Models
The Order object
Every field of the Order object — types, required flags and validation rules.
The Order object
| Field | Type | Description |
|---|---|---|
id | string | e.g. ord_1f83b |
object | string | always order |
channel_account_id | string · nullable | |
channel | string | |
order_id_on_channel | string · nullable | |
order_url | string · nullable | uri |
status | OrderStatus | Normalized 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_status | FulfillmentStatus | Normalized fulfillment progress. New values may be added. — one of: unfulfilled, partial, shipped, delivered |
source_status | string · nullable | The channel's own raw status string, verbatim — for debugging, never for logic. |
tracking | object | |
tracking.number | string · nullable | |
tracking.carrier | string · nullable | |
tracking.url | string · nullable | uri |
currency | string · nullable | ISO-4217 |
total | string (money) | Decimal string, 2 decimals. e.g. 19.90 |
lines | array of OrderLine | |
buyer | object | Buyer personal data — requires orders:read; process lawfully. |
buyer.name | string · nullable | |
buyer.email | string · nullable | |
buyer.country | string · nullable | |
buyer.address | object | Ship-to address, as provided by the source channel. |
created_at | string | ISO 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.