receiveAndCompleteReturnOrderWorkflow - Medusa Core Workflows Reference
This documentation provides a reference to the receiveAndCompleteReturnOrderWorkflow. It belongs to the @medusajs/medusa/core-flows package.
This workflow marks a return as received and completes it.
You can use this workflow within your customizations or your own custom workflows, allowing you to receive and complete a return.
Source CodeExamples#
src/api/workflow/route.ts1import type {2 MedusaRequest,3 MedusaResponse,4} from "@medusajs/framework/http"5import { receiveAndCompleteReturnOrderWorkflow } from "@medusajs/medusa/core-flows"6 7export async function POST(8 req: MedusaRequest,9 res: MedusaResponse10) {11 const { result } = await receiveAndCompleteReturnOrderWorkflow(req.scope)12 .run({13 input: {14 return_id: "return_123",15 items: [{16 id: "orli_123",17 quantity: 1,18 }]19 }20 })21 22 res.send(result)23}
Steps#
Workflow hook
Step conditioned by when
View step details
Input#
ReceiveCompleteOrderReturnWorkflowInputReceiveCompleteOrderReturnWorkflowInput
ReceiveCompleteOrderReturnWorkflowInputReceiveCompleteOrderReturnWorkflowInputreturn_idstringThe ID of the return to receive and complete.
return_idstringitemsReceiveReturnItem[]The received items.
itemsReceiveReturnItem[]created_bystringOptionalThe ID of the user that's receiving and completing the return.
created_bystringOptionaldescriptionstringOptionalDescription of the return receival.
descriptionstringOptionalinternal_notestringOptionalA note viewed by admins only related to the return receival.
internal_notestringOptionalmetadatanull | Record<string, any>OptionalCustom key-value pairs of data to store in the return receival.
metadatanull | Record<string, any>OptionalOutput#
Was this page helpful?
