> 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/return.md).

# Return

The Order Return Processing API looks up claim targets related to returns and processes claims corresponding to BO requests. This API provides the list of filed returns and supplies the information the screen needs for return processing.

***

## Key Features

* **Return Request**
  * Lets the customer apply for a return of a product.
  * Checks eligibility based on the order progress status (shipping completed, delivery completed).
  * Lets the customer select the return quantity, reason, and pickup location option.
  * Automatically calculates additional payment and refund information.
  * Allows the use of a free return coupon.
* **Return Cancellation**
  * Provides full cancellation while the return is in the requested status.
  * Refunds the amount paid and restores the free return coupon.
* **Return Completion**
  * Provides return processing once the return request has been completed.
  * Restores coupons used at the time of order and reverses product stock.
  * For employee orders, updates the discount limit amount.
* **Return Rejection**
  * After confirming a defective return (20), processes the return as rejected.
  * Allows manual entry of the reason the return is rejected.
* **Return Hold**
  * Allows placing a return on hold due to attributable fault.
  * Allows using a free return coupon when additional payment is required.
* **Return Conversion**
  * Allows converting to a return after an exchanged product is retrieved.
  * The exchange request is withdrawn and the paid amount is refunded.

***

## Process Definition\_Return 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%2FrHBBKzqzhHM0zAVyCRiA%2F%E1%84%8C%E1%85%AE%E1%84%86%E1%85%AE%E1%86%AB%E1%84%87%E1%85%A1%E1%86%AB%E1%84%91%E1%85%AE%E1%86%B71.png?alt=media&#x26;token=c17d1dd3-5443-4a98-a31c-51b077b926d8" alt=""><figcaption></figcaption></figure>

{% stepper %}
{% step %}

### Return Order Inquiry

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

{% step %}

### Return Request Processing Target Inquiry

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

{% step %}

### Claim Cost Calculation Inquiry

Looks up the additional payment amount based on the pickup location and return reason selected by the administrator, and the expected refund amount and method information after the return is completed.
{% endstep %}

{% step %}

### Delivery Number Assignment Processing

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

{% step %}

### Return Request

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

***

## Process Definition\_Return Withdrawal

<figure><img src="https://2999922013-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FXTxKSWMmuxEkop1pvuwe%2Fuploads%2F1kEmB1bRXShgf0JxgvxV%2F%E1%84%8C%E1%85%AE%E1%84%86%E1%85%AE%E1%86%AB%E1%84%87%E1%85%A1%E1%86%AB%E1%84%91%E1%85%AE%E1%86%B72.png?alt=media&#x26;token=c3f2f3f7-15c8-4dfa-a4af-32f48bd95c6f" alt=""><figcaption></figcaption></figure>

{% stepper %}
{% step %}

### Return Withdrawal Target Inquiry

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

{% step %}

### Claim Cost Calculation Inquiry

Looks up the refund amount and refund method information when withdrawing a return.
{% endstep %}

{% step %}

### Return Withdrawal

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

***

## Process Definition\_Return Completion

<figure><img src="https://2999922013-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FXTxKSWMmuxEkop1pvuwe%2Fuploads%2FZLRlazYCCuyZTFgpIn1x%2F%E1%84%8C%E1%85%AE%E1%84%86%E1%85%AE%E1%86%AB%E1%84%87%E1%85%A1%E1%86%AB%E1%84%91%E1%85%AE%E1%86%B73.png?alt=media&#x26;token=d56a97e4-6961-4911-943c-006d06c9451f" alt=""><figcaption></figcaption></figure>

{% stepper %}
{% step %}

### Return Completion Processing Target Inquiry

Looks up the return requests eligible for return completion processing.
{% endstep %}

{% step %}

### Claim Detail Inquiry

Looks up the return request processing history.
{% endstep %}

{% step %}

### Return Completion

Processes the selected return request as completed.
{% endstep %}
{% endstepper %}

***

## Process Definition\_Return Rejection

<figure><img src="https://2999922013-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FXTxKSWMmuxEkop1pvuwe%2Fuploads%2FDOrGjFBhC27wbGpskpze%2F%E1%84%8C%E1%85%AE%E1%84%86%E1%85%AE%E1%86%AB%E1%84%87%E1%85%A1%E1%86%AB%E1%84%91%E1%85%AE%E1%86%B74.png?alt=media&#x26;token=4ccf5ae9-0e1d-4c9d-ba71-f4631dc71023" alt=""><figcaption></figcaption></figure>

{% stepper %}
{% step %}

