CatalogItemOptionValue

November 20, 2019 ยท View on GitHub

Description

An enumerated value that can link a CatalogItemVariation to an item option as one of its item option values. Note: This model is in beta.

Properties

NameTypeDescriptionNotes
itemOptionIdStringUnique ID of the associated item option.[optional]
nameStringName of this item option value. Searchable.[optional]
descriptionStringA human-readable description for the option value.[optional]
colorStringThe 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]
ordinalIntegerDetermines where this option value appears in a list of option values.[optional]
itemVariationCountLongThe 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]