Sign in
Appointments

Queue an export of the appointments-v2 list

Queues a background job that exports the same appointment list returned by GET /shop/appointments-v2 as a CSV download. The -v2 endpoint sources its data from the order-item store rather than the legacy appointments collection, which means it can apply a richer set of filters (sales channel, order label, brand, etc.) and reflects the same totals shown in revenue reports.

The response returns a QueuedJob resource that you can poll via GET /shop/queued-jobs/{queuedJobId} to check progress and fetch the download_url once ready.

All filters supported by the list endpoint are accepted here and are applied to the export.

get/shop/appointments-v2/queue

Query parameters

site_idstring required

Filter results by the site they belong to

date_fromstring date

Restrict results to those on or after this date, ISO-8601 YYYY-MM-DD.

date_tostring date

Restrict results to those on or before this date, ISO-8601 YYYY-MM-DD.

order_submitted_at_fromstring date

the order submitted date to fetch appointments from

order_submitted_at_tostring date

the order submitted date to fetch appointments to

practitioner_idstring[]

A comma separated string of practitioner ids to fetch bookings for

room_idstring[]

A comma separated string of room ids to fetch bookings for

zone_idstring[]

A comma separated string of zone ids to fetch bookings for

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.