updateShippingOptionTypesWorkflow - Medusa Core Workflows Reference

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

This workflow updates one or more shipping option types. It's used by the Update Shipping Option Type Admin API Route.

This workflow has a hook that allows you to perform custom actions on the updated shipping option types. For example, you can pass under additional_data custom data that allows you to update custom data models 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 updates.

Examples#

Steps#

Input#

Output#

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.

shippingOptionTypesUpdated#

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

Example

Code
1import { updateShippingOptionTypesWorkflow } from "@medusajs/medusa/core-flows"2
3updateShippingOptionTypesWorkflow.hooks.shippingOptionTypesUpdated(4  (async ({ shipping_option_types, additional_data }, { 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
}]