beginOrderEditOrderWorkflow - Medusa Core Workflows Reference

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

This workflow creates an order edit request. It' used by the Create Order Edit Admin API Route.

To request the order edit, use the requestOrderEditRequestWorkflow. The order edit is then only applied after the order edit is confirmed using the confirmOrderEditRequestWorkflow.

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

Examples#

Steps#

Input#

Output#