dismissItemReturnRequestValidationStep - Medusa Core Workflows Reference

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

This step validates that a return request can have its items dismissed. If the order or return is canceled, the order change is not active, or the items do not exist in the return, the step will throw an error.

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

Example#

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

Input#

DismissItemReturnRequestValidationStepInputDismissItemReturnRequestValidationStepInput

The data to validate that a return request can have its items dismissed.

orderPick<OrderDTO, "id" | "items">

The order's details.

orderReturnReturnDTO

The return's details.

orderChangeOrderChangeDTO

The order change's details.

itemsReceiveOrderReturnItemsWorkflowInput["items"]

The items to dismiss.

Was this page helpful?