SquareConnect::CatalogItemOptionValue

July 24, 2019 ยท View on GitHub

Description

An enumerated value that can link a [CatalogItemVariation(#type-catalogitemvariation) to an item option as one of its item option values.

Properties

NameTypeDescriptionNotes
item_option_idStringUnique ID of the associated item option.[optional]
nameStringName of this item option value. Searchable.[optional]
descriptionStringThe option value's human-readable description.[optional]
colorStringThe HTML color for this value in the format #FFRRGGBB or #RRGGBB (e.g., "#ff8d4e85"). Only displayed if parent Item Option's `show_colors` flag is enabled. value.[optional]
ordinalIntegerDetermines where this option value appears in a list of option values.[optional]
item_variation_countIntegerThe number of [CatalogItemVariation(#type-catalogitemvariation)s that currently make use of this Item Option value. Present only if `retrieve_counts` was specified on the request used to retrieve the parent Item Option of this value. Maximum: 100 counts.[optional]