Loading...
Was this page helpful?
This documentation provides a reference to the beginReceiveReturnWorkflow
. It belongs to the @medusajs/medusa/core-flows
package.
This workflow requests return receival. It's used by the Start Return Receival Admin API Route.
You can confirm the return receival using the confirmReturnRequestWorkflow.
You can use this workflow within your customizations or your own custom workflows, allowing you to receive a return in your custom flows.
Source CodeWorkflow hook
Step conditioned by when
View step details
BeginReceiveOrderReturnWorkflowInput
BeginReceiveOrderReturnWorkflowInputreturn_id
stringcreated_by
stringOptionaldescription
stringOptionalinternal_note
stringOptionalmetadata
null | Record<string, any>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