removeExchangeShippingMethodValidationStep - Medusa Core Workflows Reference

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

This step validates that a shipping method can be removed from an exchange. If the exchange is canceled, the order change is not active, the shipping method doesn't exist, or the action isn't adding a shipping method, the step will throw an error.

NoteYou can retrieve an order exchange and order change details using Query, or useQueryGraphStep.

Example#

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

Input#

RemoveExchangeShippingMethodValidationStepInputRemoveExchangeShippingMethodValidationStepInput
The data to validate that a shipping method can be removed from an exchange.
orderExchangeOrderExchangeDTO
The order exchange's details.
orderChangeOrderChangeDTO
The order change's details.
inputPick<DeleteExchangeShippingMethodWorkflowInput, "exchange_id" | "action_id">
The details of the action.
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