completeOrderWorkflow - Medusa Core Workflows Reference

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

This workflow marks one or more orders as completed. It's used by the Complete Cart Admin API Route.

This workflow has a hook that allows you to perform custom actions on the completed orders. For example, you can pass under additional_data custom data that allows you to update custom data models linked to the orders.

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

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.

ordersCompleted#

This hook is executed after the orders are completed. You can consume this hook to perform custom actions on the completed orders.

Example

Code
1import { completeOrderWorkflow } from "@medusajs/medusa/core-flows"2
3completeOrderWorkflow.hooks.ordersCompleted(4  (async ({ orders, 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 order
}]