Menu
  • Get Started
  • Product
  • Resources
  • Tools & SDKs
  • Framework
  • Reference

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.

Source Code

Examples#

Steps#

useRemoteQueryStep

beginOrderEditValidationStep

createOrderChangeStep

Workflow Hook

Step conditioned by when

Input#

BeginorderEditWorkflowInputBeginorderEditWorkflowInput
order_idstring
The ID of the order to request an edit for.
created_bystringOptional
The ID of the user requesting the order edit.
internal_notestringOptional
A note viewed by admins only related to the order edit.
descriptionstringOptional
Describes the reason for the order edit.
metadatanull | Record<string, unknown>Optional
Custom key-value pairs of data to store in the order edit.

Output#

OrderChangeDTOOrderChangeDTO
The order change details.
idstring
The ID of the order change
versionnumber
The version of the order change
order_idstring
The ID of the associated order
return_idstring
The ID of the associated return order
exchange_idstring
The ID of the associated exchange order
claim_idstring
The ID of the associated claim order
orderOrderDTO
The associated order
return_orderReturnDTO
The associated return order
exchangeOrderExchangeDTO
The associated exchange order
claimOrderClaimDTO
The associated claim order
actionsOrderChangeActionDTO[]
The actions of the order change
statusOrderChangeStatus
The status of the order change
requested_bynull | string
The requested by of the order change
requested_atnull | string | Date
When the order change was requested
confirmed_bynull | string
The confirmed by of the order change
confirmed_atnull | string | Date
When the order change was confirmed
declined_bynull | string
The declined by of the order change
declined_reasonnull | string
The declined reason of the order change
metadatanull | Record<string, unknown>
The metadata of the order change
declined_atnull | string | Date
When the order change was declined
canceled_bynull | string
The canceled by of the order change
canceled_atnull | string | Date
When the order change was canceled
created_atstring | Date
When the order change was created
updated_atstring | Date
When the order change was updated
change_type"return" | "exchange" | "claim" | "edit" | "transfer"Optional
The type of the order change
Was this page helpful?
Ask Anything
FAQ
What is Medusa?
How can I create a module?
How can I create a data model?
How do I create a workflow?
How can I extend a data model in the Product Module?
Recipes
How do I build a marketplace with Medusa?
How do I build digital products with Medusa?
How do I build subscription-based purchases with Medusa?
What other recipes are available in the Medusa documentation?
Chat is cleared on refresh
Line break
⇧↵