updateLineItemInCartWorkflow - Medusa Core Workflows Reference

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

This workflow updates a line item's details in a cart. You can update the line item's quantity, unit price, and more. This workflow is executed by the Update Line Item Store API Route.

You can use this workflow within your own customizations or custom workflows, allowing you to update a line item's details in your custom flows.

Source Code

Examples#

Steps#

Input#

UpdateLineItemInCartWorkflowInputDTOUpdateLineItemInCartWorkflowInputDTO
The details of the line item to update.
cart_idstring
The ID of the cart that the line item belongs to.
item_idstring
The ID of the line item to update.
updatePartial<UpdateLineItemDTO>
The details to update in the line item.

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 { updateLineItemInCartWorkflow } from "@medusajs/medusa/core-flows"2
3updateLineItemInCartWorkflow.hooks.validate(4  (async ({ input, cart }, { container }) => {5    //TODO6  })7)

Input

Handlers consuming this hook accept the following input.

inputobject
The input data for the hook.
The details of the line item to update.
cartany
Was this page helpful?
Ask Anything
FAQ
What is Medusa?
How can I create a module?
How can I create a data model?
How do I create a workflow?
How can I extend a data model in the Product Module?
Recipes
How do I build a marketplace with Medusa?
How do I build digital products with Medusa?
How do I build subscription-based purchases with Medusa?
What other recipes are available in the Medusa documentation?
Chat is cleared on refresh
Line break