Class: CollectionsResource
Hierarchy
defaultCopy to Clipboard↳
CollectionsResourceCopy to Clipboard
Methods
list
▸ list(query?Copy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<StoreCollectionsListResCopy to Clipboard>
DescriptionCopy to Clipboard
Retrieves a list of collections
Parameters
| Name | Type | Description |
|---|---|---|
query?Copy to Clipboard | StoreGetCollectionsParamsCopy to Clipboard | is optional. Can contain a limit and offset for the returned list |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<StoreCollectionsListResCopy to Clipboard>
Defined in
medusa-js/src/resources/collections.ts:28
retrieve
▸ retrieve(idCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<StoreCollectionsResCopy to Clipboard>
DescriptionCopy to Clipboard
Retrieves a single collection
Parameters
| Name | Type | Description |
|---|---|---|
idCopy to Clipboard | stringCopy to Clipboard | id of the collection |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<StoreCollectionsResCopy to Clipboard>