getScheduledTimeSlots( )


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Returns a list of scheduled time slots at a specified reservation location for a specified time range, and their availability for a specified partySize.

Scheduled time slots are sequential time periods whose start times fall within a restaurant's opening hours. Opening hours are defined in the reservation location's businessSchedule.

If a restaurant is open during distinct time periods throughout the week, the startDate of the first scheduled time slot returned for each period is the same as starting time of that time period. If a restaurant is always open, the startDate of the first returned scheduled time slot for each week is Sunday at 00:00.

The duration of scheduled time slots and the interval between their startDates is determined by the reservation location's timeSlotInterval.

For example:

A restaurant is open every night from 22:30 to 03:55 with a timeSlotInterval of 1 hour. If you called this method with the time range 23:00 to 02:50, it would return time slots starting at 23:30, 00:30, 01:30, and 02:30.

Permissions
Manage Reservations (Basic)
Manage Reservations (Full)
Manage Reservations (Medium)
Manage Restaurants - all permissions
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
reservationLocationIdstringRequired

ID of the reservation location for which to retrieve time slots.


partySizenumberRequired

Size of the party that needs to be seated during this time slot.

Min: 1


optionsGetScheduledTimeSlotsOptions
Returns
Return Type:Promise<GetScheduledTimeSlotsResponse>
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?