createAndCompleteReturnOrderWorkflow - Medusa Core Workflows Reference

This documentation provides a reference to the createAndCompleteReturnOrderWorkflow. It belongs to the @medusajs/medusa/core-flows package.

This workflow creates and completes a return from the storefront. The admin would receive the return and process it from the dashboard. This workflow is used by the Create Return Store API Route.

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#

Hooks#

Hooks allow you to inject custom functionalities into the workflow. You'll receive data from the workflow, as well as additional data sent through an HTTP request.

Learn more about Hooks and Additional Data.

setPricingContext#

This hook is executed before the return's shipping method is created. You can consume this hook to return any custom context useful for the prices retrieval of the shipping method's option.

For example, assuming you have the following custom pricing rule:

Code
1{2  "attribute": "location_id",3  "operator": "eq",4  "value": "sloc_123",5}

You can consume the setPricingContext hook to add the location_id context to the prices calculation:

Code
1import { createAndCompleteReturnOrderWorkflow } from "@medusajs/medusa/core-flows";2import { StepResponse } from "@medusajs/workflows-sdk";3
4createAndCompleteReturnOrderWorkflow.hooks.setPricingContext((5  { order, additional_data }, { container }6) => {7  return new StepResponse({8    location_id: "sloc_123", // Special price for in-store purchases9  });10});

The price of the shipping method's option will now be retrieved using the context you return.

Example

Code
1import { createAndCompleteReturnOrderWorkflow } from "@medusajs/medusa/core-flows"2
3createAndCompleteReturnOrderWorkflow.hooks.setPricingContext(4  (async ({ order, additional_data }, { container }) => {5    //TODO6  })7)

Input

Handlers consuming this hook accept the following input.

Emitted Events#

This section lists the events that are either triggered by the emitEventStep in the workflow, or by another workflow executed within this workflow.

You can listen to these events in a subscriber, as explained in the Subscribers documentation.

{
  order_id, // The ID of the order
  return_id, // The ID of the return
}

{
  order_id, // The ID of the order
  return_id, // The ID of the return
}