### Return Completion Processing Target Inquiry

Looks up the return requests eligible for return completion processing.
{% endstep %}

{% step %}

### Claim Detail Inquiry

Looks up the return request processing history.
{% endstep %}

{% step %}

### Return Completion

Processes the selected return request as completed.
{% endstep %}
{% endstepper %}

***

## Process Definition\_Return Conversion

<figure><img src="https://2999922013-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FXTxKSWMmuxEkop1pvuwe%2Fuploads%2Fibwoo8WPqWSV2Hd2r5Ll%2F%E1%84%8C%E1%85%AE%E1%84%86%E1%85%AE%E1%86%AB%E1%84%87%E1%85%A1%E1%86%AB%E1%84%91%E1%85%AE%E1%86%B75.png?alt=media&#x26;token=669c9a39-b325-48e4-be55-6f5e863c12c0" alt=""><figcaption></figcaption></figure>

{% stepper %}
{% step %}

### Return Completion Processing Target Inquiry

Looks up the return requests eligible for return completion processing.
{% endstep %}

{% step %}

### Claim Detail Inquiry

Looks up the return request processing history.
{% endstep %}

{% step %}

### Return Completion

Processes the selected return request as completed.
{% endstep %}
{% endstepper %}

***

## Process Definition\_Return Hold

<figure><img src="https://2999922013-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FXTxKSWMmuxEkop1pvuwe%2Fuploads%2FMj2GQoMVLO3AERHb2yj0%2F%E1%84%8C%E1%85%AE%E1%84%86%E1%85%AE%E1%86%AB%E1%84%87%E1%85%A1%E1%86%AB%E1%84%91%E1%85%AE%E1%86%B76.png?alt=media&#x26;token=b0c71e54-17e7-463c-ae2e-39147a8b2ad7" alt=""><figcaption></figcaption></figure>

{% stepper %}
{% step %}

### Return Hold Processing Target Inquiry

Looks up the return requests eligible for hold processing.
{% endstep %}

{% step %}

### Claim Cost Calculation Inquiry

Looks up the additional payment amount, expected refund amount, and refund method information for a return hold.
{% endstep %}

{% step %}

### Return Hold

Processes the selected return request as on hold.
{% endstep %}
{% endstepper %}

***

## API Function List

