Menu
  • Get Started
  • Product
  • Resources
  • Tools & SDKs
  • Framework
  • Reference

cancelBeginOrderClaimValidationStep - Medusa Core Workflows Reference

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

This step validates that the requested claim can be canceled by checking that it's not canceled, its order isn't canceled, and it hasn't been confirmed. If not valid, 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 = cancelBeginOrderClaimValidationStep({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#

CancelBeginOrderClaimValidationStepInputCancelBeginOrderClaimValidationStepInput
The data to validate the cancelation of a requested order claim.
orderOrderDTO
The order's details.
orderClaimOrderClaimDTO
The order claim's details.
orderChangeOrderChangeDTO
The order change's details.
Was this page helpful?
Ask Anything
FAQ
What is Medusa?
How can I create a module?
How can I create a data model?
How do I create a workflow?
How can I extend a data model in the Product Module?
Recipes
How do I build a marketplace with Medusa?
How do I build digital products with Medusa?
How do I build subscription-based purchases with Medusa?
What other recipes are available in the Medusa documentation?
Chat is cleared on refresh
Line break
⇧↵