About the Bookings APIs

The Bookings APIs allow you to schedule and manage a business' service bookings. You can retrieve detailed booking information, manage the lifecycle of bookings, and assess availability for the services the merchant offers to their customers.

The Bookings APIs are essential for handling all aspects of service bookings on a site:

  • Bookings Reader V2 API (SDK | REST): Enables you to retrieve extended booking information, including details about the customer, session or schedule, attendance, and options for cancellations and rescheduling.
  • Bookings Writer V2 API (SDK | REST): Allows you to create bookings and manage their lifecycle.
  • Attendance API (SDK | REST): Lets you track attendance data for booking sessions.

Use cases

  • Book an appointment (SDK | REST).
  • Book a class session (SDK | REST).
  • Book a course (SDK | REST).
  • Reach out to customers who have recently canceled (SDK | REST).

Before you begin

It’s important to note the following points before starting to code:

  • Wix Bookings must be installed on a site before you can use the Bookings and Time Slots APIs.
  • You can handle checkout and payment flows with the eCommerce Checkout (SDK | REST) and eCommerce Orders APIs (SDK | REST) or use your own custom flow.

Terminology

  • Booking: An entity representing a scheduled appointment, class session, or course. Includes details about the customer and payment status.
  • Extended booking: A booking with additional information such as attendance details and whether the customer can cancel or reschedule.

For a comprehensive glossary of Wix Bookings terms, see Terminology (SDK | REST).

Did this help?