- Get Started
- Product
- Resources
- Tools & SDKs
- Framework
- Reference
- Get Started
- Product
- Resources
- Tools & SDKs
- Framework
- Reference
deleteProductsWorkflow - Medusa Core Workflows Reference
This documentation provides a reference to the deleteProductsWorkflow
. It belongs to the @medusajs/medusa/core-flows
package.
This workflow deletes one or more products. It's used by the Delete Products Admin API Route.
This workflow has a hook that allows you to perform custom actions after the products are deleted. For example, you can delete custom records linked to the products.
You can also use this workflow within your own custom workflows, allowing you to wrap custom logic around product deletion.
Source CodeExamples#
Steps#
Workflow Hook
Step conditioned by when
Input#
DeleteProductsWorkflowInput
DeleteProductsWorkflowInputThe data to delete one or more products.
DeleteProductsWorkflowInput
DeleteProductsWorkflowInputids
string[]The IDs of the products to delete.
ids
string[]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.
productsDeleted#
This hook is executed after the products are deleted. You can consume this hook to perform custom actions on the deleted products.
Example
Input
Handlers consuming this hook accept the following input.
input
objectThe input data for the hook.
input
objectids
string[]
ids
string[]