declineOrderChangeWorkflow - Medusa Core Workflows Reference

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

This workflow declines an order change.

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

Source Code

Examples#

Steps#

Workflow Hook

Step conditioned by when

Input#

DeclineOrderChangeDTODeclineOrderChangeDTO
The details of declining the order change.
idstring
The ID of the order change.
declined_bystringOptional
The user or customer who declined 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