CatalogItemOption

November 20, 2019 ยท View on GitHub

Description

A group of variations for a CatalogItem.

Properties

NameGetterSetterTypeDescriptionNotes
namegetName()setName($value)stringThe item option's display name for the seller. Must be unique across all item options. Searchable.[optional]
display_namegetDisplayName()setDisplayName($value)stringThe item option's display name for the customer. Searchable.[optional]
descriptiongetDescription()setDescription($value)stringThe 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.[optional]
show_colorsgetShowColors()setShowColors($value)boolIf true, display colors for entries in `values` when present.[optional]
valuesgetValues()setValues($value)\SquareConnect\Model\CatalogObject[]A list of CatalogObjects containing the `CatalogItemOptionValue`s for this item.[optional]
item_countgetItemCount()setItemCount($value)intThe number of `CatalogItem`s 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]

Note: All properties are protected and only accessed via getters and setters.

[Back to Model list] [Back to API list] [Back to README]