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

cancelValidateOrder - Medusa Core Workflows Reference

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

This step validates that an order can be canceled. If the order has fulfillments that aren't canceled, or the order was canceled previously, the step throws an error.

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

Example#

Code
1const data = cancelValidateOrder({2  order: {3    id: "order_123",4    // other order details...5  },6  input: {7    order_id: "order_123",8  }9})

Input#

CancelValidateOrderStepInputCancelValidateOrderStepInput
The data to validate the order's cancelation.
orderOrderDTO
The order to cancel.
inputCancelOrderWorkflowInput
The cancelation 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
⇧↵