Get Started
Product
Resources
Tools & SDKs
Framework
Reference

cancelClaimValidateOrderStep - Medusa Core Workflows Reference

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

This step validates that a confirmed claim can be canceled. If the claim is canceled, or the claim's fulfillments are not canceled, the step will throw an error.

Note: You can retrieve an order claim's details using Query, or useQueryGraphStep.

Example#

Code
1const data = cancelClaimValidateOrderStep({2  orderClaim: {3    id: "claim_123",4    // other order claim details...5  },6  input: {7    claim_id: "claim_123",8  }9})

Input#

CancelClaimValidateOrderStepInputCancelClaimValidateOrderStepInput

The data to validate the cancelation of a confirmed order claim.

orderClaimOrderClaimDTO

The order claim's details.

inputCancelOrderClaimWorkflowInput

The cancelation details.

Was this page helpful?