6.0 KiB
Class: AdminCollectionsResource
Hierarchy
-
default↳
AdminCollectionsResource
Methods
addProducts
▸ addProducts(id, payload, customHeaders?): ResponsePromise<AdminCollectionsRes>
Description
Updates products associated with a Product Collection
Parameters
| Name | Type | Description |
|---|---|---|
id |
string |
the id of the Collection |
payload |
AdminPostProductsToCollectionReq |
an object which contains an array of Product IDs to add to the Product Collection |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<AdminCollectionsRes>
Defined in
medusa-js/src/resources/admin/collections.ts:100
create
▸ create(payload, customHeaders?): ResponsePromise<AdminCollectionsRes>
Description
Creates a collection.
Parameters
| Name | Type |
|---|---|
payload |
AdminPostCollectionsReq |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<AdminCollectionsRes>
Created collection.
Defined in
medusa-js/src/resources/admin/collections.ts:22
delete
▸ delete(id, customHeaders?): ResponsePromise<DeleteResponse>
Description
deletes a collection
Parameters
| Name | Type | Description |
|---|---|---|
id |
string |
id of collection to delete. |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<DeleteResponse>
Deleted response
Defined in
medusa-js/src/resources/admin/collections.ts:52
list
▸ list(query?, customHeaders?): ResponsePromise<AdminCollectionsListRes>
Description
Lists collections matching a query
Parameters
| Name | Type | Description |
|---|---|---|
query? |
AdminGetCollectionsParams |
Query for searching collections |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<AdminCollectionsListRes>
a list of collections matching the query.
Defined in
medusa-js/src/resources/admin/collections.ts:80
removeProducts
▸ removeProducts(id, payload, customHeaders?): ResponsePromise<DeleteResponse>
Description
Removes products associated with a Product Collection
Parameters
| Name | Type | Description |
|---|---|---|
id |
string |
the id of the Collection |
payload |
AdminDeleteProductsFromCollectionReq |
an object which contains an array of Product IDs to add to the Product Collection |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<DeleteResponse>
Defined in
medusa-js/src/resources/admin/collections.ts:115
retrieve
▸ retrieve(id, customHeaders?): ResponsePromise<AdminCollectionsRes>
Description
get a collection
Parameters
| Name | Type | Description |
|---|---|---|
id |
string |
id of the collection to retrieve. |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<AdminCollectionsRes>
the collection with the given id
Defined in
medusa-js/src/resources/admin/collections.ts:66
update
▸ update(id, payload, customHeaders?): ResponsePromise<AdminCollectionsRes>
Description
Updates a collection
Parameters
| Name | Type | Description |
|---|---|---|
id |
string |
id of the collection to update. |
payload |
AdminPostCollectionsCollectionReq |
update to apply to collection. |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<AdminCollectionsRes>
the updated collection.