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 you can set and modify with 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:

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.

Use cases

Reservation app for restaurants on a Wix site

Terminology

For a comprehensive glossary of Reservations terms, see Terminology.

Did this help?

Reservation Locations: Supported Filters and Sorting

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

FieldSupported FiltersSortable
id$eq, $ne, $in

Related content: API Query Language, Query Reservation Locations

Did this help?

Reservation Location Object


Properties
idstringRead-onlyformat GUID

Reservation location ID.


revisionintegerformat int64

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 specify 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.


locationLocationRead-only

Physical location details.

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


configurationConfiguration

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.


extendedFieldsExtendedFields

Custom field data for the reservation location object.

Extended fields must be configured in the app dashboard before they can be accessed with API calls.

ReservationLocation
JSON
{ "reservationLocation": { "id": "28bca9ee-e5b9-4081-9f45-a6dded8593a1", "revision": "3", "createdDate": "2022-10-20T13:28:33.106Z", "updatedDate": "2023-04-06T12:25:41.555Z", "location": { "id": "56d8ab44-7555-4324-95dc-36b5371a8ffe" }, "configuration": { "onlineReservations": { "seatPacing": { "number": 5, "enabled": true }, "partyPacing": { "number": 2, "enabled": true }, "partySize": { "min": 2, "max": 7 }, "minimumReservationNotice": { "number": 30, "unit": "MINUTES" }, "defaultTurnoverTime": 90, "turnoverTimeRules": [ { "seatsMin": 12, "seatsMax": 17, "minutes": 10 } ], "businessSchedule": { "periods": [ { "openDay": "SUNDAY", "openTime": "09:00", "closeDay": "SUNDAY", "closeTime": "18:00" }, { "openDay": "MONDAY", "openTime": "09:00", "closeDay": "MONDAY", "closeTime": "18:00" }, { "openDay": "WEDNESDAY", "openTime": "09:00", "closeDay": "WEDNESDAY", "closeTime": "18:00" }, { "openDay": "FRIDAY", "openTime": "09:00", "closeDay": "FRIDAY", "closeTime": "18:00" }, { "openDay": "SATURDAY", "openTime": "09:00", "closeDay": "SATURDAY", "closeTime": "18:00" } ], "specialHourPeriod": [] }, "onlineReservationsEnabled": true, "manualApproval": { "enabled": true, "partySizeThreshold": 4 } }, "reservationForm": { "customFieldDefinitions": [ { "id": "2f84023b-1a1b-4311-8951-da19a23c4b10", "name": "Allergies", "required": false }, { "id": "fa69341c-de2b-4287-ae61-249403785f60", "name": "Vegetarian", "required": true } ] }, "myReservationsFields": [ { "fieldType": "TABLE", "shown": true }, { "fieldType": "START_DATE", "shown": true }, { "fieldType": "END_DATE", "shown": true }, { "fieldType": "CREATED_DATE", "shown": true }, { "fieldType": "UPDATED_DATE", "shown": true }, { "fieldType": "PARTY_SIZE", "shown": true }, { "fieldType": "FIRST_NAME", "shown": true }, { "fieldType": "LAST_NAME", "shown": true }, { "fieldType": "EMAIL", "shown": true }, { "fieldType": "PHONE", "shown": true }, { "fieldType": "ADDITIONAL_INFO", "shown": true }, { "fieldType": "TEAM_MESSAGE", "shown": true }, { "fieldType": "CUSTOM_FIELD", "customFieldId": "2f84023b-1a1b-4311-8951-da19a23c4b10", "shown": false }, { "fieldType": "CUSTOM_FIELD", "customFieldId": "fa69341c-de2b-4287-ae61-249403785f60", "shown": false } ], "tableManagement": { "tableDefinitions": [ { "id": "c215fb2a-0eb9-43d9-b7a7-8957e24c66e7", "name": "Small table", "seatsMin": 2, "seatsMax": 4, "isActive": false }, { "id": "32d26bf5-05ae-463b-b37a-596cd6263375", "name": "Medium table", "seatsMin": 2, "seatsMax": 6, "isActive": true }, { "id": "fccb04df-d22d-4832-ad34-2ac99d7a54e5", "name": "Big table", "seatsMin": 5, "seatsMax": 8, "isActive": true } ], "deletedTableDefinitions": [ { "id": "f737be7b-b75e-444e-a250-276234ad522d", "name": "Table", "seatsMin": 2, "seatsMax": 5, "isActive": true } ], "tableCombinations": [] } }, "default": true, "archived": false } }
Did this help?

GET

Get 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.

Permissions
Manage Reservation Locations
Read Reservation Locations (Basic)
Read Reservation Locations (Full)
Manage Restaurants - all permissions
Learn more about app permissions.
Endpoint
GET
https://www.wixapis.com/table-reservations/reservation-locations/v1/reservation-locations/{reservationLocationId}

Path Params
reservationLocationIdstringRequired

