refreshCartItemsWorkflow - Medusa Core Workflows Reference

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

This workflow refreshes a cart to ensure its prices, promotion codes, taxes, and other details are applied correctly. It's useful after making a chnge to a cart, such as after adding an item to the cart or adding a promotion code.

This workflow is used by other cart-related workflows, such as the addToCartWorkflow after an item is added to the cart.

You can use this workflow within your own customizations or custom workflows, allowing you to refresh the cart after making updates to it in your custom flows.

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.

setPricingContext#

This hook is executed before the cart is refreshed. You can consume this hook to return any custom context useful for the prices retrieval of the variants in 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 { refreshCartItemsWorkflow } from "@medusajs/medusa/core-flows";2import { StepResponse } from "@medusajs/workflows-sdk";3
4refreshCartItemsWorkflow.hooks.setPricingContext((5  { cart, 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 { refreshCartItemsWorkflow } from "@medusajs/medusa/core-flows"2
3refreshCartItemsWorkflow.hooks.setPricingContext(4  (async ({ cart_id, items, additional_data }, { container }) => {5    //TODO6  })7)

Input

Handlers consuming this hook accept the following input.

beforeRefreshingPaymentCollection#

This step is a hook that you can inject custom functionality into.

Example

Code
1import { refreshCartItemsWorkflow } from "@medusajs/medusa/core-flows"2
3refreshCartItemsWorkflow.hooks.beforeRefreshingPaymentCollection(4  (async ({ input }, { container }) => {5    //TODO6  })7)

Input

Handlers consuming this hook accept the following input.