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.
Source CodeWorkflow hook
Step conditioned by when
View step details
CancelOrderFulfillmentWorkflowInput
CancelOrderFulfillmentWorkflowInputorder_id
stringfulfillment_id
stringno_notification
booleanOptionalcanceled_by
stringOptionaladditional_data
Record<string, unknown>Optionaladditional_data
property in HTTP requests.
Learn more in this documentation.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.
This hook is executed after the fulfillment is canceled. You can consume this hook to perform custom actions on the canceled fulfillment.
Handlers consuming this hook accept the following input.
input
inputfulfillment
FulfillmentDTOadditional_data
Record<string, unknown> | undefinedadditional_data
property in HTTP requests.
Learn more in this documentation.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.
Event | Description | Payload | Action |
---|---|---|---|
| Emitted when an order's fulfillment is canceled. |
|