createOrderChangeWorkflow - Medusa Core Workflows Reference
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 CodeExamples#
Steps#
Workflow hook
Step conditioned by when
View step details
Input#
CreateOrderChangeDTOCreateOrderChangeDTOThe data of the order change to be created.
CreateOrderChangeDTOCreateOrderChangeDTOorder_idstringThe associated order's ID.
order_idstringreturn_idstringOptionalThe associated return's ID.
return_idstringOptionalclaim_idstringOptionalThe associated claim's ID.
claim_idstringOptionalexchange_idstringOptionalThe associated exchange's ID.
exchange_idstringOptionalThe type of the order change.
descriptionstringOptionalThe description of the order change.
descriptionstringOptionalinternal_notenull | stringOptionalThe internal note of the order change.
internal_notenull | stringOptionalrequested_bystringOptionalThe user or customer that requested the order change.
requested_bystringOptionalrequested_atDateOptionalThe date that the order change was requested.
requested_atDateOptionalcreated_bynull | stringOptionalThe user that created the order change.
created_bynull | stringOptionalmetadatanull | Record<string, unknown>OptionalHolds custom data in key-value pairs.
metadatanull | Record<string, unknown>OptionalThe actions of the order change.
Output#
OrderChangeDTOOrderChangeDTOThe order change details.
OrderChangeDTOOrderChangeDTOidstringThe ID of the order change
idstringversionnumberThe version of the order change
versionnumberorder_idstringThe ID of the associated order
order_idstringreturn_idstringThe ID of the associated return order
return_idstringexchange_idstringThe ID of the associated exchange order
exchange_idstringclaim_idstringThe ID of the associated claim order
claim_idstringThe associated order
The associated return order
The associated exchange order
The associated claim order
The actions of the order change
statusOrderChangeStatusThe status of the order change
statusOrderChangeStatusrequested_bynull | stringThe requested by of the order change
requested_bynull | stringrequested_atnull | string | DateWhen the order change was requested
requested_atnull | string | Dateconfirmed_bynull | stringThe confirmed by of the order change
confirmed_bynull | stringconfirmed_atnull | string | DateWhen the order change was confirmed
confirmed_atnull | string | Datedeclined_bynull | stringThe declined by of the order change
declined_bynull | stringdeclined_reasonnull | stringThe declined reason of the order change
declined_reasonnull | stringmetadatanull | Record<string, unknown>The metadata of the order change
metadatanull | Record<string, unknown>declined_atnull | string | DateWhen the order change was declined
declined_atnull | string | Datecanceled_bynull | stringThe canceled by of the order change
canceled_bynull | stringcanceled_atnull | string | DateWhen the order change was canceled
canceled_atnull | string | Datecreated_atstring | DateWhen the order change was created
created_atstring | Dateupdated_atstring | DateWhen the order change was updated
updated_atstring | Datechange_type"return" | "exchange" | "claim" | "edit" | "transfer"OptionalThe type of the order change
change_type"return" | "exchange" | "claim" | "edit" | "transfer"OptionalWas this page helpful?