Object Index / Definition

You are viewing an old version of the API
CatalogItemOption

Beta

A group of variations for a CatalogItem.

Properties

Name Description
name
string

The item option's display name for the seller. Must be unique across all item options. Searchable.

display_name
string

The item option's display name for the customer. Searchable.

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.

show_colors
boolean

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

values
CatalogObject [ ]

A list of CatalogObjects containing the CatalogItemOptionValues for this item.

item_count
integer

The number of CatalogItems currently associated with this item option. Present only if the include_counts was specified in the request. Any count over 100 will be returned as 100.

Share Feedback

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