Class: CollectionsResource

Hierarchy

• default

  ↳ CollectionsResource

Methods

list

▸ list(query?, customHeaders?): ResponsePromise<StoreCollectionsListRes>

Description

Retrieves a list of collections

Parameters

Name	Type	Description
query?	StoreGetCollectionsParams	is optional. Can contain a limit and offset for the returned list
customHeaders	Record<string, any>

Returns

ResponsePromise<StoreCollectionsListRes>

Defined in

medusa-js/src/resources/collections.ts:28

---

retrieve

▸ retrieve(id, customHeaders?): ResponsePromise<StoreCollectionsRes>

Description

Retrieves a single collection

Parameters

Name	Type	Description
id	string	id of the collection
customHeaders	Record<string, any>

Returns

ResponsePromise<StoreCollectionsRes>

Defined in

medusa-js/src/resources/collections.ts:17