deleteProductOptionsWorkflow - Medusa Core Workflows Reference
This documentation provides a reference to the deleteProductOptionsWorkflow
. It belongs to the @medusajs/medusa/core-flows
package.
This workflow deletes one or more product options. It's used by the Delete Product Option Admin API Route.
This workflow has a hook that allows you to perform custom actions after the product options 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-option deletion.
Source CodeExamples#
Steps#
Workflow hook
Step conditioned by when
View step details
Input#
DeleteProductOptionsWorkflowInput
DeleteProductOptionsWorkflowInputThe data to delete one or more product options.
DeleteProductOptionsWorkflowInput
DeleteProductOptionsWorkflowInputids
string[]The IDs of the options 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.
productOptionsDeleted#
Handlers consuming this hook accept the following input.
input
object
input
objectids
string[]
ids
string[]