Get Started
Product
Resources
Tools & SDKs
Framework
Reference

removeExchangeItemActionValidationStep - Medusa Core Workflows Reference

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

This step validates that an outbound item can be removed from an exchange. If the order or exchange is canceled, the item is not found, or the order change is not active, the step will throw an error.

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

Example#

Code
1const data = removeExchangeItemActionValidationStep({2  order: {3    id: "order_123",4    // other order details...5  },6  orderChange: {7    id: "orch_123",8    // other order change details...9  },10  orderExchange: {11    id: "exchange_123",12    // other order exchange details...13  },14  input: {15    exchange_id: "exchange_123",16    action_id: "orchact_123",17  }18})

Input#

RemoveExchangeItemActionValidationStepInputRemoveExchangeItemActionValidationStepInput

The data to validate that an outbound item can be removed from an exchange.

orderOrderDTO

The order's details.

orderExchangeOrderExchangeDTO

The order exchange's details.

orderChangeOrderChangeDTO

The order change's details.

inputDeleteOrderExchangeItemActionWorkflowInput

The details of the item to remove.

Was this page helpful?