Skip to main content
POST
{micro_service_base_url}
/
inventory
/
stores
/
{store_id}
/
modifier-groups
Create Modifier Group
curl --request POST \
  --url 'https://api.example.com/{{micro_service_base_url}}/inventory/stores/{{store_id}}/modifier-groups/' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "store_id": "<string>",
  "min_quantity": 123,
  "max_quantity": 123,
  "precedence": 123,
  "option_type": "<string>",
  "max_free_options": 123,
  "max_options_qty": 123,
  "status": "<string>",
  "modifier_options": [
    {}
  ],
  "linked_store_items": [
    {}
  ]
}
'

Documentation Index

Fetch the complete documentation index at: https://developer.lulacommerce.com/llms.txt

Use this file to discover all available pages before exploring further.

This endpoint creates a new modifier group that can be used to organize customization options for your menu items. Modifier groups define the rules and constraints for how customers can customize their orders.
Modifier groups are essential for managing product customizations like sizes, add-ons, and variations.

​
Body

​
name
string
required
Name of the modifier group. Example: “MG007”
​
description
string
required
Description of the modifier group. Example: “Modifier group for drinks”
​
store_id
string
required
The unique identifier of the store
​
min_quantity
number
required
Minimum number of options customer must select
​
max_quantity
number
required
Maximum number of options customer can select
​
precedence
number
default:0
Display order precedence for the modifier group
​
option_type
string
required
Type of options in this group. Example: “Customization”
​
max_free_options
number
default:0
Maximum number of free options allowed
​
max_options_qty
number
required
Maximum quantity for each option
​
status
string
required
Status of the modifier group. Values: “active” or “inactive”
​
modifier_options
array
Array of modifier option IDs to associate with this group
​
linked_store_items
array
Array of store item IDs to link with this modifier group

​
Request Example

{
  "name": "MG007",
  "description": "Modifier group for drinks",
  "store_id": "449235c1-3d04-4519-998b-40d2a621e5e0",
  "min_quantity": 0,
  "max_quantity": 2,
  "precedence": 0,
  "option_type": "Customization",
  "max_free_options": 0,
  "max_options_qty": 2,
  "status": "active",
  "modifier_options": ["2edc15af-2552-45a2-a149-d670279e27f3","cfb70950-996e-4dd4-8b43-60b86fb9cc17"],
  "linked_store_items": ["3dbe1e78-c746-4940-8db8-ef468c738324","3dbe1e78-c746-4940-8db8-ef468c738324"]
}

​
Response

This endpoint processes the request and creates the modifier group. No response body is provided upon successful creation.
Use modifier groups to organize related customization options like “Size Options”, “Add-ons”, or “Preparation Methods”.
Ensure that min_quantity is not greater than max_quantity, and that the linked store items exist in your inventory.