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 the 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 owner must install the Wix Table Reservations app.

Use cases

Reservation app for restaurants on a Wix site

Terminology

For a comprehensive glossary of Reservations terms, see Terminology.

Was this helpful?

Yes

Reservation Locations: Supported Filters and Sorting

The following table shows field support for filters and sorting for the Reservation Location object:

Field	Supported Filters	Sortable
`id`	`$eq`, `$ne`, `$in`

Related content: API Query Language, Query Reservation Locations

Was this helpful?

Yes

Reservation Location Object

Properties

idstringRead-onlyformat GUID

Reservation location ID.

revisionobject

Represents the current state of a reservation location. Each time the reservation location is modified, its revision changes. For an update operation to succeed, you must pass the latest revision.

createdDatestringRead-onlyformat date-time

The date and time this reservation location was created.

updatedDatestringRead-onlyformat date-time

The date and time this reservation location was last updated.

locationobject

Physical location details. Locations can be created and configured using the Locations API or on the Business Info page in the Dashboard.

configurationobject

Reservation location configuration.

defaultbooleanRead-only

Whether this reservation location's location is the default location of the business.

archivedbooleanRead-only

Whether this reservation location's location is archived.

Was this helpful?

Yes

GetGet Reservation Location

Developer Preview

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

Retrieves a reservation location by ID.

The FULL fieldset can only be retrieved by users with the READ RESERVATION LOCATIONS (FULL) or MANAGE RESERVATION LOCATIONS permission scopes.

Permission Scopes

For app development, you must have one of the following permission scopes:

Learn more about permission scopes.

Endpoint

GET

https://www.wixapis.com/table-reservations/reservation-locations/v1/reservation-locations/{reservationLocationId}

Was this helpful?

Yes

PatchUpdate Reservation Location

Developer Preview

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

Updates a reservation location. Supports partial updates.

Each time the reservation location is updated, revision increments by 1. The existing revision must be included when updating the reservation location. This ensures you're working with the latest reservation location information, and it prevents unintended overwrites.

You cannot use this endpoint to change a reservation location's location object. Attempting to do so will cause the server to return an application error.

Permission Scopes

For app development, you must have one of the following permission scopes:

Learn more about permission scopes.

Endpoint

PATCH

https://www.wixapis.com/table-reservations/reservation-locations/v1/reservation-locations/{reservationLocation.id}

Event TriggersThis method triggers the following events:

Reservation Location Updated

Was this helpful?

Yes

PostQuery Reservation Locations

Developer Preview

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

Retrieves a list of reservation locations given the provided paging, filtering, and sorting. Up to 100 reservation locations can be returned per request.

For a detailed list of supported operations, see the Supported Filters and Sorting article. To learn how to query reservation locations, see API Query Language.

The FULL fieldset can only be retrieved by users with the READ RESERVATION LOCATIONS (FULL) or MANAGE RESERVATION LOCATIONS permission scopes.

Permission Scopes

For app development, you must have one of the following permission scopes:

Learn more about permission scopes.

Endpoint

POST

https://www.wixapis.com/table-reservations/reservation-locations/v1/reservation-locations/query

Was this helpful?

Yes

GetList Reservation Locations

Developer Preview

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

Retrieves a list of up to 100 reservation locations.

The FULL fieldset can only be retrieved by users with the READ RESERVATION LOCATIONS (FULL) or MANAGE RESERVATION LOCATIONS permission scopes.

Permission Scopes

For app development, you must have one of the following permission scopes:

Learn more about permission scopes.

Endpoint

GET

https://www.wixapis.com/table-reservations/reservation-locations/v1/reservation-locations

Was this helpful?

Yes

Reservation Location Updated

Developer Preview

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

Triggered when a reservation location is updated.

Permission Scopes

For app development, you must have one of the following permission scopes:

Learn more about permission scopes.

Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.

Event Data

idstring

Unique event ID. Allows clients to ignore duplicate webhooks.

entityFqdnstring

Fully qualified domain name of the entity associated with the event. Expected wix.table_reservations.v1.reservation_location.

slugstring

Event name. Expected updated.

entityIdstring

ID of the entity associated with the event.

eventTimestringformat date-time

Event timestamp.

triggeredByAnonymizeRequestboolean

Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).

originatedFromstring

If present, indicates the action that triggered the event.

updatedEventobject

Event information.

Was this helpful?

Yes

Reservation Location Created

Developer Preview

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

Triggered when a reservation location is updated.

Permission Scopes

For app development, you must have one of the following permission scopes:

Learn more about permission scopes.

Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.

Event Data

idstring

Unique event ID. Allows clients to ignore duplicate webhooks.

entityFqdnstring

Fully qualified domain name of the entity associated with the event. Expected wix.table_reservations.v1.reservation_location.

slugstring

Event name. Expected created.

entityIdstring

ID of the entity associated with the event.

eventTimestringformat date-time

Event timestamp.

triggeredByAnonymizeRequestboolean

Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).

originatedFromstring

If present, indicates the action that triggered the event.

createdEventobject

Event information.

Was this helpful?

Yes