Skip to content

Latest commit

 

History

History
43 lines (34 loc) · 2.88 KB

catalog-item-modifier-list-info.md

File metadata and controls

43 lines (34 loc) · 2.88 KB
Raw

Catalog Item Modifier List Info

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.

Structure

Catalog Item Modifier List Info

Fields

Name Type Tags Description
modifier_list_id str Required The ID of the CatalogModifierList controlled by this CatalogModifierListInfo.
Constraints: Minimum Length: 1
modifier_overrides List Catalog Modifier Override Optional A set of CatalogModifierOverride objects that override whether a given CatalogModifier is enabled by default.
min_selected_modifiers int Optional 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
max_selected_modifiers int Optional 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
enabled bool Optional If true, enable this CatalogModifierList. The default value is true.
ordinal int Optional The position of this CatalogItemModifierListInfo object within the modifier_list_info list applied
to a CatalogItem instance.

Example (as JSON)

{
  "modifier_list_id": "modifier_list_id6",
  "modifier_overrides": [
    {
      "modifier_id": "modifier_id8",
      "on_by_default": false
    },
    {
      "modifier_id": "modifier_id8",
      "on_by_default": false
    }
  ],
  "min_selected_modifiers": 170,
  "max_selected_modifiers": 66,
  "enabled": false,
  "ordinal": 204
}