Skip to main content

Modifier Group

Modifier Groups contain all the Modifiers for a certain modification of the Item Family. I.E Drink Choice

Properties

NameTypeDescription
_idstringUsed for associating entities together, does not map to a specific system
namestringName of the Item to Display
default_modifier_quantitiesobjectKey-value object of modifier._id -> quantity for default selections
min_uniqueintegerMinimum number of selections required across this group.
When selection_type is single: each selection must be a distinct option, so a value of 2 requires 2 different modifiers.
When selection_type is multiple: this only validates total quantity picked — the same modifier may be selected more than once toward this minimum.
max_uniqueintegerMaximum number of selections allowed across this group.
When selection_type is single: each selection must be a distinct option, so a value of 2 requires 2 different modifiers.
When selection_type is multiple: this only validates total quantity picked — the same modifier may be selected more than once toward this maximum.
max_freeintegerMaximum amount of free selections across this group
selection_typestringSpecifies if a quanity can be attributed for a modifier selection.
enum: single, multiple
ex. if multiple, user may select 2 qty of modifier "Side of Ranch"
modifier_idsstring[]Array of Modifier IDs that belong to this Modifier Group

Associations

Modifier Group to Modifiers