Order
object

Choose a version:

Requires read_orders access scope or read_marketplace_orders access scope.

An order is a customer's request to purchase one or more products from a shop. You can retrieve and update orders using the Order object. Learn more about editing an existing order with the GraphQL Admin API.

Only the last 60 days' worth of orders from a store are accessible from the Order object by default. If you want to access older orders, then you need to request access to all orders. If your app is granted access, then you can add the read_all_orders scope to your app along with read_orders or write_orders. Private apps are not affected by this change and are automatically granted the scope.

Caution: Only use this data if it's required for your app's functionality. Shopify will restrict access to scopes for apps that don't have a legitimate use for the associated data.

Anchor to section titled 'Fields and connections'

Fields and connections

Anchor to Order.additionalFees additionalFees [AdditionalFee!]! non-null: A list of additional fees applied to the order.
Anchor to Order.agreements agreements SalesAgreementConnection! non-null: A list of sales agreements associated with the order.
Anchor to Order.alerts alerts [ResourceAlert!]! non-null: A list of messages that appear on the order page in the Shopify admin.
Anchor to Order.app app OrderApp: The application that created the order.
Anchor to Order.billingAddress billingAddress MailingAddress: The billing address of the customer.
Anchor to Order.billingAddressMatchesShippingAddress billingAddressMatchesShippingAddress Boolean! non-null: Whether the billing address matches the shipping address.
Anchor to Order.cancellation cancellation OrderCancellation: Cancellation details for the order.
Anchor to Order.cancelledAt cancelledAt DateTime: The date and time when the order was canceled. Returns null if the order wasn't canceled.
Anchor to Order.cancelReason cancelReason OrderCancelReason: The reason provided when the order was canceled. Returns null if the order wasn't canceled.
Anchor to Order.canMarkAsPaid canMarkAsPaid Boolean! non-null: Whether the order can be manually marked as paid.
Anchor to Order.canNotifyCustomer canNotifyCustomer Boolean! non-null: Whether a customer email exists for the order.
Anchor to Order.capturable capturable Boolean! non-null: Whether payment for the order can be captured.
Anchor to Order.cartDiscountAmountSet cartDiscountAmountSet MoneyBag: The total order-level discount amount, before returns, in shop and presentment currencies.
Anchor to Order.channelInformation channelInformation ChannelInformation: Details about the channel that created the order.
Anchor to Order.clientIp clientIp String: The IP address of the API client that created the order.
Anchor to Order.closed closed Boolean! non-null: Whether the order is closed.
Anchor to Order.closedAt closedAt DateTime: The date and time when the order was closed. Returns null if the order isn't closed.
Anchor to Order.confirmationNumber confirmationNumber 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.
Anchor to Order.confirmed confirmed Boolean! non-null: Whether inventory has been reserved for the order.
Anchor to Order.createdAt createdAt DateTime! non-null: Date and time when the order was created in Shopify.
Anchor to Order.currencyCode currencyCode CurrencyCode! non-null: The shop currency when the order was placed.
Anchor to Order.currentCartDiscountAmountSet currentCartDiscountAmountSet MoneyBag! non-null: The current order-level discount amount after all order updates, in shop and presentment currencies.
Anchor to Order.currentShippingPriceSet currentShippingPriceSet MoneyBag! non-null: The current shipping price after applying refunds and discounts. If the parent order.taxesIncluded field is true, then this price includes taxes. Otherwise, this field is the pre-tax price.
Anchor to Order.currentSubtotalLineItemsQuantity currentSubtotalLineItemsQuantity Int! non-null: The sum of the quantities for all line items that contribute to the order's current subtotal price.
Anchor to Order.currentSubtotalPriceSet currentSubtotalPriceSet MoneyBag! non-null: The sum of the prices for all line items after discounts and returns, in shop and presentment currencies. If taxesIncluded is true, then the subtotal also includes tax.
Anchor to Order.currentTaxLines currentTaxLines [TaxLine!]! non-null: A list of all tax lines applied to line items on the order, after returns. Tax line prices represent the total price for all tax lines with the same rate and title.
Anchor to Order.currentTotalAdditionalFeesSet currentTotalAdditionalFeesSet MoneyBag: The total amount of additional fees after returns, in shop and presentment currencies. Returns null if there are no additional fees for the order.
Anchor to Order.currentTotalDiscountsSet currentTotalDiscountsSet MoneyBag! non-null: The total amount discounted on the order after returns, in shop and presentment currencies. This includes both order and line level discounts.
Anchor to Order.currentTotalDutiesSet currentTotalDutiesSet MoneyBag: The total amount of duties after returns, in shop and presentment currencies. Returns null if duties aren't applicable.
Anchor to Order.currentTotalPriceSet currentTotalPriceSet MoneyBag! non-null: The total price of the order, after returns, in shop and presentment currencies. This includes taxes and discounts.
Anchor to Order.currentTotalTaxSet currentTotalTaxSet MoneyBag! non-null: The sum of the prices of all tax lines applied to line items on the order, after returns, in shop and presentment currencies.
Anchor to Order.currentTotalWeight currentTotalWeight UnsignedInt64! non-null: The total weight of the order after returns, in grams.
Anchor to Order.customAttributes customAttributes [Attribute!]! non-null: A list of additional merchant-facing details that have been added to the order. For example, whether an order is a customer's first.
Anchor to Order.customer customer Customer: The customer that placed the order.
Anchor to Order.customerAcceptsMarketing customerAcceptsMarketing Boolean! non-null: Whether the customer agreed to receive marketing materials.
Anchor to Order.customerJourneySummary customerJourneySummary CustomerJourneySummary: The customer's visits and interactions with the online store before placing the order.
Anchor to Order.customerLocale customerLocale String: A two-letter or three-letter language code, optionally followed by a region modifier.
Anchor to Order.discountApplications discountApplications DiscountApplicationConnection! non-null: A list of discounts that are applied to the order, not including order edits and refunds.
Anchor to Order.discountCode discountCode String: The discount code used for the order.
Anchor to Order.discountCodes discountCodes [String!]! non-null: The discount codes used for the order.
Anchor to Order.displayAddress displayAddress MailingAddress: The primary address of the customer. Returns null if neither the shipping address nor the billing address was provided.
Anchor to Order.displayFinancialStatus displayFinancialStatus OrderDisplayFinancialStatus: The financial status of the order that can be shown to the merchant. This field doesn't capture all the details of an order's financial state. It should only be used for display summary purposes.
Anchor to Order.displayFulfillmentStatus displayFulfillmentStatus OrderDisplayFulfillmentStatus! non-null: The fulfillment status for the order that can be shown to the merchant. This field does not capture all the details of an order's fulfillment state. It should only be used for display summary purposes. For a more granular view of the fulfillment status, refer to the FulfillmentOrder object.
Anchor to Order.disputes disputes [OrderDisputeSummary!]! non-null: A list of the disputes associated with the order.
Anchor to Order.dutiesIncluded dutiesIncluded Boolean! non-null: Whether duties are included in the subtotal price of the order.
Anchor to Order.edited edited Boolean! non-null: Whether the order has had any edits applied.
Anchor to Order.email email String: The email address associated with the customer.
Anchor to Order.estimatedTaxes estimatedTaxes Boolean! non-null: Whether taxes on the order are estimated. This field returns false when taxes on the order are finalized and aren't subject to any changes.
Anchor to Order.events events EventConnection! non-null: A list of events associated with the order.
Anchor to Order.fulfillable fulfillable Boolean! non-null: Whether there are line items that can be fulfilled. This field returns false when the order has no fulfillable line items. For a more granular view of the fulfillment status, refer to the FulfillmentOrder object.
Anchor to Order.fulfillmentOrders fulfillmentOrders FulfillmentOrderConnection! non-null: A list of fulfillment orders for a specific order.

