Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

pageSize
number | null

The maximum number of locations to return. Defaults to 100 if not specified. Must be a positive number and not exceed 1000.

Required range: x <= 1000
Example:

100

pageToken
string | null

A token to retrieve the next page of results. Used for pagination.

status
string | null

Filter orders by status. Accepts a comma-separated list of statuses. Valid values: NEW, CONFIRMED, READY, IN_PROGRESS, CANCELLED, DELIVERED, RETURN.

Example:

"NEW,CONFIRMED"

query
string | null

Search orders by recipient name, phone number, or reference ID. Performs fuzzy matching on recipient names and exact matching on phone numbers and reference IDs.

Example:

"Valentina"

Response

200 - application/json

Successfully fetched a list of orders.

orders
object[]
required

An array of orders.

nextPageToken
string | null

A token to retrieve the next page of results, if any.