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 } }
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?