beginReturnOrderWorkflow - Medusa Core Workflows Reference
This documentation provides a reference to the beginReturnOrderWorkflow. It belongs to the @medusajs/medusa/core-flows package.
This workflow creates an order return that can be later requested or confirmed. It's used by the Create Return Admin API Route.
You can start the return receival using the beginReceiveReturnWorkflow.
You can use this workflow within your customizations or your own custom workflows, allowing you to create a return for an order in your custom flow.
Source CodeExamples#
Steps#
Workflow hook
Step conditioned by when
View step details
Input#
BeginOrderReturnWorkflowInputBeginOrderReturnWorkflowInput
BeginOrderReturnWorkflowInputBeginOrderReturnWorkflowInputorder_idstringThe ID of the order to create the return for.
order_idstringlocation_idstringOptionalThe ID of the location to return the items to.
location_idstringOptionalcreated_bynull | stringOptionalThe ID of the user creating the return.
created_bynull | stringOptionalinternal_notestringOptionalA note viewed by admins only related to the return.
internal_notestringOptionaldescriptionstringOptionalDescription of the return.
descriptionstringOptionalmetadatanull | Record<string, unknown>OptionalCustom key-value pairs of data to store in the return.
metadatanull | Record<string, unknown>OptionalOutput#
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?