Loading...
Was this page helpful?
This documentation provides a reference to the beginExchangeOrderWorkflow
. It belongs to the @medusajs/medusa/core-flows
package.
This workflow requests an order exchange. It's used by the Create Exchange Admin API Route.
You can use this workflow within your customizations or your own custom workflows, allowing you to request an exchange for an order in your custom flow.
Source CodeWorkflow hook
Step conditioned by when
View step details
BeginOrderExchangeWorkflowInput
BeginOrderExchangeWorkflowInputorder_id
stringcreated_by
null | stringOptionalinternal_note
stringOptionaldescription
stringOptionalmetadata
null | Record<string, unknown>OptionalOrderChangeDTO
OrderChangeDTOid
stringversion
numberorder_id
stringreturn_id
stringexchange_id
stringclaim_id
stringstatus
OrderChangeStatusrequested_by
null | stringrequested_at
null | string | Dateconfirmed_by
null | stringconfirmed_at
null | string | Datedeclined_by
null | stringdeclined_reason
null | stringmetadata
null | Record<string, unknown>declined_at
null | string | Datecanceled_by
null | stringcanceled_at
null | string | Datecreated_at
string | Dateupdated_at
string | Datechange_type
"return" | "exchange" | "claim" | "edit" | "transfer"Optional