<- Object

Object

CatalogItemOption

A group of variations for a CatalogItem.

Link to section

Properties

Link to section

name

string

The item option's display name for the seller. Must be unique across all item options. This is a searchable attribute for use in applicable query filters.

Link to section

display_name

string

The item option's display name for the customer. This is a searchable attribute for use in applicable query filters.

Link to section

description

string

The item option's human-readable description. Displayed in the Square Point of Sale app for the seller and in the Online Store or on receipts for the buyer. This is a searchable attribute for use in applicable query filters.

Link to section

show_colors

boolean

If true, display colors for entries in values when present.

Link to section

values

A list of CatalogObjects containing the CatalogItemOptionValues for this item.