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.

Applying modifiers to menu item portions

You can configure portions for menu items. For example, a pizza menu item might be divided into portions named "half one" and "half two." You can then apply different modifiers to each portion. For information on menu portions, see Portions.

When you create an order in the orders API, to add portions and modifiers for those portions:

  1. Add each portion as a modifier of a menu item selection.

  2. For each portion modifier, set selectionType to PORTION.

  3. Apply modifiers to each portion.

To retrieve the GUIDs for the portions, use the menus API.

The following example order JSON applies modifiers to portions of a menu item selection.

{
  "entityType": "Order",
  "diningOption": {
    [contents omitted]
  },
  "checks": [
    {
      "customer": {
          [contents omitted]
      },
      "selections": [
        {
          "itemGroup": {
            "guid": "9a861b29-58ee-4c1c-9e23-9cac3a1132d4",1
          },
          "item": {
            "guid": "025006c3-acdc-4d09-be94-faffde4ce3b7"2
          },
          "quantity": 1,
          "modifiers": [3
            {
              "item": {
                "guid": "1e12608c-0875-4951-8570-cbc52e1180e6",4
              },
              "quantity": 1,
              "selectionType": "PORTION",5
              "modifiers": [6
                {
                  "optionGroup": {
                    "guid": "669c7b5e-d0d8-49ef-af2d-f71ff3aa4ef3",7
                  },
                  "item": {
                    "guid": "10e66af7-85aa-4865-9ad0-bcf9d95f44c4",8
                  },
                  "quantity": 1
                }
              ]
            },
            {
              "item": {
                "guid": "5f1257ac-00a1-43d1-8ad5-c9649629f651",9
              },
              "quantity": 1,
              "selectionType": "PORTION",10
              "modifiers": [11
                {
                  "optionGroup": {
                    "guid": "669c7b5e-d0d8-49ef-af2d-f71ff3aa4ef3",
                  "item": {
                    "guid": "4ca5f20e-2330-4a20-88dd-882dfdb8193f"
                  },
                  "quantity": 1
                  }
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}

1

The GUID of the menu group for this item selection. For example, this menu group might be "pizzas."

2

The GUID of the menu item for this item selection. For example, this menu item might be "cheese pizza."

3

Apply portions to the menu item selection in the modifiers value for that item.

4

The GUID of one of the portions configured for this menu item. For example, this portion might be "half1."

5

Include a selectionType value and include the value PORTION.

6

Apply modifiers to a portion in the modifiers value for that portion.

8

The GUID of the modifier group for this item selection. For example, this modifier group might be "pizza toppings."

7

The GUID of the modifier for this item selection. For example, this modifier might be "mushrooms."

9

The GUID of another portion configured for this menu item. For example, this portion might be "half2."

10

Include a selectionType value and include the value PORTION.

11

Apply modifiers to a portion in the modifiers value for that portion.