deleteShippingOptionTypesWorkflow - Medusa Core Workflows Reference

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

This workflow deletes one or more shipping-option types. It's used by the Delete Shipping Option Types Admin API Route.

This workflow has a hook that allows you to perform custom actions after the shipping-option types are deleted. For example, you can delete custom records linked to the shipping-option types.

You can also use this workflow within your own custom workflows, allowing you to wrap custom logic around shipping option type deletion.

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.

shippingOptionTypesDeleted#

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

Example

Code
1import { deleteShippingOptionTypesWorkflow } from "@medusajs/medusa/core-flows"2
3deleteShippingOptionTypesWorkflow.hooks.shippingOptionTypesDeleted(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 shipping option type
}]