This API helps you to retrieve available slots for the specified service booking (booking_id) on a given day. If no slots are available on that day, the API returns the next available slot on any other future day of the current week.
You can also use this API to retrieve available slots for the required group service booking (booking_id).
You can choose a specific therapist or a therapist based on a certain gender while creating a service booking; after which, a unique 32-digit booking_id is generated.
You must then specify the generated booking_id as an input parameter in the API request body to retrieve available slots for the service booking.
Response Details
Name
Type
Description
slots
object
Object that contains details about various elements about the slots on a day. For more information, refer to the slots table.
future_days
object
Object that contains details about the availability of slots on a future day of the current week. For more information, refer to the future_days table.
next_available_day
datetime
The latest day that contains available slots for the specified service booking.
Error
object
Object that contains error message and error code details. For more information, refer to the error table.
slots
Name
Type
Description
Time
datetime
The time of a slot on any given day.
Warnings
object
Object that contains details about various warning elements of the slot. For more information, refer to the Warnings table.
Priority
int
Indicates the priority of the slot.
Available
boolean
If true, it indicates that the slot is available to be booked for a service.
SalePrice
decimal
The price of the service booking.
Warnings
Name
Type
Description
Type
enum
Indicates the type of warning message for the slot: TherapistDoubleBooked = 0, TherapistOutsideSchedule = 1, GuestDoubleBooked = 2, RoomCapacityExceeded = 3, ServiceEndsOutsideCenterHours = 4, EquipmentCapacityExceeded = 5, DayIsHoliday = 6, TherapistDoubleSelcted = 7, RoomDoubleSelcted = 8, EquipmentDoubleSelcted = 9, TherapistNotAvailableOnReservation = 10, RoomNotAvailableOnReservation =11, and EquipmentNotAvailableOnReservation = 12.
Message
string
Warning message for the slot.
GuestId
guid
Unique 32-character ID of the guest who will avail a service during the slot time period.
TherapistId
guid
Unique 32-character ID of the therapist who will perform the service during the slot time period.
ServiceId
guid
Unique 32-character ID of the service that the therapist will perform during the slot time period.
RoomId
guid
Unique 32-character ID of the room in which the service will be performed during the slot time period.
EquipmentId
guid
Unique 32-character ID of the equipment that will be used in the service during the slot time period.
future_days
Name
Type
Description
Day
datetime
Date and time details of an available slot in a future day of the current week.
IsAvailable
boolean
If true, it indicates that the slot is available to be booked for a service on that day.
Error
Name
Type
Description
StatusCode
int
Status code that represents the type of the error.
Message
string
Message that describes the error.
InternalMessage
string
Internal message that describes about the error in more detail.
Error Message Details
Error Message
Error Code
Description
id is missing.
503
If the booking ID is not specified.
Could not get booking details.
502
If the booking details could not be retrieved.
Invalid booking id.
502
If the specified booking ID is not valid.
Slot is not available for reservation.
502
If the slot is not available to be reserved for the appointment.
Center not found.
502
If the center details could not be retrieved.
One or more services or addons are not available in the catalog.
502
If certain services or add-ons are not available in the catalog.
One or more therapists are not available in catalog.
502
If certain therapists are not available in the catalog.
Language
Credentials
Header
Click Try It! to start a request and see the response here!
