> 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

# QueryMenuOrderingSettings

# Package: onlineOrders

# Namespace: MenuOrderingSettingsService

# Method link: https://dev.wix.com/docs/api-reference/business-solutions/restaurants/online-orders/menu-ordering-settings/query-menu-ordering-settings.md

## Permission Scopes:
Manage Restaurants - all permissions: SCOPE.RESTAURANTS.MEGA-SCOPES

## Introduction

Retrieves a list of menu ordering settings entities given the specified paging, filtering, and sorting. Up to 100 entities can be returned per request.

To learn how to query menu ordering settings entities, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).

---

## REST API

### Schema

```
 Method: queryMenuOrderingSettings
 Description: Retrieves a list of menu ordering settings entities given the specified paging, filtering, and sorting. Up to 100 entities can be returned per request.  To learn how to query menu ordering settings entities, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).
 URL: https://www.wixapis.com/v1/menu-ordering-settings/query
 Method: POST
 Method parameters:
   param name: query | type: CursorQuery   
     - name: cursorPaging | type: CursorPaging | description: Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. 
        - 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. 
        - name: filter | type: object | description: Filter object in the following format: `"filter" : { "fieldName1": "value1", "fieldName2":{"$operator":"value2"} }` Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains` 
        - name: sort | type: array<Sorting> | description: Sort object in the following format: `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]` 
           - name: fieldName | type: string | description: Name of the field to sort by. 
           - name: order | type: SortOrder | description: Sort order. 
                 - enum: ASC, DESC
 Return type: QueryMenuOrderingSettingsResponse
  - name: menuOrderingSettings | type: array<MenuOrderingSettings> | description: List of menu ordering settings entities. 
     - name: id | type: string | description: Menu ordering settings object GUID. 
     - name: revision | type: string | description: Revision number. Increments by 1 each time the menu ordering settings object is updated. To prevent conflicting changes, the existing revision must be specified when updating a menu ordering settings object. 
     - name: createdDate | type: string | description: Date and time the menu ordering settings object was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#combined_date_and_time_representations) format. 
     - name: updatedDate | type: string | description: Date and time the menu ordering settings object was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#combined_date_and_time_representations) format. 
     - name: operationId | type: string | description: GUID of the restaurant operation the menu belongs to. (See the Restaurants Operations API for more information.) 
     - name: menuId | type: string | description: GUID of the menu these settings apply to. 
     - name: onlineOrderingEnabled | type: boolean | description: Whether online ordering is enabled for the menu. 
     - name: availability | type: Availability | description: Menu availability settings. 
        - ONE-OF: 
           - name: weeklyScheduleOptions | type: WeeklyScheduleOptions | description: Settings for availability on a weekly schedule. 
              - name: availableTimes | type: array<DayOfWeekAvailability> | description: List of available time ranges for specific days of the week. 
                 - name: dayOfWeek | type: DayOfWeek | description: The day of week this availability relates to. 
                         - enum:
                         -     MON: Monday.
                         -     TUE: Tuesday.
                         -     WED: Wednesday.
                         -     THU: Thursday.
                         -     FRI: Friday.
                         -     SAT: Saturday.
                         -     SUN: Sunday.
                 - name: timeRanges | type: array<TimeOfDayRange> | description: A list of time ranges during which the fulfillment should be available. 
                    - name: startTime | type: TimeOfDay | description: The start time in time of day representation. 
                       - name: hours | type: integer | description: Hours. <br /> Min: `0`. <br /> Max: `23`. 
                       - name: minutes | type: integer | description: Minutes. <br /> Min: `0`. <br /> Max: `23`. 
                    - name: endTime | type: TimeOfDay | description: The end time in time of day representation. 
           - name: timestampRangesOptions | type: TimestampRangesOptions | description: Settings for availability within a time range. 
              - name: ranges | type: array<AvailableRange> | description: List of available time ranges. 
                 - name: startTime | type: string | description: The start time of the availability 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 availability in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#combined_date_and_time_representations) format. 
        - name: type | type: AvailabilityType | description: Availability type. 
             - enum:
             -     UNSPECIFIED_AVAILABILITY_OPTION: Missing type due to an error.
             -     ALWAYS_AVAILABLE: Available all the time.
             -     WEEKLY_SCHEDULE: Available on specific days and times throughout the week.
             -     TIMESTAMP_RANGES: Available during a specific time range.
        - name: timeZone | type: string | description: Time zone in [Time Zone Database](https://www.iana.org/time-zones) format. 
     - name: businessLocationId | type: string | description: Business location GUID ([SDK](https://dev.wix.com/docs/sdk/backend-modules/restaurants/wix-restaurants-new/about-business-locations.md) | [REST](https://dev.wix.com/docs/rest/business-solutions/restaurants/wix-restaurants-new/about-business-locations.md)) of the menu. 
     - name: extendedFields | type: ExtendedFields | description: Extended fields. 
        - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured.  You can only access fields for which you have the appropriate permissions.  Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md). 
     - name: tags | type: Tags | description: Tags ([SDK](https://dev.wix.com/docs/sdk/backend-modules/tags/tags/introduction.md) | [REST](https://dev.wix.com/docs/rest/business-management/tags/introduction.md)) used to classify and sort different types of menu ordering settings. 
        - name: privateTags | type: TagList | description: Tags that require an additional permission in order to access them, normally not given to site members or visitors. 
           - name: tagIds | type: array | description: List of tag GUIDs 
        - name: tags | type: TagList | description: Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. 
  - name: pagingMetadata | type: CursorPagingMetadata | description: Paging metadata 
     - 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

### Query menu ordering settings
```curl
curl -X POST https://www.wixapis.com/menu-ordering-settings/v1/menu-ordering-settings/query \
    -H 'Content-Type: application/json' \
    -H 'Authorization: <AUTH>' \
    --data-raw '{
                  "query": {
                    "sort": [],
                    "filter": {
                      "name": {
                        "$startsWith": "ASAP"
                      }
                    }
                  }
                }'
```

---

## JavaScript SDK

### Schema

```
 Method: wixClientAdmin.onlineOrders.MenuOrderingSettingsService.queryMenuOrderingSettings(query)
 Description: Retrieves a list of menu ordering settings entities given the specified paging, filtering, and sorting. Up to 100 entities can be returned per request.  To learn how to query menu ordering settings entities, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).
 # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present.
 Required parameters:  query
 Method parameters: 
   param name: query | type: MenuOrderingSettingsQuery   | required: true
     - name: cursorPaging | type: CursorPaging | description: Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. 
        - 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. 
        - name: filter | type: object | description: Filter object in the following format: `"filter" : { "fieldName1": "value1", "fieldName2":{"$operator":"value2"} }` Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains` 
        - name: sort | type: array<Sorting> | description: Sort object in the following format: `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]` 
           - name: fieldName | type: string | description: Name of the field to sort by. 
           - name: order | type: SortOrder | description: Sort order. 
                 - enum: ASC, DESC
 Return type: PROMISE<QueryMenuOrderingSettingsResponse>
  - name: menuOrderingSettings | type: array<MenuOrderingSettings> | description: List of menu ordering settings entities. 
     - name: _id | type: string | description: Menu ordering settings object GUID. 
     - name: revision | type: string | description: Revision number. Increments by 1 each time the menu ordering settings object is updated. To prevent conflicting changes, the existing revision must be specified when updating a menu ordering settings object. 
     - name: _createdDate | type: Date | description: Date and time the menu ordering settings object was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#combined_date_and_time_representations) format. 
     - name: _updatedDate | type: Date | description: Date and time the menu ordering settings object was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#combined_date_and_time_representations) format. 
     - name: operationId | type: string | description: GUID of the restaurant operation the menu belongs to. (See the Restaurants Operations API for more information.) 
     - name: menuId | type: string | description: GUID of the menu these settings apply to. 
     - name: onlineOrderingEnabled | type: boolean | description: Whether online ordering is enabled for the menu. 
     - name: availability | type: Availability | description: Menu availability settings. 
        - ONE-OF: 
           - name: weeklyScheduleOptions | type: WeeklyScheduleOptions | description: Settings for availability on a weekly schedule. 
              - name: availableTimes | type: array<DayOfWeekAvailability> | description: List of available time ranges for specific days of the week. 
                 - name: dayOfWeek | type: DayOfWeek | description: The day of week this availability relates to. 
                         - enum:
                         -     MON: Monday.
                         -     TUE: Tuesday.
                         -     WED: Wednesday.
                         -     THU: Thursday.
                         -     FRI: Friday.
                         -     SAT: Saturday.
                         -     SUN: Sunday.
                 - name: timeRanges | type: array<TimeOfDayRange> | description: A list of time ranges during which the fulfillment should be available. 
                    - name: startTime | type: TimeOfDay | description: The start time in time of day representation. 
                       - name: hours | type: integer | description: Hours. <br /> Min: `0`. <br /> Max: `23`. 
                       - name: minutes | type: integer | description: Minutes. <br /> Min: `0`. <br /> Max: `23`. 
                    - name: endTime | type: TimeOfDay | description: The end time in time of day representation. 
           - name: timestampRangesOptions | type: TimestampRangesOptions | description: Settings for availability within a time range. 
              - name: ranges | type: array<AvailableRange> | description: List of available time ranges. 
                 - name: startTime | type: Date | description: The start time of the availability in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#combined_date_and_time_representations) format. 
                 - name: endTime | type: Date | description: The end time of the availability in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#combined_date_and_time_representations) format. 
        - name: type | type: AvailabilityType | description: Availability type. 
             - enum:
             -     UNSPECIFIED_AVAILABILITY_OPTION: Missing type due to an error.
             -     ALWAYS_AVAILABLE: Available all the time.
             -     WEEKLY_SCHEDULE: Available on specific days and times throughout the week.
             -     TIMESTAMP_RANGES: Available during a specific time range.
        - name: timeZone | type: string | description: Time zone in [Time Zone Database](https://www.iana.org/time-zones) format. 
     - name: businessLocationId | type: string | description: Business location GUID ([SDK](https://dev.wix.com/docs/sdk/backend-modules/restaurants/wix-restaurants-new/about-business-locations.md) | [REST](https://dev.wix.com/docs/rest/business-solutions/restaurants/wix-restaurants-new/about-business-locations.md)) of the menu. 
     - name: extendedFields | type: ExtendedFields | description: Extended fields. 
        - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured.  You can only access fields for which you have the appropriate permissions.  Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md). 
     - name: tags | type: Tags | description: Tags ([SDK](https://dev.wix.com/docs/sdk/backend-modules/tags/tags/introduction.md) | [REST](https://dev.wix.com/docs/rest/business-management/tags/introduction.md)) used to classify and sort different types of menu ordering settings. 
        - name: privateTags | type: TagList | description: Tags that require an additional permission in order to access them, normally not given to site members or visitors. 
           - name: tagIds | type: array | description: List of tag GUIDs 
        - name: tags | type: TagList | description: Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. 
  - name: pagingMetadata | type: CursorPagingMetadata | description: Paging metadata 
     - 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

### queryMenuOrderingSettings
```javascript
import { menuOrderingSettings } from '@wix/restaurants';

async function queryMenuOrderingSettings(query) {
  const response = await menuOrderingSettings.queryMenuOrderingSettings(query);
};
```

### queryMenuOrderingSettings (with elevated permissions)
```javascript
import { menuOrderingSettings } from '@wix/restaurants';
import { auth } from '@wix/essentials';

async function myQueryMenuOrderingSettingsMethod(query) {
  const elevatedQueryMenuOrderingSettings = auth.elevate(menuOrderingSettings.queryMenuOrderingSettings);
  const response = await elevatedQueryMenuOrderingSettings(query);
}
```

### queryMenuOrderingSettings (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 queryMenuOrderingSettings(query) {
  const response = await myWixClient.menuOrderingSettings.queryMenuOrderingSettings(query);
};
```

---