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.
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.
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.
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.
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.
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.
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.
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.
A custom field,
including its namespace and key, that's associated with a Shopify resource
for the purposes of adding and storing additional information.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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).
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.