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

cancelOrderTransferRequestWorkflow - Medusa Core Workflows Reference

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

This workflow cancels a requested order transfer. This operation is allowed only by admin users and the customer that requested the transfer. This workflow is used by the Cancel Order Transfer Store API Route, and the Cancel Transfer Request Admin API Route.

You can use this workflow within your customizations or your own custom workflows, allowing you to build a custom flow around canceling an order transfer.

Source Code

Examples#

Steps#

useQueryGraphStep

useQueryGraphStep

cancelTransferOrderRequestValidationStep

deleteOrderChangesStep

Workflow Hook

Step conditioned by when

Input#

CancelTransferOrderRequestWorkflowInputCancelTransferOrderRequestWorkflowInput
order_idstring
The ID of the order to cancel the transfer for.
logged_in_user_idstring
The ID of the authenticated user requesting to cancel the transfer.
actor_type"customer" | "user"
The actor type requesting to cancel the transfer.
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
⇧↵