- Get Started
- Product
- Resources
- Tools & SDKs
- Framework
- Reference
Menu
- Get Started
- Product
- Resources
- Tools & SDKs
- Framework
- Reference
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.
Note: You can retrieve an order exchange and order change details using Query,
or useQueryGraphStep.
Example#
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#
UpdateExchangeShippingMethodValidationStepInput
UpdateExchangeShippingMethodValidationStepInputThe data to validate that an exchange's shipping method can be updated.
UpdateExchangeShippingMethodValidationStepInput
UpdateExchangeShippingMethodValidationStepInputorderExchange
OrderExchangeDTOThe order exchange's details.
orderExchange
OrderExchangeDTOorderChange
OrderChangeDTOThe order change's details.
orderChange
OrderChangeDTOinput
Pick<UpdateExchangeShippingMethodWorkflowInput, "exchange_id" | "action_id">The details of the shipping method update.
input
Pick<UpdateExchangeShippingMethodWorkflowInput, "exchange_id" | "action_id">Was this page helpful?