FulfillmentOrder API access scopes govern which fulfillments orders are returned. An API client will only receive a subset of the fulfillment orders which belong to an order if they don't have the necessary access scopes to view all of the fulfillment orders. In the case that an API client does not have the access scopes necessary to view any of the fulfillment orders that belong to an order, an empty array will be returned.
Anchor to Order.fulfillments fulfillments [Fulfillment!]! non-null: List of shipments for the order.
Anchor to Order.fulfillmentsCount fulfillmentsCount Count: The count of fulfillments including the cancelled fulfillments.
Anchor to Order.fullyPaid fullyPaid Boolean! non-null: Whether the order has been paid in full.
Anchor to Order.hasTimelineComment hasTimelineComment Boolean! non-null: Whether the merchant added a timeline comment to the order.
Anchor to Order.id id ID! non-null: A globally-unique ID.
Anchor to Order.legacyResourceId legacyResourceId UnsignedInt64! non-null: The ID of the corresponding resource in the REST Admin API.
Anchor to Order.lineItems lineItems LineItemConnection! non-null: A list of the order's line items.
Anchor to Order.localizationExtensions localizationExtensions LocalizationExtensionConnection! non-null: List of localization extensions for the resource.
Anchor to Order.merchantBusinessEntity merchantBusinessEntity BusinessEntity! non-null: The merchant's business entity associated with the order.
Anchor to Order.merchantEditable merchantEditable Boolean! non-null: Whether the order can be edited by the merchant. For example, canceled orders can’t be edited.
Anchor to Order.merchantEditableErrors merchantEditableErrors [String!]! non-null: A list of reasons why the order can't be edited. For example, "Canceled orders can't be edited".
Anchor to Order.merchantOfRecordApp merchantOfRecordApp OrderApp: The application acting as the Merchant of Record for the order.
Anchor to Order.metafield metafield Metafield: A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.
Anchor to Order.metafields metafields MetafieldConnection! non-null: A list of custom fields that a merchant associates with a Shopify resource.
Anchor to Order.name name String! non-null: The unique identifier for the order that appears on the order page in the Shopify admin and the Order status page. For example, "#1001", "EN1001", or "1001-A". This value isn't unique across multiple stores.
Anchor to Order.netPaymentSet netPaymentSet MoneyBag! non-null: The net payment for the order, based on the total amount received minus the total amount refunded, in shop and presentment currencies.
Anchor to Order.nonFulfillableLineItems nonFulfillableLineItems LineItemConnection! non-null: A list of line items that can't be fulfilled. For example, tips and fully refunded line items can't be fulfilled. For a more granular view of the fulfillment status, refer to the FulfillmentOrder object.
Anchor to Order.note note String: The contents of the note associated with the order.
Anchor to Order.originalTotalAdditionalFeesSet originalTotalAdditionalFeesSet MoneyBag: The total amount of additional fees after returns, in shop and presentment currencies. Returns null if there are no additional fees for the order.
Anchor to Order.originalTotalDutiesSet originalTotalDutiesSet MoneyBag: The total amount of duties before returns, in shop and presentment currencies. Returns null if duties aren't applicable.
Anchor to Order.originalTotalPriceSet originalTotalPriceSet MoneyBag! non-null: The total price of the order at the time of order creation, in shop and presentment currencies.
Anchor to Order.paymentCollectionDetails paymentCollectionDetails OrderPaymentCollectionDetails! non-null: The payment collection details for the order.
Anchor to Order.paymentGatewayNames paymentGatewayNames [String!]! non-null: A list of the names of all payment gateways used for the order. For example, "Shopify Payments" and "Cash on Delivery (COD)".
Anchor to Order.paymentTerms paymentTerms PaymentTerms: The payment terms associated with the order.
Anchor to Order.phone phone String: The phone number associated with the customer.
Anchor to Order.poNumber poNumber String: The PO number associated with the order.
Anchor to Order.presentmentCurrencyCode presentmentCurrencyCode CurrencyCode! non-null: The payment CurrencyCode of the customer for the order.
Anchor to Order.processedAt processedAt DateTime! non-null: The date and time when the order was processed. This date and time might not match the date and time when the order was created.
Anchor to Order.publication publication Publication: The publication that the order was created from.
Anchor to Order.purchasingEntity purchasingEntity PurchasingEntity: The purchasing entity for the order.
Anchor to Order.refundable refundable Boolean! non-null: Whether the order can be refunded.
Anchor to Order.refundDiscrepancySet refundDiscrepancySet MoneyBag! non-null: The difference between the suggested and actual refund amount of all refunds that have been applied to the order. A positive value indicates a difference in the merchant's favor, and a negative value indicates a difference in the customer's favor.
Anchor to Order.refunds refunds [Refund!]! non-null: A list of refunds that have been applied to the order.
Anchor to Order.registeredSourceUrl registeredSourceUrl URL: The URL of the source that the order originated from, if found in the domain registry.
Anchor to Order.requiresShipping requiresShipping Boolean! non-null: Whether the order has shipping lines or at least one line item on the order that requires shipping.
Anchor to Order.restockable restockable Boolean! non-null: Whether any line item on the order can be restocked.
Anchor to Order.retailLocation retailLocation Location: The physical location where a retail order is created or completed, except for draft POS orders completed via the “mark as paid” flow in Admin, which return null.
Anchor to Order.returns returns ReturnConnection! non-null: A list of returns for the order.
Anchor to Order.returnStatus returnStatus OrderReturnStatus! non-null: The order's aggregated return status for display purposes.
Anchor to Order.risk risk OrderRiskSummary! non-null: The risk characteristics for the order.
Anchor to Order.shippingAddress shippingAddress MailingAddress: The mailing address of the customer.
Anchor to Order.shippingLine shippingLine ShippingLine: A summary of all shipping costs on the order.
Anchor to Order.shippingLines shippingLines ShippingLineConnection! non-null: A list of the order's shipping lines.
Anchor to Order.shopifyProtect shopifyProtect ShopifyProtectOrderSummary: The Shopify Protect details for the order. If Shopify Protect is disabled for the shop, then this will be null.
Anchor to Order.sourceIdentifier sourceIdentifier String: A unique POS or third party order identifier. For example, "1234-12-1000" or "111-98567-54". The receipt_number field is derived from this value for POS orders.
Anchor to Order.sourceName sourceName String: The name of the source associated with the order.
Anchor to Order.staffMember staffMember StaffMember: The staff member associated with the order.
Anchor to Order.statusPageUrl statusPageUrl URL! non-null: The URL where the customer can check the order's current status.
Anchor to Order.subtotalLineItemsQuantity subtotalLineItemsQuantity Int! non-null: The sum of the quantities for all line items that contribute to the order's subtotal price.
Anchor to Order.subtotalPriceSet subtotalPriceSet MoneyBag: The sum of the prices for all line items after discounts and before returns, in shop and presentment currencies. If taxesIncluded is true, then the subtotal also includes tax.
Anchor to Order.suggestedRefund suggestedRefund SuggestedRefund: A suggested refund for the order.
Anchor to Order.tags tags [String!]! non-null: 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.
Anchor to Order.taxesIncluded taxesIncluded Boolean! non-null: Whether taxes are included in the subtotal price of the order.
Anchor to Order.taxExempt taxExempt Boolean! non-null: Whether taxes are exempt on the order.
Anchor to Order.taxLines taxLines [TaxLine!]! non-null: A list of all tax lines applied to line items on the order, before returns. Tax line prices represent the total price for all tax lines with the same rate and title.
Anchor to Order.test test Boolean! non-null: Whether the order is a test. Test orders are made using the Shopify Bogus Gateway or a payment provider with test mode enabled. A test order can't be converted into a real order and vice versa.
Anchor to Order.totalCapturableSet totalCapturableSet MoneyBag! non-null: The authorized amount that's uncaptured or undercaptured, in shop and presentment currencies. This amount isn't adjusted for returns.
Anchor to Order.totalCashRoundingAdjustment totalCashRoundingAdjustment CashRoundingAdjustment! non-null: The total rounding adjustment applied to payments or refunds for an Order involving cash payments. Applies to some countries where cash transactions are rounded to the nearest currency denomination.
Anchor to Order.totalDiscountsSet totalDiscountsSet MoneyBag: The total amount discounted on the order before returns, in shop and presentment currencies. This includes both order and line level discounts.
Anchor to Order.totalOutstandingSet totalOutstandingSet MoneyBag! non-null: The total amount not yet transacted for the order, in shop and presentment currencies. A positive value indicates a difference in the merchant's favor (payment from customer to merchant) and a negative value indicates a difference in the customer's favor (refund from merchant to customer).
Anchor to Order.totalPriceSet totalPriceSet MoneyBag! non-null: The total price of the order, before returns, in shop and presentment currencies. This includes taxes and discounts.
Anchor to Order.totalReceivedSet totalReceivedSet MoneyBag! non-null: The total amount received from the customer before returns, in shop and presentment currencies.
Anchor to Order.totalRefundedSet totalRefundedSet MoneyBag! non-null: The total amount that was refunded, in shop and presentment currencies.
Anchor to Order.totalRefundedShippingSet totalRefundedShippingSet MoneyBag! non-null: The total amount of shipping that was refunded, in shop and presentment currencies.
Anchor to Order.totalShippingPriceSet totalShippingPriceSet MoneyBag! non-null: The total shipping amount before discounts and returns, in shop and presentment currencies.
Anchor to Order.totalTaxSet totalTaxSet MoneyBag: The total tax amount before returns, in shop and presentment currencies.
Anchor to Order.totalTipReceivedSet totalTipReceivedSet MoneyBag! non-null: The sum of all tip amounts for the order, in shop and presentment currencies.
Anchor to Order.totalWeight totalWeight UnsignedInt64: The total weight of the order before returns, in grams.
Anchor to Order.transactions transactions [OrderTransaction!]! non-null: A list of transactions associated with the order.
Anchor to Order.transactionsCount transactionsCount Count: The number of transactions associated with the order.
Anchor to Order.unpaid unpaid Boolean! non-null: Whether no payments have been made for the order.
Anchor to Order.updatedAt updatedAt DateTime! non-null: The date and time when the order was modified last.

