Setup

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

Copy
1
npm install @wix/table-reservations

or

Copy
1
yarn add @wix/table-reservations

Then import tableReservations from @wix/table-reservations:

Copy
1
import tableReservations from '@wix/table-reservations'
Was this helpful?
Yes
No

Introduction

The Table Reservations API provides all the functionality required to create and manage restaurant table reservations.

The Reservations API contains the following APIs:

  • Reservation Locations - This API allows you to provide location information and configure reservation settings for individual restaurants. A reservation location represents a physical restaurant, and at least 1 must be configured before using endpoints in the other Reservations APIs.
  • Time Slots - This API allows you to retrieve availability information for time slots at a reservation location. A time slot represents the availability of a restaurant for a specific party size during a given window of time.
  • Reservations - This API allows you to create and manage reservations. A reservation object represents the reservation of 1 or more tables for a party of guests at a particular restaurant.

Before you begin

It’s important to note the following points before starting to code:

  • The site or project owner must install the Wix Table Reservations app.

Terminology

For a comprehensive glossary of Table Reservations terms, see Terminology.

Was this helpful?
Yes
No

Terminology

The Table Reservations APIs provide all the functionality required to create and manage restaurant table reservations.

This article contains a comprehensive list of the various terms and concepts used in Table Reservations and its APIs.

TermDescription
Manual approvalManual approval is a setting that determines whether reservations made online are automatically accepted, or require manual approval from a human.
PartyA party is a group of guests that come to dine together at a restaurant.
Party pacingParty pacing is the maximum number of party reservations that can start within a 15-minute period.
ReservationA reservation is a set of tables and seats reserved for a party at a restaurant for a specific period of time.
Reservation locationA reservation location is a representation of a physical restaurant location at which reservations can be made.
Reservation location conflictA reservation location conflict is an attempt to make a reservation that doesn’t comply with the restaurant’s party pacing or seat pacing rules.
ReserveeA reservee is the person a reservation is made for. Not to be confused with the person making the reservation, although they may be the same.
SeatA seat is a chair or place for one person in a restaurant.
Seat pacingSeat pacing is the maximum number of seats that can be filled by new reservations within a 15-minute period.
SourceThe source of a reservation is how the reservation was made. For example, if it was booked online, in person, through an app, and so on.
StatusThe status of a reservation represents its position in the reservation lifecycle. For example, RESERVED, CANCELED, or FINISHED.
Table combination conflictA table combination conflict is an attempt to make a reservation that doesn’t comply with the restaurant’s table management or online reservation rules.
Time slotA time slot is a period of time in a restaurant’s calendar.
Turnover timeTurnover time is how much time a party needs for an entire reservation - from being seated to leaving the restaurant.
Was this helpful?
Yes
No