Default modifier items

Default modifiers are able to be enabled on a per-location basis, depending on whether a location’s POS system supports this feature and the location wishes to utilize them.

A Default Modifier is a Modifier Item that should be considered as selected always unless the following condition should be met:

• The Modifier Group that the Default Modifier belongs to has a Maximum Quantity of 1 set and another Modifier Item from the same Modifier Group has been selected explicitly.

When Default Modifiers have been enabled for a location, an additional default Boolean (i.e. true vs false) attribute will be applied to all Modifier objects in the Menu API response object. Default status will be communicated with a true value for default, and all instances where default status for a Modifier object is not applicable will have a false value for default.

In the below example, the “Choose Option (White Zuppa Di Mussels)” Modifier Group has 2 Modifier Items available, and the “Sweet” Modifier Item has the “default” attribute set to true. The Modifier Item that is not a default, has the “default” attribute set to false.

JSON

"modifier_groups": [
  {
    "id": "5064713f-2346-478e-af3a-d96eea73104e",
    "name": "Choose Option (White Zuppa Di Mussels)",
    "modifiers": [
      {
        "id": "270b1865-802b-4560-8b0a-4ac70ab01d66",
        "name": "Hot",
        "price": 0,
        "description": "",
        "suspend_until": "0",
        "modifier_groups": [],
        "nutritional_info": "",
        "default": false
      },
      {
        "id": "ad589ee9-d616-4bcd-aa0d-67c2f3e8f990",
        "name": "Sweet",
        "price": 0,
        "description": "",
        "suspend_until": "0",
        "modifier_groups": [],
        "nutritional_info": "",
         "default": true
      }
    ],
    "description": "",
    "maximum_amount": 2,
    "minimum_amount": 0
  }
]