Go Headless

Build Apps

Client

API Preview

test

Ricos

Develop Websites

REST

Velo

GraphQL (Alpha)

ID of the reservation location for which to check the time slot.

reservationLocationId

string

options

CheckTimeSlotOptions

Checks a restaurant's availability to accommodate a reservation for a given party size in a given time slot.

 `checkTimeSlot()` returns availability information for the restaurant's table combinations, and flags any party pacing or seat pacing conflicts that the proposed reservation would cause.

import { timeSlots } from '@wix/table-reservations';

async function checkTimeSlot(reservationLocationId, options) {
  const response = await timeSlots.checkTimeSlot(reservationLocationId, options);
};

checkTimeSlot: Wix-hosted

import { createClient } from '@wix/sdk';
import { timeSlots } from '@wix/table-reservations';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { timeSlots },
  // Include the auth strategy and host as relevant
});


async function checkTimeSlot(reservationLocationId, options) {
  const response = await myWixClient.timeSlots.checkTimeSlot(reservationLocationId, options);
};

Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).

checkTimeSlot: Self-hosted

checkTimeSlot

Manage Reservations (Full)

Manage Reservations (Medium)

Manage Restaurants - all permissions

CheckTimeSlotResponse

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

Date and time for which to retrieve a time slot in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#coordinated_Universal_Time_(UTC)) format.

date

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

Min: `1`

partySize

number

GetTimeSlotsOptions

Returns a list of time slots at a specified reservation location on a specified `date`, and their availability for a specified `partySize`.

Without passing optional parameters, the list will contain a single time slot at the specified `date`.
Use `slotsBefore` and `slotsAfter` to get additional time slots before and after the specified `date`.

If you do not provide a `duration`, the duration will be calculated automatically based on the reservation location's configuration.
The reservation location's settings used to determine the duration are its `defaultTurnoverTime` and `turnoverTimeRules`. These specify how much time should be allotted for a reservation of a party of a specified size.

The interval between `startDate`s of time slots in the response is determined by the reservation location's `timeSlotInterval`. This interval is not affected by the `duration` provided.

import { timeSlots } from '@wix/table-reservations';

async function getTimeSlots(reservationLocationId, date, partySize, options) {
  const response = await timeSlots.getTimeSlots(reservationLocationId, date, partySize, options);
};

getTimeSlots: Wix-hosted

import { createClient } from '@wix/sdk';
import { timeSlots } from '@wix/table-reservations';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { timeSlots },
  // Include the auth strategy and host as relevant
});


async function getTimeSlots(reservationLocationId, date, partySize, options) {
  const response = await myWixClient.timeSlots.getTimeSlots(reservationLocationId, date, partySize, options);
};

getTimeSlots: Self-hosted

getTimeSlots

Manage Reservations (Basic)

GetTimeSlotsResponse

---
title: Introduction
---

# Introduction

The Time Slots API allows you to retrieve availability information for time slots at a reservation location on and around a given date and for a given party size.

A time slot represents a period of time in a restaurant’s calendar. Time slots can have any duration, and restaurants generally set their durations based on party size.

The following factors influence whether a time slot at a reservation location is available:
* The size of the party that must be seated.
* The reservation location’s table and seat pacing rules.
* The reservation location’s business schedule (operating hours).
* Existing reservations at the reservation location.

With the Time Slots API, you can:
* Get time slots for a reservation location.

A time slot can have the following statuses:
* `AVAILABLE` - The restaurant is open and available to seat a party of the given size at the given date and time.
* `UNAVAILABLE` - The restaurant is open but unable to seat a party of the given size at the given date and time.
* `NON_WORKING_HOURS` - The restaurant is not open at this time.

`timeSlot` objects also indicate whether manual approval is required to make a reservation at the given reservation location.

## Before you begin
It’s important to note the following points before starting to code:
* The Wix user must install the Wix Table Reservations app.
* The Wix user must have at least 1 location configured in the Dashboard under [Business Info](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Fbusiness-info).

## Terminology
For a comprehensive glossary of Table Reservations terms, see [Terminology](https://dev.wix.com/docs/sdk/api-reference/table-reservations/terminology).


To use the TimeSlots API, install the `@wix/table-reservations` package using npm or Yarn:
  ```console
npm install @wix/table-reservations
```

or

```console
yarn add @wix/table-reservations
```

Then import `{ timeSlots }` from `@wix/table-reservations`:

```js
import { timeSlots } from '@wix/table-reservations'
```
  

table-reservations_time-slots

Duration of the time slot in minutes .

Min: `5`

duration

ID of a reservation to ignore during the check.

Use this when rescheduling a reservation to exclude it in its current state from the availability calculations.

excludeReservationId

Party size to check the restaurant's availability for.

Reservation location conflicts that would occur by making a reservation for the specified party size in the specified time slot.

reservationLocationConflicts

Table combinations and their availability information.

tableCombinationAvailabilities

Duration in minutes of the time slot.

Min: `5`

The number of time slots to retrieve after the specified `date`.

slotsAfter

The number of time slots to retrieve before the specified `date`.

slotsBefore

A list of time slots and their availability according to the specified party size.

timeSlots

Status

TableCombinationAvailability

Conflicts that would be generated by attempting to accommodate the proposed reservation using the table combination.

getTimeSlots( )