Toast · Schema

Portion

A container for the modifier groups that can be applied to a portion of a menu item.

RestaurantsPoint Of SalePaymentsOnline OrderingDeliveryLoyaltyGift CardsMenusOrdersKitchenLaborSchedulingInventoryHospitalityPartner Integrations

Properties

Name	Type	Description
name	string	A descriptive name for this portion, for example, "1st Half" or "2nd Half".
guid	string	A unique identifier for this portion, assigned by the Toast POS system.
modifierGroupReferences	array	An array of `referenceId`s for `ModifierGroup` objects. These objects define the modifier groups that can be applied to this portion.
priceScaleFactor	number	A multiplier that adjusts the cost of modifiers in this portion.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/toast-tab/refs/heads/main/json-schema/menus-portion-schema.json",
  "title": "Portion",
  "description": "A container for the modifier groups that can be applied to a portion of a menu item.\n",
  "type": "object",
  "properties": {
    "name": {
      "description": "A descriptive name for this portion, for example, \"1st Half\" or \"2nd Half\".\n",
      "type": "string",
      "example": "Example Name"
    },
    "guid": {
      "description": "A unique identifier for this portion, assigned by the Toast POS system.\n",
      "type": "string",
      "example": "5a401af8-d2e2-4090-8c45-9f87b8b6c4d1"
    },
    "modifierGroupReferences": {
      "type": "array",
      "description": "An array of `referenceId`s for `ModifierGroup` objects. These objects define the modifier groups that can be applied to this portion.\n",
      "minItems": 0,
      "items": {
        "type": "integer"
      }
    },
    "priceScaleFactor": {
      "type": "number",
      "format": "double",
      "description": "A multiplier that adjusts the cost of modifiers in this portion.\n",
      "x-nullable": true,
      "example": 1.0
    }
  }
}