--- title: Order - Customer API description: |- 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](https://shopify.dev/docs/apps/launch/protected-customer-data). api_version: 2026-10 source_url: html: 'https://shopify.dev/docs/api/customer/latest/objects/Order' md: 'https://shopify.dev/docs/api/customer/latest/objects/Order.md' api_name: customer api_type: graphql type: object --- # Order object Requires `customer_read_orders` access scope. 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](https://shopify.dev/docs/apps/launch/protected-customer-data). ## Fields * agreements [Sales​Agreement​Connection!](https://shopify.dev/docs/api/customer/latest/connections/SalesAgreementConnection) non-null A list of sales agreements associated with the order. * after [String](https://shopify.dev/docs/api/customer/latest/scalars/String) ### Arguments The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql). * before [String](https://shopify.dev/docs/api/customer/latest/scalars/String) The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql). * first [Int](https://shopify.dev/docs/api/customer/latest/scalars/Int) The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql). * last [Int](https://shopify.dev/docs/api/customer/latest/scalars/Int) The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql). * reverse [Boolean](https://shopify.dev/docs/api/customer/latest/scalars/Boolean) Default:false Reverse the order of the underlying list. *** * billing​Address [Customer​Address](https://shopify.dev/docs/api/customer/latest/objects/CustomerAddress) The mailing address provided by the customer. Not all orders have a mailing address. * cancelled​At [Date​Time](https://shopify.dev/docs/api/customer/latest/scalars/DateTime) The date and time when the order was canceled. Returns `null` if the order wasn't canceled. * cancel​Reason [Order​Cancel​Reason](https://shopify.dev/docs/api/customer/latest/enums/OrderCancelReason) The reason for the cancellation of the order. Returns `null` if the order wasn't canceled. * confirmation​Number [String](https://shopify.dev/docs/api/customer/latest/scalars/String) 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. * created​At [Date​Time!](https://shopify.dev/docs/api/customer/latest/scalars/DateTime) non-null The date and time when the order was created. * currency​Code [Currency​Code!](https://shopify.dev/docs/api/customer/latest/enums/CurrencyCode) non-null The shop currency when the order was placed. * customer [Customer](https://shopify.dev/docs/api/customer/latest/objects/Customer) The customer who placed the order. * customer​Locale [String](https://shopify.dev/docs/api/customer/latest/scalars/String) The locale code representing the region where this specific order was placed. * discount​Applications [Discount​Application​Connection!](https://shopify.dev/docs/api/customer/latest/connections/DiscountApplicationConnection) non-null The discounts that have been applied to the order. * after [String](https://shopify.dev/docs/api/customer/latest/scalars/String) ### Arguments The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql). * before [String](https://shopify.dev/docs/api/customer/latest/scalars/String) The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql). * first [Int](https://shopify.dev/docs/api/customer/latest/scalars/Int) The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql). * last [Int](https://shopify.dev/docs/api/customer/latest/scalars/Int) The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql). * reverse [Boolean](https://shopify.dev/docs/api/customer/latest/scalars/Boolean) Default:false Reverse the order of the underlying list. *** * draft​Order [Draft​Order](https://shopify.dev/docs/api/customer/latest/objects/DraftOrder) The draft order associated with the order. * edited [Boolean!](https://shopify.dev/docs/api/customer/latest/scalars/Boolean) non-null Whether the order has been edited or not. * email [String](https://shopify.dev/docs/api/customer/latest/scalars/String) The email address of the customer. * financial​Status [Order​Financial​Status](https://shopify.dev/docs/api/customer/latest/enums/OrderFinancialStatus) The financial status of the order. * fulfillments [Fulfillment​Connection!](https://shopify.dev/docs/api/customer/latest/connections/FulfillmentConnection) non-null The fulfillments associated with the order. * after [String](https://shopify.dev/docs/api/customer/latest/scalars/String) ### Arguments The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql). * before [String](https://shopify.dev/docs/api/customer/latest/scalars/String) The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql). * first [Int](https://shopify.dev/docs/api/customer/latest/scalars/Int) The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql). * last [Int](https://shopify.dev/docs/api/customer/latest/scalars/Int) The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql). * query [String](https://shopify.dev/docs/api/customer/latest/scalars/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](https://shopify.dev/api/usage/search-syntax). * * id id * order\_id id - Filter by `id` range. - Example: * `id:1234` * `id:>=1234` * `id:<=1234` * shipment\_status string * status string * reverse [Boolean](https://shopify.dev/docs/api/customer/latest/scalars/Boolean) Default:false Reverse the order of the underlying list. * sort​Key [Fulfillment​Sort​Keys](https://shopify.dev/docs/api/customer/latest/enums/FulfillmentSortKeys) 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](https://shopify.dev/api/usage/pagination-graphql#search-performance-considerations). *** * fulfillment​Status [Order​Fulfillment​Status!](https://shopify.dev/docs/api/customer/latest/enums/OrderFulfillmentStatus) non-null The fulfillment status of the order. * id [ID!](https://shopify.dev/docs/api/customer/latest/scalars/ID) non-null A globally-unique ID. * line​Items [Line​Item​Connection!](https://shopify.dev/docs/api/customer/latest/connections/LineItemConnection) non-null The list of line items of the order. * after [String](https://shopify.dev/docs/api/customer/latest/scalars/String) ### Arguments The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql). * before [String](https://shopify.dev/docs/api/customer/latest/scalars/String) The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql). * first [Int](https://shopify.dev/docs/api/customer/latest/scalars/Int) The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql). * last [Int](https://shopify.dev/docs/api/customer/latest/scalars/Int) The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql). * reverse [Boolean](https://shopify.dev/docs/api/customer/latest/scalars/Boolean) Default:false Reverse the order of the underlying list. *** * location​Name [String](https://shopify.dev/docs/api/customer/latest/scalars/String) The name of the fulfillment location assigned at the time of order creation. * metafield [Metafield](https://shopify.dev/docs/api/customer/latest/objects/Metafield) A metafield found by namespace and key. * key [String!](https://shopify.dev/docs/api/customer/latest/scalars/String) required ### Arguments The identifier for the metafield. * namespace [String!](https://shopify.dev/docs/api/customer/latest/scalars/String) required A container for a set of metafields. *** * metafields [\[Metafield\]!](https://shopify.dev/docs/api/customer/latest/objects/Metafield) non-null The metafields associated with the resource matching the supplied list of namespaces and keys. * identifiers [\[Has​Metafields​Identifier!\]!](https://shopify.dev/docs/api/customer/latest/input-objects/HasMetafieldsIdentifier) required ### Arguments The list of metafields to retrieve by namespace and key. *** * name [String!](https://shopify.dev/docs/api/customer/latest/scalars/String) non-null The identifier for the order that appears on the order. For example, *#1000* or \_Store1001. * note [String](https://shopify.dev/docs/api/customer/latest/scalars/String) The order's notes. * number [Int!](https://shopify.dev/docs/api/customer/latest/scalars/Int) non-null A unique numeric identifier for the order, used by both the shop owner and customer. * payment​Information [Order​Payment​Information](https://shopify.dev/docs/api/customer/latest/objects/OrderPaymentInformation) The payment information for the order. * phone [String](https://shopify.dev/docs/api/customer/latest/scalars/String) The phone number of the customer for SMS notifications. * po​Number [String](https://shopify.dev/docs/api/customer/latest/scalars/String) The purchase order number of the order. * processed​At [Date​Time!](https://shopify.dev/docs/api/customer/latest/scalars/DateTime) non-null 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. * purchasing​Entity [Purchasing​Entity](https://shopify.dev/docs/api/customer/latest/unions/PurchasingEntity) The purchasing entity for the order. * refunds [\[Refund!\]!](https://shopify.dev/docs/api/customer/latest/objects/Refund) non-null A list of refunds associated with the order. * requested​Edit​Information [Order​Requested​Edit​Information!](https://shopify.dev/docs/api/customer/latest/objects/OrderRequestedEditInformation) non-null The requested edit information for the order, including editable line items. * requested​Order​Edits [Requested​Order​Edit​Connection!](https://shopify.dev/docs/api/customer/latest/connections/RequestedOrderEditConnection) non-null The buyer's requests to edit the order's line items. * after [String](https://shopify.dev/docs/api/customer/latest/scalars/String) ### Arguments The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql). * before [String](https://shopify.dev/docs/api/customer/latest/scalars/String) The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql). * first [Int](https://shopify.dev/docs/api/customer/latest/scalars/Int) The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql). * last [Int](https://shopify.dev/docs/api/customer/latest/scalars/Int) The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql). *** * requires​Shipping [Boolean!](https://shopify.dev/docs/api/customer/latest/scalars/Boolean) non-null Whether the order requires shipping. * return​Information [Order​Return​Information!](https://shopify.dev/docs/api/customer/latest/objects/OrderReturnInformation) non-null The return information for the order. * returns [Return​Connection!](https://shopify.dev/docs/api/customer/latest/connections/ReturnConnection) non-null The list of returns for the order with pagination. * after [String](https://shopify.dev/docs/api/customer/latest/scalars/String) ### Arguments The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql). * before [String](https://shopify.dev/docs/api/customer/latest/scalars/String) The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql). * first [Int](https://shopify.dev/docs/api/customer/latest/scalars/Int) The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql). * last [Int](https://shopify.dev/docs/api/customer/latest/scalars/Int) The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql). * reverse [Boolean](https://shopify.dev/docs/api/customer/latest/scalars/Boolean) Default:false Reverse the order of the underlying list. * sort​Key [Return​Sort​Keys](https://shopify.dev/docs/api/customer/latest/enums/ReturnSortKeys) 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](https://shopify.dev/api/usage/pagination-graphql#search-performance-considerations). *** * shipping​Address [Customer​Address](https://shopify.dev/docs/api/customer/latest/objects/CustomerAddress) The mailing address to which the order items are shipped. * shipping​Discount​Allocations [\[Discount​Allocation!\]!](https://shopify.dev/docs/api/customer/latest/objects/DiscountAllocation) non-null The discounts that have been allocated onto the shipping line by discount applications. * shipping​Line [Shipping​Line](https://shopify.dev/docs/api/customer/latest/objects/ShippingLine) A summary of all shipping costs on the order. * status​Page​Url [URL!](https://shopify.dev/docs/api/customer/latest/scalars/URL) non-null The unique URL for the status page of the order. * subscription​Contracts [Subscription​Contract​Connection](https://shopify.dev/docs/api/customer/latest/connections/SubscriptionContractConnection) The customer Subscription Contracts associated with the order. * after [String](https://shopify.dev/docs/api/customer/latest/scalars/String) ### Arguments The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql). * before [String](https://shopify.dev/docs/api/customer/latest/scalars/String) The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql). * first [Int](https://shopify.dev/docs/api/customer/latest/scalars/Int) The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql). * last [Int](https://shopify.dev/docs/api/customer/latest/scalars/Int) The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql). * query [String](https://shopify.dev/docs/api/customer/latest/scalars/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](https://shopify.dev/api/usage/search-syntax). * created\_at time * * id id * last\_billing\_attempt\_error\_type string - Filter by `id` range. - Example: * `id:1234` * `id:>=1234` * `id:<=1234` * status string * updated\_at time * reverse [Boolean](https://shopify.dev/docs/api/customer/latest/scalars/Boolean) Default:false Reverse the order of the underlying list. * sort​Key [Subscription​Contracts​Sort​Keys](https://shopify.dev/docs/api/customer/latest/enums/SubscriptionContractsSortKeys) 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](https://shopify.dev/api/usage/pagination-graphql#search-performance-considerations). *** * subtotal [Money​V2](https://shopify.dev/docs/api/customer/latest/objects/MoneyV2) The price of the order before duties, shipping, and taxes. * total​Duties [Money​V2](https://shopify.dev/docs/api/customer/latest/objects/MoneyV2) The total amount of duties after returns. * total​Price [Money​V2!](https://shopify.dev/docs/api/customer/latest/objects/MoneyV2) non-null The total amount of the order (including taxes and discounts) minus the amounts for line items that have been returned. * total​Refunded [Money​V2!](https://shopify.dev/docs/api/customer/latest/objects/MoneyV2) non-null The total amount refunded. * total​Shipping [Money​V2!](https://shopify.dev/docs/api/customer/latest/objects/MoneyV2) non-null The total cost of shipping. * total​Tax [Money​V2](https://shopify.dev/docs/api/customer/latest/objects/MoneyV2) The total cost of taxes. * total​Tip [Money​V2](https://shopify.dev/docs/api/customer/latest/objects/MoneyV2) The total value of tips. * transactions [\[Order​Transaction!\]!](https://shopify.dev/docs/api/customer/latest/objects/OrderTransaction) non-null A list of transactions associated with the order. * updated​At [Date​Time!](https://shopify.dev/docs/api/customer/latest/scalars/DateTime) non-null The date and time when the order was last updated. *** ## Map ### Fields and connections with this object * [Company.orders](https://shopify.dev/docs/api/customer/latest/objects/Company#field-Company.fields.orders) * [CompanyContact.orders](https://shopify.dev/docs/api/customer/latest/objects/CompanyContact#field-CompanyContact.fields.orders) * [CompanyLocation.orders](https://shopify.dev/docs/api/customer/latest/objects/CompanyLocation#field-CompanyLocation.fields.orders) * [Customer.orders](https://shopify.dev/docs/api/customer/latest/objects/Customer#field-Customer.fields.orders) * [DraftOrder.order](https://shopify.dev/docs/api/customer/latest/objects/DraftOrder#field-DraftOrder.fields.order) * [OrderAgreement.order](https://shopify.dev/docs/api/customer/latest/objects/OrderAgreement#field-OrderAgreement.fields.order) * [OrderConnection.nodes](https://shopify.dev/docs/api/customer/latest/connections/OrderConnection#returns-nodes) * [OrderEdge.node](https://shopify.dev/docs/api/customer/latest/objects/OrderEdge#field-OrderEdge.fields.node) * [OrderTransaction.order](https://shopify.dev/docs/api/customer/latest/objects/OrderTransaction#field-OrderTransaction.fields.order) * [SubscriptionContract.orders](https://shopify.dev/docs/api/customer/latest/objects/SubscriptionContract#field-SubscriptionContract.fields.orders) * [SubscriptionContract.originOrder](https://shopify.dev/docs/api/customer/latest/objects/SubscriptionContract#field-SubscriptionContract.fields.originOrder) * [SubscriptionContractBase.orders](https://shopify.dev/docs/api/customer/latest/interfaces/SubscriptionContractBase#fields-orders) *** ## Queries * [order](https://shopify.dev/docs/api/customer/latest/queries/order) query Returns an Order resource by ID. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). * id [ID!](https://shopify.dev/docs/api/customer/latest/scalars/ID) required ### Arguments The ID of the Order to return. *** *** ## Order Queries ### Queried by * [order](https://shopify.dev/docs/api/customer/latest/queries/order) *** ## Interfaces * * [Has​Metafields](https://shopify.dev/docs/api/customer/latest/interfaces/HasMetafields) interface * [Node](https://shopify.dev/docs/api/customer/latest/interfaces/Node) interface *** ## Order Implements ### Implements * [Has​Metafields](https://shopify.dev/docs/api/customer/latest/interfaces/HasMetafields) * [Node](https://shopify.dev/docs/api/customer/latest/interfaces/Node)