> For the complete documentation index, see [llms.txt](https://tech.x2bee.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://tech.x2bee.com/api-guide/api-guides-en/back-office/claim-bo/exchange.md).

# Exchange

Provides an exchange service for products ordered by customers. It supports the exchange process for products whose orders have been completed, and also provides the ability to cancel an exchange while it is in progress. Once an exchange request is completed through this API, a notification about the exchange processing is sent to the customer.

## Key Features

* **Exchange-Eligible Product Inquiry**
  * Looks up products eligible for exchange among ordered/exchanged products, based on the order progress status (shipping completed or delivery completed).
* **Exchange Request Eligibility Check**
  * Determines whether the selected single item option is eligible for exchange when filing an exchange request.
* **Withdrawal-Eligible Product Inquiry**
  * Looks up products eligible for withdrawal, based on the exchange request progress status (payment pending, requested, or pickup instructed).
* **Exchange Information Provision**
  * Provides the information needed when filing or withdrawing an exchange request.
* **Additional Cost and Payment/Refund Information Provision**
  * Provides the recalculated additional cost, benefit, and expected payment/refund exchange delivery cost information when filing or withdrawing an exchange request.
* **Exchange Delivery Fee Management**
  * If an exchange delivery fee is incurred when filing an exchange request, the status changes to payment pending and the customer is later asked to pay the delivery fee.
  * When an exchange is canceled, the paid exchange delivery fee is refunded.
* **Stock Processing**
  * When an exchange request is filed, stock for the exchanged product is deducted; upon cancellation, the stock is restored.
* **Notification Delivery**
  * Sends a notification to the customer after the exchange request is completed. (Email/AlimTalk/notification inbox)

***

## Process Definition — Exchange Request Filing and List Inquiry

<figure><img src="https://2999922013-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FXTxKSWMmuxEkop1pvuwe%2Fuploads%2FwSbNSU6c4CFUmkPhoCEf%2F%E1%84%8C%E1%85%AE%E1%84%86%E1%85%AE%E1%86%AB%E1%84%80%E1%85%AD%E1%84%92%E1%85%AA%E1%86%AB1.png?alt=media&#x26;token=17e99350-222d-4211-b7f7-2f49c1679f69" alt=""><figcaption></figcaption></figure>

{% stepper %}
{% step %}

### Exchange Order List Inquiry

Looks up the exchange request history matching the selected and entered search conditions.
{% endstep %}

{% step %}

### Order Exchange Target Inquiry

Looks up the list of products eligible for exchange among ordered products and displays them in the exchange request popup.
{% endstep %}

{% step %}

### Claim Cost Calculation Inquiry

Looks up the additional payment cost based on the exchange reason.
{% endstep %}

{% step %}

### Exchange Claim Option Change Target Check

Checks whether the single item option to be exchanged is eligible for exchange.
{% endstep %}

{% step %}

### Delivery Number Assignment Processing

Issues a new delivery number for the pickup/delivery location to be used when filing the exchange request.
{% endstep %}

{% step %}

### Exchange Request

Proceeds with filing the exchange request for the selected product.
{% endstep %}
{% endstepper %}

***

## Process Definition — Exchange Withdrawal

<figure><img src="https://2999922013-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FXTxKSWMmuxEkop1pvuwe%2Fuploads%2F2QnhfJ1BUPz6ecLPSuXD%2F%E1%84%8C%E1%85%AE%E1%84%86%E1%85%AE%E1%86%AB%E1%84%80%E1%85%AD%E1%84%92%E1%85%AA%E1%86%AB2.png?alt=media&#x26;token=92e48d86-735b-423c-adac-22212c2b42ea" alt=""><figcaption></figcaption></figure>

{% stepper %}
{% step %}

### Exchange Withdrawal Target Inquiry

Looks up all exchange requests eligible for withdrawal.
{% endstep %}

{% step %}

### Claim Cost Calculation Inquiry

Looks up the refund amount and refund method information when withdrawing an exchange.
{% endstep %}

{% step %}

### Exchange Request Withdrawal

Withdraws the selected exchange request.
{% endstep %}
{% endstepper %}

***

## API Function List

<table><thead><tr><th width="140.111083984375">API</th><th width="267.6666259765625">Description</th><th width="93.5556640625">Server</th><th width="90.22216796875">Method</th><th>Notes</th></tr></thead><tbody><tr><td>Exchange Request Withdrawal</td><td>Withdraws an exchange request.<br>Refunds the amount paid at the time of the exchange request. Adjusts (restores) the stock that was deducted at the time of the exchange request.</td><td>BO</td><td>POST</td><td><p><a href="http://apibo.x2bee.com/content?bo=claim&#x26;depth=%EC%A3%BC%EB%AC%B8%EA%B5%90%ED%99%98&#x26;path=withdrawalExchange">🔗View API ></a></p><ol start="1"><li>Calls the Exchange Request Withdrawal (BO) API (/api/order/v1/claim/exchange/withdrawalExchange)</li></ol></td></tr><tr><td>Exchange Claim Option Change Target Check</td><td>When filing an exchange request, looks up whether the single item<br>option to be exchanged is eligible for exchange.</td><td>BO</td><td>POST</td><td><p><a href="http://apibo.x2bee.com/content?bo=claim&#x26;depth=%EC%A3%BC%EB%AC%B8%EA%B5%90%ED%99%98&#x26;path=isExistsExchangeGoodsItm">🔗View API ></a></p><ol start="1"><li>Calls the Exchange Target Product Option Change Eligibility Check API (/api/order/v1/claim/exchange/isExistsExchangeGoodsItm)</li></ol></td></tr><tr><td>Return/Exchange Withdrawal Target Inquiry</td><td>Looks up return and exchange requests that are eligible for withdrawal.</td><td>BO</td><td>POST</td><td><p><a href="http://apibo.x2bee.com/content?bo=claim&#x26;depth=%EC%A3%BC%EB%AC%B8%EA%B5%90%ED%99%98&#x26;path=getReturnExchangeCancelTargetInfo">🔗View API ></a></p><ol start="1"><li>Calls the Return/Exchange Withdrawal Target Inquiry API (/api/order/v1/claim/common/getReturnExchangeCancelTargetInfo)</li></ol></td></tr><tr><td>Exchange Order List Inquiry</td><td>Looks up exchange request history matching the conditions.</td><td>BO</td><td>POST</td><td><a href="http://apibo.x2bee.com/content?bo=claim&#x26;depth=%EC%A3%BC%EB%AC%B8%EA%B5%90%ED%99%98&#x26;path=getExchangeOrderList">🔗View API ></a></td></tr><tr><td>Order Exchange Target Inquiry</td><td>Looks up products eligible for exchange among ordered products.<br>Looks up the order information and common codes needed to proceed with filing an exchange request.</td><td>BO</td><td>POST</td><td><p><a href="http://apibo.x2bee.com/content?bo=claim&#x26;depth=%EC%A3%BC%EB%AC%B8%EA%B5%90%ED%99%98&#x26;path=getExchageTargetInfo">🔗View API ></a></p><ol start="1"><li>Calls the Exchange Target Inquiry (BO) API (/api/order/v1/claim/exchange/getExchageTargetInfo)</li></ol></td></tr><tr><td>Exchange Request</td><td>Proceeds with filing an exchange request for the selected product. Depending on the exchange reason, an exchange delivery fee may be charged; if a cost is incurred, the request is saved in payment-pending status,<br>and the customer is later asked to pay the delivery fee.<br>Stock for the exchanged product is deducted, and a notification is sent to the customer once the exchange request is completed.</td><td>BO</td><td>POST</td><td><p><a href="http://apibo.x2bee.com/content?bo=claim&#x26;depth=%EC%A3%BC%EB%AC%B8%EA%B5%90%ED%99%98&#x26;path=acceptExchange">🔗View API ></a></p><ol start="1"><li>Calls the Exchange Request (BO) API (/api/order/v1/claim/exchange/acceptExchange)</li></ol></td></tr><tr><td>Claim Cost Calculation Inquiry</td><td>Provides additional cost, benefit information, expected additional payment/refund amount, and<br>coupon usage/restoration information for each claim task.</td><td>BO</td><td>POST</td><td></td></tr><tr><td>Delivery Number Assignment Processing</td><td>Assigns the new delivery number required when processing claim tasks.</td><td>BO</td><td>POST</td><td></td></tr></tbody></table>

***

## Other Notes

* Exchange requests can only be filed within the same delivery group.
* When filing or canceling an exchange request, the processable order history status and order history classification values are checked. This information is managed as a common code.\
  → ST007 (FO system claim-processable status) reference value 1 = order history status code\
  → ST007 (FO system claim-processable status) reference value 2 = order history classification code
* Exchange reasons are managed as a common code, and include information such as the fault classification and the applicable order history classification for each reason.
* For products that include a gift, partial-quantity exchange is not possible.
* If a payment method that does not allow partial cancellation was used at the time of order, only a full exchange is possible.
* Exchange is only possible for general products (reserved products are not eligible) that are on sale at the same price.
* Exchange is not possible if the product is out of stock.
* If the exchange reason is attributable to the customer, an exchange delivery fee is charged.
* If an exchange delivery fee is incurred, the order status is registered as payment pending, and the request proceeds once the customer pays the delivery fee directly.
* When an exchange request is canceled, the paid exchange delivery fee is refunded.
* When an exchange request is filed, stock for the exchanged product is deducted, and it is restored upon cancellation.
* When canceling an exchange in the pickup-instructed status, the delivery instruction cancellation quantity is updated.
* When viewing the exchange list, partner-access administrators only see the requests submitted by their own partner company.

***