Order Cancellation
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)
Access Token
Claim Processing Request DTO
SYSTEM (System Type) * 10 : FO * 20 : BO
10Possible values: ClaimBusiness (Claim Business Type) * 11 : Order Cancellation * 20 : Return Receipt * 21 : Return Cancellation * 30 : Exchange Receipt * 31 : Exchange Cancellation * 22 : Return Completed * 23 : Return Not Possible * 24 : Exchange Return * 25 : Return On Hold
11Possible values: Order Channel Code (OM007) 10 : Phone Consultation (CC) , 20 : PC , 30 : Mobile Web , 40 : Android App , 50 : iOS App , 60 : Subscription Order
20Possible values: Order No.
20230808O007404Member No.
100001311Claim No.
20230808C010663Pickup Completion Pending Reason
불량반품ClaimBusiness (Claim Business Type) * 11 : Order Cancellation * 20 : Return Receipt * 21 : Return Cancellation * 30 : Exchange Receipt * 31 : Exchange Cancellation * 22 : Return Completed * 23 : Return Not Possible * 24 : Exchange Return * 25 : Return On Hold
11Possible values: Success
No content
Business processing error details
POST /api/order/v1/claim/orderCancel/giftOrderCancelBatch HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 5000
[
{
"systemType": "10",
"claimBusinessType": "11",
"ordMediaCd": "20",
"ordNo": "20230808O007404",
"mbrNo": "100001311",
"claimNo": "20230808C010663",
"claimGoodsList": [
{
"ordSeq": 1,
"ordProcSeq": 1,
"goodsNo": "10002297",
"itmNo": "001",
"exchangeGoodsNo": "10002297",
"exchangeItmNo": "001",
"exchangeItmNm": "001",
"claimQty": 1,
"claimLgrpCd": "10",
"claimMgrpCd": "100",
"claimCausEtcCont": "배송이 늦어짐",
"withdrawalDeliNo": "100013106",
"shipmentDeliNo": "100013105",
"prOrdDtlAtchFileInfoList": [
{
"ordNo": "20230808O007404",
"ordSeq": 1,
"ordProcSeq": 1,
"fileSeq": "1",
"filePathNm": "files/order/2023/08/03/",
"fileNm": "d732ec3b-e044-43ca-8ecb-80051b2b36f8_10.png"
}
],
"ordSeqAndOrdProcSeq": "text"
}
],
"paymentRequest": {
"siteNo": "1",
"orderInfo": {
"ordNo": "20990101O000001",
"claimNo": "20990101C000001",
"goodsNm": "플래티어커피",
"ordManNm": "김플래티어",
"ordmnCellNo": 1012345678,
"ordmnEmailAddr": "kim@plateer.com",
"crcUnitCd": "KRW",
"ordMediaCd": "30",
"mbrNo": "100000001",
"ordDtlGbCd": "10",
"clientIp": "127.0.0.1",
"taxFreeAmt": 1
},
"payInfoList": [
{
"payNo": "1",
"payWayCd": "11",
"payAmt": 1000,
"mersNo": "1",
"pgGbCd": "10",
"trdNo": "INIMX_DBNKINIpayTest20990101090000685510",
"selectCardCd": "01",
"termlId": "INIBillTst",
"billKey": "text",
"authResultMap": "{P_STATUS:결과코드, P_RMESG1:결과메시지, P_TID:인증거래번호, P_AMT:거래금액, idc_name:IDC센터코드P_REQ_URL:승인요청 URL, P_NOTI:가맹점 임의 데이터}"
}
]
},
"claimCpnInfoList": [
{
"cpnNo": "104224"
}
],
"claimReturnDlvp": {
"mbrOrdDlvpGb": "10",
"dlvpSeq": "1",
"zipNoSeq": 1,
"dlvpNm": "집",
"rcvmnNm": "홍길동",
"zipNo": 5836,
"zipAddr": "서울 송파구 법원로9길 26",
"dtlAddr": "에이치비지니스파크 D동 6층",
"rcvmnEmailAddr": "x2bee@plateer.com",
"rcvmnCellSctNo": "010",
"rcvmnCellTxnoNo": "1234",
"rcvmnCellEndNo": "5678",
"rcvmnTelRgnNo": "02",
"rcvmnTelTxnoNo": "123",
"rcvmnTelEndNo": "4567",
"deliMsg": "부재 시 문 앞에 놓아주세요.",
"deliMsgCd": "30",
"shopTrafMsg": "문 앞에 놓아주세요.",
"comnFrdrCogoMethodCd": "20",
"comnFrdrEtcMethod": "자유 출입 가능",
"comnFrdrPwd": "1234"
},
"claimDlvp": {
"mbrOrdDlvpGb": "10",
"dlvpSeq": "1",
"zipNoSeq": 1,
"dlvpNm": "집",
"rcvmnNm": "홍길동",
"zipNo": 5836,
"zipAddr": "서울 송파구 법원로9길 26",
"dtlAddr": "에이치비지니스파크 D동 6층",
"rcvmnEmailAddr": "x2bee@plateer.com",
"rcvmnCellSctNo": "010",
"rcvmnCellTxnoNo": "1234",
"rcvmnCellEndNo": "5678",
"rcvmnTelRgnNo": "02",
"rcvmnTelTxnoNo": "123",
"rcvmnTelEndNo": "4567",
"deliMsg": "부재 시 문 앞에 놓아주세요.",
"deliMsgCd": "30",
"shopTrafMsg": "문 앞에 놓아주세요.",
"comnFrdrCogoMethodCd": "20",
"comnFrdrEtcMethod": "자유 출입 가능",
"comnFrdrPwd": "1234"
},
"claimFinalAmtInfo": {
"ordNo": "20230913O058186",
"totAplyAdtnAmt": 6000,
"totCnclAdtnAmt": 0,
"totFvrAdtnAmt": 0,
"totOrdPrc": 46000,
"totDcAmt": 2200,
"expectedRefundAmt": 37800,
"addtionPayAmt": 0,
"returnAcceptAmt": 37800,
"refundAdditionAmtInfoList": [
{
"adtnOcurGbCd": "10",
"adtnOcurGbNm": "발생",
"type": "10",
"typeNm": "회수배송비",
"goodsNoItmNo": "10002762001",
"goodsNm": "상품명",
"ordAmt": 6000,
"discountMethod": "11",
"discountMethodNm": "상품할인쿠폰",
"cnclDcAmt": 2000,
"rtnDlvBenefitInfoList": [
{
"promoNo": "C1003841",
"promoNm": "무료반품쿠폰",
"promoTypCd": "11",
"ourChrgRate": 100,
"entrChrgRate": 0,
"cpnIsuNo": "4364872",
"aplyYn": "Y"
}
],
"reCalAdtnOcurGbCdAdtnAmt": 1
}
],
"refundPaymentMethodList": [
{
"payNo": "2",
"mbrNo": "100000001",
"ordNo": "20990101O000001",
"claimNo": "20990101C000001",
"uprPayNo": "1",
"payGbCd": "10",
"payGbCdNm": "결제",
"payWayCd": "11",
"payWayCdNm": "신용카드",
"payStatCd": "12",
"payStatCdNm": "결제완료",
"payAmt": 10000,
"taxFreeAmt": 10000,
"rfdPsbAmt": 10000,
"rfdAmt": 1000,
"payFnshDtm": "2026-01-01T00:00:00.000Z",
"trdNo": "INIMX_CARDINIpayTest20990101090000685510",
"trdDtm": "2026-01-01T00:00:00.000Z",
"iscmCd": "202",
"iscmCdNm": "KB국민카드",
"payReqCardcoCd": "06",
"payReqCardcoCdNm": "국민카드",
"cardNo": "카드번호 암호화",
"cardNm": "국민카드",
"cardValiTerm": "text",
"nintDivYn": "N",
"divMonCnt": 0,
"cardPointUseYn": "N",
"mersNo": "1",
"acqrCd": "121",
"acqrCdNm": "국민카드",
"aprvNo": "12345678",
"aprvDtm": "2026-01-01T00:00:00.000Z",
"sctnCnclPsbYn": "Y",
"bankCd": "148",
"bankCdNm": "국민은행",
"actnNo": "계좌번호 암호화",
"dpmnNm": "김플래티어",
"dptFcstDt": "2099-01-01 09:00:00.000000",
"dptCnfmDtm": "2026-01-01T00:00:00.000Z",
"rfdBankCd": "148",
"rfdBankCdNm": "국민은행",
"rfdActnNo": "계좌번호 암호화",
"rfdActnDepositorNm": "홍길동",
"vbankPaymentPending": true,
"vbankDptCnfm": true
}
],
"paymentOrderInfo": {
"ordNo": "20990101O000001",
"claimNo": "20990101C000001",
"goodsNm": "플래티어커피",
"ordManNm": "김플래티어",
"ordmnCellNo": 1012345678,
"ordmnEmailAddr": "kim@plateer.com",
"crcUnitCd": "KRW",
"ordMediaCd": "30",
"mbrNo": "100000001",
"ordDtlGbCd": "10",
"clientIp": "127.0.0.1",
"taxFreeAmt": 1
},
"rfdInfoResponse": {
"rfdBankCd": "203",
"rfdBankNm": "KB국민은행",
"rfdActnNo": "33330********",
"rfdActnDepositorNm": "임성현",
"rfdActnCertiYn": "Y"
}
},
"wthdFnshWaitProcCaus": "불량반품",
"occurPayment": true,
"existAddtionPayAmt": true,
"claimBusiness": "11"
}
]No content
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)
Access Token
Claim Processing Request DTO
SYSTEM (System Type) * 10 : FO * 20 : BO
10Possible values: ClaimBusiness (Claim Business Type) * 11 : Order Cancellation * 20 : Return Receipt * 21 : Return Cancellation * 30 : Exchange Receipt * 31 : Exchange Cancellation * 22 : Return Completed * 23 : Return Not Possible * 24 : Exchange Return * 25 : Return On Hold
11Possible values: Order Channel Code (OM007) 10 : Phone Consultation (CC) , 20 : PC , 30 : Mobile Web , 40 : Android App , 50 : iOS App , 60 : Subscription Order
20Possible values: Order No.
20230808O007404Member No.
100001311Claim No.
20230808C010663Pickup Completion Pending Reason
불량반품ClaimBusiness (Claim Business Type) * 11 : Order Cancellation * 20 : Return Receipt * 21 : Return Cancellation * 30 : Exchange Receipt * 31 : Exchange Cancellation * 22 : Return Completed * 23 : Return Not Possible * 24 : Exchange Return * 25 : Return On Hold
11Possible values: Success
No content
Business processing error details
POST /api/order/v1/claim/orderCancel/dptExpiredCancelBatch HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 5000
[
{
"systemType": "10",
"claimBusinessType": "11",
"ordMediaCd": "20",
"ordNo": "20230808O007404",
"mbrNo": "100001311",
"claimNo": "20230808C010663",
"claimGoodsList": [
{
"ordSeq": 1,
"ordProcSeq": 1,
"goodsNo": "10002297",
"itmNo": "001",
"exchangeGoodsNo": "10002297",
"exchangeItmNo": "001",
"exchangeItmNm": "001",
"claimQty": 1,
"claimLgrpCd": "10",
"claimMgrpCd": "100",
"claimCausEtcCont": "배송이 늦어짐",
"withdrawalDeliNo": "100013106",
"shipmentDeliNo": "100013105",
"prOrdDtlAtchFileInfoList": [
{
"ordNo": "20230808O007404",
"ordSeq": 1,
"ordProcSeq": 1,
"fileSeq": "1",
"filePathNm": "files/order/2023/08/03/",
"fileNm": "d732ec3b-e044-43ca-8ecb-80051b2b36f8_10.png"
}
],
"ordSeqAndOrdProcSeq": "text"
}
],
"paymentRequest": {
"siteNo": "1",
"orderInfo": {
"ordNo": "20990101O000001",
"claimNo": "20990101C000001",
"goodsNm": "플래티어커피",
"ordManNm": "김플래티어",
"ordmnCellNo": 1012345678,
"ordmnEmailAddr": "kim@plateer.com",
"crcUnitCd": "KRW",
"ordMediaCd": "30",
"mbrNo": "100000001",
"ordDtlGbCd": "10",
"clientIp": "127.0.0.1",
"taxFreeAmt": 1
},
"payInfoList": [
{
"payNo": "1",
"payWayCd": "11",
"payAmt": 1000,
"mersNo": "1",
"pgGbCd": "10",
"trdNo": "INIMX_DBNKINIpayTest20990101090000685510",
"selectCardCd": "01",
"termlId": "INIBillTst",
"billKey": "text",
"authResultMap": "{P_STATUS:결과코드, P_RMESG1:결과메시지, P_TID:인증거래번호, P_AMT:거래금액, idc_name:IDC센터코드P_REQ_URL:승인요청 URL, P_NOTI:가맹점 임의 데이터}"
}
]
},
"claimCpnInfoList": [
{
"cpnNo": "104224"
}
],
"claimReturnDlvp": {
"mbrOrdDlvpGb": "10",
"dlvpSeq": "1",
"zipNoSeq": 1,
"dlvpNm": "집",
"rcvmnNm": "홍길동",
"zipNo": 5836,
"zipAddr": "서울 송파구 법원로9길 26",
"dtlAddr": "에이치비지니스파크 D동 6층",
"rcvmnEmailAddr": "x2bee@plateer.com",
"rcvmnCellSctNo": "010",
"rcvmnCellTxnoNo": "1234",
"rcvmnCellEndNo": "5678",
"rcvmnTelRgnNo": "02",
"rcvmnTelTxnoNo": "123",
"rcvmnTelEndNo": "4567",
"deliMsg": "부재 시 문 앞에 놓아주세요.",
"deliMsgCd": "30",
"shopTrafMsg": "문 앞에 놓아주세요.",
"comnFrdrCogoMethodCd": "20",
"comnFrdrEtcMethod": "자유 출입 가능",
"comnFrdrPwd": "1234"
},
"claimDlvp": {
"mbrOrdDlvpGb": "10",
"dlvpSeq": "1",
"zipNoSeq": 1,
"dlvpNm": "집",
"rcvmnNm": "홍길동",
"zipNo": 5836,
"zipAddr": "서울 송파구 법원로9길 26",
"dtlAddr": "에이치비지니스파크 D동 6층",
"rcvmnEmailAddr": "x2bee@plateer.com",
"rcvmnCellSctNo": "010",
"rcvmnCellTxnoNo": "1234",
"rcvmnCellEndNo": "5678",
"rcvmnTelRgnNo": "02",
"rcvmnTelTxnoNo": "123",
"rcvmnTelEndNo": "4567",
"deliMsg": "부재 시 문 앞에 놓아주세요.",
"deliMsgCd": "30",
"shopTrafMsg": "문 앞에 놓아주세요.",
"comnFrdrCogoMethodCd": "20",
"comnFrdrEtcMethod": "자유 출입 가능",
"comnFrdrPwd": "1234"
},
"claimFinalAmtInfo": {
"ordNo": "20230913O058186",
"totAplyAdtnAmt": 6000,
"totCnclAdtnAmt": 0,
"totFvrAdtnAmt": 0,
"totOrdPrc": 46000,
"totDcAmt": 2200,
"expectedRefundAmt": 37800,
"addtionPayAmt": 0,
"returnAcceptAmt": 37800,
"refundAdditionAmtInfoList": [
{
"adtnOcurGbCd": "10",
"adtnOcurGbNm": "발생",
"type": "10",
"typeNm": "회수배송비",
"goodsNoItmNo": "10002762001",
"goodsNm": "상품명",
"ordAmt": 6000,
"discountMethod": "11",
"discountMethodNm": "상품할인쿠폰",
"cnclDcAmt": 2000,
"rtnDlvBenefitInfoList": [
{
"promoNo": "C1003841",
"promoNm": "무료반품쿠폰",
"promoTypCd": "11",
"ourChrgRate": 100,
"entrChrgRate": 0,
"cpnIsuNo": "4364872",
"aplyYn": "Y"
}
],
"reCalAdtnOcurGbCdAdtnAmt": 1
}
],
"refundPaymentMethodList": [
{
"payNo": "2",
"mbrNo": "100000001",
"ordNo": "20990101O000001",
"claimNo": "20990101C000001",
"uprPayNo": "1",
"payGbCd": "10",
"payGbCdNm": "결제",
"payWayCd": "11",
"payWayCdNm": "신용카드",
"payStatCd": "12",
"payStatCdNm": "결제완료",
"payAmt": 10000,
"taxFreeAmt": 10000,
"rfdPsbAmt": 10000,
"rfdAmt": 1000,
"payFnshDtm": "2026-01-01T00:00:00.000Z",
"trdNo": "INIMX_CARDINIpayTest20990101090000685510",
"trdDtm": "2026-01-01T00:00:00.000Z",
"iscmCd": "202",
"iscmCdNm": "KB국민카드",
"payReqCardcoCd": "06",
"payReqCardcoCdNm": "국민카드",
"cardNo": "카드번호 암호화",
"cardNm": "국민카드",
"cardValiTerm": "text",
"nintDivYn": "N",
"divMonCnt": 0,
"cardPointUseYn": "N",
"mersNo": "1",
"acqrCd": "121",
"acqrCdNm": "국민카드",
"aprvNo": "12345678",
"aprvDtm": "2026-01-01T00:00:00.000Z",
"sctnCnclPsbYn": "Y",
"bankCd": "148",
"bankCdNm": "국민은행",
"actnNo": "계좌번호 암호화",
"dpmnNm": "김플래티어",
"dptFcstDt": "2099-01-01 09:00:00.000000",
"dptCnfmDtm": "2026-01-01T00:00:00.000Z",
"rfdBankCd": "148",
"rfdBankCdNm": "국민은행",
"rfdActnNo": "계좌번호 암호화",
"rfdActnDepositorNm": "홍길동",
"vbankPaymentPending": true,
"vbankDptCnfm": true
}
],
"paymentOrderInfo": {
"ordNo": "20990101O000001",
"claimNo": "20990101C000001",
"goodsNm": "플래티어커피",
"ordManNm": "김플래티어",
"ordmnCellNo": 1012345678,
"ordmnEmailAddr": "kim@plateer.com",
"crcUnitCd": "KRW",
"ordMediaCd": "30",
"mbrNo": "100000001",
"ordDtlGbCd": "10",
"clientIp": "127.0.0.1",
"taxFreeAmt": 1
},
"rfdInfoResponse": {
"rfdBankCd": "203",
"rfdBankNm": "KB국민은행",
"rfdActnNo": "33330********",
"rfdActnDepositorNm": "임성현",
"rfdActnCertiYn": "Y"
}
},
"wthdFnshWaitProcCaus": "불량반품",
"occurPayment": true,
"existAddtionPayAmt": true,
"claimBusiness": "11"
}
]No content
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)
Access Token
Claim Processing Request DTO
SYSTEM (System Type) * 10 : FO * 20 : BO
10Possible values: ClaimBusiness (Claim Business Type) * 11 : Order Cancellation * 20 : Return Receipt * 21 : Return Cancellation * 30 : Exchange Receipt * 31 : Exchange Cancellation * 22 : Return Completed * 23 : Return Not Possible * 24 : Exchange Return * 25 : Return On Hold
11Possible values: Order Channel Code (OM007) 10 : Phone Consultation (CC) , 20 : PC , 30 : Mobile Web , 40 : Android App , 50 : iOS App , 60 : Subscription Order
20Possible values: Order No.
20230808O007404Member No.
100001311Claim No.
20230808C010663Pickup Completion Pending Reason
불량반품ClaimBusiness (Claim Business Type) * 11 : Order Cancellation * 20 : Return Receipt * 21 : Return Cancellation * 30 : Exchange Receipt * 31 : Exchange Cancellation * 22 : Return Completed * 23 : Return Not Possible * 24 : Exchange Return * 25 : Return On Hold
11Possible values: Success
Order No.
20230808O007404Claim No.
20230808C010663Business processing error details
POST /api/order/v1/claim/orderCancel/cancel HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 4998
{
"systemType": "10",
"claimBusinessType": "11",
"ordMediaCd": "20",
"ordNo": "20230808O007404",
"mbrNo": "100001311",
"claimNo": "20230808C010663",
"claimGoodsList": [
{
"ordSeq": 1,
"ordProcSeq": 1,
"goodsNo": "10002297",
"itmNo": "001",
"exchangeGoodsNo": "10002297",
"exchangeItmNo": "001",
"exchangeItmNm": "001",
"claimQty": 1,
"claimLgrpCd": "10",
"claimMgrpCd": "100",
"claimCausEtcCont": "배송이 늦어짐",
"withdrawalDeliNo": "100013106",
"shipmentDeliNo": "100013105",
"prOrdDtlAtchFileInfoList": [
{
"ordNo": "20230808O007404",
"ordSeq": 1,
"ordProcSeq": 1,
"fileSeq": "1",
"filePathNm": "files/order/2023/08/03/",
"fileNm": "d732ec3b-e044-43ca-8ecb-80051b2b36f8_10.png"
}
],
"ordSeqAndOrdProcSeq": "text"
}
],
"paymentRequest": {
"siteNo": "1",
"orderInfo": {
"ordNo": "20990101O000001",
"claimNo": "20990101C000001",
"goodsNm": "플래티어커피",
"ordManNm": "김플래티어",
"ordmnCellNo": 1012345678,
"ordmnEmailAddr": "kim@plateer.com",
"crcUnitCd": "KRW",
"ordMediaCd": "30",
"mbrNo": "100000001",
"ordDtlGbCd": "10",
"clientIp": "127.0.0.1",
"taxFreeAmt": 1
},
"payInfoList": [
{
"payNo": "1",
"payWayCd": "11",
"payAmt": 1000,
"mersNo": "1",
"pgGbCd": "10",
"trdNo": "INIMX_DBNKINIpayTest20990101090000685510",
"selectCardCd": "01",
"termlId": "INIBillTst",
"billKey": "text",
"authResultMap": "{P_STATUS:결과코드, P_RMESG1:결과메시지, P_TID:인증거래번호, P_AMT:거래금액, idc_name:IDC센터코드P_REQ_URL:승인요청 URL, P_NOTI:가맹점 임의 데이터}"
}
]
},
"claimCpnInfoList": [
{
"cpnNo": "104224"
}
],
"claimReturnDlvp": {
"mbrOrdDlvpGb": "10",
"dlvpSeq": "1",
"zipNoSeq": 1,
"dlvpNm": "집",
"rcvmnNm": "홍길동",
"zipNo": 5836,
"zipAddr": "서울 송파구 법원로9길 26",
"dtlAddr": "에이치비지니스파크 D동 6층",
"rcvmnEmailAddr": "x2bee@plateer.com",
"rcvmnCellSctNo": "010",
"rcvmnCellTxnoNo": "1234",
"rcvmnCellEndNo": "5678",
"rcvmnTelRgnNo": "02",
"rcvmnTelTxnoNo": "123",
"rcvmnTelEndNo": "4567",
"deliMsg": "부재 시 문 앞에 놓아주세요.",
"deliMsgCd": "30",
"shopTrafMsg": "문 앞에 놓아주세요.",
"comnFrdrCogoMethodCd": "20",
"comnFrdrEtcMethod": "자유 출입 가능",
"comnFrdrPwd": "1234"
},
"claimDlvp": {
"mbrOrdDlvpGb": "10",
"dlvpSeq": "1",
"zipNoSeq": 1,
"dlvpNm": "집",
"rcvmnNm": "홍길동",
"zipNo": 5836,
"zipAddr": "서울 송파구 법원로9길 26",
"dtlAddr": "에이치비지니스파크 D동 6층",
"rcvmnEmailAddr": "x2bee@plateer.com",
"rcvmnCellSctNo": "010",
"rcvmnCellTxnoNo": "1234",
"rcvmnCellEndNo": "5678",
"rcvmnTelRgnNo": "02",
"rcvmnTelTxnoNo": "123",
"rcvmnTelEndNo": "4567",
"deliMsg": "부재 시 문 앞에 놓아주세요.",
"deliMsgCd": "30",
"shopTrafMsg": "문 앞에 놓아주세요.",
"comnFrdrCogoMethodCd": "20",
"comnFrdrEtcMethod": "자유 출입 가능",
"comnFrdrPwd": "1234"
},
"claimFinalAmtInfo": {
"ordNo": "20230913O058186",
"totAplyAdtnAmt": 6000,
"totCnclAdtnAmt": 0,
"totFvrAdtnAmt": 0,
"totOrdPrc": 46000,
"totDcAmt": 2200,
"expectedRefundAmt": 37800,
"addtionPayAmt": 0,
"returnAcceptAmt": 37800,
"refundAdditionAmtInfoList": [
{
"adtnOcurGbCd": "10",
"adtnOcurGbNm": "발생",
"type": "10",
"typeNm": "회수배송비",
"goodsNoItmNo": "10002762001",
"goodsNm": "상품명",
"ordAmt": 6000,
"discountMethod": "11",
"discountMethodNm": "상품할인쿠폰",
"cnclDcAmt": 2000,
"rtnDlvBenefitInfoList": [
{
"promoNo": "C1003841",
"promoNm": "무료반품쿠폰",
"promoTypCd": "11",
"ourChrgRate": 100,
"entrChrgRate": 0,
"cpnIsuNo": "4364872",
"aplyYn": "Y"
}
],
"reCalAdtnOcurGbCdAdtnAmt": 1
}
],
"refundPaymentMethodList": [
{
"payNo": "2",
"mbrNo": "100000001",
"ordNo": "20990101O000001",
"claimNo": "20990101C000001",
"uprPayNo": "1",
"payGbCd": "10",
"payGbCdNm": "결제",
"payWayCd": "11",
"payWayCdNm": "신용카드",
"payStatCd": "12",
"payStatCdNm": "결제완료",
"payAmt": 10000,
"taxFreeAmt": 10000,
"rfdPsbAmt": 10000,
"rfdAmt": 1000,
"payFnshDtm": "2026-01-01T00:00:00.000Z",
"trdNo": "INIMX_CARDINIpayTest20990101090000685510",
"trdDtm": "2026-01-01T00:00:00.000Z",
"iscmCd": "202",
"iscmCdNm": "KB국민카드",
"payReqCardcoCd": "06",
"payReqCardcoCdNm": "국민카드",
"cardNo": "카드번호 암호화",
"cardNm": "국민카드",
"cardValiTerm": "text",
"nintDivYn": "N",
"divMonCnt": 0,
"cardPointUseYn": "N",
"mersNo": "1",
"acqrCd": "121",
"acqrCdNm": "국민카드",
"aprvNo": "12345678",
"aprvDtm": "2026-01-01T00:00:00.000Z",
"sctnCnclPsbYn": "Y",
"bankCd": "148",
"bankCdNm": "국민은행",
"actnNo": "계좌번호 암호화",
"dpmnNm": "김플래티어",
"dptFcstDt": "2099-01-01 09:00:00.000000",
"dptCnfmDtm": "2026-01-01T00:00:00.000Z",
"rfdBankCd": "148",
"rfdBankCdNm": "국민은행",
"rfdActnNo": "계좌번호 암호화",
"rfdActnDepositorNm": "홍길동",
"vbankPaymentPending": true,
"vbankDptCnfm": true
}
],
"paymentOrderInfo": {
"ordNo": "20990101O000001",
"claimNo": "20990101C000001",
"goodsNm": "플래티어커피",
"ordManNm": "김플래티어",
"ordmnCellNo": 1012345678,
"ordmnEmailAddr": "kim@plateer.com",
"crcUnitCd": "KRW",
"ordMediaCd": "30",
"mbrNo": "100000001",
"ordDtlGbCd": "10",
"clientIp": "127.0.0.1",
"taxFreeAmt": 1
},
"rfdInfoResponse": {
"rfdBankCd": "203",
"rfdBankNm": "KB국민은행",
"rfdActnNo": "33330********",
"rfdActnDepositorNm": "임성현",
"rfdActnCertiYn": "Y"
}
},
"wthdFnshWaitProcCaus": "불량반품",
"occurPayment": true,
"existAddtionPayAmt": true,
"claimBusiness": "11"
}{
"ordNo": "20230808O007404",
"claimNo": "20230808C010663"
}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"
Access Token
Claim Eligibility Search Request DTO
Order No.
20230808O007404ClaimBusiness (Claim Business Type) * 11 : Order Cancellation * 20 : Return Receipt * 21 : Return Cancellation * 30 : Exchange Receipt * 31 : Exchange Cancellation * 22 : Return Completed * 23 : Return Not Possible * 24 : Exchange Return * 25 : Return On Hold
11Possible values: Original Claim No.
20230808C010663SYSTEM (System Type) * 10 : FO * 20 : BO
20Example: 10Possible values: Delivery Address Sequence No.
1ClaimBusiness (Claim Business Type) * 11 : Order Cancellation * 20 : Return Receipt * 21 : Return Cancellation * 30 : Exchange Receipt * 31 : Exchange Cancellation * 22 : Return Completed * 23 : Return Not Possible * 24 : Exchange Return * 25 : Return On Hold
11Possible values: SYSTEM (System Type) * 10 : FO * 20 : BO
10Possible values: Success
Claim Eligibility Search Response DTO
Business processing error details
POST /api/order/v1/claim/orderCancel/cancelPopup HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 181
{
"ordNo": "20230808O007404",
"claimBusinessType": "11",
"orgClmNo": "20230808C010663",
"systemType": "10",
"dlvpSeq": "1",
"systemCdNmAndButtonCode": "text",
"claimBusiness": "11",
"system": "10"
}{
"claimTargetResponse": {
"ordNo": "20231231O000001",
"mbrNo": "100001311",
"mbrGradeCd": "10",
"ordGbCd": "10",
"mbrMgrCd": "10",
"ordManNm": "홍길동",
"ordManEmailAddr": "test@plateer.com",
"ordManCellSctNo": "010",
"ordManCellTxnoNo": "1234",
"ordManCellEndNo": "5678",
"ordMediaCd": "20",
"ordAccpDtm": "2026-01-01T00:00:00.000Z",
"sctnCnclPsbYn": "N",
"claimTargetGoodsResponseList": [
{
"goodsNo": "10002297",
"deliProcTypCd": "10",
"deliPolcNo": "10000151",
"deliNo": "100000021",
"entrNo": "1000002",
"ordQty": 1,
"salePrc": 30000,
"dcAmt": 3000,
"sysModDtm": "2026-01-01T00:00:00.000Z",
"ordNo": "20231231O000001",
"ordSeq": 1,
"ordProcSeq": 1,
"uprOrdProcSeq": 1,
"maxOrdProcSeq": 1,
"claimNo": "20231231C000001",
"itmNo": "001",
"ordDtlGbCd": "10",
"ordDtlGbCdNm": "주문일반",
"ordDtlStatCd": "10",
"ordDtlStatCdNm": "접수",
"deliGbCd": "10",
"ordAccpDtm": "2026-01-01T00:00:00.000Z",
"ordFnshDtm": "2026-01-01T00:00:00.000Z",
"cnclQty": 0,
"rtnQty": 0,
"claimQty": 0,
"claimPossibleQty": 5,
"deliIndiDtm": "2026-01-01T00:00:00.000Z",
"deliIndiRsvDtm": "2026-01-01T00:00:00.000Z",
"exchMidRtnYn": "N",
"rtnPsbYn": "N",
"exchPsbYn": "N",
"ordCnclPsbYn": "N",
"wthdYn": "Y",
"ecpnNo": "ORD0001",
"etcktNo": "ORD0001",
"claimLgrpCd": "10",
"claimLgrpCdNm": "단순변심",
"claimMgrpCd": "100",
"claimMgrpCdNm": "사이즈가 큼",
"claimCausEtcCont": "사이즈가 생각보다 큽니다.",
"ordSaleTypCd": "10",
"chlNo": "1000001",
"chlDtlNo": "1000001",
"stdCtgNo": "HT01020000",
"infDispCtgNoGbCd": "10",
"infDispCtgNo": "213",
"repDispCtgNo": "213",
"conrNo": "10050",
"brandNo": "100002",
"brandNm": "플래티어",
"goodsNm": "폴로티셔츠",
"goodsImg": "files/goods/2023/12/31/goodsImg.jpg",
"itmNm": "화이트>95",
"prestNm": "우산 증정",
"goodsCompCd": "10",
"goodsTypCd": "10",
"saleMethCd": "10",
"taxGbCd": "01",
"buyTypCd": "10",
"supPcost": 14400,
"norPrc": 25000,
"mrgnRate": 4,
"deliDday": 1,
"deliGoodsGbCd": "10",
"deliWayCd": "10",
"bpckPsbYn": "Y",
"hsCd": "0101",
"goodsRevWrtYn": "N",
"bnfAmt": 2000,
"ordPrc": 25000,
"aeGoodsYn": "N",
"withdrawalDeliNo": "100000001",
"shipmentDeliNo": "100000001",
"deliTypCd": "10",
"deliKindCd": "10",
"deliMethodCd": "10",
"deliProcTypCdNm": "업체배송",
"puTypCd": "20",
"wthdFnshGbCd": "10",
"dlvpNm": "자택",
"rcvmnNm": "홍길동",
"dlvpSeq": "1",
"maxDlvpSeq": "1",
"zipNo": 5836,
"zipAddr": "서울 송파구 법원로9길 26",
"dtlAddr": "에이치비지니스파크 D동 6층",
"rcvmnEmailAddr": "sample@plateer.com",
"rcvmnCellSctNo": "010",
"rcvmnCellTxnoNo": "1122",
"rcvmnCellEndNo": "3546",
"rcvmnTelRgnNo": "02",
"rcvmnTelTxnoNo": "112",
"rcvmnTelEndNo": "3546",
"deliMsg": "부재시 문앞에 두고 가주세요",
"deliMsgCd": "70",
"shopTrafMsg": "없음",
"comnFrdrCogoMethodCd": "10",
"comnFrdrEtcMethod": "없음",
"comnFrdrPwd": "1234",
"orgDlvpInfo": {
"mbrOrdDlvpGb": "10",
"dlvpSeq": "1",
"zipNoSeq": 1,
"dlvpNm": "집",
"rcvmnNm": "홍길동",
"zipNo": 5836,
"zipAddr": "서울 송파구 법원로9길 26",
"dtlAddr": "에이치비지니스파크 D동 6층",
"rcvmnEmailAddr": "x2bee@plateer.com",
"rcvmnCellSctNo": "010",
"rcvmnCellTxnoNo": "1234",
"rcvmnCellEndNo": "5678",
"rcvmnTelRgnNo": "02",
"rcvmnTelTxnoNo": "123",
"rcvmnTelEndNo": "4567",
"deliMsg": "부재 시 문 앞에 놓아주세요.",
"deliMsgCd": "30",
"shopTrafMsg": "문 앞에 놓아주세요.",
"comnFrdrCogoMethodCd": "20",
"comnFrdrEtcMethod": "자유 출입 가능",
"comnFrdrPwd": "1234"
},
"orgDeliNo": "100000021",
"lastDeliResponse": {
"ordNo": "text",
"deliNo": "text",
"ordSeq": "text",
"ordProcSeq": "text",
"shipIndiDtm": "2026-01-01T00:00:00.000Z",
"shipCfmDtm": "2026-01-01T00:00:00.000Z",
"shipFnshDtm": "2026-01-01T00:00:00.000Z",
"deliFnshDtm": "2026-01-01T00:00:00.000Z",
"hdcCd": "text",
"invNo": "text",
"deliDtlStatCd": "text"
},
"shippingDeliGbCd": true,
"opOrdDtlUpdateKey": {
"ordNo": "text",
"ordSeq": 1,
"ordProcSeq": 1,
"uprOrdProcSeq": 1,
"claimNo": "text",
"goodsNo": "text",
"itmNo": "text",
"ordDtlGbCd": "text",
"deliGbCd": "text",
"ordAccpDtm": "2026-01-01T00:00:00.000Z",
"ordFnshDtm": "2026-01-01T00:00:00.000Z",
"ordDtlStatCd": "text",
"ordQty": 1,
"cnclQty": 1,
"rtnQty": 1,
"deliIndiDtm": "2026-01-01T00:00:00.000Z",
"deliIndiRsvDtm": "2026-01-01T00:00:00.000Z",
"deliNo": "text",
"exchMidRtnYn": "text",
"claimLgrpCd": "text",
"claimMgrpCd": "text",
"claimCausEtcCont": "text",
"rtnPsbYn": "text",
"exchPsbYn": "text",
"ordCnclPsbYn": "text",
"wthdYn": "text",
"wthdFnshGbCd": "text",
"shipFnshFcstDtm": "2026-01-01T00:00:00.000Z",
"etcktNo": "text",
"ecpnNo": "text"
},
"generalSalesProduct": true,
"exchangeShipping": true,
"withdrawalDeliGbCd": true,
"withdrawShipping": true,
"ordSeqAndUprOrdProcSeq": "text",
"goodsNoAndItmNo": "text",
"ordSeqAndOrdProcSeq": "text"
}
],
"allNonReturnable": true,
"vbankPaymentPending": true,
"allEcoupon": true
},
"claimCausCdList": [
{
"cd": "302",
"cdNm": "색상변경",
"cdDesc": "[단순변심]",
"sortSeq": "22",
"ref1Val": "30",
"ref2Val": "10",
"ref3Val": "10",
"ref4Val": "10",
"ref5Val": "Y",
"ref6Val": "null",
"ref7Val": "null"
}
],
"claimMgrpRspnGbCdMap": {
"ANY_ADDITIONAL_PROPERTY": {
"cd": "302",
"cdNm": "색상변경",
"cdDesc": "[단순변심]",
"sortSeq": "22",
"ref1Val": "30",
"ref2Val": "10",
"ref3Val": "10",
"ref4Val": "10",
"ref5Val": "Y",
"ref6Val": "null",
"ref7Val": "null"
}
}
}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"
Access Token
Claim Eligibility Search Request DTO
Order No.
20230808O007404ClaimBusiness (Claim Business Type) * 11 : Order Cancellation * 20 : Return Receipt * 21 : Return Cancellation * 30 : Exchange Receipt * 31 : Exchange Cancellation * 22 : Return Completed * 23 : Return Not Possible * 24 : Exchange Return * 25 : Return On Hold
11Possible values: Original Claim No.
20230808C010663SYSTEM (System Type) * 10 : FO * 20 : BO
20Example: 10Possible values: Delivery Address Sequence No.
1ClaimBusiness (Claim Business Type) * 11 : Order Cancellation * 20 : Return Receipt * 21 : Return Cancellation * 30 : Exchange Receipt * 31 : Exchange Cancellation * 22 : Return Completed * 23 : Return Not Possible * 24 : Exchange Return * 25 : Return On Hold
11Possible values: SYSTEM (System Type) * 10 : FO * 20 : BO
10Possible values: Success
Claim Eligibility Search Response DTO
Business processing error details
POST /api/order/v1/claim/orderCancel/cancelPopupFO HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 181
{
"ordNo": "20230808O007404",
"claimBusinessType": "11",
"orgClmNo": "20230808C010663",
"systemType": "10",
"dlvpSeq": "1",
"systemCdNmAndButtonCode": "text",
"claimBusiness": "11",
"system": "10"
}{
"claimTargetResponse": {
"ordNo": "20231231O000001",
"mbrNo": "100001311",
"mbrGradeCd": "10",
"ordGbCd": "10",
"mbrMgrCd": "10",
"ordManNm": "홍길동",
"ordManEmailAddr": "test@plateer.com",
"ordManCellSctNo": "010",
"ordManCellTxnoNo": "1234",
"ordManCellEndNo": "5678",
"ordMediaCd": "20",
"ordAccpDtm": "2026-01-01T00:00:00.000Z",
"sctnCnclPsbYn": "N",
"claimTargetGoodsResponseList": [
{
"goodsNo": "10002297",
"deliProcTypCd": "10",
"deliPolcNo": "10000151",
"deliNo": "100000021",
"entrNo": "1000002",
"ordQty": 1,
"salePrc": 30000,
"dcAmt": 3000,
"sysModDtm": "2026-01-01T00:00:00.000Z",
"ordNo": "20231231O000001",
"ordSeq": 1,
"ordProcSeq": 1,
"uprOrdProcSeq": 1,
"maxOrdProcSeq": 1,
"claimNo": "20231231C000001",
"itmNo": "001",
"ordDtlGbCd": "10",
"ordDtlGbCdNm": "주문일반",
"ordDtlStatCd": "10",
"ordDtlStatCdNm": "접수",
"deliGbCd": "10",
"ordAccpDtm": "2026-01-01T00:00:00.000Z",
"ordFnshDtm": "2026-01-01T00:00:00.000Z",
"cnclQty": 0,
"rtnQty": 0,
"claimQty": 0,
"claimPossibleQty": 5,
"deliIndiDtm": "2026-01-01T00:00:00.000Z",
"deliIndiRsvDtm": "2026-01-01T00:00:00.000Z",
"exchMidRtnYn": "N",
"rtnPsbYn": "N",
"exchPsbYn": "N",
"ordCnclPsbYn": "N",
"wthdYn": "Y",
"ecpnNo": "ORD0001",
"etcktNo": "ORD0001",
"claimLgrpCd": "10",
"claimLgrpCdNm": "단순변심",
"claimMgrpCd": "100",
"claimMgrpCdNm": "사이즈가 큼",
"claimCausEtcCont": "사이즈가 생각보다 큽니다.",
"ordSaleTypCd": "10",
"chlNo": "1000001",
"chlDtlNo": "1000001",
"stdCtgNo": "HT01020000",
"infDispCtgNoGbCd": "10",
"infDispCtgNo": "213",
"repDispCtgNo": "213",
"conrNo": "10050",
"brandNo": "100002",
"brandNm": "플래티어",
"goodsNm": "폴로티셔츠",
"goodsImg": "files/goods/2023/12/31/goodsImg.jpg",
"itmNm": "화이트>95",
"prestNm": "우산 증정",
"goodsCompCd": "10",
"goodsTypCd": "10",
"saleMethCd": "10",
"taxGbCd": "01",
"buyTypCd": "10",
"supPcost": 14400,
"norPrc": 25000,
"mrgnRate": 4,
"deliDday": 1,
"deliGoodsGbCd": "10",
"deliWayCd": "10",
"bpckPsbYn": "Y",
"hsCd": "0101",
"goodsRevWrtYn": "N",
"bnfAmt": 2000,
"ordPrc": 25000,
"aeGoodsYn": "N",
"withdrawalDeliNo": "100000001",
"shipmentDeliNo": "100000001",
"deliTypCd": "10",
"deliKindCd": "10",
"deliMethodCd": "10",
"deliProcTypCdNm": "업체배송",
"puTypCd": "20",
"wthdFnshGbCd": "10",
"dlvpNm": "자택",
"rcvmnNm": "홍길동",
"dlvpSeq": "1",
"maxDlvpSeq": "1",
"zipNo": 5836,
"zipAddr": "서울 송파구 법원로9길 26",
"dtlAddr": "에이치비지니스파크 D동 6층",
"rcvmnEmailAddr": "sample@plateer.com",
"rcvmnCellSctNo": "010",
"rcvmnCellTxnoNo": "1122",
"rcvmnCellEndNo": "3546",
"rcvmnTelRgnNo": "02",
"rcvmnTelTxnoNo": "112",
"rcvmnTelEndNo": "3546",
"deliMsg": "부재시 문앞에 두고 가주세요",
"deliMsgCd": "70",
"shopTrafMsg": "없음",
"comnFrdrCogoMethodCd": "10",
"comnFrdrEtcMethod": "없음",
"comnFrdrPwd": "1234",
"orgDlvpInfo": {
"mbrOrdDlvpGb": "10",
"dlvpSeq": "1",
"zipNoSeq": 1,
"dlvpNm": "집",
"rcvmnNm": "홍길동",
"zipNo": 5836,
"zipAddr": "서울 송파구 법원로9길 26",
"dtlAddr": "에이치비지니스파크 D동 6층",
"rcvmnEmailAddr": "x2bee@plateer.com",
"rcvmnCellSctNo": "010",
"rcvmnCellTxnoNo": "1234",
"rcvmnCellEndNo": "5678",
"rcvmnTelRgnNo": "02",
"rcvmnTelTxnoNo": "123",
"rcvmnTelEndNo": "4567",
"deliMsg": "부재 시 문 앞에 놓아주세요.",
"deliMsgCd": "30",
"shopTrafMsg": "문 앞에 놓아주세요.",
"comnFrdrCogoMethodCd": "20",
"comnFrdrEtcMethod": "자유 출입 가능",
"comnFrdrPwd": "1234"
},
"orgDeliNo": "100000021",
"lastDeliResponse": {
"ordNo": "text",
"deliNo": "text",
"ordSeq": "text",
"ordProcSeq": "text",
"shipIndiDtm": "2026-01-01T00:00:00.000Z",
"shipCfmDtm": "2026-01-01T00:00:00.000Z",
"shipFnshDtm": "2026-01-01T00:00:00.000Z",
"deliFnshDtm": "2026-01-01T00:00:00.000Z",
"hdcCd": "text",
"invNo": "text",
"deliDtlStatCd": "text"
},
"shippingDeliGbCd": true,
"opOrdDtlUpdateKey": {
"ordNo": "text",
"ordSeq": 1,
"ordProcSeq": 1,
"uprOrdProcSeq": 1,
"claimNo": "text",
"goodsNo": "text",
"itmNo": "text",
"ordDtlGbCd": "text",
"deliGbCd": "text",
"ordAccpDtm": "2026-01-01T00:00:00.000Z",
"ordFnshDtm": "2026-01-01T00:00:00.000Z",
"ordDtlStatCd": "text",
"ordQty": 1,
"cnclQty": 1,
"rtnQty": 1,
"deliIndiDtm": "2026-01-01T00:00:00.000Z",
"deliIndiRsvDtm": "2026-01-01T00:00:00.000Z",
"deliNo": "text",
"exchMidRtnYn": "text",
"claimLgrpCd": "text",
"claimMgrpCd": "text",
"claimCausEtcCont": "text",
"rtnPsbYn": "text",
"exchPsbYn": "text",
"ordCnclPsbYn": "text",
"wthdYn": "text",
"wthdFnshGbCd": "text",
"shipFnshFcstDtm": "2026-01-01T00:00:00.000Z",
"etcktNo": "text",
"ecpnNo": "text"
},
"generalSalesProduct": true,
"exchangeShipping": true,
"withdrawalDeliGbCd": true,
"withdrawShipping": true,
"ordSeqAndUprOrdProcSeq": "text",
"goodsNoAndItmNo": "text",
"ordSeqAndOrdProcSeq": "text"
}
],
"allNonReturnable": true,
"vbankPaymentPending": true,
"allEcoupon": true
},
"claimCausCdList": [
{
"cd": "302",
"cdNm": "색상변경",
"cdDesc": "[단순변심]",
"sortSeq": "22",
"ref1Val": "30",
"ref2Val": "10",
"ref3Val": "10",
"ref4Val": "10",
"ref5Val": "Y",
"ref6Val": "null",
"ref7Val": "null"
}
],
"claimMgrpRspnGbCdMap": {
"ANY_ADDITIONAL_PROPERTY": {
"cd": "302",
"cdNm": "색상변경",
"cdDesc": "[단순변심]",
"sortSeq": "22",
"ref1Val": "30",
"ref2Val": "10",
"ref3Val": "10",
"ref4Val": "10",
"ref5Val": "Y",
"ref6Val": "null",
"ref7Val": "null"
}
}
}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
Access Token
Claim Processing Request DTO
SYSTEM (System Type) * 10 : FO * 20 : BO
10Possible values: ClaimBusiness (Claim Business Type) * 11 : Order Cancellation * 20 : Return Receipt * 21 : Return Cancellation * 30 : Exchange Receipt * 31 : Exchange Cancellation * 22 : Return Completed * 23 : Return Not Possible * 24 : Exchange Return * 25 : Return On Hold
11Possible values: Order Channel Code (OM007) 10 : Phone Consultation (CC) , 20 : PC , 30 : Mobile Web , 40 : Android App , 50 : iOS App , 60 : Subscription Order
20Possible values: Order No.
20230808O007404Member No.
100001311Claim No.
20230808C010663Pickup Completion Pending Reason
불량반품ClaimBusiness (Claim Business Type) * 11 : Order Cancellation * 20 : Return Receipt * 21 : Return Cancellation * 30 : Exchange Receipt * 31 : Exchange Cancellation * 22 : Return Completed * 23 : Return Not Possible * 24 : Exchange Return * 25 : Return On Hold
11Possible values: Success
Order No.
20230808O007404Claim No.
20230808C010663Business processing error details
POST /api/order/v1/claim/orderCancel/cancelFO HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 4998
{
"systemType": "10",
"claimBusinessType": "11",
"ordMediaCd": "20",
"ordNo": "20230808O007404",
"mbrNo": "100001311",
"claimNo": "20230808C010663",
"claimGoodsList": [
{
"ordSeq": 1,
"ordProcSeq": 1,
"goodsNo": "10002297",
"itmNo": "001",
"exchangeGoodsNo": "10002297",
"exchangeItmNo": "001",
"exchangeItmNm": "001",
"claimQty": 1,
"claimLgrpCd": "10",
"claimMgrpCd": "100",
"claimCausEtcCont": "배송이 늦어짐",
"withdrawalDeliNo": "100013106",
"shipmentDeliNo": "100013105",
"prOrdDtlAtchFileInfoList": [
{
"ordNo": "20230808O007404",
"ordSeq": 1,
"ordProcSeq": 1,
"fileSeq": "1",
"filePathNm": "files/order/2023/08/03/",
"fileNm": "d732ec3b-e044-43ca-8ecb-80051b2b36f8_10.png"
}
],
"ordSeqAndOrdProcSeq": "text"
}
],
"paymentRequest": {
"siteNo": "1",
"orderInfo": {
"ordNo": "20990101O000001",
"claimNo": "20990101C000001",
"goodsNm": "플래티어커피",
"ordManNm": "김플래티어",
"ordmnCellNo": 1012345678,
"ordmnEmailAddr": "kim@plateer.com",
"crcUnitCd": "KRW",
"ordMediaCd": "30",
"mbrNo": "100000001",
"ordDtlGbCd": "10",
"clientIp": "127.0.0.1",
"taxFreeAmt": 1
},
"payInfoList": [
{
"payNo": "1",
"payWayCd": "11",
"payAmt": 1000,
"mersNo": "1",
"pgGbCd": "10",
"trdNo": "INIMX_DBNKINIpayTest20990101090000685510",
"selectCardCd": "01",
"termlId": "INIBillTst",
"billKey": "text",
"authResultMap": "{P_STATUS:결과코드, P_RMESG1:결과메시지, P_TID:인증거래번호, P_AMT:거래금액, idc_name:IDC센터코드P_REQ_URL:승인요청 URL, P_NOTI:가맹점 임의 데이터}"
}
]
},
"claimCpnInfoList": [
{
"cpnNo": "104224"
}
],
"claimReturnDlvp": {
"mbrOrdDlvpGb": "10",
"dlvpSeq": "1",
"zipNoSeq": 1,
"dlvpNm": "집",
"rcvmnNm": "홍길동",
"zipNo": 5836,
"zipAddr": "서울 송파구 법원로9길 26",
"dtlAddr": "에이치비지니스파크 D동 6층",
"rcvmnEmailAddr": "x2bee@plateer.com",
"rcvmnCellSctNo": "010",
"rcvmnCellTxnoNo": "1234",
"rcvmnCellEndNo": "5678",
"rcvmnTelRgnNo": "02",
"rcvmnTelTxnoNo": "123",
"rcvmnTelEndNo": "4567",
"deliMsg": "부재 시 문 앞에 놓아주세요.",
"deliMsgCd": "30",
"shopTrafMsg": "문 앞에 놓아주세요.",
"comnFrdrCogoMethodCd": "20",
"comnFrdrEtcMethod": "자유 출입 가능",
"comnFrdrPwd": "1234"
},
"claimDlvp": {
"mbrOrdDlvpGb": "10",
"dlvpSeq": "1",
"zipNoSeq": 1,
"dlvpNm": "집",
"rcvmnNm": "홍길동",
"zipNo": 5836,
"zipAddr": "서울 송파구 법원로9길 26",
"dtlAddr": "에이치비지니스파크 D동 6층",
"rcvmnEmailAddr": "x2bee@plateer.com",
"rcvmnCellSctNo": "010",
"rcvmnCellTxnoNo": "1234",
"rcvmnCellEndNo": "5678",
"rcvmnTelRgnNo": "02",
"rcvmnTelTxnoNo": "123",
"rcvmnTelEndNo": "4567",
"deliMsg": "부재 시 문 앞에 놓아주세요.",
"deliMsgCd": "30",
"shopTrafMsg": "문 앞에 놓아주세요.",
"comnFrdrCogoMethodCd": "20",
"comnFrdrEtcMethod": "자유 출입 가능",
"comnFrdrPwd": "1234"
},
"claimFinalAmtInfo": {
"ordNo": "20230913O058186",
"totAplyAdtnAmt": 6000,
"totCnclAdtnAmt": 0,
"totFvrAdtnAmt": 0,
"totOrdPrc": 46000,
"totDcAmt": 2200,
"expectedRefundAmt": 37800,
"addtionPayAmt": 0,
"returnAcceptAmt": 37800,
"refundAdditionAmtInfoList": [
{
"adtnOcurGbCd": "10",
"adtnOcurGbNm": "발생",
"type": "10",
"typeNm": "회수배송비",
"goodsNoItmNo": "10002762001",
"goodsNm": "상품명",
"ordAmt": 6000,
"discountMethod": "11",
"discountMethodNm": "상품할인쿠폰",
"cnclDcAmt": 2000,
"rtnDlvBenefitInfoList": [
{
"promoNo": "C1003841",
"promoNm": "무료반품쿠폰",
"promoTypCd": "11",
"ourChrgRate": 100,
"entrChrgRate": 0,
"cpnIsuNo": "4364872",
"aplyYn": "Y"
}
],
"reCalAdtnOcurGbCdAdtnAmt": 1
}
],
"refundPaymentMethodList": [
{
"payNo": "2",
"mbrNo": "100000001",
"ordNo": "20990101O000001",
"claimNo": "20990101C000001",
"uprPayNo": "1",
"payGbCd": "10",
"payGbCdNm": "결제",
"payWayCd": "11",
"payWayCdNm": "신용카드",
"payStatCd": "12",
"payStatCdNm": "결제완료",
"payAmt": 10000,
"taxFreeAmt": 10000,
"rfdPsbAmt": 10000,
"rfdAmt": 1000,
"payFnshDtm": "2026-01-01T00:00:00.000Z",
"trdNo": "INIMX_CARDINIpayTest20990101090000685510",
"trdDtm": "2026-01-01T00:00:00.000Z",
"iscmCd": "202",
"iscmCdNm": "KB국민카드",
"payReqCardcoCd": "06",
"payReqCardcoCdNm": "국민카드",
"cardNo": "카드번호 암호화",
"cardNm": "국민카드",
"cardValiTerm": "text",
"nintDivYn": "N",
"divMonCnt": 0,
"cardPointUseYn": "N",
"mersNo": "1",
"acqrCd": "121",
"acqrCdNm": "국민카드",
"aprvNo": "12345678",
"aprvDtm": "2026-01-01T00:00:00.000Z",
"sctnCnclPsbYn": "Y",
"bankCd": "148",
"bankCdNm": "국민은행",
"actnNo": "계좌번호 암호화",
"dpmnNm": "김플래티어",
"dptFcstDt": "2099-01-01 09:00:00.000000",
"dptCnfmDtm": "2026-01-01T00:00:00.000Z",
"rfdBankCd": "148",
"rfdBankCdNm": "국민은행",
"rfdActnNo": "계좌번호 암호화",
"rfdActnDepositorNm": "홍길동",
"vbankPaymentPending": true,
"vbankDptCnfm": true
}
],
"paymentOrderInfo": {
"ordNo": "20990101O000001",
"claimNo": "20990101C000001",
"goodsNm": "플래티어커피",
"ordManNm": "김플래티어",
"ordmnCellNo": 1012345678,
"ordmnEmailAddr": "kim@plateer.com",
"crcUnitCd": "KRW",
"ordMediaCd": "30",
"mbrNo": "100000001",
"ordDtlGbCd": "10",
"clientIp": "127.0.0.1",
"taxFreeAmt": 1
},
"rfdInfoResponse": {
"rfdBankCd": "203",
"rfdBankNm": "KB국민은행",
"rfdActnNo": "33330********",
"rfdActnDepositorNm": "임성현",
"rfdActnCertiYn": "Y"
}
},
"wthdFnshWaitProcCaus": "불량반품",
"occurPayment": true,
"existAddtionPayAmt": true,
"claimBusiness": "11"
}{
"ordNo": "20230808O007404",
"claimNo": "20230808C010663"
}Last updated