This guide will be removed on April 29, 2022. Please use our new, easier-to-use Toast technical documentation site. All updated content is on the new site.

Structure of a modifiers entry

The modifiers value is an array of objects. Each object in modifiers defines the details of a modifier to add to the menu item selection.

Each modifier object contains:

optionGroup

Contains the GUID of the modifier's parent modifier group.

For example, for a salad menu item, a parent modifier group might be the available salad dressings.

item

Contains the GUID of the specific modifier.

For example, in the salad dressings modifier group, a modifier might be the balsamic vinaigrette dressing.

quantity

The quantity for the modifier.

The quantity must match the quantity of the menu item selection. See Requirements for modifier quantities.

preModifier (optional)

Contains the GUID of the pre-modifier, if one is applied.

modifiers (optional)

An array of modifier objects that represent any nested modifiers for this modifier.

A nested modifier further refines the modifier. For example, a Steak menu item has a Sides modifier group. The Sides modifier group contains a Salad modifier. The Salad modifier contains a nested modifier group called Salad Dressing that has Ranch and Balsamic Vinaigrette modifiers.

Modifiers can be nested an arbitrary number of levels deep.

To get the GUID identifiers for modifier groups, modifiers, and pre-modifiers, use the menus API. For more information, see the menus API reference documentation.

The following example message body for an order shows a modifier and a pre-modifier for a menu item selection.

{
  "entityType": "Order",

    [contents omitted]

  "checks": [
    {
      [contents omitted]
      "selections": [
        {
          "itemGroup": {
            "guid": "4c842ed6-ae99-425a-a343-390ab0e081d3",1
          },
          "item": {
            "guid": "28dc4d65-e84b-44f0-8b73-0a721d5a9b88"2
          },
          "quantity": 1,
          "modifiers": [
            {
              "optionGroup": {
                "guid": "d0bf5394-adff-428d-8a6b-bcb848c8b16d"3
              },
              "item": {
                "guid": "ed4d3bfc-ad0c-46e7-afdf-1fb48ff91edd"4
              },
              "quantity": 1,
              "preModifier": {5
                "guid": "6311f315-3df8-48ed-bbc3-bd924cb90d55"6
              },
              "modifiers": []
            }
          ]
        }
      ]
    }
  ]
}

1

The GUID of the menu group for this menu item selection. For example, this menu group might contain salads.

2

The GUID of the menu item for this menu item selection. For example, this menu item might be a garden salad.

3

The GUID of the modifier group for this item selection. For example, this modifier group might contain salad dressings.

4

The GUID of the modifier for this item selection. For example, this modifier might be the balsamic vinaigrette dressing.

5

To specify a pre-modifier for a modifier, add the preModifier value to the modifier.

6

The GUID of the pre-modifier for this modifier. For example, the pre-modifier might be NO or EXTRA.