An order is a customer’s completed request to purchase one or more products from a shop. An order is created when a customer completes the checkout process, during which time they provides an email address, billing address and payment information.
Fields
billingAddress ● OrderShippingAddress
The address associated with the payment method.
More
buyerNote ● String
Buyer notes added to the order.
cancelReason ● String
Cancellation reason for the order.
canceledAt ● Date
The date and time when the order was canceled. Returns null if the order wasn't canceled.
customer ● Customer
customer
More
email ● String
The customer's email address.
financialStatus ● OrderFinancialStatus
Represents the order's current financial status.
More
fulfillmentStatus ● OrderFulfillmentStatus
Shipment status
More
id ● ID!non-null
A globally-unique ID.
lineItems ● [OrderLineItem]
List of the order’s line items.
More
name ● String
Merchant's custom order number, starting from 1001. It can be the same across different stores, and it is not necessarily unique within the same store.
phone ● String
The customer's phone number for receiving SMS notifications.
processedAt ● Date
Order fulfillment time (the actual business time of the order when it was imported).
shippingAddress ● OrderShippingAddress
The address to where the order will be shipped.
More
shippingDiscountAllocations ● [OrderDiscountAllocation]
The discounts that have been allocated onto the shipping line by discount applications.
More
statusUrl ● URI
The unique URL for the order's status page.
subtotalPrice ● Money
Price of the order before shipping and taxes.
More
successfulFulfillments ● [Fulfillment]
List of the order’s successful fulfillments.
More
totalDuties ● Money
The total customs duty for the order, including the edited order items.
More
totalPrice ● Money
The sum of all the prices of all the items in the order, duties, taxes and discounts included (must be positive).
More
totalShippingPrice ● Money
Total shipping cost of the order, including shipping discounts.
More
totalTax ● Money
The total tax and fees for the order, including editing the order items.
More
Status and error codes
For detailed information about common codes, see Status and error codes.
Was this article helpful to you?