A customer’s completed request to purchase one or more products from a shop. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data).
Access Scopes
Fields
billingAddress:
CustomerAddress -
The mailing address provided by the customer. Not all orders have a mailing address.
cancelReason:
OrderCancelReason -
The reason for the cancellation of the order. Returns `null` if the order wasn't canceled.
cancelledAt:
DateTime -
The date and time when the order was canceled.
Returns `null` if the order wasn't canceled.
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.
createdAt:
DateTime! -
The date and time when the order was created.
currencyCode:
CurrencyCode! -
The shop currency when the order was placed.
customer:
Customer -
The customer who placed the order.
customerLocale:
String -
The locale code representing the region where this specific order was placed.
draftOrder:
DraftOrder -
The draft order associated with the order.
edited:
Boolean! -
Whether the order has been edited or not.
email:
String -
The email address of the customer.
financialStatus:
OrderFinancialStatus -
The financial status of the order.
number:
Int! -
A unique numeric identifier for the order, used by both the shop owner and customer.
paymentInformation:
OrderPaymentInformation -
The payment information for the order.
phone:
String -
The phone number of the customer for SMS notifications.
poNumber:
String -
The purchase order number of the order.
processedAt:
DateTime! -
The date and time when the order was processed.
This value can be set to dates in the past when importing from other systems.
If no value is provided, it will be auto-generated based on current date and time.
purchasingEntity:
PurchasingEntity -
The purchasing entity for the order.
refunds:
Refund! -
A list of refunds associated with the order.
requiresShipping:
Boolean! -
Whether the order requires shipping.
shippingAddress:
CustomerAddress -
The mailing address to which the order items are shipped.
shippingDiscountAllocations:
DiscountAllocation! -
The discounts that have been allocated onto the shipping line by discount applications.
shippingLine:
ShippingLine -
A summary of all shipping costs on the order.
statusPageUrl:
URL! -
The unique URL for the status page of the order.
subtotal:
MoneyV2 -
The price of the order before duties, shipping, and taxes.
totalDuties:
MoneyV2 -
The total amount of duties after returns.
totalPrice:
MoneyV2! -
The total amount of the order (including taxes and discounts) minus the amounts for line items that have been returned.
totalRefunded:
MoneyV2! -
The total amount refunded.
totalShipping:
MoneyV2! -
The total cost of shipping.
order
Returns an Order resource by ID. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data).