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 Code

Examples#

Steps#

deleteProductOptionsStep

productOptionsDeleted

emitEventStep

Workflow Hook

Step conditioned by when

Input#

DeleteProductOptionsWorkflowInputDeleteProductOptionsWorkflowInput

The data to delete one or more product options.

idsstring[]

The IDs of the options to delete.

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#

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

Example

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

Input

Handlers consuming this hook accept the following input.

inputobject

The input data for the hook.

idsstring[]

Was this page helpful?