A modifier list in the Catalog object model. A CatalogModifierList
contains CatalogModifier
objects 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 CatalogModifier
s "Ketchup", "Mustard", and "Relish". The selection_type
field specifies whether or not multiple selections from the modifier list are allowed.
Name | Type | Description | Notes |
---|---|---|---|
name | String | A searchable name for the `CatalogModifierList`. This field has max length of 255 Unicode code points. | [optional] |
ordinal | Number | Determines where this `CatalogModifierList` appears in a list of `CatalogModifierList` values. | [optional] |
selection_type | String | Indicates whether multiple options from the `CatalogModifierList` can be applied to a single `CatalogItem`. See CatalogModifierListSelectionType for possible values | [optional] |
modifiers | [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] |