주문취소
기능설명
주문취소를 진행합니다.
상세설명
주문취소 처리 API 호출 시점의 주문 상태를 확인, 접수 가능 여부를 확인합니다.
주문취소 요청 데이터의 유효성 검증은 다음의 항목에 대해 진행합니다.
접수 상품 배송번호 일치 여부 체크(-> 클레임 불가)
접수 상품 사은품 유무 체크(-> 부분 수량 클레임 불가)
부분취소불가 결제수단 사용 여부 체크(-> 부분 클레임 불가)
추가결제금액이 여부 체크(-> BO에서 클레임 불가)
주문 취소 데이터 생성 및 업데이트합니다.
주문 취소 시 발생하는 환불/결제 금액에 대해 검증을 수행합니다.
복원 쿠폰이 있을 경우 쿠폰 복원이 일어납니다.
주문 취소 상품에 대한 재고 복원이 일어납니다.
환불/결제 처리됩니다.
주문 취소 고객에게 알림을 발송합니다.(이메일/알림톡/알림함)
Header parameters
AuthorizationanyOptional
Access Token
Bodyobject · ClaimRequest[]
클레임 처리 요청 DTO
systemTypestring · enumRequiredExample:
SYSTEM(시스템유형) * 10 : FO * 20 : BO
10Possible values: claimBusinessTypestring · enumRequiredExample:
ClaimBusiness(클레임업무유형) * 11 : 주문취소 * 20 : 반품접수 * 21 : 반품취소 * 30 : 교환접수 * 31 : 교환취소 * 22 : 반품완료 * 23 : 반품불가 * 24 : 교환반품 * 25 : 반품보류
11Possible values: ordMediaCdstring · enumRequiredExample:
주문매체 코드(OM007) 10 : 전화상담(CC) , 20 : PC , 30 : 모바일웹 , 40 : 안드로이드앱 , 50 : IOS앱 , 60 : 정기주문
20Possible values: ordNostringRequiredExample:
주문번호
20230808O007404mbrNostringOptionalExample:
회원번호
100001311claimNostringRequiredExample:
클레임번호
20230808C010663wthdFnshWaitProcCausstringRequiredExample:
회수완료 대기처리 사유
불량반품occurPaymentbooleanOptional
existAddtionPayAmtbooleanOptional
claimBusinessstring · enumOptionalExample:
ClaimBusiness(클레임업무유형) * 11 : 주문취소 * 20 : 반품접수 * 21 : 반품취소 * 30 : 교환접수 * 31 : 교환취소 * 22 : 반품완료 * 23 : 반품불가 * 24 : 교환반품 * 25 : 반품보류
11Possible values: Responses
200
성공
No content
900
업무처리 오류 내용
*/*
post/v1/claim/orderCancel/giftOrderCancelBatch
POST /api/order/v1/claim/orderCancel/giftOrderCancelBatch HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 5012
[
{
"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": "01012345678",
"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": "05836",
"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": "05836",
"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": "01012345678",
"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
기능설명
입금기한 초과한 가상계좌 주문을 자동 취소 처리합니다.
상세설명
입금기한 초과 가상계좌 주문에 대해 배치로 취소 처리를 진행합니다.
주문취소 처리 API 호출 시점의 주문 상태를 확인, 접수 가능 여부를 확인합니다.
주문취소 요청 데이터의 유효성 검증은 다음의 항목에 대해 진행합니다.
접수 상품 사은품 유무 체크(-> 부분 수량 클레임 불가)
부분취소불가 결제수단 사용 여부 체크(-> 부분 클레임 불가)
주문 취소 데이터 생성 및 업데이트합니다.
주문 취소 시 발생하는 환불/결제 금액에 대해 검증을 수행합니다.
복원 쿠폰이 있을 경우 쿠폰 복원이 일어납니다.
주문 취소 상품에 대한 재고 복원이 일어납니다.
환불/결제 처리됩니다.
주문 취소 고객에게 알림을 발송합니다.(이메일/알림톡/알림함)
Header parameters
AuthorizationanyOptional
Access Token
Bodyobject · ClaimRequest[]
클레임 처리 요청 DTO
systemTypestring · enumRequiredExample:
SYSTEM(시스템유형) * 10 : FO * 20 : BO
10Possible values: claimBusinessTypestring · enumRequiredExample:
ClaimBusiness(클레임업무유형) * 11 : 주문취소 * 20 : 반품접수 * 21 : 반품취소 * 30 : 교환접수 * 31 : 교환취소 * 22 : 반품완료 * 23 : 반품불가 * 24 : 교환반품 * 25 : 반품보류
11Possible values: ordMediaCdstring · enumRequiredExample:
주문매체 코드(OM007) 10 : 전화상담(CC) , 20 : PC , 30 : 모바일웹 , 40 : 안드로이드앱 , 50 : IOS앱 , 60 : 정기주문
20Possible values: ordNostringRequiredExample:
주문번호
20230808O007404mbrNostringOptionalExample:
회원번호
100001311claimNostringRequiredExample:
클레임번호
20230808C010663wthdFnshWaitProcCausstringRequiredExample:
회수완료 대기처리 사유
불량반품occurPaymentbooleanOptional
existAddtionPayAmtbooleanOptional
claimBusinessstring · enumOptionalExample:
ClaimBusiness(클레임업무유형) * 11 : 주문취소 * 20 : 반품접수 * 21 : 반품취소 * 30 : 교환접수 * 31 : 교환취소 * 22 : 반품완료 * 23 : 반품불가 * 24 : 교환반품 * 25 : 반품보류
11Possible values: Responses
200
성공
No content
900
업무처리 오류 내용
*/*
post/v1/claim/orderCancel/dptExpiredCancelBatch
POST /api/order/v1/claim/orderCancel/dptExpiredCancelBatch HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 5012
[
{
"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": "01012345678",
"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": "05836",
"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": "05836",
"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": "01012345678",
"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
기능설명
주문취소를 진행합니다.
상세설명
주문취소 처리 API 호출 시점의 주문 상태를 확인, 접수 가능 여부를 확인합니다.
주문취소 요청 데이터의 유효성 검증은 다음의 항목에 대해 진행합니다.
접수 상품 사은품 유무 체크(-> 부분 수량 클레임 불가)
부분취소불가 결제수단 사용 여부 체크(-> 부분 클레임 불가)
추가결제금액이 여부 체크(-> BO에서 클레임 불가)
주문 취소 데이터 생성 및 업데이트합니다.
주문 취소 시 발생하는 환불/결제 금액에 대해 검증을 수행합니다.
복원 쿠폰이 있을 경우 쿠폰 복원이 일어납니다.
주문 취소 상품에 대한 재고 복원이 일어납니다.
환불/결제 처리됩니다.
주문 취소 고객에게 알림을 발송합니다.(이메일/알림톡/알림함)
수정번호
release_231009_01 : 주문혜택관계테이블 주문수량, 취소수량 컬럼 추가
Release v2.00_240627: 접수 상품 배송번호 일치 여부 체크 로직 제거 ( 전체 취소 기능 추가)
Header parameters
AuthorizationanyOptional
Access Token
Body
클레임 처리 요청 DTO
systemTypestring · enumRequiredExample:
SYSTEM(시스템유형) * 10 : FO * 20 : BO
10Possible values: claimBusinessTypestring · enumRequiredExample:
ClaimBusiness(클레임업무유형) * 11 : 주문취소 * 20 : 반품접수 * 21 : 반품취소 * 30 : 교환접수 * 31 : 교환취소 * 22 : 반품완료 * 23 : 반품불가 * 24 : 교환반품 * 25 : 반품보류
11Possible values: ordMediaCdstring · enumRequiredExample:
주문매체 코드(OM007) 10 : 전화상담(CC) , 20 : PC , 30 : 모바일웹 , 40 : 안드로이드앱 , 50 : IOS앱 , 60 : 정기주문
20Possible values: ordNostringRequiredExample:
주문번호
20230808O007404mbrNostringOptionalExample:
회원번호
100001311claimNostringRequiredExample:
클레임번호
20230808C010663wthdFnshWaitProcCausstringRequiredExample:
회수완료 대기처리 사유
불량반품occurPaymentbooleanOptional
existAddtionPayAmtbooleanOptional
claimBusinessstring · enumOptionalExample:
ClaimBusiness(클레임업무유형) * 11 : 주문취소 * 20 : 반품접수 * 21 : 반품취소 * 30 : 교환접수 * 31 : 교환취소 * 22 : 반품완료 * 23 : 반품불가 * 24 : 교환반품 * 25 : 반품보류
11Possible values: Responses
200
성공
*/*
ordNostringOptionalExample:
주문번호
20230808O007404claimNostringOptionalExample:
클레임번호
20230808C010663900
업무처리 오류 내용
*/*
post/v1/claim/orderCancel/cancel
POST /api/order/v1/claim/orderCancel/cancel HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 5010
{
"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": "01012345678",
"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": "05836",
"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": "05836",
"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": "01012345678",
"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"
}기능설명
주문 내역과 취소 가능 상품 목록, 화면 처리 시 필요한 기타 정보를 조회합니다.
상세설명
**주문번호(ordNo), 클레임업무유형(claimBusinessType), 시스템유형(systemType)**은 필수 파라미터입니다.
다음의 조건을 모두 충족하는 대상에 대해 주문취소 처리가 가능합니다.
주문내역구분(OM003) 값이 **주문일반(10)**인 경우
주문내역상태(OM005) 값이 주문완료(12) 이거나 배송지시(21) 이거나 출고지시(22) 이거나 출고대기(23) 인 경우
일반상품인 경우(사은품 제외)
취소 가능 수량이 1개 이상인 경우( 주문수량 – 취소수량 – 반품수량 > 0 )
주문 취소 가능 여부가 'Y'인 경우
기타 정보에 포함된 사항은 아래와 같습니다.
주문취소 중분류 사유 List
귀책사유 코드를 Key로 하고 주문취소 중분류 사유를 Value로 하는 Map
수정번호
release_231204_01 : Request DTO 배송지순번(dlvpSeq) 추가, 대상 조회시 배송지 순번 값이 있는경우 필터링 추가 실행
Release v2.00_240729 : 주문 취소 가능 여부(ordCnclPsbYn)값이 "N"인 경우 대상 제외
Header parameters
AuthorizationanyOptional
Access Token
Body
클레임 가능 대상 조회 요청 DTO
ordNostringRequiredExample:
주문번호
20230808O007404claimBusinessTypestring · enumOptionalExample:
ClaimBusiness(클레임업무유형) * 11 : 주문취소 * 20 : 반품접수 * 21 : 반품취소 * 30 : 교환접수 * 31 : 교환취소 * 22 : 반품완료 * 23 : 반품불가 * 24 : 교환반품 * 25 : 반품보류
11Possible values: orgClmNostringOptionalExample:
원클레임 번호
20230808C010663systemTypestring · enumRequiredDefault:
SYSTEM(시스템유형) * 10 : FO * 20 : BO
20Example: 10Possible values: dlvpSeqstringOptionalExample:
배송지순번
1systemCdNmAndButtonCodestringOptional
claimBusinessstring · enumOptionalExample:
ClaimBusiness(클레임업무유형) * 11 : 주문취소 * 20 : 반품접수 * 21 : 반품취소 * 30 : 교환접수 * 31 : 교환취소 * 22 : 반품완료 * 23 : 반품불가 * 24 : 교환반품 * 25 : 반품보류
11Possible values: systemstring · enumOptionalExample:
SYSTEM(시스템유형) * 10 : FO * 20 : BO
10Possible values: Responses
200
성공
*/*
클레임 가능 대상 조회 응답 DTO
900
업무처리 오류 내용
*/*
post/v1/claim/orderCancel/cancelPopup
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": "05836",
"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": "05836",
"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"
}
}
}기능설명
주문 내역과 취소 가능 상품 목록, 화면 처리 시 필요한 기타 정보를 조회합니다.
상세설명
**주문번호(ordNo), 클레임업무유형(claimBusinessType), 시스템유형(systemType)**은 필수 파라미터입니다.
다음의 조건을 모두 충족하는 대상에 대해 주문취소 처리가 가능합니다.
주문내역구분(OM003) 값이 **주문일반(10)**인 경우
주문내역상태(OM005) 값이 주문완료(12) 이거나 배송지시(21) 이거나 출고지시(22) 이거나 출고대기(23) 인 경우
일반상품인 경우(사은품 제외)
취소 가능 수량이 1개 이상인 경우( 주문수량 – 취소수량 – 반품수량 > 0 )
주문 취소 가능 여부가 'Y'인 경우
기타 정보에 포함된 사항은 아래와 같습니다.
주문취소 중분류 사유 List
귀책사유 코드를 Key로 하고 주문취소 중분류 사유를 Value로 하는 Map
수정번호
release_231204_01 : Request DTO 배송지순번(dlvpSeq) 추가, 대상 조회시 배송지 순번 값이 있는경우 필터링 추가 실행
Release v2.00_240729 : 주문 취소 가능 여부(ordCnclPsbYn)값이 "N"인 경우 대상 제외
Header parameters
AuthorizationanyOptional
Access Token
Body
클레임 가능 대상 조회 요청 DTO
ordNostringRequiredExample:
주문번호
20230808O007404claimBusinessTypestring · enumOptionalExample:
ClaimBusiness(클레임업무유형) * 11 : 주문취소 * 20 : 반품접수 * 21 : 반품취소 * 30 : 교환접수 * 31 : 교환취소 * 22 : 반품완료 * 23 : 반품불가 * 24 : 교환반품 * 25 : 반품보류
11Possible values: orgClmNostringOptionalExample:
원클레임 번호
20230808C010663systemTypestring · enumRequiredDefault:
SYSTEM(시스템유형) * 10 : FO * 20 : BO
20Example: 10Possible values: dlvpSeqstringOptionalExample:
배송지순번
1systemCdNmAndButtonCodestringOptional
claimBusinessstring · enumOptionalExample:
ClaimBusiness(클레임업무유형) * 11 : 주문취소 * 20 : 반품접수 * 21 : 반품취소 * 30 : 교환접수 * 31 : 교환취소 * 22 : 반품완료 * 23 : 반품불가 * 24 : 교환반품 * 25 : 반품보류
11Possible values: systemstring · enumOptionalExample:
SYSTEM(시스템유형) * 10 : FO * 20 : BO
10Possible values: Responses
200
성공
*/*
클레임 가능 대상 조회 응답 DTO
900
업무처리 오류 내용
*/*
post/v1/claim/orderCancel/cancelPopupFO
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": "05836",
"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": "05836",
"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"
}
}
}기능설명
주문취소를 진행합니다.
상세설명
주문취소 처리 API 호출 시점의 주문 상태를 확인, 접수 가능 여부를 확인합니다.
주문취소 요청 데이터의 유효성 검증은 다음의 항목에 대해 진행합니다.
접수 상품 사은품 유무 체크(-> 부분 수량 클레임 불가)
부분취소불가 결제수단 사용 여부 체크(-> 부분 클레임 불가)
주문 취소 데이터 생성 및 업데이트합니다.
주문 취소 시 발생하는 환불/결제 금액에 대해 검증을 수행합니다.
복원 쿠폰이 있을 경우 쿠폰 복원이 일어납니다.
주문 취소 상품에 대한 재고 복원이 일어납니다.
환불/결제 처리됩니다.
주문 취소 고객에게 알림을 발송합니다.(이메일/알림톡/알림함)
수정번호
release_231009_01 : 주문혜택관계테이블 주문수량, 취소수량 컬럼 추가
Release v2.00_240627: 접수 상품 배송번호 일치 여부 체크 로직 제거 ( 전체 취소 기능 추가)
Release v2.00_250714: 클레임 처리 시 환불 세금계산서 발행 추가
Release v2.00_250801 : 환경설정에 따른 증빙서류(세금계산서) 활성화 처리
Release v2.00_251020 : 이니시스 클레임 처리 시 현금영수증 취소 발행 추가
Header parameters
AuthorizationanyOptional
Access Token
Body
클레임 처리 요청 DTO
systemTypestring · enumRequiredExample:
SYSTEM(시스템유형) * 10 : FO * 20 : BO
10Possible values: claimBusinessTypestring · enumRequiredExample:
ClaimBusiness(클레임업무유형) * 11 : 주문취소 * 20 : 반품접수 * 21 : 반품취소 * 30 : 교환접수 * 31 : 교환취소 * 22 : 반품완료 * 23 : 반품불가 * 24 : 교환반품 * 25 : 반품보류
11Possible values: ordMediaCdstring · enumRequiredExample:
주문매체 코드(OM007) 10 : 전화상담(CC) , 20 : PC , 30 : 모바일웹 , 40 : 안드로이드앱 , 50 : IOS앱 , 60 : 정기주문
20Possible values: ordNostringRequiredExample:
주문번호
20230808O007404mbrNostringOptionalExample:
회원번호
100001311claimNostringRequiredExample:
클레임번호
20230808C010663wthdFnshWaitProcCausstringRequiredExample:
회수완료 대기처리 사유
불량반품occurPaymentbooleanOptional
existAddtionPayAmtbooleanOptional
claimBusinessstring · enumOptionalExample:
ClaimBusiness(클레임업무유형) * 11 : 주문취소 * 20 : 반품접수 * 21 : 반품취소 * 30 : 교환접수 * 31 : 교환취소 * 22 : 반품완료 * 23 : 반품불가 * 24 : 교환반품 * 25 : 반품보류
11Possible values: Responses
200
성공
*/*
ordNostringOptionalExample:
주문번호
20230808O007404claimNostringOptionalExample:
클레임번호
20230808C010663900
업무처리 오류 내용
*/*
post/v1/claim/orderCancel/cancelFO
POST /api/order/v1/claim/orderCancel/cancelFO HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 5010
{
"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": "01012345678",
"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": "05836",
"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": "05836",
"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": "01012345678",
"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"
}마지막 업데이트