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.

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

Input

Handlers consuming this hook accept the following input.

setPricingContext#

This hook is executed after the cart is retrieved and before the line items are created. You can consume this hook to return any custom context useful for the prices retrieval of the variants to be added to the cart.

For example, assuming you have the following custom pricing rule:

Code
1{2  "attribute": "location_id",3  "operator": "eq",4  "value": "sloc_123",5}

You can consume the setPricingContext hook to add the location_id context to the prices calculation:

Code
1import { addToCartWorkflow } from "@medusajs/medusa/core-flows";2import { StepResponse } from "@medusajs/workflows-sdk";3
4addToCartWorkflow.hooks.setPricingContext((5  { cart, variantIds, items, additional_data }, { container }6) => {7  return new StepResponse({8    location_id: "sloc_123", // Special price for in-store purchases9  });10});

The variants' prices will now be retrieved using the context you return.

Example

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