Skip to main content
GET
{micro_service_base_url}
/
inventory
/
stores
/
{store_id}
/
modifier-groups
Get List Of Modifier Groups
curl --request GET \
  --url 'https://api.example.com/{{micro_service_base_url}}/inventory/stores/{{store_id}}/modifier-groups/'
{
  "modifier_groups": [
    {
      "id": "<string>",
      "name": "<string>",
      "min_quantity": 123,
      "max_quantity": 123,
      "precedence": 123,
      "option_type": "<string>",
      "max_free_options": 123,
      "max_options_qty": 123,
      "status": "<string>",
      "linked_options": "<string>",
      "linked_items": "<string>"
    }
  ]
}
This endpoint returns a comprehensive list of modifier groups configured for your store. You can filter by status, search by name, and control the ordering of results to find specific modifier groups quickly.
This endpoint provides an overview of all your customization options, helping you manage and organize your menu modifiers effectively.

​
Path Parameters

​
store_id
string
required
The unique identifier of the store

​
Query Parameters

​
offset
number
default:0
Number of records to skip for pagination
​
search_string
string
Search term to filter modifier groups by name
​
order
string
default:"ASC"
Sort order for results. Values: “ASC” or “DESC”
​
status
string
Filter by modifier group status. Values: “active” or “inactive”

​
Response

​
modifier_groups
array
Array of modifier group objects

​
Response Example

[
  {
    "id": "1000054",
    "name": "Choose your Sandwich Type",
    "min_quantity": 1,
    "max_quantity": 1,
    "precedence": 0,
    "option_type": "Customization",
    "max_free_options": 0,
    "max_options_qty": null,
    "status": "active",
    "linked_options": "Small,Large,Wrap",
    "linked_items": "Build Your Own Sandwich,Build Your Own Sandwich,Build Your Own Sandwich"
  },
  {
    "id": "1000055",
    "name": "Choice of Meat",
    "min_quantity": 1,
    "max_quantity": 1,
    "precedence": 0,
    "option_type": "Customization",
    "max_free_options": 0,
    "max_options_qty": null,
    "status": "active",
    "linked_options": "Egg Salad,Roast Beef,Honey Ham,Turkey,Salami,Crandberry Walnut Chicken Salad,In-Store Made Chicken Salad,Buffalo Style Chicken Salad,Tuna Salad",
    "linked_items": "Build Your Own Sandwich,Build Your Own Sandwich,Build Your Own Sandwich,Build Your Own Sandwich,Build Your Own Sandwich,Build Your Own Sandwich,Build Your Own Sandwich,Build Your Own Sandwich,Build Your Own Sandwich"
  }
]
Use the search_string parameter to quickly find specific modifier groups by name. The status filter helps you view only active or inactive groups.
The linked_options and linked_items fields provide a quick overview of what’s connected to each modifier group without needing additional API calls.