Get Started
Product
Framework
Commerce Modules
Infrastructure Modules
Build
Recipes
How-to & Tutorials
Integrations
Storefront
Tools
CLI Tools
JS SDK
Next.js Starter
Medusa UI
Reference
Admin API
Store API
Admin Injection Zones
Container Resources
Core Workflows
Data Model Language
Data Model Repository
Events Reference
Helper Steps
Service Factory
Testing Framework
Workflows SDK
User Guide

Help

Troubleshooting

Discord Community

Hide Sidebar⌘\

Theme

Light

Dark

Menu

Get Started
Product
Build
Tools
Reference
User Guide

Loading...

Was this page helpful?

New versionv2.8.3 details

Loading...

View as Markdown

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

⇧↵

Navigation↑↓

Open Result↵

CreateOrderExchangeDTO

The exchange to be created.

order_idstring

The associated order's ID.

return_idstringOptional

The associated return's ID.

claim_idstringOptional

The associated claim's ID.

exchange_idstringOptional

The associated exchange'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.

additional_itemsBaseOrderBundledItemActionsDTO[]Optional

The items to be sent to the customer.

shipping_methodsstring[] | Omit<CreateOrderShippingMethodDTO, "order_id">[]Optional

The shipping methods used to send the additional items to the customer.

return_shippingstring | Omit<CreateOrderShippingMethodDTO, "order_id">Optional

The shipping methods used to return items from the customer.

difference_dueBigNumberInputOptional

The difference due of the exchange.

If less than 0, the merchant owes the customer this amount.
If greater than 0, the customer owes the merchange this amount.
If equal to 0, no payment is required by either sides.

allow_backorderbooleanOptional

Whether backorder is allowed for the exchange's items.

no_notificationbooleanOptional

Whether the customer should receive notifications related to updates on the exchange.

created_bynull | stringOptional

The id of the user that creates the order exchange