ProductCollection

Interface

A product collection on the storefront. Mirrors the API's public whitelist.

Property

Type

Optional

Description

description

string | null

No

Editorial description, or null when the merchant left it empty.

id

string

No

Prefixed wire id (e.g. 'col_...'). Stable; safe to store and link.

image

string | null

No

Public image URL, or null when no image is set.

seoDescription

string | null

No

SEO meta description, or null when unset.

seoTitle

string | null

No

SEO title override, or null when unset (fall back to title).

slug

string

No

URL-friendly unique slug. Usable as the collection filter on products.list().

title

string

No

Collection title in the requested locale. Always non-empty.


ProductCollectionsFilters

Interface

Filters for a storefront collections listing. All optional.

Property

Type

Optional

Description

limit

number

Yes

Items per page. Defaults to 20, max 100.

page

number

Yes

Page number (1-based). Defaults to 1.


ProductCollectionsListResponse

Interface

Paginated collections list response: the collections on the page plus pagination metadata.

Property

Type

Optional

Description

data

ProductCollection[]

No

The product collections on this page.

meta

PaginationMeta

No

Pagination info (total, currentPage, lastPage, perPage, hasMorePages).