Choose a version:

Order

object

A customer’s completed request to purchase one or more products from a shop. Apps using the Customer Account API must meet the protected customer data requirements.

Anchor to Fields and connectionsFields and connections

Anchor to agreementsagreements •SalesAgreementConnection!non-nullPre-auth accessible: A list of sales agreements associated with the order.
Anchor to billingAddressbillingAddress •CustomerAddressPre-auth accessible: The mailing address provided by the customer. Not all orders have a mailing address.
Anchor to cancelledAtcancelledAt •DateTimePre-auth accessible: The date and time when the order was canceled. Returns null if the order wasn't canceled.
Anchor to cancelReasoncancelReason •OrderCancelReasonPre-auth accessible: The reason for the cancellation of the order. Returns null if the order wasn't canceled.
Anchor to confirmationNumberconfirmationNumber •StringPre-auth accessible: A randomly generated alpha-numeric identifier for the order that may be shown to the customer instead of the sequential order name. For example, "XPAV284CT", "R50KELTJP" or "35PKUN0UJ". This value isn't guaranteed to be unique.
Anchor to createdAtcreatedAt •DateTime!non-nullPre-auth accessible: The date and time when the order was created.
Anchor to currencyCodecurrencyCode •CurrencyCode!non-nullPre-auth accessible: The shop currency when the order was placed.
Anchor to customercustomer •CustomerPre-auth accessible: The customer who placed the order.
Anchor to customerLocalecustomerLocale •StringPre-auth accessible: The locale code representing the region where this specific order was placed.
Anchor to discountApplicationsdiscountApplications •DiscountApplicationConnection!non-nullPre-auth accessible: The discounts that have been applied to the order.
Anchor to draftOrderdraftOrder •DraftOrderPre-auth accessible: The draft order associated with the order.
Anchor to editededited •Boolean!non-nullPre-auth accessible: Whether the order has been edited or not.
Anchor to emailemail •StringPre-auth accessible: The email address of the customer.
Anchor to financialStatusfinancialStatus •OrderFinancialStatusPre-auth accessible: The financial status of the order.
Anchor to fulfillmentsfulfillments •FulfillmentConnection!non-nullPre-auth accessible: The fulfillments associated with the order.
Anchor to fulfillmentStatusfulfillmentStatus •OrderFulfillmentStatus!non-nullPre-auth accessible: The fulfillment status of the order.
Anchor to idid •ID!non-nullPre-auth accessible: A globally-unique ID.
Anchor to lineItemslineItems •LineItemConnection!non-nullPre-auth accessible: The list of line items of the order.
Anchor to locationNamelocationName •StringPre-auth accessible: The name of the fulfillment location assigned at the time of order creation.
Anchor to metafieldmetafield •MetafieldPre-auth accessible: A metafield found by namespace and key.
Anchor to metafieldsmetafields •[Metafield]!non-nullPre-auth accessible: The metafields associated with the resource matching the supplied list of namespaces and keys.
Anchor to namename •String!non-nullPre-auth accessible: The identifier for the order that appears on the order. For example, #1000 or _Store1001.
Anchor to notenote •StringPre-auth accessible: The order's notes.
Anchor to numbernumber •Int!non-nullPre-auth accessible: A unique numeric identifier for the order, used by both the shop owner and customer.
Anchor to paymentInformationpaymentInformation •OrderPaymentInformationPre-auth accessible: The payment information for the order.
Anchor to phonephone •String: The phone number of the customer for SMS notifications.
Anchor to poNumberpoNumber •StringPre-auth accessible: The purchase order number of the order.
Anchor to processedAtprocessedAt •DateTime!non-nullPre-auth accessible: The date and time when the order was processed. 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 purchasingEntitypurchasingEntity •PurchasingEntityPre-auth accessible: The purchasing entity for the order.
Anchor to refundsrefunds •[Refund!]!non-nullPre-auth accessible: A list of refunds associated with the order.
Anchor to requiresShippingrequiresShipping •Boolean!non-nullPre-auth accessible: Whether the order requires shipping.
Anchor to returnInformationreturnInformation •OrderReturnInformation!non-nullPre-auth accessible: The return information for the order.
Anchor to returnsreturns •ReturnConnection!non-nullPre-auth accessible: The list of returns for the order with pagination.
Anchor to shippingAddressshippingAddress •CustomerAddressPre-auth accessible: The mailing address to which the order items are shipped.
Anchor to shippingDiscountAllocationsshippingDiscountAllocations •[DiscountAllocation!]!non-nullPre-auth accessible: The discounts that have been allocated onto the shipping line by discount applications.
Anchor to shippingLineshippingLine •ShippingLinePre-auth accessible: A summary of all shipping costs on the order.
Anchor to statusPageUrlstatusPageUrl •URL!non-nullPre-auth accessible: The unique URL for the status page of the order.
Anchor to subscriptionContractssubscriptionContracts •SubscriptionContractConnection: The customer Subscription Contracts associated with the order.
Anchor to subtotalsubtotal •MoneyV2Pre-auth accessible: The price of the order before duties, shipping, and taxes.
Anchor to totalDutiestotalDuties •MoneyV2Pre-auth accessible: The total amount of duties after returns.
Anchor to totalPricetotalPrice •MoneyV2!non-nullPre-auth accessible: The total amount of the order (including taxes and discounts) minus the amounts for line items that have been returned.
Anchor to totalRefundedtotalRefunded •MoneyV2!non-nullPre-auth accessible: The total amount refunded.
Anchor to totalShippingtotalShipping •MoneyV2!non-nullPre-auth accessible: The total cost of shipping.
Anchor to totalTaxtotalTax •MoneyV2Pre-auth accessible: The total cost of taxes.
Anchor to totalTiptotalTip •MoneyV2Pre-auth accessible: The total value of tips.
Anchor to transactionstransactions •[OrderTransaction!]!non-nullPre-auth accessible: A list of transactions associated with the order.
Anchor to updatedAtupdatedAt •DateTime!non-null: The date and time when the order was last updated.

Was this section helpful?

Anchor to QueriesQueries

Anchor to order order •query: Returns an Order resource by ID. Apps using the Customer Account API must meet the protected customer data requirements.

Was this section helpful?

Anchor to InterfacesInterfaces

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

Was this section helpful?