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) 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.

Use cases

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.
Did this help?

Item Modifier Groups: Sample Use Cases & Flows

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.

Sync pizza menu across all sites

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:

  1. Call Get Modifier Group on the site where you updated the menu.
  2. Extract the modifierGroup.name and modifierGroup.modifiers field values.
  3. Call Create Modifier Group for your other sites and pass the new item modifier group to each.
  4. Call Update Item and add new modifier group ID to the item.modifierGroups array.
Did this help?

Item Modifier Groups: Supported Filters and Sorting

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

FieldSupported FiltersSortable
id$eq, $ne, $in, $ninSortable
createdDate$eq, $ne, $gt, $lt, $gte, $lteSortable
updatedDate$eq, $ne, $gt, $lt, $gte, $lteSortable
name$eq, $ne, $in, $nin, $startsWithSortable
modifiers$existsSortable
modifiers.id$in, $nin, $hasSomeSortable
modifiers.modifiers.priceInfo.additionalCharge$eq, $ne, $in, $nin, $hasSomeSortable
modifiers.preSelected$eq, $ne, $in, $ninSortable
rule$existsSortable
rule.required$eq, $ne, $in, $ninSortable
rule.minSelections$eq, $neSortable
rule.maxSelections$eq, $neSortable

Related content: API Query Language, Query Modifiers.

Did this help?

Item Modifier Group Object


Properties
idstringRead-onlyformat GUID

Modifier group ID.


revisionintegerRead-onlyformat int64

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.


createdDatestringRead-onlyformat date-time

Date and time the modifier group was created.


updatedDatestringRead-onlyformat date-time

Date and time the modifier group was updated.


namestringminLength 1maxLength 100

Modifier group name.


modifiersArray <Modifier>minItems 0maxItems 25

Group of item modifiers.


ruleRule

Modifier group details.


extendedFieldsExtendedFields

Extended fields.

ModifierGroup
JSON
{ "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 }
Did this help?

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 } }
Did this help?

POST

Create Modifier Group


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.

Creates a modifier group.

To create multiple modifier groups at once, use Bulk Create Modifiers.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Restaurants - all permissions
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/restaurants/item-modifier-group/v1/modifier-groups

Body Params
modifierGroupModifierGroupRequired

Modifier group details.

Response Object
modifierGroupModifierGroup

Modifier group.

Create Modifier Group Example 1
Request
cURL
Title: Create Modifier Group
Response
JSON
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 } } }'
Event TriggersThis method triggers the following events:
Did this help?

GET

Get Modifier Group


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 modifier group by the ID.

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/{modifierGroupId}

Path Params
modifierGroupIdstringRequired

Modifier group ID.

Response Object
modifierGroupModifierGroup

Modifier group.

Retrieve a modifier group
Request
cURL
curl -X GET https://www.wixapis.com/restaurants/item-modifier-group/v1/modifier-groups/02042f01-58ab-441c-b5db-55f51c855a62 \ -H 'Authorization: <AUTH>'
Response
JSON
{ "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 } } }
Did this help?

DELETE

Delete Modifier Group


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.

Deletes a modifier group.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Restaurants - all permissions
Learn more about app permissions.
Endpoint
DELETE
https://www.wixapis.com/restaurants/item-modifier-group/v1/modifier-groups/{modifierGroupId}

Path Params
modifierGroupIdstringRequired

Modifier group ID.

Response Object
Returns an empty object.
Delete Modifier Group Example 1
Request
cURL
Title: Delete a modifier group
Response
JSON
curl -X DELETE https://www.wixapis.com/restaurants/item-modifier-group/v1/modifier-groups/cbbf4358-292c-4e9e-a820-7e75b4551120 \ -H 'Authorization: <AUTH>'
Event TriggersThis method triggers the following events:
Did this help?

POST

Query 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 modifier groups given the provided paging, filtering, and sorting. Up to 100 modifier groups can be returned per request. For a detailed list of supported operations, see the Supported Filters and Sorting article. To learn how to query modifier groups, see API Query Language.

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

Body Params
queryQuery

Query options.

Response Object
modifierGroupsArray <ModifierGroup>

Retrieved modifier groups.


pagingMetadataPagingMetadata

Metadata of the paginated results.

Query modifier groups by name
Request
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" } } }'
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 } } ], "pagingMetadata": { "count": 2, "cursors": {}, "hasNext": false } }
Did this help?

POST

Count 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 API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from the Wix App Market.

Retrieves the number of modifier groups that match a specified filter.

If a filter isn't passed in the request, the endpoint returns the count of all modifier groups.

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

Body Params
filterstruct

Filter for counting modifier groups.

Response Object
countinteger

Counted modifier groups.

Errors
428Failed Precondition

There is 1 error with this status code:

See the entire list and learn more about Wix errors.

Did this help?

PATCH

Update Modifier Group


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.

Updates a modifier group.

