Order
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 FieldsFields
- Anchor to agreementsagreements•Sales
Agreement Connection! non-nullPre-auth accessible A list of sales agreements associated with the order.
- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
Arguments
- Anchor to billingAddressbilling•Customer
Address Address The mailing address provided by the customer. Not all orders have a mailing address.
- Anchor to cancelledAtcancelled•Date
At Time The date and time when the order was canceled. Returns
nullif the order wasn't canceled.- Anchor to cancelReasoncancel•Order
Reason Cancel Reason The reason for the cancellation of the order. Returns
nullif the order wasn't canceled.- Anchor to confirmationNumberconfirmation•String
Number 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 createdAtcreated•Date
At Time! non-nullPre-auth accessible The date and time when the order was created.
- Anchor to currencyCodecurrency•Currency
Code Code! non-nullPre-auth accessible The shop currency when the order was placed.
- Anchor to customercustomer•Customer
The customer who placed the order.
- Anchor to customerLocalecustomer•String
Locale The locale code representing the region where this specific order was placed.
- Anchor to discountApplicationsdiscount•Discount
Applications Application Connection! non-nullPre-auth accessible The discounts that have been applied to the order.
- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
Arguments
- Anchor to draftOrderdraft•Draft
Order Order 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•String
The email address of the customer.
- Anchor to financialStatusfinancial•Order
Status Financial Status The financial status of the order.
- Anchor to fulfillmentsfulfillments•Fulfillment
Connection! non-nullPre-auth accessible The fulfillments associated with the order.
- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
- Anchor to sortKeysort•Fulfillment
Key Sort Keys Default:ID Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.
- Anchor to queryquery•String
A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.
Arguments
- Anchor to fulfillmentStatusfulfillment•Order
Status Fulfillment Status! non-nullPre-auth accessible The fulfillment status of the order.
- •ID!non-nullPre-auth accessible
A globally-unique ID.
- Anchor to lineItemsline•Line
Items Item Connection! non-nullPre-auth accessible The list of line items of the order.
- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
Arguments
- Anchor to locationNamelocation•String
Name The name of the fulfillment location assigned at the time of order creation.
- Anchor to metafieldmetafield•Metafield
A metafield found by namespace and key.
- Anchor to namespacenamespace•String!required
A container for a set of metafields.
- •String!required
The identifier for the metafield.
Arguments
- Anchor to metafieldsmetafields•[Metafield]!non-nullPre-auth accessible
The metafields associated with the resource matching the supplied list of namespaces and keys.
- Anchor to identifiersidentifiers•[Has
Metafields Identifier!]! required The list of metafields to retrieve by namespace and key.
Arguments
- 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•String
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 paymentInformationpayment•Order
Information Payment Information The payment information for the order.
- Anchor to phonephone•String
The phone number of the customer for SMS notifications.
- Anchor to poNumberpo•String
Number The purchase order number of the order.
- Anchor to processedAtprocessed•Date
At Time! 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 purchasingEntitypurchasing•Purchasing
Entity Entity The purchasing entity for the order.
- Anchor to refundsrefunds•[Refund!]!non-nullPre-auth accessible
A list of refunds associated with the order.
- Anchor to requiresShippingrequires•Boolean!
Shipping non-nullPre-auth accessible Whether the order requires shipping.
- Anchor to returnInformationreturn•Order
Information Return Information! non-nullPre-auth accessible The return information for the order.
- Anchor to returnsreturns•Return
Connection! non-nullPre-auth accessible The list of returns for the order with pagination.
- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
- Anchor to sortKeysort•Return
Key Sort Keys Default:ID Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.
Arguments
- Anchor to shippingAddressshipping•Customer
Address Address The mailing address to which the order items are shipped.
- Anchor to shippingDiscountAllocationsshipping•[Discount
Discount Allocations Allocation!]! non-nullPre-auth accessible The discounts that have been allocated onto the shipping line by discount applications.
- Anchor to shippingLineshipping•Shipping
Line Line A summary of all shipping costs on the order.
- Anchor to statusPageUrlstatus•URL!
Page Url non-nullPre-auth accessible The unique URL for the status page of the order.
- Anchor to subscriptionContractssubscription•Subscription
Contracts Contract Connection The customer Subscription Contracts associated with the order.
- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
- Anchor to sortKeysort•Subscription
Key Contracts Sort Keys Default:CREATED_AT Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.
- Anchor to queryquery•String
A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.
Arguments
- Anchor to subtotalsubtotal•Money
V2 The price of the order before duties, shipping, and taxes.
- Anchor to totalDutiestotal•Money
Duties V2 The total amount of duties after returns.
- Anchor to totalPricetotal•Money
Price V2! 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 totalRefundedtotal•Money
Refunded V2! non-nullPre-auth accessible The total amount refunded.
- Anchor to totalShippingtotal•Money
Shipping V2! non-nullPre-auth accessible The total cost of shipping.
- Anchor to totalTaxtotal•Money
Tax V2 The total cost of taxes.
- Anchor to totalTiptotal•Money
Tip V2 The total value of tips.
- Anchor to transactionstransactions•[Order
Transaction!]! non-nullPre-auth accessible A list of transactions associated with the order.
- Anchor to updatedAtupdated•Date
At Time! non-null The date and time when the order was last updated.
Anchor to QueriesQueries
- •query
Returns an Order resource by ID. Apps using the Customer Account API must meet the protected customer data requirements.
- •ID!required
The ID of the Order to return.
Arguments
- •ID!