cancelReturnValidateOrder - Medusa Core Workflows Reference

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

This step validates that a return can be canceled. If the return is canceled, its fulfillment aren't canceled, or it has received items, the step will throw an error.

Note: You can retrieve a return details using Query, or useQueryGraphStep.

Example#

Code
1const data = cancelReturnValidateOrder({2  orderReturn: {3    id: "return_123",4    // other order return details...5  },6  input: {7    return_id: "return_123"8  }9})

Input#

CancelReturnValidateOrderInputCancelReturnValidateOrderInput

The data to validate that a return can be canceled.

orderReturnReturnDTO

The order return's details.

inputCancelReturnWorkflowInput

The data to cancel a return.