> 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 # BulkCreateModifierGroups # Package: items # Namespace: ModifierGroupsService # Method link: https://dev.wix.com/docs/api-reference/business-solutions/restaurants/menus/items/item-modifier-groups/bulk-create-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). Creates multiple modifier groups. --- ## REST API ### Schema ``` Method: bulkCreateModifierGroups 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). Creates multiple modifier groups. URL: https://www.wixapis.com/restaurants/menus/v1/bulk/modifier-groups/create Method: POST # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: modifierGroups Method parameters: param name: modifierGroups | type: array | description: Modifier groups details. | required: true - name: name | type: string | description: Modifier group name. - name: modifiers | type: array | 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). param name: returnEntity | type: returnEntity | description: Whether to receive the created modifier groups in the response. Return type: BulkCreateModifierGroupsResponse - name: results | type: array | description: Information about the created modifier groups. - name: itemMetadata | type: ItemMetadata | description: Metadata for group modifier creation. - name: id | type: string | description: Item GUID. Should always be available, unless it's impossible (for example, when failing to create an item). - name: originalIndex | type: integer | description: Index of the item within the request array. Allows for correlation between request and response items. - name: success | type: boolean | description: Whether the requested action was successful for this item. When `false`, the `error` field is populated. - name: error | type: ApplicationError | description: Details about the error in case of failure. - name: code | type: string | description: Error code. - name: description | type: string | description: Description of the error. - name: data | type: object | description: Data related to the error. - name: modifierGroup | type: ModifierGroup | description: Created modifier group. - 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 | 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: bulkActionMetadata | type: BulkActionMetadata | description: Metadata for the API call. - name: totalSuccesses | type: integer | description: Number of items that were successfully processed. - name: totalFailures | type: integer | description: Number of items that couldn't be processed. - name: undetailedFailures | type: integer | description: Number of failures without details because detailed failure threshold was exceeded. ``` ### Examples ### Create multiple modifier groups ```curl curl -X POST https://www.wixapis.com/restaurants/item-modifier-group/v1/bulk/modifier-groups/create \ -H 'Authorization: ' --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 }' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.items.ModifierGroupsService.bulkCreateModifierGroups(modifierGroups, options) 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). Creates multiple modifier groups. # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: modifierGroups Method parameters: param name: modifierGroups | type: array | description: Modifier groups details. | required: true - name: name | type: string | description: Modifier group name. - name: modifiers | type: array | 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). param name: options | type: BulkCreateModifierGroupsOptions none - name: returnEntity | type: boolean | description: Whether to receive the created modifier groups in the response. Return type: PROMISE - name: results | type: array | description: Information about the created modifier groups. - name: itemMetadata | type: ItemMetadata | description: Metadata for group modifier creation. - name: _id | type: string | description: Item GUID. Should always be available, unless it's impossible (for example, when failing to create an item). - name: originalIndex | type: integer | description: Index of the item within the request array. Allows for correlation between request and response items. - name: success | type: boolean | description: Whether the requested action was successful for this item. When `false`, the `error` field is populated. - name: error | type: ApplicationError | description: Details about the error in case of failure. - name: code | type: string | description: Error code. - name: description | type: string | description: Description of the error. - name: data | type: object | description: Data related to the error. - name: modifierGroup | type: ModifierGroup | description: Created modifier group. - 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 | 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: bulkActionMetadata | type: BulkActionMetadata | description: Metadata for the API call. - name: totalSuccesses | type: integer | description: Number of items that were successfully processed. - name: totalFailures | type: integer | description: Number of items that couldn't be processed. - name: undetailedFailures | type: integer | description: Number of failures without details because detailed failure threshold was exceeded. ``` ### Examples ### bulkCreateModifierGroups ```javascript import { itemModifierGroups } from '@wix/restaurants'; async function bulkCreateModifierGroups(modifierGroups,options) { const response = await itemModifierGroups.bulkCreateModifierGroups(modifierGroups,options); }; ``` ### bulkCreateModifierGroups (with elevated permissions) ```javascript import { itemModifierGroups } from '@wix/restaurants'; import { auth } from '@wix/essentials'; async function myBulkCreateModifierGroupsMethod(modifierGroups,options) { const elevatedBulkCreateModifierGroups = auth.elevate(itemModifierGroups.bulkCreateModifierGroups); const response = await elevatedBulkCreateModifierGroups(modifierGroups,options); } ``` ### bulkCreateModifierGroups (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 bulkCreateModifierGroups(modifierGroups,options) { const response = await myWixClient.itemModifierGroups.bulkCreateModifierGroups(modifierGroups,options); }; ``` ---