Service for reading a site's storefront product collections.
Accessible via lynkow.productCollections. Returns only collections the
merchant made visible. Requires a publishable key: pass publishableKey to
createClient(...) so every request carries it (commerce routes reject calls
without a valid key). Responses are cached in-memory for 5 minutes (SHORT TTL)
when a cache adapter is configured on the client.
Access via: lynkow.productCollections
Methods
1 method
list
list(filters?: ProductCollectionsFilters, options?: BaseRequestOptions): Promise<ProductCollectionsListResponse>Retrieves a paginated list of merchant-visible product collections. Cached for 5 minutes per unique filter combination.
Parameter | Type | Description |
|---|---|---|
|
| Optional ProductCollectionsFilters: |
|
| Base request options (locale override, custom fetch options). |
Returns: Promise<ProductCollectionsListResponse>
const { data, meta } = await lynkow.productCollections.list({ page: 1, limit: 20 })