An access token is required to call this API. Refer to Authorization for more information about how to obtain the token.
The current interface is about to be discontinued, and new integrations will no longer be directly accessible. For applying for access permissions, please contact the platform through the ticketing system.
Arguments
id ● ID
order id
ids ● [ID]
order id list
Returns
billingAddress ● OrderShippingAddress
The address associated with the payment method.
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
email ● String
The customer's email address.
financialStatus ● OrderFinancialStatus
Represents the order's current financial status.
fulfillmentStatus ● OrderFulfillmentStatus
Shipment status
id ● ID!non-null
A globally-unique ID.
lineItems ● [OrderLineItem]
List of the order’s line items.
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.
shippingDiscountAllocations ● [OrderDiscountAllocation]
The discounts that have been allocated onto the shipping line by discount applications.
statusUrl ● URI
The unique URL for the order's status page.
subtotalPrice ● Money
Price of the order before shipping and taxes.
successfulFulfillments ● [Fulfillment]
List of the order’s successful fulfillments.
totalDuties ● Money
The total customs duty for the order, including the edited order items.
totalPrice ● Money
The sum of all the prices of all the items in the order, duties, taxes and discounts included (must be positive).
totalShippingPrice ● Money
Total shipping cost of the order, including shipping discounts.
totalTax ● Money
The total tax and fees for the order, including editing the order items.
Error Code
For more information about common error codes, refer to Status and error codes.
Was this article helpful to you?