exchangeRequestItemReturnValidationStep - Medusa Core Workflows Reference

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

This step validates that items can be returned as part of an exchange. If the order, exchange, or return is canceled, the order change is not active, or the item doesn't exist in the order, the step will throw an error.

NoteYou can retrieve an order, order exchange, and order return details using Query, or useQueryGraphStep.

Example#

Code
1const data = exchangeRequestItemReturnValidationStep({2  order: {3    id: "order_123",4    // other order details...5  },6  orderChange: {7    id: "orch_123",8    // other order change details...9  },10  orderExchange: {11    id: "exchange_123",12    // other order exchange details...13  },14  orderReturn: {15    id: "return_123",16    // other order return details...17  },18  items: [19    {20      id: "orli_123",21      quantity: 1,22    }23  ]24})

Input#

ExchangeRequestItemReturnValidationStepInputExchangeRequestItemReturnValidationStepInput
The data to validate that items can be returned as part of an exchange.
The order's details.
orderExchangeOrderExchangeDTO
The order exchange's details.
orderChangeOrderChangeDTO
The order change's details.
orderReturnReturnDTO
The order return's details.
The items to be returned.
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