Find order

This query returns an order.

About this query

Triggers, queries, and actions are the building blocks of Applets. Triggers tell an Applet to start, queries ask a question, and actions are its end result.

Developer info

Description: This query returns an order.
API endpoint slug: shippo.find_order
Runtime method: performQuery("shippo.find_order")

Query fields

Order ID Text input > Other

Label: What is the Order's Object ID?
Helper text: Tip: use the 'OrderObjectID' ingredient from a Shippo trigger.
Slug: order_id
Required: true
Can have default value: true

Ingredients

Order numberThe order number

Slug: order_number
Filter code: Shippo.findOrder.OrderNumber
Type: String
Example: #1234

Order statusThe current status of the order

Slug: order_status
Filter code: Shippo.findOrder.OrderStatus
Type: String
Example: PAID

Placed atThe date the order was placed

Slug: placed_at
Filter code: Shippo.findOrder.PlacedAt
Type: Date with time (ISO8601)
Example: 2020-07-08T04:17:06.000+05:00

NotesThe notes of the order

Slug: notes
Filter code: Shippo.findOrder.Notes
Type: String
Example: Please ship ASAP!

Order object IDThe object ID of the order

Slug: object_id
Filter code: Shippo.findOrder.OrderObjectId
Type: String
Example: aaaaaaa

Subtotal priceThe subtotal price of the order

Slug: subtotal_price
Filter code: Shippo.findOrder.SubtotalPrice
Type: String
Example: 12.10

Total priceThe total price of the order

Slug: total_price
Filter code: Shippo.findOrder.TotalPrice
Type: String
Example: 24.93

Total taxThe total tax of the order

Slug: total_tax
Filter code: Shippo.findOrder.TotalTax
Type: String
Example: 0.00

CurrencyThe currency of the order

Slug: currency
Filter code: Shippo.findOrder.Currency
Type: String
Example: USD

To address nameThe name of the recipient for the order

Slug: to_address_name
Filter code: Shippo.findOrder.ToAddressName
Type: String
Example: Mr Hippo

To address emailThe email address of the recipient for the order

Slug: to_address_email
Filter code: Shippo.findOrder.ToAddressEmail
Type: String
Example: test@example.com

To address phoneThe phone number of the recipient for the order

Slug: to_address_phone
Filter code: Shippo.findOrder.ToAddressPhone
Type: String
Example: 15553419393

To address companyThe company name of the recipient for the order

Slug: to_address_company
Filter code: Shippo.findOrder.ToAddressCompany
Type: String
Example: Shippo

To address object IDThe ID of the recipient address

Slug: to_address_object_id
Filter code: Shippo.findOrder.ToAddressObjectId
Type: String
Example: aaaaaaa

To address street1The 1st street line of the recipient address

Slug: to_address_street1
Filter code: Shippo.findOrder.ToAddressStreet1
Type: String
Example: 215 Clayton St.

To address street2The 2nd street line of the recipient address

Slug: to_address_street2
Filter code: Shippo.findOrder.ToAddressStreet2
Type: String
Example: Unit 2

To address street3The 3rd street line of the recipient address

Slug: to_address_street3
Filter code: Shippo.findOrder.ToAddressStreet3
Type: String
Example: Floor 3

To address cityThe city of the recipient address

Slug: to_address_city
Filter code: Shippo.findOrder.ToAddressCity
Type: String
Example: San Francisco

To address stateThe state of the recipient address

Slug: to_address_state
Filter code: Shippo.findOrder.ToAddressState
Type: String
Example: CA

To address zipThe zip code of the recipient address

Slug: to_address_zip
Filter code: Shippo.findOrder.ToAddressZip
Type: String
Example: 94117

To address countryThe country of the recipient address

Slug: to_address_country
Filter code: Shippo.findOrder.ToAddressCountry
Type: String
Example: US

From address nameThe name of the sender for the order

Slug: from_address_name
Filter code: Shippo.findOrder.FromAddressName
Type: String
Example: Mr Hippo

