removeReturnShippingMethodValidationStep - Medusa Core Workflows Reference

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

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

NoteYou can retrieve a return and order change details using Query, or useQueryGraphStep.

Example#

Code
1const data = removeReturnShippingMethodValidationStep({2  orderChange: {3    id: "orch_123",4    // other order change details...5  },6  orderReturn: {7    id: "return_123",8    // other return details...9  },10  input: {11    return_id: "return_123",12    action_id: "orchac_123",13  }14})

Input#

RemoveReturnShippingMethodValidationStepInputRemoveReturnShippingMethodValidationStepInput
The data to validate that a shipping method can be removed from a return.
orderChangeOrderChangeDTO
The order change's details.
orderReturnReturnDTO
The return's details.
inputPick<DeleteReturnShippingMethodWorkflowInput, "return_id" | "action_id">
The details of the shipping method to be removed.
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