<- Object

Object

All versions ->

CatalogModifier

A modifier that can be applied to items at the time of sale.

For example, a cheese modifier for a burger, or a flavor modifier for a serving of ice cream.

Link to section

Properties

Link to section

name

string

The modifier name. 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

price_money

The modifier price.

Link to section

on_by_default

boolean

Beta

When true, this modifier is selected by default when displaying the modifier list. This setting can be overridden at the item level using CatalogModifierListInfo.modifier_overrides.

Link to section

ordinal

integer(32-bit)

Determines where this CatalogModifier appears in the CatalogModifierList.

Link to section

modifier_list_id

string

The ID of the CatalogModifierList associated with this modifier.

Link to section

location_overrides

Location-specific price overrides.

Link to section

image_id

string

Beta

The ID of the image associated with this CatalogModifier instance. Currently this image is not displayed by Square, but is free to be displayed in 3rd party applications.

Link to section

hidden_online

boolean

Beta

When true, this modifier is hidden from online ordering channels. This setting can be overridden at the item level using CatalogModifierListInfo.modifier_overrides.