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

cancelExchangeValidateOrder - Medusa Core Workflows Reference

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

This step validates that an exchange can be canceled. If the exchange is canceled, or any of the fulfillments are not canceled, the step will throw an error.

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

Example#

Code
1const data = cancelExchangeValidateOrder({2  orderExchange: {3    id: "exchange_123",4    // other order exchange details...5  },6  input: {7    exchange_id: "exchange_123",8  }9})

Input#

CancelExchangeValidateOrderStepInputCancelExchangeValidateOrderStepInput
The data to validate that an exchange can be canceled.
orderExchangeOrderExchangeDTO
The order exchange's details.
inputCancelOrderExchangeWorkflowInput
The details of canceling the exchange.
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
⇧↵