cancelBeginOrderEditWorkflow - Medusa Core Workflows Reference

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

This workflow cancels a requested edit for an order. It's used by the Cancel Order Edit Admin API Route.

You can use this workflow within your customizations or your own custom workflows, allowing you to cancel an order edit in your custom flow.

Examples#

Steps#

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
  actions, // (array) The [actions](https://docs.medusajs.com/resources/references/fulfillment/interfaces/fulfillment.OrderChangeActionDTO) to edit the order
}