Object Index / Definition

You are viewing an old version of the API
Catalog​Item​Option​Value

Beta

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

Properties

Name Description
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.

description
string

A human-readable description for the option value.

item_option_id
string

Unique ID of the associated item option.

item_variation_count
integer

The number of CatalogItemVariations 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.

name
string

Name of this item option value. Searchable.

ordinal
integer

Determines where this option value appears in a list of option values.

Share Feedback

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