<- Object

Object

All versions ->

CatalogModifierList

A list of modifiers applicable to items at the time of sale.

For example, a "Condiments" modifier list applicable to a "Hot Dog" item may contain "Ketchup", "Mustard", and "Relish" modifiers. Use the selection_type field to specify whether or not multiple selections from the modifier list are allowed.

Link to section

Properties

Link to section

name

string

The name for the CatalogModifierList instance. This is a searchable attribute for use in applicable query filters, and its value length is of Unicode code points.

Max Length
255
Link to section

ordinal

integer(32-bit)

Determines where this modifier list appears in a list of CatalogModifierList values.

Link to section

selection_type

string

Indicates whether multiple options from the modifier list can be applied to a single CatalogItem.

Link to section

modifiers

The options included in the CatalogModifierList. You must include at least one CatalogModifier. Each CatalogObject must have type MODIFIER and contain CatalogModifier data.