deleteCollectionsWorkflow - Medusa Core Workflows Reference

This documentation provides a reference to the deleteCollectionsWorkflow. It belongs to the @medusajs/medusa/core-flows package.

This workflow deletes one or more product collections. It's used by the Delete Product Collection Admin API Route.

This workflow has a hook that allows you to perform custom actions after the product collections are deleted. For example, you can delete custom records linked to the product colleciton.

You can also use this workflow within your own custom workflows, allowing you to wrap custom logic around product-collection deletion.

Examples#

Steps#

Input#

Hooks#

Hooks allow you to inject custom functionalities into the workflow. You'll receive data from the workflow, as well as additional data sent through an HTTP request.

Learn more about Hooks and Additional Data.

collectionsDeleted#

This hook is executed after the collections are deleted. You can consume this hook to perform custom actions on the deleted collections.

Example

Code
1import { deleteCollectionsWorkflow } from "@medusajs/medusa/core-flows"2
3deleteCollectionsWorkflow.hooks.collectionsDeleted(4  (async ({ ids }, { container }) => {5    //TODO6  })7)

Input

Handlers consuming this hook accept the following input.

Emitted Events#

This section lists the events that are either triggered by the emitEventStep in the workflow, or by another workflow executed within this workflow.

You can listen to these events in a subscriber, as explained in the Subscribers documentation.

[{
  id, // The ID of the product collection
}]