orderClaimRequestItemReturnValidationStep - Medusa Core Workflows Reference

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

This step validates that items can be requested to return as part of a claim. If the order, claim, or return is canceled, or the order change is not active, the step will throw an error.

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

Example#

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

Input#

OrderClaimRequestItemReturnValidationStepInputOrderClaimRequestItemReturnValidationStepInput

The data to validate that items can be requested to return as part of a claim.

orderOrderDTO

The order's details.

orderReturnReturnDTO

The order return's details.

orderClaimOrderClaimDTO

The order claim's details.

orderChangeOrderChangeDTO

The order change's details.

itemsOrderClaimRequestItemReturnWorkflowInput["items"]

The items requested to return.