Order object

An order represents an agreement to do business between a customer and a merchant.

Required access

read_orders access scope.

On this page

• Connections
• Fields
• Types that return Order
• Mutations for Order
• Implements
• Deprecated fields
• Samples

Connections

• discountApplications ([DiscountApplicationConnection!](https://shopify.dev/docs/admin-api/graphql/reference/orders/discountapplication))
  Discounts that have been applied on the order.

• events ([EventConnection!](https://shopify.dev/docs/admin-api/graphql/reference/events/eventconnection))
  List of internal events associated with the order.

• fulfillmentOrders ([FulfillmentOrderConnection!](https://shopify.dev/docs/admin-api/graphql/reference/shipping-and-fulfillment/fulfillmentorder))
  List of fulfillment orders with pagination.

• lineItems ([LineItemConnection!](https://shopify.dev/docs/admin-api/graphql/reference/orders/lineitem))
  List of the order’s line items.

• localizationExtensions ([LocalizationExtensionConnection!](https://shopify.dev/docs/admin-api/graphql/reference/translations/localizationextensionconnection))
  List of localization extensions for the resource.

• metafields ([MetafieldConnection!](https://shopify.dev/docs/admin-api/graphql/reference/metafields/metafieldconnection))
  A paginated list of metafields associated with the resource.

• nonFulfillableLineItems ([LineItemConnection!](https://shopify.dev/docs/admin-api/graphql/reference/orders/lineitem))
  Line items that can’t be fulfilled. For example, because some or all of the items have been refunded, or the item is not one which can be fulfilled, such as a tip. These line items would be ‘lost’ if you only considered the line items in draft fulfillments or fulfillments.

• privateMetafields ([PrivateMetafieldConnection!](https://shopify.dev/docs/admin-api/graphql/reference/metafields/privatemetafieldconnection))
  List of private metafields.

• shippingLines ([ShippingLineConnection!](https://shopify.dev/docs/admin-api/graphql/reference/orders/shippingline))
  List of line items that contains the shipping costs.

Fields

• alerts ([[ResourceAlert!]!](https://shopify.dev/docs/admin-api/graphql/reference/events/resourcealert))
  Generated messages that appear at the top of an order page in the Shopify admin. For example, this is a test order.
• billingAddress ([MailingAddress](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/mailingaddress))
  Mailing address provided by the customer. Not all orders have mailing addresses.
• billingAddressMatchesShippingAddress ([Boolean!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01))
  Whether the billing address matches the shipping address.
• canMarkAsPaid ([Boolean!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01))
  Whether the order can be manually marked as paid.
• canNotifyCustomer ([Boolean!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01))
  Whether notifications can be sent to the customer or not.
• cancelReason ([OrderCancelReason](https://shopify.dev/docs/admin-api/graphql/reference/orders/ordercancelreason))
  Reason the order was canceled. Returns null if the order wasn’t canceled.
• cancelledAt ([DateTime](https://shopify.dev/docs/admin-api/graphql/reference/scalar#datetime-2021-01))
  Date and time when the order was canceled. Returns null if the order wasn’t canceled.
• capturable ([Boolean!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01))
  Whether payment for the order can be captured. Returns true when the customer’s credit card has been authorized for payment and the authorization period has not expired.
• cartDiscountAmountSet ([MoneyBag](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneybag))
  Amount of the order-level discount (does not contain any line item discounts) in shop and presentment currencies.
• clientIp ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
  The ip address of the client that is associated with this order.
• closed ([Boolean!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01))
  Whether the order is closed.
• closedAt ([DateTime](https://shopify.dev/docs/admin-api/graphql/reference/scalar#datetime-2021-01))
  Date and time when the order closed. If the order is not closed, then this field is null.
• confirmed ([Boolean!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01))
  Whether inventory has been reserved for the order.
• createdAt ([DateTime!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#datetime-2021-01))
  Date and time when the order was created in Shopify.
• currencyCode ([CurrencyCode!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/currencycode))
  The currency of the store at the time of the order. If payment hasn’t occurred, then this field is null.
• currentCartDiscountAmountSet ([MoneyBag!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneybag))
  The amount of the order-level discount minus the amounts for line items that have been returned. This doesn’t include line item discounts.
• currentSubtotalLineItemsQuantity ([Int!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01))
  The sum of the quantities for the line items that contribute to the order’s subtotal.
• currentSubtotalPriceSet ([MoneyBag!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneybag))
  The subtotal of line items and their discounts minus the line items that have been returned. This includes order-level discounts, unless the argument with_cart_discount is set to false. This doesn’t include shipping costs and shipping discounts. Taxes are not included unless the order is a taxes-included order.
• currentTaxLines ([[TaxLine!]!](https://shopify.dev/docs/admin-api/graphql/reference/orders/taxline))
  The taxes charged for the order minus the taxes for line items that have been returned.
• currentTotalDiscountsSet ([MoneyBag!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneybag))
  The total amount discounted from the order (including order-level and line item discounts) minus the amounts for items that have been returned.
• currentTotalDutiesSet ([MoneyBag](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneybag))
  The total amount of duties for the order. If duties aren’t applicable, then this value is null.
• currentTotalPriceSet ([MoneyBag!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneybag))
  The total amount of the order (including taxes and discounts) minus the amounts for line items that have been returned.
• currentTotalTaxSet ([MoneyBag!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneybag))
  The total of all taxes applied to the order minus the taxes for line items that have been returned.
• currentTotalWeight ([UnsignedInt64!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#unsignedint64-2021-01))
  The total weight (grams) of the order minus the weights for line items that have been returned.
• customAttributes ([[Attribute!]!](https://shopify.dev/docs/admin-api/graphql/reference/orders/attribute))
  Custom information added to the order by your customer (Also referred to as note attributes).
• customer ([Customer](https://shopify.dev/docs/admin-api/graphql/reference/customers/customer))
  Unique identifier of the customer who placed the order. Not all orders have customers associated with them.
• customerAcceptsMarketing ([Boolean!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01))
  Whether the customer agreed to receive marketing materials.
• customerJourneySummary ([CustomerJourneySummary](https://shopify.dev/docs/admin-api/graphql/reference/discounts-and-marketing/customerjourneysummary))
  Description of the customer’s experience with the store leading up to the order. Loaded asynchronously, consumers should poll until the ‘ready’ field resolves to true.
• customerLocale ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
  A two-letter or three-letter language code, optionally followed by a region modifier. Example values could be ‘en’, ‘en-CA’, ‘en-PIRATE’.
• discountCode ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
  Discount code provided by the customer.
• displayAddress ([MailingAddress](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/mailingaddress))
  Primary address of the customer, which is shown on the order.
• displayFinancialStatus ([OrderDisplayFinancialStatus](https://shopify.dev/docs/admin-api/graphql/reference/orders/orderdisplayfinancialstatus))
  Financial status of the order that can be shown to the merchant. This field does not capture all the possible details of an order’s financial state and should only be used for display summary purposes.
• displayFulfillmentStatus ([OrderDisplayFulfillmentStatus!](https://shopify.dev/docs/admin-api/graphql/reference/orders/orderdisplayfulfillmentstatus))
  Fulfillment status for the order that can be shown to the merchant. This field does not capture all the possible details of an order’s fulfillment state. It should only be used for display summary purposes.
• disputes ([[OrderDisputeSummary!]!](https://shopify.dev/docs/admin-api/graphql/reference/shopify-payments/orderdisputesummary))
  Summary of each dispute associated with the order. Sorted in ascending (ASC) order by ID.
• edited ([Boolean!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01))
  Whether the order has had any edits applied or not.
• email ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
  Email address provided by the customer.
• fulfillable ([Boolean!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01))
  Whether there are items that can be fulfilled. After an order is completely fulfilled (or completely refunded without any fulfillments) then this field returns false.
• fulfillments ([[Fulfillment!]!](https://shopify.dev/docs/admin-api/graphql/reference/shipping-and-fulfillment/fulfillment))
  List of shipments for the order.

• fullyPaid ([Boolean!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01))
  Whether the order has been paid in full.
• hasTimelineComment ([Boolean!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01))
  Whether the merchant added timeline comments to the order.
• id ([ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01))
  Globally unique identifier.
• legacyResourceId ([UnsignedInt64!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#unsignedint64-2021-01))
  The ID of the corresponding resource in the REST Admin API.
• merchantEditable ([Boolean!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01))
  Whether the order can be edited or not.
• merchantEditableErrors ([[String!]!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
  A list of reasons of why the order cannot be edited.
• metafield ([Metafield](https://shopify.dev/docs/admin-api/graphql/reference/metafields/metafield))
  The metafield associated with the resource.

• name ([String!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
  Unique identifier for the order that appears on the order. For example, #1000 or _Store1001. This value is not unique across multiple stores.
• netPaymentSet ([MoneyBag!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneybag))
  Net payment for the order, based on the total amount received - total amount refunded in shop and presentment currencies.
• note ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
  Contents of the note associated with the order.
• originalTotalDutiesSet ([MoneyBag](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneybag))
  The total amount of duties prior to any applied edits for the order. If duties aren’t applicable, then this value is null.
• originalTotalPriceSet ([MoneyBag!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneybag))
  Total price of the order prior to any applied edits in shop and presentment currencies.
• paymentCollectionDetails ([OrderPaymentCollectionDetails!](https://shopify.dev/docs/admin-api/graphql/reference/orders/orderpaymentcollectiondetails))
  The payment collection details for an order requiring additional payment.
• paymentGatewayNames ([[String!]!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
  List of all payment gateways used for the order. For example, authorize_net and Cash on Delivery (COD).
• phone ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
  Phone number provided by the customer.
• physicalLocation ([Location](https://shopify.dev/docs/admin-api/graphql/reference/store-properties/location))
  If the order was processed using Shopify POS, then this is its location as provided by the merchant.
• presentmentCurrencyCode ([CurrencyCode!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/currencycode))
  The payment currency of the customer for this order.
• privateMetafield ([PrivateMetafield](https://shopify.dev/docs/admin-api/graphql/reference/metafields/privatemetafield))
  Returns a private metafield found by namespace and key.

• processedAt ([DateTime!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#datetime-2021-01))
  Date and time when the order was processed. When orders are imported from an app, this date and time may not match the date and time when the order was created.
• publication ([Publication](https://shopify.dev/docs/admin-api/graphql/reference/apps/publication))
  Publication that created the order.
• refundDiscrepancySet ([MoneyBag!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneybag))
  The difference between suggested and actual refund amounts. A positive value indicates a difference in the merchants favor and a negative value indicates a difference in the customers favor.
• refundable ([Boolean!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01))
  Whether the order can be refunded.
• refunds ([[Refund!]!](https://shopify.dev/docs/admin-api/graphql/reference/orders/refund))
  List of refunds that have been applied to the order.

• requiresShipping ([Boolean!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01))
  Whether any line item in the order requires physical shipping.
• restockable ([Boolean!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01))
  Whether the order can be restocked.
• riskLevel ([OrderRiskLevel!](https://shopify.dev/docs/admin-api/graphql/reference/orders/orderrisklevel))
  Fraud risk level of the order.
• risks ([[OrderRisk!]!](https://shopify.dev/docs/admin-api/graphql/reference/orders/orderrisk))
  The order risks associated with this order.

• shippingAddress ([MailingAddress](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/mailingaddress))
  Mailing address for shipping provided by the customer.
• shippingLine ([ShippingLine](https://shopify.dev/docs/admin-api/graphql/reference/orders/shippingline))
  Line item that contains the shipping costs.
• subtotalLineItemsQuantity ([Int!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01))
  The sum of the quantities for the line items that contribute to the order’s subtotal.
• subtotalPriceSet ([MoneyBag](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneybag))
  Subtotal of the line items and their discounts (does not contain shipping costs and shipping discounts) in shop and presentment currencies.
• suggestedRefund ([SuggestedRefund](https://shopify.dev/docs/admin-api/graphql/reference/orders/suggestedrefund))
  The details of the suggested refund. This response can be used to submit a RefundCreate mutation.

• tags ([[String!]!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
  A comma separated list of tags associated with the order. Updating tags overwrites any existing tags that were previously added to the order. To add new tags without overwriting existing tags, use the tagsAdd mutation.
• taxLines ([[TaxLine!]!](https://shopify.dev/docs/admin-api/graphql/reference/orders/taxline))
  Taxes charged for the line item.
• taxesIncluded ([Boolean!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01))
  Whether taxes are included in the subtotal price of the order.
• test ([Boolean!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01))
  Whether the order is a test. Test orders are made using the Shopify Bogus Gateway or a payment provider with test mode enabled.
• totalCapturableSet ([MoneyBag!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneybag))
  Amount authorized for the order, that is uncaptured or undercaptured in shop and presentment currencies.
• totalDiscountsSet ([MoneyBag](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneybag))
  Total amount discounted from the order (includes order-level and line item discounts) in shop and presentment currencies.
• totalOutstandingSet ([MoneyBag!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneybag))
  Total amount of money not yet authorized for the order.
• totalPriceSet ([MoneyBag!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneybag))
  Total amount of the order (includes taxes and discounts) in shop and presentment currencies.
• totalReceivedSet ([MoneyBag!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneybag))
  Total amount received by the customer for the order in shop and presentment currencies.
• totalRefundedSet ([MoneyBag!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneybag))
  Total amount refunded for the order in shop and presentment currencies.
• totalRefundedShippingSet ([MoneyBag!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneybag))
  Total amount refunded for shipping in shop and presentment currencies.
• totalShippingPriceSet ([MoneyBag!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneybag))
  Total amount charged for shipping the order in shop and presentment currencies.
• totalTaxSet ([MoneyBag](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneybag))
  Total of all taxes applied to the order in shop and presentment currencies.
• totalTipReceivedSet ([MoneyBag!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneybag))
  Total tip received for the order in shop and presentment currencies.
• totalWeight ([UnsignedInt64](https://shopify.dev/docs/admin-api/graphql/reference/scalar#unsignedint64-2021-01))
  Total weight (grams) of the order.
• transactions ([[OrderTransaction!]!](https://shopify.dev/docs/admin-api/graphql/reference/orders/ordertransaction))
  List of all transactions associated with the order.

• unpaid ([Boolean!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01))
  Whether no payments have been made for the order. If no payments have been made for the order, then this returns true.
• updatedAt ([DateTime!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#datetime-2021-01))
  Date and time when the order was last modified.

Types that return Order

• [CalculatedOrder.originalOrder](https://shopify.dev/docs/admin-api/graphql/reference/orders/calculatedorder#originalorder-2021-01)
• [Customer.lastOrder](https://shopify.dev/docs/admin-api/graphql/reference/customers/customer#lastorder-2021-01)
• [Customer.orders](https://shopify.dev/docs/admin-api/graphql/reference/customers/customer#orders-2021-01)
• [DraftOrder.order](https://shopify.dev/docs/admin-api/graphql/reference/orders/draftorder#order-2021-01)
• [Fulfillment.order](https://shopify.dev/docs/admin-api/graphql/reference/shipping-and-fulfillment/fulfillment#order-2021-01)
• [FulfillmentOrder.order](https://shopify.dev/docs/admin-api/graphql/reference/shipping-and-fulfillment/fulfillmentorder#order-2021-01)
• [OrderTransaction.order](https://shopify.dev/docs/admin-api/graphql/reference/orders/ordertransaction#order-2021-01)
• [QueryRoot.orders](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/queryroot#orders-2021-01)
• [QueryRoot.order](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/queryroot#order-2021-01)
• [Refund.order](https://shopify.dev/docs/admin-api/graphql/reference/orders/refund#order-2021-01)
• [ShopifyPaymentsDispute.order](https://shopify.dev/docs/admin-api/graphql/reference/shopify-payments/shopifypaymentsdispute#order-2021-01)
• [SubscriptionBillingAttempt.order](https://shopify.dev/docs/admin-api/graphql/reference/orders/subscriptionbillingattempt#order-2021-01)
• [SubscriptionContract.orders](https://shopify.dev/docs/admin-api/graphql/reference/orders/subscriptioncontract#orders-2021-01)
• [SubscriptionContract.originOrder](https://shopify.dev/docs/admin-api/graphql/reference/orders/subscriptioncontract#originorder-2021-01)

Mutations for Order

• orderCapture
  Captures from an authorized transaction on an order.
• orderClose
  Closes an open order.
• orderEditAddCustomItem
  Add a custom item to the order.
• orderEditAddLineItemDiscount
  Add a discount to an item added during this order edit.
• orderEditAddVariant
  Add a line item from an existing product variant.
• orderEditBegin
  Start editing an order.
• orderEditCommit
  Applies and saves staged changes to an order.
• orderEditRemoveLineItemDiscount
  Removes a discount that was added as part of this edit.
• orderEditSetQuantity
  Set the quantity of an item on the order.
• orderMarkAsPaid
  Marks an order as paid.
• orderOpen
  Opens a closed order.
• orderUpdate
  Updates an order.

Implements

• [CommentEventSubject](https://shopify.dev/docs/admin-api/graphql/reference/events/commenteventsubject)
• [HasEvents](https://shopify.dev/docs/admin-api/graphql/reference/events/hasevents)
• [HasLocalizationExtensions](https://shopify.dev/docs/admin-api/graphql/reference/translations/haslocalizationextensions)
• [HasMetafields](https://shopify.dev/docs/admin-api/graphql/reference/metafields/hasmetafields)
• [LegacyInteroperability](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/legacyinteroperability)
• [Node](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/node)

Deprecated fields

Show/Hide

An auto-generated type for paginating through multiple Orders.

On this page

• Fields

Fields

• edges ([[OrderEdge!]!](https://shopify.dev/docs/admin-api/graphql/reference/orders/order))
  A list of edges.
• pageInfo ([PageInfo!](https://shopify.dev/docs/admin-api/graphql/reference/pageinfo))
  Information to aid in pagination.

An auto-generated type which holds one Order and a cursor during pagination.

On this page

• Fields
• Types that return OrderEdge

Fields

• cursor ([String!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
  A cursor for use in pagination.
• node ([Order!](https://shopify.dev/docs/admin-api/graphql/reference/orders/order))
  The item at the end of OrderEdge.

Types that return OrderEdge

• [OrderConnection.edges](https://shopify.dev/docs/admin-api/graphql/reference/orders/order#edges-2021-01)