Skip to main content
GET
List organization orders

Authorizations

x-api-key
string
header
required

Location/organization API key.

Path Parameters

organization_id
string
required

Query Parameters

limit
integer
default:10

Page size (1–100).

Required range: 1 <= x <= 100
starting_after
string

Return orders after this order id.

ending_before
string

Return orders before this order id.

created_after
string<date-time>

Return orders created after this ISO 8601 timestamp.

created_before
string<date-time>

Return orders created before this ISO 8601 timestamp.

updated_after
string<date-time>

Return orders updated after this ISO 8601 timestamp. For reconciliation, combine it with one fixed updated_before high-water mark across every page.

updated_before
string<date-time>

Return orders updated before this ISO 8601 timestamp. Keep this high-water value unchanged while paginating a reconciliation scan.

status
enum<string>
Available options:
received,
accepted,
in_preparation,
awaiting_shipment,
awaiting_collection,
in_delivery,
completed,
rejected,
cancelled,
delivery_failed
service_type
enum<string>
Available options:
delivery,
collection,
eat_in
location_id
string

Restrict results to one organization location.

Response

A paginated list of orders.

object
enum<string>
required
Available options:
list
data
object[]
required
has_more
boolean
required
url
string
required