Skip to content
This repository was archived by the owner on Apr 23, 2021. It is now read-only.

Latest commit

 

History

History
16 lines (9 loc) · 1.49 KB

CatalogModifierList.md

File metadata and controls

16 lines (9 loc) · 1.49 KB

CatalogModifierList

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

Name Type Description Notes
name String The CatalogModifierList's name. Searchable. This field has max length of 255 Unicode code points. [optional]
selectionType String Indicates whether multiple options from the CatalogModifierList can be applied to a single CatalogItem. See CatalogModifierListSelectionType for possible values [optional]
modifiers List<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]