Menu
  • Get Started
  • Product
  • Resources
  • Tools & SDKs
  • Framework
  • Reference

createReturnReasonsWorkflow - Medusa Core Workflows Reference

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

This workflow creates one or more return reasons. It's used by the Create Return Reason Admin API Route.

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

Source Code

Examples#

Steps#

createReturnReasonsStep

Workflow Hook

Step conditioned by when

Input#

CreateReturnReasonsWorkflowInputCreateReturnReasonsWorkflowInput
The data to create return reasons.
dataCreateOrderReturnReasonDTO[]
The return reasons to create.

Output#

CreateReturnReasonsWorkflowOutputCreateReturnReasonsWorkflowOutput
The created 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?
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
⇧↵