Class: AdminCollectionsResource
Hierarchy
defaultCopy to Clipboard↳
AdminCollectionsResourceCopy to Clipboard
Methods
addProducts
▸ addProducts(idCopy to Clipboard, payloadCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminCollectionsResCopy to Clipboard>
DescriptionCopy to Clipboard
Updates products associated with a Product Collection
Parameters
| Name | Type | Description |
|---|---|---|
idCopy to Clipboard | stringCopy to Clipboard | the id of the Collection |
payloadCopy to Clipboard | AdminPostProductsToCollectionReqCopy to Clipboard | an object which contains an array of Product IDs to add to the Product Collection |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminCollectionsResCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/collections.ts:100
create
▸ create(payloadCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminCollectionsResCopy to Clipboard>
DescriptionCopy to Clipboard
Creates a collection.
Parameters
| Name | Type |
|---|---|
payloadCopy to Clipboard | AdminPostCollectionsReqCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminCollectionsResCopy to Clipboard>
Created collection.
Defined in
medusa-js/src/resources/admin/collections.ts:22
delete
▸ delete(idCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<DeleteResponseCopy to Clipboard>
DescriptionCopy to Clipboard
deletes a collection
Parameters
| Name | Type | Description |
|---|---|---|
idCopy to Clipboard | stringCopy to Clipboard | id of collection to delete. |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<DeleteResponseCopy to Clipboard>
Deleted response
Defined in
medusa-js/src/resources/admin/collections.ts:52
list
▸ list(query?Copy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminCollectionsListResCopy to Clipboard>
DescriptionCopy to Clipboard
Lists collections matching a query
Parameters
| Name | Type | Description |
|---|---|---|
query?Copy to Clipboard | AdminGetCollectionsParamsCopy to Clipboard | Query for searching collections |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminCollectionsListResCopy to Clipboard>
a list of collections matching the query.
Defined in
medusa-js/src/resources/admin/collections.ts:80
removeProducts
▸ removeProducts(idCopy to Clipboard, payloadCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<DeleteResponseCopy to Clipboard>
DescriptionCopy to Clipboard
Removes products associated with a Product Collection
Parameters
| Name | Type | Description |
|---|---|---|
idCopy to Clipboard | stringCopy to Clipboard | the id of the Collection |
payloadCopy to Clipboard | AdminDeleteProductsFromCollectionReqCopy to Clipboard | an object which contains an array of Product IDs to add to the Product Collection |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<DeleteResponseCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/collections.ts:115
retrieve
▸ retrieve(idCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminCollectionsResCopy to Clipboard>
DescriptionCopy to Clipboard
get a collection
Parameters
| Name | Type | Description |
|---|---|---|
idCopy to Clipboard | stringCopy to Clipboard | id of the collection to retrieve. |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminCollectionsResCopy to Clipboard>
the collection with the given id
Defined in
medusa-js/src/resources/admin/collections.ts:66
update
▸ update(idCopy to Clipboard, payloadCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminCollectionsResCopy to Clipboard>
DescriptionCopy to Clipboard
Updates a collection
Parameters
| Name | Type | Description |
|---|---|---|
idCopy to Clipboard | stringCopy to Clipboard | id of the collection to update. |
payloadCopy to Clipboard | AdminPostCollectionsCollectionReqCopy to Clipboard | update to apply to collection. |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminCollectionsResCopy to Clipboard>
the updated collection.