GET

List Modifier Groups


Developer Preview

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.

Permissions
Manage Bookings Services and Settings
Manage Portfolio
Manage Restaurants - all permissions
Learn more about app permissions.
Endpoint
GET
https://www.wixapis.com/restaurants/item-modifier-group/v1/modifier-groups

Query Params
modifierGroupIdsArray <string>

Modifier group IDs.


paging.limitintegerminimum 0maximum 100format int32

Number of items to load.


paging.cursorstring

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.

Response Object
modifierGroupsArray <ModifierGroup>

Retrieved modifier groups.


metadataMetadata

The metadata of the paginated results.

Retrieve all modifier groups
Request
cURL
curl -X GET https://www.wixapis.com/restaurants/item-modifier-group/v1/modifier-groups \ -H 'Authorization: <AUTH>'
Response
JSON
{ "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 } }
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?