SquareConnect::CatalogModifierList

March 27, 2019 ยท View on GitHub

Description

A modifier list in the Catalog object model. A CatalogModifierList contains Modifiers that can be applied to a CatalogItem at the time of sale. For example, a modifier list "Condiments" that would apply to a "Hot Dog" CatalogItem might contain CatalogModifiers "Ketchup", "Mustard", and "Relish". The selection_type field specifies whether or not multiple selections from the modifier list are allowed.

Properties

NameTypeDescriptionNotes
nameStringThe CatalogModifierList's name. Searchable. This field has max length of 255 Unicode code points.[optional]
selection_typeStringIndicates whether multiple options from the CatalogModifierList can be applied to a single CatalogItem. See CatalogModifierListSelectionType for possible values[optional]
modifiersArray<CatalogObject>The options included in the CatalogModifierList. You must include at least one CatalogModifier. Each CatalogObject must have type `MODIFIER` and contain CatalogModifier data.[optional]