ID of the ReservationLocation to retrieve.

Query Params
fieldsetsArray <string>

Array of named, predefined sets of projected fields to be returned.

Default: PUBLIC.

Response Object
reservationLocationReservationLocation

The retrieved reservation location.

Get a reservation location
Request
cURL
curl -X GET 'https://www.wixapis.com/table-reservations/reservation-locations/v1/reservation-locations/7b0221b9-a14a-48a3-a71c-f0d3b5d2b1ae?fieldsets=FULL' \ -H 'Authorization: <AUTH>'
Response
JSON
{ "reservationLocation": { "id": "28bca9ee-e5b9-4081-9f45-a6dded8593a1", "revision": "3", "createdDate": "2022-10-20T13:28:33.106Z", "updatedDate": "2023-04-06T12:25:41.555Z", "location": { "id": "56d8ab44-7555-4324-95dc-36b5371a8ffe" }, "configuration": { "onlineReservations": { "seatPacing": { "number": 5, "enabled": true }, "partyPacing": { "number": 2, "enabled": true }, "partySize": { "min": 2, "max": 7 }, "minimumReservationNotice": { "number": 30, "unit": "MINUTES" }, "defaultTurnoverTime": 90, "turnoverTimeRules": [ { "seatsMin": 12, "seatsMax": 17, "minutes": 10 } ], "businessSchedule": { "periods": [ { "openDay": "SUNDAY", "openTime": "09:00", "closeDay": "SUNDAY", "closeTime": "18:00" }, { "openDay": "MONDAY", "openTime": "09:00", "closeDay": "MONDAY", "closeTime": "18:00" }, { "openDay": "WEDNESDAY", "openTime": "09:00", "closeDay": "WEDNESDAY", "closeTime": "18:00" }, { "openDay": "FRIDAY", "openTime": "09:00", "closeDay": "FRIDAY", "closeTime": "18:00" }, { "openDay": "SATURDAY", "openTime": "09:00", "closeDay": "SATURDAY", "closeTime": "18:00" } ], "specialHourPeriod": [] }, "onlineReservationsEnabled": true, "manualApproval": { "enabled": true, "partySizeThreshold": 4 } }, "reservationForm": { "customFieldDefinitions": [ { "id": "2f84023b-1a1b-4311-8951-da19a23c4b10", "name": "Allergies", "required": false }, { "id": "fa69341c-de2b-4287-ae61-249403785f60", "name": "Vegetarian", "required": true } ] }, "myReservationsFields": [ { "fieldType": "TABLE", "shown": true }, { "fieldType": "START_DATE", "shown": true }, { "fieldType": "END_DATE", "shown": true }, { "fieldType": "CREATED_DATE", "shown": true }, { "fieldType": "UPDATED_DATE", "shown": true }, { "fieldType": "PARTY_SIZE", "shown": true }, { "fieldType": "FIRST_NAME", "shown": true }, { "fieldType": "LAST_NAME", "shown": true }, { "fieldType": "EMAIL", "shown": true }, { "fieldType": "PHONE", "shown": true }, { "fieldType": "ADDITIONAL_INFO", "shown": true }, { "fieldType": "TEAM_MESSAGE", "shown": true }, { "fieldType": "CUSTOM_FIELD", "customFieldId": "2f84023b-1a1b-4311-8951-da19a23c4b10", "shown": false }, { "fieldType": "CUSTOM_FIELD", "customFieldId": "fa69341c-de2b-4287-ae61-249403785f60", "shown": false } ], "tableManagement": { "tableDefinitions": [ { "id": "c215fb2a-0eb9-43d9-b7a7-8957e24c66e7", "name": "Small table", "seatsMin": 2, "seatsMax": 4, "isActive": false }, { "id": "32d26bf5-05ae-463b-b37a-596cd6263375", "name": "Medium table", "seatsMin": 2, "seatsMax": 6, "isActive": true }, { "id": "fccb04df-d22d-4832-ad34-2ac99d7a54e5", "name": "Big table", "seatsMin": 5, "seatsMax": 8, "isActive": true } ], "deletedTableDefinitions": [ { "id": "f737be7b-b75e-444e-a250-276234ad522d", "name": "Table", "seatsMin": 2, "seatsMax": 5, "isActive": true } ], "tableCombinations": [] } }, "default": true, "archived": false } }
Did this help?

PATCH

Update 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 method to change a reservation location's location object. Attempting to do so will cause the server to return an application error.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Reservation Locations
Manage Restaurants - all permissions
Learn more about app permissions.
Endpoint
PATCH
https://www.wixapis.com/table-reservations/reservation-locations/v1/reservation-locations/{reservationLocation.id}

Path Params
reservationLocation.idstringRequired

Reservation location ID.

Body Params
reservationLocationReservationLocationRequired

ReservationLocation to be updated, may be partial.

Response Object
reservationLocationReservationLocation

The updated reservation location.

