Object Index / Definition

You are viewing an old version of the API
Catalog​Modifier​List

A modifier list in the Catalog object model

A CatalogModifierList contains CatalogModifier objects that can be applied to a CatalogItem at the time of sale.

For example, a modifier list "Condiments" that would apply to a "Hot Dog" CatalogItem might contain CatalogModifiers "Ketchup", "Mustard", and "Relish". The selection_type field specifies whether or not multiple selections from the modifier list are allowed.

Properties

Name Description
modifiers
Catalog​Object [ ]

The options included in the CatalogModifierList. You must include at least one CatalogModifier. Each CatalogObject must have type MODIFIER and contain CatalogModifier data.

name
string

A searchable name for the CatalogModifierList. This field has max length of 255 Unicode code points.

selection_type
string

Indicates whether multiple options from the CatalogModifierList can be applied to a single CatalogItem.

Share Feedback

Thanks for visiting the Square API documentation. What's on your mind?