PreModifier

A wrapper object with fields that allow reference to a Toast entity by Toast GUID.

basePrice
number <double>

Amount to add to the modifier price, if scalePrice is false. Otherwise not used.

chargeAsExtra
boolean or null

When true, selecting this pre-modifier adds an additional portion of the modifier to the menu item and adds the price of the additional portion to the menu item according to the rules listed below.

If the modifier group that the modifier belongs to:

  • Uses the No charge option, the Toast platform uses the modifier's override price or, if no override price exists, the item reference price as the price of the additional portion.
  • Uses the Individual option where each modifier has its own price, the Toast platform uses the modifier's override price or, if no override price exists, the item reference price as the price of the additional portion.
  • Uses the Group option where all modifiers in the group share a price, the Toast platform uses the group price as the price of the additional portion.

Additionally, if the modifier group that the modifier belongs to uses:

  • Size pricing, the Toast platform uses the size price that matches the size of the menu item when determining the price of the additional portion.
  • Sequence pricing, the Toast platform treats the additional portion as the next modifier in the sequence and prices it using the sequence pricing rules that have been specified.
  • Size/sequence pricing, the Toast platform matches the size of the additional portion to the size of the menu item and then treats it as the next modifier in the sequence when determining the price of the additional portion.

The chargeAsExtra value is null if the value is not set.

displayMode
string

Where this premodifier should be displayed relative to the modifier name. PREFIX - before the modifier name SUFFIX - after the modifier name

Enum: "PREFIX" "SUFFIX"
entityType
required
string

The type of object this is.

guid
required
string

The GUID maintained by the Toast POS.

name
string

The name of the pre modifier that appears in the Toast POS.

object (ToastReference)

A wrapper object with fields that allow reference to a Toast entity by Toast GUID.

scaleFactor
number <float>

Amount to multiply the modifier price, if scalePrice is true. Otherwise not used.

scalePrice
boolean

True if this multiplies the modifier price, false if it adds to the modifier price.

{
  • "guid": "string",
  • "entityType": "string",
  • "name": "string",
  • "scalePrice": true,
  • "basePrice": 0,
  • "scaleFactor": 0,
  • "displayMode": "PREFIX",
  • "parent": {
    },
  • "chargeAsExtra": true
}