Sign in

v1

latestOpenAPI 3.1.02026-07-1342112262.5 KB
Orders

List orders

List orders

Required scope: business/orders:read

get/v1/orders/

Query parameters

created_at__gtestring date-time nullable

The min created date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away (e.g. supplying only __gte=2024-11-01T00:00:00Z sets __lte=2024-12-02T00:00:00Z). When both bounds are provided, the range may not exceed 31 days.

Example:2024-11-19T15:27:02+00:00

The min created date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away (e.g. supplying only __gte=2024-11-01T00:00:00Z sets __lte=2024-12-02T00:00:00Z). When both bounds are provided, the range may not exceed 31 days.

created_at__ltestring date-time nullable

The max created date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away (e.g. supplying only __gte=2024-11-01T00:00:00Z sets __lte=2024-12-02T00:00:00Z). When both bounds are provided, the range may not exceed 31 days.

Example:2024-11-19T15:27:02+00:00

The max created date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away (e.g. supplying only __gte=2024-11-01T00:00:00Z sets __lte=2024-12-02T00:00:00Z). When both bounds are provided, the range may not exceed 31 days.

updated_at__gtestring date-time nullable

The min updated date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away (e.g. supplying only __gte=2024-11-01T00:00:00Z sets __lte=2024-12-02T00:00:00Z). When both bounds are provided, the range may not exceed 31 days.

Example:2024-11-19T15:27:02+00:00

The min updated date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away (e.g. supplying only __gte=2024-11-01T00:00:00Z sets __lte=2024-12-02T00:00:00Z). When both bounds are provided, the range may not exceed 31 days.

updated_at__ltestring date-time nullable

The max updated date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away (e.g. supplying only __gte=2024-11-01T00:00:00Z sets __lte=2024-12-02T00:00:00Z). When both bounds are provided, the range may not exceed 31 days.

Example:2024-11-19T15:27:02+00:00

The max updated date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away (e.g. supplying only __gte=2024-11-01T00:00:00Z sets __lte=2024-12-02T00:00:00Z). When both bounds are provided, the range may not exceed 31 days.

cursorstring nullable

A pagination cursor from where results should start being fetched.

A pagination cursor from where results should start being fetched.

limitinteger

The maximum number of results to return.

The maximum number of results to return.

closed_at__gtestring date-time nullable

The min closed date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away (e.g. supplying only __gte=2024-11-01T00:00:00Z sets __lte=2024-12-02T00:00:00Z). When both bounds are provided, the range may not exceed 31 days.

Example:2024-11-19T15:27:02+00:00

The min closed date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away (e.g. supplying only __gte=2024-11-01T00:00:00Z sets __lte=2024-12-02T00:00:00Z). When both bounds are provided, the range may not exceed 31 days.

closed_at__ltestring date-time nullable

The max closed date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away (e.g. supplying only __gte=2024-11-01T00:00:00Z sets __lte=2024-12-02T00:00:00Z). When both bounds are provided, the range may not exceed 31 days.

Example:2024-11-19T15:27:02+00:00

The max closed date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away (e.g. supplying only __gte=2024-11-01T00:00:00Z sets __lte=2024-12-02T00:00:00Z). When both bounds are provided, the range may not exceed 31 days.

statusOrderStatus[] nullable

A list of statuses to filter on.

A list of statuses to filter on.

location_idstring[] nullable

A list of location ids to filter on. Pass "null" to include orders without a location.

A list of location ids to filter on. Pass "null" to include orders without a location.

Response

Successful Response

next_cursorstring nullable required

A pagination cursor that can be used to retrieve the next set of results.

Example response

{
  "data": [],
  "next_cursor": "1323935095007282836"
}