- Get Started
- Product
- Resources
- Tools & SDKs
- Framework
- Reference
Menu
- Get Started
- Product
- Resources
- Tools & SDKs
- Framework
- Reference
cancelBeginOrderClaimWorkflow - Medusa Core Workflows Reference
This documentation provides a reference to the cancelBeginOrderClaimWorkflow
. It belongs to the @medusajs/medusa/core-flows
package.
This workflow cancels a requested order claim. It's used by the Cancel Claim Request Admin API Route.
You can use this workflow within your customizations or your own custom workflows, allowing you to cancel a claim for an order in your custom flows.
Source CodeExamples#
Steps#
Workflow Hook
Step conditioned by when
Input#
CancelBeginOrderClaimWorkflowInput
CancelBeginOrderClaimWorkflowInputThe data to cancel a requested order claim.
CancelBeginOrderClaimWorkflowInput
CancelBeginOrderClaimWorkflowInputclaim_id
stringThe ID of the claim to cancel.
claim_id
stringWas this page helpful?