ProductVariation

Extends Object

Properties
description

Type String

The description of the specification.

id

Type Number

The System ID for the variation.

identifier

Type String

A string identifier applied to the specification.

isBoolean

Type Boolean

Set to true if the type is 'boolean'.

isNumeric

Type Boolean

Set to true if the type is 'numeric'.

isRange

Type Boolean

Set to true if the type is 'range'.

isString

Type Boolean

Set to true if the type is 'string' (default).

isSwatch

Type Boolean

Set to true if the type is 'swatch'.

options

Type Array

The list of variation options. Each element of the Array contains a ProductVariationOption object.

title

Type String

The title of the variation.

type

Type String

The type of specification/variation, which may be used to determine how to render the specification title and value. Currently the supported specification types are:

  • boolean
  • numeric
  • range
  • string (default)
  • swatch
url

Type Url | null

Contains a URL to a help document if set, otherwise is set to null.