createCartWorkflow - Medusa Core Workflows Reference

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

This workflow creates and returns a cart. You can set the cart's items, region, customer, and other details. This workflow is executed by the Create Cart Store API Route.

This workflow has a hook that allows you to perform custom actions on the created cart. You can see an example in this guide.

You can also use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around cart creation.

Examples#

Steps#

Input#

Output#

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

Input

Handlers consuming this hook accept the following input.

cartCreated#

This hook is executed after a cart is created. You can consume this hook to perform custom actions on the created cart.

Example

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

Input

Handlers consuming this hook accept the following input.