API ReferenceOrders
List orders
GET /rest/v1/orders
Orders ingested from all channels, one shape. 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
Range
1 <= value <= 100Default
25cursor?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
Format
date-timeResponse Body
application/json
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", "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", "total": "19.90", "lines": [ { "sku": "string", "title": "string", "quantity": 0, "price": "19.90", "product_id": "string" } ], "buyer": { "name": "string", "email": "string", "country": "string" }, "created_at": "2019-08-24T14:15:22Z" } ]}Last updated on July 28, 2026
Need help?
The API is in private beta — email us and a human replies, usually within one business day.