SquareConnect::CatalogItemOption

July 24, 2019 ยท View on GitHub

Description

A group of variations for a CatalogItem's.

Properties

NameTypeDescriptionNotes
nameStringThe item option's display name for the seller. Must be unique across all item options. Searchable.[optional]
display_nameStringThe item option's display name for the customer. Searchable.[optional]
descriptionStringThe item option's human-readable description. Displays for in the Square Point of Sale app for the seller and in the Online Store or on receipts for the buyer.[optional]
show_colorsBOOLEANIf true, display colors for entries in `values` when present.[optional]
valuesArray<CatalogObject>A list of CatalogObjects containing the CatalogItemOptionValues for this item.[optional]
item_countIntegerThe 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`.[optional]