<- Object

Object

All versions ->

CatalogItemOptionValue

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

Link to section

Properties

Link to section

item_option_id

string

Unique ID of the associated item option.

Link to section

name

string

Name of this item option value. This is a searchable attribute for use in applicable query filters.

Link to section

description

string

A human-readable description for the option value. This is a searchable attribute for use in applicable query filters.

Link to section

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.

Link to section

ordinal

integer(32-bit)

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