Skip to main content
GET
List all Orders

Authorizations

Authorization
string
header
required

Bearer Token necessary to use API

Query Parameters

page
integer

Pagination: Page number

Required range: x >= 1
limit
integer

Pagination: Limit number of items per page.

Required range: 1 <= x <= 100
contact_id
string[]

Filter by Contact IDs. Supports multiple values separated by a comma.

site_id
string[]

Filter by Site IDs. Supports multiple values separated by a comma.

sort_by
enum<string>

Sorting by attribute. Default created_at

Available options:
created_at,
updated_at
sort_direction
enum<string>

Sorting by ASC or DESC direction. Default DESC

Available options:
ASC,
DESC
expand
string[]

This endpoint supports expandable responses. For more, see the documentation page.

status
enum<string>[]

Filter by status. Supports multiple values separated by a comma.

Available options:
draft,
finalized,
completed,
abandoned
source
enum<string>[]

Filter by source. Supports multiple values separated by a comma.

Available options:
backoffice,
storefront,
storefront_multi_step,
import,
public_api,
unspecified
billing_period
enum<string>[]

Filter by billing period. Supports multiple values separated by a comma.

Available options:
monthly,
weekly,
every_four_weeks,
every_three_months,
every_six_months,
yearly,
one_time
created_after
string<date-time>

Filters results to created after (including given date) the given ISO 8601 timestamp (e.g., 2025-01-12T15:30:00Z).

created_before
string<date-time>

Filters results to created before (excluding given date) the given ISO 8601 timestamp (e.g., 2025-01-12T15:30:00Z).

updated_after
string<date-time>

Filters results to updated after (including given date) the given ISO 8601 timestamp (e.g., 2025-01-12T15:30:00Z).

updated_before
string<date-time>

Filters results to updated before (excluding given date) the given ISO 8601 timestamp (e.g., 2025-01-12T15:30:00Z).

starts_after
string<date-time>

Filters results to starts after (including given date) the given ISO 8601 timestamp (e.g., 2025-01-12T15:30:00Z).

starts_before
string<date-time>

Filters results to starts before (excluding given date) the given ISO 8601 timestamp (e.g., 2025-01-12T15:30:00Z).

metadata
object

Filter by metadata. Use metadata[key]=value to filter by specific metadata keys.

Example:

Response

200 - application/json

list of orders

List of Orders

orders
object[]
meta
object