Skip to content

Latest commit

 

History

History
18 lines (13 loc) · 1.33 KB

CatalogItemOptionValue.md

File metadata and controls

18 lines (13 loc) · 1.33 KB

SquareConnect.CatalogItemOptionValue

Description

Note: This model is in beta.

An enumerated value that can link a CatalogItemVariation to an item option as one of its item option values.

Properties

Name Type Description Notes
item_option_id String Unique ID of the associated item option. [optional]
name String Name of this item option value. Searchable. [optional]
description String A human-readable description for the option value. [optional]
color String The HTML-supported hex color for the item option (e.g., "#ff8d4e85"). Only displayed if `show_colors` is enabled on the parent `ItemOption`. When left unset, `color` defaults to white ("#ffffff") when `show_colors` is enabled on the parent `ItemOption`. [optional]
ordinal Number Determines where this option value appears in a list of option values. [optional]
item_variation_count Number The number of `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]