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.
additionalFees•
[AdditionalFee!]!
non-null
A list of additional fees applied to the order.
agreements•
SalesAgreementConnection!
non-null
A list of sales agreements associated with the order.
alerts•
[ResourceAlert!]!
non-null
A list of messages that appear on the order page in the Shopify admin.
app•
OrderApp
The application that created the order.
billingAddress•
MailingAddress
The billing address of the customer.
billingAddressMatchesShippingAddress•
Boolean!
non-null
Whether the billing address matches the shipping address.
cancellation•
OrderCancellation
Cancellation details for the order.
cancelledAt•
DateTime
The date and time when the order was canceled.
Returns null if the order wasn't canceled.
cancelReason•
OrderCancelReason
The reason provided when the order was canceled.
Returns null if the order wasn't canceled.
canMarkAsPaid•
Boolean!
non-null
Whether the order can be manually marked as paid.
canNotifyCustomer•
Boolean!
non-null
Whether a customer email exists for the order.
capturable•
Boolean!
non-null
Whether payment for the order can be captured.
cartDiscountAmountSet•
MoneyBag
The total order-level discount amount, before returns, in shop and presentment currencies.
channelInformation•
ChannelInformation
Details about the channel that created the order.
clientIp•
String
The IP address of the API client that created the order.
closed•
Boolean!
non-null
Whether the order is closed.
closedAt•
DateTime
The date and time when the order was closed.
Returns null if the order isn't closed.
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.
confirmed•
Boolean!
non-null
Whether inventory has been reserved for the order.
createdAt•
DateTime!
non-null
Date and time when the order was created in Shopify.
currencyCode•
CurrencyCode!
non-null
The shop currency when the order was placed.
currentCartDiscountAmountSet•
MoneyBag!
non-null
The current order-level discount amount after all order updates, in shop and presentment currencies.
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.
currentSubtotalLineItemsQuantity•
Int!
non-null
The sum of the quantities for all line items that contribute to the order's current subtotal price.
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.
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.
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.
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.
currentTotalDutiesSet•
MoneyBag
The total amount of duties after returns, in shop and presentment currencies.
Returns null if duties aren't applicable.
currentTotalPriceSet•
MoneyBag!
non-null
The total price of the order, after returns, in shop and presentment currencies.
This includes taxes and discounts.
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.
currentTotalWeight•
UnsignedInt64!
non-null
The total weight of the order after returns, in grams.
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.
customer•
Customer
The customer that placed the order.
customerAcceptsMarketing•
Boolean!
non-null
Whether the customer agreed to receive marketing materials.
customerJourneySummary•
CustomerJourneySummary
The customer's visits and interactions with the online store before placing the order.
customerLocale•
String
A two-letter or three-letter language code, optionally followed by a region modifier.
discountApplications•
DiscountApplicationConnection!
non-null
A list of discounts that are applied to the order, not including order edits and refunds.
discountCode•
String
The discount code used for the order.
discountCodes•
[String!]!
non-null
The discount codes used for the order.
displayAddress•
MailingAddress
The primary address of the customer.
Returns null if neither the shipping address nor the billing address was provided.
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.
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.
disputes•
[OrderDisputeSummary!]!
non-null
A list of the disputes associated with the order.
dutiesIncluded•
Boolean!
non-null
Whether duties are included in the subtotal price of the order.