removeClaimShippingMethodValidationStep - Medusa Core Workflows Reference

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

This step validates that a claim's shipping method can be removed. If the claim or order change is canceled, the shipping method doesn't exist in the claim, or the action is not adding a shipping method, the step will throw an error.

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

Example#

Code
1const data = removeClaimShippingMethodValidationStep({2  orderChange: {3    id: "orch_123",4    // other order change details...5  },6  orderClaim: {7    id: "claim_123",8    // other order claim details...9  },10  input: {11    claim_id: "claim_123",12    action_id: "orchact_123",13  }14})

Input#

RemoveClaimShippingMethodValidationStepInputRemoveClaimShippingMethodValidationStepInput

The data to validate that a claim's shipping method can be removed.

orderClaimOrderClaimDTO

The order claim's details.

orderChangeOrderChangeDTO

The order change's details.

inputPick<DeleteClaimShippingMethodWorkflowInput, "claim_id" | "action_id">

The details of removing the shipping method.

Was this page helpful?