> 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

# QueryModifierGroups

# Package: items

# Namespace: ModifierGroupsService

# Method link: https://dev.wix.com/docs/api-reference/business-solutions/restaurants/menus/items/item-modifier-groups/query-modifier-groups.md

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

## Introduction

> **Note:** The Item Modifier Groups API only works with the Wix Restaurants Menus app. Make sure you downloaded this app from [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new).

Retrieves a list of modifier groups given the provided paging, filtering, and sorting. Up to 500 modifier groups can be returned per request.

To learn how to query modifier groups, see [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md).

---

## REST API

### Schema

```
 Method: queryModifierGroups
 Description: > **Note:** The Item Modifier Groups API only works with the Wix Restaurants Menus app. Make sure you downloaded this app from [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new).  Retrieves a list of modifier groups given the provided paging, filtering, and sorting. Up to 500 modifier groups can be returned per request.  To learn how to query modifier groups, see [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md).
 URL: https://www.wixapis.com/restaurants/menus/v1/modifier-groups/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: Number of items to load. 
        - name: cursor | type: string | description: 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. 
        - 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: QueryModifierGroupsResponse
  - name: modifierGroups | type: array<ModifierGroup> | description: Retrieved modifier groups. 
     - name: id | type: string | description: Modifier group GUID. 
     - name: revision | type: string | description: Revision number, which increments by 1 each time the modifier group is updated. To prevent conflicting changes, the current revision must be passed when updating the modifier group. Ignored when creating a modifier group. 
     - name: createdDate | type: string | description: Date and time the modifier group was created. 
     - name: updatedDate | type: string | description: Date and time the modifier group was updated. 
     - name: name | type: string | description: Modifier group name. 
     - name: modifiers | type: array<Modifier> | description: Group of item modifiers. 
        - name: id | type: string | description: Item modifier GUID. 
        - name: preSelected | type: boolean | description: Whether the item modifier is pre-selected. Default: `false`. 
        - name: additionalChargeInfo | type: AdditionalChargeInfo | description: Item modifier price details. 
           - name: additionalCharge | type: string | description: Additional charge for the item modifier. A value of `0` means the item modifier is free. 
     - name: rule | type: Rule | description: Modifier group details. 
        - name: required | type: boolean | description: Whether the items from the modifier group must be selected. 
        - name: minSelections | type: integer | description: Minimum number of item modifiers a site visitor must select. The value must be lower or equal to the available item modifiers in the group. Default: `0`. 
        - name: maxSelections | type: integer | description: Maximum number of item modifiers a site visitor may select. Must be greater than or equal to the value of `minSelections`. 
     - 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: businessLocationIds | type: array | description: IDs of the business locations ([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)) where these item modifier groups are available. 
  - name: pagingMetadata | type: CursorPagingMetadata | description: Metadata of the paginated results. 
     - name: count | type: integer | description: Number of items returned in the response. 
     - name: cursors | type: Cursors | description: Offset that was requested. 
        - name: next | type: string | description: Cursor pointing to next page in the list of results. 
        - name: prev | type: string | description: Cursor pointing to previous page in the list of results. 
     - name: hasNext | type: boolean | description: Indicates if there are more results after the current page. If `true`, another page of results can be retrieved. If `false`, this is the last page. 


```

### Examples

### Query modifier groups by name
```curl
curl -X POST https://www.wixapis.com/restaurants/item-modifier-group/v1/modifier-groups/query \
-H 'Authorization: <AUTH>'
--data-binary '{
                "query": {
                    "sort": [],
                    "filter": {
                      "name": "Topping"
                    }
                  }
                }'
```

---

## JavaScript SDK

### Schema

```
 Method: wixClientAdmin.items.ModifierGroupsService.queryModifierGroups(query)
 Description: > **Note:** The Item Modifier Groups API only works with the Wix Restaurants Menus app. Make sure you downloaded this app from [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new).  Retrieves a list of modifier groups given the provided paging, filtering, and sorting. Up to 500 modifier groups can be returned per request.  To learn how to query modifier groups, see [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md).
 # 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: ItemModifierGroupQuery   | 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: Number of items to load. 
        - name: cursor | type: string | description: 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. 
        - 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<QueryModifierGroupsResponse>
  - name: modifierGroups | type: array<ModifierGroup> | description: Retrieved modifier groups. 
     - name: _id | type: string | description: Modifier group GUID. 
     - name: revision | type: string | description: Revision number, which increments by 1 each time the modifier group is updated. To prevent conflicting changes, the current revision must be passed when updating the modifier group. Ignored when creating a modifier group. 
     - name: _createdDate | type: Date | description: Date and time the modifier group was created. 
     - name: _updatedDate | type: Date | description: Date and time the modifier group was updated. 
     - name: name | type: string | description: Modifier group name. 
     - name: modifiers | type: array<Modifier> | description: Group of item modifiers. 
        - name: _id | type: string | description: Item modifier GUID. 
        - name: preSelected | type: boolean | description: Whether the item modifier is pre-selected. Default: `false`. 
        - name: additionalChargeInfo | type: AdditionalChargeInfo | description: Item modifier price details. 
           - name: additionalCharge | type: string | description: Additional charge for the item modifier. A value of `0` means the item modifier is free. 
     - name: rule | type: Rule | description: Modifier group details. 
        - name: required | type: boolean | description: Whether the items from the modifier group must be selected. 
        - name: minSelections | type: integer | description: Minimum number of item modifiers a site visitor must select. The value must be lower or equal to the available item modifiers in the group. Default: `0`. 
        - name: maxSelections | type: integer | description: Maximum number of item modifiers a site visitor may select. Must be greater than or equal to the value of `minSelections`. 
     - 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: businessLocationIds | type: array | description: IDs of the business locations ([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)) where these item modifier groups are available. 
  - name: pagingMetadata | type: CursorPagingMetadata | description: Metadata of the paginated results. 
     - name: count | type: integer | description: Number of items returned in the response. 
     - name: cursors | type: Cursors | description: Offset that was requested. 
        - name: next | type: string | description: Cursor pointing to next page in the list of results. 
        - name: prev | type: string | description: Cursor pointing to previous page in the list of results. 
     - name: hasNext | type: boolean | description: Indicates if there are more results after the current page. If `true`, another page of results can be retrieved. If `false`, this is the last page. 


```

### Examples

### queryModifierGroups
```javascript
import { itemModifierGroups } from '@wix/restaurants';

async function queryModifierGroups(query) {
  const response = await itemModifierGroups.queryModifierGroups(query);
};
```

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

async function myQueryModifierGroupsMethod(query) {
  const elevatedQueryModifierGroups = auth.elevate(itemModifierGroups.queryModifierGroups);
  const response = await elevatedQueryModifierGroups(query);
}
```

### queryModifierGroups (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 { itemModifierGroups } from '@wix/restaurants';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { itemModifierGroups },
  // Include the auth strategy and host as relevant
});


async function queryModifierGroups(query) {
  const response = await myWixClient.itemModifierGroups.queryModifierGroups(query);
};
```

---