3b28f46705
* added reference for JS Client * added reference for JS Client * added reference for JS Client
1.7 KiB
1.7 KiB
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
packages/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>