Update a reservation location
Request
cURL
curl -X PATCH 'https://www.wixapis.com/table-reservations/reservation-locations/v1/reservation-locations/7b0221b9-a14a-48a3-a71c-f0d3b5d2b1ae' \ -H 'Authorization: <AUTH>' \ --data-binary '{ "reservation_location": { "id": "28bca9ee-e5b9-4081-9f45-a6dded8593a1", "revision": "2", "configuration": { "online_reservations": { "partySize": { "min": 1, "max": 20 } } } } }'
Response
JSON
{ "reservationLocation": { "id": "28bca9ee-e5b9-4081-9f45-a6dded8593a1", "revision": "3", "createdDate": "2022-10-20T13:28:33.106Z", "updatedDate": "2023-04-06T12:25:41.555Z", "location": { "id": "56d8ab44-7555-4324-95dc-36b5371a8ffe" }, "configuration": { "onlineReservations": { "seatPacing": { "number": 5, "enabled": true }, "partyPacing": { "number": 2, "enabled": true }, "partySize": { "min": 1, "max": 20 }, "minimumReservationNotice": { "number": 30, "unit": "MINUTES" }, "defaultTurnoverTime": 90, "turnoverTimeRules": [ { "seatsMin": 12, "seatsMax": 17, "minutes": 10 } ], "businessSchedule": { "periods": [ { "openDay": "SUNDAY", "openTime": "09:00", "closeDay": "SUNDAY", "closeTime": "18:00" }, { "openDay": "MONDAY", "openTime": "09:00", "closeDay": "MONDAY", "closeTime": "18:00" }, { "openDay": "WEDNESDAY", "openTime": "09:00", "closeDay": "WEDNESDAY", "closeTime": "18:00" }, { "openDay": "FRIDAY", "openTime": "09:00", "closeDay": "FRIDAY", "closeTime": "18:00" }, { "openDay": "SATURDAY", "openTime": "09:00", "closeDay": "SATURDAY", "closeTime": "18:00" } ], "specialHourPeriod": [] }, "onlineReservationsEnabled": true }, "reservationForm": { "customFieldDefinitions": [ { "id": "2f84023b-1a1b-4311-8951-da19a23c4b10", "name": "Allergies", "required": false }, { "id": "fa69341c-de2b-4287-ae61-249403785f60", "name": "Vegetarian", "required": true } ] }, "myReservationsFields": [ { "fieldType": "TABLE", "shown": true }, { "fieldType": "START_DATE", "shown": true }, { "fieldType": "END_DATE", "shown": true }, { "fieldType": "CREATED_DATE", "shown": true }, { "fieldType": "UPDATED_DATE", "shown": true }, { "fieldType": "PARTY_SIZE", "shown": true }, { "fieldType": "FIRST_NAME", "shown": true }, { "fieldType": "LAST_NAME", "shown": true }, { "fieldType": "EMAIL", "shown": true }, { "fieldType": "PHONE", "shown": true }, { "fieldType": "ADDITIONAL_INFO", "shown": true }, { "fieldType": "TEAM_MESSAGE", "shown": true }, { "fieldType": "CUSTOM_FIELD", "customFieldId": "2f84023b-1a1b-4311-8951-da19a23c4b10", "shown": false }, { "fieldType": "CUSTOM_FIELD", "customFieldId": "fa69341c-de2b-4287-ae61-249403785f60", "shown": false } ], "tableManagement": { "tableDefinitions": [ { "id": "c215fb2a-0eb9-43d9-b7a7-8957e24c66e7", "name": "Small table", "seatsMin": 2, "seatsMax": 4, "isActive": false }, { "id": "32d26bf5-05ae-463b-b37a-596cd6263375", "name": "Medium table", "seatsMin": 2, "seatsMax": 6, "isActive": true }, { "id": "fccb04df-d22d-4832-ad34-2ac99d7a54e5", "name": "Big table", "seatsMin": 5, "seatsMax": 8, "isActive": true } ], "deletedTableDefinitions": [ { "id": "f737be7b-b75e-444e-a250-276234ad522d", "name": "Table", "seatsMin": 2, "seatsMax": 5, "isActive": true } ], "tableCombinations": [] } }, "default": true, "archived": false } }
Errors
400Invalid Argument

There is 1 error with this status code:

See the entire list and learn more about Wix errors.

Event TriggersThis method triggers the following events:
Did this help?

POST

Update Extended Fields


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 the extended fields of a reservation location without incrementing the revision number.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Reservation Locations
Manage Restaurants - all permissions
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/table-reservations/reservation-locations/v1/reservation-locations/{id}/update-extended-fields

Path Params
idstringRequired

ID of the entity to update.

Body Params
namespacestringRequired

Identifier for the app whose extended fields are being updated.


namespaceDatastructRequired

Data to update. Structured according to the schema defined when the extended fields were configured.

Response Object
reservationLocationReservationLocation

Updated reservation location.

Did this help?

POST

