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

# Order Cancellation

Provides the ability to cancel ordered products. This lets customers check which items are eligible for cancellation and provides the information needed for customers to cancel their orders.

***

## Key Features

* **Provides Order Cancellation**
  * Provides a simple way to cancel ordered products.
  * Lets customers check which items are eligible for cancellation and select the product and quantity to cancel.
* **Guidance Based on Cancellation Reason and Delivery Fee**
  * Additional payment may be required depending on the cancellation reason and delivery fee policy.
  * However, if additional payment is required, the customer can cancel the order directly.
* **Refund Processing**
  * Refunds the canceled order amount.
  * Restores coupons used at the time of order and reverses deducted stock.
* **Notification Email and Message Delivery**
  * Sends a notification email and message (AlimTalk/notification inbox) to the customer upon cancellation completion.

## Process Definition

<figure><img src="https://2999922013-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FXTxKSWMmuxEkop1pvuwe%2Fuploads%2FvqZpSWYGvi6NUiYQzc3o%2F%E1%84%8C%E1%85%AE%E1%84%86%E1%85%AE%E1%86%AB%E1%84%8E%E1%85%B1%E1%84%89%E1%85%A9.png?alt=media&#x26;token=9727a3c6-9bdc-4d46-80de-b2bf4623f260" alt=""><figcaption></figcaption></figure>

{% stepper %}
{% step %}

### Order Cancellation History Inquiry

Looks up the order cancellation history matching the selected and entered search conditions.
{% endstep %}

{% step %}

### Order Cancellation Popup Information Inquiry

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

{% step %}

### Claim Cost Calculation Inquiry

Looks up the payment amount incurred, the expected refund amount, and the refund method information when canceling an order.
{% endstep %}

{% step %}

### Order Cancellation Processing (BO)

Cancels the order for the selected product.
{% endstep %}
{% endstepper %}

## API Function List

<table><thead><tr><th width="104.5556640625" valign="top">API</th><th width="305.5555419921875" valign="top">Description</th><th width="102.4443359375" valign="top">Server</th><th width="89.111083984375" valign="top">Method</th><th>Notes</th></tr></thead><tbody><tr><td valign="top">Order Cancellation Popup Information Inquiry (BO)</td><td valign="top">Looks up the products among ordered items that are eligible for cancellation.<br>Looks up the order information and common codes needed to proceed with order cancellation.</td><td valign="top">BO</td><td valign="top">POST</td><td><p><a href="http://apibo.x2bee.com/content?bo=claim&#x26;depth=%EC%A3%BC%EB%AC%B8%EC%B7%A8%EC%86%8C&#x26;path=getOrderCancelPopupInfo">🔗View API ></a></p><ol start="1"><li>Calls the Order Cancellation Target Inquiry (BO) API</li></ol><p>(/api/order/v1/claim/orderCancel/cancelPopup)</p></td></tr><tr><td valign="top">Order Cancellation History Inquiry</td><td valign="top">Looks up the order cancellation history matching the conditions.</td><td valign="top">BO</td><td valign="top">POST</td><td><a href="http://apibo.x2bee.com/content?bo=claim&#x26;depth=%EC%A3%BC%EB%AC%B8%EC%B7%A8%EC%86%8C&#x26;path=getOrderCancelList">🔗View API ></a></td></tr><tr><td valign="top">Order Cancellation Processing (BO)</td><td valign="top">Cancels the order. Additional payment may be required depending on the cancellation reason, in which case order cancellation cannot proceed. (Only the customer can cancel directly in this case.) Restores coupons used at the time of order and reverses deducted stock. Refunds the order amount. Sends a notification to the customer after order cancellation is completed.</td><td valign="top">BO</td><td valign="top">POST</td><td><p><a href="http://apibo.x2bee.com/content?bo=claim&#x26;depth=%EC%A3%BC%EB%AC%B8%EC%B7%A8%EC%86%8C&#x26;path=cancelOrder">🔗View API ></a></p><ol start="1"><li>Calls the Order Cancellation (BO) API (/api/order/v1/claim/orderCancel/cancel)</li></ol></td></tr><tr><td valign="top">Claim<br>Cost Calculation Inquiry</td><td valign="top">Provides additional cost, benefit information, expected additional payment/refund amount, and coupon usage/restoration information for each claim task.</td><td valign="top">BO</td><td valign="top">POST</td><td></td></tr></tbody></table>

## Other Notes

* Order cancellation is only possible within the same delivery group.
* The order history status codes and order history classification codes eligible for order cancellation are managed as common codes.\
  : 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
* For products that include a gift, partial-quantity cancellation is not possible.
* If a payment method that does not allow partial cancellation was used at the time of order, only full cancellation is possible.
* If additional payment is required for the cancellation, the cancellation request cannot be accepted.
* Coupons used at the time of order are restored only when all applicable products are canceled.
* Stock deducted at the time of order is adjusted (increased) upon cancellation.
* If cancellation is processed after the delivery instruction status, the delivery instruction quantity is updated.
* For employee orders, the discount limit amount is updated.
* When viewing the cancellation list, partner-access administrators only see the requests submitted by their own partner company.
