CatalogModifierList

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

The position of this CatalogModifierList within a list of CatalogModifierList instances.

Deprecated: Indicates whether a single (SINGLE) modifier or multiple (MULTIPLE) modifiers can be selected. Use min_selected_modifiers and max_selected_modifiers instead.

A non-empty list of CatalogModifier objects to be included in the CatalogModifierList, for non text-based modifiers when the modifier_type attribute is LIST. Each element of this list is a CatalogObject instance of the MODIFIER type, containing the following attributes:

{
"id": "{{catalog_modifier_id}}",
"type": "MODIFIER", 
"modifier_data": {{a CatalogModifier instance>}} 
}

The IDs of images associated with this CatalogModifierList instance. Currently these images are not displayed on Square products, but may be displayed in 3rd-party applications.

When true, allows multiple quantities of the same modifier to be selected.

True if modifiers belonging to this list can be used conversationally.

The type of the modifier.

When this modifier_type value is TEXT, the CatalogModifierList represents a text-based modifier. When this modifier_type value is LIST, the CatalogModifierList contains a list of CatalogModifier objects.

The maximum length, in Unicode points, of the text string of the text-based modifier as represented by this CatalogModifierList object with the modifier_type set to TEXT.

Whether the text string must be a non-empty string (true) or not (false) for a text-based modifier as represented by this CatalogModifierList object with the modifier_type set to TEXT.

A note for internal use by the business.

For example, for a text-based modifier applied to a T-shirt item, if the buyer-supplied text of "Hello, Kitty!"
is to be printed on the T-shirt, this internal_name attribute can be "Use italic face" as an instruction for the business to follow.

For non text-based modifiers, this internal_name attribute can be used to include SKUs, internal codes, or supplemental descriptions for internal use.

The minimum number of modifiers that must be selected from this list. The value can be overridden with CatalogItemModifierListInfo.

Values:

• 0: No selection is required.
• -1: Default value, the attribute was not set by the client. Treated as no selection required.
• >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.

The maximum number of modifiers that must be selected from this list. The value can be overridden with CatalogItemModifierListInfo.

Values:

• 0: No maximum limit.
• -1: Default value, the attribute was not set by the client. Treated as no maximum limit.
• >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.