GET

List Menus Availability Status


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 a menu's availability statuses for a given time slot and restaurant operation. (See the Restaurants Operations API for more information.) Returns the availability status for the given time slot per menu.

Permissions
Manage Restaurants - all permissions
Learn more about app permissions.
Endpoint
GET
https://www.wixapis.com/menu-ordering-settings/v1/menu-ordering-settings/menus-availability-status

Query Params
timeSlot.startTimestringformat date-time

The start time of the time slot in ISO-8601 format.


timeSlot.endTimestringformat date-time

The end time of the time slot in ISO-8601 format.


operationIdstring

The ID of the restaurant operation whose menus will be checked. (See the Restaurants Operations API for more information.)


cursorPaging.limitintegerminimum 0maximum 100format int32

Maximum number of items to return in the results.


cursorPaging.cursorstringmaxLength 16000

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

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

Response Object
menusAvailabilityStatusArray <MenuAvailabilityStatus>maxItems 100

The retrieved menus' availability statuses.


pagingMetadataPagingMetadata

The metadata of the paginated results.

List menu availability statuses
Request
cURL
curl -X GET 'https://www.wixapis.com/restaurants/v1/menu-ordering-settings/menus-availability-status' -H 'Content-Type: application/json' \ -H 'Authorization: <AUTH>' --data-raw '{ "operationId": "48605ac5-53fc-49b4-96b2-87f7636f5ce0", "timeSlot": { "startTime": "2024-07-16T00:00:00Z", "endTime": "2024-07-16T00:00:00Z" } }'
Response
JSON
{ "menus_availability_status": [ { "menuId": "bbb65621-6338-4837-8fdd-aebc654523e0", "availabilityStatus": "AVAILABLE" }, { "menuId": "8d02b27d-a73f-41de-a538-deb934d55088", "availabilityStatus": "AVAILABLE" }, { "menuId": "74dbb400-4f56-4bb0-8d55-cf23e0485495", "availabilityStatus": "AVAILABLE" } ], "pagingMetadata": { "count": 3, "cursors": { "next": null, "prev": null }, "hasNext": false } }
Errors

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

Did this help?