Introduction
The Reservations Locations API allows you to configure reservation settings for a restaurant location.
A reservation location represents a physical restaurant and holds the ID of a location
object. The location object holds the address that corresponds to the on-site location of that restaurant (except when the restaurant has no on-site location). Each reservation location has its own calendar, scheduling rules, table management settings, and other attributes that can be set and modified by the API.
With the Reservations Locations API, you can:
- Query or list reservation locations.
- Update the configuration of existing reservation locations.
Note: Reservation locations can only be created and archived through a Wix site Dashboard, or using the Locations API.
Once a reservation location has been configured, you can:
- Retrieve time slots for the location using the Time Slots API.
- Make reservations for the location using a Wix site, or the Reservations API.
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.
Permissions information
The following functions may require additional permissions to run depending on which fields are included, or the value of certain fields.
getReservationLocation()
Calling getReservationLocation()
with fieldsets
set to FULL
requires additional permissions:
- In an app, the
FULL
fieldset requires either theREAD RESERVATION LOCATIONS (FULL)
orMANAGE RESERVATION LOCATIONS
permission scope. - On a headless site, retrieving the
FULL
fieldset requires API key authorization with appropriate permissions.
listReservationLocations()
Calling listReservationLocations()
with fieldsets
set to FULL
requires additional permissions:
- In an app, the
FULL
fieldset requires either theREAD RESERVATION LOCATIONS (FULL)
orMANAGE RESERVATION LOCATIONS
permission scope. - On a headless site, retrieving the
FULL
fieldset requires API key authorization with appropriate permissions.
queryReservationLocations()
Calling queryReservationLocations()
with fieldsets
set to FULL
requires additional permissions:
- In an app, the
FULL
fieldset requires either theREAD RESERVATION LOCATIONS (FULL)
orMANAGE RESERVATION LOCATIONS
permission scope. - On a headless site, retrieving the
FULL
fieldset requires API key authorization with appropriate permissions.
Terminology
For a comprehensive glossary of Table Reservations terms, see Terminology.