Skip to main content
GET
List orders for your Business. Requires scope: orders:read Your API key can only list orders that belong to your Business. Use Get order when you need the full timeline.

Headers

string
required
Bearer API key (Bearer <api_key>).

Query parameters

number
Page number (default 1).
number
Page size (default 10).
Free-text search (order code, recipient name, phone).
string
Filter by shipment status.
string
Sort field: NEWEST, OLDEST, PRICE_LOW_TO_HIGH, PRICE_HIGH_TO_LOW, DISTANCE_LOW_TO_HIGH, DISTANCE_HIGH_TO_LOW.
string
ISO start date on createdAt.
string
ISO end date on createdAt.

Response

array
Page of orders (list payload omits timeline).
number
Total matching orders.
number
Current page.
number
Page size.
number
Total pages.