• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

Object Index

You are viewing an old version of the API
CatalogModifierList

A list of modifiers applicable to items at the time of sale.

For example, a "Condiments" modifier list applicable to a "Hot Dog" item may contain "Ketchup", "Mustard", and "Relish" modifiers. Use the selection_type field to specify whether or not multiple selections from the modifier list are allowed.

Properties

Name Description
name
string

The name for 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
ordinal
integer

Determines where this modifier list appears in a list of CatalogModifierList values.

selection_type
string

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

modifiers
CatalogObject [ ]

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

Share Feedback

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