List orders

GET /rest/v1/orders

Orders ingested from all channels, one shape: one entry per channel order, with all its lines. Newest first by created_at (the time the order was placed), not updated_at. Requires the orders:read scope (buyer personal data included; you are responsible for lawful processing).

Authorization

apiKey

AuthorizationBearer <token>

Authorization: Bearer nbl_live_... (or nbl_test_... for test mode). Test-mode writes are validated and simulated but never persisted and never touch channels; simulated results are marked simulated.

In: header

Query Parameters

limit?integer

Range1 <= value <= 100

Default25

cursor?string

channel_account_id?string

channel?string

status?string

Normalized cross-channel order status (one vocabulary for every channel; forward-only transitions). New values may be added.

Value in

"awaiting_payment"
"awaiting_shipment"
"shipped"
"canceled"
"refunded"
"partially_refunded"

created_after?string

Orders placed after this time.

Formatdate-time

updated_after?string

Orders placed OR changed after this time (status, fulfillment or tracking, e.g. cancelled or refunded on the channel). Poll with the time of your previous poll to catch every change.

Formatdate-time

Response Body

`application/json`

curl -X GET "https://example.com/orders"

{  "object": "list",  "has_more": true,  "next_cursor": "string",  "data": [    {      "id": "ord_1f83b",      "object": "order",      "channel_account_id": "string",      "channel": "string",      "order_id_on_channel": "string",      "number": "1011",      "order_url": "http://example.com",      "status": "awaiting_payment",      "fulfillment_status": "unfulfilled",      "source_status": "string",      "tracking": {        "number": "string",        "carrier": "string",        "url": "http://example.com"      },      "currency": "string",      "subtotal": "string",      "shipping": "string",      "discount": "string",      "tax": "string",      "tax_remitted_by": "marketplace",      "total": "19.90",      "lines": [        {          "id": "oline_66f0a1b2c3d4e5f6a7b8c9d0",          "sku": "string",          "title": "string",          "quantity": 1,          "price": "19.90",          "product_id": "string",          "variant_id": "string"        }      ],      "buyer": {        "name": "string",        "email": "string",        "country": "string",        "address": {          "line1": "string",          "line2": "string",          "city": "string",          "zip": "string",          "province": "string",          "country": "string"        }      },      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z"    }  ]}

Dernière mise à jour le 16 octobre 2026

Besoin d'aide ?

Écrivez-nous et une personne vous répond, généralement sous un jour ouvré.

Écrivez-nous Statut de l'API

Authorization

Query Parameters

Response Body

200application/json

403application/json

`application/json`

`application/json`