Loading...
Was this page helpful?
This documentation provides a reference to the createOrderChangeWorkflow
. It belongs to the @medusajs/medusa/core-flows
package.
This workflow creates an order change.
You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around creating an order change.
Source CodeWorkflow hook
Step conditioned by when
View step details
CreateOrderChangeDTO
CreateOrderChangeDTOorder_id
stringreturn_id
stringOptionalclaim_id
stringOptionalexchange_id
stringOptionaldescription
stringOptionalinternal_note
null | stringOptionalrequested_by
stringOptionalrequested_at
DateOptionalcreated_by
null | 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