updateExchangeShippingMethodValidationStep - Medusa Core Workflows Reference

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

This step validates that an exchange's shipping method can be updated. If the exchange is canceled, the order change is not active, the shipping method doesn't exist in the exchange, 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 = updateExchangeShippingMethodValidationStep({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    data: {14      custom_amount: 10,15    }16  }17})

Input#

UpdateExchangeShippingMethodValidationStepInputUpdateExchangeShippingMethodValidationStepInput
The data to validate that an exchange's shipping method can be updated.
orderExchangeOrderExchangeDTO
The order exchange's details.
orderChangeOrderChangeDTO
The order change's details.
inputPick<UpdateExchangeShippingMethodWorkflowInput, "exchange_id" | "action_id">
The details of the shipping method update.
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