Models

The Order object

Every field of the Order object — types, required flags and validation rules.

The Order object

FieldTypeDescription
idstringe.g. ord_1f83b
objectstringalways order
channel_account_idstring · nullable
channelstring
order_id_on_channelstring · nullable
order_urlstring · nullableuri
statusOrderStatusNormalized cross-channel order status (one vocabulary for every channel; forward-only transitions). New values may be added. — one of: awaiting_payment, awaiting_shipment, shipped, canceled, refunded, partially_refunded
fulfillment_statusFulfillmentStatusNormalized fulfillment progress. New values may be added. — one of: unfulfilled, partial, shipped, delivered
source_statusstring · nullableThe channel's own raw status string, verbatim — for debugging, never for logic.
trackingobject
tracking.numberstring · nullable
tracking.carrierstring · nullable
tracking.urlstring · nullableuri
currencystring · nullableISO-4217
totalstring (money)Decimal string, 2 decimals. e.g. 19.90
linesarray of OrderLine
buyerobjectBuyer personal data — requires orders:read; process lawfully.
buyer.namestring · nullable
buyer.emailstring · nullable
buyer.countrystring · nullable
buyer.addressobjectShip-to address, as provided by the source channel.
created_atstringISO 8601

Last updated on July 30, 2026

Need help?

The API is in private beta — email us and a human replies, usually within one business day.

On this page