<table><thead><tr><th width="97.888916015625">API</th><th width="297.5555419921875">Description</th><th width="93.555419921875">Server</th><th width="91.2222900390625">Method</th><th>Notes</th></tr></thead><tbody><tr><td>Return Request Processing Target Inquiry</td><td>Looks up all products among ordered products that are eligible for return.<br>Looks up the order information and common codes needed to proceed with filing a return request.</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%EB%B0%98%ED%92%88&#x26;path=getReturnTransformPopupBaseInfo">🔗View API ></a> Calls the Return Request Target Inquiry (BO) API (/api/order/v1/claim/return/returnTargetInfo)</td></tr><tr><td>Return Completion Processing Target Inquiry</td><td>Looks up all products among return-requested products that are eligible for return completion processing.<br>Looks up the order information needed to proceed with return completion.</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%EB%B0%98%ED%92%88&#x26;path=getReturnCompletePopupBaseInfo">🔗View API ></a> Calls the Return Request Target Inquiry (BO) API (/api/order/v1/claim/return/returnTargetInfo)</td></tr><tr><td>Return Rejection Target Inquiry</td><td>Looks up all products among return-requested products that are eligible for return rejection processing.<br>Looks up the order information needed to proceed with a return rejection.</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%EB%B0%98%ED%92%88&#x26;path=getReturnRejectPopupInfo">🔗View API ></a> Calls the Return Request Target Inquiry (BO) API (/api/order/v1/claim/return/returnTargetInfo)</td></tr><tr><td>Return Conversion Processing Target Inquiry</td><td>Looks up all products among exchange-requested products that are eligible for return conversion processing.<br>Looks up the order information needed to proceed with return conversion.</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%EB%B0%98%ED%92%88&#x26;path=getReturnTransformPopupBaseInfo">🔗View API ></a> Calls the Return Request Target Inquiry (BO) API (/api/order/v1/claim/return/returnTargetInfo)</td></tr><tr><td>Return Hold Processing Target Inquiry</td><td>Looks up all products among return-requested products that are eligible for hold processing.<br>Looks up the order information needed to proceed with a return hold.</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%EB%B0%98%ED%92%88&#x26;path=getReturnPendingPopupBaseInfo">🔗View API ></a> Calls the Return Request Target Inquiry (BO) API (/api/order/v1/claim/return/returnTargetInfo)</td></tr><tr><td>Return Request</td><td>Proceeds with filing the return request for the selected product.<br>Recalculates and validates costs and benefits based on the product / quantity / pickup location / return reason / coupon usage specified by the administrator.<br>If any additional amount is incurred during the return process, the status changes to payment pending,<br>and the customer is later asked to pay the delivery fee.<br>When a free return coupon is used, the pickup delivery fee is waived and the coupon is marked as used.<br>A delivery fee payment notification is sent to the customer once the return request is completed.</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%EB%B0%98%ED%92%88&#x26;path=acceptReturn">🔗View API ></a> Calls the Return Request (BO) API (/api/order/v1/claim/return/acceptReturn)</td></tr><tr><td>Return Withdrawal</td><td>Withdraws a return request.<br>Refunds the cost paid at the time of the return request.<br>Restores the free return coupon used at the time of the return request.</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%EB%B0%98%ED%92%88&#x26;path=acceptReturn">🔗View API ></a> Calls the Return Withdrawal (BO) API (/api/order/v1/claim/return/withdrawalReturn)</td></tr><tr><td>Return Rejection</td><td>Withdraws a return request and changes the status so that it cannot be re-requested.<br>Refunds the cost paid at the time of the return request.<br>Restores the free return coupon used at the time of the return request.</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%EB%B0%98%ED%92%88&#x26;path=acceptReturn">🔗View API ></a> Calls the Return Rejection (BO) API (/api/order/v1/claim/return/rejectReturn)</td></tr><tr><td>Return Completion</td><td>Processes a return request whose pickup has been completed as fully completed.<br>Restores the coupon and stock used at the time of order, and refunds the order amount.<br>Sends a notification to the customer after the return is completed.</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%EB%B0%98%ED%92%88&#x26;path=completeReturn">🔗View API ></a> Calls the Return Completion (BO) API (/api/order/v1/claim/return/completeReturn)</td></tr><tr><td>Return Conversion</td><td>Files a return for a product retrieved during an exchange as attributable to the company.<br>Withdraws the exchange in progress and refunds any amount incurred at the time of the exchange request.<br>Restores the stock deducted at the time of the exchange request.</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%EB%B0%98%ED%92%88&#x26;path=transformReturn">🔗View API ></a> Calls the Return During Exchange (BO) API (/api/order/v1/claim/return/transformReturn)</td></tr><tr><td>Return Hold</td><td>When a return product filed as attributable to the company is determined, during the pickup confirmation process, to actually be attributable to the customer,<br>recalculates any uncharged cost based on the fault reason and modifies the request information.<br>If additional cost is incurred as a result of the recalculation, asks the customer to pay the delivery fee.<br>If the return can proceed without additional payment, processes it as pickup completed.</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%EB%B0%98%ED%92%88&#x26;path=returnPending">🔗View API ></a> Calls the Return Hold (BO) API (/api/order/v1/claim/return/returnPending)</td></tr><tr><td>Return Order Inquiry</td><td>Looks up the return 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%EB%B0%98%ED%92%88&#x26;path=getReturnOrderList">🔗View API ></a></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>Common Claim API</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>Common Claim API</td></tr><tr><td>Claim Detail Inquiry</td><td>Looks up claim detail information.<br>Provides order information, claim target information, refund/payment details, coupons pending restoration, and delivery address information.</td><td>BO</td><td>POST</td><td>Common Claim API</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>Order Exchange</td></tr></tbody></table>

***

## Other Notes

* Return requests can only be filed within the same delivery group.
* When filing or canceling a return 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
* When looking up return targets, the product attribute “Return Eligibility” value is checked.
* Return 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 return is not possible.
* If a payment method that does not allow partial cancellation was used at the time of order, only a full order return is possible.
* If there is an existing return request history within the same delivery group for which an initial delivery fee has already been charged, and that return request is still in a cancelable status, an additional return request cannot be filed.
* When filing a return request that incurs an initial delivery fee, if there is a cancelable return history within the same delivery group, an additional return request cannot be filed.
* If additional payment is incurred when filing a return request, the status changes to payment pending only when the payment amount is greater than the expected refund amount; otherwise, it is deducted from the refund amount.
* When canceling a return request in the pickup-instructed status, the delivery instruction cancellation quantity is updated.
* The manually entered reasons for return rejection and return hold are saved as the pickup-completion-pending reason in the order delivery information.
* When viewing the return list, partner-access administrators only see the requests submitted by their own partner company.

***