This documentation provides a reference to the deleteProductVariantsWorkflow
. It belongs to the @medusajs/medusa/core-flows
package.
This workflow deletes one or more product variants. It's used by the Delete Product Variants Admin API Route.
This workflow has a hook that allows you to perform custom actions after the product variants are deleted. For example, you can delete custom records linked to the product variants.
You can also use this workflow within your own custom workflows, allowing you to wrap custom logic around product-variant deletion.
Source CodeWorkflow hook
Step conditioned by when
View step details
DeleteProductVariantsWorkflowInput
DeleteProductVariantsWorkflowInputids
string[]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.
This hook is executed after the variants are deleted. You can consume this hook to perform custom actions on the deleted variants.
Handlers consuming this hook accept the following input.
input
inputids
string[]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.
Event | Description | Payload | Action |
---|---|---|---|
| Emitted when product variants are deleted. |
|