Modifier

Order-Level Content → Menu → Modifier

Overview

What is a Modifier?

Modifiers are ingredients that the brand allows to get modfied in each item. They have no PLU related to them in a lot of cases but there might be POS exceptions.

These are what you might know as ingredients that are modifiable in each of our items like Tomato (Sandwich), Lettuce (Sandwich) , Sugar (Coffee), Milk (Coffee).

Special Note for Modifiers

In the US and Canada, Modifiers will come from an automated sync from MDS. The team will have to create them in MDS before.

In international markets, they will be created with the set up process provided below.

If you are not in the USA or Canada, this guide is for you!

Editing Modifiers

Name

This is the name of the item that will show in the platform, so must be edited according to your marketing guidelines. In the above examples: Choose a Size and Select Your Size.

Region

This field is only applicable for USA and Canada, where Modifiers are synchronized from MDS

Image

This is the image that is shown for the modifier.

Best Practices Tip

Remember choosing a picture without a background will look better, remove noise, and turn the guest’s focus to the actual purchase 🍔 🍟

Take into account that this picture will be shown in a small size to the guests, so avoid complex images

Image Description

This will be the text for the alt attribute on the image.

What is the alt attribute?

The alt attribute is the HTML attribute used in HTML and XHTML documents to specify alternative text (alt text) that is to be rendered when the element to which it is applied cannot be rendered.

It is also important for SEO purposes, as this description is what allows search engines (like Google) to connect this image to a search. By adding the Plant-based Whopper description, there is a chance users will find this image in Google Images, which can lead to traffic in the platform

Vendor Configs

If your POS uses PLU for modifiers

You will need to configure each modifier here.

In your brand and country Sanity environment, you will see the Service Mode Groups (Pickup and Delivery) and POS used, as well as the Tablet system in place, in case some restaurants use a POS without order injection integration.

In the example above, please note that rPOS will include the PLU of items for all Pickup service modes (Takeaway, Dine-in, Drive-thru, Curbside), whereas rPOS Delivery refers to the PLU of items for delivery only.

For each Service Mode Group (Pickup and Delivery), you will need to configure the correct PLU.

If your POS does not use a PLU for modifiers

You will still need to make some simple configurations.

Please expand the designated Vendor Config and select PLU Type = Ignore.

With this, we are telling the system, which is configured to check the PLU of the modifier, to skip that step and keep injecting the guest’s order.

NCR and Sicom are two famous POS examples that do not include PLUs for modifiers.

Don’t know if your POS has PLUs for Modifiers? Try having a look at our Vendor Configs POS collection in Vendor Config PLU Types.

Specification Number

This field is only applicable for USA and Canada, where Modifiers are synchronized from MDS

Specification Name

This field is only applicable for USA and Canada, where Modifiers are synchronized from MDS

Modifier Controls

You arrive here by clicking on the Options in the Item document, as seen below.

We found that it was easier and effortless for our teams to maintain the options of each items in this section, rather than in the Modifiers document.

There are five modifier control scenarios that we have identified:

Boolean: The individual modifier can either be on or off, not available in a range
1. Ex: Add bacon to a burger
2. UI: Checkbox
Non-numeric range: The individual modifier is available in a range of quantities that the brand wants to display as a non-numeric value
1. Ex: None, light, regular, extra ketchup
2. UI: Edit pencil icon with slide-up drawer
Numeric range: The individual modifier is available in a range of quantities that the brand wants to display as a numeric value
1. Ex: 0, 1, 2, 3 creams in your coffee
2. UI: + - buttons
Select one from options: The modifier has multiple options from which the guest can select one
1. Ex: Salad dressing
2. UI: Radio button
Select multiple from options: The modifier has multiple options from which the guest can select more than one
1. Ex: Sauces for chicken nuggets
2. UI: + - buttons, description that displays amount guest must select

Existing fields:

itemOption name
Display Group - find more about this field in the Display Groups document
Component Style
displayModifierMultiplierName
allowMultipleSelections
injectDefaultSelection
min
max
Options

For this, we won’t be using the following fields:

allowMultipleSelections
injectDefaultSelection
min
Component Style

We will be using:

displayModifierMultiplierName
max: the maximum number of modifier selections available to the user for the given modifier, used only for dipping sauce-type modifiers (singleChoiceOnly)
singleChoiceOnly: will be a Read Only field that comes through from MDM, determines if the modifier is one that must be chosen from the group of its options

Find below the configuration options for each of the use cases identified:

Modifier Type	Rules / Acceptance Criteria
Boolean/checkbox	itemOption has two options with modifierMultipliers 0 and 1 `singleChoiceOnly` = false Grouped by display group, use as headers in Customize section Ignore: `displayModifierMultiplierName` itemOption `min` and `max`- always 0 and 1
Non-numeric range	`singleChoiceOnly` = false `displayModifierMultiplierName` = true Use modifier multiplier prefix to display quantity Grouped by display group, use as headers in Customize section If no prefixes (for all or only some of the quantity options), default to using modifier multiplier numbers for all values. There shouldn’t be a mix of prefixes and numbers. Ignore: itemOption `min` and `max`- always 0 and 1
Numeric range	`singleChoiceOnly` = false `displayModifierMultiplierName` = false Use modifier multiplier number to display quantity Grouped by display group, use as headers in Customize section Ignore: itemOption `min` and `max`- always 0 and 1
Select one from options	itemOption `max` = 1 `singleChoiceOnly` = true No display group, use modifier group name from MDM as header Ignore: `displayModifierMultiplierName`
Select multiple from options	itemOption `max` > 1 `singleChoiceOnly` = true No display group, use modifier group name from MDM as header Sub-header to indicate max number of selections: “Choose x {modifierGroup}” Use same wording/Lokalise key as cart add-ons max Since we will default users to x number of selections, all + should be disabled and they should have to decrement the selection they don’t want in order to enable the + on other selections Ignore: `displayModifierMultiplierName`

Unused Information

You might see additional fields in this document that are not part of this guide. Please disregard them as they are not needed for your Menu setup.