| 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 it has not been set.
|
| displayMode | string A string that indicates how the pre-modifier is displayed on tickets and receipts:
- PREFIX: The pre-modifier name is placed before the modifier option name, for example, "EXTRA Cheese".
- SUFFIX: The pre-modifier name is placed after the modifier option name, for example, "Cheese EXTRA".
|
| fixedPrice | number or null <double> An optional fixed price for this pre-modifier. The fixed price is added to the cost of the modifier option that the pre-modifier is applied to.
A PreModifier object has two optional values, fixedPrice and multiplicationFactor, that both alter the price of a modifier option when the pre-modifier is applied to it. However, these values cannot be used at the same time. If you specify a fixedPrice value for a premodifier, then multiplicationFactor is null. If you specify a multiplicationFactor for a pre-modifier, then fixedPrice is null. If you choose not to assign either a fixed price or a multiplication factor to a pre-modifier, then the fixedPrice value is 0 and the multiplicationFactor is null.
|
| guid | string A unique identifier for this pre-modifier group, assigned by the Toast POS system.
|
| multiLocationId | string (MultiLocationId) An identifier that is used to identify and consolidate menu entities that are versions of each other.
multiLocationId replaces masterId. multiLocationId and masterId always have the same value.
Menu entities can be versioned. Those versions can be assigned to specific restaurant locations, or groups of locations, in a management group. For example, you could have two versions of a burger, one for a Boston location and another for a New York City location. Versioned menu entities share the majority of, but not all of, their data. For example, the Boston version is called the Minuteman Burger and has pickles, while the New York City version is called the Empire Burger and does not.
You use the multiLocationId to identify menu entities that are versions of each other. To continue the example above, the Minuteman Burger in the JSON returned for the Boston location has the same multilocationId as the Empire Burger in the JSON returned for the New York City location. These matching multlocationId values indicate that the two items are related versions of the same item. In Toast reports, this allows a restaurant to track sales of the burger across both locations.
The Toast POS system ensures that once a multilocationId value is assigned to a set of versions within a management group, that multiLocationId is not used for any other version sets in the same management group. It does not guarantee, however, that the multiLocationId is not used by another management group to identify a set of versions within it.
See Toast identifiers in the Toast Developer Guide for more information on the multiLocationId and its relationship to other Toast identifiers.
See Enterprise module overview in the Toast Platform Guide for more information on the enterprise module and versioning.
|
| multiplicationFactor | number or null <double> An optional number that specifies how much the cost of a modifier option is multiplied by when this pre-modifier is applied to it. For example, an EXTRA pre-modifier option could specify a multiplicationFactor of 1.5 to indicate that adding extra cheese to a menu item costs one and a half times the regular price of the cheese modifier option.
A PreModifier object has two optional values, fixedPrice and multiplicationFactor, that both alter the price of a modifier option when the pre-modifier is applied to it. However, these values cannot be used at the same time. If you specify a fixedPrice value for a premodifier, then multiplicationFactor is null. If you specify a multiplicationFactor for a premodifier, then fixedPrice is null. If you choose not to assign either a fixed price or a multiplication factor to a pre-modifier, then the fixedPrice value is 0 and the multiplicationFactor is null.
|
| name | string A descriptive name for this pre-modifier, for example, "NO" or "EXTRA".
|
| posButtonColorDark | string (PosButtonColorDark) The color of the menu entity's button on the Toast POS app, when the app is running in dark mode.
When an employee configures a POS button's color, they select a color pairing that consists of two colors, one for light mode and one for dark mode. posButtonColorDark contains the HEX code for the dark mode color.
posButtonColorDark defaults to #1a1c23, the HEX code when the WHITE color pairing is chosen.
The following list shows the possible HEX codes for posButtonColorDark, with the associated color pairing in parentheses.
- #1a1c23 (WHITE)
- #7e635d (TERRACOTTA_1)
- #74504D (TERRACOTTA_2)
- #722e25 (TERRACOTTA_3)
- #561408 (TERRACOTTA_4)
- #8f5f3d (ORANGE_1)
- #7e4116 (ORANGE_2)
- #803500 (ORANGE_3)
- #682d03 (ORANGE_4)
- #7e6b44 (YELLOW_1)
- #7b5f27 (YELLOW_2)
- #7c5000 (YELLOW_3)
- #633d09 (YELLOW_4)
- #657552 (GRASS_1)
- #556e34 (GRASS_2)
- #37570a (GRASS_3)
- #113a00 (GRASS_4)
- #637486 (SKY_1)
- #4d6074 (SKY_2)
- #2a456b (SKY_3)
- #213554 (SKY_4)
- #78668a (LAVENDER_1)
- #5e4776 (LAVENDER_2)
- #402960 (LAVENDER_3)
- #25174f (LAVENDER_4)
- #6c6c6c (GRAY_1)
- #5f5f5f (GRAY_2)
- #474747 (GRAY_3)
- #404040 (GRAY_4)
|
| posButtonColorLight | string (PosButtonColorLight) The color of the menu entity's button on the Toast POS app, when the app is running in light mode.
When an employee configures a POS button's color, they select a color pairing that consists of two colors, one for light mode and one for dark mode. posButtonColorLight contains the HEX code for the light mode color.
posButtonColorLight defaults to #f7f7f7, the HEX code when the WHITE color pairing is chosen.
The following list shows the possible HEX codes for posButtonColorLight, with the associated color pairing in parentheses.
- #f7f7f7 (WHITE)
- #ffe6e9 (TERRACOTTA_1)
- #efa49f (TERRACOTTA_2)
- #f07166 (TERRACOTTA_3)
- #e45a4e (TERRACOTTA_4)
- #fbd9b6 (ORANGE_1)
- #f7be6e (ORANGE_2)
- #f98c1f (ORANGE_3)
- #e56f1a (ORANGE_4)
- #fbf5b6 (YELLOW_1)
- #fed850 (YELLOW_2)
- #e9b10c (YELLOW_3)
- #c78605 (YELLOW_4)
- #e8f7d4 (GRASS_1)
- #afe26c (GRASS_2)
- #71b314 (GRASS_3)
- #32a206 (GRASS_4)
- #e3f0fb (SKY_1)
- #9fc5f0 (SKY_2)
- #77a5e4 (SKY_3)
- #558edd (SKY_4)
- #f1e3fd (LAVENDER_1)
- #dab2f7 (LAVENDER_2)
- #b26ee2 (LAVENDER_3)
- #a270db (LAVENDER_4)
- #d0d0d0 (GRAY_1)
- #c3c3c3 (GRAY_2)
- #b1b1b1 (GRAY_3)
- #989898 (GRAY_4)
|
| posName | string (PosName) The button label name that appears for this menu entity in the Toast POS app. posName contains an empty string if a posName has not been defined for the menu entity and the name value is used for the button label instead.
|