With the Bookings Writer V2 API you can manage bookings for a site's services.
The booking object holds information about the customer and the session or
schedule they have booked. An extended booking includes additional details,
for example, attendance information and whether the customer can cancel.
The Bookings Writer V2 API allows you to:
- Create bookings.
- Manage bookings' life cycles.
You can read more about:
- Bookings Reader V2 API
(SDK | REST):
Retrieve extended bookings.
- Bookings Services API
(SDK | REST):
Manage a site's services so customers can book appointments, class sessions, and courses.
- Availability Calendar API
(SDK | REST):
Calculate the availability of appointments and class sessions.
- Attendance API
(SDK | REST):
Lets you track attendance data for booking sessions.
- Calendar V3 APIs
(SDK | REST):
Manage a site's business schedules and events.
- eCommerce Checkout API
(SDK | REST)
and eCommerce Orders API
(SDK | REST):
Manage checkout and payment flows for a site's bookings.
- Book an appointment
(SDK | REST).
- Book a class session
(SDK | REST).
- Book a course
(SDK | REST).
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 V2 APIs.
- You can't retrieve bookings objects with the Bookings Writer V2 API,
instead use the Bookings Reader V2 API
(SDK | REST).
- 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.
- You can't track attendance with the with the Bookings Writer V2 API,
instead use the Attendance API
(SDK | REST).
- 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.
- Flow control settings: Settings that modify the standard booking flow, such
as skipping availability checks before creating or rescheduling a booking.
- Participant notification: Information about the very last message sent to
the customer regarding booking changes. Previous messages are overridden.
Doesn't specify which type of change occurred.
- Payment status: If the customer paid with an eCommerce checkout
(SDK | REST),
the payment status is synced from the corresponding eCommerce order
(SDK | REST).
- Policy violations: Indicators of policy
(SDK | REST)
violations for a booking, such as booking too early or too late.
- Status: Life cycle information of the booking. Statuses include:
CREATED: The booking was created, but the customer hasn't completed the related
eCommerce order
(SDK | REST)
yet.PENDING: The merchant must manually confirm the booking before it appears
in the business calendar.CONFIRMED: The merchant has confirmed the booking and it appears in the
business calendar. Merchants can set up their services to automatically
confirm all PENDING bookings.CANCELED: The customer has canceled the booking. Depending on the
relevant service's policy snapshot
(SDK | REST)
they may have to pay a cancellation fee
(SDK | REST).DECLINED: The merchant has declined the booking before the customer was
charged.WAITING_LIST: The customer's booking is on a
waitlist.
Currently, you can't call Register to Waitlist
(REST)
for course or appointment bookings, even though this is supported in live sites.
You can call Register to Waitlist only for class session bookings.
For a comprehensive glossary of Wix Bookings terms, see Terminology
(SDK | REST).