Retrieve all orders matching the given parameters
Use this endpoint to retrieve orders
Query parameters
The query to filter orders on.
The customer ID to filter orders on.
The status to filter orders on.
The labels to filter orders on.
A comma separated string of offering ids to fetch orders for
Discriminator describing what kind of sellable item an Offering represents. The value determines which downstream schema (Appointment, Session, Package, etc.) the offering's offering_id resolves against, and which checkout/booking flow applies.
Filter orders by the type of offering for their items.
A comma separated string of user ids to fetch orders for
Filter on orders with a revenue date on or after this date.
Filter on orders with a revenue date on or before this date.
Filter on orders with an items on this date.
Filter on orders with an item date on or after this date.
Filter on orders with an item date on or before this date.
Filter on orders with an item status of one of these comma-separated values.
Filter on orders with a submitted date on or after this time.
Filter on orders with a submitted date before this date.
Filter on orders with a updated date on or after this date.
Filter on orders with a updated date before this date.
Filter on orders that contain a membership purchase
Filters on orders that have an outstanding balance
Filter on orders that have the given sales channel ID
Filter on an external ID, in the format {key}:{value}
Pass true to return a single 'items' array rather than separate arrays for each item type
Filter results by the site they belong to
The page to retrieve results from
The number of results to return per page
Response
The Orders were successfully retrieved