This documentation provides a reference to the sdk.admin.productCollection set of methods used to send requests to Medusa's Admin API routes.

create#

This method creates a product collection. It sends a request to the Create Collection API route.

Example#

Code
1sdk.admin.productCollection.create({2  title: "Summer Collection"3})4.then(({ collection }) => {5  console.log(collection)6})

Parameters#

Returns#

---

update#

This method updates a collection. It sends a request to the Update Collection API route.

Example#

Code
1sdk.admin.productCollection.update("pcol_123", {2  title: "Summer Collection"3})4.then(({ collection }) => {5  console.log(collection)6})

Parameters#

Returns#

---

list#

This method retrieves a paginated list of collections. It sends a request to the List Collections API route.

Example#

To retrieve the list of collections:

Code
1sdk.admin.productCollection.list()2.then(({ collections, count, limit, offset }) => {3  console.log(collections)4})

To configure the pagination, pass the limit and offset query parameters.

For example, to retrieve only 10 items and skip 10 items:

Code
1sdk.admin.productCollection.list({2  limit: 10,3  offset: 104})5.then(({ collections, count, limit, offset }) => {6  console.log(collections)7})

Using the fields query parameter, you can specify the fields and relations to retrieve in each collection:

Code
1sdk.admin.productCollection.list({2  fields: "id,*products"3})4.then(({ collections, count, limit, offset }) => {5  console.log(collections)6})

Learn more about the fields property in the API reference.

Parameters#

Returns#

---

retrieve#

This method retrieves a collection by its ID. It sends a request to the Get Collection API route.

Example#

To retrieve a collection by its ID:

Code
1sdk.admin.productCollection.retrieve("pcol_123")2.then(({ collection }) => {3  console.log(collection)4})

To specify the fields and relations to retrieve:

Code
1sdk.admin.productCollection.retrieve("pcol_123", {2  fields: "id,*products"3})4.then(({ collection }) => {5  console.log(collection)6})

Learn more about the fields property in the API reference.

Parameters#

Returns#

---

delete#

This method deletes a product collection. It sends a request to the Delete Collection API route.

Example#

Code
1sdk.admin.productCollection.delete("pcol_123")2.then(({ deleted }) => {3  console.log(deleted)4})

Parameters#

Returns#

---

updateProducts#

This method manages the products of a collection to add or remove them. It sends a request to the Manage Products API route.

Example#

Code
1sdk.admin.productCollection.updateProducts("pcol_123", {2  add: ["prod_123"],3  remove: ["prod_321"]4})5.then(({ collection }) => {6  console.log(collection)7})

Parameters#

Returns#