Sign in
Orders

Queue an export of the orders list

Queue a request to export the orders list

get/shop/orders/queue

Query parameters

querystring

The query to filter orders on.

customer_idstring uuid

The customer ID to filter orders on.

statusstring

The status to filter orders on.

labelsstring

The labels to filter orders on.

item_offering_idstring

A comma separated string of offering ids to fetch orders for

item_offering_type'appointment' | 'appointment_enquiry' | 'area_booking' | 'course' | 'hotel_room_reservation' | 'membership' | 'package' | 'product' | 'session' | 'table_reservation' | 'voucher'

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.

Example:appointment

Filter orders by the type of offering for their items.

submitted_by_idstring

A comma separated string of user ids to fetch orders for

revenue_date_fromstring date

Filter on orders with a revenue date on or after this date.

revenue_date_tostring date

Filter on orders with a revenue date on or before this date.

item_datestring date

Filter on orders with an items on this date.

item_date_fromstring date-time

Filter on orders with an item date on or after this date.

item_date_tostring date-time

Filter on orders with an item date on or before this date.

item_statusstring

Filter on orders with an item status of one of these comma-separated values.

submitted_at_fromstring date-time

Filter on orders with a submitted date on or after this time.

submitted_at_tostring date-time

Filter on orders with a submitted date before this date.

updated_at_fromstring date-time

Filter on orders with a updated date on or after this date.

updated_at_tostring date-time

Filter on orders with a updated date before this date.

is_membershipboolean

Filter on orders that contain a membership purchase

has_outstanding_balanceboolean

Filters on orders that have an outstanding balance

sales_channelstring object-id

Filter on orders that have the given sales channel ID

external_idstring

Filter on an external ID, in the format {key}:{value}

site_idstring

Filter results by the site they belong to

Response

The job was successfully queued

Example response

{
  "data": {
    "created_at": "2023-11-07T00:00:00+00:00",
    "updated_at": "2023-11-07T01:00:00+00:00"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.