Requires access scope.
An order is a customer’s completed request to purchase one or more products from a shop. An order is created when a customer completes the checkout process, during which time they provides an email address, billing address and payment information.
Fields and connections
The address associated with the payment method.
The date and time when the order was canceled. Returns null if the order wasn't canceled.
The reason for the order's cancellation. Returns
nullif the order wasn't canceled.The code of the currency used for the payment.
The subtotal of line items and their discounts, excluding line items that have been removed. Does not contain order-level discounts, duties, shipping costs, or shipping discounts. Taxes aren't included unless the order is a taxes-included order.
The total cost of duties for the order, including refunds.
The total amount of the order, including duties, taxes and discounts, minus amounts for line items that have been removed.
The total cost of shipping, excluding shipping lines that have been refunded or removed. Taxes aren't included unless the order is a taxes-included order.
The total of all taxes applied to the order, excluding taxes for returned line items.
A list of the custom attributes added to the order. For example, whether an order is a customer's first.
The locale code in which this specific order happened.
The unique URL that the customer can use to access the order.
Discounts that have been applied on the order.
Whether the order has had any edits applied or not.
The customer's email address.
The financial status of the order.
The fulfillment status for the order.
A globally-unique ID.
List of the order’s line items.
Returns a metafield found by namespace and key.
The metafields associated with the resource matching the supplied list of namespaces and keys.
Unique identifier for the order that appears on the order. For example, #1000 or _Store1001.
A unique numeric identifier for the order for use by shop owner and customer.
The total cost of duties charged at checkout.
The total price of the order before any applied edits.
The customer's phone number for receiving SMS notifications.
The date and time when the order was imported. This value can be set to dates in the past when importing from other systems. If no value is provided, it will be auto-generated based on current date and time.
The address to where the order will be shipped.
The discounts that have been allocated onto the shipping line by discount applications.
The unique URL for the order's status page.
Price of the order before shipping and taxes.
List of the order’s successful fulfillments.
The sum of all the prices of all the items in the order, duties, taxes and discounts included (must be positive).
The total amount that has been refunded.
The total cost of shipping.
The total cost of taxes.