removeClaimAddItemActionValidationStep - Medusa Core Workflows Reference

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

This step validates that outbound (new) items can be removed from a claim. If the order, claim, or order change is canceled, or the action is not adding an item, the step will throw an error.

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

Example#

Code
1const data = removeClaimAddItemActionValidationStep({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  input: {15    claim_id: "claim_123",16    action_id: "orchact_123",17  }18})

Input#

RemoveClaimAddItemActionValidationStepInputRemoveClaimAddItemActionValidationStepInput

The data to validate that outbound (new) items can be removed from a claim.

orderOrderDTO

The order's details.

orderClaimOrderClaimDTO

The order claim's details.

orderChangeOrderChangeDTO

The order change's details.

inputDeleteOrderClaimItemActionWorkflowInput

The details of removing the outbound items.

Was this page helpful?