> 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-cancellation.md).
# Order Cancellation
## Retrieve Order Cancellation Popup Information (BO)
> \## Function Description\
> \* Retrieves the order history, the list of products eligible for cancellation, and other information needed for screen processing.\
> \---\
> \## Detailed Description\
> \* \*\*Order No. (ordNo), Claim Business Type (claimBusinessType), System Type (systemType)\*\* are required parameters.\
> \* Order cancellation processing is possible for targets that satisfy all of the following conditions.\
> \* The order history type (OM003) value is \*\*General Order (10)\*\*\
> \* The order history status (OM005) value is \*\*Order Complete (12)\*\*, \*\*Delivery Instruction (21)\*\*, \*\*Shipment Instruction (22)\*\*, or \*\*Awaiting Shipment (23)\*\*\
> \* The item is a general product (excluding free gifts)\
> \* The cancellable quantity is 1 or more ( \*\*Order Quantity – Cancellation Quantity – Return Quantity > 0\*\* )\
> \* The order cancellation available status is 'Y'\
> \* The other information included is as follows.\
> \* Order cancellation middle-category reason list\
> \* A map with the fault code as the key and the order cancellation middle-category reason as the value\
> \---\
> \## Revision History\
> \* Release v2.00\_240729 : Excludes targets whose order cancellation available status (ordCnclPsbYn) value is "N"
```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"]},"OrderCancelPopupResponse":{"type":"object","description":"Claim Eligibility Search Response DTO","properties":{"claimTargetResponse":{"$ref":"#/components/schemas/ClaimTargetResponse","description":"Claim Target"},"claimCausCdList":{"type":"array","description":"Claim Major Category Reason","items":{"$ref":"#/components/schemas/StStdCd"}},"claimMgrpRspnGbCdMap":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/StStdCd"},"description":"Claim Sub-Category Reason Map Keyed by Responsibility Type 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/orderCancel/getOrderCancelPopupInfo":{"post":{"tags":["Order Cancellation"],"summary":"Retrieve Order Cancellation Popup Information (BO)","description":"## Function Description\n* Retrieves the order history, the list of products eligible for cancellation, and other information needed for screen processing.\n---\n## Detailed Description\n* **Order No. (ordNo), Claim Business Type (claimBusinessType), System Type (systemType)** are required parameters.\n* Order cancellation processing is possible for targets that satisfy all of the following conditions.\n * The order history type (OM003) value is **General Order (10)**\n * The order history status (OM005) value is **Order Complete (12)**, **Delivery Instruction (21)**, **Shipment Instruction (22)**, or **Awaiting Shipment (23)**\n * The item is a general product (excluding free gifts)\n * The cancellable quantity is 1 or more ( **Order Quantity – Cancellation Quantity – Return Quantity > 0** )\n * The order cancellation available status is 'Y'\n* The other information included is as follows.\n * Order cancellation middle-category reason list\n * A map with the fault code as the key and the order cancellation middle-category reason as the value\n---\n## Revision History\n* Release v2.00_240729 : Excludes targets whose order cancellation available status (ordCnclPsbYn) value is \"N\"\n","operationId":"getOrderCancelPopupInfo","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClaimTargetRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OrderCancelPopupResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## Retrieve Order Cancellation History
> \## Function Description\
> \* Retrieves order cancellation history.\
> \---\
> \## Detailed Description\
> \* Retrieves order cancellation history matching the search request conditions, based on information whose order history type (OM003) value is \*\*General Order (10)\*\* and order history status type (OM005) value is \*\*Order Cancelled (13)\*\*.\
> \* Among the response values, the login ID and orderer's name related to personal information are masked.\
> \* 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":{"OrderCancelSearchRequest":{"type":"object","properties":{"entrNo":{"type":"string","description":"Vendor No."},"ordAccpDtmStart":{"type":"string","format":"date","description":"Order Receipt Search Start Date"},"ordAccpDtmEnd":{"type":"string","format":"date","description":"Order Receipt Search End Date"},"cnclDtRng":{"type":"string","description":"Search Range Date"},"loginId":{"type":"string","description":"Login ID"},"cnclOrdDtlStatCd":{"type":"string","description":"Order Cancellation Status Code"},"ordNo":{"type":"string","description":"Order No."},"ordManNm":{"type":"string","description":"Orderer Name"},"rcvmnNm":{"type":"string","description":"Recipient Name"},"ordManCellNo":{"type":"string","description":"Orderer's Contact Number"},"rcvmnCellNo":{"type":"string","description":"Recipient's Contact Number"},"zipNo":{"type":"string","description":"Postal Code"},"ordGbCd":{"type":"string","description":"Order Type Code"},"deliKindCd":{"type":"string","description":"Delivery Type Code"},"claimCausCd":{"type":"string","description":"Cancellation Reason Code"},"goodsNoRng":{"type":"string","description":"Product Search Scope Code"},"goodsNo":{"type":"string","description":"Product No."},"goodsNoFrom":{"type":"string","description":"Product Start No."},"goodsNoTo":{"type":"string","description":"Multiple Product No.s"},"goodsNoList":{"type":"string","description":"Product No."},"goodsNm":{"type":"string","description":"Product Name"}}},"RealGridListResponseOrderCancelSearchResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/OrderCancelSearchResponse"}}}},"OrderCancelSearchResponse":{"type":"object","properties":{"claimNo":{"type":"string","description":"Claim 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."},"siteNm":{"type":"string","description":"Site Name"},"siteNo":{"type":"string","description":"Site No."},"ordNo":{"type":"string","description":"Order No."},"ordDtlGbCdNm":{"type":"string","description":"Order Detail Type Code Name"},"ordCmptDtm":{"type":"string","format":"date-time","description":"Order Completion Date"},"ordAccpDtm":{"type":"string","format":"date-time","description":"Order Cancellation Receipt Date"},"goodsNo":{"type":"string","description":"Product No."},"goodsNm":{"type":"string","description":"Product Name"},"itmNo":{"type":"string","description":"Item No."},"itmNm":{"type":"string","description":"Item Name"},"cnclQty":{"type":"integer","format":"int32","description":"Cancellation Quantity"},"brandNo":{"type":"string","description":"Brand No."},"brandNm":{"type":"string","description":"Brand Name"},"claimMgrpCd":{"type":"string","description":"Claim Middle Category Code"},"claimMgrpCdNm":{"type":"string","description":"Claim Subcategory Code Name"},"loginId":{"type":"string"},"mbrGradeCd":{"type":"string","description":"Member Grade Code"},"mbrGradeCdNm":{"type":"string","description":"Member Grade Code Name"},"instMbrYn":{"type":"string","description":"Interested Customer Status"},"ordManNm":{"type":"string","description":"Orderer Name"},"deliKindCd":{"type":"string","description":"Delivery Type Code"},"deliKindCdNm":{"type":"string","description":"Delivery Method Code"},"payNo":{"type":"string","description":"Payment Number"},"payGbCd":{"type":"string","description":"Payment Classification Code (OM012)"},"payWayCd":{"type":"string","description":"Payment Method Code (OM013)"},"payWayCdNm":{"type":"string","description":"Payment Method Code Name"},"payStatCd":{"type":"string","description":"Payment Status Code (OM014)"},"payAmt":{"type":"number","description":"Payment/Refund Amount"},"totalAmt":{"type":"number","description":"Total Payment Amount"},"pgAmt":{"type":"number","description":"PG Payment Amount"},"mainAmt":{"type":"number","description":"Actual Payment Amount"},"mileageAmt":{"type":"number","description":"Mileage Payment Amount"},"ordGbCdNm":{"type":"string","description":"Order Classification Code Name"},"entrNm":{"type":"string","description":"Vendor Name"},"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"},"ordDtlStatCdNm":{"type":"string","description":"Order Detail Status Code Name"},"mbrGbCdNm":{"type":"string","description":"Member Type Code Name"},"mainPayWayCd":{"type":"boolean"},"mileagePayWayCd":{"type":"boolean"}}},"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/orderCancel/getOrderCancelList":{"post":{"tags":["Order Cancellation"],"summary":"Retrieve Order Cancellation History","description":"## Function Description\n* Retrieves order cancellation history.\n---\n## Detailed Description\n* Retrieves order cancellation history matching the search request conditions, based on information whose order history type (OM003) value is **General Order (10)** and order history status type (OM005) value is **Order Cancelled (13)**.\n* Among the response values, the login ID and orderer's name related to personal information are masked.\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":"getOrderCancelList","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderCancelSearchRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RealGridListResponseOrderCancelSearchResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## Process Order Cancellation (BO)
> \## Function Description\
> \* Processes an order cancellation.\
> \---\
> \## Detailed Description\
> \* Checks the order status at the time the order cancellation processing API is called, and verifies whether receipt is possible.\
> \* Validity verification of the order cancellation request data is performed on the following items.\
> \* Checks whether the received product includes a free gift (-> \*partial quantity claim not allowed\*)\
> \* Checks whether a payment method that does not allow partial cancellation is used (-> \*partial claim not allowed\*)\
> \* Checks whether there is an additional payment amount (-> \*claim not allowed in BO\*)\
> \* Creates and updates the order cancellation data.\
> \* Verifies the refund/payment amount that occurs upon order cancellation.\
> \* If a restorable coupon exists, the coupon is restored.\
> \* Stock is restored for the cancelled order product.\
> \* Refund/payment processing is performed.\
> \* Sends a notification to the customer regarding the order cancellation. (email/AlimTalk/notification box)\
> \---\
> \## Revision History\
> \* release\_231009\_01 : Added order quantity and cancellation quantity columns to the order benefit relationship table\
> \* Release v2.00\_240627: Removed the logic that checks whether the received product's delivery number matches (added full cancellation feature)
```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/orderCancel/cancel":{"post":{"tags":["Order Cancellation"],"summary":"Process Order Cancellation (BO)","description":"## Function Description\n* Processes an order cancellation.\n---\n## Detailed Description\n* Checks the order status at the time the order cancellation processing API is called, and verifies whether receipt is possible.\n* Validity verification of the order cancellation request data is performed on the following items.\n * Checks whether the received product includes a free gift (-> *partial quantity claim not allowed*)\n * Checks whether a payment method that does not allow partial cancellation is used (-> *partial claim not allowed*)\n * Checks whether there is an additional payment amount (-> *claim not allowed in BO*)\n* Creates and updates the order cancellation data.\n* Verifies the refund/payment amount that occurs upon order cancellation.\n* If a restorable coupon exists, the coupon is restored.\n* Stock is restored for the cancelled order product.\n* Refund/payment processing is performed.\n* Sends a notification to the customer regarding the order cancellation. (email/AlimTalk/notification box)\n---\n## Revision History\n* release_231009_01 : Added order quantity and cancellation quantity columns to the order benefit relationship table\n* Release v2.00_240627: Removed the logic that checks whether the received product's delivery number matches (added full cancellation feature)\n","operationId":"cancelOrder","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"}}}}}}}}}
```