refreshCartShippingMethodsWorkflow - Medusa Core Workflows Reference

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

This workflow refreshes a cart's shipping methods, ensuring that their associated shipping options can still be used on the cart, and retrieve their correct pricing after a cart update. This workflow is used by the refreshCartItemsWorkflow.

You can use this workflow within your own customizations or custom workflows, allowing you to refresh the cart's shipping method after making updates 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 { refreshCartShippingMethodsWorkflow } from "@medusajs/medusa/core-flows"2
3refreshCartShippingMethodsWorkflow.hooks.validate(4  (async ({ input, cart }, { container }) => {5    //TODO6  })7)

Input

Handlers consuming this hook accept the following input.