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.
displayRefundStatus•
OrderDisplayRefundStatus
The status of the refund(s) that can be shown to the merchant. Mostly used when a refund is in a deferred
state (i.e. it was not yet sent to the payments provider).
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.
edited•
Boolean!
non-null
Whether the order has had any edits applied.
email•
String
The email address associated with the customer.
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.
events•
EventConnection!
non-null
A list of events associated with the order.
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.
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.
fulfillments•
[Fulfillment!]!
non-null
List of shipments for the order.
fulfillmentsCount•
Count
The count of fulfillments including the cancelled fulfillments.
fullyPaid•
Boolean!
non-null
Whether the order has been paid in full.
hasTimelineComment•
Boolean!
non-null
Whether the merchant added a timeline comment to the order.
id•
ID!
non-null
A globally-unique ID.
incotermInformation•
IncotermInformation
Information about the incoterm used for the order.
legacyResourceId•
UnsignedInt64!
non-null
The ID of the corresponding resource in the REST Admin API.
lineItems•
LineItemConnection!
non-null
A list of the order's line items.
localizedFields•
LocalizedFieldConnection!
non-null
List of localized fields for the resource.
merchantBusinessEntity•
BusinessEntity!
non-null
The merchant's business entity associated with the order.
merchantEditable•
Boolean!
non-null
Whether the order can be edited by the merchant. For example, canceled orders can’t be edited.
merchantEditableErrors•
[String!]!
non-null
A list of reasons why the order can't be edited. For example, "Canceled orders can't be edited".
merchantOfRecordApp•
OrderApp
The application acting as the Merchant of Record for the order.
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.
metafields•
MetafieldConnection!
non-null
A list of custom fields
that a merchant associates with a Shopify resource.
metafieldsByIdentifiers•
[Metafield]!
non-null
The metafields associated with the resource matching the supplied list of namespaces and keys.
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.
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.
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.
note•
String
The contents of the note associated with the order.
number•
Int!
non-null
The order number used to generate the name using the store's configured order number prefix/suffix. This value isn't unique across multiple stores.
originalTotalAdditionalFeesSet•
MoneyBag
The total amount of additional fees at the time of order creation, in shop and presentment currencies.
Returns null if additional fees aren't applicable.
originalTotalDutiesSet•
MoneyBag
The total amount of duties at the time of order creation, in shop and presentment currencies.
Returns null if duties aren't applicable.
originalTotalPriceSet •
MoneyBag!
non-null
The total price of the order at the time of order creation, in shop and presentment currencies.
paymentCollectionDetails•
OrderPaymentCollectionDetails!
non-null
The payment collection details for the order.
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)".
paymentTerms•
PaymentTerms
The payment terms associated with the order.
phone•
String
The phone number associated with the customer.
poNumber•
String
The PO number associated with the order.
presentmentCurrencyCode•
CurrencyCode!
non-null
The payment CurrencyCode of the customer for the order.
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.
publication•
Publication
The publication that the order was created from.
purchasingEntity•
PurchasingEntity
The purchasing entity for the order.
refundable•
Boolean!
non-null
Whether the order can be refunded.
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.
refunds•
[Refund!]!
non-null
A list of refunds that have been applied to the order.
registeredSourceUrl•
URL
The URL of the source that the order originated from, if found in the domain registry.
requiresShipping•
Boolean!
non-null
Whether the order has shipping lines or at least one line item on the order that requires shipping.
restockable•
Boolean!
non-null
Whether any line item on the order can be restocked.
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. Transactions associated with the order might have been processed at a different location.
returns•
ReturnConnection!
non-null
A list of returns for the order.
returnStatus•
OrderReturnStatus!
non-null
The order's aggregated return status for display purposes.
risk•
OrderRiskSummary!
non-null
The risk characteristics for the order.
shippingAddress•
MailingAddress
The mailing address of the customer.
shippingLine•
ShippingLine
A summary of all shipping costs on the order.
shippingLines•
ShippingLineConnection!
non-null
A list of the order's shipping lines.
shopifyProtect•
ShopifyProtectOrderSummary
The Shopify Protect details for the order. If Shopify Protect is disabled for the shop, then this will be null.
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.
sourceName•
String
The name of the source associated with the order.
staffMember•
StaffMember
The staff member associated with the order.
statusPageUrl•
URL!
non-null
The URL where the customer can check the order's current status.
subtotalLineItemsQuantity•
Int!
non-null
The sum of the quantities for all line items that contribute to the order's subtotal price.
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.
suggestedRefund•
SuggestedRefund
A suggested refund for the order.
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.
taxesIncluded•
Boolean!
non-null
Whether taxes are included in the subtotal price of the order.
taxExempt•
Boolean!
non-null
Whether taxes are exempt on the order.
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.
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.
totalCapturableSet•
MoneyBag!
non-null
The authorized amount that's uncaptured or undercaptured, in shop and presentment currencies.
This amount isn't adjusted for returns.
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.
totalDiscountsSet•
MoneyBag
The total amount discounted on the order before returns, in shop and presentment currencies.
This includes both order and line level discounts.
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).
totalPriceSet•
MoneyBag!
non-null
The total price of the order, before returns, in shop and presentment currencies.
This includes taxes and discounts.
totalReceivedSet•
MoneyBag!
non-null
The total amount received from the customer before returns, in shop and presentment currencies.
totalRefundedSet•
MoneyBag!
non-null
The total amount that was refunded, in shop and presentment currencies.
totalRefundedShippingSet•
MoneyBag!
non-null
The total amount of shipping that was refunded, in shop and presentment currencies.
totalShippingPriceSet•
MoneyBag!
non-null
The total shipping amount before discounts and returns, in shop and presentment currencies.
totalTaxSet•
MoneyBag
The total tax amount before returns, in shop and presentment currencies.
totalTipReceivedSet•
MoneyBag!
non-null
The sum of all tip amounts for the order, in shop and presentment currencies.
totalWeight•
UnsignedInt64
The total weight of the order before returns, in grams.
transactions•
[OrderTransaction!]!
non-null
A list of transactions associated with the order.
transactionsCount•
Count
The number of transactions associated with the order.
unpaid•
Boolean!
non-null
Whether no payments have been made for the order.
updatedAt•
DateTime!
non-null
The date and time when the order was modified last.
cartDiscountAmount•
Money
The total order-level discount amount, before returns, in shop currency.
channel•
Channel
The channel that created the order.
customerJourney•
CustomerJourney
The customer's visits and interactions with the online store before placing the order.
landingPageDisplayText•
String
The URL of the first page of the online store that the customer visited before they submitted the order.
landingPageUrl•
URL
The first page of the online store that the customer visited before they submitted the order.
localizationExtensions•
LocalizationExtensionConnection!
non-null
List of localization extensions for the resource.
metafieldDefinitions•
MetafieldDefinitionConnection!
non-null
List of metafield definitions.
netPayment•
Money!
non-null
The net payment for the order, based on the total amount received minus the total amount refunded, in shop currency.
physicalLocation•
Location
The fulfillment location that was assigned when the order was created.
Orders can have multiple fulfillment orders. These fulfillment orders can each be assigned to a different location which is responsible for fulfilling a subset of the items in an order. The Order.physicalLocation field will only point to one of these locations.
Use the FulfillmentOrder
object for up to date fulfillment location information.
referralCode•
String
The marketing referral code from the link that the customer clicked to visit the store.
Supports the following URL attributes: "ref", "source", or "r".
For example, if the URL is {shop}.myshopify.com/products/slide?ref=j2tj1tn2, then this value is j2tj1tn2.
referrerDisplayText•
String
A web domain or short description of the source that sent the customer to your online store. For example, "shopify.com" or "email".
referrerUrl•
URL
The URL of the webpage where the customer clicked a link that sent them to your online store.
riskLevel•
OrderRiskLevel!
non-null
The fraud risk level of the order.
risks•
[OrderRisk!]!
non-null
A list of risks associated with the order.
subtotalPrice•
Money
The sum of the prices for all line items after discounts and before returns, in shop currency.
If taxesIncluded is true, then the subtotal also includes tax.
totalCapturable•
Money!
non-null
The authorized amount that's uncaptured or undercaptured, in shop currency.
This amount isn't adjusted for returns.
totalDiscounts•
Money
The total amount discounted on the order before returns, in shop currency.
This includes both order and line level discounts.
totalPrice•
Money!
non-null
The total price of the order, before returns, in shop currency.
This includes taxes and discounts.
totalReceived•
Money!
non-null
The total amount received from the customer before returns, in shop currency.
totalRefunded•
Money!
non-null
The total amount that was refunded, in shop currency.
totalShippingPrice•
Money!
non-null
The total shipping amount before discounts and returns, in shop currency.
totalTax•
Money
The total tax amount before returns, in shop currency.
totalTipReceived•
MoneyV2!
non-null
The sum of all tip amounts for the order, in shop currency.
