- Get Started
- Product
- Resources
- Tools & SDKs
- Framework
- Reference
- Get Started
- Product
- Resources
- Tools & SDKs
- Framework
- Reference
Order Exchange
In this document, you’ll learn about order exchanges.
What is an Exchange?#
An exchange is the replacement of an item that the customer ordered with another.
A merchant creates the exchange, specifying the items to be replaced and the new items to be sent.
The OrderExchange data model represents an exchange.
Returned and New Items#
When the exchange is created, a return, represented by the Return data model, is created to handle receiving the items back from the customer.
The OrderExchangeItem data model represents the new items to be sent to the customer.
Exchange Shipping Methods#
An exchange has shipping methods used to send the new items to the customer. They’re represented by the OrderShippingMethod data model.
The shipping methods for the returned items are associated with the exchange's return, as explained in this guide.
Exchange Payment#
The Exchange
data model has a difference_due
property that stores the outstanding amount.
Condition | Result |
---|---|
| Merchant owes the customer a refund of the |
| Merchant requires additional payment from the customer of the |
| No payment processing is required. |
Any payment or refund made is stored in the Transaction data model.
How Exchanges Impact an Order’s Version#
When an exchange is confirmed, the order’s version is incremented.