Skip to main content
GET
List orders

Authorizations

Authorization
string
header
required

OAuth 2.0 client credentials.

Headers

X-Request-Id
string

A caller-supplied request identifier for support.

Required string length: 1 - 255

Query Parameters

cursor
string

The opaque cursor from the previous response.

page_size
integer
default:50

The number of resources to return.

Required range: 1 <= x <= 100
status
enum<string>

Return only orders with this status. Overall order state derived from all vehicles. accepted means no vehicle is in transit; in_transit means transport is underway; delivered means every required vehicle is delivered; cancelled means the order was cancelled.

Available options:
accepted,
in_transit,
delivered,
cancelled
customer_reference
string

Return orders with this exact customer reference.

Required string length: 1 - 255

Response

The order page.

Cursor-paginated list of order summaries.

data
object[]
required

Orders in this page.

next_cursor
string | null
required

Opaque cursor for the next page, or null after the final page.

has_more
boolean
required

Whether another page is available.