updateDraftOrderWorkflow - Medusa Core Workflows Reference

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

This workflow updates a draft order's details. It's used by the Update Draft Order Admin API Route.

This workflow doesn't update the draft order's items, shipping methods, or promotions. Instead, you have to create a draft order edit using beginDraftOrderEditWorkflow and make updates in the draft order edit. Then, you can confirm the draft order edit using confirmDraftOrderEditWorkflow or request a draft order edit using requestDraftOrderEditWorkflow.

You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around updating a draft order.

Examples#

Steps#

Input#

Output#

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
}