<- Object

Object

All versions ->

CatalogModifierList

A container for a list of modifiers, or a text-based modifier.

For text-based modifiers, this represents text configuration for an item. (For example, custom text to print on a t-shirt). For non text-based modifiers, this represents a list of modifiers that can be applied to items at the time of sale. (For example, a list of condiments for a hot dog, or a list of ice cream flavors). Each element of the modifier list is a CatalogObject instance of the MODIFIER type.

Link to section

Properties

Link to section

name

string

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.

Max Length
255
Link to section

ordinal

integer(32-bit)

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

Link to section

selection_type

string

Deprecated

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

Link to section

modifiers

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>}} 
}
Link to section

image_ids

string [ ]

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.

Link to section

allow_quantities

boolean

Beta

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

Link to section

is_conversational

boolean

Beta

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

Link to section

modifier_type

string

Beta

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.

Link to section

max_length

integer(32-bit)

Beta

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.

Link to section

text_required

boolean

Beta

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.

Link to section

internal_name

string

Beta

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.

Max Length
512
Link to section

min_selected_modifiers

integer(64-bit)

Beta

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.
Link to section

max_selected_modifiers

integer(64-bit)

Beta

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.
Link to section

hidden_from_customer

boolean

Beta

If true, modifiers from this list are hidden from customer receipts. The default value is false. This setting can be overridden with CatalogItemModifierListInfo.hidden_from_customer_override.