> 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/api-en/back-office-api-reference/claim-bo-api/claim-common.md).
# Claim Common
## Retrieve Changeable Item (SKU) List
> \## Function Description\
> \* Retrieves the list of changeable items (SKUs)\
> \
\
> \
\
> \---\
> \## Detailed Content\
> \* Provides the list of changeable items when changing the item of an order/exchange target product\
> \* Calls the Product API ( API URL : \*\*/api/goods/v1/detail/otherItms\*\* )
```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ClaimItmOtherInfoRequest":{"type":"object","description":"Order Changed SKU List Search Request DTO","properties":{"goodsNo":{"type":"string","description":"Product No."},"itmNo":{"type":"array","description":"Item No. List","items":{"type":"string"}},"stkQty":{"type":"integer","format":"int64","description":"Stock Quantity"}}},"ClaimItmOtherInfoListResponse":{"type":"object","description":"Order Change Item (SKU) List Inquiry DTO","properties":{"goodsNo":{"type":"string","description":"Product No."},"reqIteNo":{"type":"string","description":"Item No. to Change"},"itmNos":{"type":"array","description":"Item No. List","items":{"$ref":"#/components/schemas/ClaimItmOtherInfoResponse"}}}},"ClaimItmOtherInfoResponse":{"type":"object","properties":{"goodsNo":{"type":"string","description":"Product No."},"itmNo":{"type":"string","description":"Item No."},"itmNm":{"type":"string","description":"Item Name"},"stkQty":{"type":"integer","format":"int64","description":"Remaining Quantity"},"supPcost":{"type":"number","description":"Supply Price"},"norPrc":{"type":"number","description":"Regular Price"},"salePrc":{"type":"number","description":"Selling Price"},"tsalePrc":{"type":"number","description":"Final Sale Price"},"tsupPrc":{"type":"number","description":"Final Supply Cost"}}}}},"paths":{"/v1/claim/claimCommon/itmListOtherInfo":{"post":{"tags":["Claim Common"],"summary":"Retrieve Changeable Item (SKU) List","description":"## Function Description\n* Retrieves the list of changeable items (SKUs)\n
\n
\n---\n## Detailed Content\n* Provides the list of changeable items when changing the item of an order/exchange target product\n* Calls the Product API ( API URL : **/api/goods/v1/detail/otherItms** )\n","operationId":"itmListOtherInfo","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ClaimItmOtherInfoRequest"}}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ClaimItmOtherInfoListResponse"}}}}}}}}}}
```
## Retrieve Delivery Number Issuance List
> \## Function Description\
> \* Retrieves the delivery number issuance list\
> \---\
> \## Detailed Content\
> \* Issues new delivery numbers for as many entries as the length of the delivery number list (dlvpList) in the request data\
> \* Returns the list of issued delivery numbers as the result data\
> \* Calls the Delivery Number Issuance List Inquiry API ( API URL : \*\*/api/order/v1/claim/common/getNewNumberedDeliNo\*\* )
```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ClaimDeliNoRequest":{"type":"object","description":"Claim Delivery No. Request DTO","properties":{"dlvpList":{"type":"array","description":"Delivery No. List","items":{"type":"string"}}}}}},"paths":{"/v1/claim/claimCommon/getNewNumberedDeliNo":{"post":{"tags":["Claim Common"],"summary":"Retrieve Delivery Number Issuance List","description":"## Function Description\n* Retrieves the delivery number issuance list\n---\n## Detailed Content\n* Issues new delivery numbers for as many entries as the length of the delivery number list (dlvpList) in the request data\n* Returns the list of issued delivery numbers as the result data\n* Calls the Delivery Number Issuance List Inquiry API ( API URL : **/api/order/v1/claim/common/getNewNumberedDeliNo** )\n","operationId":"getNewNumberedDeliNo","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClaimDeliNoRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"type":"string"}}}}}}}}}}
```
## Retrieve Claim Detail History
> \## Function Description\
> \* Retrieves claim detail history\
> \
\
> \
\
> \---\
> \## Detailed Content\
> \* Provides the claim detail history corresponding to the requested order number and claim number\
> \* Provides order history information, claim product information, refund/payment history, coupons scheduled for refund, and delivery address information\
> \* Calls the Claim Detail History Inquiry API ( API URL : \*\*/api/order/v1/claim/common/claimDetailsInfo\*\* )
```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ClaimDetailsInfoRequest":{"type":"object","description":"Claim Detail Search Request DTO","properties":{"ordNo":{"type":"string","description":"Order No."},"claimNo":{"type":"string","description":"Claim No."},"claimBusinessType":{"type":"string","description":"Claim Business Type","enum":["ORDER_CANCEL","RETURN_ACCEPT","RETURN_WITHDRAWAL","EXCHANGE_ACCEPT","EXCHANGE_WITHDRAWAL","RETURN_COMPLETE","RETURN_REJECT","RETURN_TRANSFORM"]}}},"ClaimDetailsInfoResponse":{"type":"object","description":"Claim Detail Search Response DTO","properties":{"claimFinalAmtInfo":{"$ref":"#/components/schemas/ClaimFinalAmtInfo","description":"Additional Payment/Refund Amount Information"}}},"ClaimFinalAmtInfo":{"type":"object","description":"Claim Final Payment/Refund Amount Information DTO","properties":{"ordNo":{"type":"string","description":"Order No."},"totAplyAdtnAmt":{"type":"integer","format":"int64","description":"Total Delivery Fee Incurred Amount"},"totCnclAdtnAmt":{"type":"integer","format":"int64","description":"Total Cancelled Delivery Fee Amount"},"totFvrAdtnAmt":{"type":"integer","format":"int64","description":"Total Benefit Delivery Fee Amount"},"totOrdPrc":{"type":"integer","format":"int64","description":"Claim Product Amount"},"totDcAmt":{"type":"integer","format":"int64","description":"Claim Cancellation Discount Amount"},"expectedRefundAmt":{"type":"integer","format":"int64","description":"Expected Refund Amount"},"addtionPayAmt":{"type":"integer","format":"int64","description":"Additional Payment Amount"},"returnAcceptAmt":{"type":"integer","format":"int64","description":"Return Received Amount"},"refundAdditionAmtInfoList":{"type":"array","description":"Additional Payment/Refund Information List","items":{"$ref":"#/components/schemas/RefundAdditionAmtInfo"}},"refundPaymentMethodList":{"type":"array","description":"Refund Payment Information List","items":{"$ref":"#/components/schemas/PaymentClaimResponse"}},"rfdInfoResponse":{"$ref":"#/components/schemas/RfdInfoResponse","description":"Refund Account Information"}}},"RefundAdditionAmtInfo":{"type":"object","description":"Additional Payment/Refund Information DTO","properties":{"adtnOcurGbCd":{"type":"string","description":"Additional Cost Occurrence Classification Code (OM017)"},"adtnOcurGbNm":{"type":"string","description":"Additional Cost Occurrence Type Name"},"type":{"type":"string","description":"Type Classification","enum":["DELIVERY_FEE","RETURN_FEE","EXCHANGE_FEE","GOODS","EXTRA_FEE"]},"typeNm":{"type":"string","description":"Type Classification Name"},"goodsNoItmNo":{"type":"string","description":"Product No.+SKU No."},"goodsNm":{"type":"string","description":"Product Name"},"ordAmt":{"type":"number","description":"Payment Amount"},"discountMethod":{"type":"string","description":"Benefit Detail Information (OM019)"},"discountMethodNm":{"type":"string","description":"Benefit Detail Information Name"},"cnclDcAmt":{"type":"integer","format":"int64","description":"Cancellation Benefit Amount"},"rtnDlvBenefitInfoList":{"type":"array","description":"Return Coupon Information List","items":{"$ref":"#/components/schemas/ClaimDlvBenefitInfo"}}}},"ClaimDlvBenefitInfo":{"type":"object","description":"Claim Coupon Information DTO","properties":{"promoNo":{"type":"string","description":"Coupon No."},"promoNm":{"type":"string","description":"Coupon Name"},"promoTypCd":{"type":"string","description":"Coupon Type (MK002)"},"ourChrgRate":{"type":"integer","format":"int32","description":"Company Cost-Sharing Rate"},"entrChrgRate":{"type":"integer","format":"int32","description":"Vendor Cost-Sharing Rate"},"cpnIsuNo":{"type":"string","description":"Coupon Issuance No."},"aplyYn":{"type":"string","description":"Application Status","enum":["Y","N"]}}},"PaymentClaimResponse":{"type":"object","description":"Refundable Payment Method DTO","properties":{"payNo":{"type":"string","description":"Payment Number"},"ordNo":{"type":"string","description":"Order No."},"claimNo":{"type":"string","description":"Claim No."},"uprPayNo":{"type":"string","description":"Parent Payment No."},"payGbCd":{"type":"string","description":"Payment Classification Code (OM012)"},"payGbCdNm":{"type":"string","description":"Payment Classification Code Name (OM012)"},"payWayCd":{"type":"string","description":"Payment Method Code (OM013)"},"payWayCdNm":{"type":"string","description":"Payment Method Code Name (OM013)"},"payStatCd":{"type":"string","description":"Payment Status Code (OM014)"},"payStatCdNm":{"type":"string","description":"Payment Status Code Name (OM014)"},"payAmt":{"type":"number","description":"Payment Amount"},"rfdPsbAmt":{"type":"number","description":"Refundable Amount"},"rfdAmt":{"type":"number","description":"Refund Amount"},"payFnshDtm":{"type":"string","format":"date-time","description":"Payment Completion Date/Time"},"trdNo":{"type":"string","description":"Transaction No. (tid)"},"trdDtm":{"type":"string","format":"date-time","description":"Transaction Date/Time"},"iscmCd":{"type":"string","description":"Issuer Code (OM027)"},"iscmCdNm":{"type":"string","description":"Issuer Code Name (OM027)"},"payReqCardcoCd":{"type":"string","description":"Payment Request Card Company Code (OM057)"},"payReqCardcoCdNm":{"type":"string","description":"Payment Request Card Company Code Name (OM057)"},"cardNo":{"type":"string","description":"Card No."},"cardNm":{"type":"string","description":"Card Name"},"cardValiTerm":{"type":"string","description":"Card Expiration Date"},"nintDivYn":{"type":"string","description":"Interest-Free Installment Status"},"divMonCnt":{"type":"integer","format":"int32","description":"Installment Months"},"cardPointUseYn":{"type":"string","description":"Card Points Usage Status"},"mersNo":{"type":"string","description":"Merchant Number"},"acqrCd":{"type":"string","description":"Purchasing Company Code (OM028)"},"acqrCdNm":{"type":"string","description":"Acquirer Code Name (OM028)"},"aprvNo":{"type":"string","description":"Approval No."},"aprvDtm":{"type":"string","format":"date-time","description":"Approval Date/Time"},"sctnCnclPsbYn":{"type":"string","description":"Partial Cancellation Availability Status"},"bankCd":{"type":"string","description":"Bank Code (OM026)"},"bankCdNm":{"type":"string","description":"Bank Code Name (OM026)"},"actnNo":{"type":"string","description":"Account Number"},"dpmnNm":{"type":"string","description":"Depositor Name"},"dptFcstDt":{"type":"string","description":"Scheduled Deposit Date"},"dptCnfmDtm":{"type":"string","format":"date-time","description":"Deposit Confirmation Date/Time"},"rfdBankCd":{"type":"string","description":"Refund Bank Code (OM026)"},"rfdBankCdNm":{"type":"string","description":"Refund Bank Code Name (OM026)"},"rfdActnNo":{"type":"string","description":"Refund Account No."},"rfdActnDepositorNm":{"type":"string","description":"Refund Account Holder Name"}}},"RfdInfoResponse":{"type":"object","description":"Refund Account Information Retrieval Response","properties":{"rfdBankCd":{"type":"string","description":"Bank Code (OM026)"},"rfdBankNm":{"type":"string","description":"Bank Name"},"rfdActnNo":{"type":"string","description":"Refund Account No."},"rfdActnDepositorNm":{"type":"string","description":"Refund Account Holder Name"},"rfdActnCertiYn":{"type":"string","description":"Refund Account Verification Status"}}}}},"paths":{"/v1/claim/claimCommon/claimDetailsInfo":{"post":{"tags":["Claim Common"],"summary":"Retrieve Claim Detail History","description":"## Function Description\n* Retrieves claim detail history\n
\n
\n---\n## Detailed Content\n* Provides the claim detail history corresponding to the requested order number and claim number\n* Provides order history information, claim product information, refund/payment history, coupons scheduled for refund, and delivery address information\n* Calls the Claim Detail History Inquiry API ( API URL : **/api/order/v1/claim/common/claimDetailsInfo** )\n","operationId":"claimDetailsInfo","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClaimDetailsInfoRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ClaimDetailsInfoResponse"}}}}}}}}}
```
## Retrieve Claim Cost Calculation
> \## Function Description\
> \* Retrieves the claim cost calculation\
> \
\
> \
\
> \---\
> \## Detailed Content\
> \* Provides additional payment/refund amount information and refund method information for the screen by claim task\
> \* Provides information for generating additional payment/refund scheduled data based on DB-level additional costs and benefit information, and coupon use/restoration information, during claim task processing\
> \* Calls the BO Claim Cost Calculation Inquiry API ( API URL : \*\*/api/order/v1/claim/common/claimCalculateCost\*\* )
```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ClaimCalculateRequest":{"type":"object","description":"Claim Cost Calculation Search Request DTO","properties":{"ordNo":{"type":"string","description":"Order No.","minLength":1},"ordMediaCd":{"type":"string","description":"Order Channel Code (OM007)","minLength":1},"orgClmNo":{"type":"string","description":"Current Claim No."},"newNumberedclmNo":{"type":"string","description":"Newly Issued Claim No."},"claimBusinessType":{"type":"string","description":"Claim Business Type","enum":["ORDER_CANCEL","RETURN_ACCEPT","RETURN_WITHDRAWAL","EXCHANGE_ACCEPT","EXCHANGE_WITHDRAWAL","RETURN_COMPLETE","RETURN_REJECT","RETURN_TRANSFORM"],"minLength":1},"systemType":{"type":"string","description":"System Type","enum":["FO","BO"],"minLength":1},"claimCalculateWorkType":{"type":"string","description":"Claim Benefit/Cost Processing Task Type","enum":["VIEW_SEARCH","CLAIM_PROCESS"],"minLength":1},"deliMethodCd":{"type":"string","description":"Delivery Method Code (LO010)","minLength":1},"selectedRtnDlvBenefitYn":{"type":"string","description":"Return Free Coupon Screen Selection Status","enum":["Y","N"]},"dlvpInfo":{"$ref":"#/components/schemas/ClaimDlvp","description":"Delivery Address Information"},"withdrawalInfo":{"$ref":"#/components/schemas/ClaimDlvp","description":"Collection Location Information"},"rtnDlvBenefitInfo":{"$ref":"#/components/schemas/ClaimDlvBenefitInfo","description":"Free Return Coupon Information"},"claimGoodsList":{"type":"array","description":"Claim Target Product Information List","items":{"$ref":"#/components/schemas/ClaimTargetGoodsResponse"}},"customerCauseFault":{"type":"boolean"}},"required":["claimBusinessType","claimCalculateWorkType","deliMethodCd","ordMediaCd","ordNo","systemType"]},"ClaimDlvp":{"type":"object","description":"Claim Delivery Information DTO","properties":{"mbrOrdDlvpGb":{"type":"string","description":"Member Order Delivery Address Type","enum":["MBR","ORD"]},"dlvpSeq":{"type":"string","description":"Delivery Address Sequence No."},"zipNoSeq":{"type":"integer","format":"int64","description":"Postal Code Sequence No."},"dlvpNm":{"type":"string","description":"Delivery Address Name","minLength":1},"rcvmnNm":{"type":"string","description":"Recipient Name","minLength":1},"zipNo":{"type":"string","description":"Postal Code","minLength":1},"zipAddr":{"type":"string","description":"Postal Address","minLength":1},"dtlAddr":{"type":"string","description":"Detailed Address","minLength":1},"rcvmnEmailAddr":{"type":"string","description":"Recipient Email Address"},"rcvmnCellSctNo":{"type":"string","description":"Recipient's Mobile Phone Prefix Code"},"rcvmnCellTxnoNo":{"type":"string","description":"Recipient's Mobile Phone Exchange Code"},"rcvmnCellEndNo":{"type":"string","description":"Recipient's Mobile Phone Exchange Code"},"rcvmnTelRgnNo":{"type":"string","description":"Recipient's Phone Area Code"},"rcvmnTelTxnoNo":{"type":"string","description":"Recipient's Phone Exchange Code"},"rcvmnTelEndNo":{"type":"string","description":"Recipient's Phone Last Digits"},"deliMsg":{"type":"string","description":"Delivery Message"},"deliMsgCd":{"type":"string","description":"Delivery Message Code (ME039)"},"shopTrafMsg":{"type":"string","description":"Store Delivery Message"},"comnFrdrCogoMethodCd":{"type":"string","description":"Common Entrance Access Method Code (ME040)"},"comnFrdrEtcMethod":{"type":"string","description":"Other Common Entrance Access Method"},"comnFrdrPwd":{"type":"string","description":"Common Entrance Password"}},"required":["dlvpNm","dtlAddr","rcvmnNm","zipAddr","zipNo"]},"ClaimDlvBenefitInfo":{"type":"object","description":"Claim Coupon Information DTO","properties":{"promoNo":{"type":"string","description":"Coupon No."},"promoNm":{"type":"string","description":"Coupon Name"},"promoTypCd":{"type":"string","description":"Coupon Type (MK002)"},"ourChrgRate":{"type":"integer","format":"int32","description":"Company Cost-Sharing Rate"},"entrChrgRate":{"type":"integer","format":"int32","description":"Vendor Cost-Sharing Rate"},"cpnIsuNo":{"type":"string","description":"Coupon Issuance No."},"aplyYn":{"type":"string","description":"Application Status","enum":["Y","N"]}}},"ClaimTargetGoodsResponse":{"type":"object","description":"Claim Processing Target Product Response DTO","properties":{"ordNo":{"type":"string","description":"Order No."},"ordSeq":{"type":"integer","format":"int32","description":"Order Sequence No."},"ordProcSeq":{"type":"integer","format":"int32","description":"Order Processing Sequence No."},"uprOrdProcSeq":{"type":"integer","format":"int32","description":"Parent Order Processing Sequence No."},"maxOrdProcSeq":{"type":"integer","format":"int32","description":"Maximum Order Processing Sequence No."},"claimNo":{"type":"string","description":"Claim No."},"goodsNo":{"type":"string","description":"Product No."},"itmNo":{"type":"string","description":"Item No."},"ordDtlGbCd":{"type":"string","description":"Order Detail Classification Code (OM003)"},"ordDtlGbCdNm":{"type":"string","description":"Order Detail Classification Code Name"},"ordDtlStatCd":{"type":"string","description":"Order Detail Status Code (OM005)"},"ordDtlStatCdNm":{"type":"string","description":"Order Detail Status Code Name"},"deliGbCd":{"type":"string","description":"Delivery Type Code (LO001)"},"ordAccpDtm":{"type":"string","format":"date-time","description":"Order Receipt Date/Time"},"ordFnshDtm":{"type":"string","format":"date-time","description":"Order Completion Date/Time"},"ordQty":{"type":"integer","format":"int32","description":"Order Quantity"},"cnclQty":{"type":"integer","format":"int32","description":"Cancellation Quantity"},"rtnQty":{"type":"integer","format":"int32","description":"Return Quantity"},"claimQty":{"type":"integer","format":"int32","description":"Claim Quantity"},"claimPossibleQty":{"type":"integer","format":"int32","description":"Claimable Quantity"},"deliIndiDtm":{"type":"string","format":"date-time","description":"Delivery Instruction Date/Time"},"deliIndiRsvDtm":{"type":"string","format":"date-time","description":"Delivery Instruction Reservation Date/Time"},"exchMidRtnYn":{"type":"string","description":"Return During Exchange Status","enum":["Y","N"]},"rtnPsbYn":{"type":"string","description":"Return Availability Status","enum":["Y","N"]},"exchPsbYn":{"type":"string","description":"Exchange Availability Status","enum":["Y","N"]},"ordCnclPsbYn":{"type":"string","description":"Cancellation Availability Status","enum":["Y","N"]},"wthdYn":{"type":"string","description":"Collection Status","enum":["Y","N"]},"ecpnNo":{"type":"string","description":"E-Coupon No."},"etcktNo":{"type":"string","description":"E-Ticket No."},"claimLgrpCd":{"type":"string","description":"Claim Major Classification Code (OM047)","minLength":1},"claimLgrpCdNm":{"type":"string","description":"Claim Major Category Code Name"},"claimMgrpCd":{"type":"string","description":"Claim Subcategory Code (OM006)","minLength":1},"claimMgrpCdNm":{"type":"string","description":"Claim Subcategory Code Name"},"claimCausEtcCont":{"type":"string","description":"Other Claim Reason Details"},"ordSaleTypCd":{"type":"string","description":"Order Sales Type Code (OM004)"},"chlNo":{"type":"string","description":"Channel No."},"chlDtlNo":{"type":"string","description":"Channel Detail No."},"stdCtgNo":{"type":"string","description":"Standard Category No."},"infDispCtgNoGbCd":{"type":"string","description":"Referral Display Category No. Classification Code (OM041)"},"infDispCtgNo":{"type":"string","description":"Referral Display Category No."},"repDispCtgNo":{"type":"string","description":"Main Display Category No."},"conrNo":{"type":"string","description":"Corner No."},"brandNo":{"type":"string","description":"Brand No."},"brandNm":{"type":"string","description":"Brand Name"},"goodsNm":{"type":"string","description":"Product Name"},"itmNm":{"type":"string","description":"Item Name"},"prestNm":{"type":"string","description":"Gift Item Name"},"goodsCompCd":{"type":"string","description":"Product Composition Code (PR001)"},"goodsTypCd":{"type":"string","description":"Product Type Code (PR002)"},"saleMethCd":{"type":"string","description":"Sales Method Code (PR003)"},"taxGbCd":{"type":"string","description":"Tax/Duty-Free Classification Code (PR007)"},"buyTypCd":{"type":"string","description":"Purchase Type Code (PR006)"},"supPcost":{"type":"number","description":"Supply Cost"},"norPrc":{"type":"number","description":"Regular Price"},"salePrc":{"type":"number","description":"Selling Price"},"preSalePrc":{"type":"number","description":"Discount Base Price"},"mrgnRate":{"type":"number","description":"Margin Rate"},"entrNo":{"type":"string","description":"Vendor No."},"deliPolcNo":{"type":"string","description":"Delivery Policy No."},"deliDday":{"type":"integer","format":"int64","description":"Delivery Lead Time"},"deliGoodsGbCd":{"type":"string","description":"Delivery Product Classification Code (PR010)"},"deliWayCd":{"type":"string","description":"Delivery Product Type Code (PR009)"},"bpckPsbYn":{"type":"string","description":"Combined Packaging Availability Status","enum":["Y","N"]},"hsCd":{"type":"string","description":"HS Code"},"goodsRevWrtYn":{"type":"string","description":"Product Review Written Status","enum":["Y","N"]},"bnfAmt":{"type":"number","description":"Benefit Amount"},"ordPrc":{"type":"number","description":"Order Amount"},"aeGoodsYn":{"type":"string","description":"Gift Status","enum":["Y","N"]},"deliNo":{"type":"string","description":"Delivery No."},"deliMethodCd":{"type":"string","description":"Delivery Method Code (LO010)"},"deliProcTypCd":{"type":"string","description":"Delivery Processing Type Code (PR008)"},"deliProcTypCdNm":{"type":"string","description":"Delivery Processing Type Code Name"},"deliFnshDtm":{"type":"string","format":"date-time","description":"Delivery Completion Date/Time"},"puTypCd":{"type":"string","description":"Pickup Type Code (LO006)"},"dlvpNm":{"type":"string","description":"Delivery Address Name"},"rcvmnNm":{"type":"string","description":"Recipient Name"},"dlvpSeq":{"type":"string","description":"Delivery Address Sequence No."},"zipNo":{"type":"string","description":"Postal Code"},"zipAddr":{"type":"string","description":"Postal Address"},"dtlAddr":{"type":"string","description":"Detailed Address"},"dlvZipNo":{"type":"string","description":"Postal Code (Delivery Address)"},"dlvZipAddr":{"type":"string","description":"Postal Address (Delivery Address)"},"dlvDtlAddr":{"type":"string","description":"Detailed Address (Delivery Address)"},"rcvmnEmailAddr":{"type":"string","description":"Recipient Email Address"},"rcvmnCellSctNo":{"type":"string","description":"Recipient's Mobile Phone Prefix Code"},"rcvmnCellTxnoNo":{"type":"string","description":"Recipient's Mobile Phone Exchange Code"},"rcvmnCellEndNo":{"type":"string","description":"Recipient's Mobile Phone Last Digits"},"rcvmnTelRgnNo":{"type":"string","description":"Recipient's Phone Area Code"},"rcvmnTelTxnoNo":{"type":"string","description":"Recipient's Phone Exchange Code"},"rcvmnTelEndNo":{"type":"string","description":"Recipient's Phone Last Digits"},"deliMsg":{"type":"string","description":"Delivery Message"},"deliMsgCd":{"type":"string","description":"Delivery Message Code (ME039)"},"shopTrafMsg":{"type":"string","description":"Store Delivery Message"},"comnFrdrCogoMethodCd":{"type":"string","description":"Common Entrance Access Method Code (ME040)"},"comnFrdrEtcMethod":{"type":"string","description":"Other Common Entrance Access Method"},"comnFrdrPwd":{"type":"string","description":"Common Entrance Password"},"orgDlvpInfo":{"$ref":"#/components/schemas/ClaimDlvp"},"orgDeliNo":{"type":"string","description":"Original Delivery No."},"withdrawalDeliNo":{"type":"string","description":"Pickup Destination Delivery No."},"dlvpInfo":{"$ref":"#/components/schemas/ClaimDlvp"},"shippingDeliGbCd":{"type":"boolean"},"withdrawalDeliGbCd":{"type":"boolean"},"exchangeShipping":{"type":"boolean"},"withdrawShipping":{"type":"boolean"},"withDlvpInfo":{"$ref":"#/components/schemas/ClaimDlvp","writeOnly":true}},"required":["claimLgrpCd","claimMgrpCd"]},"ClaimCalculateResponse":{"type":"object","description":"Claim Cost Calculation Search Response DTO","properties":{"ordNo":{"type":"string","description":"Order No."},"claimFinalAmtInfo":{"$ref":"#/components/schemas/ClaimFinalAmtInfo","description":"Claim Final Payment/Refund Amount Information"}}},"ClaimFinalAmtInfo":{"type":"object","description":"Claim Final Payment/Refund Amount Information DTO","properties":{"ordNo":{"type":"string","description":"Order No."},"totAplyAdtnAmt":{"type":"integer","format":"int64","description":"Total Delivery Fee Incurred Amount"},"totCnclAdtnAmt":{"type":"integer","format":"int64","description":"Total Cancelled Delivery Fee Amount"},"totFvrAdtnAmt":{"type":"integer","format":"int64","description":"Total Benefit Delivery Fee Amount"},"totOrdPrc":{"type":"integer","format":"int64","description":"Claim Product Amount"},"totDcAmt":{"type":"integer","format":"int64","description":"Claim Cancellation Discount Amount"},"expectedRefundAmt":{"type":"integer","format":"int64","description":"Expected Refund Amount"},"addtionPayAmt":{"type":"integer","format":"int64","description":"Additional Payment Amount"},"returnAcceptAmt":{"type":"integer","format":"int64","description":"Return Received Amount"},"refundAdditionAmtInfoList":{"type":"array","description":"Additional Payment/Refund Information List","items":{"$ref":"#/components/schemas/RefundAdditionAmtInfo"}},"refundPaymentMethodList":{"type":"array","description":"Refund Payment Information List","items":{"$ref":"#/components/schemas/PaymentClaimResponse"}},"rfdInfoResponse":{"$ref":"#/components/schemas/RfdInfoResponse","description":"Refund Account Information"}}},"RefundAdditionAmtInfo":{"type":"object","description":"Additional Payment/Refund Information DTO","properties":{"adtnOcurGbCd":{"type":"string","description":"Additional Cost Occurrence Classification Code (OM017)"},"adtnOcurGbNm":{"type":"string","description":"Additional Cost Occurrence Type Name"},"type":{"type":"string","description":"Type Classification","enum":["DELIVERY_FEE","RETURN_FEE","EXCHANGE_FEE","GOODS","EXTRA_FEE"]},"typeNm":{"type":"string","description":"Type Classification Name"},"goodsNoItmNo":{"type":"string","description":"Product No.+SKU No."},"goodsNm":{"type":"string","description":"Product Name"},"ordAmt":{"type":"number","description":"Payment Amount"},"discountMethod":{"type":"string","description":"Benefit Detail Information (OM019)"},"discountMethodNm":{"type":"string","description":"Benefit Detail Information Name"},"cnclDcAmt":{"type":"integer","format":"int64","description":"Cancellation Benefit Amount"},"rtnDlvBenefitInfoList":{"type":"array","description":"Return Coupon Information List","items":{"$ref":"#/components/schemas/ClaimDlvBenefitInfo"}}}},"PaymentClaimResponse":{"type":"object","description":"Refundable Payment Method DTO","properties":{"payNo":{"type":"string","description":"Payment Number"},"ordNo":{"type":"string","description":"Order No."},"claimNo":{"type":"string","description":"Claim No."},"uprPayNo":{"type":"string","description":"Parent Payment No."},"payGbCd":{"type":"string","description":"Payment Classification Code (OM012)"},"payGbCdNm":{"type":"string","description":"Payment Classification Code Name (OM012)"},"payWayCd":{"type":"string","description":"Payment Method Code (OM013)"},"payWayCdNm":{"type":"string","description":"Payment Method Code Name (OM013)"},"payStatCd":{"type":"string","description":"Payment Status Code (OM014)"},"payStatCdNm":{"type":"string","description":"Payment Status Code Name (OM014)"},"payAmt":{"type":"number","description":"Payment Amount"},"rfdPsbAmt":{"type":"number","description":"Refundable Amount"},"rfdAmt":{"type":"number","description":"Refund Amount"},"payFnshDtm":{"type":"string","format":"date-time","description":"Payment Completion Date/Time"},"trdNo":{"type":"string","description":"Transaction No. (tid)"},"trdDtm":{"type":"string","format":"date-time","description":"Transaction Date/Time"},"iscmCd":{"type":"string","description":"Issuer Code (OM027)"},"iscmCdNm":{"type":"string","description":"Issuer Code Name (OM027)"},"payReqCardcoCd":{"type":"string","description":"Payment Request Card Company Code (OM057)"},"payReqCardcoCdNm":{"type":"string","description":"Payment Request Card Company Code Name (OM057)"},"cardNo":{"type":"string","description":"Card No."},"cardNm":{"type":"string","description":"Card Name"},"cardValiTerm":{"type":"string","description":"Card Expiration Date"},"nintDivYn":{"type":"string","description":"Interest-Free Installment Status"},"divMonCnt":{"type":"integer","format":"int32","description":"Installment Months"},"cardPointUseYn":{"type":"string","description":"Card Points Usage Status"},"mersNo":{"type":"string","description":"Merchant Number"},"acqrCd":{"type":"string","description":"Purchasing Company Code (OM028)"},"acqrCdNm":{"type":"string","description":"Acquirer Code Name (OM028)"},"aprvNo":{"type":"string","description":"Approval No."},"aprvDtm":{"type":"string","format":"date-time","description":"Approval Date/Time"},"sctnCnclPsbYn":{"type":"string","description":"Partial Cancellation Availability Status"},"bankCd":{"type":"string","description":"Bank Code (OM026)"},"bankCdNm":{"type":"string","description":"Bank Code Name (OM026)"},"actnNo":{"type":"string","description":"Account Number"},"dpmnNm":{"type":"string","description":"Depositor Name"},"dptFcstDt":{"type":"string","description":"Scheduled Deposit Date"},"dptCnfmDtm":{"type":"string","format":"date-time","description":"Deposit Confirmation Date/Time"},"rfdBankCd":{"type":"string","description":"Refund Bank Code (OM026)"},"rfdBankCdNm":{"type":"string","description":"Refund Bank Code Name (OM026)"},"rfdActnNo":{"type":"string","description":"Refund Account No."},"rfdActnDepositorNm":{"type":"string","description":"Refund Account Holder Name"}}},"RfdInfoResponse":{"type":"object","description":"Refund Account Information Retrieval Response","properties":{"rfdBankCd":{"type":"string","description":"Bank Code (OM026)"},"rfdBankNm":{"type":"string","description":"Bank Name"},"rfdActnNo":{"type":"string","description":"Refund Account No."},"rfdActnDepositorNm":{"type":"string","description":"Refund Account Holder Name"},"rfdActnCertiYn":{"type":"string","description":"Refund Account Verification Status"}}}}},"paths":{"/v1/claim/claimCommon/claimCalculateCost":{"post":{"tags":["Claim Common"],"summary":"Retrieve Claim Cost Calculation","description":"## Function Description\n* Retrieves the claim cost calculation\n
\n
\n---\n## Detailed Content\n* Provides additional payment/refund amount information and refund method information for the screen by claim task\n* Provides information for generating additional payment/refund scheduled data based on DB-level additional costs and benefit information, and coupon use/restoration information, during claim task processing\n* Calls the BO Claim Cost Calculation Inquiry API ( API URL : **/api/order/v1/claim/common/claimCalculateCost** )\n","operationId":"claimCalculateCost","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClaimCalculateRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ClaimCalculateResponse"}}}}}}}}}
```