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

cancelOrderClaimWorkflow - Medusa Core Workflows Reference

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

This workflow cancels a confirmed order claim. It's used by the Cancel Claim 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 Code

Examples#

Steps#

useRemoteQueryStep

cancelClaimValidateOrderStep

cancelOrderClaimStep

deleteReservationsByLineItemsStep

cancelReturnWorkflow

Workflow Hook

Step conditioned by when

Input#

CancelOrderClaimWorkflowInputCancelOrderClaimWorkflowInput
claim_idstring
The ID of the claim to cancel.
no_notificationbooleanOptional
Whether to notify the customer of the cancellation.
canceled_bystringOptional
The ID of the user canceling the claim.
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
⇧↵