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

CreateOrderReturnDTO

The return to be created.

order_idstring
The associated order's ID.
return_idstringOptional
The associated return's ID.
descriptionstringOptional
The description of the action.
internal_notestringOptional
The internal note of the action.
referencestringOptional
The name of the data model the action references. For example, return.
reference_idstringOptional
The ID of the record of the data model specified in reference. For example, if reference is return, the value is return_123.
metadatanull | Record<string, unknown>Optional
Holds custom data in key-value pairs.
location_idstringOptional
The ID of the location to return the items to.
itemsobject[]Optional
The items of the return.
shipping_methodstring | Omit<CreateOrderShippingMethodDTO, "order_id">Optional
The shipping method of the return.
refund_amountBigNumberInputOptional
The refund amount of the return.
no_notificationbooleanOptional
Whether the customer should receive notifications related to updates on the return.
claim_idstringOptional
The associated claim's ID.
exchange_idstringOptional
The associated exchange's ID.
created_bynull | stringOptional
The id of the user that creates the fulfillment
Was this page helpful?
Edit this page
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
⇧↵