Query 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.

Permissions
Manage Reservation Locations
Read Reservation Locations (Basic)
Read Reservation Locations (Full)
Manage Restaurants - all permissions
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/table-reservations/reservation-locations/v1/reservation-locations/query

Body Params
queryQueryRequired

Query options.


fieldsetsArray <string>maxItems 1

Array of named, predefined sets of projected fields to be returned.

Default: PUBLIC.

Response Object
reservationLocationsArray <ReservationLocation>

List of reservation locations.


pagingMetadataPagingMetadata

Metadata for the paginated results.

Query reservation locations
Request
cURL
curl -X POST 'https://www.wixapis.com/table-reservations/reservation-locations/v1/reservation-locations/query' \ -H 'Authorization: <AUTH>' --data-binary '{ "query": { "sort": [ { "fieldName": "id", "order": "ASC" } ], "cursorPaging" : { "limit" : 2 } }, "fieldsets": ["FULL"] }'
Response
JSON
{ "reservationLocations": [ { "id": "28bca9ee-e5b9-4081-9f45-a6dded8593a1", "revision": "3", "createdDate": "2022-10-20T13:28:33.106Z", "updatedDate": "2023-04-06T12:39:35.038Z", "location": { "id": "56d8ab44-7555-4324-95dc-36b5371a8ffe" }, "configuration": { "onlineReservations": { "seatPacing": { "number": 5, "enabled": true }, "partyPacing": { "number": 2, "enabled": true }, "partySize": { "min": 2, "max": 7 }, "minimumReservationNotice": { "number": 30, "unit": "MINUTES" }, "defaultTurnoverTime": 90, "turnoverTimeRules": [ { "seatsMin": 12, "seatsMax": 17, "minutes": 10 } ], "businessSchedule": { "periods": [ { "openDay": "SUNDAY", "openTime": "09:00", "closeDay": "SUNDAY", "closeTime": "18:00" }, { "openDay": "MONDAY", "openTime": "09:00", "closeDay": "MONDAY", "closeTime": "18:00" }, { "openDay": "WEDNESDAY", "openTime": "09:00", "closeDay": "WEDNESDAY", "closeTime": "18:00" }, { "openDay": "FRIDAY", "openTime": "09:00", "closeDay": "FRIDAY", "closeTime": "18:00" }, { "openDay": "SATURDAY", "openTime": "09:00", "closeDay": "SATURDAY", "closeTime": "18:00" } ], "specialHourPeriod": [] }, "onlineReservationsEnabled": true, "manualApproval": { "enabled": true, "partySizeThreshold": 4 } }, "reservationForm": { "customFieldDefinitions": [ { "id": "2f84023b-1a1b-4311-8951-da19a23c4b10", "name": "Allergies", "required": false }, { "id": "fa69341c-de2b-4287-ae61-249403785f60", "name": "Vegetarian", "required": true } ] }, "myReservationsFields": [ { "fieldType": "TABLE", "shown": true }, { "fieldType": "START_DATE", "shown": true }, { "fieldType": "END_DATE", "shown": true }, { "fieldType": "CREATED_DATE", "shown": true }, { "fieldType": "UPDATED_DATE", "shown": true }, { "fieldType": "PARTY_SIZE", "shown": true }, { "fieldType": "FIRST_NAME", "shown": true }, { "fieldType": "LAST_NAME", "shown": true }, { "fieldType": "EMAIL", "shown": true }, { "fieldType": "PHONE", "shown": true }, { "fieldType": "ADDITIONAL_INFO", "shown": true }, { "fieldType": "TEAM_MESSAGE", "shown": true }, { "fieldType": "CUSTOM_FIELD", "customFieldId": "2f84023b-1a1b-4311-8951-da19a23c4b10", "shown": false }, { "fieldType": "CUSTOM_FIELD", "customFieldId": "fa69341c-de2b-4287-ae61-249403785f60", "shown": false } ], "tableManagement": { "tableDefinitions": [ { "id": "c215fb2a-0eb9-43d9-b7a7-8957e24c66e7", "name": "Small table", "seatsMin": 2, "seatsMax": 4, "isActive": false }, { "id": "32d26bf5-05ae-463b-b37a-596cd6263375", "name": "Medium table", "seatsMin": 2, "seatsMax": 6, "isActive": true }, { "id": "fccb04df-d22d-4832-ad34-2ac99d7a54e5", "name": "Big table", "seatsMin": 5, "seatsMax": 8, "isActive": true } ], "deletedTableDefinitions": [ { "id": "f737be7b-b75e-444e-a250-276234ad522d", "name": "Table", "seatsMin": 2, "seatsMax": 5, "isActive": true } ], "tableCombinations": [] } }, "default": true, "archived": false }, { "id": "40a84336-c72b-4bb6-b254-ba71b049f3c9", "revision": "7", "createdDate": "2022-11-02T10:19:21.100Z", "updatedDate": "2023-04-06T12:41:41.601Z", "location": { "id": "51543a74-627a-4b87-bb3b-e6fcd24aba27" }, "configuration": { "onlineReservations": { "partySize": { "min": 1, "max": 6 }, "minimumReservationNotice": { "number": 30, "unit": "MINUTES" }, "defaultTurnoverTime": 90, "turnoverTimeRules": [], "businessSchedule": { "periods": [ { "openDay": "SUNDAY", "openTime": "00:00", "closeDay": "TUESDAY", "closeTime": "00:00" }, { "openDay": "THURSDAY", "openTime": "00:00", "closeDay": "FRIDAY", "closeTime": "00:00" }, { "openDay": "SATURDAY", "openTime": "00:00", "closeDay": "SUNDAY", "closeTime": "00:00" } ], "specialHourPeriod": [] }, "showPhoneNumber": true, "onlineReservationsEnabled": true }, "reservationForm": { "customFieldDefinitions": [], "lastNameRequired": true, "emailRequired": true }, "myReservationsFields": [ { "fieldType": "TABLE", "shown": true }, { "fieldType": "START_DATE", "shown": true }, { "fieldType": "END_DATE", "shown": true }, { "fieldType": "CREATED_DATE", "shown": true }, { "fieldType": "UPDATED_DATE", "shown": true }, { "fieldType": "PARTY_SIZE", "shown": true }, { "fieldType": "FIRST_NAME", "shown": true }, { "fieldType": "LAST_NAME", "shown": true }, { "fieldType": "EMAIL", "shown": true }, { "fieldType": "PHONE", "shown": true }, { "fieldType": "ADDITIONAL_INFO", "shown": true }, { "fieldType": "TEAM_MESSAGE", "shown": true } ], "tableManagement": { "tableDefinitions": [ { "id": "b39e48e8-bf48-42ae-ab53-d02bcaa29c80", "name": "Small table two", "seatsMin": 1, "seatsMax": 4, "isActive": true }, { "id": "50d599a2-e886-42b1-8da5-0904ac2491a3", "name": "Big table", "seatsMin": 3, "seatsMax": 6, "isActive": true }, { "id": "36faf291-a8d2-4624-ace9-08ee9d1bedad", "name": "Small table one", "seatsMin": 1, "seatsMax": 4, "isActive": false } ], "deletedTableDefinitions": [], "tableCombinations": [ { "id": "5c6418a5-2c83-4e32-8fbb-69269c633ce1", "tableIds": [ "36faf291-a8d2-4624-ace9-08ee9d1bedad", "b39e48e8-bf48-42ae-ab53-d02bcaa29c80" ], "seatsMin": 5, "seatsMax": 8, "isActive": true } ] } }, "default": false, "archived": false } ], "paging_metadata": { "count": 2, "cursors": { "next": "1056a8e19ac1ed3298ebe8d033d13e4ce7983555.IiQwMDMzYzhmNi0zMzg1LTQwNGEtODk3Yi0zZDcxNzI1OGFjMjM" }, "has_next": true } }
Did this help?

