addShippingMethodToCartWorkflow - Medusa Core Workflows Reference

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

This workflow adds a shipping method to a cart. It's executed by the Add Shipping Method Store API Route.

You can use this workflow within your own customizations or custom workflows, allowing you to wrap custom logic around adding a shipping method to the cart.

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.

validate#

This hook is executed before all operations. You can consume this hook to perform any custom validation. If validation fails, you can throw an error to stop the workflow execution.

Example

Code
1import { addShippingMethodToCartWorkflow } from "@medusajs/medusa/core-flows"2
3addShippingMethodToCartWorkflow.hooks.validate(4  (async ({ input, cart }, { 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 cart
}