<- Object

Object

All versions ->

CatalogItemModifierListInfo

Controls how a modifier list is applied to a specific item.

This object allows for item-specific customization of modifier list behavior and provides the ability to override global modifier list settings.

Link to section

Properties

Link to section

modifier_list_id

string

Required

The ID of the CatalogModifierList controlled by this CatalogModifierListInfo.

Min Length
1
Link to section

modifier_overrides

A set of CatalogModifierOverride objects that override default modifier settings for this item.

Link to section

min_selected_modifiers

integer(32-bit)

The minimum number of modifiers that must be selected from this modifier list. Values:

  • 0: No selection is required.
  • -1: Default value, the attribute was not set by the client. When max_selected_modifiers is also -1, use the minimum and maximum selection values set on the CatalogItemModifierList.
  • >0: The required minimum modifier selections. This can be larger than the total CatalogModifiers when allow_quantities is enabled.
  • < -1: Invalid. Treated as no selection required.
Link to section

max_selected_modifiers

integer(32-bit)

The maximum number of modifiers that can be selected. Values:

  • 0: No maximum limit.
  • -1: Default value, the attribute was not set by the client. When min_selected_modifiers is also -1, use the minimum and maximum selection values set on the CatalogItemModifierList.
  • >0: The maximum total modifier selections. This can be larger than the total CatalogModifiers when allow_quantities is enabled.
  • < -1: Invalid. Treated as no maximum limit.
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.

Link to section

allow_quantities

Beta

Controls whether multiple quantities of the same modifier can be selected for this item.

  • YES means that every modifier in the CatalogModifierList can have multiple quantities selected for this item.
  • NO means that each modifier in the CatalogModifierList can be selected only once for this item.
  • NOT_SET means that the allow_quantities setting on the CatalogModifierList is obeyed.
Link to section

is_conversational

Beta

Controls whether conversational mode is enabled for modifiers on this item.

  • YES means conversational mode is enabled for every modifier in the CatalogModifierList.
  • NO means that conversational mode is not enabled for any modifier in the CatalogModifierList.
  • NOT_SET means that conversational mode is not enabled for any modifier in the CatalogModifierList.
Link to section

hidden_from_customer_override

Beta

Controls whether all modifiers for this item are hidden from customer receipts.

  • YES means that all modifiers in the CatalogModifierList are hidden from customer receipts for this item.
  • NO means that all modifiers in the CatalogModifierList are visible on customer receipts for this item.
  • NOT_SET means that the hidden_from_customer setting on the CatalogModifierList is obeyed.