> 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/store-front-api-reference/order-api/order-cancellation.md).
# Order Cancellation
## Cancel Gift Order (Batch)
> \## Function Description\
> \* Cancels the order.\
> \---\
> \## Detailed Description\
> \* Checks the order status at the time the order cancellation processing API is called to verify whether registration is possible.\
> \* Validates the order cancellation request data for the following items:\
> \* Checks whether the delivery number of the registered product matches (-> \*Claim not possible\*)\
> \* Checks whether the registered product includes a free gift (-> \*Partial quantity claim not possible\*)\
> \* Checks whether a payment method that does not allow partial cancellation was used (-> \*Partial claim not possible\*)\
> \* Checks whether there is an additional payment amount (-> \*Claim not possible from BO\*)\
> \* Creates and updates the order cancellation data.\
> \* Validates the refund/payment amounts arising from the order cancellation.\
> \* If there is a coupon to restore, the coupon is restored.\
> \* Stock is restored for the cancelled order products.\
> \* The refund/payment is processed.\
> \* Sends a notification to the customer for the order cancellation. (Email/AlimTalk/Notification box)
```json
{"openapi":"3.0.1","info":{"title":"X2BEE Order API","version":"v1"},"servers":[{"url":"https://api-order.x2bee.com/api/order/","description":"prd"}],"paths":{"/v1/claim/orderCancel/giftOrderCancelBatch":{"post":{"tags":["Order Cancellation"],"summary":"Cancel Gift Order (Batch)","description":"## Function Description\n* Cancels the order.\n---\n## Detailed Description\n* Checks the order status at the time the order cancellation processing API is called to verify whether registration is possible.\n* Validates the order cancellation request data for the following items:\n * Checks whether the delivery number of the registered product matches (-> *Claim not possible*)\n * Checks whether the registered product includes a free gift (-> *Partial quantity claim not possible*)\n * Checks whether a payment method that does not allow partial cancellation was used (-> *Partial claim not possible*)\n * Checks whether there is an additional payment amount (-> *Claim not possible from BO*)\n* Creates and updates the order cancellation data.\n* Validates the refund/payment amounts arising from the order cancellation.\n* If there is a coupon to restore, the coupon is restored.\n* Stock is restored for the cancelled order products.\n* The refund/payment is processed.\n* Sends a notification to the customer for the order cancellation. (Email/AlimTalk/Notification box)\n","operationId":"giftOrderCancelBatch","parameters":[{"name":"Authorization","in":"header","description":"Access Token","required":false}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ClaimRequest"}}}},"required":true},"responses":{"200":{"description":"Success"},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"components":{"schemas":{"ClaimRequest":{"required":["claimBusinessType","claimDlvp","claimGoodsList","claimNo","claimReturnDlvp","ordMediaCd","ordNo","systemType","wthdFnshWaitProcCaus"],"type":"object","properties":{"systemType":{"type":"string","description":" SYSTEM (System Type)\n * 10 : FO\n * 20 : BO\n","enum":["FO","BO"]},"claimBusinessType":{"type":"string","description":" ClaimBusiness (Claim Business Type)\n * 11 : Order Cancellation\n * 20 : Return Receipt\n * 21 : Return Cancellation\n * 30 : Exchange Receipt\n * 31 : Exchange Cancellation\n * 22 : Return Completed\n * 23 : Return Not Possible\n * 24 : Exchange Return\n * 25 : Return On Hold\n","enum":["ORDER_CANCEL","RETURN_ACCEPT","RETURN_WITHDRAWAL","EXCHANGE_ACCEPT","EXCHANGE_WITHDRAWAL","RETURN_COMPLETE","RETURN_REJECT","RETURN_TRANSFORM","RETURN_PENDING","DELIVERY_FEE_PAYMENT"]},"ordMediaCd":{"type":"string","description":"Order Channel Code (OM007)\n 10 : Phone Consultation (CC)\n, 20 : PC\n, 30 : Mobile Web\n, 40 : Android App\n, 50 : iOS App\n, 60 : Subscription Order\n","enum":["10","20","30","40","50","60"]},"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"}},"paymentRequest":{"$ref":"#/components/schemas/PaymentRequestPaymentInfo"},"claimCpnInfoList":{"type":"array","description":"Coupon List","items":{"$ref":"#/components/schemas/ClaimCpnInfo"}},"claimReturnDlvp":{"$ref":"#/components/schemas/ClaimDlvp"},"claimDlvp":{"$ref":"#/components/schemas/ClaimDlvp"},"claimFinalAmtInfo":{"$ref":"#/components/schemas/ClaimFinalAmtInfo"},"wthdFnshWaitProcCaus":{"type":"string","description":"Pickup Completion Pending Reason"},"occurPayment":{"type":"boolean"},"existAddtionPayAmt":{"type":"boolean"},"claimBusiness":{"type":"string","description":" ClaimBusiness (Claim Business Type)\n * 11 : Order Cancellation\n * 20 : Return Receipt\n * 21 : Return Cancellation\n * 30 : Exchange Receipt\n * 31 : Exchange Cancellation\n * 22 : Return Completed\n * 23 : Return Not Possible\n * 24 : Exchange Return\n * 25 : Return On Hold\n","enum":["ORDER_CANCEL","RETURN_ACCEPT","RETURN_WITHDRAWAL","EXCHANGE_ACCEPT","EXCHANGE_WITHDRAWAL","RETURN_COMPLETE","RETURN_REJECT","RETURN_TRANSFORM","RETURN_PENDING","DELIVERY_FEE_PAYMENT"]}},"description":"Claim Processing Request DTO"},"ClaimGoodsRequest":{"required":["claimLgrpCd","claimMgrpCd","claimQty","exchangeGoodsNo","exchangeItmNm","exchangeItmNo"],"type":"object","properties":{"ordSeq":{"type":"integer","description":"Order Sequence No.","format":"int32"},"ordProcSeq":{"type":"integer","description":"Order Processing Sequence No.","format":"int32"},"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","description":"Claim Quantity","format":"int32"},"claimLgrpCd":{"type":"string","description":"OM047(Claim Major Category Code)\n 10: Simple Change of Mind\n , 20: Defective Product\n , 30: Delivery Complaint\n , 40: Product Information Error\n , 50: Re-payment Order\n","enum":["SIMPLE_CHANGE","GOODS_BAD","DELIVERY_CLAIM","GOODS_INFOMATION_ERROR","REPAYMENT_ORDER"]},"claimMgrpCd":{"type":"string","description":"OM006(Claim Sub-Category Code)\n 100: Delivery Delayed\n , 101: Product Out of Stock\n , 102: Option/Size Change/Cancellation\n , 103: More Expensive Than Elsewhere\n , 104: Coupon/Discount Benefit Change\n , 105: No Longer Wish to Purchase\n , 106: Gift Change/Cancellation\n , 107: Payment Method Change (Purchase Gift Applied/Card Change, etc.)\n , 108: Purchased Similar Product\n , 109: Insufficient Product Information\n , 110: Seller Cancellation (Seller)\n , 111: Discretionary Cancellation (Agent)\n , 112: Automatic Cancellation (Insufficient Payment)\n , 113: Automatic Cancellation (Out-of-Stock Cancellation)\n , 300: Size Too Large\n , 301: Size Too Small\n , 302: Simple Change of Mind - Color Change\n , 303: Stained\n , 304: Damaged (Seam Tear, etc.)\n , 305: Missing Components (Necklace, Belt, etc.)\n , 306: Defective Contents (Cosmetics, etc.)\n , 307: Wrong Product Delivered\n , 308: Other\n , 200: Ordered Different Product\n , 201: Size Too Large\n , 203: Size Too Small\n , 204: Product Image Differs (Color, Design, Fit)\n , 205: No Longer Wish to Purchase\n , 206: No Color or Size Exchange Option Available\n , 207: Other\n , 208: Stained\n , 209: Damaged (Seam Tear, etc.)\n , 210: Missing Components (Necklace, Belt, etc.)\n , 211: Defective Contents (Cosmetics, etc.)\n , 212: Other\n , 213: Wrong Size Delivered\n , 214: Wrong Color Delivered\n , 215: Wrong Product Delivered\n , 216: Delivery Delayed\n , 217: Other\n , 218: Measured Size Error\n , 219: Material Error\n , 220: Color Error\n , 221: Differs From Product Description (Mislabeled)\n , 222: Other\n , 223: Return On Hold\n , 224: Return Not Possible\n","enum":["CLAIM_MGRP_CD_100","CLAIM_MGRP_CD_101","CLAIM_MGRP_CD_102","CLAIM_MGRP_CD_103","CLAIM_MGRP_CD_104","CLAIM_MGRP_CD_105","CLAIM_MGRP_CD_106","CLAIM_MGRP_CD_107","CLAIM_MGRP_CD_108","CLAIM_MGRP_CD_109","CLAIM_MGRP_CD_110","CLAIM_MGRP_CD_111","CLAIM_MGRP_CD_112","CLAIM_MGRP_CD_113","CLAIM_MGRP_CD_114","CLAIM_MGRP_CD_300","CLAIM_MGRP_CD_301","CLAIM_MGRP_CD_302","CLAIM_MGRP_CD_303","CLAIM_MGRP_CD_304","CLAIM_MGRP_CD_305","CLAIM_MGRP_CD_306","CLAIM_MGRP_CD_307","CLAIM_MGRP_CD_308","CLAIM_MGRP_CD_200","CLAIM_MGRP_CD_201","CLAIM_MGRP_CD_203","CLAIM_MGRP_CD_204","CLAIM_MGRP_CD_205","CLAIM_MGRP_CD_206","CLAIM_MGRP_CD_207","CLAIM_MGRP_CD_208","CLAIM_MGRP_CD_209","CLAIM_MGRP_CD_210","CLAIM_MGRP_CD_211","CLAIM_MGRP_CD_212","CLAIM_MGRP_CD_213","CLAIM_MGRP_CD_214","CLAIM_MGRP_CD_215","CLAIM_MGRP_CD_216","CLAIM_MGRP_CD_217","CLAIM_MGRP_CD_218","CLAIM_MGRP_CD_219","CLAIM_MGRP_CD_220","CLAIM_MGRP_CD_221","CLAIM_MGRP_CD_222","CLAIM_MGRP_CD_223","CLAIM_MGRP_CD_224"]},"claimCausEtcCont":{"type":"string","description":"Other Claim Reason Details"},"withdrawalDeliNo":{"type":"string","description":"Pickup Delivery No."},"shipmentDeliNo":{"type":"string","description":"Shipment Delivery No."},"prOrdDtlAtchFileInfoList":{"type":"array","description":"Attached Image List","items":{"$ref":"#/components/schemas/PrOrdDtlAtchFileInfo"}},"ordSeqAndOrdProcSeq":{"type":"string"}},"description":"Claim Requested Product Information DTO"},"PrOrdDtlAtchFileInfo":{"type":"object","properties":{"ordNo":{"type":"string","description":"Order No."},"ordSeq":{"type":"integer","description":"Order Sequence No.","format":"int32"},"ordProcSeq":{"type":"integer","description":"Order Processing Sequence No.","format":"int32"},"fileSeq":{"type":"string","description":"File Sequence No."},"filePathNm":{"type":"string","description":"File Path"},"fileNm":{"type":"string","description":"File Name"}},"description":"Order Detail Attachment File Info DTO"},"PaymentRequestPaymentInfo":{"type":"object","properties":{"siteNo":{"type":"string","description":"Site No."},"orderInfo":{"$ref":"#/components/schemas/PaymentOrderInfo"},"payInfoList":{"type":"array","description":"Order/Claim DTO Requesting Payment","items":{"$ref":"#/components/schemas/PaymentInfo"}}},"description":"Payment and Payment Cancellation DTO","nullable":true},"PaymentOrderInfo":{"type":"object","properties":{"ordNo":{"type":"string","description":"Order No."},"claimNo":{"type":"string","description":"Claim No."},"goodsNm":{"type":"string","description":"Product Name"},"ordManNm":{"type":"string","description":"Orderer Name"},"ordmnCellNo":{"type":"string","description":"Orderer's Mobile Phone Number"},"ordmnEmailAddr":{"type":"string","description":"Orderer Email Address"},"crcUnitCd":{"type":"string","description":"Currency Unit Code"},"ordMediaCd":{"type":"string","description":"Order Channel Code (OM007)"},"mbrNo":{"type":"string","description":"Member No."},"ordDtlGbCd":{"type":"string","description":"Order Detail Classification Code (OM003)"},"clientIp":{"type":"string","description":"Client IP"},"taxFreeAmt":{"type":"integer","description":"Tax-Exempt Amount","format":"int64"}},"description":"Order DTO Required for Payment"},"PaymentInfo":{"type":"object","properties":{"payNo":{"type":"string","description":"Payment Number"},"payWayCd":{"type":"string","description":"Payment Method Code (OM013)"},"payAmt":{"type":"integer","description":"Payment Amount","format":"int64"},"mersNo":{"type":"string","description":"Merchant Number"},"pgGbCd":{"type":"string","description":"PG Classification Code (OM030)"},"trdNo":{"type":"string","description":"Transaction No. (tid)"},"selectCardCd":{"type":"string","description":"Payment Request Card Company Code (OM057)"},"termlId":{"type":"string","description":"Terminal ID (mid)"},"billKey":{"type":"string","description":"Billing Key Value to Request Approval"},"authResultMap":{"type":"object","additionalProperties":{"type":"string","description":"Verification Result Information"},"description":"Verification Result Information"}},"description":"Payment DTO"},"ClaimCpnInfo":{"type":"object","properties":{"cpnNo":{"type":"string","description":"Coupon Issuance No."}},"description":"Claim Coupon Information DTO"},"ClaimDlvp":{"required":["dlvpNm","dtlAddr","rcvmnNm","zipAddr","zipNo"],"type":"object","properties":{"mbrOrdDlvpGb":{"type":"string","description":" ClaimDlvpGbCd (Claim Delivery Address Type)\n * 10 : Member Delivery Address\n * 20 : Order Delivery Address\n","enum":["MBR","ORD"]},"dlvpSeq":{"type":"string","description":"Delivery Address Sequence No."},"zipNoSeq":{"type":"integer","description":"Postal Code Sequence No.","format":"int64"},"dlvpNm":{"type":"string","description":"Delivery Address Name"},"rcvmnNm":{"type":"string","description":"Recipient Name"},"zipNo":{"type":"string","description":"Postal Code"},"zipAddr":{"type":"string","description":"Postal Address"},"dtlAddr":{"type":"string","description":"Detailed 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 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) 20: Please call before delivery, 30: Leave at the door if absent, 40: Leave with security desk if absent, 50: Please deliver quickly, 60: Please call my mobile if absent, 70: Enter manually"},"shopTrafMsg":{"type":"string","description":"Store Delivery Message"},"comnFrdrCogoMethodCd":{"type":"string","description":"Common Entrance Access Method Code (ME040) 10: Entrance access code, 20: Free access, 30: Other","default":"20"},"comnFrdrEtcMethod":{"type":"string","description":"Other Common Entrance Access Method"},"comnFrdrPwd":{"type":"string","description":"Common Entrance Password"}},"description":"Claim Delivery Information DTO"},"ClaimFinalAmtInfo":{"type":"object","properties":{"ordNo":{"type":"string","description":"Order No."},"totAplyAdtnAmt":{"type":"integer","description":"Total Delivery Fee Incurred Amount","format":"int64"},"totCnclAdtnAmt":{"type":"integer","description":"Total Cancelled Delivery Fee Amount","format":"int64"},"totFvrAdtnAmt":{"type":"integer","description":"Total Benefit Delivery Fee Amount","format":"int64"},"totOrdPrc":{"type":"integer","description":"Claim Product Amount","format":"int64"},"totDcAmt":{"type":"integer","description":"Claim Cancellation Discount Amount","format":"int64"},"expectedRefundAmt":{"type":"integer","description":"Expected Refund Amount","format":"int64"},"addtionPayAmt":{"type":"integer","description":"Additional Payment Amount","format":"int64"},"returnAcceptAmt":{"type":"integer","description":"Return Received Amount","format":"int64"},"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"}},"paymentOrderInfo":{"$ref":"#/components/schemas/PaymentOrderInfo"},"rfdInfoResponse":{"$ref":"#/components/schemas/RfdInfoResponse"}},"description":"Claim Final Payment/Refund Amount Information DTO"},"RefundAdditionAmtInfo":{"type":"object","properties":{"adtnOcurGbCd":{"type":"string","description":"OM017 (Additional Cost Occurrence Classification Code)\n 10: Occurred\n , 20: Cancelled\n","enum":["OCCURRNECE","CANCEL"]},"adtnOcurGbNm":{"type":"string","description":"Additional Cost Occurrence Type Name"},"type":{"type":"string","description":" ClaimAmountType (Claim Additional Cost Type)\n * 10 : Shipping Fee\n * 20 : Collection Shipping Fee\n * 30 : Exchange Shipping Fee\n * 40 : Product\n * 50 : Additional Shipping Fee\n * 60 : Free Gift\n","enum":["DELIVERY_FEE","RETURN_FEE","EXCHANGE_FEE","GOODS","EXTRA_FEE","GIFTS"]},"typeNm":{"type":"string","description":"Type Classification Name"},"goodsNoItmNo":{"type":"string","description":"Product No.+SKU No."},"goodsNm":{"type":"string","description":"Product Name"},"ordAmt":{"type":"integer","description":"Payment Amount","format":"int64"},"discountMethod":{"type":"string","description":"OM019 (Additional Cost Detail Type Code)\n 11: Product Discount Coupon\n , 12: Cart Coupon\n , 13: Stackable Discount Coupon\n , 14: Free Shipping Coupon\n , 15: Free Return Coupon\n , 20: Employee Discount\n , 21: Instant Product Discount\n , 51: Product Free Gift\n , 40: Promotion Accrual\n , 41: Basic Accrual\n , 42: Membership Tier Additional Accrual\n","enum":["GOODS_DISCOUNT","SHOPPING_BASKET","REDUNDANT_DISCOUNT","FREE_DELIVERY","FREE_RETURN","EXECUTIVES","GOODS_DIRECT","GOODS_GIFTS","MILEAGE","BASIC_ACCUMULATION","MBR_GRADE_ACCUMULATION"]},"discountMethodNm":{"type":"string","description":"Benefit Detail Information Name"},"cnclDcAmt":{"type":"integer","description":"Cancellation Benefit Amount","format":"int64"},"rtnDlvBenefitInfoList":{"type":"array","description":"Return Coupon Information List","items":{"$ref":"#/components/schemas/ClaimDlvBenefitInfo"}},"reCalAdtnOcurGbCdAdtnAmt":{"type":"integer","format":"int64"}},"description":"Additional Payment/Refund Information DTO"},"ClaimDlvBenefitInfo":{"type":"object","properties":{"promoNo":{"type":"string","description":"Coupon No."},"promoNm":{"type":"string","description":"Coupon Name"},"promoTypCd":{"type":"string","description":"Promotion Type Code (MK002)\n 11 : Product Discount Coupon\n , 12 : Cart Coupon\n , 13 : Stackable Discount Coupon\n , 14 : Free Shipping Coupon\n , 15 : Free Return Coupon\n , 20 : Employee Discount\n , 21 : Instant Product Discount\n , 40 : Product Mileage\n","enum":["11","12","13","14","15","20","21","40"]},"ourChrgRate":{"type":"integer","description":"Company Cost-Sharing Rate","format":"int32"},"entrChrgRate":{"type":"integer","description":"Vendor Cost-Sharing Rate","format":"int32"},"cpnIsuNo":{"type":"string","description":"Coupon Issuance No."},"aplyYn":{"type":"string","description":"Application Status","enum":["Y","N"]}},"description":"Return Coupon Information List"},"PaymentClaimResponse":{"type":"object","properties":{"payNo":{"type":"string","description":"Payment Number"},"mbrNo":{"type":"string","description":"Member No."},"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":"integer","description":"Payment Amount","format":"int64"},"taxFreeAmt":{"type":"integer","description":"Tax-Exempt Price","format":"int64"},"rfdPsbAmt":{"type":"integer","description":"Refundable Amount","format":"int64"},"rfdAmt":{"type":"integer","description":"Refund Amount","format":"int64"},"payFnshDtm":{"type":"string","description":"Payment Completion Date/Time","format":"date-time"},"trdNo":{"type":"string","description":"Transaction No. (tid)"},"trdDtm":{"type":"string","description":"Transaction Date/Time","format":"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","description":"Installment Months","format":"int32"},"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","description":"Approval Date/Time","format":"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","description":"Deposit Confirmation Date/Time","format":"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"},"vbankPaymentPending":{"type":"boolean"},"vbankDptCnfm":{"type":"boolean"}},"description":"Refundable Payment Method DTO"},"RfdInfoResponse":{"type":"object","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"}},"description":"Refund Account Information Retrieval Response"},"Response":{"type":"object","properties":{"timestamp":{"type":"string","description":"result time","format":"date-time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"type":"object","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"}},"description":"validation error list"}}}}
```
## Cancel Virtual Account Order Past Payment Deadline (Batch)
> \## Function Description\
> \* Automatically cancels virtual account orders that have exceeded the payment deadline.\
> \---\
> \## Detailed Description\
> \* Performs batch cancellation processing for virtual account orders that have exceeded the payment deadline.\
> \* Checks the order status at the time the order cancellation processing API is called to verify whether registration is possible.\
> \* Validates the order cancellation request data for the following items:\
> \* Checks whether the registered product includes a free gift (-> \*Partial quantity claim not possible\*)\
> \* Checks whether a payment method that does not allow partial cancellation was used (-> \*Partial claim not possible\*)\
> \* Creates and updates the order cancellation data.\
> \* Validates the refund/payment amounts arising from the order cancellation.\
> \* If there is a coupon to restore, the coupon is restored.\
> \* Stock is restored for the cancelled order products.\
> \* The refund/payment is processed.\
> \* Sends a notification to the customer for the order cancellation. (Email/AlimTalk/Notification box)
```json
{"openapi":"3.0.1","info":{"title":"X2BEE Order API","version":"v1"},"servers":[{"url":"https://api-order.x2bee.com/api/order/","description":"prd"}],"paths":{"/v1/claim/orderCancel/dptExpiredCancelBatch":{"post":{"tags":["Order Cancellation"],"summary":"Cancel Virtual Account Order Past Payment Deadline (Batch)","description":"## Function Description\n* Automatically cancels virtual account orders that have exceeded the payment deadline.\n---\n## Detailed Description\n* Performs batch cancellation processing for virtual account orders that have exceeded the payment deadline.\n* Checks the order status at the time the order cancellation processing API is called to verify whether registration is possible.\n* Validates the order cancellation request data for the following items:\n * Checks whether the registered product includes a free gift (-> *Partial quantity claim not possible*)\n * Checks whether a payment method that does not allow partial cancellation was used (-> *Partial claim not possible*)\n* Creates and updates the order cancellation data.\n* Validates the refund/payment amounts arising from the order cancellation.\n* If there is a coupon to restore, the coupon is restored.\n* Stock is restored for the cancelled order products.\n* The refund/payment is processed.\n* Sends a notification to the customer for the order cancellation. (Email/AlimTalk/Notification box)\n","operationId":"dptExpiredCancelBatch","parameters":[{"name":"Authorization","in":"header","description":"Access Token","required":false}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ClaimRequest"}}}},"required":true},"responses":{"200":{"description":"Success"},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"components":{"schemas":{"ClaimRequest":{"required":["claimBusinessType","claimDlvp","claimGoodsList","claimNo","claimReturnDlvp","ordMediaCd","ordNo","systemType","wthdFnshWaitProcCaus"],"type":"object","properties":{"systemType":{"type":"string","description":" SYSTEM (System Type)\n * 10 : FO\n * 20 : BO\n","enum":["FO","BO"]},"claimBusinessType":{"type":"string","description":" ClaimBusiness (Claim Business Type)\n * 11 : Order Cancellation\n * 20 : Return Receipt\n * 21 : Return Cancellation\n * 30 : Exchange Receipt\n * 31 : Exchange Cancellation\n * 22 : Return Completed\n * 23 : Return Not Possible\n * 24 : Exchange Return\n * 25 : Return On Hold\n","enum":["ORDER_CANCEL","RETURN_ACCEPT","RETURN_WITHDRAWAL","EXCHANGE_ACCEPT","EXCHANGE_WITHDRAWAL","RETURN_COMPLETE","RETURN_REJECT","RETURN_TRANSFORM","RETURN_PENDING","DELIVERY_FEE_PAYMENT"]},"ordMediaCd":{"type":"string","description":"Order Channel Code (OM007)\n 10 : Phone Consultation (CC)\n, 20 : PC\n, 30 : Mobile Web\n, 40 : Android App\n, 50 : iOS App\n, 60 : Subscription Order\n","enum":["10","20","30","40","50","60"]},"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"}},"paymentRequest":{"$ref":"#/components/schemas/PaymentRequestPaymentInfo"},"claimCpnInfoList":{"type":"array","description":"Coupon List","items":{"$ref":"#/components/schemas/ClaimCpnInfo"}},"claimReturnDlvp":{"$ref":"#/components/schemas/ClaimDlvp"},"claimDlvp":{"$ref":"#/components/schemas/ClaimDlvp"},"claimFinalAmtInfo":{"$ref":"#/components/schemas/ClaimFinalAmtInfo"},"wthdFnshWaitProcCaus":{"type":"string","description":"Pickup Completion Pending Reason"},"occurPayment":{"type":"boolean"},"existAddtionPayAmt":{"type":"boolean"},"claimBusiness":{"type":"string","description":" ClaimBusiness (Claim Business Type)\n * 11 : Order Cancellation\n * 20 : Return Receipt\n * 21 : Return Cancellation\n * 30 : Exchange Receipt\n * 31 : Exchange Cancellation\n * 22 : Return Completed\n * 23 : Return Not Possible\n * 24 : Exchange Return\n * 25 : Return On Hold\n","enum":["ORDER_CANCEL","RETURN_ACCEPT","RETURN_WITHDRAWAL","EXCHANGE_ACCEPT","EXCHANGE_WITHDRAWAL","RETURN_COMPLETE","RETURN_REJECT","RETURN_TRANSFORM","RETURN_PENDING","DELIVERY_FEE_PAYMENT"]}},"description":"Claim Processing Request DTO"},"ClaimGoodsRequest":{"required":["claimLgrpCd","claimMgrpCd","claimQty","exchangeGoodsNo","exchangeItmNm","exchangeItmNo"],"type":"object","properties":{"ordSeq":{"type":"integer","description":"Order Sequence No.","format":"int32"},"ordProcSeq":{"type":"integer","description":"Order Processing Sequence No.","format":"int32"},"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","description":"Claim Quantity","format":"int32"},"claimLgrpCd":{"type":"string","description":"OM047(Claim Major Category Code)\n 10: Simple Change of Mind\n , 20: Defective Product\n , 30: Delivery Complaint\n , 40: Product Information Error\n , 50: Re-payment Order\n","enum":["SIMPLE_CHANGE","GOODS_BAD","DELIVERY_CLAIM","GOODS_INFOMATION_ERROR","REPAYMENT_ORDER"]},"claimMgrpCd":{"type":"string","description":"OM006(Claim Sub-Category Code)\n 100: Delivery Delayed\n , 101: Product Out of Stock\n , 102: Option/Size Change/Cancellation\n , 103: More Expensive Than Elsewhere\n , 104: Coupon/Discount Benefit Change\n , 105: No Longer Wish to Purchase\n , 106: Gift Change/Cancellation\n , 107: Payment Method Change (Purchase Gift Applied/Card Change, etc.)\n , 108: Purchased Similar Product\n , 109: Insufficient Product Information\n , 110: Seller Cancellation (Seller)\n , 111: Discretionary Cancellation (Agent)\n , 112: Automatic Cancellation (Insufficient Payment)\n , 113: Automatic Cancellation (Out-of-Stock Cancellation)\n , 300: Size Too Large\n , 301: Size Too Small\n , 302: Simple Change of Mind - Color Change\n , 303: Stained\n , 304: Damaged (Seam Tear, etc.)\n , 305: Missing Components (Necklace, Belt, etc.)\n , 306: Defective Contents (Cosmetics, etc.)\n , 307: Wrong Product Delivered\n , 308: Other\n , 200: Ordered Different Product\n , 201: Size Too Large\n , 203: Size Too Small\n , 204: Product Image Differs (Color, Design, Fit)\n , 205: No Longer Wish to Purchase\n , 206: No Color or Size Exchange Option Available\n , 207: Other\n , 208: Stained\n , 209: Damaged (Seam Tear, etc.)\n , 210: Missing Components (Necklace, Belt, etc.)\n , 211: Defective Contents (Cosmetics, etc.)\n , 212: Other\n , 213: Wrong Size Delivered\n , 214: Wrong Color Delivered\n , 215: Wrong Product Delivered\n , 216: Delivery Delayed\n , 217: Other\n , 218: Measured Size Error\n , 219: Material Error\n , 220: Color Error\n , 221: Differs From Product Description (Mislabeled)\n , 222: Other\n , 223: Return On Hold\n , 224: Return Not Possible\n","enum":["CLAIM_MGRP_CD_100","CLAIM_MGRP_CD_101","CLAIM_MGRP_CD_102","CLAIM_MGRP_CD_103","CLAIM_MGRP_CD_104","CLAIM_MGRP_CD_105","CLAIM_MGRP_CD_106","CLAIM_MGRP_CD_107","CLAIM_MGRP_CD_108","CLAIM_MGRP_CD_109","CLAIM_MGRP_CD_110","CLAIM_MGRP_CD_111","CLAIM_MGRP_CD_112","CLAIM_MGRP_CD_113","CLAIM_MGRP_CD_114","CLAIM_MGRP_CD_300","CLAIM_MGRP_CD_301","CLAIM_MGRP_CD_302","CLAIM_MGRP_CD_303","CLAIM_MGRP_CD_304","CLAIM_MGRP_CD_305","CLAIM_MGRP_CD_306","CLAIM_MGRP_CD_307","CLAIM_MGRP_CD_308","CLAIM_MGRP_CD_200","CLAIM_MGRP_CD_201","CLAIM_MGRP_CD_203","CLAIM_MGRP_CD_204","CLAIM_MGRP_CD_205","CLAIM_MGRP_CD_206","CLAIM_MGRP_CD_207","CLAIM_MGRP_CD_208","CLAIM_MGRP_CD_209","CLAIM_MGRP_CD_210","CLAIM_MGRP_CD_211","CLAIM_MGRP_CD_212","CLAIM_MGRP_CD_213","CLAIM_MGRP_CD_214","CLAIM_MGRP_CD_215","CLAIM_MGRP_CD_216","CLAIM_MGRP_CD_217","CLAIM_MGRP_CD_218","CLAIM_MGRP_CD_219","CLAIM_MGRP_CD_220","CLAIM_MGRP_CD_221","CLAIM_MGRP_CD_222","CLAIM_MGRP_CD_223","CLAIM_MGRP_CD_224"]},"claimCausEtcCont":{"type":"string","description":"Other Claim Reason Details"},"withdrawalDeliNo":{"type":"string","description":"Pickup Delivery No."},"shipmentDeliNo":{"type":"string","description":"Shipment Delivery No."},"prOrdDtlAtchFileInfoList":{"type":"array","description":"Attached Image List","items":{"$ref":"#/components/schemas/PrOrdDtlAtchFileInfo"}},"ordSeqAndOrdProcSeq":{"type":"string"}},"description":"Claim Requested Product Information DTO"},"PrOrdDtlAtchFileInfo":{"type":"object","properties":{"ordNo":{"type":"string","description":"Order No."},"ordSeq":{"type":"integer","description":"Order Sequence No.","format":"int32"},"ordProcSeq":{"type":"integer","description":"Order Processing Sequence No.","format":"int32"},"fileSeq":{"type":"string","description":"File Sequence No."},"filePathNm":{"type":"string","description":"File Path"},"fileNm":{"type":"string","description":"File Name"}},"description":"Order Detail Attachment File Info DTO"},"PaymentRequestPaymentInfo":{"type":"object","properties":{"siteNo":{"type":"string","description":"Site No."},"orderInfo":{"$ref":"#/components/schemas/PaymentOrderInfo"},"payInfoList":{"type":"array","description":"Order/Claim DTO Requesting Payment","items":{"$ref":"#/components/schemas/PaymentInfo"}}},"description":"Payment and Payment Cancellation DTO","nullable":true},"PaymentOrderInfo":{"type":"object","properties":{"ordNo":{"type":"string","description":"Order No."},"claimNo":{"type":"string","description":"Claim No."},"goodsNm":{"type":"string","description":"Product Name"},"ordManNm":{"type":"string","description":"Orderer Name"},"ordmnCellNo":{"type":"string","description":"Orderer's Mobile Phone Number"},"ordmnEmailAddr":{"type":"string","description":"Orderer Email Address"},"crcUnitCd":{"type":"string","description":"Currency Unit Code"},"ordMediaCd":{"type":"string","description":"Order Channel Code (OM007)"},"mbrNo":{"type":"string","description":"Member No."},"ordDtlGbCd":{"type":"string","description":"Order Detail Classification Code (OM003)"},"clientIp":{"type":"string","description":"Client IP"},"taxFreeAmt":{"type":"integer","description":"Tax-Exempt Amount","format":"int64"}},"description":"Order DTO Required for Payment"},"PaymentInfo":{"type":"object","properties":{"payNo":{"type":"string","description":"Payment Number"},"payWayCd":{"type":"string","description":"Payment Method Code (OM013)"},"payAmt":{"type":"integer","description":"Payment Amount","format":"int64"},"mersNo":{"type":"string","description":"Merchant Number"},"pgGbCd":{"type":"string","description":"PG Classification Code (OM030)"},"trdNo":{"type":"string","description":"Transaction No. (tid)"},"selectCardCd":{"type":"string","description":"Payment Request Card Company Code (OM057)"},"termlId":{"type":"string","description":"Terminal ID (mid)"},"billKey":{"type":"string","description":"Billing Key Value to Request Approval"},"authResultMap":{"type":"object","additionalProperties":{"type":"string","description":"Verification Result Information"},"description":"Verification Result Information"}},"description":"Payment DTO"},"ClaimCpnInfo":{"type":"object","properties":{"cpnNo":{"type":"string","description":"Coupon Issuance No."}},"description":"Claim Coupon Information DTO"},"ClaimDlvp":{"required":["dlvpNm","dtlAddr","rcvmnNm","zipAddr","zipNo"],"type":"object","properties":{"mbrOrdDlvpGb":{"type":"string","description":" ClaimDlvpGbCd (Claim Delivery Address Type)\n * 10 : Member Delivery Address\n * 20 : Order Delivery Address\n","enum":["MBR","ORD"]},"dlvpSeq":{"type":"string","description":"Delivery Address Sequence No."},"zipNoSeq":{"type":"integer","description":"Postal Code Sequence No.","format":"int64"},"dlvpNm":{"type":"string","description":"Delivery Address Name"},"rcvmnNm":{"type":"string","description":"Recipient Name"},"zipNo":{"type":"string","description":"Postal Code"},"zipAddr":{"type":"string","description":"Postal Address"},"dtlAddr":{"type":"string","description":"Detailed 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 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) 20: Please call before delivery, 30: Leave at the door if absent, 40: Leave with security desk if absent, 50: Please deliver quickly, 60: Please call my mobile if absent, 70: Enter manually"},"shopTrafMsg":{"type":"string","description":"Store Delivery Message"},"comnFrdrCogoMethodCd":{"type":"string","description":"Common Entrance Access Method Code (ME040) 10: Entrance access code, 20: Free access, 30: Other","default":"20"},"comnFrdrEtcMethod":{"type":"string","description":"Other Common Entrance Access Method"},"comnFrdrPwd":{"type":"string","description":"Common Entrance Password"}},"description":"Claim Delivery Information DTO"},"ClaimFinalAmtInfo":{"type":"object","properties":{"ordNo":{"type":"string","description":"Order No."},"totAplyAdtnAmt":{"type":"integer","description":"Total Delivery Fee Incurred Amount","format":"int64"},"totCnclAdtnAmt":{"type":"integer","description":"Total Cancelled Delivery Fee Amount","format":"int64"},"totFvrAdtnAmt":{"type":"integer","description":"Total Benefit Delivery Fee Amount","format":"int64"},"totOrdPrc":{"type":"integer","description":"Claim Product Amount","format":"int64"},"totDcAmt":{"type":"integer","description":"Claim Cancellation Discount Amount","format":"int64"},"expectedRefundAmt":{"type":"integer","description":"Expected Refund Amount","format":"int64"},"addtionPayAmt":{"type":"integer","description":"Additional Payment Amount","format":"int64"},"returnAcceptAmt":{"type":"integer","description":"Return Received Amount","format":"int64"},"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"}},"paymentOrderInfo":{"$ref":"#/components/schemas/PaymentOrderInfo"},"rfdInfoResponse":{"$ref":"#/components/schemas/RfdInfoResponse"}},"description":"Claim Final Payment/Refund Amount Information DTO"},"RefundAdditionAmtInfo":{"type":"object","properties":{"adtnOcurGbCd":{"type":"string","description":"OM017 (Additional Cost Occurrence Classification Code)\n 10: Occurred\n , 20: Cancelled\n","enum":["OCCURRNECE","CANCEL"]},"adtnOcurGbNm":{"type":"string","description":"Additional Cost Occurrence Type Name"},"type":{"type":"string","description":" ClaimAmountType (Claim Additional Cost Type)\n * 10 : Shipping Fee\n * 20 : Collection Shipping Fee\n * 30 : Exchange Shipping Fee\n * 40 : Product\n * 50 : Additional Shipping Fee\n * 60 : Free Gift\n","enum":["DELIVERY_FEE","RETURN_FEE","EXCHANGE_FEE","GOODS","EXTRA_FEE","GIFTS"]},"typeNm":{"type":"string","description":"Type Classification Name"},"goodsNoItmNo":{"type":"string","description":"Product No.+SKU No."},"goodsNm":{"type":"string","description":"Product Name"},"ordAmt":{"type":"integer","description":"Payment Amount","format":"int64"},"discountMethod":{"type":"string","description":"OM019 (Additional Cost Detail Type Code)\n 11: Product Discount Coupon\n , 12: Cart Coupon\n , 13: Stackable Discount Coupon\n , 14: Free Shipping Coupon\n , 15: Free Return Coupon\n , 20: Employee Discount\n , 21: Instant Product Discount\n , 51: Product Free Gift\n , 40: Promotion Accrual\n , 41: Basic Accrual\n , 42: Membership Tier Additional Accrual\n","enum":["GOODS_DISCOUNT","SHOPPING_BASKET","REDUNDANT_DISCOUNT","FREE_DELIVERY","FREE_RETURN","EXECUTIVES","GOODS_DIRECT","GOODS_GIFTS","MILEAGE","BASIC_ACCUMULATION","MBR_GRADE_ACCUMULATION"]},"discountMethodNm":{"type":"string","description":"Benefit Detail Information Name"},"cnclDcAmt":{"type":"integer","description":"Cancellation Benefit Amount","format":"int64"},"rtnDlvBenefitInfoList":{"type":"array","description":"Return Coupon Information List","items":{"$ref":"#/components/schemas/ClaimDlvBenefitInfo"}},"reCalAdtnOcurGbCdAdtnAmt":{"type":"integer","format":"int64"}},"description":"Additional Payment/Refund Information DTO"},"ClaimDlvBenefitInfo":{"type":"object","properties":{"promoNo":{"type":"string","description":"Coupon No."},"promoNm":{"type":"string","description":"Coupon Name"},"promoTypCd":{"type":"string","description":"Promotion Type Code (MK002)\n 11 : Product Discount Coupon\n , 12 : Cart Coupon\n , 13 : Stackable Discount Coupon\n , 14 : Free Shipping Coupon\n , 15 : Free Return Coupon\n , 20 : Employee Discount\n , 21 : Instant Product Discount\n , 40 : Product Mileage\n","enum":["11","12","13","14","15","20","21","40"]},"ourChrgRate":{"type":"integer","description":"Company Cost-Sharing Rate","format":"int32"},"entrChrgRate":{"type":"integer","description":"Vendor Cost-Sharing Rate","format":"int32"},"cpnIsuNo":{"type":"string","description":"Coupon Issuance No."},"aplyYn":{"type":"string","description":"Application Status","enum":["Y","N"]}},"description":"Return Coupon Information List"},"PaymentClaimResponse":{"type":"object","properties":{"payNo":{"type":"string","description":"Payment Number"},"mbrNo":{"type":"string","description":"Member No."},"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":"integer","description":"Payment Amount","format":"int64"},"taxFreeAmt":{"type":"integer","description":"Tax-Exempt Price","format":"int64"},"rfdPsbAmt":{"type":"integer","description":"Refundable Amount","format":"int64"},"rfdAmt":{"type":"integer","description":"Refund Amount","format":"int64"},"payFnshDtm":{"type":"string","description":"Payment Completion Date/Time","format":"date-time"},"trdNo":{"type":"string","description":"Transaction No. (tid)"},"trdDtm":{"type":"string","description":"Transaction Date/Time","format":"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","description":"Installment Months","format":"int32"},"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","description":"Approval Date/Time","format":"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","description":"Deposit Confirmation Date/Time","format":"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"},"vbankPaymentPending":{"type":"boolean"},"vbankDptCnfm":{"type":"boolean"}},"description":"Refundable Payment Method DTO"},"RfdInfoResponse":{"type":"object","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"}},"description":"Refund Account Information Retrieval Response"},"Response":{"type":"object","properties":{"timestamp":{"type":"string","description":"result time","format":"date-time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"type":"object","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"}},"description":"validation error list"}}}}
```
## Cancel Order (BO)
> \## Function Description\
> \* Cancels the order.\
> \---\
> \## Detailed Description\
> \* Checks the order status at the time the order cancellation processing API is called to verify whether registration is possible.\
> \* Validates the order cancellation request data for the following items:\
> \* Checks whether the registered product includes a free gift (-> \*Partial quantity claim not possible\*)\
> \* Checks whether a payment method that does not allow partial cancellation was used (-> \*Partial claim not possible\*)\
> \* Checks whether there is an additional payment amount (-> \*Claim not possible from BO\*)\
> \* Creates and updates the order cancellation data.\
> \* Validates the refund/payment amounts arising from the order cancellation.\
> \* If there is a coupon to restore, the coupon is restored.\
> \* Stock is restored for the cancelled order products.\
> \* The refund/payment is processed.\
> \* Sends a notification to the customer for the order cancellation. (Email/AlimTalk/Notification box)\
> \---\
> \## Revision History\
> \* release\_231009\_01 : Added order quantity and cancel quantity columns to the order benefit relationship table\
> \* Release v2.00\_240627: Removed the logic that checks whether the delivery number of the registered product matches (added full cancellation feature)
```json
{"openapi":"3.0.1","info":{"title":"X2BEE Order API","version":"v1"},"servers":[{"url":"https://api-order.x2bee.com/api/order/","description":"prd"}],"paths":{"/v1/claim/orderCancel/cancel":{"post":{"tags":["Order Cancellation"],"summary":"Cancel Order (BO)","description":"## Function Description\n* Cancels the order.\n---\n## Detailed Description\n* Checks the order status at the time the order cancellation processing API is called to verify whether registration is possible.\n* Validates the order cancellation request data for the following items:\n * Checks whether the registered product includes a free gift (-> *Partial quantity claim not possible*)\n * Checks whether a payment method that does not allow partial cancellation was used (-> *Partial claim not possible*)\n * Checks whether there is an additional payment amount (-> *Claim not possible from BO*)\n* Creates and updates the order cancellation data.\n* Validates the refund/payment amounts arising from the order cancellation.\n* If there is a coupon to restore, the coupon is restored.\n* Stock is restored for the cancelled order products.\n* The refund/payment is processed.\n* Sends a notification to the customer for the order cancellation. (Email/AlimTalk/Notification box)\n---\n## Revision History\n* release_231009_01 : Added order quantity and cancel quantity columns to the order benefit relationship table\n* Release v2.00_240627: Removed the logic that checks whether the delivery number of the registered product matches (added full cancellation feature)\n","operationId":"cancelOrder","parameters":[{"name":"Authorization","in":"header","description":"Access Token","required":false}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClaimRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ClaimProcessResultResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"components":{"schemas":{"ClaimRequest":{"required":["claimBusinessType","claimDlvp","claimGoodsList","claimNo","claimReturnDlvp","ordMediaCd","ordNo","systemType","wthdFnshWaitProcCaus"],"type":"object","properties":{"systemType":{"type":"string","description":" SYSTEM (System Type)\n * 10 : FO\n * 20 : BO\n","enum":["FO","BO"]},"claimBusinessType":{"type":"string","description":" ClaimBusiness (Claim Business Type)\n * 11 : Order Cancellation\n * 20 : Return Receipt\n * 21 : Return Cancellation\n * 30 : Exchange Receipt\n * 31 : Exchange Cancellation\n * 22 : Return Completed\n * 23 : Return Not Possible\n * 24 : Exchange Return\n * 25 : Return On Hold\n","enum":["ORDER_CANCEL","RETURN_ACCEPT","RETURN_WITHDRAWAL","EXCHANGE_ACCEPT","EXCHANGE_WITHDRAWAL","RETURN_COMPLETE","RETURN_REJECT","RETURN_TRANSFORM","RETURN_PENDING","DELIVERY_FEE_PAYMENT"]},"ordMediaCd":{"type":"string","description":"Order Channel Code (OM007)\n 10 : Phone Consultation (CC)\n, 20 : PC\n, 30 : Mobile Web\n, 40 : Android App\n, 50 : iOS App\n, 60 : Subscription Order\n","enum":["10","20","30","40","50","60"]},"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"}},"paymentRequest":{"$ref":"#/components/schemas/PaymentRequestPaymentInfo"},"claimCpnInfoList":{"type":"array","description":"Coupon List","items":{"$ref":"#/components/schemas/ClaimCpnInfo"}},"claimReturnDlvp":{"$ref":"#/components/schemas/ClaimDlvp"},"claimDlvp":{"$ref":"#/components/schemas/ClaimDlvp"},"claimFinalAmtInfo":{"$ref":"#/components/schemas/ClaimFinalAmtInfo"},"wthdFnshWaitProcCaus":{"type":"string","description":"Pickup Completion Pending Reason"},"occurPayment":{"type":"boolean"},"existAddtionPayAmt":{"type":"boolean"},"claimBusiness":{"type":"string","description":" ClaimBusiness (Claim Business Type)\n * 11 : Order Cancellation\n * 20 : Return Receipt\n * 21 : Return Cancellation\n * 30 : Exchange Receipt\n * 31 : Exchange Cancellation\n * 22 : Return Completed\n * 23 : Return Not Possible\n * 24 : Exchange Return\n * 25 : Return On Hold\n","enum":["ORDER_CANCEL","RETURN_ACCEPT","RETURN_WITHDRAWAL","EXCHANGE_ACCEPT","EXCHANGE_WITHDRAWAL","RETURN_COMPLETE","RETURN_REJECT","RETURN_TRANSFORM","RETURN_PENDING","DELIVERY_FEE_PAYMENT"]}},"description":"Claim Processing Request DTO"},"ClaimGoodsRequest":{"required":["claimLgrpCd","claimMgrpCd","claimQty","exchangeGoodsNo","exchangeItmNm","exchangeItmNo"],"type":"object","properties":{"ordSeq":{"type":"integer","description":"Order Sequence No.","format":"int32"},"ordProcSeq":{"type":"integer","description":"Order Processing Sequence No.","format":"int32"},"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","description":"Claim Quantity","format":"int32"},"claimLgrpCd":{"type":"string","description":"OM047(Claim Major Category Code)\n 10: Simple Change of Mind\n , 20: Defective Product\n , 30: Delivery Complaint\n , 40: Product Information Error\n , 50: Re-payment Order\n","enum":["SIMPLE_CHANGE","GOODS_BAD","DELIVERY_CLAIM","GOODS_INFOMATION_ERROR","REPAYMENT_ORDER"]},"claimMgrpCd":{"type":"string","description":"OM006(Claim Sub-Category Code)\n 100: Delivery Delayed\n , 101: Product Out of Stock\n , 102: Option/Size Change/Cancellation\n , 103: More Expensive Than Elsewhere\n , 104: Coupon/Discount Benefit Change\n , 105: No Longer Wish to Purchase\n , 106: Gift Change/Cancellation\n , 107: Payment Method Change (Purchase Gift Applied/Card Change, etc.)\n , 108: Purchased Similar Product\n , 109: Insufficient Product Information\n , 110: Seller Cancellation (Seller)\n , 111: Discretionary Cancellation (Agent)\n , 112: Automatic Cancellation (Insufficient Payment)\n , 113: Automatic Cancellation (Out-of-Stock Cancellation)\n , 300: Size Too Large\n , 301: Size Too Small\n , 302: Simple Change of Mind - Color Change\n , 303: Stained\n , 304: Damaged (Seam Tear, etc.)\n , 305: Missing Components (Necklace, Belt, etc.)\n , 306: Defective Contents (Cosmetics, etc.)\n , 307: Wrong Product Delivered\n , 308: Other\n , 200: Ordered Different Product\n , 201: Size Too Large\n , 203: Size Too Small\n , 204: Product Image Differs (Color, Design, Fit)\n , 205: No Longer Wish to Purchase\n , 206: No Color or Size Exchange Option Available\n , 207: Other\n , 208: Stained\n , 209: Damaged (Seam Tear, etc.)\n , 210: Missing Components (Necklace, Belt, etc.)\n , 211: Defective Contents (Cosmetics, etc.)\n , 212: Other\n , 213: Wrong Size Delivered\n , 214: Wrong Color Delivered\n , 215: Wrong Product Delivered\n , 216: Delivery Delayed\n , 217: Other\n , 218: Measured Size Error\n , 219: Material Error\n , 220: Color Error\n , 221: Differs From Product Description (Mislabeled)\n , 222: Other\n , 223: Return On Hold\n , 224: Return Not Possible\n","enum":["CLAIM_MGRP_CD_100","CLAIM_MGRP_CD_101","CLAIM_MGRP_CD_102","CLAIM_MGRP_CD_103","CLAIM_MGRP_CD_104","CLAIM_MGRP_CD_105","CLAIM_MGRP_CD_106","CLAIM_MGRP_CD_107","CLAIM_MGRP_CD_108","CLAIM_MGRP_CD_109","CLAIM_MGRP_CD_110","CLAIM_MGRP_CD_111","CLAIM_MGRP_CD_112","CLAIM_MGRP_CD_113","CLAIM_MGRP_CD_114","CLAIM_MGRP_CD_300","CLAIM_MGRP_CD_301","CLAIM_MGRP_CD_302","CLAIM_MGRP_CD_303","CLAIM_MGRP_CD_304","CLAIM_MGRP_CD_305","CLAIM_MGRP_CD_306","CLAIM_MGRP_CD_307","CLAIM_MGRP_CD_308","CLAIM_MGRP_CD_200","CLAIM_MGRP_CD_201","CLAIM_MGRP_CD_203","CLAIM_MGRP_CD_204","CLAIM_MGRP_CD_205","CLAIM_MGRP_CD_206","CLAIM_MGRP_CD_207","CLAIM_MGRP_CD_208","CLAIM_MGRP_CD_209","CLAIM_MGRP_CD_210","CLAIM_MGRP_CD_211","CLAIM_MGRP_CD_212","CLAIM_MGRP_CD_213","CLAIM_MGRP_CD_214","CLAIM_MGRP_CD_215","CLAIM_MGRP_CD_216","CLAIM_MGRP_CD_217","CLAIM_MGRP_CD_218","CLAIM_MGRP_CD_219","CLAIM_MGRP_CD_220","CLAIM_MGRP_CD_221","CLAIM_MGRP_CD_222","CLAIM_MGRP_CD_223","CLAIM_MGRP_CD_224"]},"claimCausEtcCont":{"type":"string","description":"Other Claim Reason Details"},"withdrawalDeliNo":{"type":"string","description":"Pickup Delivery No."},"shipmentDeliNo":{"type":"string","description":"Shipment Delivery No."},"prOrdDtlAtchFileInfoList":{"type":"array","description":"Attached Image List","items":{"$ref":"#/components/schemas/PrOrdDtlAtchFileInfo"}},"ordSeqAndOrdProcSeq":{"type":"string"}},"description":"Claim Requested Product Information DTO"},"PrOrdDtlAtchFileInfo":{"type":"object","properties":{"ordNo":{"type":"string","description":"Order No."},"ordSeq":{"type":"integer","description":"Order Sequence No.","format":"int32"},"ordProcSeq":{"type":"integer","description":"Order Processing Sequence No.","format":"int32"},"fileSeq":{"type":"string","description":"File Sequence No."},"filePathNm":{"type":"string","description":"File Path"},"fileNm":{"type":"string","description":"File Name"}},"description":"Order Detail Attachment File Info DTO"},"PaymentRequestPaymentInfo":{"type":"object","properties":{"siteNo":{"type":"string","description":"Site No."},"orderInfo":{"$ref":"#/components/schemas/PaymentOrderInfo"},"payInfoList":{"type":"array","description":"Order/Claim DTO Requesting Payment","items":{"$ref":"#/components/schemas/PaymentInfo"}}},"description":"Payment and Payment Cancellation DTO","nullable":true},"PaymentOrderInfo":{"type":"object","properties":{"ordNo":{"type":"string","description":"Order No."},"claimNo":{"type":"string","description":"Claim No."},"goodsNm":{"type":"string","description":"Product Name"},"ordManNm":{"type":"string","description":"Orderer Name"},"ordmnCellNo":{"type":"string","description":"Orderer's Mobile Phone Number"},"ordmnEmailAddr":{"type":"string","description":"Orderer Email Address"},"crcUnitCd":{"type":"string","description":"Currency Unit Code"},"ordMediaCd":{"type":"string","description":"Order Channel Code (OM007)"},"mbrNo":{"type":"string","description":"Member No."},"ordDtlGbCd":{"type":"string","description":"Order Detail Classification Code (OM003)"},"clientIp":{"type":"string","description":"Client IP"},"taxFreeAmt":{"type":"integer","description":"Tax-Exempt Amount","format":"int64"}},"description":"Order DTO Required for Payment"},"PaymentInfo":{"type":"object","properties":{"payNo":{"type":"string","description":"Payment Number"},"payWayCd":{"type":"string","description":"Payment Method Code (OM013)"},"payAmt":{"type":"integer","description":"Payment Amount","format":"int64"},"mersNo":{"type":"string","description":"Merchant Number"},"pgGbCd":{"type":"string","description":"PG Classification Code (OM030)"},"trdNo":{"type":"string","description":"Transaction No. (tid)"},"selectCardCd":{"type":"string","description":"Payment Request Card Company Code (OM057)"},"termlId":{"type":"string","description":"Terminal ID (mid)"},"billKey":{"type":"string","description":"Billing Key Value to Request Approval"},"authResultMap":{"type":"object","additionalProperties":{"type":"string","description":"Verification Result Information"},"description":"Verification Result Information"}},"description":"Payment DTO"},"ClaimCpnInfo":{"type":"object","properties":{"cpnNo":{"type":"string","description":"Coupon Issuance No."}},"description":"Claim Coupon Information DTO"},"ClaimDlvp":{"required":["dlvpNm","dtlAddr","rcvmnNm","zipAddr","zipNo"],"type":"object","properties":{"mbrOrdDlvpGb":{"type":"string","description":" ClaimDlvpGbCd (Claim Delivery Address Type)\n * 10 : Member Delivery Address\n * 20 : Order Delivery Address\n","enum":["MBR","ORD"]},"dlvpSeq":{"type":"string","description":"Delivery Address Sequence No."},"zipNoSeq":{"type":"integer","description":"Postal Code Sequence No.","format":"int64"},"dlvpNm":{"type":"string","description":"Delivery Address Name"},"rcvmnNm":{"type":"string","description":"Recipient Name"},"zipNo":{"type":"string","description":"Postal Code"},"zipAddr":{"type":"string","description":"Postal Address"},"dtlAddr":{"type":"string","description":"Detailed 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 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) 20: Please call before delivery, 30: Leave at the door if absent, 40: Leave with security desk if absent, 50: Please deliver quickly, 60: Please call my mobile if absent, 70: Enter manually"},"shopTrafMsg":{"type":"string","description":"Store Delivery Message"},"comnFrdrCogoMethodCd":{"type":"string","description":"Common Entrance Access Method Code (ME040) 10: Entrance access code, 20: Free access, 30: Other","default":"20"},"comnFrdrEtcMethod":{"type":"string","description":"Other Common Entrance Access Method"},"comnFrdrPwd":{"type":"string","description":"Common Entrance Password"}},"description":"Claim Delivery Information DTO"},"ClaimFinalAmtInfo":{"type":"object","properties":{"ordNo":{"type":"string","description":"Order No."},"totAplyAdtnAmt":{"type":"integer","description":"Total Delivery Fee Incurred Amount","format":"int64"},"totCnclAdtnAmt":{"type":"integer","description":"Total Cancelled Delivery Fee Amount","format":"int64"},"totFvrAdtnAmt":{"type":"integer","description":"Total Benefit Delivery Fee Amount","format":"int64"},"totOrdPrc":{"type":"integer","description":"Claim Product Amount","format":"int64"},"totDcAmt":{"type":"integer","description":"Claim Cancellation Discount Amount","format":"int64"},"expectedRefundAmt":{"type":"integer","description":"Expected Refund Amount","format":"int64"},"addtionPayAmt":{"type":"integer","description":"Additional Payment Amount","format":"int64"},"returnAcceptAmt":{"type":"integer","description":"Return Received Amount","format":"int64"},"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"}},"paymentOrderInfo":{"$ref":"#/components/schemas/PaymentOrderInfo"},"rfdInfoResponse":{"$ref":"#/components/schemas/RfdInfoResponse"}},"description":"Claim Final Payment/Refund Amount Information DTO"},"RefundAdditionAmtInfo":{"type":"object","properties":{"adtnOcurGbCd":{"type":"string","description":"OM017 (Additional Cost Occurrence Classification Code)\n 10: Occurred\n , 20: Cancelled\n","enum":["OCCURRNECE","CANCEL"]},"adtnOcurGbNm":{"type":"string","description":"Additional Cost Occurrence Type Name"},"type":{"type":"string","description":" ClaimAmountType (Claim Additional Cost Type)\n * 10 : Shipping Fee\n * 20 : Collection Shipping Fee\n * 30 : Exchange Shipping Fee\n * 40 : Product\n * 50 : Additional Shipping Fee\n * 60 : Free Gift\n","enum":["DELIVERY_FEE","RETURN_FEE","EXCHANGE_FEE","GOODS","EXTRA_FEE","GIFTS"]},"typeNm":{"type":"string","description":"Type Classification Name"},"goodsNoItmNo":{"type":"string","description":"Product No.+SKU No."},"goodsNm":{"type":"string","description":"Product Name"},"ordAmt":{"type":"integer","description":"Payment Amount","format":"int64"},"discountMethod":{"type":"string","description":"OM019 (Additional Cost Detail Type Code)\n 11: Product Discount Coupon\n , 12: Cart Coupon\n , 13: Stackable Discount Coupon\n , 14: Free Shipping Coupon\n , 15: Free Return Coupon\n , 20: Employee Discount\n , 21: Instant Product Discount\n , 51: Product Free Gift\n , 40: Promotion Accrual\n , 41: Basic Accrual\n , 42: Membership Tier Additional Accrual\n","enum":["GOODS_DISCOUNT","SHOPPING_BASKET","REDUNDANT_DISCOUNT","FREE_DELIVERY","FREE_RETURN","EXECUTIVES","GOODS_DIRECT","GOODS_GIFTS","MILEAGE","BASIC_ACCUMULATION","MBR_GRADE_ACCUMULATION"]},"discountMethodNm":{"type":"string","description":"Benefit Detail Information Name"},"cnclDcAmt":{"type":"integer","description":"Cancellation Benefit Amount","format":"int64"},"rtnDlvBenefitInfoList":{"type":"array","description":"Return Coupon Information List","items":{"$ref":"#/components/schemas/ClaimDlvBenefitInfo"}},"reCalAdtnOcurGbCdAdtnAmt":{"type":"integer","format":"int64"}},"description":"Additional Payment/Refund Information DTO"},"ClaimDlvBenefitInfo":{"type":"object","properties":{"promoNo":{"type":"string","description":"Coupon No."},"promoNm":{"type":"string","description":"Coupon Name"},"promoTypCd":{"type":"string","description":"Promotion Type Code (MK002)\n 11 : Product Discount Coupon\n , 12 : Cart Coupon\n , 13 : Stackable Discount Coupon\n , 14 : Free Shipping Coupon\n , 15 : Free Return Coupon\n , 20 : Employee Discount\n , 21 : Instant Product Discount\n , 40 : Product Mileage\n","enum":["11","12","13","14","15","20","21","40"]},"ourChrgRate":{"type":"integer","description":"Company Cost-Sharing Rate","format":"int32"},"entrChrgRate":{"type":"integer","description":"Vendor Cost-Sharing Rate","format":"int32"},"cpnIsuNo":{"type":"string","description":"Coupon Issuance No."},"aplyYn":{"type":"string","description":"Application Status","enum":["Y","N"]}},"description":"Return Coupon Information List"},"PaymentClaimResponse":{"type":"object","properties":{"payNo":{"type":"string","description":"Payment Number"},"mbrNo":{"type":"string","description":"Member No."},"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":"integer","description":"Payment Amount","format":"int64"},"taxFreeAmt":{"type":"integer","description":"Tax-Exempt Price","format":"int64"},"rfdPsbAmt":{"type":"integer","description":"Refundable Amount","format":"int64"},"rfdAmt":{"type":"integer","description":"Refund Amount","format":"int64"},"payFnshDtm":{"type":"string","description":"Payment Completion Date/Time","format":"date-time"},"trdNo":{"type":"string","description":"Transaction No. (tid)"},"trdDtm":{"type":"string","description":"Transaction Date/Time","format":"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","description":"Installment Months","format":"int32"},"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","description":"Approval Date/Time","format":"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","description":"Deposit Confirmation Date/Time","format":"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"},"vbankPaymentPending":{"type":"boolean"},"vbankDptCnfm":{"type":"boolean"}},"description":"Refundable Payment Method DTO"},"RfdInfoResponse":{"type":"object","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"}},"description":"Refund Account Information Retrieval Response"},"ClaimProcessResultResponse":{"type":"object","properties":{"ordNo":{"type":"string","description":"Order No."},"claimNo":{"type":"string","description":"Claim No."}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","description":"result time","format":"date-time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"type":"object","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"}},"description":"validation error list"}}}}
```
## Search Order Cancellation Targets (BO)
> \## Function Description\
> \* Retrieves order history, the list of cancellable products, and other information needed for screen processing.\
> \---\
> \## Detailed Description\
> \* \*\*Order No. (ordNo), Claim Business Type (claimBusinessType), and System Type (systemType)\*\* are required parameters.\
> \* Order cancellation is possible for targets that satisfy all of the following conditions.\
> \* Order Detail Classification (OM003) value is \*\*General Order (10)\*\*\
> \* Order Detail Status (OM005) value is \*\*Order Completed (12)\*\*, \*\*Delivery Instructed (21)\*\*, \*\*Shipment Instructed (22)\*\*, or \*\*Awaiting Shipment (23)\*\*\
> \* The item is a general product (gifts excluded)\
> \* The cancellable quantity is 1 or more (\*\*Order Quantity – Cancelled Quantity – Returned Quantity > 0\*\*)\
> \* Order Cancellation Available Status is 'Y'\
> \* The other information included is as follows.\
> \* Order Cancellation Mid-Category Reason List\
> \* A Map with the liability reason code as the Key and the order cancellation mid-category reason as the Value\
> \---\
> \## Revision History\
> \* release\_231204\_01 : Added delivery address sequence number (dlvpSeq) to the Request DTO; added filtering when a delivery address sequence value exists during target retrieval\
> \* Release v2.00\_240729 : Excludes targets where Order Cancellation Available Status (ordCnclPsbYn) is "N"
```json
{"openapi":"3.0.1","info":{"title":"X2BEE Order API","version":"v1"},"servers":[{"url":"https://api-order.x2bee.com/api/order/","description":"prd"}],"paths":{"/v1/claim/orderCancel/cancelPopup":{"post":{"tags":["Order Cancellation"],"summary":"Search Order Cancellation Targets (BO)","description":"## Function Description\n* Retrieves order history, the list of cancellable products, and other information needed for screen processing.\n---\n## Detailed Description\n* **Order No. (ordNo), Claim Business Type (claimBusinessType), and System Type (systemType)** are required parameters.\n* Order cancellation is possible for targets that satisfy all of the following conditions.\n * Order Detail Classification (OM003) value is **General Order (10)**\n * Order Detail Status (OM005) value is **Order Completed (12)**, **Delivery Instructed (21)**, **Shipment Instructed (22)**, or **Awaiting Shipment (23)**\n * The item is a general product (gifts excluded)\n * The cancellable quantity is 1 or more (**Order Quantity – Cancelled Quantity – Returned Quantity > 0**)\n * Order Cancellation Available Status is 'Y'\n* The other information included is as follows.\n * Order Cancellation Mid-Category Reason List\n * A Map with the liability reason code as the Key and the order cancellation mid-category reason as the Value\n---\n## Revision History\n* release_231204_01 : Added delivery address sequence number (dlvpSeq) to the Request DTO; added filtering when a delivery address sequence value exists during target retrieval\n* Release v2.00_240729 : Excludes targets where Order Cancellation Available Status (ordCnclPsbYn) is \"N\"\n","operationId":"getOrderCancelPopupInfo","parameters":[{"name":"Authorization","in":"header","description":"Access Token","required":false}],"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"}}}}}}}},"components":{"schemas":{"ClaimTargetRequest":{"required":["ordNo","systemType"],"type":"object","properties":{"ordNo":{"type":"string","description":"Order No."},"claimBusinessType":{"type":"string","description":" ClaimBusiness (Claim Business Type)\n * 11 : Order Cancellation\n * 20 : Return Receipt\n * 21 : Return Cancellation\n * 30 : Exchange Receipt\n * 31 : Exchange Cancellation\n * 22 : Return Completed\n * 23 : Return Not Possible\n * 24 : Exchange Return\n * 25 : Return On Hold\n","enum":["ORDER_CANCEL","RETURN_ACCEPT","RETURN_WITHDRAWAL","EXCHANGE_ACCEPT","EXCHANGE_WITHDRAWAL","RETURN_COMPLETE","RETURN_REJECT","RETURN_TRANSFORM","RETURN_PENDING","DELIVERY_FEE_PAYMENT"]},"orgClmNo":{"type":"string","description":"Original Claim No."},"systemType":{"type":"string","description":" SYSTEM (System Type)\n * 10 : FO\n * 20 : BO\n","enum":["FO","BO"],"default":"20"},"dlvpSeq":{"type":"string","description":"Delivery Address Sequence No."},"systemCdNmAndButtonCode":{"type":"string"},"claimBusiness":{"type":"string","description":" ClaimBusiness (Claim Business Type)\n * 11 : Order Cancellation\n * 20 : Return Receipt\n * 21 : Return Cancellation\n * 30 : Exchange Receipt\n * 31 : Exchange Cancellation\n * 22 : Return Completed\n * 23 : Return Not Possible\n * 24 : Exchange Return\n * 25 : Return On Hold\n","enum":["ORDER_CANCEL","RETURN_ACCEPT","RETURN_WITHDRAWAL","EXCHANGE_ACCEPT","EXCHANGE_WITHDRAWAL","RETURN_COMPLETE","RETURN_REJECT","RETURN_TRANSFORM","RETURN_PENDING","DELIVERY_FEE_PAYMENT"]},"system":{"type":"string","description":" SYSTEM (System Type)\n * 10 : FO\n * 20 : BO\n","enum":["FO","BO"]}},"description":"Claim Eligibility Search Request DTO"},"OrderCancelPopupResponse":{"type":"object","properties":{"claimTargetResponse":{"$ref":"#/components/schemas/ClaimTargetResponse"},"claimCausCdList":{"type":"array","description":"Claim Major Category Reason","items":{"$ref":"#/components/schemas/StCdDtlResponse"}},"claimMgrpRspnGbCdMap":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/StCdDtlResponse"},"description":"Claim Sub-Category Reason Map Keyed by Responsibility Type Code"}},"description":"Claim Eligibility Search Response DTO"},"ClaimTargetResponse":{"type":"object","properties":{"ordNo":{"type":"string","description":"Order No."},"mbrNo":{"type":"string","description":"Member No."},"mbrGradeCd":{"type":"string","description":"Member Grade Code (ME008)\n 10 : GREEN\n, 20 : FAMILY\n, 30 : GOLD\n, 40 : VIP\n, 50 : VVIP\n","enum":["10","20","30","40","50"]},"ordGbCd":{"type":"string","description":"OM002 (Order Classification Code)\n 10: General Order\n , 20: Gift\n , 30: E-Coupon\n , 40: Affiliate\n","enum":["GENERAL_ORDER","GIVE_GIFT_ORDER","E_COUPON","SUBSCRIBE_ORDER"]},"mbrMgrCd":{"type":"string","description":"ME002 (Member Management Code)\n 10: UNION_MEMBER (Integrated Member)\n,20: GENERAL_MEMBER (General Member)\n,30: SOCIAL_MEMBER (Social Member)\n,99: NO_MEMBER (Non-Member)\n","enum":["UNION_MEMBER","GENERAL_MEMBER","SOCIAL_MEMBER","ENTERPRISE_MEMBER","NO_MEMBER"]},"ordManNm":{"type":"string","description":"Orderer Name"},"ordManEmailAddr":{"type":"string","description":"Orderer Email Address"},"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"},"ordMediaCd":{"type":"string","description":"Order Channel Code (OM007)\n 10 : Phone Consultation (CC)\n, 20 : PC\n, 30 : Mobile Web\n, 40 : Android App\n, 50 : iOS App\n, 60 : Subscription Order\n","enum":["10","20","30","40","50","60"]},"ordAccpDtm":{"type":"string","description":"Order Receipt Date","format":"date-time"},"sctnCnclPsbYn":{"type":"string","description":"Partial Cancellation Availability Status","enum":["Y","N"]},"claimTargetGoodsResponseList":{"type":"array","description":"Claim Target Product List","items":{"$ref":"#/components/schemas/ClaimTargetGoodsResponse"}},"allNonReturnable":{"type":"boolean"},"vbankPaymentPending":{"type":"boolean"},"allEcoupon":{"type":"boolean"},"upGoodsImg":{"type":"object","additionalProperties":{"type":"string"},"writeOnly":true}},"description":"Claim Processing Target Response DTO"},"ClaimTargetGoodsResponse":{"required":["claimMgrpCd"],"type":"object","properties":{"goodsNo":{"type":"string","description":"Product No."},"deliProcTypCd":{"type":"string","description":"PR008 (Delivery Processing Type Code)\n 10: CNTR_DLV (Center Delivery)\n,20: CORP_DLV (Vendor Delivery)\n,30: E_COUPON_DLV (E-Coupon Delivery)\n","enum":["CNTR_DLV","CORP_DLV","E_COUPON_DLV"]},"deliPolcNo":{"type":"string","description":"Delivery Policy No."},"deliNo":{"type":"string","description":"Delivery No."},"entrNo":{"type":"string","description":"Vendor No."},"ordQty":{"type":"integer","description":"Order Quantity","format":"int32"},"salePrc":{"type":"integer","description":"Selling Price","format":"int64"},"dcAmt":{"type":"integer","description":"Discounted Price","format":"int64"},"sysModDtm":{"type":"string","description":"System Modification Date/Time","format":"date-time"},"ordNo":{"type":"string","description":"Order No."},"ordSeq":{"type":"integer","description":"Order Sequence No.","format":"int32"},"ordProcSeq":{"type":"integer","description":"Order Processing Sequence No.","format":"int32"},"uprOrdProcSeq":{"type":"integer","description":"Parent Order Processing Sequence No.","format":"int32"},"maxOrdProcSeq":{"type":"integer","description":"Maximum Order Processing Sequence No.","format":"int32"},"claimNo":{"type":"string","description":"Claim No."},"itmNo":{"type":"string","description":"Item No."},"ordDtlGbCd":{"type":"string","description":"OM003(Order Detail Type Code)\n 10: Regular Order\n , 11: Order Cancellation\n , 20: Regular Return\n , 21: Return Cancellation\n , 30: Exchange Order\n , 31: Exchange Cancellation\n , 40: Exchange Return\n","enum":["ORDER_GENERAL","ORDER_CANCEL","RETURN_GENERAL","RETURN_WITHDRAWAL","EXCHANGE_ORDER","EXCHANGE_WITHDRAWAL","EXCHANGE_RETURN"]},"ordDtlGbCdNm":{"type":"string","description":"Order Detail Classification Code Name"},"ordDtlStatCd":{"type":"string","description":"OM005 (Order Detail Status Code)\n 10: REPAY_REQ(Repayment Requested)\n,11: ORDER_ACCEPT(Order Accepted)\n,12: ORDER_COMPLETE(Order Completed)\n,13: ORDER_CANCEL(Order Cancelled)\n,21: DELIVERY_ORDER(Delivery Instructed)\n,22: SHIPPING_ORDER(Shipment Instructed)\n,23: SHIPPING_WAIT(Awaiting Shipment)\n,25: SHIPPING_CONFIRM(Shipment Confirmed)\n,26: SHIPPING_FINISH(Shipment Completed)\n,27: DELIVERY_FINISH(Delivery Completed)\n,31: RETURN_APPLY(Payment Pending)\n,32: RETURN_ACCEPT(Return Accepted)\n,33: RETURN_CANCEL(Return Cancelled)\n,34: WITHDRAWAL_ORDER(Collection Instructed)\n,35: WITHDRAWAL_CONFIRM(Collection Confirmed)\n,36: WITHDRAWAL_FINISH(Collection Completed)\n,37: RETURN_FINISH(Return Completed)\n","enum":["REPAY_REQ","ORDER_ACCEPT","ORDER_COMPLETE","ORDER_CANCEL","DELIVERY_ORDER","SHIPPING_ORDER","SHIPPING_WAIT","SHIPPING_CONFIRM","SHIPPING_FINISH","DELIVERY_FINISH","PARTIAL_SHIPPING","RETURN_APPLY","RETURN_ACCEPT","RETURN_CANCEL","WITHDRAWAL_ORDER","WITHDRAWAL_CONFIRM","WITHDRAWAL_FINISH","RETURN_FINISH"]},"ordDtlStatCdNm":{"type":"string","description":"Order Detail Status Code Name"},"deliGbCd":{"type":"string","description":" LO001(Delivery Type Code)\n * 10 : Shipment\n * 20 : Return\n","enum":["SHIPPING","WITHDRAWAL"]},"ordAccpDtm":{"type":"string","description":"Order Receipt Date/Time","format":"date-time"},"ordFnshDtm":{"type":"string","description":"Order Completion Date/Time","format":"date-time"},"cnclQty":{"type":"integer","description":"Cancellation Quantity","format":"int32"},"rtnQty":{"type":"integer","description":"Return Quantity","format":"int32"},"claimQty":{"type":"integer","description":"Claim Quantity","format":"int32"},"claimPossibleQty":{"type":"integer","description":"Claimable Quantity","format":"int32"},"deliIndiDtm":{"type":"string","description":"Delivery Instruction Date/Time","format":"date-time"},"deliIndiRsvDtm":{"type":"string","description":"Delivery Instruction Reservation Date/Time","format":"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":"OM047(Claim Major Category Code)\n 10: Simple Change of Mind\n , 20: Defective Product\n , 30: Delivery Complaint\n , 40: Product Information Error\n , 50: Re-payment Order\n","enum":["SIMPLE_CHANGE","GOODS_BAD","DELIVERY_CLAIM","GOODS_INFOMATION_ERROR","REPAYMENT_ORDER"]},"claimLgrpCdNm":{"type":"string","description":"Claim Major Category Code Name"},"claimMgrpCd":{"type":"string","description":"OM006(Claim Sub-Category Code)\n 100: Delivery Delayed\n , 101: Product Out of Stock\n , 102: Option/Size Change/Cancellation\n , 103: More Expensive Than Elsewhere\n , 104: Coupon/Discount Benefit Change\n , 105: No Longer Wish to Purchase\n , 106: Gift Change/Cancellation\n , 107: Payment Method Change (Purchase Gift Applied/Card Change, etc.)\n , 108: Purchased Similar Product\n , 109: Insufficient Product Information\n , 110: Seller Cancellation (Seller)\n , 111: Discretionary Cancellation (Agent)\n , 112: Automatic Cancellation (Insufficient Payment)\n , 113: Automatic Cancellation (Out-of-Stock Cancellation)\n , 300: Size Too Large\n , 301: Size Too Small\n , 302: Simple Change of Mind - Color Change\n , 303: Stained\n , 304: Damaged (Seam Tear, etc.)\n , 305: Missing Components (Necklace, Belt, etc.)\n , 306: Defective Contents (Cosmetics, etc.)\n , 307: Wrong Product Delivered\n , 308: Other\n , 200: Ordered Different Product\n , 201: Size Too Large\n , 203: Size Too Small\n , 204: Product Image Differs (Color, Design, Fit)\n , 205: No Longer Wish to Purchase\n , 206: No Color or Size Exchange Option Available\n , 207: Other\n , 208: Stained\n , 209: Damaged (Seam Tear, etc.)\n , 210: Missing Components (Necklace, Belt, etc.)\n , 211: Defective Contents (Cosmetics, etc.)\n , 212: Other\n , 213: Wrong Size Delivered\n , 214: Wrong Color Delivered\n , 215: Wrong Product Delivered\n , 216: Delivery Delayed\n , 217: Other\n , 218: Measured Size Error\n , 219: Material Error\n , 220: Color Error\n , 221: Differs From Product Description (Mislabeled)\n , 222: Other\n , 223: Return On Hold\n , 224: Return Not Possible\n","enum":["CLAIM_MGRP_CD_100","CLAIM_MGRP_CD_101","CLAIM_MGRP_CD_102","CLAIM_MGRP_CD_103","CLAIM_MGRP_CD_104","CLAIM_MGRP_CD_105","CLAIM_MGRP_CD_106","CLAIM_MGRP_CD_107","CLAIM_MGRP_CD_108","CLAIM_MGRP_CD_109","CLAIM_MGRP_CD_110","CLAIM_MGRP_CD_111","CLAIM_MGRP_CD_112","CLAIM_MGRP_CD_113","CLAIM_MGRP_CD_114","CLAIM_MGRP_CD_300","CLAIM_MGRP_CD_301","CLAIM_MGRP_CD_302","CLAIM_MGRP_CD_303","CLAIM_MGRP_CD_304","CLAIM_MGRP_CD_305","CLAIM_MGRP_CD_306","CLAIM_MGRP_CD_307","CLAIM_MGRP_CD_308","CLAIM_MGRP_CD_200","CLAIM_MGRP_CD_201","CLAIM_MGRP_CD_203","CLAIM_MGRP_CD_204","CLAIM_MGRP_CD_205","CLAIM_MGRP_CD_206","CLAIM_MGRP_CD_207","CLAIM_MGRP_CD_208","CLAIM_MGRP_CD_209","CLAIM_MGRP_CD_210","CLAIM_MGRP_CD_211","CLAIM_MGRP_CD_212","CLAIM_MGRP_CD_213","CLAIM_MGRP_CD_214","CLAIM_MGRP_CD_215","CLAIM_MGRP_CD_216","CLAIM_MGRP_CD_217","CLAIM_MGRP_CD_218","CLAIM_MGRP_CD_219","CLAIM_MGRP_CD_220","CLAIM_MGRP_CD_221","CLAIM_MGRP_CD_222","CLAIM_MGRP_CD_223","CLAIM_MGRP_CD_224"]},"claimMgrpCdNm":{"type":"string","description":"Claim Subcategory Code Name"},"claimCausEtcCont":{"type":"string","description":"Other Claim Reason Details"},"ordSaleTypCd":{"type":"string","description":"OM004 (Order Sales Type Code)\n 10: General Sale\n , 20: Order Gift\n , 30: Product Gift\n","enum":["GENERAL_SALES","ORDER_FREE_GIFT","GOODS_FREE_GIFT"]},"chlNo":{"type":"string","description":"Channel No."},"chlDtlNo":{"type":"string","description":"Channel Detail No."},"stdCtgNo":{"type":"string","description":"Standard Category No."},"infDispCtgNoGbCd":{"type":"string","description":"OM041(Inflow Display Category No. Type Code)\n 01: DISPLAY_STORE(Display Store)\n,02: EXHIBITIONS(Special Exhibition)\n,06: SEARCH_SALES(Search Sales)\n,07: SEARCH_AD_BANNER(Search Ad Banner)\n,08: FLOATING_BANNER(Floating Banner)\n,09: WISHLIST(Wishlist)\n,10: NONE(No Inflow Display No.)\n","enum":["DISPLAY_STORE","EXHIBITIONS","SEARCH_SALES","SEARCH_AD_BANNER","FLOATING_BANNER","WISHLIST","NONE"]},"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"},"goodsImg":{"type":"string","description":"Product Image Path"},"itmNm":{"type":"string","description":"Item Name"},"prestNm":{"type":"string","description":"Gift Item Name"},"goodsCompCd":{"type":"string","description":"PR001 (Product Composition Code)\n 10: GEN_GOODS (General Product)\n,20: PKG_GOODS (Bundled Product)\n","enum":["GEN_GOODS","PKG_GOODS"]},"goodsTypCd":{"type":"string","description":"PR002 (Product Type Code)\n 10: GEN_GOODS (General Product)\n,20: GFT_GOODS (Free Gift)\n,30: CPN_GOODS (E-Coupon Product)\n","enum":["GEN_GOODS","GFT_GOODS","CPN_GOODS"]},"saleMethCd":{"type":"string","description":"PR003 (Sales Method Code)\n 10: NORMAL_SALE (General Sale)\n,20: RSV_SALE (Reservation Product)\n","enum":["NORMAL_SALE","RSV_SALE"]},"taxGbCd":{"type":"string","description":"Tax/Duty-Free Classification Code (PR007)"},"buyTypCd":{"type":"string","description":"Purchase Type Code (PR006)"},"supPcost":{"type":"integer","description":"Supply Cost","format":"int64"},"norPrc":{"type":"integer","description":"Regular Price","format":"int64"},"mrgnRate":{"type":"integer","description":"Margin Rate","format":"int64"},"deliDday":{"type":"integer","description":"Delivery Lead Time","format":"int64"},"deliGoodsGbCd":{"type":"string","description":"PR010 (Delivery Product Type Code)\n 01: GEN_GOODS (General Product)\n,02: INST_GOODS (Installation Product)\n,03: ORDMK_GOODS (Made-to-Order Product)\n,04: E_COUPON (E-Coupon)\n","enum":["GEN_GOODS","INST_GOODS","ORDMK_GOODS","E_COUPON"]},"deliWayCd":{"type":"string","description":"PR009 (Delivery Method Code)\n 01: COURIER_DELIVERY (Courier Delivery)\n,02: NON_DELIVERY (No Delivery)\n","enum":["COURIER_DELIVERY","NON_DELIVERY"]},"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":"integer","description":"Benefit Amount","format":"int64"},"ordPrc":{"type":"integer","description":"Order Amount","format":"int64"},"aeGoodsYn":{"type":"string","description":"Gift Status","enum":["Y","N"]},"withdrawalDeliNo":{"type":"string","description":"Pickup Destination Delivery No."},"shipmentDeliNo":{"type":"string","description":"Delivery Address Delivery No."},"deliTypCd":{"type":"string","description":" LO002 (Delivery Type Code)\n * 10 : Normal Shipment\n * 11 : Exchange Shipment\n * 20 : Return Collection\n * 21 : Exchange Collection\n","enum":["NORMAL_SHIPPING","EXCHANGE_SHIPPING","RETURN_RECOVERY","EXCHANGE_RECOVERY"]},"deliKindCd":{"type":"string","description":"LO009(Delivery Type Code)\n 10: NORMAL_DELIVERY(Standard Delivery)\n,20: RESERVATION_DELIVERY(Reserved Delivery)\n","enum":["NORMAL_DELIVERY","RESERVATION_DELIVERY"]},"deliMethodCd":{"type":"string","description":" LO010 (Delivery Method Code)\n * 10 : Courier Delivery\n * 30 : Store Pickup\n * 40 : Quick Delivery\n * 50 : Overseas Delivery\n * 60 : No Delivery\n","enum":["COURIER_DELIVERY","FOUR_PM","STORE_PICK_UP","QUICK_DELIVERY","OVERSEAS_DELIVERY","NON_DELIVERY"]},"deliProcTypCdNm":{"type":"string","description":"Delivery Processing Type Code Name"},"puTypCd":{"type":"string","description":" LO006 (Collection Type Code)\n * 20 : Collection\n * 30 : Collection Not Required\n","enum":["SHIPPING","WITHDRAWAL","WITHDRAWAL_NOT_REQUIRED"]},"wthdFnshGbCd":{"type":"string","description":"Collection Completion Classification Code","enum":["NORMAL_RETURN","BAD_RETURN","COURIER_LOSE","RETURN_TRANSFORM"]},"dlvpNm":{"type":"string","description":"Delivery Address Name"},"rcvmnNm":{"type":"string","description":"Recipient Name"},"dlvpSeq":{"type":"string","description":"Delivery Address Sequence No."},"maxDlvpSeq":{"type":"string","description":"Maximum Delivery Address Sequence No."},"zipNo":{"type":"string","description":"Postal Code"},"zipAddr":{"type":"string","description":"Postal Address"},"dtlAddr":{"type":"string","description":"Detailed 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."},"lastDeliResponse":{"$ref":"#/components/schemas/ClaimTargetGoodsDeliResponse"},"shippingDeliGbCd":{"type":"boolean"},"opOrdDtlUpdateKey":{"$ref":"#/components/schemas/OpOrdDtl"},"generalSalesProduct":{"type":"boolean"},"exchangeShipping":{"type":"boolean"},"withdrawalDeliGbCd":{"type":"boolean"},"withdrawShipping":{"type":"boolean"},"ordSeqAndUprOrdProcSeq":{"type":"string"},"goodsNoAndItmNo":{"type":"string"},"ordSeqAndOrdProcSeq":{"type":"string"}},"description":"Claim Processing Target Product Response DTO"},"ClaimDlvp":{"required":["dlvpNm","dtlAddr","rcvmnNm","zipAddr","zipNo"],"type":"object","properties":{"mbrOrdDlvpGb":{"type":"string","description":" ClaimDlvpGbCd (Claim Delivery Address Type)\n * 10 : Member Delivery Address\n * 20 : Order Delivery Address\n","enum":["MBR","ORD"]},"dlvpSeq":{"type":"string","description":"Delivery Address Sequence No."},"zipNoSeq":{"type":"integer","description":"Postal Code Sequence No.","format":"int64"},"dlvpNm":{"type":"string","description":"Delivery Address Name"},"rcvmnNm":{"type":"string","description":"Recipient Name"},"zipNo":{"type":"string","description":"Postal Code"},"zipAddr":{"type":"string","description":"Postal Address"},"dtlAddr":{"type":"string","description":"Detailed 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 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) 20: Please call before delivery, 30: Leave at the door if absent, 40: Leave with security desk if absent, 50: Please deliver quickly, 60: Please call my mobile if absent, 70: Enter manually"},"shopTrafMsg":{"type":"string","description":"Store Delivery Message"},"comnFrdrCogoMethodCd":{"type":"string","description":"Common Entrance Access Method Code (ME040) 10: Entrance access code, 20: Free access, 30: Other","default":"20"},"comnFrdrEtcMethod":{"type":"string","description":"Other Common Entrance Access Method"},"comnFrdrPwd":{"type":"string","description":"Common Entrance Password"}},"description":"Claim Delivery Information DTO"},"ClaimTargetGoodsDeliResponse":{"type":"object","properties":{"ordNo":{"type":"string"},"deliNo":{"type":"string"},"ordSeq":{"type":"string"},"ordProcSeq":{"type":"string"},"shipIndiDtm":{"type":"string","format":"date-time"},"shipCfmDtm":{"type":"string","format":"date-time"},"shipFnshDtm":{"type":"string","format":"date-time"},"deliFnshDtm":{"type":"string","format":"date-time"},"hdcCd":{"type":"string"},"invNo":{"type":"string"},"deliDtlStatCd":{"type":"string"}},"description":"Search Claim Processing Target Delivery Info Response DTO"},"OpOrdDtl":{"type":"object","properties":{"ordNo":{"type":"string"},"ordSeq":{"type":"integer","format":"int32"},"ordProcSeq":{"type":"integer","format":"int32"},"uprOrdProcSeq":{"type":"integer","format":"int32"},"claimNo":{"type":"string"},"goodsNo":{"type":"string"},"itmNo":{"type":"string"},"ordDtlGbCd":{"type":"string"},"deliGbCd":{"type":"string"},"ordAccpDtm":{"type":"string","format":"date-time"},"ordFnshDtm":{"type":"string","format":"date-time"},"ordDtlStatCd":{"type":"string"},"ordQty":{"type":"integer","format":"int32"},"cnclQty":{"type":"integer","format":"int32"},"rtnQty":{"type":"integer","format":"int32"},"deliIndiDtm":{"type":"string","format":"date-time"},"deliIndiRsvDtm":{"type":"string","format":"date-time"},"deliNo":{"type":"string"},"exchMidRtnYn":{"type":"string"},"claimLgrpCd":{"type":"string"},"claimMgrpCd":{"type":"string"},"claimCausEtcCont":{"type":"string"},"rtnPsbYn":{"type":"string"},"exchPsbYn":{"type":"string"},"ordCnclPsbYn":{"type":"string"},"wthdYn":{"type":"string"},"wthdFnshGbCd":{"type":"string"},"shipFnshFcstDtm":{"type":"string","format":"date-time"},"etcktNo":{"type":"string"},"ecpnNo":{"type":"string"}},"description":"Order Detail List"},"StCdDtlResponse":{"type":"object","properties":{"cd":{"type":"string","description":"Code"},"cdNm":{"type":"string","description":"Code Name"},"cdDesc":{"type":"string","description":"Code Description"},"sortSeq":{"type":"string","description":"Sort Order"},"ref1Val":{"type":"string","description":"Reference Value 1"},"ref2Val":{"type":"string","description":"Reference Value 2"},"ref3Val":{"type":"string","description":"Reference Value 3"},"ref4Val":{"type":"string","description":"Reference Value 4"},"ref5Val":{"type":"string","description":"Reference Value 5"},"ref6Val":{"type":"string","description":"Reference Value 6"},"ref7Val":{"type":"string","description":"Reference Value 7"}},"description":"Common Code Response DTO"},"Response":{"type":"object","properties":{"timestamp":{"type":"string","description":"result time","format":"date-time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"type":"object","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"}},"description":"validation error list"}}}}
```
## Search Order Cancellation Targets (FO)
> \## Function Description\
> \* Retrieves order history, the list of cancellable products, and other information needed for screen processing.\
> \---\
> \## Detailed Description\
> \* \*\*Order No. (ordNo), Claim Business Type (claimBusinessType), and System Type (systemType)\*\* are required parameters.\
> \* Order cancellation is possible for targets that satisfy all of the following conditions.\
> \* Order Detail Classification (OM003) value is \*\*General Order (10)\*\*\
> \* Order Detail Status (OM005) value is \*\*Order Completed (12)\*\*, \*\*Delivery Instructed (21)\*\*, \*\*Shipment Instructed (22)\*\*, or \*\*Awaiting Shipment (23)\*\*\
> \* The item is a general product (gifts excluded)\
> \* The cancellable quantity is 1 or more (\*\*Order Quantity – Cancelled Quantity – Returned Quantity > 0\*\*)\
> \* Order Cancellation Available Status is 'Y'\
> \* The other information included is as follows.\
> \* Order Cancellation Mid-Category Reason List\
> \* A Map with the liability reason code as the Key and the order cancellation mid-category reason as the Value\
> \---\
> \## Revision History\
> \* release\_231204\_01 : Added delivery address sequence number (dlvpSeq) to the Request DTO; added filtering when a delivery address sequence value exists during target retrieval\
> \* Release v2.00\_240729 : Excludes targets where Order Cancellation Available Status (ordCnclPsbYn) is "N"
```json
{"openapi":"3.0.1","info":{"title":"X2BEE Order API","version":"v1"},"servers":[{"url":"https://api-order.x2bee.com/api/order/","description":"prd"}],"paths":{"/v1/claim/orderCancel/cancelPopupFO":{"post":{"tags":["Order Cancellation"],"summary":"Search Order Cancellation Targets (FO)","description":"## Function Description\n* Retrieves order history, the list of cancellable products, and other information needed for screen processing.\n---\n## Detailed Description\n* **Order No. (ordNo), Claim Business Type (claimBusinessType), and System Type (systemType)** are required parameters.\n* Order cancellation is possible for targets that satisfy all of the following conditions.\n * Order Detail Classification (OM003) value is **General Order (10)**\n * Order Detail Status (OM005) value is **Order Completed (12)**, **Delivery Instructed (21)**, **Shipment Instructed (22)**, or **Awaiting Shipment (23)**\n * The item is a general product (gifts excluded)\n * The cancellable quantity is 1 or more (**Order Quantity – Cancelled Quantity – Returned Quantity > 0**)\n * Order Cancellation Available Status is 'Y'\n* The other information included is as follows.\n * Order Cancellation Mid-Category Reason List\n * A Map with the liability reason code as the Key and the order cancellation mid-category reason as the Value\n---\n## Revision History\n* release_231204_01 : Added delivery address sequence number (dlvpSeq) to the Request DTO; added filtering when a delivery address sequence value exists during target retrieval\n* Release v2.00_240729 : Excludes targets where Order Cancellation Available Status (ordCnclPsbYn) is \"N\"\n","operationId":"getOrderCancelPopupInfoFO","parameters":[{"name":"Authorization","in":"header","description":"Access Token","required":false}],"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"}}}}}}}},"components":{"schemas":{"ClaimTargetRequest":{"required":["ordNo","systemType"],"type":"object","properties":{"ordNo":{"type":"string","description":"Order No."},"claimBusinessType":{"type":"string","description":" ClaimBusiness (Claim Business Type)\n * 11 : Order Cancellation\n * 20 : Return Receipt\n * 21 : Return Cancellation\n * 30 : Exchange Receipt\n * 31 : Exchange Cancellation\n * 22 : Return Completed\n * 23 : Return Not Possible\n * 24 : Exchange Return\n * 25 : Return On Hold\n","enum":["ORDER_CANCEL","RETURN_ACCEPT","RETURN_WITHDRAWAL","EXCHANGE_ACCEPT","EXCHANGE_WITHDRAWAL","RETURN_COMPLETE","RETURN_REJECT","RETURN_TRANSFORM","RETURN_PENDING","DELIVERY_FEE_PAYMENT"]},"orgClmNo":{"type":"string","description":"Original Claim No."},"systemType":{"type":"string","description":" SYSTEM (System Type)\n * 10 : FO\n * 20 : BO\n","enum":["FO","BO"],"default":"20"},"dlvpSeq":{"type":"string","description":"Delivery Address Sequence No."},"systemCdNmAndButtonCode":{"type":"string"},"claimBusiness":{"type":"string","description":" ClaimBusiness (Claim Business Type)\n * 11 : Order Cancellation\n * 20 : Return Receipt\n * 21 : Return Cancellation\n * 30 : Exchange Receipt\n * 31 : Exchange Cancellation\n * 22 : Return Completed\n * 23 : Return Not Possible\n * 24 : Exchange Return\n * 25 : Return On Hold\n","enum":["ORDER_CANCEL","RETURN_ACCEPT","RETURN_WITHDRAWAL","EXCHANGE_ACCEPT","EXCHANGE_WITHDRAWAL","RETURN_COMPLETE","RETURN_REJECT","RETURN_TRANSFORM","RETURN_PENDING","DELIVERY_FEE_PAYMENT"]},"system":{"type":"string","description":" SYSTEM (System Type)\n * 10 : FO\n * 20 : BO\n","enum":["FO","BO"]}},"description":"Claim Eligibility Search Request DTO"},"OrderCancelPopupResponse":{"type":"object","properties":{"claimTargetResponse":{"$ref":"#/components/schemas/ClaimTargetResponse"},"claimCausCdList":{"type":"array","description":"Claim Major Category Reason","items":{"$ref":"#/components/schemas/StCdDtlResponse"}},"claimMgrpRspnGbCdMap":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/StCdDtlResponse"},"description":"Claim Sub-Category Reason Map Keyed by Responsibility Type Code"}},"description":"Claim Eligibility Search Response DTO"},"ClaimTargetResponse":{"type":"object","properties":{"ordNo":{"type":"string","description":"Order No."},"mbrNo":{"type":"string","description":"Member No."},"mbrGradeCd":{"type":"string","description":"Member Grade Code (ME008)\n 10 : GREEN\n, 20 : FAMILY\n, 30 : GOLD\n, 40 : VIP\n, 50 : VVIP\n","enum":["10","20","30","40","50"]},"ordGbCd":{"type":"string","description":"OM002 (Order Classification Code)\n 10: General Order\n , 20: Gift\n , 30: E-Coupon\n , 40: Affiliate\n","enum":["GENERAL_ORDER","GIVE_GIFT_ORDER","E_COUPON","SUBSCRIBE_ORDER"]},"mbrMgrCd":{"type":"string","description":"ME002 (Member Management Code)\n 10: UNION_MEMBER (Integrated Member)\n,20: GENERAL_MEMBER (General Member)\n,30: SOCIAL_MEMBER (Social Member)\n,99: NO_MEMBER (Non-Member)\n","enum":["UNION_MEMBER","GENERAL_MEMBER","SOCIAL_MEMBER","ENTERPRISE_MEMBER","NO_MEMBER"]},"ordManNm":{"type":"string","description":"Orderer Name"},"ordManEmailAddr":{"type":"string","description":"Orderer Email Address"},"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"},"ordMediaCd":{"type":"string","description":"Order Channel Code (OM007)\n 10 : Phone Consultation (CC)\n, 20 : PC\n, 30 : Mobile Web\n, 40 : Android App\n, 50 : iOS App\n, 60 : Subscription Order\n","enum":["10","20","30","40","50","60"]},"ordAccpDtm":{"type":"string","description":"Order Receipt Date","format":"date-time"},"sctnCnclPsbYn":{"type":"string","description":"Partial Cancellation Availability Status","enum":["Y","N"]},"claimTargetGoodsResponseList":{"type":"array","description":"Claim Target Product List","items":{"$ref":"#/components/schemas/ClaimTargetGoodsResponse"}},"allNonReturnable":{"type":"boolean"},"vbankPaymentPending":{"type":"boolean"},"allEcoupon":{"type":"boolean"},"upGoodsImg":{"type":"object","additionalProperties":{"type":"string"},"writeOnly":true}},"description":"Claim Processing Target Response DTO"},"ClaimTargetGoodsResponse":{"required":["claimMgrpCd"],"type":"object","properties":{"goodsNo":{"type":"string","description":"Product No."},"deliProcTypCd":{"type":"string","description":"PR008 (Delivery Processing Type Code)\n 10: CNTR_DLV (Center Delivery)\n,20: CORP_DLV (Vendor Delivery)\n,30: E_COUPON_DLV (E-Coupon Delivery)\n","enum":["CNTR_DLV","CORP_DLV","E_COUPON_DLV"]},"deliPolcNo":{"type":"string","description":"Delivery Policy No."},"deliNo":{"type":"string","description":"Delivery No."},"entrNo":{"type":"string","description":"Vendor No."},"ordQty":{"type":"integer","description":"Order Quantity","format":"int32"},"salePrc":{"type":"integer","description":"Selling Price","format":"int64"},"dcAmt":{"type":"integer","description":"Discounted Price","format":"int64"},"sysModDtm":{"type":"string","description":"System Modification Date/Time","format":"date-time"},"ordNo":{"type":"string","description":"Order No."},"ordSeq":{"type":"integer","description":"Order Sequence No.","format":"int32"},"ordProcSeq":{"type":"integer","description":"Order Processing Sequence No.","format":"int32"},"uprOrdProcSeq":{"type":"integer","description":"Parent Order Processing Sequence No.","format":"int32"},"maxOrdProcSeq":{"type":"integer","description":"Maximum Order Processing Sequence No.","format":"int32"},"claimNo":{"type":"string","description":"Claim No."},"itmNo":{"type":"string","description":"Item No."},"ordDtlGbCd":{"type":"string","description":"OM003(Order Detail Type Code)\n 10: Regular Order\n , 11: Order Cancellation\n , 20: Regular Return\n , 21: Return Cancellation\n , 30: Exchange Order\n , 31: Exchange Cancellation\n , 40: Exchange Return\n","enum":["ORDER_GENERAL","ORDER_CANCEL","RETURN_GENERAL","RETURN_WITHDRAWAL","EXCHANGE_ORDER","EXCHANGE_WITHDRAWAL","EXCHANGE_RETURN"]},"ordDtlGbCdNm":{"type":"string","description":"Order Detail Classification Code Name"},"ordDtlStatCd":{"type":"string","description":"OM005 (Order Detail Status Code)\n 10: REPAY_REQ(Repayment Requested)\n,11: ORDER_ACCEPT(Order Accepted)\n,12: ORDER_COMPLETE(Order Completed)\n,13: ORDER_CANCEL(Order Cancelled)\n,21: DELIVERY_ORDER(Delivery Instructed)\n,22: SHIPPING_ORDER(Shipment Instructed)\n,23: SHIPPING_WAIT(Awaiting Shipment)\n,25: SHIPPING_CONFIRM(Shipment Confirmed)\n,26: SHIPPING_FINISH(Shipment Completed)\n,27: DELIVERY_FINISH(Delivery Completed)\n,31: RETURN_APPLY(Payment Pending)\n,32: RETURN_ACCEPT(Return Accepted)\n,33: RETURN_CANCEL(Return Cancelled)\n,34: WITHDRAWAL_ORDER(Collection Instructed)\n,35: WITHDRAWAL_CONFIRM(Collection Confirmed)\n,36: WITHDRAWAL_FINISH(Collection Completed)\n,37: RETURN_FINISH(Return Completed)\n","enum":["REPAY_REQ","ORDER_ACCEPT","ORDER_COMPLETE","ORDER_CANCEL","DELIVERY_ORDER","SHIPPING_ORDER","SHIPPING_WAIT","SHIPPING_CONFIRM","SHIPPING_FINISH","DELIVERY_FINISH","PARTIAL_SHIPPING","RETURN_APPLY","RETURN_ACCEPT","RETURN_CANCEL","WITHDRAWAL_ORDER","WITHDRAWAL_CONFIRM","WITHDRAWAL_FINISH","RETURN_FINISH"]},"ordDtlStatCdNm":{"type":"string","description":"Order Detail Status Code Name"},"deliGbCd":{"type":"string","description":" LO001(Delivery Type Code)\n * 10 : Shipment\n * 20 : Return\n","enum":["SHIPPING","WITHDRAWAL"]},"ordAccpDtm":{"type":"string","description":"Order Receipt Date/Time","format":"date-time"},"ordFnshDtm":{"type":"string","description":"Order Completion Date/Time","format":"date-time"},"cnclQty":{"type":"integer","description":"Cancellation Quantity","format":"int32"},"rtnQty":{"type":"integer","description":"Return Quantity","format":"int32"},"claimQty":{"type":"integer","description":"Claim Quantity","format":"int32"},"claimPossibleQty":{"type":"integer","description":"Claimable Quantity","format":"int32"},"deliIndiDtm":{"type":"string","description":"Delivery Instruction Date/Time","format":"date-time"},"deliIndiRsvDtm":{"type":"string","description":"Delivery Instruction Reservation Date/Time","format":"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":"OM047(Claim Major Category Code)\n 10: Simple Change of Mind\n , 20: Defective Product\n , 30: Delivery Complaint\n , 40: Product Information Error\n , 50: Re-payment Order\n","enum":["SIMPLE_CHANGE","GOODS_BAD","DELIVERY_CLAIM","GOODS_INFOMATION_ERROR","REPAYMENT_ORDER"]},"claimLgrpCdNm":{"type":"string","description":"Claim Major Category Code Name"},"claimMgrpCd":{"type":"string","description":"OM006(Claim Sub-Category Code)\n 100: Delivery Delayed\n , 101: Product Out of Stock\n , 102: Option/Size Change/Cancellation\n , 103: More Expensive Than Elsewhere\n , 104: Coupon/Discount Benefit Change\n , 105: No Longer Wish to Purchase\n , 106: Gift Change/Cancellation\n , 107: Payment Method Change (Purchase Gift Applied/Card Change, etc.)\n , 108: Purchased Similar Product\n , 109: Insufficient Product Information\n , 110: Seller Cancellation (Seller)\n , 111: Discretionary Cancellation (Agent)\n , 112: Automatic Cancellation (Insufficient Payment)\n , 113: Automatic Cancellation (Out-of-Stock Cancellation)\n , 300: Size Too Large\n , 301: Size Too Small\n , 302: Simple Change of Mind - Color Change\n , 303: Stained\n , 304: Damaged (Seam Tear, etc.)\n , 305: Missing Components (Necklace, Belt, etc.)\n , 306: Defective Contents (Cosmetics, etc.)\n , 307: Wrong Product Delivered\n , 308: Other\n , 200: Ordered Different Product\n , 201: Size Too Large\n , 203: Size Too Small\n , 204: Product Image Differs (Color, Design, Fit)\n , 205: No Longer Wish to Purchase\n , 206: No Color or Size Exchange Option Available\n , 207: Other\n , 208: Stained\n , 209: Damaged (Seam Tear, etc.)\n , 210: Missing Components (Necklace, Belt, etc.)\n , 211: Defective Contents (Cosmetics, etc.)\n , 212: Other\n , 213: Wrong Size Delivered\n , 214: Wrong Color Delivered\n , 215: Wrong Product Delivered\n , 216: Delivery Delayed\n , 217: Other\n , 218: Measured Size Error\n , 219: Material Error\n , 220: Color Error\n , 221: Differs From Product Description (Mislabeled)\n , 222: Other\n , 223: Return On Hold\n , 224: Return Not Possible\n","enum":["CLAIM_MGRP_CD_100","CLAIM_MGRP_CD_101","CLAIM_MGRP_CD_102","CLAIM_MGRP_CD_103","CLAIM_MGRP_CD_104","CLAIM_MGRP_CD_105","CLAIM_MGRP_CD_106","CLAIM_MGRP_CD_107","CLAIM_MGRP_CD_108","CLAIM_MGRP_CD_109","CLAIM_MGRP_CD_110","CLAIM_MGRP_CD_111","CLAIM_MGRP_CD_112","CLAIM_MGRP_CD_113","CLAIM_MGRP_CD_114","CLAIM_MGRP_CD_300","CLAIM_MGRP_CD_301","CLAIM_MGRP_CD_302","CLAIM_MGRP_CD_303","CLAIM_MGRP_CD_304","CLAIM_MGRP_CD_305","CLAIM_MGRP_CD_306","CLAIM_MGRP_CD_307","CLAIM_MGRP_CD_308","CLAIM_MGRP_CD_200","CLAIM_MGRP_CD_201","CLAIM_MGRP_CD_203","CLAIM_MGRP_CD_204","CLAIM_MGRP_CD_205","CLAIM_MGRP_CD_206","CLAIM_MGRP_CD_207","CLAIM_MGRP_CD_208","CLAIM_MGRP_CD_209","CLAIM_MGRP_CD_210","CLAIM_MGRP_CD_211","CLAIM_MGRP_CD_212","CLAIM_MGRP_CD_213","CLAIM_MGRP_CD_214","CLAIM_MGRP_CD_215","CLAIM_MGRP_CD_216","CLAIM_MGRP_CD_217","CLAIM_MGRP_CD_218","CLAIM_MGRP_CD_219","CLAIM_MGRP_CD_220","CLAIM_MGRP_CD_221","CLAIM_MGRP_CD_222","CLAIM_MGRP_CD_223","CLAIM_MGRP_CD_224"]},"claimMgrpCdNm":{"type":"string","description":"Claim Subcategory Code Name"},"claimCausEtcCont":{"type":"string","description":"Other Claim Reason Details"},"ordSaleTypCd":{"type":"string","description":"OM004 (Order Sales Type Code)\n 10: General Sale\n , 20: Order Gift\n , 30: Product Gift\n","enum":["GENERAL_SALES","ORDER_FREE_GIFT","GOODS_FREE_GIFT"]},"chlNo":{"type":"string","description":"Channel No."},"chlDtlNo":{"type":"string","description":"Channel Detail No."},"stdCtgNo":{"type":"string","description":"Standard Category No."},"infDispCtgNoGbCd":{"type":"string","description":"OM041(Inflow Display Category No. Type Code)\n 01: DISPLAY_STORE(Display Store)\n,02: EXHIBITIONS(Special Exhibition)\n,06: SEARCH_SALES(Search Sales)\n,07: SEARCH_AD_BANNER(Search Ad Banner)\n,08: FLOATING_BANNER(Floating Banner)\n,09: WISHLIST(Wishlist)\n,10: NONE(No Inflow Display No.)\n","enum":["DISPLAY_STORE","EXHIBITIONS","SEARCH_SALES","SEARCH_AD_BANNER","FLOATING_BANNER","WISHLIST","NONE"]},"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"},"goodsImg":{"type":"string","description":"Product Image Path"},"itmNm":{"type":"string","description":"Item Name"},"prestNm":{"type":"string","description":"Gift Item Name"},"goodsCompCd":{"type":"string","description":"PR001 (Product Composition Code)\n 10: GEN_GOODS (General Product)\n,20: PKG_GOODS (Bundled Product)\n","enum":["GEN_GOODS","PKG_GOODS"]},"goodsTypCd":{"type":"string","description":"PR002 (Product Type Code)\n 10: GEN_GOODS (General Product)\n,20: GFT_GOODS (Free Gift)\n,30: CPN_GOODS (E-Coupon Product)\n","enum":["GEN_GOODS","GFT_GOODS","CPN_GOODS"]},"saleMethCd":{"type":"string","description":"PR003 (Sales Method Code)\n 10: NORMAL_SALE (General Sale)\n,20: RSV_SALE (Reservation Product)\n","enum":["NORMAL_SALE","RSV_SALE"]},"taxGbCd":{"type":"string","description":"Tax/Duty-Free Classification Code (PR007)"},"buyTypCd":{"type":"string","description":"Purchase Type Code (PR006)"},"supPcost":{"type":"integer","description":"Supply Cost","format":"int64"},"norPrc":{"type":"integer","description":"Regular Price","format":"int64"},"mrgnRate":{"type":"integer","description":"Margin Rate","format":"int64"},"deliDday":{"type":"integer","description":"Delivery Lead Time","format":"int64"},"deliGoodsGbCd":{"type":"string","description":"PR010 (Delivery Product Type Code)\n 01: GEN_GOODS (General Product)\n,02: INST_GOODS (Installation Product)\n,03: ORDMK_GOODS (Made-to-Order Product)\n,04: E_COUPON (E-Coupon)\n","enum":["GEN_GOODS","INST_GOODS","ORDMK_GOODS","E_COUPON"]},"deliWayCd":{"type":"string","description":"PR009 (Delivery Method Code)\n 01: COURIER_DELIVERY (Courier Delivery)\n,02: NON_DELIVERY (No Delivery)\n","enum":["COURIER_DELIVERY","NON_DELIVERY"]},"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":"integer","description":"Benefit Amount","format":"int64"},"ordPrc":{"type":"integer","description":"Order Amount","format":"int64"},"aeGoodsYn":{"type":"string","description":"Gift Status","enum":["Y","N"]},"withdrawalDeliNo":{"type":"string","description":"Pickup Destination Delivery No."},"shipmentDeliNo":{"type":"string","description":"Delivery Address Delivery No."},"deliTypCd":{"type":"string","description":" LO002 (Delivery Type Code)\n * 10 : Normal Shipment\n * 11 : Exchange Shipment\n * 20 : Return Collection\n * 21 : Exchange Collection\n","enum":["NORMAL_SHIPPING","EXCHANGE_SHIPPING","RETURN_RECOVERY","EXCHANGE_RECOVERY"]},"deliKindCd":{"type":"string","description":"LO009(Delivery Type Code)\n 10: NORMAL_DELIVERY(Standard Delivery)\n,20: RESERVATION_DELIVERY(Reserved Delivery)\n","enum":["NORMAL_DELIVERY","RESERVATION_DELIVERY"]},"deliMethodCd":{"type":"string","description":" LO010 (Delivery Method Code)\n * 10 : Courier Delivery\n * 30 : Store Pickup\n * 40 : Quick Delivery\n * 50 : Overseas Delivery\n * 60 : No Delivery\n","enum":["COURIER_DELIVERY","FOUR_PM","STORE_PICK_UP","QUICK_DELIVERY","OVERSEAS_DELIVERY","NON_DELIVERY"]},"deliProcTypCdNm":{"type":"string","description":"Delivery Processing Type Code Name"},"puTypCd":{"type":"string","description":" LO006 (Collection Type Code)\n * 20 : Collection\n * 30 : Collection Not Required\n","enum":["SHIPPING","WITHDRAWAL","WITHDRAWAL_NOT_REQUIRED"]},"wthdFnshGbCd":{"type":"string","description":"Collection Completion Classification Code","enum":["NORMAL_RETURN","BAD_RETURN","COURIER_LOSE","RETURN_TRANSFORM"]},"dlvpNm":{"type":"string","description":"Delivery Address Name"},"rcvmnNm":{"type":"string","description":"Recipient Name"},"dlvpSeq":{"type":"string","description":"Delivery Address Sequence No."},"maxDlvpSeq":{"type":"string","description":"Maximum Delivery Address Sequence No."},"zipNo":{"type":"string","description":"Postal Code"},"zipAddr":{"type":"string","description":"Postal Address"},"dtlAddr":{"type":"string","description":"Detailed 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."},"lastDeliResponse":{"$ref":"#/components/schemas/ClaimTargetGoodsDeliResponse"},"shippingDeliGbCd":{"type":"boolean"},"opOrdDtlUpdateKey":{"$ref":"#/components/schemas/OpOrdDtl"},"generalSalesProduct":{"type":"boolean"},"exchangeShipping":{"type":"boolean"},"withdrawalDeliGbCd":{"type":"boolean"},"withdrawShipping":{"type":"boolean"},"ordSeqAndUprOrdProcSeq":{"type":"string"},"goodsNoAndItmNo":{"type":"string"},"ordSeqAndOrdProcSeq":{"type":"string"}},"description":"Claim Processing Target Product Response DTO"},"ClaimDlvp":{"required":["dlvpNm","dtlAddr","rcvmnNm","zipAddr","zipNo"],"type":"object","properties":{"mbrOrdDlvpGb":{"type":"string","description":" ClaimDlvpGbCd (Claim Delivery Address Type)\n * 10 : Member Delivery Address\n * 20 : Order Delivery Address\n","enum":["MBR","ORD"]},"dlvpSeq":{"type":"string","description":"Delivery Address Sequence No."},"zipNoSeq":{"type":"integer","description":"Postal Code Sequence No.","format":"int64"},"dlvpNm":{"type":"string","description":"Delivery Address Name"},"rcvmnNm":{"type":"string","description":"Recipient Name"},"zipNo":{"type":"string","description":"Postal Code"},"zipAddr":{"type":"string","description":"Postal Address"},"dtlAddr":{"type":"string","description":"Detailed 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 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) 20: Please call before delivery, 30: Leave at the door if absent, 40: Leave with security desk if absent, 50: Please deliver quickly, 60: Please call my mobile if absent, 70: Enter manually"},"shopTrafMsg":{"type":"string","description":"Store Delivery Message"},"comnFrdrCogoMethodCd":{"type":"string","description":"Common Entrance Access Method Code (ME040) 10: Entrance access code, 20: Free access, 30: Other","default":"20"},"comnFrdrEtcMethod":{"type":"string","description":"Other Common Entrance Access Method"},"comnFrdrPwd":{"type":"string","description":"Common Entrance Password"}},"description":"Claim Delivery Information DTO"},"ClaimTargetGoodsDeliResponse":{"type":"object","properties":{"ordNo":{"type":"string"},"deliNo":{"type":"string"},"ordSeq":{"type":"string"},"ordProcSeq":{"type":"string"},"shipIndiDtm":{"type":"string","format":"date-time"},"shipCfmDtm":{"type":"string","format":"date-time"},"shipFnshDtm":{"type":"string","format":"date-time"},"deliFnshDtm":{"type":"string","format":"date-time"},"hdcCd":{"type":"string"},"invNo":{"type":"string"},"deliDtlStatCd":{"type":"string"}},"description":"Search Claim Processing Target Delivery Info Response DTO"},"OpOrdDtl":{"type":"object","properties":{"ordNo":{"type":"string"},"ordSeq":{"type":"integer","format":"int32"},"ordProcSeq":{"type":"integer","format":"int32"},"uprOrdProcSeq":{"type":"integer","format":"int32"},"claimNo":{"type":"string"},"goodsNo":{"type":"string"},"itmNo":{"type":"string"},"ordDtlGbCd":{"type":"string"},"deliGbCd":{"type":"string"},"ordAccpDtm":{"type":"string","format":"date-time"},"ordFnshDtm":{"type":"string","format":"date-time"},"ordDtlStatCd":{"type":"string"},"ordQty":{"type":"integer","format":"int32"},"cnclQty":{"type":"integer","format":"int32"},"rtnQty":{"type":"integer","format":"int32"},"deliIndiDtm":{"type":"string","format":"date-time"},"deliIndiRsvDtm":{"type":"string","format":"date-time"},"deliNo":{"type":"string"},"exchMidRtnYn":{"type":"string"},"claimLgrpCd":{"type":"string"},"claimMgrpCd":{"type":"string"},"claimCausEtcCont":{"type":"string"},"rtnPsbYn":{"type":"string"},"exchPsbYn":{"type":"string"},"ordCnclPsbYn":{"type":"string"},"wthdYn":{"type":"string"},"wthdFnshGbCd":{"type":"string"},"shipFnshFcstDtm":{"type":"string","format":"date-time"},"etcktNo":{"type":"string"},"ecpnNo":{"type":"string"}},"description":"Order Detail List"},"StCdDtlResponse":{"type":"object","properties":{"cd":{"type":"string","description":"Code"},"cdNm":{"type":"string","description":"Code Name"},"cdDesc":{"type":"string","description":"Code Description"},"sortSeq":{"type":"string","description":"Sort Order"},"ref1Val":{"type":"string","description":"Reference Value 1"},"ref2Val":{"type":"string","description":"Reference Value 2"},"ref3Val":{"type":"string","description":"Reference Value 3"},"ref4Val":{"type":"string","description":"Reference Value 4"},"ref5Val":{"type":"string","description":"Reference Value 5"},"ref6Val":{"type":"string","description":"Reference Value 6"},"ref7Val":{"type":"string","description":"Reference Value 7"}},"description":"Common Code Response DTO"},"Response":{"type":"object","properties":{"timestamp":{"type":"string","description":"result time","format":"date-time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"type":"object","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"}},"description":"validation error list"}}}}
```
## Cancel Order (FO)
> \## Function Description\
> \* Cancels the order.\
> \---\
> \## Detailed Description\
> \* Checks the order status at the time the order cancellation processing API is called to verify whether registration is possible.\
> \* Validates the order cancellation request data for the following items:\
> \* Checks whether the registered product includes a free gift (-> \*Partial quantity claim not possible\*)\
> \* Checks whether a payment method that does not allow partial cancellation was used (-> \*Partial claim not possible\*)\
> \* Creates and updates the order cancellation data.\
> \* Validates the refund/payment amounts arising from the order cancellation.\
> \* If there is a coupon to restore, the coupon is restored.\
> \* Stock is restored for the cancelled order products.\
> \* The refund/payment is processed.\
> \* Sends a notification to the customer for the order cancellation. (Email/AlimTalk/Notification box)\
> \---\
> \## Revision History\
> \* release\_231009\_01 : Added order quantity and cancel quantity columns to the order benefit relationship table\
> \* Release v2.00\_240627: Removed the logic that checks whether the delivery number of the registered product matches (added full cancellation feature)\
> \* Release v2.00\_250714: Added refund tax invoice issuance when processing a claim\
> \* Release v2.00\_250801 : Enabled activation of supporting documents (tax invoice) based on configuration\
> \* Release v2.00\_251020 : Added cash receipt cancellation issuance when processing an INICIS claim
```json
{"openapi":"3.0.1","info":{"title":"X2BEE Order API","version":"v1"},"servers":[{"url":"https://api-order.x2bee.com/api/order/","description":"prd"}],"paths":{"/v1/claim/orderCancel/cancelFO":{"post":{"tags":["Order Cancellation"],"summary":"Cancel Order (FO)","description":"## Function Description\n* Cancels the order.\n---\n## Detailed Description\n* Checks the order status at the time the order cancellation processing API is called to verify whether registration is possible.\n* Validates the order cancellation request data for the following items:\n * Checks whether the registered product includes a free gift (-> *Partial quantity claim not possible*)\n * Checks whether a payment method that does not allow partial cancellation was used (-> *Partial claim not possible*)\n* Creates and updates the order cancellation data.\n* Validates the refund/payment amounts arising from the order cancellation.\n* If there is a coupon to restore, the coupon is restored.\n* Stock is restored for the cancelled order products.\n* The refund/payment is processed.\n* Sends a notification to the customer for the order cancellation. (Email/AlimTalk/Notification box)\n---\n## Revision History\n* release_231009_01 : Added order quantity and cancel quantity columns to the order benefit relationship table\n* Release v2.00_240627: Removed the logic that checks whether the delivery number of the registered product matches (added full cancellation feature)\n* Release v2.00_250714: Added refund tax invoice issuance when processing a claim\n* Release v2.00_250801 : Enabled activation of supporting documents (tax invoice) based on configuration\n* Release v2.00_251020 : Added cash receipt cancellation issuance when processing an INICIS claim\n","operationId":"cancelOrderFO","parameters":[{"name":"Authorization","in":"header","description":"Access Token","required":false}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClaimRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ClaimProcessResultResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"components":{"schemas":{"ClaimRequest":{"required":["claimBusinessType","claimDlvp","claimGoodsList","claimNo","claimReturnDlvp","ordMediaCd","ordNo","systemType","wthdFnshWaitProcCaus"],"type":"object","properties":{"systemType":{"type":"string","description":" SYSTEM (System Type)\n * 10 : FO\n * 20 : BO\n","enum":["FO","BO"]},"claimBusinessType":{"type":"string","description":" ClaimBusiness (Claim Business Type)\n * 11 : Order Cancellation\n * 20 : Return Receipt\n * 21 : Return Cancellation\n * 30 : Exchange Receipt\n * 31 : Exchange Cancellation\n * 22 : Return Completed\n * 23 : Return Not Possible\n * 24 : Exchange Return\n * 25 : Return On Hold\n","enum":["ORDER_CANCEL","RETURN_ACCEPT","RETURN_WITHDRAWAL","EXCHANGE_ACCEPT","EXCHANGE_WITHDRAWAL","RETURN_COMPLETE","RETURN_REJECT","RETURN_TRANSFORM","RETURN_PENDING","DELIVERY_FEE_PAYMENT"]},"ordMediaCd":{"type":"string","description":"Order Channel Code (OM007)\n 10 : Phone Consultation (CC)\n, 20 : PC\n, 30 : Mobile Web\n, 40 : Android App\n, 50 : iOS App\n, 60 : Subscription Order\n","enum":["10","20","30","40","50","60"]},"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"}},"paymentRequest":{"$ref":"#/components/schemas/PaymentRequestPaymentInfo"},"claimCpnInfoList":{"type":"array","description":"Coupon List","items":{"$ref":"#/components/schemas/ClaimCpnInfo"}},"claimReturnDlvp":{"$ref":"#/components/schemas/ClaimDlvp"},"claimDlvp":{"$ref":"#/components/schemas/ClaimDlvp"},"claimFinalAmtInfo":{"$ref":"#/components/schemas/ClaimFinalAmtInfo"},"wthdFnshWaitProcCaus":{"type":"string","description":"Pickup Completion Pending Reason"},"occurPayment":{"type":"boolean"},"existAddtionPayAmt":{"type":"boolean"},"claimBusiness":{"type":"string","description":" ClaimBusiness (Claim Business Type)\n * 11 : Order Cancellation\n * 20 : Return Receipt\n * 21 : Return Cancellation\n * 30 : Exchange Receipt\n * 31 : Exchange Cancellation\n * 22 : Return Completed\n * 23 : Return Not Possible\n * 24 : Exchange Return\n * 25 : Return On Hold\n","enum":["ORDER_CANCEL","RETURN_ACCEPT","RETURN_WITHDRAWAL","EXCHANGE_ACCEPT","EXCHANGE_WITHDRAWAL","RETURN_COMPLETE","RETURN_REJECT","RETURN_TRANSFORM","RETURN_PENDING","DELIVERY_FEE_PAYMENT"]}},"description":"Claim Processing Request DTO"},"ClaimGoodsRequest":{"required":["claimLgrpCd","claimMgrpCd","claimQty","exchangeGoodsNo","exchangeItmNm","exchangeItmNo"],"type":"object","properties":{"ordSeq":{"type":"integer","description":"Order Sequence No.","format":"int32"},"ordProcSeq":{"type":"integer","description":"Order Processing Sequence No.","format":"int32"},"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","description":"Claim Quantity","format":"int32"},"claimLgrpCd":{"type":"string","description":"OM047(Claim Major Category Code)\n 10: Simple Change of Mind\n , 20: Defective Product\n , 30: Delivery Complaint\n , 40: Product Information Error\n , 50: Re-payment Order\n","enum":["SIMPLE_CHANGE","GOODS_BAD","DELIVERY_CLAIM","GOODS_INFOMATION_ERROR","REPAYMENT_ORDER"]},"claimMgrpCd":{"type":"string","description":"OM006(Claim Sub-Category Code)\n 100: Delivery Delayed\n , 101: Product Out of Stock\n , 102: Option/Size Change/Cancellation\n , 103: More Expensive Than Elsewhere\n , 104: Coupon/Discount Benefit Change\n , 105: No Longer Wish to Purchase\n , 106: Gift Change/Cancellation\n , 107: Payment Method Change (Purchase Gift Applied/Card Change, etc.)\n , 108: Purchased Similar Product\n , 109: Insufficient Product Information\n , 110: Seller Cancellation (Seller)\n , 111: Discretionary Cancellation (Agent)\n , 112: Automatic Cancellation (Insufficient Payment)\n , 113: Automatic Cancellation (Out-of-Stock Cancellation)\n , 300: Size Too Large\n , 301: Size Too Small\n , 302: Simple Change of Mind - Color Change\n , 303: Stained\n , 304: Damaged (Seam Tear, etc.)\n , 305: Missing Components (Necklace, Belt, etc.)\n , 306: Defective Contents (Cosmetics, etc.)\n , 307: Wrong Product Delivered\n , 308: Other\n , 200: Ordered Different Product\n , 201: Size Too Large\n , 203: Size Too Small\n , 204: Product Image Differs (Color, Design, Fit)\n , 205: No Longer Wish to Purchase\n , 206: No Color or Size Exchange Option Available\n , 207: Other\n , 208: Stained\n , 209: Damaged (Seam Tear, etc.)\n , 210: Missing Components (Necklace, Belt, etc.)\n , 211: Defective Contents (Cosmetics, etc.)\n , 212: Other\n , 213: Wrong Size Delivered\n , 214: Wrong Color Delivered\n , 215: Wrong Product Delivered\n , 216: Delivery Delayed\n , 217: Other\n , 218: Measured Size Error\n , 219: Material Error\n , 220: Color Error\n , 221: Differs From Product Description (Mislabeled)\n , 222: Other\n , 223: Return On Hold\n , 224: Return Not Possible\n","enum":["CLAIM_MGRP_CD_100","CLAIM_MGRP_CD_101","CLAIM_MGRP_CD_102","CLAIM_MGRP_CD_103","CLAIM_MGRP_CD_104","CLAIM_MGRP_CD_105","CLAIM_MGRP_CD_106","CLAIM_MGRP_CD_107","CLAIM_MGRP_CD_108","CLAIM_MGRP_CD_109","CLAIM_MGRP_CD_110","CLAIM_MGRP_CD_111","CLAIM_MGRP_CD_112","CLAIM_MGRP_CD_113","CLAIM_MGRP_CD_114","CLAIM_MGRP_CD_300","CLAIM_MGRP_CD_301","CLAIM_MGRP_CD_302","CLAIM_MGRP_CD_303","CLAIM_MGRP_CD_304","CLAIM_MGRP_CD_305","CLAIM_MGRP_CD_306","CLAIM_MGRP_CD_307","CLAIM_MGRP_CD_308","CLAIM_MGRP_CD_200","CLAIM_MGRP_CD_201","CLAIM_MGRP_CD_203","CLAIM_MGRP_CD_204","CLAIM_MGRP_CD_205","CLAIM_MGRP_CD_206","CLAIM_MGRP_CD_207","CLAIM_MGRP_CD_208","CLAIM_MGRP_CD_209","CLAIM_MGRP_CD_210","CLAIM_MGRP_CD_211","CLAIM_MGRP_CD_212","CLAIM_MGRP_CD_213","CLAIM_MGRP_CD_214","CLAIM_MGRP_CD_215","CLAIM_MGRP_CD_216","CLAIM_MGRP_CD_217","CLAIM_MGRP_CD_218","CLAIM_MGRP_CD_219","CLAIM_MGRP_CD_220","CLAIM_MGRP_CD_221","CLAIM_MGRP_CD_222","CLAIM_MGRP_CD_223","CLAIM_MGRP_CD_224"]},"claimCausEtcCont":{"type":"string","description":"Other Claim Reason Details"},"withdrawalDeliNo":{"type":"string","description":"Pickup Delivery No."},"shipmentDeliNo":{"type":"string","description":"Shipment Delivery No."},"prOrdDtlAtchFileInfoList":{"type":"array","description":"Attached Image List","items":{"$ref":"#/components/schemas/PrOrdDtlAtchFileInfo"}},"ordSeqAndOrdProcSeq":{"type":"string"}},"description":"Claim Requested Product Information DTO"},"PrOrdDtlAtchFileInfo":{"type":"object","properties":{"ordNo":{"type":"string","description":"Order No."},"ordSeq":{"type":"integer","description":"Order Sequence No.","format":"int32"},"ordProcSeq":{"type":"integer","description":"Order Processing Sequence No.","format":"int32"},"fileSeq":{"type":"string","description":"File Sequence No."},"filePathNm":{"type":"string","description":"File Path"},"fileNm":{"type":"string","description":"File Name"}},"description":"Order Detail Attachment File Info DTO"},"PaymentRequestPaymentInfo":{"type":"object","properties":{"siteNo":{"type":"string","description":"Site No."},"orderInfo":{"$ref":"#/components/schemas/PaymentOrderInfo"},"payInfoList":{"type":"array","description":"Order/Claim DTO Requesting Payment","items":{"$ref":"#/components/schemas/PaymentInfo"}}},"description":"Payment and Payment Cancellation DTO","nullable":true},"PaymentOrderInfo":{"type":"object","properties":{"ordNo":{"type":"string","description":"Order No."},"claimNo":{"type":"string","description":"Claim No."},"goodsNm":{"type":"string","description":"Product Name"},"ordManNm":{"type":"string","description":"Orderer Name"},"ordmnCellNo":{"type":"string","description":"Orderer's Mobile Phone Number"},"ordmnEmailAddr":{"type":"string","description":"Orderer Email Address"},"crcUnitCd":{"type":"string","description":"Currency Unit Code"},"ordMediaCd":{"type":"string","description":"Order Channel Code (OM007)"},"mbrNo":{"type":"string","description":"Member No."},"ordDtlGbCd":{"type":"string","description":"Order Detail Classification Code (OM003)"},"clientIp":{"type":"string","description":"Client IP"},"taxFreeAmt":{"type":"integer","description":"Tax-Exempt Amount","format":"int64"}},"description":"Order DTO Required for Payment"},"PaymentInfo":{"type":"object","properties":{"payNo":{"type":"string","description":"Payment Number"},"payWayCd":{"type":"string","description":"Payment Method Code (OM013)"},"payAmt":{"type":"integer","description":"Payment Amount","format":"int64"},"mersNo":{"type":"string","description":"Merchant Number"},"pgGbCd":{"type":"string","description":"PG Classification Code (OM030)"},"trdNo":{"type":"string","description":"Transaction No. (tid)"},"selectCardCd":{"type":"string","description":"Payment Request Card Company Code (OM057)"},"termlId":{"type":"string","description":"Terminal ID (mid)"},"billKey":{"type":"string","description":"Billing Key Value to Request Approval"},"authResultMap":{"type":"object","additionalProperties":{"type":"string","description":"Verification Result Information"},"description":"Verification Result Information"}},"description":"Payment DTO"},"ClaimCpnInfo":{"type":"object","properties":{"cpnNo":{"type":"string","description":"Coupon Issuance No."}},"description":"Claim Coupon Information DTO"},"ClaimDlvp":{"required":["dlvpNm","dtlAddr","rcvmnNm","zipAddr","zipNo"],"type":"object","properties":{"mbrOrdDlvpGb":{"type":"string","description":" ClaimDlvpGbCd (Claim Delivery Address Type)\n * 10 : Member Delivery Address\n * 20 : Order Delivery Address\n","enum":["MBR","ORD"]},"dlvpSeq":{"type":"string","description":"Delivery Address Sequence No."},"zipNoSeq":{"type":"integer","description":"Postal Code Sequence No.","format":"int64"},"dlvpNm":{"type":"string","description":"Delivery Address Name"},"rcvmnNm":{"type":"string","description":"Recipient Name"},"zipNo":{"type":"string","description":"Postal Code"},"zipAddr":{"type":"string","description":"Postal Address"},"dtlAddr":{"type":"string","description":"Detailed 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 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) 20: Please call before delivery, 30: Leave at the door if absent, 40: Leave with security desk if absent, 50: Please deliver quickly, 60: Please call my mobile if absent, 70: Enter manually"},"shopTrafMsg":{"type":"string","description":"Store Delivery Message"},"comnFrdrCogoMethodCd":{"type":"string","description":"Common Entrance Access Method Code (ME040) 10: Entrance access code, 20: Free access, 30: Other","default":"20"},"comnFrdrEtcMethod":{"type":"string","description":"Other Common Entrance Access Method"},"comnFrdrPwd":{"type":"string","description":"Common Entrance Password"}},"description":"Claim Delivery Information DTO"},"ClaimFinalAmtInfo":{"type":"object","properties":{"ordNo":{"type":"string","description":"Order No."},"totAplyAdtnAmt":{"type":"integer","description":"Total Delivery Fee Incurred Amount","format":"int64"},"totCnclAdtnAmt":{"type":"integer","description":"Total Cancelled Delivery Fee Amount","format":"int64"},"totFvrAdtnAmt":{"type":"integer","description":"Total Benefit Delivery Fee Amount","format":"int64"},"totOrdPrc":{"type":"integer","description":"Claim Product Amount","format":"int64"},"totDcAmt":{"type":"integer","description":"Claim Cancellation Discount Amount","format":"int64"},"expectedRefundAmt":{"type":"integer","description":"Expected Refund Amount","format":"int64"},"addtionPayAmt":{"type":"integer","description":"Additional Payment Amount","format":"int64"},"returnAcceptAmt":{"type":"integer","description":"Return Received Amount","format":"int64"},"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"}},"paymentOrderInfo":{"$ref":"#/components/schemas/PaymentOrderInfo"},"rfdInfoResponse":{"$ref":"#/components/schemas/RfdInfoResponse"}},"description":"Claim Final Payment/Refund Amount Information DTO"},"RefundAdditionAmtInfo":{"type":"object","properties":{"adtnOcurGbCd":{"type":"string","description":"OM017 (Additional Cost Occurrence Classification Code)\n 10: Occurred\n , 20: Cancelled\n","enum":["OCCURRNECE","CANCEL"]},"adtnOcurGbNm":{"type":"string","description":"Additional Cost Occurrence Type Name"},"type":{"type":"string","description":" ClaimAmountType (Claim Additional Cost Type)\n * 10 : Shipping Fee\n * 20 : Collection Shipping Fee\n * 30 : Exchange Shipping Fee\n * 40 : Product\n * 50 : Additional Shipping Fee\n * 60 : Free Gift\n","enum":["DELIVERY_FEE","RETURN_FEE","EXCHANGE_FEE","GOODS","EXTRA_FEE","GIFTS"]},"typeNm":{"type":"string","description":"Type Classification Name"},"goodsNoItmNo":{"type":"string","description":"Product No.+SKU No."},"goodsNm":{"type":"string","description":"Product Name"},"ordAmt":{"type":"integer","description":"Payment Amount","format":"int64"},"discountMethod":{"type":"string","description":"OM019 (Additional Cost Detail Type Code)\n 11: Product Discount Coupon\n , 12: Cart Coupon\n , 13: Stackable Discount Coupon\n , 14: Free Shipping Coupon\n , 15: Free Return Coupon\n , 20: Employee Discount\n , 21: Instant Product Discount\n , 51: Product Free Gift\n , 40: Promotion Accrual\n , 41: Basic Accrual\n , 42: Membership Tier Additional Accrual\n","enum":["GOODS_DISCOUNT","SHOPPING_BASKET","REDUNDANT_DISCOUNT","FREE_DELIVERY","FREE_RETURN","EXECUTIVES","GOODS_DIRECT","GOODS_GIFTS","MILEAGE","BASIC_ACCUMULATION","MBR_GRADE_ACCUMULATION"]},"discountMethodNm":{"type":"string","description":"Benefit Detail Information Name"},"cnclDcAmt":{"type":"integer","description":"Cancellation Benefit Amount","format":"int64"},"rtnDlvBenefitInfoList":{"type":"array","description":"Return Coupon Information List","items":{"$ref":"#/components/schemas/ClaimDlvBenefitInfo"}},"reCalAdtnOcurGbCdAdtnAmt":{"type":"integer","format":"int64"}},"description":"Additional Payment/Refund Information DTO"},"ClaimDlvBenefitInfo":{"type":"object","properties":{"promoNo":{"type":"string","description":"Coupon No."},"promoNm":{"type":"string","description":"Coupon Name"},"promoTypCd":{"type":"string","description":"Promotion Type Code (MK002)\n 11 : Product Discount Coupon\n , 12 : Cart Coupon\n , 13 : Stackable Discount Coupon\n , 14 : Free Shipping Coupon\n , 15 : Free Return Coupon\n , 20 : Employee Discount\n , 21 : Instant Product Discount\n , 40 : Product Mileage\n","enum":["11","12","13","14","15","20","21","40"]},"ourChrgRate":{"type":"integer","description":"Company Cost-Sharing Rate","format":"int32"},"entrChrgRate":{"type":"integer","description":"Vendor Cost-Sharing Rate","format":"int32"},"cpnIsuNo":{"type":"string","description":"Coupon Issuance No."},"aplyYn":{"type":"string","description":"Application Status","enum":["Y","N"]}},"description":"Return Coupon Information List"},"PaymentClaimResponse":{"type":"object","properties":{"payNo":{"type":"string","description":"Payment Number"},"mbrNo":{"type":"string","description":"Member No."},"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":"integer","description":"Payment Amount","format":"int64"},"taxFreeAmt":{"type":"integer","description":"Tax-Exempt Price","format":"int64"},"rfdPsbAmt":{"type":"integer","description":"Refundable Amount","format":"int64"},"rfdAmt":{"type":"integer","description":"Refund Amount","format":"int64"},"payFnshDtm":{"type":"string","description":"Payment Completion Date/Time","format":"date-time"},"trdNo":{"type":"string","description":"Transaction No. (tid)"},"trdDtm":{"type":"string","description":"Transaction Date/Time","format":"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","description":"Installment Months","format":"int32"},"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","description":"Approval Date/Time","format":"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","description":"Deposit Confirmation Date/Time","format":"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"},"vbankPaymentPending":{"type":"boolean"},"vbankDptCnfm":{"type":"boolean"}},"description":"Refundable Payment Method DTO"},"RfdInfoResponse":{"type":"object","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"}},"description":"Refund Account Information Retrieval Response"},"ClaimProcessResultResponse":{"type":"object","properties":{"ordNo":{"type":"string","description":"Order No."},"claimNo":{"type":"string","description":"Claim No."}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","description":"result time","format":"date-time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"type":"object","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"}},"description":"validation error list"}}}}
```