createOrderChangeActionsWorkflow - Medusa Core Workflows Reference
This documentation provides a reference to the createOrderChangeActionsWorkflow. It belongs to the @medusajs/medusa/core-flows package.
This workflow creates order change actions. It's used by other order-related workflows, such as requestItemReturnWorkflow to create an order change action based on changes made to the order.
You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around creating an order change action.
Source CodeExamples#
Input#
CreateOrderChangeActionDTO[]CreateOrderChangeActionDTO[]
CreateOrderChangeActionDTO[]CreateOrderChangeActionDTO[]actionChangeActionTypeThe type of action.
actionChangeActionTypeorder_change_idstringOptionalThe associated order change's ID.
order_change_idstringOptionalorder_idstringOptionalThe associated order's ID.
order_idstringOptionalreturn_idstringOptionalThe associated return's ID.
return_idstringOptionalclaim_idstringOptionalThe associated claim's ID.
claim_idstringOptionalexchange_idstringOptionalThe associated exchange's ID.
exchange_idstringOptionalversionnumberOptionalThe version of the order change action.
Once the order change action is confirmed, this
becomes the order's version.
versionnumberOptionalreferencestringOptionalThe name of the data model that this action
references. For example, return.
referencestringOptionalreturn.reference_idstringOptionalThe ID of the record references of the data model
specified in reference.
For example, if reference is return, the reference_id
is the ID of the return.
reference_idstringOptionalreference is return, the reference_id
is the ID of the return.internal_notenull | stringOptionalThe internal note of the order change action.
internal_notenull | stringOptionalThe amount of the order change action.
detailsRecord<string, unknown>OptionalThe details of the order change action.
This could include the returned items or their changed
quantity, based on the type of this action.
detailsRecord<string, unknown>OptionalappliedbooleanOptionalWhether the action has been applied.
appliedbooleanOptionalOutput#
OrderChangeActionDTO[]OrderChangeActionDTO[]
OrderChangeActionDTO[]OrderChangeActionDTO[]idstringThe ID of the order change action
idstringorder_change_idnull | stringThe ID of the associated order change
order_change_idnull | stringThe associated order change
order_idnull | stringThe ID of the associated order
order_idnull | stringreturn_idnull | stringThe ID of the associated return.
return_idnull | stringclaim_idnull | stringThe ID of the associated claim.
claim_idnull | stringexchange_idnull | stringThe ID of the associated exchange.
exchange_idnull | stringThe associated order
referencestringThe reference of the order change action
referencestringreference_idstringThe ID of the reference
reference_idstringactionChangeActionTypeThe action of the order change action
actionChangeActionTypedetailsnull | Record<string, unknown>The details of the order change action
detailsnull | Record<string, unknown>internal_notenull | stringThe internal note of the order change action
internal_notenull | stringcreated_atstring | DateWhen the order change action was created
created_atstring | Dateupdated_atstring | DateWhen the order change action was updated
updated_atstring | DateWas this page helpful?