--- title: Order - Storefront API description: |- 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. api_version: 2026-04 source_url: html: https://shopify.dev/docs/api/storefront/latest/objects/order md: https://shopify.dev/docs/api/storefront/latest/objects/order.md --- # 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. ## Fields * billing​Address [Mailing​Address](https://shopify.dev/docs/api/storefront/latest/objects/MailingAddress) Token access required The address associated with the payment method. * canceled​At [Date​Time](https://shopify.dev/docs/api/storefront/latest/scalars/DateTime) Token access required 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/storefront/latest/enums/OrderCancelReason) Token access required The reason for the order's cancellation. Returns `null` if the order wasn't canceled. * currency​Code [Currency​Code!](https://shopify.dev/docs/api/storefront/latest/enums/CurrencyCode) non-null Token access required The code of the currency used for the payment. * current​Subtotal​Price [Money​V2!](https://shopify.dev/docs/api/storefront/latest/objects/MoneyV2) non-null Token access required 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. * current​Total​Duties [Money​V2](https://shopify.dev/docs/api/storefront/latest/objects/MoneyV2) Token access required The total cost of duties for the order, including refunds. * current​Total​Price [Money​V2!](https://shopify.dev/docs/api/storefront/latest/objects/MoneyV2) non-null Token access required The total amount of the order, including duties, taxes and discounts, minus amounts for line items that have been removed. * current​Total​Shipping​Price [Money​V2!](https://shopify.dev/docs/api/storefront/latest/objects/MoneyV2) non-null Token access required 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. * current​Total​Tax [Money​V2!](https://shopify.dev/docs/api/storefront/latest/objects/MoneyV2) non-null Token access required The total of all taxes applied to the order, excluding taxes for returned line items. * custom​Attributes [\[Attribute!\]!](https://shopify.dev/docs/api/storefront/latest/objects/Attribute) non-null Token access required A list of the custom attributes added to the order. For example, whether an order is a customer's first. * customer​Locale [String](https://shopify.dev/docs/api/storefront/latest/scalars/String) Token access required The locale code in which this specific order happened. * customer​Url [URL](https://shopify.dev/docs/api/storefront/latest/scalars/URL) Token access required The unique URL that the customer can use to access the order. * discount​Applications [Discount​Application​Connection!](https://shopify.dev/docs/api/storefront/latest/connections/DiscountApplicationConnection) non-null Token access required Discounts that have been applied on the order. * after [String](https://shopify.dev/docs/api/storefront/latest/scalars/String) ### Arguments Returns the elements that come after the specified cursor. * before [String](https://shopify.dev/docs/api/storefront/latest/scalars/String) Returns the elements that come before the specified cursor. * first [Int](https://shopify.dev/docs/api/storefront/latest/scalars/Int) Returns up to the first `n` elements from the list. * last [Int](https://shopify.dev/docs/api/storefront/latest/scalars/Int) Returns up to the last `n` elements from the list. * reverse [Boolean](https://shopify.dev/docs/api/storefront/latest/scalars/Boolean) Default:false Reverse the order of the underlying list. *** * edited [Boolean!](https://shopify.dev/docs/api/storefront/latest/scalars/Boolean) non-null Token access required Whether the order has had any edits applied or not. * email [String](https://shopify.dev/docs/api/storefront/latest/scalars/String) Token access required The customer's email address. * financial​Status [Order​Financial​Status](https://shopify.dev/docs/api/storefront/latest/enums/OrderFinancialStatus) Token access required The financial status of the order. * fulfillment​Status [Order​Fulfillment​Status!](https://shopify.dev/docs/api/storefront/latest/enums/OrderFulfillmentStatus) non-null Token access required The fulfillment status for the order. * id [ID!](https://shopify.dev/docs/api/storefront/latest/scalars/ID) non-null Token access required A globally-unique ID. * line​Items [Order​Line​Item​Connection!](https://shopify.dev/docs/api/storefront/latest/connections/OrderLineItemConnection) non-null Token access required List of the order’s line items. * after [String](https://shopify.dev/docs/api/storefront/latest/scalars/String) ### Arguments Returns the elements that come after the specified cursor. * before [String](https://shopify.dev/docs/api/storefront/latest/scalars/String) Returns the elements that come before the specified cursor. * first [Int](https://shopify.dev/docs/api/storefront/latest/scalars/Int) Returns up to the first `n` elements from the list. * last [Int](https://shopify.dev/docs/api/storefront/latest/scalars/Int) Returns up to the last `n` elements from the list. * reverse [Boolean](https://shopify.dev/docs/api/storefront/latest/scalars/Boolean) Default:false Reverse the order of the underlying list. *** * metafield [Metafield](https://shopify.dev/docs/api/storefront/latest/objects/Metafield) Token access required A [custom field](https://shopify.dev/docs/apps/build/custom-data), including its `namespace` and `key`, that's associated with a Shopify resource for the purposes of adding and storing additional information. * key [String!](https://shopify.dev/docs/api/storefront/latest/scalars/String) required ### Arguments The identifier for the metafield. * namespace [String](https://shopify.dev/docs/api/storefront/latest/scalars/String) The container the metafield belongs to. If omitted, the app-reserved namespace will be used. *** * metafields [\[Metafield\]!](https://shopify.dev/docs/api/storefront/latest/objects/Metafield) non-null Token access required A list of [custom fields](https://shopify.dev/docs/apps/build/custom-data) that a merchant associates with a Shopify resource. * identifiers [\[Has​Metafields​Identifier!\]!](https://shopify.dev/docs/api/storefront/latest/input-objects/HasMetafieldsIdentifier) required ### Arguments The list of metafields to retrieve by namespace and key. The input must not contain more than `250` values. *** * name [String!](https://shopify.dev/docs/api/storefront/latest/scalars/String) non-null Token access required Unique identifier for the order that appears on the order. For example, *#1000* or \_Store1001. * order​Number [Int!](https://shopify.dev/docs/api/storefront/latest/scalars/Int) non-null Token access required A unique numeric identifier for the order for use by shop owner and customer. * original​Total​Duties [Money​V2](https://shopify.dev/docs/api/storefront/latest/objects/MoneyV2) Token access required The total cost of duties charged at checkout. * original​Total​Price [Money​V2!](https://shopify.dev/docs/api/storefront/latest/objects/MoneyV2) non-null Token access required The total price of the order before any applied edits. * phone [String](https://shopify.dev/docs/api/storefront/latest/scalars/String) Token access required The customer's phone number for receiving SMS notifications. * processed​At [Date​Time!](https://shopify.dev/docs/api/storefront/latest/scalars/DateTime) non-null Token access required 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. * shipping​Address [Mailing​Address](https://shopify.dev/docs/api/storefront/latest/objects/MailingAddress) Token access required The address to where the order will be shipped. * shipping​Discount​Allocations [\[Discount​Allocation!\]!](https://shopify.dev/docs/api/storefront/latest/objects/DiscountAllocation) non-null Token access required The discounts that have been allocated onto the shipping line by discount applications. * status​Url [URL!](https://shopify.dev/docs/api/storefront/latest/scalars/URL) non-null Token access required The unique URL for the order's status page. * subtotal​Price [Money​V2](https://shopify.dev/docs/api/storefront/latest/objects/MoneyV2) Token access required Price of the order before shipping and taxes. * successful​Fulfillments [\[Fulfillment!\]](https://shopify.dev/docs/api/storefront/latest/objects/Fulfillment) Token access required List of the order’s successful fulfillments. * first [Int](https://shopify.dev/docs/api/storefront/latest/scalars/Int) ### Arguments Truncate the array result to this size. *** * total​Price [Money​V2!](https://shopify.dev/docs/api/storefront/latest/objects/MoneyV2) non-null Token access required The sum of all the prices of all the items in the order, duties, taxes and discounts included (must be positive). * total​Refunded [Money​V2!](https://shopify.dev/docs/api/storefront/latest/objects/MoneyV2) non-null Token access required The total amount that has been refunded. * total​Shipping​Price [Money​V2!](https://shopify.dev/docs/api/storefront/latest/objects/MoneyV2) non-null Token access required The total cost of shipping. * total​Tax [Money​V2](https://shopify.dev/docs/api/storefront/latest/objects/MoneyV2) Token access required The total cost of taxes. ### Deprecated fields * subtotal​Price​V2 [Money​V2](https://shopify.dev/docs/api/storefront/latest/objects/MoneyV2) Deprecated Token access required * total​Price​V2 [Money​V2!](https://shopify.dev/docs/api/storefront/latest/objects/MoneyV2) non-nullDeprecated Token access required * total​Refunded​V2 [Money​V2!](https://shopify.dev/docs/api/storefront/latest/objects/MoneyV2) non-nullDeprecated Token access required * total​Shipping​Price​V2 [Money​V2!](https://shopify.dev/docs/api/storefront/latest/objects/MoneyV2) non-nullDeprecated Token access required * total​Tax​V2 [Money​V2](https://shopify.dev/docs/api/storefront/latest/objects/MoneyV2) Deprecated Token access required *** ## Map ### Fields and connections with this object * [Customer.orders](https://shopify.dev/docs/api/storefront/latest/objects/Customer#field-Customer.fields.orders) * [OrderConnection.nodes](https://shopify.dev/docs/api/storefront/latest/connections/OrderConnection#returns-nodes) * [OrderEdge.node](https://shopify.dev/docs/api/storefront/latest/objects/OrderEdge#field-OrderEdge.fields.node) ### Possible type in * [Metafield​Parent​Resource](https://shopify.dev/docs/api/storefront/latest/unions/MetafieldParentResource) *** ## Interfaces * * [Has​Metafields](https://shopify.dev/docs/api/storefront/latest/interfaces/HasMetafields) interface * [Node](https://shopify.dev/docs/api/storefront/latest/interfaces/Node) interface *** ## Order Implements ### Implements * [Has​Metafields](https://shopify.dev/docs/api/storefront/latest/interfaces/HasMetafields) * [Node](https://shopify.dev/docs/api/storefront/latest/interfaces/Node)