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.

Modifier Group Mappings

This section provides a mapping that shows the configuration options for modifier groups in the Toast administration back-end and the JSON values that represent those configuration options in the menu data export, the menus API, and the configuration API. If a configuration option is not represented in the data returned by an API or in the data export, it is marked with a dash (-).

Toast Administration Back-end Menus API Menu Data Export Configuration API

-

-

entityType

-

Name

name

name

name

GUID

guid

guid

-

Number

multilocationId

-

-

Required

requiredMode

-

-

Multi-select

isMultiSelect

-

-

Min # selections

minSelections

minSelections

minSelections

Max # selections

maxSelections

maxSelections

maxSelections

Pre-Modifier Group

premodifierGroupReferences

-

-

Select where pricing is set

pricingStrategy

pricingRules

pricingMode

-

Allow default modifiers to charge their configured price

defaultOptionsChargePrice

defaultOptionsChargePrice

-

Enable Substitution Pricing

defaultOptionsSubstitutionPricing

defaultOptionsSubstitutionPricing

-

Select pricing for all modifiers

pricingStrategy

pricingRules

-

-

Fixed Modifier Price

pricingStrategy

pricingRules

-

-

Sequence Price

pricingStrategy

pricingRules

pricingStrategy

pricingStrategyRules

-

Size Price

pricingStrategy

pricingRules

pricingStrategy

pricingStrategyRules

-

Size/Sequence Price

pricingStrategy

pricingRules

pricingStrategy

pricingStrategyRules

-

Modifiers

modifierOptionReferences

items

options

Visibility

visibility

visibility

-

Grubhub

visibility

-

-

ID string

-

idString

-

Note

While the menu data export contains JSON data for the premodifiers themselves, it does not contain data that defines the modifier groups that a premodifier applies to. The menus API has resolved this issue by including a premodifierGroupReferences value on each ModifierGroup object that defines which premodifiers apply to each modifier group.