confirmReturnRequestValidationStep - Medusa Core Workflows Reference

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

This step validates that a return request can be confirmed. If the order or return is canceled or the order change is not active, the step will throw an error.

Note: You can retrieve an order, order change, and return details using Query, or useQueryGraphStep.

Example#

Code
1const data = confirmReturnRequestValidationStep({2  order: {3    id: "order_123",4    // other order details...5  },6  orderReturn: {7    id: "return_123",8    // other order return details...9  },10  orderChange: {11    id: "orch_123",12    // other order change details...13  }14})

Input#

ConfirmReturnRequestValidationStepInputConfirmReturnRequestValidationStepInput

The data to validate that a return request can be confirmed.

orderOrderDTO

The order's details.

orderReturnReturnDTO

The order return's details.

orderChangeOrderChangeDTO

The order change's details.

Was this page helpful?