ProductSpecification

Extends Object. Represents a specification entry for a product.

Properties
description

Type String

The description for the specification.

id

Type Number

The system ID for the specification.

identifier

Type String

An identifier for the specification.

isBoolean

Type Boolean

True if the product specification is of type boolean, else false.

isNumeric

Type Boolean

True if the product specification is of type numeric, else false.

isRange

Type Boolean

True if the product specification is of type range, else false.

isString

Type Boolean

True if the product specification is of type string, else false.

isSwatch

Type Boolean

True if the product specification is of type swatch, else false.

isVariable

Type Boolean

True if the specification is used for product.variations and has more than one value in values.

title

Type String

The title of the specification e.g. Colour.

type

Type String

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

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

Type Url | null

A URL to a help document for the specification if set, or null if not.

value

Type ProductSpecificationValue

The value of the specification for the current Product e.g. Red

values

Type Array

The values list as an Array, which includes all values across variations.