GET

List 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.

Permissions
Manage Reservation Locations
Read Reservation Locations (Basic)
Read Reservation Locations (Full)
Manage Restaurants - all permissions
Learn more about app permissions.
Endpoint
GET
https://www.wixapis.com/table-reservations/reservation-locations/v1/reservation-locations

Query Params
paging.limitintegerminimum 0maximum 100format int32

Number of items to load.


paging.cursorstring

Pointer to the next or previous page in the list of results.

You can get the relevant cursor token from the pagingMetadata object in the previous call's response. Not relevant for the first request.


sort.fieldNamestring

Name of the field to sort by.


sort.orderstring

Sort order.

Defaults to ASC.


fieldsetsArray <string>

Array of named, predefined sets of projected fields to be returned.

Default: PUBLIC.

Response Object
reservationLocationsArray <ReservationLocation>

Locations list.


pagingMetadataPagingMetadata

Metadata for the paginated results.

List reseration locations
Request
cURL
curl -X GET 'https://www.wixapis.com/table-reservations/reservation-locations/v1/reservation-locations?fieldsets=FULL' \ -H 'Authorization: <AUTH>'
Response
JSON
{ "reservationLocations": [ { "id": "28bca9ee-e5b9-4081-9f45-a6dded8593a1", "revision": "3", "createdDate": "2022-10-20T13:28:33.106Z", "updatedDate": "2023-04-06T12:39:35.038Z", "location": { "id": "56d8ab44-7555-4324-95dc-36b5371a8ffe" }, "configuration": { "onlineReservations": { "seatPacing": { "number": 5, "enabled": true }, "partyPacing": { "number": 2, "enabled": true }, "partySize": { "min": 2, "max": 7 }, "minimumReservationNotice": { "number": 30, "unit": "MINUTES" }, "defaultTurnoverTime": 90, "turnoverTimeRules": [ { "seatsMin": 12, "seatsMax": 17, "minutes": 10 } ], "businessSchedule": { "periods": [ { "openDay": "SUNDAY", "openTime": "09:00", "closeDay": "SUNDAY", "closeTime": "18:00" }, { "openDay": "MONDAY", "openTime": "09:00", "closeDay": "MONDAY", "closeTime": "18:00" }, { "openDay": "WEDNESDAY", "openTime": "09:00", "closeDay": "WEDNESDAY", "closeTime": "18:00" }, { "openDay": "FRIDAY", "openTime": "09:00", "closeDay": "FRIDAY", "closeTime": "18:00" }, { "openDay": "SATURDAY", "openTime": "09:00", "closeDay": "SATURDAY", "closeTime": "18:00" } ], "specialHourPeriod": [] }, "onlineReservationsEnabled": true, "manualApproval": { "enabled": true, "partySizeThreshold": 4 } }, "reservationForm": { "customFieldDefinitions": [ { "id": "2f84023b-1a1b-4311-8951-da19a23c4b10", "name": "Allergies", "required": false }, { "id": "fa69341c-de2b-4287-ae61-249403785f60", "name": "Vegetarian", "required": true } ] }, "myReservationsFields": [ { "fieldType": "TABLE", "shown": true }, { "fieldType": "START_DATE", "shown": true }, { "fieldType": "END_DATE", "shown": true }, { "fieldType": "CREATED_DATE", "shown": true }, { "fieldType": "UPDATED_DATE", "shown": true }, { "fieldType": "PARTY_SIZE", "shown": true }, { "fieldType": "FIRST_NAME", "shown": true }, { "fieldType": "LAST_NAME", "shown": true }, { "fieldType": "EMAIL", "shown": true }, { "fieldType": "PHONE", "shown": true }, { "fieldType": "ADDITIONAL_INFO", "shown": true }, { "fieldType": "TEAM_MESSAGE", "shown": true }, { "fieldType": "CUSTOM_FIELD", "customFieldId": "2f84023b-1a1b-4311-8951-da19a23c4b10", "shown": false }, { "fieldType": "CUSTOM_FIELD", "customFieldId": "fa69341c-de2b-4287-ae61-249403785f60", "shown": false } ], "tableManagement": { "tableDefinitions": [ { "id": "c215fb2a-0eb9-43d9-b7a7-8957e24c66e7", "name": "Small table", "seatsMin": 2, "seatsMax": 4, "isActive": false }, { "id": "32d26bf5-05ae-463b-b37a-596cd6263375", "name": "Medium table", "seatsMin": 2, "seatsMax": 6, "isActive": true }, { "id": "fccb04df-d22d-4832-ad34-2ac99d7a54e5", "name": "Big table", "seatsMin": 5, "seatsMax": 8, "isActive": true } ], "deletedTableDefinitions": [ { "id": "f737be7b-b75e-444e-a250-276234ad522d", "name": "Table", "seatsMin": 2, "seatsMax": 5, "isActive": true } ], "tableCombinations": [] } }, "default": true, "archived": false }, { "id": "40a84336-c72b-4bb6-b254-ba71b049f3c9", "revision": "7", "createdDate": "2022-11-02T10:19:21.100Z", "updatedDate": "2023-04-06T12:41:41.601Z", "location": { "id": "51543a74-627a-4b87-bb3b-e6fcd24aba27" }, "configuration": { "onlineReservations": { "partySize": { "min": 1, "max": 6 }, "minimumReservationNotice": { "number": 30, "unit": "MINUTES" }, "defaultTurnoverTime": 90, "turnoverTimeRules": [], "businessSchedule": { "periods": [ { "openDay": "SUNDAY", "openTime": "00:00", "closeDay": "TUESDAY", "closeTime": "00:00" }, { "openDay": "THURSDAY", "openTime": "00:00", "closeDay": "FRIDAY", "closeTime": "00:00" }, { "openDay": "SATURDAY", "openTime": "00:00", "closeDay": "SUNDAY", "closeTime": "00:00" } ], "specialHourPeriod": [] }, "showPhoneNumber": true, "onlineReservationsEnabled": true }, "reservationForm": { "customFieldDefinitions": [], "lastNameRequired": true, "emailRequired": true }, "myReservationsFields": [ { "fieldType": "TABLE", "shown": true }, { "fieldType": "START_DATE", "shown": true }, { "fieldType": "END_DATE", "shown": true }, { "fieldType": "CREATED_DATE", "shown": true }, { "fieldType": "UPDATED_DATE", "shown": true }, { "fieldType": "PARTY_SIZE", "shown": true }, { "fieldType": "FIRST_NAME", "shown": true }, { "fieldType": "LAST_NAME", "shown": true }, { "fieldType": "EMAIL", "shown": true }, { "fieldType": "PHONE", "shown": true }, { "fieldType": "ADDITIONAL_INFO", "shown": true }, { "fieldType": "TEAM_MESSAGE", "shown": true } ], "tableManagement": { "tableDefinitions": [ { "id": "b39e48e8-bf48-42ae-ab53-d02bcaa29c80", "name": "Small table two", "seatsMin": 1, "seatsMax": 4, "isActive": true }, { "id": "50d599a2-e886-42b1-8da5-0904ac2491a3", "name": "Big table", "seatsMin": 3, "seatsMax": 6, "isActive": true }, { "id": "36faf291-a8d2-4624-ace9-08ee9d1bedad", "name": "Small table one", "seatsMin": 1, "seatsMax": 4, "isActive": false } ], "deletedTableDefinitions": [], "tableCombinations": [ { "id": "5c6418a5-2c83-4e32-8fbb-69269c633ce1", "tableIds": [ "36faf291-a8d2-4624-ace9-08ee9d1bedad", "b39e48e8-bf48-42ae-ab53-d02bcaa29c80" ], "seatsMin": 5, "seatsMax": 8, "isActive": true } ] } }, "default": false, "archived": false } ], "pagingMetadata": { "count": 2, "cursors": {}, "hasNext": false } }
Did this help?

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.

