Get Started
Product
Resources
Tools & SDKs
Framework
Reference

cancelTransferOrderRequestValidationStep - Medusa Core Workflows Reference

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

This step validates that a requested order transfer can be canceled. If the customer canceling the order transfer isn't the one that requested the transfer, the step throws an error. Admin users can cancel any order transfer.

Note: You can retrieve an order and order change details using Query, or useQueryGraphStep.

Example#

Code
1const data = cancelTransferOrderRequestValidationStep({2  order: {3    id: "order_123",4    // other order details...5  },6  orderChange: {7    id: "order_change_123",8    // other order change details...9  },10  input: {11    order_id: "order_123",12    logged_in_user_id: "cus_123",13    actor_type: "customer"14  }15})

Input#

CancelTransferOrderRequestValidationStepCancelTransferOrderRequestValidationStep

The details of the order transfer cancellation to validate.

orderOrderDTO

The order to cancel the transfer request for.

orderChangeOrderChangeDTO

The order change made by the transfer request.

inputCancelTransferOrderRequestWorkflowInput

The cancelation details.

Was this page helpful?