order
object, or the orders
list if you are processing orders in bulk. The order
object has the same properties as orders returned by Shopify REST API: https://shopify.dev/docs/admin-api/rest/reference/orders/orderorder.metafields
order.fulfillment_orders
order.customer.metafields
orders.transactions
order.billing_address.address1
: The street address of the billing address.order.billing_address.address2
: An optional additional field for the street address of the billing address.order.billing_address.city
: The city, town, or village of the billing address.order.billing_address.company
: The company of the person associated with the billing address.order.billing_address.country
: The name of the country of the billing address.order.billing_address.country_code
: The two-letter code (ISO 3166-1 format) for the country of the billing address.order.billing_address.first_name
: The first name of the person associated with the payment method.order.billing_address.last_name
: The last name of the person associated with the payment method.order.billing_address.latitude
: The latitude of the billing address.order.billing_address.longitude
: The longitude of the billing address.order.billing_address.name
: The full name of the person associated with the payment method.order.billing_address.phone
: The phone number at the billing address.order.billing_address.province
: The name of the region (province, state, prefecture, …) of the billing address.order.billing_address.province_code
: The two-letter abbreviation of the region of the billing address.order.billing_address.zip
: The postal code (zip, postcode, Eircode, …) of the billing address.order.discount_codes
contains a list of discounts applied to the order. Each discount object includes the following properties:code
, this property returns the discount code that was entered at checkout. Otherwise this property returns the title of the discount that was applied.fixed_amount
: Applies amount
as a unit of the store's currency. For example, if amount
is 30 and the store's currency is USD, then 30 USD is deducted from the order total when the discount is applied.percentage
: Applies a discount of amount
as a percentage of the order total.shipping
: Applies a free shipping discount on orders that have a shipping rate less than or equal to amount
. For example, if amount
is 30, then the discount will give the customer free shipping for any shipping rate that is less than or equal to $30.order.discount_codes
is a list, you can assume that there will be at most one discount code. Here is a code snippet that returns a discount value or 0 if there was no discount :order.note_attributes
are custom form fields that let you collect additional information from your customers on the cart page. They appear in the Additional Details section of an order details page.
order.node_attributes
is a list of objects that consist of name
and value
, for example:order.line_items
contains the list of order line items. Each line item has the following properties:amount
: The discount amount allocated to the line in the shop currency.discount_application_index
: The index of the associated discount application in the order's discount_applications
list.amount_set
: The discount amount allocated to the line item in shop and presentment currencies.quantity - max(refunded_quantity, fulfilled_quantity) - pending_fulfilled_quantity - open_fulfilled_quantity
manual
, or the name of the provider, such as amazon
or shipwire
.null
, fulfilled
, partial
, and not_eligible
.true
, then the item is not taxed or considered for shipping charges.option.name
as the option and option.value
as the option value. Elements in line_item.options_with_values
can be displayed using a for
loop. id
: The location ID of the line item’s fulfillment origin. Used by Shopify to calculate applicable taxes. This is not the ID of the location where the order was placed. You can use the FulfillmentOrder resource to determine the location an item will be sourced from.province_code
: The two-letter abbreviation for the region of the item's supplier.name
: The name of the item's supplier.address1
: The street address of the item's supplier.address2
: The suite number of the item's supplier.city
: The city of the item's supplier.zip
: The zip of the item's supplier.title
: The name of the tax.price
: The amount added to the order for this tax in the shop currency.price_set
: The amount added to the order for this tax in shop and presentment currencies.rate
: The tax rate applied to the order to calculate the tax price.rate_percentage
: The tax rate in percentage format.shopify_payments
. Present only on tips.Visa
. Present only on tips.discount_allocations
, which provides the same information.discount_allocations
, which provides the same information.order.shipping_address.address1
: The street address of the billing address.order.shipping_address.address2
: An optional additional field for the street address of the billing address.order.shipping_address.city
: The city, town, or village of the billing address.order.shipping_address.company
: The company of the person associated with the billing address.order.shipping_address.country
: The name of the country of the billing address.order.shipping_address.country_code
: The two-letter code (ISO 3166-1 format) for the country of the billing address.order.shipping_address.first_name
: The first name of the person associated with the payment method.order.shipping_address.last_name
: The last name of the person associated with the payment method.order.shipping_address.latitude
: The latitude of the billing address.order.shipping_address.longitude
: The longitude of the billing address.order.shipping_address.name
: The full name of the person associated with the payment method.order.shipping_address.phone
: The phone number at the billing address.order.shipping_address.province
: The name of the region (province, state, prefecture, …) of the billing address.order.shipping_address.province_code
: The two-letter abbreviation of the region of the billing address.order.shipping_address.zip
: The postal code (zip, postcode, Eircode, …) of the billing address.order.total_shipping_price_set
: The total shipping price of the order, excluding discounts and returns, in shop and presentment currencies. If order.taxes_included
is set to true
, then total_shipping_price_set
includes taxes.order.shipping_lines
: An array of objects, each of which details a shipping method used. Each object has the following properties:null
otherwise.{{ order.shipping_lines[0].title }}
.order.financial_status
The status of payments associated with the order. Can only be set when the order is created. Possible values:order.fulfillment_status
The order's status in terms of fulfilled line items. Possible values:order.total_discounts
The total discounts applied to the price of the order in the shop currency.order.total_discounts_set
The total discounts applied to the price of the order in shop and presentment currencies.order.total_discounts_set.shop_money.amount
order.total_discounts_set.shop_money.currency
order.total_discounts_set.presentment_money.ammount
order.total_discounts_set.presentment_money.currency
order.total_line_items_price
The sum of all line item prices in the shop currency.order.total_line_items_price_set
The total of all line item prices in shop and presentment currencies.order.total_line_items_price_set.shop_money.amount
order.total_line_items_price_set.shop_money.currency
order.total_line_items_price_set.presentment_money.ammount
order.total_line_items_price_set.presentment_money.currency
order.total_outstanding
The total outstanding amount of the order in the shop currency.order.total_price
The sum of all line item prices, discounts, shipping, taxes, and tips in the shop currency.order.total_price_set
The total price of the order in shop and presentment currencies.order.total_price_set.shop_money.amount
order.total_price_set.shop_money.currency
order.total_price_set.presentment_money.ammount
order.total_price_set.presentment_money.currency
order.total_shipping_price_set
The total shipping price of the order, excluding discounts and returns, in shop and presentment currencies. If taxes_included
is set to true
, then order.total_shipping_price_set
includes taxes.order.total_tax
The sum of all the taxes applied to the order in the shop currencyorder.total_tax_set
The total tax applied to the order in shop and presentment currencies.order.total_tax_set.shop_money.amount
order.total_tax_set.shop_money.currency
order.total_tax_set.presentment_money.ammount
order.total_tax_set.presentment_money.currency
order.total_tip_received
The sum of all the tips in the order in the shop currency.order.total_weight
The sum of all line item weights in grams.order.transactions
contains the list of transactions. Each transaction has the following properties:capture
transactions, the parent needs to be an authorization
transaction.void
transactions, the parent needs to be an authorization
transaction.refund
transactions, the parent needs to be a capture
or sale
transaction.created_at
value. If you're importing transactions from an app or another platform, then you can set processed_at
to a date and time in the past to match when the original transaction was processed.gift_card
, then receipt contains gift_card_id
and gift_card_last_characters
.web
, pos
, iphone
, and android
.pending
, failure
, success
, and error
.