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

cancelOrderChangeWorkflow - Medusa Core Workflows Reference

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

This workflow cancels an order change.

You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around canceling an order change.

Source Code

Examples#

Steps#

cancelOrderChangeStep

Workflow Hook

Step conditioned by when

Input#

CancelOrderChangeDTOCancelOrderChangeDTO
The details of the order change cancelation.
idstring
The ID of the order change.
canceled_bystringOptional
The user or customer that canceled the order change.
metadatanull | Record<string, unknown>Optional
Holds custom data in key-value pairs.
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
⇧↵