> 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/order-return.md).
# Order Return
## Return Withdrawal
> \## Function Description\
> Withdraws a return receipt case.\
> \
\
\
> \---\
> \## Detailed Content\
> \* Calls the Order Return Withdrawal (BO) API.\
\
\
> \_API URL : /api/order/v1/claim/return/withdrawalReturn\_\
> \---\
> \## Revision History\
> \* release\_231009\_01 : Added order quantity and cancellation quantity columns to the order benefit relationship table
```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":{"ClaimRequest":{"type":"object","description":"Claim Processing Request DTO","properties":{"systemType":{"type":"string","description":"System Type","enum":["FO","BO"],"minLength":1},"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},"ordMediaCd":{"type":"string","description":"Order Channel Code (OM007)","minLength":1},"ordNo":{"type":"string","description":"Order No."},"mbrNo":{"type":"string","description":"Member No."},"claimNo":{"type":"string","description":"Claim No."},"claimGoodsList":{"type":"array","description":"Claim Target Product Information List","items":{"$ref":"#/components/schemas/ClaimGoodsRequest"}},"claimCpnInfoList":{"type":"array","description":"Coupon List","items":{"$ref":"#/components/schemas/ClaimCpnInfo"}},"claimReturnDlvp":{"$ref":"#/components/schemas/ClaimDlvp","description":"Collection Location Information"},"claimDlvp":{"$ref":"#/components/schemas/ClaimDlvp","description":"Delivery Address Information"},"claimFinalAmtInfo":{"$ref":"#/components/schemas/ClaimFinalAmtInfo","description":"Additional Payment/Refund Amount Information"},"wthdFnshWaitProcCaus":{"type":"string","description":"Pickup Completion Pending Reason"}},"required":["claimBusinessType","claimGoodsList","ordMediaCd","systemType"]},"ClaimGoodsRequest":{"type":"object","description":"Claim Requested Product Information DTO","properties":{"ordSeq":{"type":"integer","format":"int32","description":"Order Sequence No."},"ordProcSeq":{"type":"integer","format":"int32","description":"Order Processing Sequence No."},"goodsNo":{"type":"string","description":"Product No."},"itmNo":{"type":"string","description":"Item No."},"exchangeGoodsNo":{"type":"string","description":"Exchange Product No."},"exchangeItmNo":{"type":"string","description":"Exchange SKU No."},"exchangeItmNm":{"type":"string","description":"Exchange SKU Name"},"claimQty":{"type":"integer","format":"int32","description":"Claim Quantity"},"claimLgrpCd":{"type":"string","description":"Claim Major Classification Code (OM047)"},"claimMgrpCd":{"type":"string","description":"Claim Subcategory Code (OM006)","minLength":1},"claimCausEtcCont":{"type":"string","description":"Other Claim Reason Details"},"withdrawalDeliNo":{"type":"string","description":"Pickup Delivery No."},"shipmentDeliNo":{"type":"string","description":"Shipment Delivery No."}},"required":["claimMgrpCd","claimQty"]},"ClaimCpnInfo":{"type":"object","description":"Claim Coupon Information DTO","properties":{"cpnNo":{"type":"string","description":"Coupon Issuance No."}}},"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"]},"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":{"/v2/claim/return/withdrawalReturn":{"post":{"tags":["Order Return"],"summary":"Return Withdrawal","description":"## Function Description\nWithdraws a return receipt case.\n
\n---\n## Detailed Content\n* Calls the Order Return Withdrawal (BO) API.
\n_API URL : /api/order/v1/claim/return/withdrawalReturn_\n---\n## Revision History\n* release_231009_01 : Added order quantity and cancellation quantity columns to the order benefit relationship table\n","operationId":"withdrawalReturn","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClaimRequest"}}},"required":true},"responses":{"200":{"description":"OK"}}}}}}
```
## Return Conversion
> \## Function Description\
> Processes a return receipt while an exchange is in progress.\
> \
\
\
> \---\
> \## Detailed Content\
> \* Calls the Order Claim Exchange-to-Return API.\
\
\
> \_API URL : /api/order/v1/claim/return/transformReturn\_
```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":{"ClaimRequest":{"type":"object","description":"Claim Processing Request DTO","properties":{"systemType":{"type":"string","description":"System Type","enum":["FO","BO"],"minLength":1},"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},"ordMediaCd":{"type":"string","description":"Order Channel Code (OM007)","minLength":1},"ordNo":{"type":"string","description":"Order No."},"mbrNo":{"type":"string","description":"Member No."},"claimNo":{"type":"string","description":"Claim No."},"claimGoodsList":{"type":"array","description":"Claim Target Product Information List","items":{"$ref":"#/components/schemas/ClaimGoodsRequest"}},"claimCpnInfoList":{"type":"array","description":"Coupon List","items":{"$ref":"#/components/schemas/ClaimCpnInfo"}},"claimReturnDlvp":{"$ref":"#/components/schemas/ClaimDlvp","description":"Collection Location Information"},"claimDlvp":{"$ref":"#/components/schemas/ClaimDlvp","description":"Delivery Address Information"},"claimFinalAmtInfo":{"$ref":"#/components/schemas/ClaimFinalAmtInfo","description":"Additional Payment/Refund Amount Information"},"wthdFnshWaitProcCaus":{"type":"string","description":"Pickup Completion Pending Reason"}},"required":["claimBusinessType","claimGoodsList","ordMediaCd","systemType"]},"ClaimGoodsRequest":{"type":"object","description":"Claim Requested Product Information DTO","properties":{"ordSeq":{"type":"integer","format":"int32","description":"Order Sequence No."},"ordProcSeq":{"type":"integer","format":"int32","description":"Order Processing Sequence No."},"goodsNo":{"type":"string","description":"Product No."},"itmNo":{"type":"string","description":"Item No."},"exchangeGoodsNo":{"type":"string","description":"Exchange Product No."},"exchangeItmNo":{"type":"string","description":"Exchange SKU No."},"exchangeItmNm":{"type":"string","description":"Exchange SKU Name"},"claimQty":{"type":"integer","format":"int32","description":"Claim Quantity"},"claimLgrpCd":{"type":"string","description":"Claim Major Classification Code (OM047)"},"claimMgrpCd":{"type":"string","description":"Claim Subcategory Code (OM006)","minLength":1},"claimCausEtcCont":{"type":"string","description":"Other Claim Reason Details"},"withdrawalDeliNo":{"type":"string","description":"Pickup Delivery No."},"shipmentDeliNo":{"type":"string","description":"Shipment Delivery No."}},"required":["claimMgrpCd","claimQty"]},"ClaimCpnInfo":{"type":"object","description":"Claim Coupon Information DTO","properties":{"cpnNo":{"type":"string","description":"Coupon Issuance No."}}},"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"]},"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":{"/v2/claim/return/transformReturn":{"post":{"tags":["Order Return"],"summary":"Return Conversion","description":"## Function Description\nProcesses a return receipt while an exchange is in progress.\n
\n---\n## Detailed Content\n* Calls the Order Claim Exchange-to-Return API.
\n_API URL : /api/order/v1/claim/return/transformReturn_\n","operationId":"transformReturn","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClaimRequest"}}},"required":true},"responses":{"200":{"description":"OK"}}}}}}
```
## Return Hold
> \## Function Description\
> Processes a return hold.\
> \
\
\
> \---\
> \## Detailed Content\
> \* Calls the Order Claim Return Hold API.\
\
\
> \_API URL : /api/order/v1/claim/return/returnPending
```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":{"ClaimRequest":{"type":"object","description":"Claim Processing Request DTO","properties":{"systemType":{"type":"string","description":"System Type","enum":["FO","BO"],"minLength":1},"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},"ordMediaCd":{"type":"string","description":"Order Channel Code (OM007)","minLength":1},"ordNo":{"type":"string","description":"Order No."},"mbrNo":{"type":"string","description":"Member No."},"claimNo":{"type":"string","description":"Claim No."},"claimGoodsList":{"type":"array","description":"Claim Target Product Information List","items":{"$ref":"#/components/schemas/ClaimGoodsRequest"}},"claimCpnInfoList":{"type":"array","description":"Coupon List","items":{"$ref":"#/components/schemas/ClaimCpnInfo"}},"claimReturnDlvp":{"$ref":"#/components/schemas/ClaimDlvp","description":"Collection Location Information"},"claimDlvp":{"$ref":"#/components/schemas/ClaimDlvp","description":"Delivery Address Information"},"claimFinalAmtInfo":{"$ref":"#/components/schemas/ClaimFinalAmtInfo","description":"Additional Payment/Refund Amount Information"},"wthdFnshWaitProcCaus":{"type":"string","description":"Pickup Completion Pending Reason"}},"required":["claimBusinessType","claimGoodsList","ordMediaCd","systemType"]},"ClaimGoodsRequest":{"type":"object","description":"Claim Requested Product Information DTO","properties":{"ordSeq":{"type":"integer","format":"int32","description":"Order Sequence No."},"ordProcSeq":{"type":"integer","format":"int32","description":"Order Processing Sequence No."},"goodsNo":{"type":"string","description":"Product No."},"itmNo":{"type":"string","description":"Item No."},"exchangeGoodsNo":{"type":"string","description":"Exchange Product No."},"exchangeItmNo":{"type":"string","description":"Exchange SKU No."},"exchangeItmNm":{"type":"string","description":"Exchange SKU Name"},"claimQty":{"type":"integer","format":"int32","description":"Claim Quantity"},"claimLgrpCd":{"type":"string","description":"Claim Major Classification Code (OM047)"},"claimMgrpCd":{"type":"string","description":"Claim Subcategory Code (OM006)","minLength":1},"claimCausEtcCont":{"type":"string","description":"Other Claim Reason Details"},"withdrawalDeliNo":{"type":"string","description":"Pickup Delivery No."},"shipmentDeliNo":{"type":"string","description":"Shipment Delivery No."}},"required":["claimMgrpCd","claimQty"]},"ClaimCpnInfo":{"type":"object","description":"Claim Coupon Information DTO","properties":{"cpnNo":{"type":"string","description":"Coupon Issuance No."}}},"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"]},"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":{"/v2/claim/return/returnPending":{"post":{"tags":["Order Return"],"summary":"Return Hold","description":"## Function Description\nProcesses a return hold.\n
\n---\n## Detailed Content\n* Calls the Order Claim Return Hold API.
\n_API URL : /api/order/v1/claim/return/returnPending\n","operationId":"returnPending","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClaimRequest"}}},"required":true},"responses":{"200":{"description":"OK"}}}}}}
```
## Return Rejection
> \## Function Description\
> Processes a return rejection.\
> \
\
\
> \---\
> \## Detailed Content\
> \* Calls the Order Claim Return Rejection API.\
\
\
> \_API URL : /api/order/v1/claim/return/rejectReturn
```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":{"ClaimRequest":{"type":"object","description":"Claim Processing Request DTO","properties":{"systemType":{"type":"string","description":"System Type","enum":["FO","BO"],"minLength":1},"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},"ordMediaCd":{"type":"string","description":"Order Channel Code (OM007)","minLength":1},"ordNo":{"type":"string","description":"Order No."},"mbrNo":{"type":"string","description":"Member No."},"claimNo":{"type":"string","description":"Claim No."},"claimGoodsList":{"type":"array","description":"Claim Target Product Information List","items":{"$ref":"#/components/schemas/ClaimGoodsRequest"}},"claimCpnInfoList":{"type":"array","description":"Coupon List","items":{"$ref":"#/components/schemas/ClaimCpnInfo"}},"claimReturnDlvp":{"$ref":"#/components/schemas/ClaimDlvp","description":"Collection Location Information"},"claimDlvp":{"$ref":"#/components/schemas/ClaimDlvp","description":"Delivery Address Information"},"claimFinalAmtInfo":{"$ref":"#/components/schemas/ClaimFinalAmtInfo","description":"Additional Payment/Refund Amount Information"},"wthdFnshWaitProcCaus":{"type":"string","description":"Pickup Completion Pending Reason"}},"required":["claimBusinessType","claimGoodsList","ordMediaCd","systemType"]},"ClaimGoodsRequest":{"type":"object","description":"Claim Requested Product Information DTO","properties":{"ordSeq":{"type":"integer","format":"int32","description":"Order Sequence No."},"ordProcSeq":{"type":"integer","format":"int32","description":"Order Processing Sequence No."},"goodsNo":{"type":"string","description":"Product No."},"itmNo":{"type":"string","description":"Item No."},"exchangeGoodsNo":{"type":"string","description":"Exchange Product No."},"exchangeItmNo":{"type":"string","description":"Exchange SKU No."},"exchangeItmNm":{"type":"string","description":"Exchange SKU Name"},"claimQty":{"type":"integer","format":"int32","description":"Claim Quantity"},"claimLgrpCd":{"type":"string","description":"Claim Major Classification Code (OM047)"},"claimMgrpCd":{"type":"string","description":"Claim Subcategory Code (OM006)","minLength":1},"claimCausEtcCont":{"type":"string","description":"Other Claim Reason Details"},"withdrawalDeliNo":{"type":"string","description":"Pickup Delivery No."},"shipmentDeliNo":{"type":"string","description":"Shipment Delivery No."}},"required":["claimMgrpCd","claimQty"]},"ClaimCpnInfo":{"type":"object","description":"Claim Coupon Information DTO","properties":{"cpnNo":{"type":"string","description":"Coupon Issuance No."}}},"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"]},"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":{"/v2/claim/return/rejectReturn":{"post":{"tags":["Order Return"],"summary":"Return Rejection","description":"## Function Description\nProcesses a return rejection.\n
\n---\n## Detailed Content\n* Calls the Order Claim Return Rejection API.
\n_API URL : /api/order/v1/claim/return/rejectReturn\n","operationId":"rejectReturn","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClaimRequest"}}},"required":true},"responses":{"200":{"description":"OK"}}}}}}
```
## Retrieve Return Conversion Processing Targets
> \## Function Description\
> Retrieves the order information, the list of products eligible for return conversion, and other information needed when invoking the return conversion popup.\
> \
\
\
> \---\
> \## Detailed Content\
> \* Calls the Order Return Processing Target Inquiry (BO) API.\
\
\
> \_API URL : /api/order/v1/claim/return/returnTargetInfo\_\
> \---\
> \## Revision History\
> \* Release v2.00\_240729 : Added collection status (wthdYn)\
> \* Release v2.00\_240829 : Updated masking processing
```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":{"ReturnPopupRequest":{"type":"object","description":"Return Popup Request DTO","properties":{"ordNo":{"type":"string","description":"Order 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"]},"systemType":{"type":"string","description":"System Type","enum":["FO","BO"]}}},"ReturnPopupResponse":{"type":"object","description":"Return Popup Response DTO","properties":{"claimTargetResponse":{"$ref":"#/components/schemas/ClaimTargetResponse","description":"Claim Target Information"},"codeMap":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/StStdCd"}},"description":"Common Code"},"claimBusinessType":{"type":"string","description":"Claim Task Type","enum":["ORDER_CANCEL","RETURN_ACCEPT","RETURN_WITHDRAWAL","EXCHANGE_ACCEPT","EXCHANGE_WITHDRAWAL","RETURN_COMPLETE","RETURN_REJECT","RETURN_TRANSFORM"]}}},"ClaimTargetResponse":{"type":"object","description":"Claim Processing Target Response DTO","properties":{"ordNo":{"type":"string","description":"Order No."},"mbrNo":{"type":"string","description":"Member No."},"ordManNm":{"type":"string","description":"Orderer Name"},"ordMediaCd":{"type":"string","description":"Order Channel Code (OM007) 20: PC, 30: Mobile Web, 40: Android App, 50: iOS App"},"sctnCnclPsbYn":{"type":"string","description":"Partial Cancellation Availability Status","enum":["Y","N"]},"claimTargetGoodsResponseList":{"type":"array","description":"Claim Target Product List","items":{"$ref":"#/components/schemas/ClaimTargetGoodsResponse"}},"vbankPaymentPending":{"type":"boolean"},"allNonReturnable":{"type":"boolean"},"allEcoupon":{"type":"boolean"}}},"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"]},"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"]},"StStdCd":{"type":"object","description":"Group Code Search/Register/Modify Request","properties":{"grpCd":{"type":"string","description":"Group Code"},"cd":{"type":"string","description":"Code"},"cdNm":{"type":"string","description":"Code Name"},"cdDesc":{"type":"string","description":"Code Description"},"useYn":{"type":"string","description":"Usage Status"},"sortSeq":{"type":"integer","format":"int32","description":"Sort Order"},"ref1Val":{"type":"string","description":"Reference Value 1 Description"},"ref2Val":{"type":"string","description":"Reference Value 2 Description"},"ref3Val":{"type":"string","description":"Reference Value 3 Description"},"ref4Val":{"type":"string","description":"Reference Value 4 Description"},"ref5Val":{"type":"string","description":"Reference Value 5 Description"},"ref6Val":{"type":"string","description":"Reference Value 6 Description"},"ref7Val":{"type":"string","description":"Reference Value 7 Description"}}}}},"paths":{"/v2/claim/return/getReturnTransformPopupBaseInfo":{"post":{"tags":["Order Return"],"summary":"Retrieve Return Conversion Processing Targets","description":"## Function Description\nRetrieves the order information, the list of products eligible for return conversion, and other information needed when invoking the return conversion popup.\n
\n---\n## Detailed Content\n* Calls the Order Return Processing Target Inquiry (BO) API.
\n_API URL : /api/order/v1/claim/return/returnTargetInfo_\n---\n## Revision History\n* Release v2.00_240729 : Added collection status (wthdYn)\n* Release v2.00_240829 : Updated masking processing\n","operationId":"getReturnTransformPopupBaseInfo","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReturnPopupRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ReturnPopupResponse"}}}}}}}}}
```
## Retrieve Return Rejection Targets
> \## Function Description\
> Retrieves the order information and the list of products eligible for return rejection needed when invoking the return rejection popup.\
> \
\
\
> \---\
> \## Detailed Content\
> \* Calls the Order Return Processing Target Inquiry (BO) API.\
\
\
> \_API URL : /api/order/v1/claim/return/returnTargetInfo\_\
> \---\
> \## Revision History\
> \* Release v2.00\_240729 : Added collection status (wthdYn)\
> \* Release v2.00\_240829 : Updated masking processing
```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":{"ReturnPopupRequest":{"type":"object","description":"Return Popup Request DTO","properties":{"ordNo":{"type":"string","description":"Order 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"]},"systemType":{"type":"string","description":"System Type","enum":["FO","BO"]}}},"ReturnPopupResponse":{"type":"object","description":"Return Popup Response DTO","properties":{"claimTargetResponse":{"$ref":"#/components/schemas/ClaimTargetResponse","description":"Claim Target Information"},"codeMap":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/StStdCd"}},"description":"Common Code"},"claimBusinessType":{"type":"string","description":"Claim Task Type","enum":["ORDER_CANCEL","RETURN_ACCEPT","RETURN_WITHDRAWAL","EXCHANGE_ACCEPT","EXCHANGE_WITHDRAWAL","RETURN_COMPLETE","RETURN_REJECT","RETURN_TRANSFORM"]}}},"ClaimTargetResponse":{"type":"object","description":"Claim Processing Target Response DTO","properties":{"ordNo":{"type":"string","description":"Order No."},"mbrNo":{"type":"string","description":"Member No."},"ordManNm":{"type":"string","description":"Orderer Name"},"ordMediaCd":{"type":"string","description":"Order Channel Code (OM007) 20: PC, 30: Mobile Web, 40: Android App, 50: iOS App"},"sctnCnclPsbYn":{"type":"string","description":"Partial Cancellation Availability Status","enum":["Y","N"]},"claimTargetGoodsResponseList":{"type":"array","description":"Claim Target Product List","items":{"$ref":"#/components/schemas/ClaimTargetGoodsResponse"}},"vbankPaymentPending":{"type":"boolean"},"allNonReturnable":{"type":"boolean"},"allEcoupon":{"type":"boolean"}}},"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"]},"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"]},"StStdCd":{"type":"object","description":"Group Code Search/Register/Modify Request","properties":{"grpCd":{"type":"string","description":"Group Code"},"cd":{"type":"string","description":"Code"},"cdNm":{"type":"string","description":"Code Name"},"cdDesc":{"type":"string","description":"Code Description"},"useYn":{"type":"string","description":"Usage Status"},"sortSeq":{"type":"integer","format":"int32","description":"Sort Order"},"ref1Val":{"type":"string","description":"Reference Value 1 Description"},"ref2Val":{"type":"string","description":"Reference Value 2 Description"},"ref3Val":{"type":"string","description":"Reference Value 3 Description"},"ref4Val":{"type":"string","description":"Reference Value 4 Description"},"ref5Val":{"type":"string","description":"Reference Value 5 Description"},"ref6Val":{"type":"string","description":"Reference Value 6 Description"},"ref7Val":{"type":"string","description":"Reference Value 7 Description"}}}}},"paths":{"/v2/claim/return/getReturnRejectPopupInfo":{"post":{"tags":["Order Return"],"summary":"Retrieve Return Rejection Targets","description":"## Function Description\nRetrieves the order information and the list of products eligible for return rejection needed when invoking the return rejection popup.\n
\n---\n## Detailed Content\n* Calls the Order Return Processing Target Inquiry (BO) API.
\n_API URL : /api/order/v1/claim/return/returnTargetInfo_\n---\n## Revision History\n* Release v2.00_240729 : Added collection status (wthdYn)\n* Release v2.00_240829 : Updated masking processing\n","operationId":"getReturnRejectPopupInfo","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReturnPopupRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ReturnPopupResponse"}}}}}}}}}
```
## Retrieve Return Receipt Processing Targets
> \## Function Description\
> Retrieves the order information, the list of products eligible for return, and other information needed when invoking the return receipt popup.\
> \
\
\
> \---\
> \## Detailed Content\
> \* Calls the Order Return Processing Target Inquiry (BO) API.\
\
\
> \_API URL : /api/order/v1/claim/return/returnTargetInfo\_\
> \---\
> \## Revision History\
> \* Release v2.00\_240729 : Added cancellation available status (ordCnclPsbYn), collection status (wthdYn), e-coupon number (ecpnNo), e-ticket number (etcktNo)\
> \* Release v2.00\_240829 : Updated masking processing
```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":{"ReturnPopupRequest":{"type":"object","description":"Return Popup Request DTO","properties":{"ordNo":{"type":"string","description":"Order 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"]},"systemType":{"type":"string","description":"System Type","enum":["FO","BO"]}}},"ReturnPopupResponse":{"type":"object","description":"Return Popup Response DTO","properties":{"claimTargetResponse":{"$ref":"#/components/schemas/ClaimTargetResponse","description":"Claim Target Information"},"codeMap":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/StStdCd"}},"description":"Common Code"},"claimBusinessType":{"type":"string","description":"Claim Task Type","enum":["ORDER_CANCEL","RETURN_ACCEPT","RETURN_WITHDRAWAL","EXCHANGE_ACCEPT","EXCHANGE_WITHDRAWAL","RETURN_COMPLETE","RETURN_REJECT","RETURN_TRANSFORM"]}}},"ClaimTargetResponse":{"type":"object","description":"Claim Processing Target Response DTO","properties":{"ordNo":{"type":"string","description":"Order No."},"mbrNo":{"type":"string","description":"Member No."},"ordManNm":{"type":"string","description":"Orderer Name"},"ordMediaCd":{"type":"string","description":"Order Channel Code (OM007) 20: PC, 30: Mobile Web, 40: Android App, 50: iOS App"},"sctnCnclPsbYn":{"type":"string","description":"Partial Cancellation Availability Status","enum":["Y","N"]},"claimTargetGoodsResponseList":{"type":"array","description":"Claim Target Product List","items":{"$ref":"#/components/schemas/ClaimTargetGoodsResponse"}},"vbankPaymentPending":{"type":"boolean"},"allNonReturnable":{"type":"boolean"},"allEcoupon":{"type":"boolean"}}},"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"]},"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"]},"StStdCd":{"type":"object","description":"Group Code Search/Register/Modify Request","properties":{"grpCd":{"type":"string","description":"Group Code"},"cd":{"type":"string","description":"Code"},"cdNm":{"type":"string","description":"Code Name"},"cdDesc":{"type":"string","description":"Code Description"},"useYn":{"type":"string","description":"Usage Status"},"sortSeq":{"type":"integer","format":"int32","description":"Sort Order"},"ref1Val":{"type":"string","description":"Reference Value 1 Description"},"ref2Val":{"type":"string","description":"Reference Value 2 Description"},"ref3Val":{"type":"string","description":"Reference Value 3 Description"},"ref4Val":{"type":"string","description":"Reference Value 4 Description"},"ref5Val":{"type":"string","description":"Reference Value 5 Description"},"ref6Val":{"type":"string","description":"Reference Value 6 Description"},"ref7Val":{"type":"string","description":"Reference Value 7 Description"}}}}},"paths":{"/v2/claim/return/getReturnPopupBaseInfo":{"post":{"tags":["Order Return"],"summary":"Retrieve Return Receipt Processing Targets","description":" ## Function Description\n Retrieves the order information, the list of products eligible for return, and other information needed when invoking the return receipt popup.\n
\n ---\n ## Detailed Content\n * Calls the Order Return Processing Target Inquiry (BO) API.
\n _API URL : /api/order/v1/claim/return/returnTargetInfo_\n ---\n ## Revision History\n * Release v2.00_240729 : Added cancellation available status (ordCnclPsbYn), collection status (wthdYn), e-coupon number (ecpnNo), e-ticket number (etcktNo)\n* Release v2.00_240829 : Updated masking processing\n","operationId":"getReturnPopupBaseInfo","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReturnPopupRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ReturnPopupResponse"}}}}}}}}}
```
## Retrieve Return Hold Processing Targets
> \## Function Description\
> Retrieves the order information, the list of products eligible for return hold, and other information needed when invoking the return hold popup.\
> \
\
\
> \---\
> \## Detailed Content\
> \* Calls the Order Return Processing Target Inquiry (BO) API.\
\
\
> \_API URL : /api/order/v1/claim/return/returnTargetInfo\_\
> \---\
> \## Revision History\
> \* Release v2.00\_240729 : Added collection status (wthdYn)\
> \* Release v2.00\_240829 : Updated masking processing
```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":{"ReturnPopupRequest":{"type":"object","description":"Return Popup Request DTO","properties":{"ordNo":{"type":"string","description":"Order 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"]},"systemType":{"type":"string","description":"System Type","enum":["FO","BO"]}}},"ReturnPopupResponse":{"type":"object","description":"Return Popup Response DTO","properties":{"claimTargetResponse":{"$ref":"#/components/schemas/ClaimTargetResponse","description":"Claim Target Information"},"codeMap":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/StStdCd"}},"description":"Common Code"},"claimBusinessType":{"type":"string","description":"Claim Task Type","enum":["ORDER_CANCEL","RETURN_ACCEPT","RETURN_WITHDRAWAL","EXCHANGE_ACCEPT","EXCHANGE_WITHDRAWAL","RETURN_COMPLETE","RETURN_REJECT","RETURN_TRANSFORM"]}}},"ClaimTargetResponse":{"type":"object","description":"Claim Processing Target Response DTO","properties":{"ordNo":{"type":"string","description":"Order No."},"mbrNo":{"type":"string","description":"Member No."},"ordManNm":{"type":"string","description":"Orderer Name"},"ordMediaCd":{"type":"string","description":"Order Channel Code (OM007) 20: PC, 30: Mobile Web, 40: Android App, 50: iOS App"},"sctnCnclPsbYn":{"type":"string","description":"Partial Cancellation Availability Status","enum":["Y","N"]},"claimTargetGoodsResponseList":{"type":"array","description":"Claim Target Product List","items":{"$ref":"#/components/schemas/ClaimTargetGoodsResponse"}},"vbankPaymentPending":{"type":"boolean"},"allNonReturnable":{"type":"boolean"},"allEcoupon":{"type":"boolean"}}},"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"]},"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"]},"StStdCd":{"type":"object","description":"Group Code Search/Register/Modify Request","properties":{"grpCd":{"type":"string","description":"Group Code"},"cd":{"type":"string","description":"Code"},"cdNm":{"type":"string","description":"Code Name"},"cdDesc":{"type":"string","description":"Code Description"},"useYn":{"type":"string","description":"Usage Status"},"sortSeq":{"type":"integer","format":"int32","description":"Sort Order"},"ref1Val":{"type":"string","description":"Reference Value 1 Description"},"ref2Val":{"type":"string","description":"Reference Value 2 Description"},"ref3Val":{"type":"string","description":"Reference Value 3 Description"},"ref4Val":{"type":"string","description":"Reference Value 4 Description"},"ref5Val":{"type":"string","description":"Reference Value 5 Description"},"ref6Val":{"type":"string","description":"Reference Value 6 Description"},"ref7Val":{"type":"string","description":"Reference Value 7 Description"}}}}},"paths":{"/v2/claim/return/getReturnPendingPopupBaseInfo":{"post":{"tags":["Order Return"],"summary":"Retrieve Return Hold Processing Targets","description":"## Function Description\nRetrieves the order information, the list of products eligible for return hold, and other information needed when invoking the return hold popup.\n
\n---\n## Detailed Content\n* Calls the Order Return Processing Target Inquiry (BO) API.
\n_API URL : /api/order/v1/claim/return/returnTargetInfo_\n---\n## Revision History\n* Release v2.00_240729 : Added collection status (wthdYn)\n* Release v2.00_240829 : Updated masking processing\n","operationId":"getReturnPendingPopupBaseInfo","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReturnPopupRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ReturnPopupResponse"}}}}}}}}}
```
## Retrieve Return Completion Processing Targets
> \## Function Description\
> Retrieves the order information, the list of products eligible for return completion, and other information needed when invoking the return completion popup.\
> \
\
\
> \---\
> \## Detailed Content\
> \* Calls the Order Return Processing Target Inquiry (BO) API.\
\
\
> \_API URL : /api/order/v1/claim/return/returnTargetInfo\_\
> \---\
> \## Revision History\
> \* Release v2.00\_240729 : Added collection status (wthdYn), e-coupon number (ecpnNo)\
> \* Release v2.00\_240829 : Updated masking processing
```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":{"ReturnPopupRequest":{"type":"object","description":"Return Popup Request DTO","properties":{"ordNo":{"type":"string","description":"Order 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"]},"systemType":{"type":"string","description":"System Type","enum":["FO","BO"]}}},"ReturnPopupResponse":{"type":"object","description":"Return Popup Response DTO","properties":{"claimTargetResponse":{"$ref":"#/components/schemas/ClaimTargetResponse","description":"Claim Target Information"},"codeMap":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/StStdCd"}},"description":"Common Code"},"claimBusinessType":{"type":"string","description":"Claim Task Type","enum":["ORDER_CANCEL","RETURN_ACCEPT","RETURN_WITHDRAWAL","EXCHANGE_ACCEPT","EXCHANGE_WITHDRAWAL","RETURN_COMPLETE","RETURN_REJECT","RETURN_TRANSFORM"]}}},"ClaimTargetResponse":{"type":"object","description":"Claim Processing Target Response DTO","properties":{"ordNo":{"type":"string","description":"Order No."},"mbrNo":{"type":"string","description":"Member No."},"ordManNm":{"type":"string","description":"Orderer Name"},"ordMediaCd":{"type":"string","description":"Order Channel Code (OM007) 20: PC, 30: Mobile Web, 40: Android App, 50: iOS App"},"sctnCnclPsbYn":{"type":"string","description":"Partial Cancellation Availability Status","enum":["Y","N"]},"claimTargetGoodsResponseList":{"type":"array","description":"Claim Target Product List","items":{"$ref":"#/components/schemas/ClaimTargetGoodsResponse"}},"vbankPaymentPending":{"type":"boolean"},"allNonReturnable":{"type":"boolean"},"allEcoupon":{"type":"boolean"}}},"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"]},"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"]},"StStdCd":{"type":"object","description":"Group Code Search/Register/Modify Request","properties":{"grpCd":{"type":"string","description":"Group Code"},"cd":{"type":"string","description":"Code"},"cdNm":{"type":"string","description":"Code Name"},"cdDesc":{"type":"string","description":"Code Description"},"useYn":{"type":"string","description":"Usage Status"},"sortSeq":{"type":"integer","format":"int32","description":"Sort Order"},"ref1Val":{"type":"string","description":"Reference Value 1 Description"},"ref2Val":{"type":"string","description":"Reference Value 2 Description"},"ref3Val":{"type":"string","description":"Reference Value 3 Description"},"ref4Val":{"type":"string","description":"Reference Value 4 Description"},"ref5Val":{"type":"string","description":"Reference Value 5 Description"},"ref6Val":{"type":"string","description":"Reference Value 6 Description"},"ref7Val":{"type":"string","description":"Reference Value 7 Description"}}}}},"paths":{"/v2/claim/return/getReturnCompletePopupBaseInfo":{"post":{"tags":["Order Return"],"summary":"Retrieve Return Completion Processing Targets","description":"## Function Description\nRetrieves the order information, the list of products eligible for return completion, and other information needed when invoking the return completion popup.\n
\n---\n## Detailed Content\n* Calls the Order Return Processing Target Inquiry (BO) API.
\n_API URL : /api/order/v1/claim/return/returnTargetInfo_\n---\n## Revision History\n* Release v2.00_240729 : Added collection status (wthdYn), e-coupon number (ecpnNo)\n* Release v2.00_240829 : Updated masking processing\n","operationId":"getReturnCompletePopupBaseInfo","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReturnPopupRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ReturnPopupResponse"}}}}}}}}}
```
## Return Completion
> \## Function Description\
> Marks a return receipt as complete.\
> \
\
\
> \---\
> \## Detailed Content\
> \* Calls the Order Return Completion API.\
\
\
> \_API URL : /api/order/v1/claim/return/completeReturn\_
```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":{"ClaimRequest":{"type":"object","description":"Claim Processing Request DTO","properties":{"systemType":{"type":"string","description":"System Type","enum":["FO","BO"],"minLength":1},"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},"ordMediaCd":{"type":"string","description":"Order Channel Code (OM007)","minLength":1},"ordNo":{"type":"string","description":"Order No."},"mbrNo":{"type":"string","description":"Member No."},"claimNo":{"type":"string","description":"Claim No."},"claimGoodsList":{"type":"array","description":"Claim Target Product Information List","items":{"$ref":"#/components/schemas/ClaimGoodsRequest"}},"claimCpnInfoList":{"type":"array","description":"Coupon List","items":{"$ref":"#/components/schemas/ClaimCpnInfo"}},"claimReturnDlvp":{"$ref":"#/components/schemas/ClaimDlvp","description":"Collection Location Information"},"claimDlvp":{"$ref":"#/components/schemas/ClaimDlvp","description":"Delivery Address Information"},"claimFinalAmtInfo":{"$ref":"#/components/schemas/ClaimFinalAmtInfo","description":"Additional Payment/Refund Amount Information"},"wthdFnshWaitProcCaus":{"type":"string","description":"Pickup Completion Pending Reason"}},"required":["claimBusinessType","claimGoodsList","ordMediaCd","systemType"]},"ClaimGoodsRequest":{"type":"object","description":"Claim Requested Product Information DTO","properties":{"ordSeq":{"type":"integer","format":"int32","description":"Order Sequence No."},"ordProcSeq":{"type":"integer","format":"int32","description":"Order Processing Sequence No."},"goodsNo":{"type":"string","description":"Product No."},"itmNo":{"type":"string","description":"Item No."},"exchangeGoodsNo":{"type":"string","description":"Exchange Product No."},"exchangeItmNo":{"type":"string","description":"Exchange SKU No."},"exchangeItmNm":{"type":"string","description":"Exchange SKU Name"},"claimQty":{"type":"integer","format":"int32","description":"Claim Quantity"},"claimLgrpCd":{"type":"string","description":"Claim Major Classification Code (OM047)"},"claimMgrpCd":{"type":"string","description":"Claim Subcategory Code (OM006)","minLength":1},"claimCausEtcCont":{"type":"string","description":"Other Claim Reason Details"},"withdrawalDeliNo":{"type":"string","description":"Pickup Delivery No."},"shipmentDeliNo":{"type":"string","description":"Shipment Delivery No."}},"required":["claimMgrpCd","claimQty"]},"ClaimCpnInfo":{"type":"object","description":"Claim Coupon Information DTO","properties":{"cpnNo":{"type":"string","description":"Coupon Issuance No."}}},"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"]},"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":{"/v2/claim/return/completeReturn":{"post":{"tags":["Order Return"],"summary":"Return Completion","description":"## Function Description\nMarks a return receipt as complete.\n
\n---\n## Detailed Content\n* Calls the Order Return Completion API.
\n_API URL : /api/order/v1/claim/return/completeReturn_\n","operationId":"completeReturn","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClaimRequest"}}},"required":true},"responses":{"200":{"description":"OK"}}}}}}
```
## Return Receipt
> \## Function Description\
> Processes the receipt of a return target.\
> \
\
\
> \---\
> \## Detailed Content\
> \* Calls the Order Return Receipt (BO) API.\
\
\
> \_API URL : /api/order/v1/claim/return/acceptReturn\_\
> \---\
> \## Revision History\
> \* release\_231009\_01 : Added order quantity and cancellation quantity columns to the order benefit relationship table
```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":{"ClaimRequest":{"type":"object","description":"Claim Processing Request DTO","properties":{"systemType":{"type":"string","description":"System Type","enum":["FO","BO"],"minLength":1},"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},"ordMediaCd":{"type":"string","description":"Order Channel Code (OM007)","minLength":1},"ordNo":{"type":"string","description":"Order No."},"mbrNo":{"type":"string","description":"Member No."},"claimNo":{"type":"string","description":"Claim No."},"claimGoodsList":{"type":"array","description":"Claim Target Product Information List","items":{"$ref":"#/components/schemas/ClaimGoodsRequest"}},"claimCpnInfoList":{"type":"array","description":"Coupon List","items":{"$ref":"#/components/schemas/ClaimCpnInfo"}},"claimReturnDlvp":{"$ref":"#/components/schemas/ClaimDlvp","description":"Collection Location Information"},"claimDlvp":{"$ref":"#/components/schemas/ClaimDlvp","description":"Delivery Address Information"},"claimFinalAmtInfo":{"$ref":"#/components/schemas/ClaimFinalAmtInfo","description":"Additional Payment/Refund Amount Information"},"wthdFnshWaitProcCaus":{"type":"string","description":"Pickup Completion Pending Reason"}},"required":["claimBusinessType","claimGoodsList","ordMediaCd","systemType"]},"ClaimGoodsRequest":{"type":"object","description":"Claim Requested Product Information DTO","properties":{"ordSeq":{"type":"integer","format":"int32","description":"Order Sequence No."},"ordProcSeq":{"type":"integer","format":"int32","description":"Order Processing Sequence No."},"goodsNo":{"type":"string","description":"Product No."},"itmNo":{"type":"string","description":"Item No."},"exchangeGoodsNo":{"type":"string","description":"Exchange Product No."},"exchangeItmNo":{"type":"string","description":"Exchange SKU No."},"exchangeItmNm":{"type":"string","description":"Exchange SKU Name"},"claimQty":{"type":"integer","format":"int32","description":"Claim Quantity"},"claimLgrpCd":{"type":"string","description":"Claim Major Classification Code (OM047)"},"claimMgrpCd":{"type":"string","description":"Claim Subcategory Code (OM006)","minLength":1},"claimCausEtcCont":{"type":"string","description":"Other Claim Reason Details"},"withdrawalDeliNo":{"type":"string","description":"Pickup Delivery No."},"shipmentDeliNo":{"type":"string","description":"Shipment Delivery No."}},"required":["claimMgrpCd","claimQty"]},"ClaimCpnInfo":{"type":"object","description":"Claim Coupon Information DTO","properties":{"cpnNo":{"type":"string","description":"Coupon Issuance No."}}},"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"]},"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":{"/v2/claim/return/acceptReturn":{"post":{"tags":["Order Return"],"summary":"Return Receipt","description":"## Function Description\nProcesses the receipt of a return target.\n
\n---\n## Detailed Content\n* Calls the Order Return Receipt (BO) API.
\n_API URL : /api/order/v1/claim/return/acceptReturn_\n---\n## Revision History\n* release_231009_01 : Added order quantity and cancellation quantity columns to the order benefit relationship table\n","operationId":"acceptReturn","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClaimRequest"}}},"required":true},"responses":{"200":{"description":"OK"}}}}}}
```
## Retrieve Return Order
> \## Function Description\
> Retrieves the order return history.\
> \
\
\
> \---\
> \## Detailed Content\
> \* Retrieves targets matching the search conditions among order history whose order history type (OM003) is \*\*Return (20)\*\*. (→ excludes withdrawn cases)\
\
\
> \* When accessed via a partner site, the vendor number from the login information is added to the search conditions. (→ only orders related to the vendor's products are retrieved)\
\
```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":{"ReturnMgmtRequest":{"type":"object","description":"Return Order Inquiry Request DTO","properties":{"siteNo":{"type":"string","description":"Site No."},"entrNo":{"type":"string","description":"Vendor No."},"rtnAccpDtRng":{"type":"string","description":"Return Receipt Date Range","enum":["3","7","30","all"]},"rtnAccpStrDt":{"type":"string","format":"date","description":"Return Receipt Start Date"},"rtnAccpEndDt":{"type":"string","format":"date","description":"Return Receipt End Date"},"loginId":{"type":"string","description":"Login ID"},"ordDtlStatCd":{"type":"string","description":"Order Detail Status Code (OM005)"},"ordNoArr":{"type":"array","description":"Order No. Array","items":{"type":"string"}},"ordManNm":{"type":"string","description":"Orderer Name"},"rcvmnNm":{"type":"string","description":"Recipient Name"},"ordManCellNo":{"type":"string","description":"Orderer's Mobile Phone No."},"rcvmnCellNo":{"type":"string","description":"Recipient's Mobile Phone No."},"zipNo":{"type":"string","description":"Recipient's Postal Code"},"ordGbCd":{"type":"string","description":"Order Detail Classification Code (OM003)"},"deliKindCd":{"type":"string","description":"Delivery Type Code (LO009)"},"claimCausCd":{"type":"string","description":"Claim Subcategory Code (OM006)"},"goodsNoRng":{"type":"string","description":"Product Search Scope Code","enum":["st","in","eq","mt","rg"]},"goodsNo":{"type":"string","description":"Product No."},"goodsNoFrom":{"type":"string","description":"Product Start No."},"goodsNoTo":{"type":"string","description":"Product End No."},"goodsNoArr":{"type":"array","description":"Product No. Array","items":{"type":"string"}},"goodsNm":{"type":"string","description":"Product Name"}}},"RealGridListResponseReturnMgmtResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/ReturnMgmtResponse"}}}},"ReturnMgmtResponse":{"type":"object","description":"Return Order Inquiry Response DTO","properties":{"siteNm":{"type":"string","description":"Site Name"},"ordNo":{"type":"string","description":"Order No."},"ordSeq":{"type":"string","description":"Order Sequence No."},"ordProcSeq":{"type":"string","description":"Order Processing Sequence No."},"uprOrdProcSeq":{"type":"string","description":"Parent Order Processing Sequence No."},"claimNo":{"type":"string","description":"Claim 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"},"ordAccpDtm":{"type":"string","format":"date-time","description":"Return Reception Date/Time"},"ordFnshDtm":{"type":"string","format":"date-time","description":"Return Completion Date/Time"},"ordQty":{"type":"integer","format":"int32","description":"Return Quantity"},"claimLgrpCd":{"type":"string","description":"Claim Major Classification Code (OM047)"},"claimLgrpCdNm":{"type":"string","description":"Claim Major Category Code Name"},"claimMgrpCd":{"type":"string","description":"Claim Subcategory Code (OM006)"},"claimMgrpCdNm":{"type":"string","description":"Claim Subcategory Code Name"},"claimCausEtcCont":{"type":"string","description":"Other Claim Reason Details"},"wthdFnshGbCd":{"type":"string","description":"Collection Completion Classification Code (LO011)"},"wthdFnshGbCdNm":{"type":"string","description":"Collection Completion Type Code Name"},"goodsNo":{"type":"string","description":"Product No."},"itmNo":{"type":"string","description":"Item No."},"goodsNm":{"type":"string","description":"Product Name"},"itmNm":{"type":"string","description":"Item Name"},"brandNm":{"type":"string","description":"Brand Name"},"mbrNo":{"type":"string","description":"Member No."},"loginId":{"type":"string","description":"Login ID"},"mbrMgrCd":{"type":"string","description":"Member Management Code (ME002)"},"mbrGradeCd":{"type":"string","description":"Member Grade Code (ME008)"},"mbrGradeCdNm":{"type":"string","description":"Member Grade Code Name"},"instMbrYn":{"type":"string","description":"Interested Customer Status","enum":["Y","N"]},"ordManNm":{"type":"string","description":"Orderer Name"},"ordManCellNo":{"type":"string","description":"Orderer's Mobile Phone Number"},"ordManCellSctNo":{"type":"string","description":"Orderer's Mobile Phone Prefix Code"},"ordManCellTxnoNo":{"type":"string","description":"Orderer's Mobile Phone Exchange Code"},"ordManCellEndNo":{"type":"string","description":"Orderer's Mobile Phone Last Digits"},"rcvmnNm":{"type":"string","description":"Recipient Name"},"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"},"ordGbCdNm":{"type":"string","description":"Order Classification Code Name"},"entrNm":{"type":"string","description":"Vendor Name"},"mbrGbCdNm":{"type":"string","description":"Member Type Code Name"}}}}},"paths":{"/v1/claim/return/getReturnOrderList":{"post":{"tags":["Order Return"],"summary":"Retrieve Return Order","description":"## Function Description\nRetrieves the order return history.\n
\n---\n## Detailed Content\n* Retrieves targets matching the search conditions among order history whose order history type (OM003) is **Return (20)**. (→ excludes withdrawn cases)
\n* When accessed via a partner site, the vendor number from the login information is added to the search conditions. (→ only orders related to the vendor's products are retrieved)
\n","operationId":"getReturnOrderList","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReturnMgmtRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RealGridListResponseReturnMgmtResponse"}}}}}}}}}
```