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

cancelOrderExchangeWorkflow - Medusa Core Workflows Reference

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

This workflow cancels a confirmed exchange. It's used by the Cancel Exchange Admin API Route.

You can use this workflow within your customizations or your own custom workflows, allowing you to cancel an exchange for an order in your custom flow.

Source Code

Examples#

Steps#

useRemoteQueryStep

cancelExchangeValidateOrder

cancelOrderExchangeStep

deleteReservationsByLineItemsStep

cancelReturnWorkflow

Workflow Hook

Step conditioned by when

Input#

CancelOrderExchangeWorkflowInputCancelOrderExchangeWorkflowInput
exchange_idstring
The ID of the exchange to cancel.
no_notificationbooleanOptional
Whether to notify the customer of the cancellation.
canceled_bystringOptional
The ID of the user that's 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
⇧↵