- Get Started
- Product
- Resources
- Tools & SDKs
- Framework
- Reference
Menu
- Get Started
- Product
- Resources
- Tools & SDKs
- Framework
- Reference
removeReturnItemActionValidationStep - Medusa Core Workflows Reference
This documentation provides a reference to the removeReturnItemActionValidationStep
. It belongs to the @medusajs/medusa/core-flows
package.
This step validates that a return item can be removed. If the order or return is canceled, the order change is not active, the return request is not found, or the action is not a request return action, the step will throw an error.
Note: You can retrieve an order, return, and order change details using Query,
or useQueryGraphStep.
Example#
1const data = removeReturnItemActionValidationStep({2 order: {3 id: "order_123",4 // other order details...5 },6 orderChange: {7 id: "orch_123",8 // other order change details...9 },10 orderReturn: {11 id: "return_123",12 // other return details...13 },14 input: {15 return_id: "return_123",16 action_id: "orchac_123",17 }18})
Input#
RemoveItemReturnActionValidationStepInput
RemoveItemReturnActionValidationStepInputThe data to validate that a return item can be removed.
RemoveItemReturnActionValidationStepInput
RemoveItemReturnActionValidationStepInputorder
OrderDTOThe order's details.
order
OrderDTOorderReturn
ReturnDTOThe return's details.
orderReturn
ReturnDTOorderChange
OrderChangeDTOThe order change's details.
orderChange
OrderChangeDTOThe details of the item to be removed.
Was this page helpful?