This guide will be removed on April 29, 2022. Please use our new, easier-to-use Toast technical documentation site. All updated content is on the new site.

Pre/Post modifiers

This section describes:

  • premodifierGroup objects. Each premodifier group contains a group of premodifier objects.

  • premodifier objects. Each premodifier can be a premodifier or postmodifier item.

premodifierGroups

Field

Description

Data Type

name

A descriptive identifier for a premodifierGroup object.

String

guid

The unique identifier for the premodifier group, assigned by the Toast POS.

String

isDefault

Whether or not the item is selected unless a customer chooses to decline it.

Boolean

premodifiers

An array of premodifiers objects.

JSON array


premodifiers

Field

Description

Data Type

name

A descriptive identifier for a specific premodifier or postmodifier in a premodifiers object. For example, ADD or ON SIDE.

String

guid

The unique identifier for the premodifier or postmodifier, assigned by the Toast POS.

String

basePrice

If scalePrice is false, this amount is added to the price. Note that the amount can be 0.00 (so that the price remains the same) and it can also be a negative value (which will reduce the price).

Currency

scalePrice

Determines how the price is scaled. Values are:

  • true - multiplies the price by the scaleFactor value.

  • false - does not multiply the price but instead adds the basePrice value to the item.

Boolean

scaleFactor

If scalePrice is true, the item price is multiplied by this factor.

Number

displayMode

Determines the modifier type. Values are:

  • PREFIX - specifies a premodifier. This means the name of this premodifier is displayed as a prefix before the name of the modifier. For example, if the modifier is named Bacon and the premodifer is named ADD, the full display will be ADD Bacon.

  • SUFFIX - specifies a postmodifier. This means the name of this premodifier is displayed as a suffix after the name of the modifier. For example, if the modifier is named Bacon and the postmodifer is named ON SIDE, the full display will be Bacon ON SIDE.

String