daea35fe73
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
1.8 KiB
1.8 KiB
displayed_sidebar
| displayed_sidebar |
|---|
| jsClientSidebar |
Class: CollectionsResource
Hierarchy
-
default↳
CollectionsResource
Methods
list
▸ list(query?, customHeaders?): ResponsePromise<StoreCollectionsListRes>
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>
Description
Retrieves a list of collections
Defined in
packages/medusa-js/src/resources/collections.ts:28
retrieve
▸ retrieve(id, customHeaders?): ResponsePromise<StoreCollectionsRes>
Parameters
| Name | Type | Description |
|---|---|---|
id |
string |
id of the collection |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<StoreCollectionsRes>
Description
Retrieves a single collection