ProductSpecification

Extends Object. Represents a specification entry for a product.

Properties
description String

The description for the specification.

id Number

The system ID for the specification.

identifier String

An identifier for the specification.

isBoolean Boolean

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

isNumeric Boolean

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

isRange Boolean

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

isString Boolean

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

isSwatch Boolean

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

isVariable Boolean

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

title String

The title of the specification e.g. Colour.

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 Url | null

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

value ProductSpecificationValue

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

values Array

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