Each time a modifier group is updated, its revision increments by 1. The existing revision must be included when updating the modifier group. This ensures you're working with the latest modifier group information, and it prevents unintended overwrites.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Restaurants - all permissions
Learn more about app permissions.
Endpoint
PATCH
https://www.wixapis.com/restaurants/item-modifier-group/v1/modifier-groups/{modifierGroup.id}

Path Params
modifierGroup.idstringRequired

Modifier group ID.

Body Params
modifierGroupModifierGroupRequired

Modifier group to update.

Response Object
modifierGroupModifierGroup

Updated modifier group.

Update a modifier group
Request
cURL
curl -X PATCH https://www.wixapis.com/restaurants/item-modifier-group/02042f01-58ab-441c-b5db-55f51c855a11?modifierGroupId=02042f01-58ab-441c-b5db-55f51c855a11 \ -H 'Authorization: <AUTH>' \ --data-binary '{ "modifierGroup": { "id": "02042f01-58ab-441c-b5db-55f51c855a11", "revision": "2", "name": "Topping", }, "mask": { "paths": [ "name" ] } }'
Response
JSON
{ "modifierGroup": { "id": "02042f01-58ab-441c-b5db-55f51c855a11", "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 } } }
Event TriggersThis method triggers the following events:
Did this help?

POST

Bulk Create 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.

Creates multiple modifier groups.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Restaurants - all permissions
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/restaurants/item-modifier-group/v1/bulk/modifier-groups/create

Body Params
modifierGroupsArray <ModifierGroup>RequiredmaxItems 100

Modifier groups details.


returnEntityboolean

Whether to receive the created modifier groups in the response.

Response Object
resultsArray <BulkCreateModifierGroupsResult>

Information about the created modifier groups.


bulkActionMetadataBulkActionMetadata

Metadata for the API call.

Create multiple modifier groups
Request
cURL
curl -X POST https://www.wixapis.com/restaurants/item-modifier-group/v1/bulk/modifier-groups/create \ -H 'Authorization: <AUTH>' --data-binary '{ "modifierGroups": [ { "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 } }, { "name": "Sides", "modifiers": [ { "id": "b23eba29-b831-4f1b-abfc-1ac4461b2cee", "additionalChargeInfo": {"additionalCharge": "0.20} }, { "id": "b8bd35fc-9f62-4900-a62b-93c7040fef64", "additionalChargeInfo": {"additionalCharge": "0.80"} } ], "rule": { "mandatory": true, "minSelections": 1, "maxSelections": 3 } } ], "returnEntity": false }'
Response
JSON
{ "results": [ { "itemMetadata": { "id": "02042f01-58ab-441c-33db-55221c855c11", "originalIndex": 0, "success": true } }, { "itemMetadata": { "id": "02022fe1-58ab-ee1c-33db-45521c855e11", "originalIndex": 1, "success": true } } ], "bulkActionMetadata": { "totalSuccesses": 2, "totalFailures": 0, "undetailedFailures": 0 } }
Event TriggersThis method triggers the following events:
Did this help?

POST

Bulk Update 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.

Updates multiple item modifier groups at once. This function supports partial updates. Each time a modifier group is updated, its revision increments by 1. The existing revision must be included when updating an item modifier group. This ensures you're working with the latest item information, and prevents unintended overwrites. Up to 100 modifier groups can be returned per request.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Restaurants - all permissions
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/restaurants/item-modifier-group/v1/bulk/modifiers-groups/update

Body Params
modifierGroupsArray <MaskedModifierGroup>RequiredminItems 1maxItems 100

Modifier groups to update.


returnEntityboolean

Whether to receive the updated modifier groups in the response.

Response Object
resultsArray <BulkUpdateModifierGroupsResult>minItems 1maxItems 100

Information about the updated modifier groups.


bulkActionMetadataBulkActionMetadata

Metadata for the API call.

Bulk Update Modifier Groups Example 1
Request
cURL
Title: Bulk update modifier groups
Response
JSON
curl -X POST https://www.wixapis.com/restaurants/item-modifier-group/v1/bulk/modifiers-groups/update \ -H 'Authorization: <AUTH> \ --data-binary '{ "modifierGroups": [ { "modifierGroup": { "modifiers": [], "id": "0e29cc7a-123c-4a7f-b9b3-b456cad20246", "revision": "9", "name": "sugar options" }, "mask": { "paths": [ "name" ] } }, { "modifierGroup": { "modifiers": [], "id": "25878df0-f387-488f-8696-a023e3db0a2d", "name": "Toppings", "revision": "5" }, "mask": { "paths": [ "name" ] } } ], "returnEntity": true }'
Event TriggersThis method triggers the following events:
Did this help?

Item Modifier Group Created


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Permissions
Manage Bookings Services and Settings
Manage Portfolio
Manage Restaurants - all permissions
Learn more about app permissions.
Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring

Unique event ID. Allows clients to ignore duplicate webhooks.


entityFqdnstring

Fully qualified domain name of the entity associated with the event. Expected wix.restaurants.menus.v1.item_modifier_group.


slugstring

Event name. Expected created.


entityIdstring

ID of the entity associated with the event.


eventTimestringformat date-time

Event timestamp.


triggeredByAnonymizeRequestboolean

Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).


originatedFromstring

If present, indicates the action that triggered the event.


createdEventCreatedEvent

Event information.

Event Body

The data payload will include the following as an encoded JWT:

JSON
{ "data": { "eventType": "wix.restaurants.menus.v1.item_modifier_group_created", "instanceId": "<app-instance-id>", "data": "<stringified-JSON>", // The identity field is sent as a stringified JSON "identity": { "identityType": "<identityType>", // ANONYMOUS_VISITOR, MEMBER, WIX_USER, APP "anonymousVisitorId": "<anonymousVisitorId>", // in case of ANONYMOUS_VISITOR "memberId": "<memberId>", // in case of MEMBER "wixUserId": "<wixUserId>", // in case of WIX_USER "appId": "<appId>" // in case of APP } } }

ItemModifierGroupCreated
JSON
{ "id": "420819d4-80ee-4a15-aa52-5d08ae786fa5", "entityFqdn": "wix.restaurants.menus.v1.item_modifier_group", "slug": "created", "entityId": "0517e5d4-8fd3-4b28-a743-68cf631e534a", "createdEvent": { "entity": { "id": "0517e5d4-8fd3-4b28-a743-68cf631e534a", "revision": "1", "createdDate": "2024-01-14T12:42:50.267Z", "updatedDate": "2024-01-14T12:42:50.267Z", "name": "Toppings", "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 } } }, "eventTime": "2024-01-14T12:42:50.316316270Z", "triggeredByAnonymizeRequest": false, "entityEventSequence": "1" }
Did this help?

Item Modifier Group Deleted


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Permissions
Manage Bookings Services and Settings
Manage Portfolio
Manage Restaurants - all permissions
Learn more about app permissions.
Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring

Unique event ID. Allows clients to ignore duplicate webhooks.


entityFqdnstring

Fully qualified domain name of the entity associated with the event. Expected wix.restaurants.menus.v1.item_modifier_group.


slugstring

Event name. Expected deleted.


entityIdstring

ID of the entity associated with the event.


eventTimestringformat date-time

Event timestamp.


triggeredByAnonymizeRequestboolean

Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).


originatedFromstring

If present, indicates the action that triggered the event.


deletedEventstruct

Event information.

Event Body

The data payload will include the following as an encoded JWT:

JSON
{ "data": { "eventType": "wix.restaurants.menus.v1.item_modifier_group_deleted", "instanceId": "<app-instance-id>", "data": "<stringified-JSON>", // The identity field is sent as a stringified JSON "identity": { "identityType": "<identityType>", // ANONYMOUS_VISITOR, MEMBER, WIX_USER, APP "anonymousVisitorId": "<anonymousVisitorId>", // in case of ANONYMOUS_VISITOR "memberId": "<memberId>", // in case of MEMBER "wixUserId": "<wixUserId>", // in case of WIX_USER "appId": "<appId>" // in case of APP } } }
Did this help?

Item Modifier Group Updated


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Permissions
Manage Bookings Services and Settings
Manage Portfolio
Manage Restaurants - all permissions
Learn more about app permissions.
Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring

Unique event ID. Allows clients to ignore duplicate webhooks.


entityFqdnstring

Fully qualified domain name of the entity associated with the event. Expected wix.restaurants.menus.v1.item_modifier_group.


slugstring

Event name. Expected updated.


entityIdstring

ID of the entity associated with the event.


eventTimestringformat date-time

Event timestamp.


triggeredByAnonymizeRequestboolean

Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).


originatedFromstring

If present, indicates the action that triggered the event.


updatedEventUpdatedEvent

Event information.

Event Body

The data payload will include the following as an encoded JWT:

JSON
{ "data": { "eventType": "wix.restaurants.menus.v1.item_modifier_group_updated", "instanceId": "<app-instance-id>", "data": "<stringified-JSON>", // The identity field is sent as a stringified JSON "identity": { "identityType": "<identityType>", // ANONYMOUS_VISITOR, MEMBER, WIX_USER, APP "anonymousVisitorId": "<anonymousVisitorId>", // in case of ANONYMOUS_VISITOR "memberId": "<memberId>", // in case of MEMBER "wixUserId": "<wixUserId>", // in case of WIX_USER "appId": "<appId>" // in case of APP } } }

ItemModifierGroupUpdated
JSON
{ "id": "ce9768c8-5b98-4e66-be70-7b00d49e0c68", "entityFqdn": "wix.restaurants.menus.v1.item_modifier", "slug": "updated", "entityId": "f2409ddd-5408-48d7-bc8d-e1a10750ecfa", "updatedEvent": { "currentEntity": { "id": "0517e5d4-8fd3-4b28-a743-68cf631e534a", "revision": "2", "createdDate": "2024-01-14T12:42:50.267Z", "updatedDate": "2024-01-14T12:42:50.267Z", "name": "Sides", "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 } }, "eventTime": "2024-01-14T12:42:53.076984076Z", "triggeredByAnonymizeRequest": false, "entityEventSequence": "2" } }
Did this help?