- Get Started
- Product
- Resources
- Tools & SDKs
- Framework
- Reference
- Get Started
- Product
- Resources
- Tools & SDKs
- Framework
- Reference
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 CodeExamples#
Steps#
Workflow Hook
Step conditioned by when
Input#
UpdateLineItemInCartWorkflowInputDTO
UpdateLineItemInCartWorkflowInputDTOThe details of the line item to update.
UpdateLineItemInCartWorkflowInputDTO
UpdateLineItemInCartWorkflowInputDTOcart_id
stringThe ID of the cart that the line item belongs to.
cart_id
stringitem_id
stringThe ID of the line item to update.
item_id
stringupdate
Partial<UpdateLineItemDTO>The details to update in the line item.
update
Partial<UpdateLineItemDTO>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
Input
Handlers consuming this hook accept the following input.
input
objectThe input data for the hook.
input
objectThe details of the line item to update.
cart
any
cart
any