deleteCollections - Product Module Reference

Beta

This documentation provides a reference to the deleteCollections method. This belongs to the Product Module.

This method is used to delete collections by their ID.

Example

import {
  initialize as initializeProductModule,
} from "@medusajs/product"

async function deleteCollection (ids: string[]) {
  const productModule = await initializeProductModule()

  await productModule.deleteCollections(ids)
}

Parameters

productCollectionIdsstring[]Required

The IDs of the product collections to be updated.

sharedContextContext

A context used to share resources, such as transaction manager, between the application and the module.

Returns

PromisePromise<void>Required

Resolves when the product options are successfully deleted.