Skip to main content
GET
{micro_service_base_url}
/
inventory
/
stores
/
{store_id}
/
modifier-groups
/
{modifier_group_id}
{
  "modifier_group": [
    {
      "id": "<string>",
      "name": "<string>",
      "min_quantity": 123,
      "max_quantity": 123,
      "precedence": 123,
      "option_type": "<string>",
      "store_id": "<string>",
      "max_free_options": 123,
      "max_options_qty": 123,
      "status": "<string>",
      "external_id": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "deletedAt": "<string>",
      "description": "<string>",
      "linked_items_count": "<string>",
      "options_count": "<string>",
      "store_item_modifier_groups_mapping": [
        {}
      ],
      "options": [
        {}
      ]
    }
  ]
}
This endpoint provides detailed information about a specific modifier group, including all associated options, linked store items, and complete configuration details. This is useful for reviewing or auditing modifier group setups.
This endpoint returns the complete structure of a modifier group, making it ideal for detailed analysis or debugging configuration issues.

​
Path Parameters

​
store_id
string
required
The unique identifier of the store
​
modifier_group_id
string
required
The unique identifier of the modifier group

​
Response

​
modifier_group
array
Array containing the modifier group details (typically one object)

​
Response Example

[
  {
    "id": "1000124",
    "name": "MG Test 3 - Updated",
    "min_quantity": 0,
    "max_quantity": 2,
    "precedence": 0,
    "option_type": "Customization",
    "store_id": "449235c1-3d04-4519-998b-40d2a621e5e0",
    "max_free_options": 0,
    "max_options_qty": 2,
    "status": "active",
    "external_id": "5606aa02-34ce-4ed1-819b-b76bc81151c0",
    "createdAt": "2024-05-02T00:57:35.628Z",
    "updatedAt": "2024-05-02T00:58:01.654Z",
    "deletedAt": null,
    "description": "Modifier group for drinks",
    "linked_items_count": "2",
    "options_count": "3",
    "store_item_modifier_groups_mapping": [
      {
        "id": "1000094",
        "store_item_id": "3dbe1e78-c746-4940-8db8-ef468c738324",
        "modifier_group_id": "1000124",
        "createdAt": "2024-05-02T00:57:36.280Z",
        "updatedAt": "2024-05-02T00:57:36.280Z",
        "deletedAt": null,
        "storeItem": {
          "id": "3dbe1e78-c746-4940-8db8-ef468c738324",
          "name": "Build Your Own Sandwich",
          "description": "With your choice of bread, meat, cheese and toppings.",
          "price": "6.99"
        }
      }
    ],
    "options": [
      {
        "id": "1000346",
        "modifier_group_id": "1000124",
        "price": "0.00",
        "store_item_id": "2edc15af-2552-45a2-a149-d670279e27f3",
        "status": "active",
        "precedence": 0,
        "external_id": "22b222b1-a5ed-4907-a4e5-71f52e2ab7ab",
        "default_qty": 0,
        "storeItem": {
          "id": "2edc15af-2552-45a2-a149-d670279e27f3",
          "name": "Small",
          "price": "0.0"
        }
      }
    ]
  }
]
Use this endpoint to get a complete overview of a modifier group’s configuration, including all linked items and available options.
The response includes nested objects for linked store items and options, providing complete details without requiring additional API calls.
⌘I