The Time Slots V2 API allows you to retrieve information about when services are available for booking. You can check availability for single-service or multi-service bookings, and get detailed information about each time slot including: whether the slot is bookable, available resources, and any booking restrictions.
With the Time Slots V2 API, you can:
- List time slots available for services within a specified time range.
- Get detailed information about specific time slots.
- Filter time slots by location, resources, and whether customers can book them.
- Determine why certain time slots aren't bookable due to policy violations.
The availability calculation for a service is based on:
- Service configurations: Duration, buffer time between sessions, and other service-specific settings.
- Operating hours: Business opening hours by default. However, if the service requires exactly one resource and that resource is a staff member, availability extends to that staff member's working hours, even if they work outside regular business hours.
- Resource availability: Whether all required resources are available during the requested time.
- Booking policies: Service-specific rules that may restrict when bookings can be made.
Availability vs. bookability: An available time slot has all required resources free, but may not be bookable due to service policies, such as minimum advance booking time.
Capacity information: Time slots include total capacity, remaining available spots, and bookable capacity that accounts for waitlist reservations.
Resource filtering: Control which time slots are returned and which resource details are included in responses.
Policy violations: Determine why slots aren't bookable. For example, the booking is too far in advance or too close to the appointment time, or online booking is disabled for the service.
Duration-range services: Some appointment-based services are configured with a duration range instead of a fixed duration. The customer picks a start time and then chooses how long the booking lasts, within a minimum and maximum range. Duration-range services can be hourly or daily.
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 Time Slots V2 API.
- Only appointment-based services and classes are supported. For course availability, follow the end-to-end booking flow for courses.
- Time slots aren't returned when they have no available resources.
- Daylight saving time (DST) transitions are automatically handled when using IANA time zone formats.
- Time slot: A specific period when a service can be booked.
- Available slot: A time slot with all required resources free.
- Bookable slot: An available slot that doesn't violate any service booking policies.
- Resource: Staff members, equipment, or facilities needed to provide a service.
- Capacity: The maximum number of participants a service can accommodate in a time slot.
- Duration range: A service configuration where the customer picks a duration within a minimum and maximum range, instead of booking a fixed-length session.
For a comprehensive glossary of Wix Bookings terms, see Terminology.
- Services V2 API: Manage bookable services.
- Bookings Writer V2 API: Create and manage single-service and multi-service bookings.
- Resources V2 API: Manage bookable resources.