updateCartWorkflow - Medusa Core Workflows Reference

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

This workflow updates a cart and returns it. You can update the cart's region, address, and more. This workflow is executed by the Update Cart Store API Route.

This workflow has a hook that allows you to perform custom actions on the updated cart. For example, you can pass custom data under the additional_data property of the Update Cart API route, then update any associated details related to the cart in the workflow's hook.

You can also use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around updating a 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 { updateCartWorkflow } from "@medusajs/medusa/core-flows"2
3updateCartWorkflow.hooks.validate(4  (async ({ input, cart }, { container }) => {5    //TODO6  })7)

Input

Handlers consuming this hook accept the following input.

cartUpdated#

This hook is executed after a cart is update. You can consume this hook to perform custom actions on the updated cart.

Example

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

{
  id, // The ID of the cart
}