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.

Examples#

Steps#

Input#

Output#