Choose a version:

Order

object

Requires unauthenticated_read_customers 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.

Anchor to FieldsFields

Anchor to billingAddressbillingAddress •MailingAddress: The address associated with the payment method.
Anchor to canceledAtcanceledAt •DateTime: The date and time when the order was canceled. Returns null if the order wasn't canceled.
Anchor to cancelReasoncancelReason •OrderCancelReason: The reason for the order's cancellation. Returns null if the order wasn't canceled.
Anchor to currencyCodecurrencyCode •CurrencyCode! non-null: The code of the currency used for the payment.
Anchor to currentSubtotalPricecurrentSubtotalPrice •MoneyV2! non-null: 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.
Anchor to currentTotalDutiescurrentTotalDuties •MoneyV2: The total cost of duties for the order, including refunds.
Anchor to currentTotalPricecurrentTotalPrice •MoneyV2! non-null: The total amount of the order, including duties, taxes and discounts, minus amounts for line items that have been removed.
Anchor to currentTotalShippingPricecurrentTotalShippingPrice •MoneyV2! non-null: 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.
Anchor to currentTotalTaxcurrentTotalTax •MoneyV2! non-null: The total of all taxes applied to the order, excluding taxes for returned line items.
Anchor to customAttributescustomAttributes •[Attribute!]! non-null: A list of the custom attributes added to the order. For example, whether an order is a customer's first.
Anchor to customerLocalecustomerLocale •String: The locale code in which this specific order happened.
Anchor to customerUrlcustomerUrl •URL: The unique URL that the customer can use to access the order.
Anchor to discountApplicationsdiscountApplications •DiscountApplicationConnection! non-null: Discounts that have been applied on the order.
Anchor to editededited •Boolean! non-null: Whether the order has had any edits applied or not.
Anchor to emailemail •String: The customer's email address.
Anchor to financialStatusfinancialStatus •OrderFinancialStatus: The financial status of the order.
Anchor to fulfillmentStatusfulfillmentStatus •OrderFulfillmentStatus! non-null: The fulfillment status for the order.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to lineItemslineItems •OrderLineItemConnection! non-null: List of the order’s line items.
Anchor to metafieldmetafield •Metafield: A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.
Anchor to metafieldsmetafields •[Metafield]! non-null: A list of custom fields that a merchant associates with a Shopify resource.
Anchor to namename •String! non-null: Unique identifier for the order that appears on the order. For example, #1000 or _Store1001.
Anchor to orderNumberorderNumber •Int! non-null: A unique numeric identifier for the order for use by shop owner and customer.
Anchor to originalTotalDutiesoriginalTotalDuties •MoneyV2: The total cost of duties charged at checkout.
Anchor to originalTotalPriceoriginalTotalPrice •MoneyV2! non-null: The total price of the order before any applied edits.
Anchor to phonephone •String: The customer's phone number for receiving SMS notifications.
Anchor to processedAtprocessedAt •DateTime! non-null: 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.
Anchor to shippingAddressshippingAddress •MailingAddress: The address to where the order will be shipped.
Anchor to shippingDiscountAllocationsshippingDiscountAllocations •[DiscountAllocation!]! non-null: The discounts that have been allocated onto the shipping line by discount applications.
Anchor to statusUrlstatusUrl •URL! non-null: The unique URL for the order's status page.
Anchor to subtotalPricesubtotalPrice •MoneyV2: Price of the order before shipping and taxes.
Anchor to successfulFulfillmentssuccessfulFulfillments •[Fulfillment!]: List of the order’s successful fulfillments.
Anchor to totalPricetotalPrice •MoneyV2! non-null: The sum of all the prices of all the items in the order, duties, taxes and discounts included (must be positive).
Anchor to totalRefundedtotalRefunded •MoneyV2! non-null: The total amount that has been refunded.
Anchor to totalShippingPricetotalShippingPrice •MoneyV2! non-null: The total cost of shipping.
Anchor to totalTaxtotalTax •MoneyV2: The total cost of taxes.

Deprecated fields

Anchor to subtotalPriceV2subtotalPriceV2 •MoneyV2 Deprecated
Anchor to totalPriceV2totalPriceV2 •MoneyV2! non-nullDeprecated
Anchor to totalRefundedV2totalRefundedV2 •MoneyV2! non-nullDeprecated
Anchor to totalShippingPriceV2totalShippingPriceV2 •MoneyV2! non-nullDeprecated
Anchor to totalTaxV2totalTaxV2 •MoneyV2 Deprecated

Was this section helpful?

Anchor to InterfacesInterfaces

Anchor to HasMetafields HasMetafields •interface
Anchor to Node Node •interface

Was this section helpful?