updateReturnReasonsWorkflow - Medusa Core Workflows Reference

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

This workflow updates return reasons matching the specified filters. It's used by the Update Return Reason Admin API Route.

You can use this workflow within your customizations or your own custom workflows, allowing you to update return reasons within your custom flows.

Examples#

updateReturnReasonsStep

Workflow Hook

Step conditioned by when

UpdateReturnReasonsWorkflowInputUpdateReturnReasonsWorkflowInput

The data to update return reasons.

The filters to select the return reasons to update.

updateReturnReasonUpdatableFields

The data to update the return reasons.

UpdateReturnReasonsWorkflowOutputUpdateReturnReasonsWorkflowOutput

The updated return reasons.

idstring

The ID of the return reason

valuestring

The unique value of the return reason

labelstring

The label of the return reason

metadatanull | Record<string, unknown>

The metadata of the return reason

created_atstring | Date

When the return reason was created

updated_atstring | Date

When the return reason was updated

descriptionstringOptional

The description of the return reason

parent_return_reason_idstringOptional

The parent return reason ID

parent_return_reasonOrderReturnReasonDTOOptional

The associated order return reason.

return_reason_childrenOrderReturnReasonDTO[]Optional

The return reason children of the order return reason.

Was this page helpful?