> Portal Navigation: > > - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version. > - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages). > - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`). > - Top-level index of all portals: https://dev.wix.com/docs/llms.txt > - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt # ListMenusAvailabilityStatus # Package: onlineOrders # Namespace: MenuOrderingSettingsService # Method link: https://dev.wix.com/docs/api-reference/business-solutions/restaurants/online-orders/menu-ordering-settings/list-menus-availability-status.md ## Permission Scopes: Manage Restaurants - all permissions: SCOPE.RESTAURANTS.MEGA-SCOPES ## Introduction 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. --- ## REST API ### Schema ``` Method: listMenusAvailabilityStatus Description: 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. URL: https://www.wixapis.com/v1/menu-ordering-settings/menus-availability-status Method: GET # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: timeSlot Method parameters: param name: cursorPaging | type: CursorPaging - name: limit | type: integer | description: Maximum number of items to return in the results. - name: cursor | type: string | description: 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. query param name: operationId | type: operationId | description: The GUID of the restaurant operation whose menus will be checked. (See the Restaurants Operations API for more information.) param name: timeSlot | type: TimeSlot | required: true - name: startTime | type: string | description: The start time of the time slot in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#combined_date_and_time_representations) format. - name: endTime | type: string | description: The end time of the time slot in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#combined_date_and_time_representations) format. Return type: ListMenusAvailabilityStatusResponse - name: menusAvailabilityStatus | type: array | description: The retrieved menus' availability statuses. - name: menuId | type: string | description: Menu GUID. - name: availabilityStatus | type: AvailabilityStatus | description: The menu's availability status. - enum: - UNKNOWN_AVAILABILITY_STATUS: Unknown availability status. - AVAILABLE: Available. - UNAVAILABLE: Unavailable. - name: pagingMetadata | type: CursorPagingMetadata | description: The metadata of the paginated results. - name: count | type: integer | description: Number of items returned in the response. - name: cursors | type: Cursors | description: Cursor strings that point to the next page, previous page, or both. - name: next | type: string | description: Cursor string pointing to the next page in the list of results. - name: prev | type: string | description: Cursor pointing to the previous page in the list of results. - name: hasNext | type: boolean | description: Whether there are more pages to retrieve following the current page. + `true`: Another page of results can be retrieved. + `false`: This is the last page. ``` ### Examples ### List menu availability statuses ```curl curl -X GET 'https://www.wixapis.com/restaurants/v1/menu-ordering-settings/menus-availability-status' -H 'Content-Type: application/json' \ -H 'Authorization: ' --data-raw '{ "operationId": "48605ac5-53fc-49b4-96b2-87f7636f5ce0", "timeSlot": { "startTime": "2024-07-16T00:00:00Z", "endTime": "2024-07-16T00:00:00Z" } }' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.onlineOrders.MenuOrderingSettingsService.listMenusAvailabilityStatus(timeSlot, options) Description: 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. # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: timeSlot, timeSlot.startTime, timeSlot.endTime Method parameters: param name: options | type: ListMenusAvailabilityStatusOptions none - name: operationId | type: string | description: The GUID of the restaurant operation whose menus will be checked. (See the Restaurants Operations API for more information.) - name: cursorPaging | type: CursorPaging | description: Cursor paging - name: limit | type: integer | description: Maximum number of items to return in the results. - name: cursor | type: string | description: 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. param name: timeSlot | type: TimeSlot | required: true - name: startTime | type: Date | description: The start time of the time slot in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#combined_date_and_time_representations) format. | required: true - name: endTime | type: Date | description: The end time of the time slot in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#combined_date_and_time_representations) format. | required: true Return type: PROMISE - name: menusAvailabilityStatus | type: array | description: The retrieved menus' availability statuses. - name: menuId | type: string | description: Menu GUID. - name: availabilityStatus | type: AvailabilityStatus | description: The menu's availability status. - enum: - UNKNOWN_AVAILABILITY_STATUS: Unknown availability status. - AVAILABLE: Available. - UNAVAILABLE: Unavailable. - name: pagingMetadata | type: CursorPagingMetadata | description: The metadata of the paginated results. - name: count | type: integer | description: Number of items returned in the response. - name: cursors | type: Cursors | description: Cursor strings that point to the next page, previous page, or both. - name: next | type: string | description: Cursor string pointing to the next page in the list of results. - name: prev | type: string | description: Cursor pointing to the previous page in the list of results. - name: hasNext | type: boolean | description: Whether there are more pages to retrieve following the current page. + `true`: Another page of results can be retrieved. + `false`: This is the last page. ``` ### Examples ### listMenusAvailabilityStatus ```javascript import { menuOrderingSettings } from '@wix/restaurants'; async function listMenusAvailabilityStatus(timeSlot,options) { const response = await menuOrderingSettings.listMenusAvailabilityStatus(timeSlot,options); }; ``` ### listMenusAvailabilityStatus (with elevated permissions) ```javascript import { menuOrderingSettings } from '@wix/restaurants'; import { auth } from '@wix/essentials'; async function myListMenusAvailabilityStatusMethod(timeSlot,options) { const elevatedListMenusAvailabilityStatus = auth.elevate(menuOrderingSettings.listMenusAvailabilityStatus); const response = await elevatedListMenusAvailabilityStatus(timeSlot,options); } ``` ### listMenusAvailabilityStatus (self-hosted) Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md). ```javascript import { createClient } from '@wix/sdk'; import { menuOrderingSettings } from '@wix/restaurants'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { menuOrderingSettings }, // Include the auth strategy and host as relevant }); async function listMenusAvailabilityStatus(timeSlot,options) { const response = await myWixClient.menuOrderingSettings.listMenusAvailabilityStatus(timeSlot,options); }; ``` ---