cancelOrderWorkflow - Medusa Core Workflows Reference

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

This workflow cancels an order. An order can only be canceled if it doesn't have any fulfillments, or if all fulfillments are canceled. The workflow will also cancel any uncaptured payments, and refund any captured payments.

This workflow is used by the Cancel Order Admin API Route.

This workflow has a hook that allows you to perform custom actions on the canceled order. For example, you can make changes to custom models linked to the order.

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

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.

orderCanceled#

This hook is executed after the order is canceled. You can consume this hook to perform custom actions on the canceled order.

Example

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