API ReferenceBookings

Overview

Set availability, block dates, and manage customer appointments.

Use booking APIs to decide when customers can book and to manage appointments afterward. They follow the same rules as the seller dashboard. Your key needs the listing ability to configure availability and date overrides, or invoice to read, cancel, and reschedule customer appointments.

All resources are scoped to the store selected by X-STORE. Product, variant, booking, and provider-connection IDs from another store return an authorization or not-found response rather than crossing store boundaries.

Endpoints

Time and concurrency

Appointment times are returned as ISO 8601 timestamps. Weekly availability and date overrides use an IANA timezone, such as Europe/London. A local date can span 23 or 25 hours when daylight saving time changes; SellApp stores the corresponding UTC boundaries.

Rescheduling and checkout holds share the same product- or variant-level lock, so they cannot reserve conflicting slots at the same time. SellApp checks availability again while holding that lock. An outdated request cannot overwrite a cancelled appointment or take a slot already held by another appointment.

Webhooks

Appointment changes can be observed by enabling the public events booking.cancelled and booking.rescheduled on a webhook channel. Payloads contain safe appointment state and omit provider error details and credentials.

On this page