deleteProductCategoriesWorkflow - Medusa Core Workflows Reference

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

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

You can use this workflow within your customizations or your own custom workflows, allowing you to delete product categories within your custom flows.

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.

categoriesDeleted#

This step is a hook that you can inject custom functionality into.

Example

Code
1import { deleteProductCategoriesWorkflow } from "@medusajs/medusa/core-flows"2
3deleteProductCategoriesWorkflow.hooks.categoriesDeleted(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 category
}]