cancelOrderFulfillmentWorkflow - Medusa Core Workflows Reference

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

This workflow cancels an order's fulfillment. It's used by the Cancel Order's Fulfillment Admin API Route.

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

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

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.

orderFulfillmentCanceled#

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

Example

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

{
  order_id, // The ID of the order
  fulfillment_id, // The ID of the fulfillment
  no_notification, // (boolean) Whether to notify the customer
}