Skip to content

Latest commit

 

History

History
36 lines (27 loc) · 1.34 KB

catalog-item-modifier-list-info.md

File metadata and controls

36 lines (27 loc) · 1.34 KB

Catalog Item Modifier List Info

Options to control the properties of a CatalogModifierList applied to a CatalogItem instance.

Structure

Catalog Item Modifier List Info

Fields

Name Type Tags Description
modifier_list_id string Required The ID of the CatalogModifierList controlled by this CatalogModifierListInfo.
Constraints: Minimum Length: 1
modifier_overrides List of 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.
max_selected_modifiers int Optional If 0 or larger, the largest number of CatalogModifiers that can be selected from this CatalogModifierList.
enabled bool Optional If true, enable this CatalogModifierList. The default value is true.

Example (as JSON)

{
  "modifier_list_id": "modifier_list_id6",
  "modifier_overrides": [
    {
      "modifier_id": "modifier_id1",
      "on_by_default": true
    }
  ],
  "min_selected_modifiers": 38,
  "max_selected_modifiers": 198,
  "enabled": false
}