Permissions
Manage Reservation Locations
Read Reservation Locations (Full)
Manage Restaurants - all permissions
Learn more about app permissions.
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.


updatedEventUpdatedEvent

Event information.

Event Body

The data payload will include the following as an encoded JWT:

JSON
{ "data": { "eventType": "wix.table_reservations.v1.reservation_location_updated", "instanceId": "<app-instance-id>", "data": "<stringified-JSON>", // The identity field is sent as a stringified JSON "identity": { "identityType": "<identityType>", // ANONYMOUS_VISITOR, MEMBER, WIX_USER, APP "anonymousVisitorId": "<anonymousVisitorId>", // in case of ANONYMOUS_VISITOR "memberId": "<memberId>", // in case of MEMBER "wixUserId": "<wixUserId>", // in case of WIX_USER "appId": "<appId>" // in case of APP } } }

ReservationLocationUpdated
JSON
{ "entityId": "28bca9ee-e5b9-4081-9f45-a6dded8593a1", "slug": "updated", "id": "1d034196-3347-4a66-988a-3f30d7e51b9d", "updatedEvent": { "currentEntity": { "reservationLocation": { "id": "28bca9ee-e5b9-4081-9f45-a6dded8593a1", "revision": "2", "createdDate": "2022-10-20T13:28:33.106Z", "updatedDate": "2022-10-20T13:48:38.116Z", "location": { "id": "56d8ab44-7555-4324-95dc-36b5371a8ffe" }, "configuration": { "onlineReservations": { "seatPacing": { "number": 5, "enabled": true }, "partyPacing": { "number": 2, "enabled": true }, "partySize": { "min": 2, "max": 7 }, "minimumReservationNotice": { "number": 30, "unit": "MINUTES" }, "defaultTurnoverTime": 90, "turnoverTimeRules": [ { "seatsMin": 12, "seatsMax": 17, "minutes": 10 } ], "businessSchedule": { "periods": [ { "openDay": "SUNDAY", "openTime": "09:00", "closeDay": "SUNDAY", "closeTime": "18:00" }, { "openDay": "MONDAY", "openTime": "09:00", "closeDay": "MONDAY", "closeTime": "18:00" }, { "openDay": "WEDNESDAY", "openTime": "09:00", "closeDay": "WEDNESDAY", "closeTime": "18:00" }, { "openDay": "FRIDAY", "openTime": "09:00", "closeDay": "FRIDAY", "closeTime": "18:00" }, { "openDay": "SATURDAY", "openTime": "09:00", "closeDay": "SATURDAY", "closeTime": "18:00" } ], "specialHourPeriod": [] }, "onlineReservationsEnabled": true, "manualApproval": { "enabled": true, "partySizeThreshold": 4 } }, "reservationForm": { "customFieldDefinitions": [] }, "myReservationsFields": [ { "fieldType": "TABLE", "shown": true }, { "fieldType": "START_DATE", "shown": true }, { "fieldType": "END_DATE", "shown": true }, { "fieldType": "CREATED_DATE", "shown": true }, { "fieldType": "UPDATED_DATE", "shown": true }, { "fieldType": "PARTY_SIZE", "shown": true }, { "fieldType": "FIRST_NAME", "shown": true }, { "fieldType": "LAST_NAME", "shown": true }, { "fieldType": "EMAIL", "shown": true }, { "fieldType": "PHONE", "shown": true }, { "fieldType": "ADDITIONAL_INFO", "shown": true }, { "fieldType": "TEAM_MESSAGE", "shown": true } ], "tableManagement": { "tableDefinitions": [ { "id": "c215fb2a-0eb9-43d9-b7a7-8957e24c66e7", "name": "Small table", "seatsMin": 2, "seatsMax": 4, "isActive": false }, { "id": "32d26bf5-05ae-463b-b37a-596cd6263375", "name": "Medium table", "seatsMin": 2, "seatsMax": 6, "isActive": true }, { "id": "fccb04df-d22d-4832-ad34-2ac99d7a54e5", "name": "Big table", "seatsMin": 5, "seatsMax": 8, "isActive": true } ], "deletedTableDefinitions": [], "tableCombinations": [] } }, "default": true, "archived": false } } }, "entityFqdn": "wix.table_reservations.v1.reservation_location", "eventTime": "2022-10-20T13:48:38.116Z", "triggeredByAnonymizeRequest": false }
Did this help?

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.

Permissions
Manage Reservation Locations
Read Reservation Locations (Full)
Manage Restaurants - all permissions
Learn more about app permissions.
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.


createdEventCreatedEvent

Event information.

Event Body

The data payload will include the following as an encoded JWT:

JSON
{ "data": { "eventType": "wix.table_reservations.v1.reservation_location_created", "instanceId": "<app-instance-id>", "data": "<stringified-JSON>", // The identity field is sent as a stringified JSON "identity": { "identityType": "<identityType>", // ANONYMOUS_VISITOR, MEMBER, WIX_USER, APP "anonymousVisitorId": "<anonymousVisitorId>", // in case of ANONYMOUS_VISITOR "memberId": "<memberId>", // in case of MEMBER "wixUserId": "<wixUserId>", // in case of WIX_USER "appId": "<appId>" // in case of APP } } }

ReservationLocationCreated
JSON
{ "entityId": "28bca9ee-e5b9-4081-9f45-a6dded8593a1", "slug": "created", "id": "1d034196-3347-4a66-988a-3f30d7e51b9d", "createdEvent": { "entity": { "reservationLocation": { "id": "28bca9ee-e5b9-4081-9f45-a6dded8593a1", "revision": "1", "createdDate": "2022-10-20T13:28:33.106Z", "updatedDate": "2022-10-20T13:28:33.106Z", "location": { "id": "56d8ab44-7555-4324-95dc-36b5371a8ffe" }, "configuration": { "onlineReservations": { "seatPacing": { "number": 5, "enabled": true }, "partyPacing": { "number": 2, "enabled": true }, "partySize": { "min": 2, "max": 7 }, "minimumReservationNotice": { "number": 30, "unit": "MINUTES" }, "defaultTurnoverTime": 90, "turnoverTimeRules": [ { "seatsMin": 12, "seatsMax": 17, "minutes": 10 } ], "businessSchedule": { "periods": [ { "openDay": "SUNDAY", "openTime": "09:00", "closeDay": "SUNDAY", "closeTime": "18:00" }, { "openDay": "MONDAY", "openTime": "09:00", "closeDay": "MONDAY", "closeTime": "18:00" }, { "openDay": "WEDNESDAY", "openTime": "09:00", "closeDay": "WEDNESDAY", "closeTime": "18:00" }, { "openDay": "FRIDAY", "openTime": "09:00", "closeDay": "FRIDAY", "closeTime": "18:00" }, { "openDay": "SATURDAY", "openTime": "09:00", "closeDay": "SATURDAY", "closeTime": "18:00" } ], "specialHourPeriod": [] }, "onlineReservationsEnabled": true, "manualApproval": { "enabled": true, "partySizeThreshold": 4 } }, "reservationForm": { "customFieldDefinitions": [] }, "myReservationsFields": [ { "fieldType": "TABLE", "shown": true }, { "fieldType": "START_DATE", "shown": true }, { "fieldType": "END_DATE", "shown": true }, { "fieldType": "CREATED_DATE", "shown": true }, { "fieldType": "UPDATED_DATE", "shown": true }, { "fieldType": "PARTY_SIZE", "shown": true }, { "fieldType": "FIRST_NAME", "shown": true }, { "fieldType": "LAST_NAME", "shown": true }, { "fieldType": "EMAIL", "shown": true }, { "fieldType": "PHONE", "shown": true }, { "fieldType": "ADDITIONAL_INFO", "shown": true }, { "fieldType": "TEAM_MESSAGE", "shown": true } ], "tableManagement": { "tableDefinitions": [ { "id": "c215fb2a-0eb9-43d9-b7a7-8957e24c66e7", "name": "Small table", "seatsMin": 2, "seatsMax": 4, "isActive": false }, { "id": "32d26bf5-05ae-463b-b37a-596cd6263375", "name": "Medium table", "seatsMin": 2, "seatsMax": 6, "isActive": true }, { "id": "fccb04df-d22d-4832-ad34-2ac99d7a54e5", "name": "Big table", "seatsMin": 5, "seatsMax": 8, "isActive": true } ], "deletedTableDefinitions": [], "tableCombinations": [] } }, "default": true, "archived": false } } }, "entityFqdn": "wix.table_reservations.v1.reservation_location", "eventTime": "2022-10-20T13:28:33.106Z" }
Did this help?