<- Object

Object

All versions ->

CatalogItemModifierListInfo

References a text-based modifier or a list of non text-based modifiers applied to a CatalogItem instance and specifies supported behaviors of the application.

Link to section

Properties

Link to section

modifier_list_id

string

Required

The ID of the CatalogModifierList controlled by this CatalogModifierListInfo.

Link to section

modifier_overrides

A set of CatalogModifierOverride objects that override whether a given CatalogModifier is enabled by default.

Link to section

min_selected_modifiers

integer(32-bit)

If 0 or larger, the smallest number of CatalogModifiers that must be selected from this CatalogModifierList. The default value is -1.

When CatalogModifierList.selection_type is MULTIPLE, CatalogModifierListInfo.min_selected_modifiers=-1 and CatalogModifierListInfo.max_selected_modifier=-1 means that from zero to the maximum number of modifiers of the CatalogModifierList can be selected from the CatalogModifierList.

When the CatalogModifierList.selection_type is SINGLE, CatalogModifierListInfo.min_selected_modifiers=-1 and CatalogModifierListInfo.max_selected_modifier=-1 means that exactly one modifier must be present in and can be selected from the CatalogModifierList

Link to section

max_selected_modifiers

integer(32-bit)

If 0 or larger, the largest number of CatalogModifiers that can be selected from this CatalogModifierList. The default value is -1.

When CatalogModifierList.selection_type is MULTIPLE, CatalogModifierListInfo.min_selected_modifiers=-1 and CatalogModifierListInfo.max_selected_modifier=-1 means that from zero to the maximum number of modifiers of the CatalogModifierList can be selected from the CatalogModifierList.

When the CatalogModifierList.selection_type is SINGLE, CatalogModifierListInfo.min_selected_modifiers=-1 and CatalogModifierListInfo.max_selected_modifier=-1 means that exactly one modifier must be present in and can be selected from the CatalogModifierList

Link to section

enabled

boolean

If true, enable this CatalogModifierList. The default value is true.

Link to section

ordinal

integer(32-bit)

Beta

The position of this CatalogItemModifierListInfo object within the modifier_list_info list applied to a CatalogItem instance.