Introduction

The Reservations API allows you to create and manage reservations at restaurants.

This API provides all the necessary functionality to move a reservation through the phases of its lifecycle, such as from the reservation request until completion.

The Reservations API works together with the Reservation Locations API, which provides information about the physical location of a restaurant, as well as that restaurant’s availability and reservation conditions.

The Reservations API also works together with the Time Slots API, which allows you to retrieve availability information about time slots at a restaurant on a specific date and for a specific party size.

With the Reservations API, you can:

Create and manage reservations at a restaurant.
Get information about existing reservations at a restaurant.

Before you begin

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

You must install the Wix Table Reservations app.
You must have at least 1 location configured in your Dashboard under Business Info.
To use the Reservations API, import reservations from wix-table-reservations.v2:

import { reservations } from 'wix-table-reservations.v2';

js | Copy Code

Permissions information

The following functions may require elevated permissions to run depending on which fields are included, or the value of certain fields.

createReservation()

Calling createReservation() with the following fields requires elevated permissions:

status
source
reservation.details.tableIds
reservation.details.endDate
ignoreReservationLocationConflicts
ignoreTableCombinationConflicts

If you do not provide a source, the value assigned to it depends on whether you called createReservation() with elevated permissions. With elevated permissions, source is set to UNDEFINED. Otherwise, source is set to ONLINE.

getReservation()

Calling getReservation() with fieldsets set to FULL requires elevated permissions.

Terminology

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

Was this helpful?