With the Wix Bookings Availability Calendar API, you can retrieve the
availability of a calendar's sessions.
The Calendar Availability APIs calculate the availability of sessions for appointments and classes, but not for courses.
- Booking: Information about the service that the customer has booked.
Includes details about the time, location, participants, and price.
- Service: Online or in-person business offerings, such as courses and private sessions. For
example, a fitness studio may offer a
1-hour yoga class, a 45 minute HIIT training session, and a 30 minute 1-on-1
personal training. Bookings offers 3 types of services:
- Appointments: Appointments take place whenever a customer books a specific
time slot. For example, your hair salon may be open for business from 9:00 AM
to 7:00 PM and a customer can book a session at any available time during the day.
- Classes: Classes can be scheduled on different days, at different times,
with different resources, such as staff members. Customers can sign up for single sessions
or a class's recurring sessions. For example, a language school offers a beginner's Spanish
class every Monday at 8:00 PM. Clients can join the session they want and don't have to commit
to attending all sessions.
- Courses: A limited number of sessions for the same service that starts and ends
on a particular day. Customers sign up for the entire course and not one session. For example,
a 12-session introductory course to Pilates, starting on February 1st and
ending on March 17th.
- Schedule: A collection of all sessions that belong to the same class, course,
appointment, or resource. Schedules also comprise available slots that can still be booked.
- Session: An occupied period of time in a schedule. Sessions are the
building blocks of appointments, classes, and courses. Each of these types of
services comprise sessions. The collection of related sessions for a service represent the
service's schedule.
- Slot: An available period of time in a schedule that can be booked by a
customer. While this includes existing sessions that are available for
booking, it can also represent a period of time that can be booked based on
the availability of a resource, such as a barber with appointments of 30
minutes each that are open for booking every weekday between 8:00 - 17:00.
These slots are calculated according to the constraints of the schedule.
- Calendar: General overview about the availability and bookings of the
business, including its services and resources. Manage your appointments, classes
and courses on the calendar.
- Resource: Business asset like a staff member, room, or equipment that's
needed to provide a service.
- Bookings Policy: Terms the business wants to enforce when
customers try to book a service. For example, how far in advance customers
may book a service or until what point before the start of a session
customers can cancel.
- Locked Sessions: Sessions that customers cannot book due to business reasons, such
as the session being full and having a waitlist, or because an administrator
wants to manually screen each customer before adding a customer to a session.