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.
Source CodeExamples#
Steps#
Workflow hook
Step conditioned by when
View step details
Input#
AddShippingMethodToCartWorkflowInputAddShippingMethodToCartWorkflowInputThe data to add a shipping method to a cart.
AddShippingMethodToCartWorkflowInputAddShippingMethodToCartWorkflowInputcart_idstringThe ID of the cart to add the shipping method to.
cart_idstringoptionsobject[]The shipping options to create the shipping methods from and add to the cart.
optionsobject[]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#
Handlers consuming this hook accept the following input.
invokeInvokeFn<object, TOutput, TCompensateInput>The type of invocation function passed to a step.
The type of compensation function passed to a step.
Was this page helpful?