- Get Started
- Product
- Resources
- Tools & SDKs
- Framework
- Reference
Menu
- Get Started
- Product
- Resources
- Tools & SDKs
- Framework
- Reference
CreateOrderExchangeDTO
The exchange to be created.
order_idstringThe associated order's ID.
return_idstringOptionalThe associated return's ID.
claim_idstringOptionalThe associated claim's ID.
exchange_idstringOptionalThe associated exchange's ID.
descriptionstringOptionalThe description of the action.
internal_notestringOptionalThe internal note of the action.
referencestringOptionalThe name of the data model the action
references. For example,
return.reference_idstringOptionalThe 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>OptionalHolds custom data in key-value pairs.
The items to be sent to the customer.
The shipping methods used to send the additional items
to the customer.
The shipping methods used to return items from the customer.
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.
- 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_backorderbooleanOptionalWhether backorder is allowed for the exchange's items.
no_notificationbooleanOptionalWhether the customer should receive notifications related to
updates on the exchange.
created_bynull | stringOptionalThe id of the user that creates the order exchange
Was this page helpful?