# About Item Modifier Groups

The Item Modifier Groups API allows you to manage your item modifier groups. Item modifier groups gather individual menu items (or [item modifiers](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::234525ed-20da-49b3-b471-6118d4f41a23slug::introduction*fallback::https://dev.wix.com/docs/rest/business-solutions/restaurants/menus/item-modifiers/introduction)) that can be used to modify, enhance, or specify existing menu items in an order. For example, a modifier group is called "Pizza toppings" and has the following modifier items: "extra cheese", "pepperoni", "mushrooms".  

With the Item Modifier Groups API, you can:

- Create, delete, and update item modifier groups.
- Retrieve the information about item modifier groups.

## Before you begin

It's important to note the following point before starting to code:

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

## Use cases

- [Sync pizza menu across all sites](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::01b34f34-1ed7-4b1e-b226-a198151650cbslug::sample-use-cases-and-flows#sync-pizza-menu-across-all-sites*fallback::https://dev.wix.com/docs/rest/business-solutions/restaurants/wix-restaurants-new/menus/item-modifier-groups/sample-use-cases-and-flows#sync-pizza-menu-across-all-sites)

## Terminology

- **Menu**: A list of food and beverage items available for purchase at a restaurant, café, or other dining establishment.
- **Item modifier**: Type of menu item that serves as an addition to an existing menu item. For example, "Almond milk" could be an item modifier that can be applied to a coffee order.

@sdk_package_setup

# Item Modifier Groups: Sample Use Cases & Flows

This article presents possible use cases and corresponding sample flows that you can support. It provides a useful starting point as you plan your implementation.

## Sync pizza menu across all sites

If you have several pizzeria sites, you might need to sync menus across those sites. For example, if there's a new item modifier group called "Extra Toppings", this change also needs to be reflected on other sites.    

To update the pizza menu across all sites:

1. Call [Get Modifier Group](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::01b34f34-1ed7-4b1e-b226-a198151650cbslug::get-modifier-group*fallback::https://dev.wix.com/docs/rest/business-solutions/restaurants/menus/item-modifier-groups/get-modifier-group) on the site where you updated the menu.
1. Extract the `modifierGroup.name` and `modifierGroup.modifiers` field values.
1. Call [Create Modifier Group](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::01b34f34-1ed7-4b1e-b226-a198151650cbslug::create-modifier-group*fallback::https://dev.wix.com/docs/rest/business-solutions/restaurants/menus/item-modifier-groups/create-modifier-group) for your other sites and pass the new item modifier group to each.
1. Call [Update Item](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::ad26d386-d18b-4166-9c20-7c04fa3d5e12slug::update-item*fallback::https://dev.wix.com/docs/rest/business-solutions/restaurants/menus/item/update-item) and add new modifier group ID to the `item.modifierGroups` array.

# Item Modifier Groups: Supported Filters and Sorting

The following table shows field support for filters and sorting for the item modifier groups object:

| Field                                            | Supported Filters                          | Sortable |
| -------------------------------------------------|--------------------------------------------| -------- |
| `id`                                             | `$eq`, `$ne`, `$in`, `$nin`                | Sortable |
| `createdDate`                                    | `$eq`, `$ne`, `$gt`, `$lt`, `$gte`, `$lte` | Sortable |
| `updatedDate`                                    | `$eq`, `$ne`, `$gt`, `$lt`, `$gte`, `$lte` | Sortable |
| `name`                                           | `$eq`, `$ne`, `$in`, `$nin`, `$startsWith` | Sortable |
| `modifiers`                                      | `$exists`                                  | Sortable |
| `modifiers.id`                                   | `$in`, `$nin`, `$hasSome`                  | Sortable |
| `modifiers.modifiers.priceInfo.additionalCharge` | `$eq`, `$ne`, `$in`, `$nin`, `$hasSome`    | Sortable |
| `modifiers.preSelected`                          | `$eq`, `$ne`, `$in`, `$nin`                | Sortable |
| `rule`                                           | `$exists`                                  | Sortable |
| `rule.required`                                  | `$eq`, `$ne`, `$in`, `$nin`                | Sortable |
| `rule.minSelections`                             | `$eq`, `$ne`                               | Sortable |
| `rule.maxSelections`                             | `$eq`, `$ne`                               | Sortable |

**Related content:**
[API Query Language](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::8158a590-f60c-4606-9fed-16a34e275f3a*fallback::https://dev.wix.com/api/rest/getting-started/api-query-language),
[Query Modifiers](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::234525ed-20da-49b3-b471-6118d4f41a23slug::query-modifiers*fallback::https://dev.wix.com/docs/rest/business-solutions/restaurants/menus/item-modifiers/query-modifiers).

Property	Filters	Sort
`id`	`$eq`, `$ne`, `$in`, `$nin`	None
`createdDate`	`$eq`, `$ne`, `$gt`, `$gte`, `$lt`, `$lte`	None
`updatedDate`	`$eq`, `$ne`, `$gt`, `$gte`, `$lt`, `$lte`	None
`modifiers.id`	`$in`, `$nin`, `$hasSome`	None
`modifiers.preSelected`	`$eq`, `$ne`	None
`rule.minSelections`	`$eq`, `$ne`	None
`rule.maxSelections`	`$eq`, `$ne`	None
`modifiers`	`$exists`	None
`rule.required`	`$eq`, `$ne`, `$in`, `$nin`	None
`rule`	`$exists`	None
`name`	`$startsWith`, `$eq`, `$ne`, `$in`, `$nin`	None

Query Modifier Groups