Toast · Schema

PreModifierGroup

Information about a pre-modifier group configured for this restaurant, including an array of pre-modifiers contained in the group.

Food ServicePoint of SaleRestaurantsHospitality

Properties

Name Type Description
name string A descriptive name for this pre-modifier group, for example, "Sandwich Pre-mods".
guid string A unique identifier for this pre-modifier group, assigned by the Toast POS system.
multiLocationId object
preModifiers array An array of `PreModifier` objects that are contained in this pre-modifier group. Pre-modifiers alter the display of modifier options on receipts and tickets to satisfy guest requests such as EXTRA or
View JSON Schema on GitHub

JSON Schema

menus-pre-modifier-group-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/toast/refs/heads/main/json-schema/menus-pre-modifier-group-schema.json",
  "title": "PreModifierGroup",
  "description": "Information about a pre-modifier group configured for this restaurant, including an array of pre-modifiers contained in the group.\n",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "A descriptive name for this pre-modifier group, for example, \"Sandwich Pre-mods\".\n"
    },
    "guid": {
      "description": "A unique identifier for this pre-modifier group, assigned by the Toast POS system.\n",
      "type": "string"
    },
    "multiLocationId": {
      "$ref": "#/definitions/MultiLocationId"
    },
    "preModifiers": {
      "description": "An array of `PreModifier` objects that are contained in this pre-modifier group. Pre-modifiers alter the display of modifier options on receipts and tickets to satisfy guest requests such as EXTRA or ON THE SIDE for modifier options. Pre-modifiers can also be configured to modify the cost of the modifier options they are applied to, for example, by charging more for an EXTRA serving of a modifier option.\n",
      "type": "array",
      "items": {
        "$ref": "#/definitions/PreModifier"
      }
    }
  }
}