Skip to navigation

SwatchOptionValue

OBJECT

A swatch option value - swatch values can be associated with a list of hexidecimal colors or an image.

Fields

hexColorslist of StringsRequired
List of up to 3 hex encoded colors to associate with a swatch value.
entityIdIntegerRequired
Unique ID for the option value.
labelStringRequired
Label for the option value.
isDefaultBooleanRequired
Indicates whether this value is the chosen default selected value.
imageUrlStringOptional
Absolute path of a swatch texture image.
isSelectedBooleanOptional

Indicates whether this value is selected based on sku/variantEntityId/optionValueIds overlay requested on the product node level.