> 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/store-front/order/claim-common.md).

# Claim Common

Provides features required for the overall claim operations of customers who have purchased products.

***

### Key Features

* **Claim Detail Information**
  * Provides detailed additional payment/refund amount information and refund method information during claim processing.
  * Provides coupon usage/restoration information and return coupon usage list information to transparently manage claim history.
* **Delivery and Benefit Data**
  * Provides detailed delivery fee and benefit data for claims so that customers and administrators can easily understand them.
* **Delivery Number Issuance Information**
  * When a new delivery/return address is created during claim processing, delivery number issuance information is provided to support accurate management.
* **Image Upload Support**
  * When image upload is required during claim processing, image upload information is provided to support smooth processing.
* **Claim Delivery Fee Payment Information**
  * Provides additional payment information for claim delivery fee payment. This is used when a claim is received in BO and additional payment is made in FO.
* **Post-Claim-Processing Detail Information**
  * After claim processing, provides details for the detail screens. Based on the order number and claim number, it comprehensively presents order history information, claim product information, refund/payment history, coupons pending refund, delivery address information, and more.
* **Additional Payment for Claims in Payment Pending Status**
  * Provides the ability to process additional delivery fee payment for claims in Payment Pending status and update the order history status.

### API Function List

<table><thead><tr><th width="122.333251953125">API</th><th width="398.22216796875">Description</th><th width="96.888916015625">Server</th><th width="90.22216796875">Method</th><th>Remarks</th></tr></thead><tbody><tr><td>Claim Cost Calculation Lookup</td><td>Retrieves the claim cost calculation. Provides additional payment/refund amount information and refund method information for each claim task screen. When processing claim tasks, provides additional cost and benefit information based on the DB, additional payment/refund pending data creation information, and coupon usage/restoration information.</td><td>Order</td><td>POST</td><td>FO: <a href="http://api.x2bee.com/content?msa=order&#x26;depth=%ED%81%B4%EB%A0%88%EC%9E%84%EA%B3%B5%ED%86%B5&#x26;path=calculateFO">🔗View API ></a> BO: <a href="http://api.x2bee.com/content?msa=order&#x26;depth=%ED%81%B4%EB%A0%88%EC%9E%84%EA%B3%B5%ED%86%B5&#x26;path=calculate">🔗View API ></a></td></tr><tr><td>Claim Detail Lookup</td><td>Retrieves the claim detail history. Provides the claim details corresponding to the requested order number and claim number. Provides order history information, claim product information, refund/payment history, coupons pending refund, and delivery address information.</td><td>Order</td><td>POST</td><td>FO: <a href="http://api.x2bee.com/content?msa=order&#x26;depth=%ED%81%B4%EB%A0%88%EC%9E%84%EA%B3%B5%ED%86%B5&#x26;path=getClaimDetailsInfoFO">🔗View API ></a> BO: <a href="http://api.x2bee.com/content?msa=order&#x26;depth=%ED%81%B4%EB%A0%88%EC%9E%84%EA%B3%B5%ED%86%B5&#x26;path=getClaimDetailsInfo">🔗View API ></a></td></tr><tr><td>Delivery Number<br>Issuance List<br>Lookup</td><td>Retrieves the delivery number issuance list.</td><td>Order</td><td>POST</td><td><a href="http://api.x2bee.com/content?msa=order&#x26;depth=%ED%81%B4%EB%A0%88%EC%9E%84%EA%B3%B5%ED%86%B5&#x26;path=getNewNumberedDeliNo">🔗View API ></a></td></tr><tr><td>Image<br>Upload Processing</td><td>Processes S3 image uploads. Upon completion of upload, provides the order number, order sequence number, order processing sequence number, file URL, and file name.</td><td>Order</td><td>POST</td><td><a href="http://api.x2bee.com/content?msa=order&#x26;depth=%ED%81%B4%EB%A0%88%EC%9E%84%EA%B3%B5%ED%86%B5&#x26;path=claimImgUpload">🔗View API ></a></td></tr><tr><td>Claim Additional Payment Information<br>Lookup</td><td>Retrieves the information needed for the claim additional payment. Retrieves the list of available primary and secondary payment methods. If logged-in member information exists, the available mileage information is also included in the secondary payment method list.</td><td>Order</td><td>POST</td><td><a href="http://api.x2bee.com/content?msa=order&#x26;depth=%ED%81%B4%EB%A0%88%EC%9E%84%EA%B3%B5%ED%86%B5&#x26;path=getAdditionalFeePaymentInfo">🔗View API ></a></td></tr><tr><td>Claim<br>Delivery Fee Payment-Pending Status<br>Target Information</td><td>Retrieves the claim delivery fee payment-pending target information in FO. The order number and claim number are required. Retrieves the additional delivery fee and product list of the return/exchange claim.</td><td>Order</td><td>POST</td><td><a href="http://api.x2bee.com/content?msa=order&#x26;depth=%ED%81%B4%EB%A0%88%EC%9E%84%EA%B3%B5%ED%86%B5&#x26;path=getClaimPayWaitStateInfo">🔗View API ></a></td></tr><tr><td>Claim<br>Delivery Fee Payment Processing</td><td>Processes additional delivery fee payment for claims in Payment Pending status and updates the order history status. If the target claim is Return Held, the order history status is updated to Retrieval Completed; if it is a return or exchange that is not Return Held, the order history status is updated to Received. Saves the payment approval information for the target claim's delivery fee.</td><td>Order</td><td>POST</td><td><a href="http://api.x2bee.com/content?msa=order&#x26;depth=%ED%81%B4%EB%A0%88%EC%9E%84%EA%B3%B5%ED%86%B5&#x26;path=doPayDeliveryFee">🔗View API ></a></td></tr></tbody></table>

## Other Notes

* When receiving or withdrawing a claim, additional cost, benefit, and refund information is retrieved using the claim cost calculation lookup; however, for tasks that later change the claim status (e.g., return completion), claim processing is done via the claim detail lookup.
* When uploading images, the extension is restricted to .png, .bmp, jpeg, and gif.
* If the image upload has already succeeded and the file information has been received before the claim receipt processing, only the information is saved to the DB during receipt processing.