Was this section helpful?

Anchor to section titled 'Queries'

Queries

Anchor to order order query: Returns an Order resource by ID.
Anchor to orders orders query: Returns a list of orders placed in the store.

Was this section helpful?

<?>

Order Queries

Order

Queried by

Anchor to section titled 'Mutations'

Mutations

Anchor to orderClose orderClose mutation: Closes an open order.
Anchor to orderCreate orderCreate mutation: Creates an order.
Anchor to orderEditCommit orderEditCommit mutation: Applies and saves staged changes to an order. Mutations are operating on OrderEdit. All order edits start with orderEditBegin, have any number of orderEdit* mutations made, and end with orderEditCommit.
Anchor to orderInvoiceSend orderInvoiceSend mutation: Sends an email invoice for an order.
Anchor to orderMarkAsPaid orderMarkAsPaid mutation: Marks an order as paid. You can only mark an order as paid if it isn't already fully paid.
Anchor to orderOpen orderOpen mutation: Opens a closed order.
Anchor to orderUpdate orderUpdate mutation: Updates the fields of an order.
Anchor to refundCreate refundCreate mutation: Creates a refund.

Was this section helpful?

<~>

Order Mutations

Order

Mutated by

Anchor to section titled 'Implements'

Implements

Anchor to CommentEventSubject CommentEventSubject interface
Anchor to HasEvents HasEvents interface
Anchor to HasLocalizationExtensions HasLocalizationExtensions interface
Anchor to HasMetafieldDefinitions HasMetafieldDefinitions interface
Anchor to HasMetafields HasMetafields interface
Anchor to LegacyInteroperability LegacyInteroperability interface
Anchor to Node Node interface

Was this section helpful?

||-

Order Implements

Order

Order
object

Fields and connections

Fields and connections from

Possible types in

Queries

Queried by

Mutations

Mutated by

Implements

Implements

Orderobject

Fields and connections

Fields and connections from

Possible types in

Queries

Queried by

Mutations

Mutated by

Implements

Implements

Order
object