Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Product

Information about a product

Hierarchy

Index

Properties

Optional basePriceText

basePriceText: undefined | string

The base price to display crossed out and replaced with priceText to indicate a sale.

Optional colors

colors: Color[]

Available colors

Optional description

description: undefined | string

The product description

id

id: string

The ID of the product

media

Product images and videos

Optional name

name: undefined | string

The PDP URL

Optional price

price: undefined | number

The price as a number

Optional priceText

priceText: undefined | string

The text to display for the price

Optional rating

rating: undefined | number

A numeric product rating from 0 to 5 in increments of 0.5

Optional reviewCount

reviewCount: undefined | number

The number of reviews

Optional reviewsKey

reviewsKey: undefined | string

The id used for looking up reviews for the product

Optional sizes

sizes: Size[]

Available sizes

Optional sku

sku: undefined | string

Optional slots

slots: CmsSlots

HTML snippets from the CMS. Keys are slot names, values are HTML strings

Optional specs

specs: undefined | string

The product specs

thumbnail

thumbnail: Media

The product thumbnail

url

url: string

The PDP URL

Generated using TypeDoc