Menu
  • Get Started
  • Product
  • Resources
  • Tools & SDKs
  • Framework
  • Reference

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 Code

Examples#

Steps#

useRemoteQueryStep

receiveCompleteReturnValidationStep

Workflow Hook

Step conditioned by when

Input#

ReceiveCompleteOrderReturnWorkflowInputReceiveCompleteOrderReturnWorkflowInput
return_idstring
The ID of the return to receive and complete.
itemsReceiveReturnItem[]
The received items.
created_bystringOptional
The ID of the user that's receiving and completing the return.
descriptionstringOptional
Description of the return receival.
internal_notestringOptional
A note viewed by admins only related to the return receival.
metadatanull | Record<string, any>Optional
Custom key-value pairs of data to store in the return receival.

Output#

undefined | ReturnDTOundefined | ReturnDTO
undefined | ReturnDTOundefined | ReturnDTO
Was this page helpful?
Ask Anything
FAQ
What is Medusa?
How can I create a module?
How can I create a data model?
How do I create a workflow?
How can I extend a data model in the Product Module?
Recipes
How do I build a marketplace with Medusa?
How do I build digital products with Medusa?
How do I build subscription-based purchases with Medusa?
What other recipes are available in the Medusa documentation?
Chat is cleared on refresh
Line break
⇧↵