This documentation provides a reference to the completeCartWorkflow
. It belongs to the @medusajs/medusa/core-flows
package.
This workflow completes a cart and places an order for the customer. It's executed by the Complete Cart Store API Route.
You can use this workflow within your own customizations or custom workflows, allowing you to wrap custom logic around completing a cart. For example, in the Subscriptions recipe, this workflow is used within another workflow that creates a subscription order.
Source CodeWorkflow hook
Step conditioned by when
View step details
CompleteCartWorkflowInput
CompleteCartWorkflowInputid
stringCompleteCartWorkflowOutput
CompleteCartWorkflowOutputid
stringHooks 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.
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.
Handlers consuming this hook accept the following input.
input
inputcart
anyThis 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.
Event | Description | Payload | Action |
---|---|---|---|
| Emitted when an order is placed, or when a draft order is converted to an order. |
|