The Item Modifier Groups API allows you to manage your item modifier groups. Item modifier groups gather individual menu items (or item modifiers) 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:
It's important to note the following point before starting to code:
This article presents possible use cases and corresponding sample flows that your app can support. It provides a useful starting point as you plan your app's implementation.
If you have several pizzeria sites that use your app you might need to sync menu 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:
modifierGroup.name and modifierGroup.modifiers field values.item.modifierGroups array.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, Query Modifiers.
Modifier group ID.
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.
Date and time the modifier group was created.
Date and time the modifier group was updated.
Modifier group name.
Group of item modifiers.
Modifier group details.
Extended fields.
{
"id": "116a2e4d-1ddd-4947-8050-4aea8d0af2b4",
"revision": "1",
"createdDate": "2023-12-04T08:20:38.784Z",
"updatedDate": "2023-12-04T08:20:38.784Z",
"name": "Topping",
"modifiers": [
{
"id": "481135f7-1392-4a2e-ac6b-12fb0ef398b7",
"additionalChargeInfo": { "additionalCharge": "2.50" }
}
],
"rule": {
"mandatory": false,
"minSelections": 0,
"maxSelections": null
},
"extendedFields": null
}This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Note: The Item Modifier Groups API only works with the Wix Restaurants Menus (New) app. Make sure you downloaded this app from Wix App Market.
Retrieves a list of up to 100 modifier groups.
Modifier group IDs.
Number of items to load.
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.
Retrieved modifier groups.
The metadata of the paginated results.
curl -X GET https://www.wixapis.com/restaurants/item-modifier-group/v1/modifier-groups \
-H 'Authorization: <AUTH>'{
"modifierGroups": [
{
"id": "02042f01-58ab-441c-b5db-55f51c855a62",
"revision": "1",
"createdDate": "2023-12-03T21:23:33.861Z",
"updatedDate": "2023-12-03T21:23:33.861Z",
"name": "Topping",
"modifiers": [
{
"id": "481135f7-1392-4a2e-ac6b-12fb0ef398b7",
"additionalChargeInfo": { "additionalCharge": "2.50" }
},
{
"id": "68eddbbf-da8b-4b24-ac74-a5f6b38b6de6",
"additionalChargeInfo": { "additionalCharge": "0.00" }
}
],
"rule": {
"mandatory": false,
"minSelections": 0,
"maxSelections": null
}
},
{
"id": "0517e5d4-8fd3-4b28-a743-68cf631e534a",
"revision": "1",
"createdDate": "2023-12-03T21:23:33.861Z",
"updatedDate": "2023-12-03T21:23:33.861Z",
"name": "Topping",
"modifiers": [
{
"modifierId": "ef7dc1ed-06df-481a-8ecc-ad87ef9b6b0c",
"additionalChargeInfo": { "additionalCharge": "1.00" }
},
{
"modifierId": "869315e7-f1c8-428b-aff0-68bf2d7af067",
"additionalChargeInfo": { "additionalCharge": "1.50" }
},
{
"modifierId": "b719995f-fed6-469d-9330-4b9ea9662edf",
"additionalChargeInfo": { "additionalCharge": "2.00" }
}
],
"rule": {
"mandatory": false,
"minSelections": 0,
"maxSelections": null
}
},
{
"id": "1c1ca051-b460-4064-b7a2-5f9df47f2d3c",
"revision": "1",
"createdDate": "2023-12-03T21:23:33.861Z",
"updatedDate": "2023-12-03T21:23:33.861Z",
"name": "Sauces",
"modifiers": [
{
"modifierId": "ef7dc1ed-06df-481a-8ecc-ad87ef9b6b0c",
"additionalChargeInfo": { "additionalCharge": "0.00" }
},
{
"modifierId": "869315e7-f1c8-428b-aff0-68bf2d7af067",
"additionalChargeInfo": { "additionalCharge": "0.00" }
},
{
"modifierId": "b719995f-fed6-469d-9330-4b9ea9662edf",
"additionalChargeInfo": { "additionalCharge": "2.00" }
}
],
"rule": {
"mandatory": true,
"minSelections": 1,
"maxSelections": 1
}
}
],
"pagingMetadata": {
"count": 3,
"cursors": {},
"hasNext": false
}
}This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Note: The Item Modifier Groups API only works with the Wix Restaurants Menus (New) app. Make sure you downloaded this app from Wix App Market.
Creates a modifier group.
To create multiple modifier groups at once, use Bulk Create Modifiers.
You can only call this method when authenticated as a Wix app or Wix user identity.
Modifier group details.
Modifier group.
Title: Create Modifier Group
curl -X POST https://www.wixapis.com/restaurants/item-modifier-group/v1/modifier-groups \
-H 'Authorization: <AUTH>' \
--data-binary '{
"modifierGroup": {
"name": "Topping",
"modifiers": [
{
"id": "481135f7-1392-4a2e-ac6b-12fb0ef398b7",
"additionalChargeInfo": {"additionalCharge": "2.50"}
},
{
"id": "68eddbbf-da8b-4b24-ac74-a5f6b38b6de6",
"additionalChargeInfo": {"additionalCharge": "0.00"}
}
],
"rule": {
"mandatory": false,
"minSelections": 0,
"maxSelections": null
}
}
}'This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Note: The Item Modifier Groups API only works with the Wix Restaurants Menus (New) app. Make sure you downloaded this app from Wix App Market.
Retrieves a modifier group by the ID.
Modifier group ID.
Modifier group.
curl -X GET https://www.wixapis.com/restaurants/item-modifier-group/v1/modifier-groups/02042f01-58ab-441c-b5db-55f51c855a62 \
-H 'Authorization: <AUTH>'{
"modifierGroup": {
"id": "02042f01-58ab-441c-b5db-55f51c855a62",
"revision": "1",
"createdDate": "2023-12-03T21:23:33.861Z",
"updatedDate": "2023-12-03T21:23:33.861Z",
"name": "Topping",
"modifiers": [
{
"id": "481135f7-1392-4a2e-ac6b-12fb0ef398b7",
"additionalChargeInfo": { "additionalCharge": "2.50" }
},
{
"id": "68eddbbf-da8b-4b24-ac74-a5f6b38b6de6",
"additionalChargeInfo": { "additionalCharge": "0.00" }
}
],
"rule": {
"mandatory": false,
"minSelections": 0,
"maxSelections": null
}
}
}This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Note: The Item Modifier Groups API only works with the Wix Restaurants Menus (New) app. Make sure you downloaded this app from Wix App Market.
Deletes a modifier group.
You can only call this method when authenticated as a Wix app or Wix user identity.
Modifier group ID.
Title: Delete a modifier group
curl -X DELETE https://www.wixapis.com/restaurants/item-modifier-group/v1/modifier-groups/cbbf4358-292c-4e9e-a820-7e75b4551120 \
-H 'Authorization: <AUTH>'This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.