From address emailThe email address of the sender for the order

Slug: from_address_email
Filter code: Shippo.findOrder.FromAddressEmail
Type: String
Example: test@example.com

From address phoneThe phone number of the sender for the order

Slug: from_address_phone
Filter code: Shippo.findOrder.FromAddressPhone
Type: String
Example: 15553419393

From address companyThe company of the address the order is being shipped from

Slug: from_address_company
Filter code: Shippo.findOrder.FromAddressCompany
Type: String
Example: Shippo

From address object IDThe ID of the sender address

Slug: from_address_object_id
Filter code: Shippo.findOrder.FromAddressObjectId
Type: String
Example: aaaaaaa

From address street1The 1st street line of the sender address

Slug: from_address_street1
Filter code: Shippo.findOrder.FromAddressStreet1
Type: String
Example: 215 Clayton St.

From address street2The 2nd street line of the sender address

Slug: from_address_street2
Filter code: Shippo.findOrder.FromAddressStreet2
Type: String
Example: Unit 2

From address street3The 3rd street line of the sender address

Slug: from_address_street3
Filter code: Shippo.findOrder.FromAddressStreet3
Type: String
Example: Floor 3

From address cityThe city of the sender address

Slug: from_address_city
Filter code: Shippo.findOrder.FromAddressCity
Type: String
Example: San Francisco

From address stateThe state of the sender address

Slug: from_address_state
Filter code: Shippo.findOrder.FromAddressState
Type: String
Example: CA

From address zipThe zip code of the sender address

Slug: from_address_zip
Filter code: Shippo.findOrder.FromAddressZip
Type: String
Example: 94117

From address countryThe country of the sender address

Slug: from_address_country
Filter code: Shippo.findOrder.FromAddressCountry
Type: String
Example: US

Shipping methodThe shipping method of the order

Slug: shipping_method
Filter code: Shippo.findOrder.ShippingMethod
Type: String
Example: USPS First Class Package

Shipping costThe shipping cost of the order

Slug: shipping_cost
Filter code: Shippo.findOrder.ShippingCost
Type: String
Example: 12.83

Shipping cost currencyThe shipping cost currency of the order

Slug: shipping_cost_currency
Filter code: Shippo.findOrder.ShippingCostCurrency
Type: String
Example: USD

WeightThe weight value of the order

Slug: weight
Filter code: Shippo.findOrder.Weight
Type: String
Example: 0.40

Weight unitThe unit of the weight of the order

Slug: weight_unit
Filter code: Shippo.findOrder.WeightUnit
Type: String
Example: lb

Line item titleThe title of the line item

Slug: line_item_title
Filter code: Shippo.findOrder.LineItemTitle
Type: String
Example: Hippo Magazines

Line item descriptionThe description of the line item

Slug: line_item_description
Filter code: Shippo.findOrder.LineItemDescription
Type: String
Example: Hippo Magazines

Line item skuThe SKU of the line item

Slug: line_item_sku
Filter code: Shippo.findOrder.LineItemSku
Type: String
Example: HM-123

Line item priceThe price of the line item

Slug: line_item_price
Filter code: Shippo.findOrder.LineItemPrice
Type: String
Example: 12.10

Line item price currencyThe price currency of the line item

Slug: line_item_price_currency
Filter code: Shippo.findOrder.LineItemPriceCurrency
Type: String
Example: USD

Line item weightThe weight of the line item

Slug: line_item_weight
Filter code: Shippo.findOrder.LineItemWeight
Type: String
Example: 0.40

Line item weight unitThe weight unit of the line item

Slug: line_item_weight_unit
Filter code: Shippo.findOrder.LineItemWeightUnit
Type: String
Example: lb

Line item object IDThe ID of the line item

Slug: line_item_object_id
Filter code: Shippo.findOrder.LineItemObjectId
Type: String
Example: aaaaaaa

Shop appThe name of the app the order was placed on

Slug: shop_app
Filter code: Shippo.findOrder.ShopApp
Type: String
Example: Shippo