> 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-exchange.md). # Order Exchange ## Withdraw Exchange Receipt > \## Function Description\ > \* Withdraws an exchange receipt target in BO.\ > \---\ > \## Detailed Description\ > \* \*\*Order No. (ordNo)\*\*, \*\*Claim Business Type (claimBusinessType)\*\*, and \*\*System Type (systemType)\*\* are required.\ > \* Exchange withdrawal processing is possible for targets that satisfy all of the following conditions.\ > \* The \*\*Order History Type (OM003)\*\* value is \*\*Exchange (30)\*\*\ > \* The \*\*Order History Status (OM005)\*\* value is \*\*Payment Pending (31)\*\*, \*\*Exchange Received (32)\*\*, or \*\*Collection Instruction (34)\*\*\ > \* Updates the existing \*\*order exchange data\*\* and creates \*\*order exchange withdrawal data\*\*.\ > \* \*\*Verifies\*\* the \*\*payment information\*\* that occurs upon exchange withdrawal.\ > \* Performs \*\*stock adjustment processing\*\*.\ > \---\ > \## Notes\ > \* Exchange receipt withdrawal proceeds only when \*\*Claim Business Type (claimBusinessType)\*\* is \*\*Exchange Withdrawal (31)\*\*.\ > \---\ > \## 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"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/claim/exchange/withdrawalExchange":{"post":{"tags":["Order Exchange"],"summary":"Withdraw Exchange Receipt","description":"## Function Description\n* Withdraws an exchange receipt target in BO.\n---\n## Detailed Description\n* **Order No. (ordNo)**, **Claim Business Type (claimBusinessType)**, and **System Type (systemType)** are required.\n* Exchange withdrawal processing is possible for targets that satisfy all of the following conditions.\n * The **Order History Type (OM003)** value is **Exchange (30)**\n * The **Order History Status (OM005)** value is **Payment Pending (31)**, **Exchange Received (32)**, or **Collection Instruction (34)**\n* Updates the existing **order exchange data** and creates **order exchange withdrawal data**.\n* **Verifies** the **payment information** that occurs upon exchange withdrawal.\n* Performs **stock adjustment processing**.\n---\n## Notes\n* Exchange receipt withdrawal proceeds only when **Claim Business Type (claimBusinessType)** is **Exchange Withdrawal (31)**.\n---\n## Revision History\n* release_231009_01 : Added order quantity and cancellation quantity columns to the order benefit relationship table\n","operationId":"withdrawalExchange","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClaimRequest"}}},"required":true},"responses":{"200":{"description":"Success"},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}} ``` ## Check Exchange Claim Option Change Target > \## Function Description\ > \* Checks whether the exchange claim option change target is valid in BO.\ > \---\ > \## Detailed Description\ > \* \*\*Product No. (goodsNo)\*\* and \*\*Item No. (itmNo)\*\* are required.\ > \* Checks all of the following conditions.\ > \* Checks whether the option change target's \*\*Sales Status Code (PR005)\*\* is \*\*On Sale (10)\*\*.\ > \* Checks whether the option change target's \*\*Sales Method Code (PR003)\*\* is \*\*General Sale (10)\*\*.\ > \* Checks whether the option change target has the same price as the existing target.\ > \* Checks the stock of the option change target.
```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":{"ClaimGoodsItmInfoRequest":{"type":"object","description":"Exchange Claim Option Change Target Request DTO","properties":{"goodsNo":{"type":"string","description":"Product No."},"itmNo":{"type":"string","description":"Item No."},"claimQty":{"type":"integer","format":"int32","description":"Claim Quantity"},"salePrc":{"type":"number","description":"Selling Price"}},"required":["goodsNo","itmNo"]},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/claim/exchange/isExistsExchangeGoodsItm":{"post":{"tags":["Order Exchange"],"summary":"Check Exchange Claim Option Change Target","description":"## Function Description\n* Checks whether the exchange claim option change target is valid in BO.\n---\n## Detailed Description\n* **Product No. (goodsNo)** and **Item No. (itmNo)** are required.\n* Checks all of the following conditions.\n * Checks whether the option change target's **Sales Status Code (PR005)** is **On Sale (10)**.\n * Checks whether the option change target's **Sales Method Code (PR003)** is **General Sale (10)**.\n * Checks whether the option change target has the same price as the existing target.\n * Checks the stock of the option change target.\n","operationId":"isExistsExchangeGoodsItm","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ClaimGoodsItmInfoRequest"}}}},"required":true},"responses":{"200":{"description":"Success"},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}} ``` ## Retrieve Return/Exchange Withdrawal Targets > \## Function Description\ > \* Retrieves return/exchange withdrawal targets in BO.\ > \---\ > \## Detailed Description\ > \* \*\*Order No. (ordNo)\*\*, \*\*Claim Business Type (claimBusinessType)\*\*, and \*\*System Type (systemType)\*\* are required.\ > \* Return/exchange withdrawal processing is possible for targets that satisfy all of the following conditions.\ > \* The \*\*Order History Type (OM003)\*\* value is \*\*Return (20)\*\* or \*\*Exchange (30)\*\*\ > \* The \*\*Order History Status (OM005)\*\* value is \*\*Payment Pending (31)\*\*, \*\*Return/Exchange Received (32)\*\*, or \*\*Collection Instruction (32)\*\*\ > \* The \*\*Return Available Status (rtnPsbYn)\*\* value is \*\*Y\*\*\ > \* The item is a general product \*\*(excluding free gifts)\*\*\ > \* The withdrawable quantity is 1 or more \*\*( Order Quantity – Cancellation Quantity – Return Quantity > 0 )\*\*\ > \---\ > \## 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":{"ClaimTargetRequest":{"type":"object","description":"Claim Eligibility Search 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"}},"required":["ordNo","systemType"]},"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"]},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/claim/exchange/getReturnExchangeCancelTargetInfo":{"post":{"tags":["Order Exchange"],"summary":"Retrieve Return/Exchange Withdrawal Targets","description":"## Function Description\n* Retrieves return/exchange withdrawal targets in BO.\n---\n## Detailed Description\n* **Order No. (ordNo)**, **Claim Business Type (claimBusinessType)**, and **System Type (systemType)** are required.\n* Return/exchange withdrawal processing is possible for targets that satisfy all of the following conditions.\n * The **Order History Type (OM003)** value is **Return (20)** or **Exchange (30)**\n * The **Order History Status (OM005)** value is **Payment Pending (31)**, **Return/Exchange Received (32)**, or **Collection Instruction (32)**\n * The **Return Available Status (rtnPsbYn)** value is **Y**\n * The item is a general product **(excluding free gifts)**\n * The withdrawable quantity is 1 or more **( Order Quantity – Cancellation Quantity – Return Quantity > 0 )**\n---\n## Revision History\n* Release v2.00_240729 : Added collection status (wthdYn)\n* Release v2.00_240829 : Updated masking processing\n","operationId":"getReturnExchangeCancelTargetInfo","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClaimTargetRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ClaimTargetResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}} ``` ## Retrieve Exchange Order List > \## Function Description\ > \* Retrieves the exchange order list in BO.\ > \---\ > \## Detailed Description\ > \* The order exchange quantity is 1 or more \*\*( Order Quantity – Cancellation Quantity – Return Quantity > 0 )\*\*\ > \* The \*\*Order History Type (OM003)\*\* value is \*\*Exchange (30)\*\*\ > \* In addition to the above (basic) conditions, further search conditions are added according to the given search conditions.\ > \* The exchange reason code is taken from entries in the claim middle-category code (OM006) whose ref\_1\_val is 30 (Exchange).\ > \---\ > \## Revision History\ > \* Release v2.00\_240613: Improved period search conditions\ > \* Release v2.00\_240919: Improved site, multi-product, and multi-order search conditions
```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":{"ExchangeSearchRequest":{"type":"object","description":"Exchange Order Inquiry Request DTO","properties":{"siteNo":{"type":"string","description":"Site No."},"entrNo":{"type":"string","description":"Vendor No."},"exchgStrtDt":{"type":"string","format":"date","description":"Search Condition Start Date"},"exchgEndDt":{"type":"string","format":"date","description":"Search Condition End Date"},"allDateYn":{"type":"boolean","description":"Full Period Status"},"loginId":{"type":"string","description":"Member ID"},"ordDtlStatCd":{"type":"string","description":"Order Detail Status Code (OM005)","enum":["REPAY_REQ","ORDER_ACCEPT","ORDER_COMPLETE","ORDER_CANCEL","DELIVERY_ORDER","SHIPPING_ORDER","SHIPPING_WAIT","SHIPPING_CONFIRM","SHIPPING_FINISH","DELIVERY_FINISH","RETURN_APPLY","RETURN_ACCEPT","RETURN_CANCEL","WITHDRAWAL_ORDER","WITHDRAWAL_FINISH_WAIT","WITHDRAWAL_FINISH","RETURN_FINISH"]},"ordNo":{"type":"string","description":"Order No."},"ordNoList":{"type":"array","description":"Order No. List","items":{"type":"string"}},"manNmOpt":{"type":"string","description":"Order/Recipient Condition"},"manNm":{"type":"string","description":"Order/Recipient Content"},"ordGbCd":{"type":"string","description":"Order Type Code (OM002) 10: General Order"},"deliKindCd":{"type":"string","description":"Delivery Type Code (LO009) 10: General Delivery, 20: Reserved Delivery"},"claimCausCd":{"type":"string","description":"Exchange Reason Code (OM006)"},"goodsNoRng":{"type":"string","description":"Product No. Condition"},"goodsNo":{"type":"string","description":"Product No."},"goodsNoList":{"type":"string","description":"Product No. List"},"goodsNos":{"type":"array","description":"Product No. List","items":{"type":"string"}},"goodsNoFrom":{"type":"string","description":"Start Product No."},"goodsNoTo":{"type":"string","description":"End Product No."},"goodsNm":{"type":"string","description":"Product Name"}}},"RealGridListResponseExchangeOrderResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/ExchangeOrderResponse"}}}},"ExchangeOrderResponse":{"type":"object","description":"Exchange Order Inquiry Response DTO","properties":{"siteNm":{"type":"string","description":"Site Name"},"ordNo":{"type":"string","description":"Order No."},"ordSeq":{"type":"string","description":"Order Sequence 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","description":"Exchange Receipt Date/Time"},"goodsNo":{"type":"string","description":"Product No."},"goodsNm":{"type":"string","description":"Product Name"},"itmNm":{"type":"string","description":"Item Name"},"brandNm":{"type":"string","description":"Brand Name"},"ordQty":{"type":"integer","format":"int32","description":"Order Quantity"},"claimMgrpCd":{"type":"string","description":"Claim Reason Code (OM006)"},"claimMgrpCdNm":{"type":"string","description":"Claim Reason Code Name"},"claimCausEtcCont":{"type":"string","description":"Other Claim Reason Details"},"loginId":{"type":"string","description":"Login ID"},"mbrGradeCdNm":{"type":"string","description":"Member Grade Code Name"},"mgrTypCd":{"type":"string","description":"Management Type Code (ME009)"},"mgrTypCdNm":{"type":"string","description":"Management Type Code Name"},"ordManNm":{"type":"string","description":"Orderer Name"},"ordManCellSctNo":{"type":"string","description":"Mobile Phone Prefix Code"},"ordManCellTxnoNo":{"type":"string","description":"Mobile Phone Exchange Code"},"ordManCellEndNo":{"type":"string","description":"Mobile Phone Last Digits"},"rcvmnNm":{"type":"string","description":"Recipient Name"},"deliIndiDtm":{"type":"string","description":"Delivery Instruction Date/Time"},"hdcCd":{"type":"string","description":"Courier Company Code (LO005)"},"hdcCdNm":{"type":"string","description":"Courier Company Code Name"},"invNo":{"type":"string","description":"Invoice No."},"mbrNo":{"type":"string","description":"Member No."},"ordGbCdNm":{"type":"string","description":"Order Classification Code Name"},"entrNm":{"type":"string","description":"Vendor Name"},"mbrGbCdNm":{"type":"string","description":"Member Type Code 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"},"instMbrYn":{"type":"string","description":"Interested Customer Status"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/claim/exchange/getExchangeOrderList":{"post":{"tags":["Order Exchange"],"summary":"Retrieve Exchange Order List","description":"## Function Description\n* Retrieves the exchange order list in BO.\n---\n## Detailed Description\n* The order exchange quantity is 1 or more **( Order Quantity – Cancellation Quantity – Return Quantity > 0 )**\n* The **Order History Type (OM003)** value is **Exchange (30)**\n * In addition to the above (basic) conditions, further search conditions are added according to the given search conditions.\n * The exchange reason code is taken from entries in the claim middle-category code (OM006) whose ref_1_val is 30 (Exchange).\n---\n## Revision History\n* Release v2.00_240613: Improved period search conditions\n* Release v2.00_240919: Improved site, multi-product, and multi-order search conditions\n","operationId":"getExchangeOrderList","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExchangeSearchRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RealGridListResponseExchangeOrderResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}} ``` ## Retrieve Order Exchange Targets > \## Function Description\ > \* Retrieves order exchange targets in BO.\ > \---\ > \## Detailed Description\ > \* \*\*Order No. (ordNo)\*\*, \*\*Claim Business Type (claimBusinessType)\*\*, and \*\*System Type (systemType)\*\* are required.\ > \* Exchange receipt processing is possible for targets that satisfy all of the following conditions.\ > \* The \*\*Order History Type (OM003)\*\* value is \*\*General Order (10)\*\* or \*\*Exchange (30)\*\*\ > \* The \*\*Order History Status (OM005)\*\* value is \*\*Shipment Complete (26)\*\* or \*\*Delivery Complete (27)\*\*\ > \* The \*\*Return Available Status (rtnPsbYn)\*\* value is \*\*Y\*\*\ > \* The item is a general product \*\*(excluding free gifts)\*\*\ > \* The exchangeable quantity is 1 or more \*\*( Order Quantity – Cancellation Quantity – Return Quantity > 0 )\*\*\ > \---\ > \## Notes\ > \* Exchange targets are retrieved only when \*\*Claim Business Type (claimBusinessType)\*\* is \*\*Exchange (30)\*\*.\ > \---\ > \## Revision History\ > \* release v2.00\_240409 : Fixed a typo in the Response DTO ( CaimTargetResponse -> ClaimTargetResponse )\ > \* Release v2.00\_240729 : Added collection status (wthdYn), collection-not-required order status (isAllNonReturnable)
```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":{"ClaimTargetRequest":{"type":"object","description":"Claim Eligibility Search 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"}},"required":["ordNo","systemType"]},"ExchangeTargetResponse":{"type":"object","description":"Exchange Order Claim Target Response DTO","properties":{"claimTargetResponse":{"$ref":"#/components/schemas/ClaimTargetResponse","description":"Claim Target"},"codeMap":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/StStdCd"}},"description":"Claim Common Code"}}},"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"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/claim/exchange/getExchageTargetInfo":{"post":{"tags":["Order Exchange"],"summary":"Retrieve Order Exchange Targets","description":"## Function Description\n* Retrieves order exchange targets in BO.\n---\n## Detailed Description\n* **Order No. (ordNo)**, **Claim Business Type (claimBusinessType)**, and **System Type (systemType)** are required.\n* Exchange receipt processing is possible for targets that satisfy all of the following conditions.\n * The **Order History Type (OM003)** value is **General Order (10)** or **Exchange (30)**\n * The **Order History Status (OM005)** value is **Shipment Complete (26)** or **Delivery Complete (27)**\n * The **Return Available Status (rtnPsbYn)** value is **Y**\n * The item is a general product **(excluding free gifts)**\n * The exchangeable quantity is 1 or more **( Order Quantity – Cancellation Quantity – Return Quantity > 0 )**\n---\n## Notes\n* Exchange targets are retrieved only when **Claim Business Type (claimBusinessType)** is **Exchange (30)**.\n---\n## Revision History\n* release v2.00_240409 : Fixed a typo in the Response DTO ( CaimTargetResponse -> ClaimTargetResponse )\n* Release v2.00_240729 : Added collection status (wthdYn), collection-not-required order status (isAllNonReturnable)\n","operationId":"getExchageTargetInfo","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClaimTargetRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExchangeTargetResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}} ``` ## Exchange Receipt > \## Function Description\ > \* Processes the receipt of an exchange target in BO.\ > \---\ > \## Detailed Description\ > \* \*\*Order No. (ordNo)\*\*, \*\*Claim Business Type (claimBusinessType)\*\*, and \*\*System Type (systemType)\*\* are required.\ > \* All exchange receipt targets must have the same delivery number to be received.\ > \* Checks whether the exchange receipt target includes a free gift (if a free gift is included, partial claim is not possible)\ > \* Exchange processing is possible for exchange targets that satisfy all of the following conditions.\ > \* Checks whether the product is valid.\ > \* Checks whether the \*\*Sales Status Code (PR005)\*\* of the product to be exchanged is \*\*On Sale (10)\*\*.\ > \* Checks whether the \*\*Sales Method Code (PR003)\*\* of the product to be exchanged is \*\*General Sale (10)\*\*.\ > \* Checks whether the product to be exchanged has the same price as the exchange target product.\ > \* Checks the stock of the product to be exchanged.\ > \* Creates and updates \*\*order exchange data\*\*.\ > \* If the \*\*Claim Major Category Code (claimLgrpCd)\*\* is \*\*Simple Change of Mind (10)\*\*, a shipping fee is incurred.\ > \* If an \*\*additional payment amount (shipping fee)\*\* occurs, the \*\*Order History Status (OM005)\*\* value changes to \*\*Payment Pending (31)\*\* instead of \*\*Exchange Received (32)\*\*.\ > \* If the status is \*\*Payment Pending (31)\*\*, payment must be made through the \*\*shipping fee payment\*\* screen in the \*\*FO\*\* for the status to become \*\*Exchange Received (32)\*\*.\ > \* \*\*Verifies\*\* the \*\*payment information\*\* that occurs upon exchange receipt.\ > \* Performs \*\*stock adjustment processing\*\*.\ > \* Processes \*\*notification message sending\*\* after exchange receipt.\ > \---\ > \## Notes\ > \* Exchange receipt proceeds only when \*\*Claim Business Type (claimBusinessType)\*\* is \*\*Exchange (30)\*\*.\ > \---\ > \## 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"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/claim/exchange/acceptExchange":{"post":{"tags":["Order Exchange"],"summary":"Exchange Receipt","description":"## Function Description\n* Processes the receipt of an exchange target in BO.\n---\n## Detailed Description\n* **Order No. (ordNo)**, **Claim Business Type (claimBusinessType)**, and **System Type (systemType)** are required.\n* All exchange receipt targets must have the same delivery number to be received.\n* Checks whether the exchange receipt target includes a free gift (if a free gift is included, partial claim is not possible)\n* Exchange processing is possible for exchange targets that satisfy all of the following conditions.\n * Checks whether the product is valid.\n * Checks whether the **Sales Status Code (PR005)** of the product to be exchanged is **On Sale (10)**.\n * Checks whether the **Sales Method Code (PR003)** of the product to be exchanged is **General Sale (10)**.\n * Checks whether the product to be exchanged has the same price as the exchange target product.\n * Checks the stock of the product to be exchanged.\n* Creates and updates **order exchange data**.\n * If the **Claim Major Category Code (claimLgrpCd)** is **Simple Change of Mind (10)**, a shipping fee is incurred.\n * If an **additional payment amount (shipping fee)** occurs, the **Order History Status (OM005)** value changes to **Payment Pending (31)** instead of **Exchange Received (32)**.\n * If the status is **Payment Pending (31)**, payment must be made through the **shipping fee payment** screen in the **FO** for the status to become **Exchange Received (32)**.\n* **Verifies** the **payment information** that occurs upon exchange receipt.\n* Performs **stock adjustment processing**.\n* Processes **notification message sending** after exchange receipt.\n---\n## Notes\n* Exchange receipt proceeds only when **Claim Business Type (claimBusinessType)** is **Exchange (30)**.\n---\n## Revision History\n* release_231009_01 : Added order quantity and cancellation quantity columns to the order benefit relationship table\n","operationId":"acceptExchange","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClaimRequest"}}},"required":true},"responses":{"200":{"description":"Success"},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}} ```