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.

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": {
    }
}