Class AssetsResource

Index

Constructors

Methods

Constructors

constructor

new AssetsResource(http: HttpClient): AssetsResource
Parameters
- http: HttpClient
Returns AssetsResource
- Defined in services/api/packages/storefront-sdk/src/resources/assets.ts:5

Methods

list

list(params: AssetListParams): Promise<AssetListResponse>
Images with the products shown in them (hotspots).

Pass productIds for every image tagged with any of those products, and/or ids for specific images such as the product's own gallery. Hotspots carry the product's id and SKU only: fetch name, price and stock with products.getBatchByIds (or getBatch by SKU), and drop hotspots whose product does not come back (not sold in this market or not in the customer's catalog).
Parameters
- params: AssetListParams
Returns Promise<AssetListResponse>
Example
```
const { data } = await client.assets.list({ productIds: variantIds, limit: 12 })
const ids = [...new Set(data.flatMap((img) => img.hotspots.map((h) => h.productId)))]
const products = await client.products.getBatchByIds(ids)
```
- Defined in services/api/packages/storefront-sdk/src/resources/assets.ts:23