Models
Cette page n'est disponible qu'en anglais.
The Order object
Every field of the Order object, with 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 | The channel's internal order id (e.g. Shopify 18968716083351) |
number | string · nullable | The order number the seller sees on the channel (Shopify "#1011" → "1011", Etsy receipt id, WooCommerce order number); for channels without a separate display number, the channel's order id. Search orders by it the way support staff do. Same value as the "Order" column of the orders export. e.g. 1011 |
order_url | string · nullable | uri |
status | OrderStatus | Omitted when the order has no normalized status yet. One of: awaiting_payment, awaiting_shipment, shipped, canceled, refunded, partially_refunded |
fulfillment_status | FulfillmentStatus | Omitted when not known. One of: unfulfilled, partial, shipped, delivered |
source_status | string · nullable | The channel's own raw status string, verbatim, as of Nembol's last read of the order (it refreshes with the order sync, so it can lag a minute behind a fulfillment sent through the API). For debugging, never for logic: use status |
tracking | object | |
tracking.number | string · nullable | |
tracking.carrier | string · nullable | |
tracking.url | string · nullable | uri |
currency | string · nullable | ISO-4217, per-order |
subtotal | string · nullable | Items subtotal as the channel reports it. null when the channel gave no breakdown (older orders, some channels) |
shipping | string · nullable | Shipping charged to the buyer |
discount | string · nullable | Discount on the items |
tax | string · nullable | Tax on items and shipping |
tax_remitted_by | string · nullable | marketplace when the channel collects and remits the tax (marketplace facilitator), seller when you do; null when not known. One of: marketplace, seller, null |
total | string (money) | The order total as the channel reports it (items + shipping + tax − discounts), in currency, the same numbers as the orders export. When the channel gave no breakdown, the sum of the lines (unit price × quantity). e.g. 19.90 |
lines | array of OrderLine | Every line of the channel order, oldest first |
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 · nullable | When the order was placed. ISO 8601 |
updated_at | string · nullable | Last change of status, fulfillment or tracking; equal to created_at until the first change. Filter with GET /orders?updated_after=. ISO 8601 |
Dernière mise à jour le 17 octobre 2026
Besoin d'aide ?
Écrivez-nous et une personne vous répond, généralement sous un jour ouvré.