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

OrderExchangeDTO

The exchange details.

idstring
The exchange's ID.
order_idstring
The associated order's ID.
order_versionnumber
The version of the order when the exchange is applied.
display_idnumber
The exchange's display ID.
additional_itemsany[]
The items to be sent to the customer.
metadatanull | Record<string, unknown>
Holds custom data in key-value pairs.
orderOrderDTOOptional
The associated order.
no_notificationbooleanOptional
Whether the customer should receive notifications related to updates on the exchange.
difference_dueBigNumberValueOptional
The difference due of the order 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.
raw_difference_dueBigNumberValueOptional
The raw difference due of the order 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 the variants that are out of stock can be added to the exchange.
returnReturnDTOOptional
The associated return.
return_idstringOptional
The associated return's ID.
created_bynull | stringOptional
The id of the user that created the order exchange
shipping_methodsOrderShippingMethodDTO[]Optional
The shipping methods used to send the additional items.
transactionsOrderTransactionDTO[]Optional
The exchange's transactions if additional payment is required.
created_atstring | DateOptional
The creation date of the exchange.
updated_atstring | DateOptional
The update date of the exchange.
deleted_atstring | DateOptional
The deletion date of the exchange.
canceled_atstring | DateOptional
The cancelation date of the exchange.
Was this page helpful?
Edit this page