removeOrderEditShippingMethodValidationStep - Medusa Core Workflows Reference

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

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

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

Example#

Code
1const data = removeOrderEditShippingMethodValidationStep({2  orderChange: {3    id: "orch_123",4    // other order change details...5  },6  input: {7    order_id: "order_123",8    action_id: "orchact_123",9  }10})

Input#

RemoveOrderEditShippingMethodValidationStepInputRemoveOrderEditShippingMethodValidationStepInput

The data to validate that a shipping method can be removed from an order edit.

orderChangeOrderChangeDTO

The order change's details.

inputPick<DeleteOrderEditShippingMethodWorkflowInput, "order_id" | "action_id">

The details of the shipping method to be removed.

Was this page helpful?