About the Bookings Reader V2 API

With the Bookings Reader V2 API you can retrieve extended bookings for a site's services. The extended booking object holds information about the customer, the session or schedule they have booked, whether they can cancel or reschedule, and attendance details.

The Bookings Reader V2 API allows you to retrieve extended bookings and count how many bookings match a specific filter.

You can read more about:

Use cases

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 Reader V2 APIs.
  • There is no Get Extended Booking method, instead you can call Query Extended Booking specifying a single booking ID in the filter.
  • The participantNotification object is overridden every time a new message about a booking change is specified. The objects holds only the very last message. It also doesn't specify whether the message was sent due to canceling, rescheduling, declining, or confirming the booking.

Terminology

  • Booking: An entity representing a scheduled appointment, class session, or course. Includes details about the customer and payment status.
  • Booked entity: Details about the timing of the appointment, class session, or course that has been booked.
  • 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.

Did this help?