addToCartWorkflow - Medusa Core Workflows Reference
This documentation provides a reference to the addToCartWorkflow. It belongs to the @medusajs/medusa/core-flows package.
This workflow adds a product variant to a cart as a line item. It's executed by the Add Line Item Store API Route.
You can use this workflow within your own customizations or custom workflows, allowing you to wrap custom logic around adding an item to the cart. For example, you can use this workflow to add a line item to the cart with a custom price.
Source CodeExamples#
Steps#
Workflow hook
Step conditioned by when
View step details
Input#
AddToCartWorkflowInputDTOAddToCartWorkflowInputDTOThe details of adding items to the cart.
AddToCartWorkflowInputDTOAddToCartWorkflowInputDTOcart_idstringThe ID of the cart to add items to.
cart_idstringitemsCreateCartCreateLineItemDTO[]The items to add to the cart.
itemsCreateCartCreateLineItemDTO[]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.
inputobjectThe input data for the hook.
inputobjectThe details of adding items to the cart.
cartany
cartany