API reference
The order object
A comprehensive list of the order resource's attributes and relationships
An order object is returned as part of the response body of each successful list, retrieve, create or update API call to the /api/orders endpoint.

Fields

Field
Type
Description
type
string
orders
id
string
The order unique identifier
links.self
string
The order endpoint URL
attributes.number
integer
Unique identifier for the order (numeric).
attributes.autorefresh
boolean
Save this attribute as 'false' if you want prevent the order to be refreshed automatically at each change (much faster).
attributes.status
string
The order status. One of 'draft' (default), 'pending', 'placed', 'approved', or 'cancelled'.
attributes.payment_status
string
The order's payment status. One of 'unpaid' (default), 'authorized', 'paid', 'voided', or 'refunded'.
attributes.fulfillment_status
string
The order's fulfillment status. One of 'unfulfilled' (default), 'in_progress', or 'fulfilled'.
attributes.guest
boolean
Indicates if the order has been placed as guest.
attributes.editable
boolean
Indicates if the order can be edited.
attributes.customer_email
string
The email address of the associated customer. When creating or updating an order, this is a shortcut to find or create the associated customer by email.
attributes.customer_password
string
The password of the associated customer. When creating or updating an order, this is a shortcut to sign up the associated customer.
attributes.language_code
string
The preferred language code (ISO 639-1) to be used when communicating with the customer. This can be useful when sending the order to 3rd party marketing tools and CRMs. If the language is supported, the hosted checkout will be localized accordingly.
attributes.currency_code
string
The international 3-letter currency code as defined by the ISO 4217 standard, automatically inherited from the order's market.
attributes.tax_included
boolean
Indicates if taxes are included in the order amounts, automatically inherited from the order's price list.
attributes.tax_rate
float
The tax rate for this order (if calculated).
attributes.freight_taxable
boolean
Indicates if taxes are applied to shipping costs.
attributes.requires_billing_info
boolean
Indicates if the billing address associated to this order requires billing info to be present.
attributes.country_code
string
The international 2-letter country code as defined by the ISO 3166-1 standard, automatically inherited from the order's shipping address.
attributes.shipping_country_code_lock
string
The country code that you want the shipping address to be locked to. This can be useful to make sure the shipping address belongs to a given shipping country, e.g. the one selected in a country selector page.
Copy link
Contents
Fields