List Orders

Retrieve a list of all orders with comprehensive filtering and sorting capabilities.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Retrieve a list of all orders with comprehensive filtering and sorting capabilities.

Query Params
string

Filter results by the status of the order, e.g., pending.

string

Filter orders assigned to a specific user or entity ID.

string

Filter orders by a two-letter province or state code, e.g., ON.

string

Filter orders by a unique customer ID.

string

Filter orders by a customer's email address.

string

Filter orders by a customer's first name.

string

Filter orders by a customer's last name.

string

Filter orders created on or after this ISO 8601 date, e.g., 2025-01-01T00:00:00Z.

string

Filter orders created on or before this ISO 8601 date.

string

Filter orders last updated on or after this ISO 8601 date.

string

Filter orders last updated on or before this ISO 8601 date.

number

Filter orders with an ID greater than or equal to this number.

number

Filter orders with an ID less than or equal to this number.

number

The maximum number of results to return.

string

A comma-separated list of order statuses to include, e.g., pending,processing.

boolean

A boolean flag to include archived orders in the results.

string

The field to sort the results by, e.g., createdAt or id.

string

Filter orders by a product ID.

boolean

A boolean flag to include a total count of results in the response.

Response

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json