declineTransferOrderRequestValidationStep - Medusa Core Workflows Reference

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

This step validates that a requested order transfer can be declineed. If the provided token doesn't match the token of the transfer request, the step throws an error.

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

Example#

Code
1const data = declineTransferOrderRequestValidationStep({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    token: "token_123",12    order_id: "order_123",13  }14})

Input#

DeclineTransferOrderRequestValidationStepInputDeclineTransferOrderRequestValidationStepInput

The details of the order transfer decline to validate.

orderOrderDTO

The order to decline the transfer request for.

orderChangeOrderChangeDTO

The order change made by the transfer request.

inputDeclineTransferOrderRequestWorkflowInput

The decline details.