- Get Started
- Product
- Resources
- Tools & SDKs
- Framework
- Reference
Menu
- Get Started
- Product
- Resources
- Tools & SDKs
- Framework
- Reference
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.
Note: You can retrieve an order, order exchange, and order return details using Query,
or useQueryGraphStep.
Example#
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#
ExchangeRequestItemReturnValidationStepInput
ExchangeRequestItemReturnValidationStepInputThe data to validate that items can be returned as part of an exchange.
ExchangeRequestItemReturnValidationStepInput
ExchangeRequestItemReturnValidationStepInputorder
OrderDTOThe order's details.
order
OrderDTOorderExchange
OrderExchangeDTOThe order exchange's details.
orderExchange
OrderExchangeDTOorderChange
OrderChangeDTOThe order change's details.
orderChange
OrderChangeDTOorderReturn
ReturnDTOThe order return's details.
orderReturn
ReturnDTOitems
OrderExchangeRequestItemReturnWorkflowInput["items"]The items to be returned.
items
OrderExchangeRequestItemReturnWorkflowInput["items"]Was this page helpful?