Copy page

@wocart/storefront v3.1.0

---

@wocart/storefront / index / ProductPage

Interface: ProductPage

One page of products from products.page() or products.search().

Properties

hasNext

hasNext: boolean

True when another page follows this one.

---

items

items: object[]

categoryId?

optional categoryId?: string

compareAtPrice?

optional compareAtPrice?: number

coverImage?

optional coverImage?: object

coverImage.altText?

optional altText?: string

coverImage.height?

optional height?: number

coverImage.id

id: string

coverImage.key

key: string

coverImage.position

position: number

coverImage.url

url: string

coverImage.width?

optional width?: number

currency

currency: string

description?

optional description?: string

descriptionFormat

descriptionFormat: "html" | "text"

descriptionPlain?

optional descriptionPlain?: string

handle

handle: string

hasVariants

hasVariants: boolean

id

id: string

inventory

inventory: number

lowStockThreshold

lowStockThreshold: number

metaDescription?

optional metaDescription?: string

metaTitle?

optional metaTitle?: string

name

name: string

price

price: number

reviewStats?

optional reviewStats?: object

reviewStats.avgRating

avgRating: number

reviewStats.reviewCount

reviewCount: number

sku?

optional sku?: string

tags

tags: string[]

trackInventory

trackInventory: boolean

type

type: "DIGITAL" | "PHYSICAL"

variantOptions?

optional variantOptions?: object[]

---

total

total: number

How many products the whole listing holds, across its pages.