Skip to main content

Class: CollectionsResource

Hierarchy

  • default

    CollectionsResource

Methods

list

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

Description

Retrieves a list of collections

Parameters

NameTypeDescription
query?StoreGetCollectionsParamsis optional. Can contain a limit and offset for the returned list
customHeadersRecord<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

NameTypeDescription
idstringid of the collection
customHeadersRecord<string, any>

Returns

ResponsePromise<StoreCollectionsRes>

Defined in

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