주문교환

교환 접수 철회(BO)

post

기능 설명

BO에서 교환접수대상을 철회처리합니다.

상세 설명

주문 번호(ordNo), 클레임업무유형(claimBusinessType), **시스템 유형(systemType)**은 필수로 있어야합니다.
다음의 조건을 모두 충족하는 대상에 대해 교환 철회 처리가 가능합니다.
- 주문내역구분(OM003) 값이 **교환(30)**인 경우
- 주문내역상태(OM005) 값이 결제대기(31) 이거나 교환접수(32) 이거나 **회수지시(34)**인 경우
기존 주문교환데이터를 업데이트하고 주문교환철회데이터를 생성 처리합니다.
교환 철회시 발생하는 결제 정보를 검증처리합니다.
재고 증감처리를 수행합니다.

특이 사항

**클레임업무유형(claimBusinessType)**이 **교환철회(31)**인 경우에만 교환접수철회가 진행됩니다.

수정번호

release_231009_01 : 주문혜택관계테이블 주문수량, 취소수량 컬럼 추가

Header parameters

AuthorizationanyOptional

Access Token

Body

클레임 처리 요청 DTO

systemTypestring · enumRequired

SYSTEM(시스템유형) * 10 : FO * 20 : BO

Example: 10Possible values:

claimBusinessTypestring · enumRequired

ClaimBusiness(클레임업무유형) * 11 : 주문취소 * 20 : 반품접수 * 21 : 반품취소 * 30 : 교환접수 * 31 : 교환취소 * 22 : 반품완료 * 23 : 반품불가 * 24 : 교환반품 * 25 : 반품보류

Example: 11Possible values:

ordMediaCdstring · enumRequired

주문매체 코드(OM007) 10 : 전화상담(CC) , 20 : PC , 30 : 모바일웹 , 40 : 안드로이드앱 , 50 : IOS앱 , 60 : 정기주문

Example: 20Possible values:

ordNostringRequired

주문번호

Example: 20230808O007404

mbrNostringOptional

회원번호

Example: 100001311

claimNostringRequired

클레임번호

Example: 20230808C010663

wthdFnshWaitProcCausstringRequired

회수완료 대기처리 사유

Example: 불량반품

occurPaymentbooleanOptional

existAddtionPayAmtbooleanOptional

claimBusinessstring · enumOptional

Example: 11Possible values:

Responses

200

성공

*/*

ordNostringOptional

주문번호

Example: 20230808O007404

claimNostringOptional

클레임번호

Example: 20230808C010663

900

업무처리 오류 내용

*/*

post/v1/claim/exchange/withdrawalExchange

POST /api/order/v1/claim/exchange/withdrawalExchange 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"
}

교환 접수 철회(FO)

post

기능 설명

FO에서 교환접수대상을 철회처리합니다.

상세 설명

주문 번호(ordNo), 클레임업무유형(claimBusinessType), **시스템 유형(systemType)**은 필수로 있어야합니다.
다음의 조건을 모두 충족하는 대상에 대해 교환 철회 처리가 가능합니다.
- 주문내역구분(OM003) 값이 **교환(30)**인 경우
- 주문내역상태(OM005) 값이 결제대기(31) 이거나 **교환접수(32)**인 경우
기존 주문교환데이터를 업데이트하고 주문교환철회데이터를 생성 처리합니다.
교환 철회시 발생하는 결제 정보를 검증처리합니다.
재고 증감처리를 수행합니다.

특이 사항

**클레임업무유형(claimBusinessType)**이 **교환철회(31)**인 경우에만 교환접수철회가 진행됩니다.

수정번호

release_231009_01 : 주문혜택관계테이블 주문수량, 취소수량 컬럼 추가

Header parameters

AuthorizationanyOptional

Access Token

Body

클레임 처리 요청 DTO

systemTypestring · enumRequired

SYSTEM(시스템유형) * 10 : FO * 20 : BO

Example: 10Possible values:

claimBusinessTypestring · enumRequired

Example: 11Possible values:

ordMediaCdstring · enumRequired

주문매체 코드(OM007) 10 : 전화상담(CC) , 20 : PC , 30 : 모바일웹 , 40 : 안드로이드앱 , 50 : IOS앱 , 60 : 정기주문

Example: 20Possible values:

ordNostringRequired

주문번호

Example: 20230808O007404

mbrNostringOptional

회원번호

Example: 100001311

claimNostringRequired

클레임번호

Example: 20230808C010663

wthdFnshWaitProcCausstringRequired

회수완료 대기처리 사유

Example: 불량반품

occurPaymentbooleanOptional

existAddtionPayAmtbooleanOptional

claimBusinessstring · enumOptional

Example: 11Possible values:

Responses

200

성공

*/*

ordNostringOptional

주문번호

Example: 20230808O007404

claimNostringOptional

클레임번호

Example: 20230808C010663

900

업무처리 오류 내용

*/*

post/v1/claim/exchange/withdrawalExchangeFO

POST /api/order/v1/claim/exchange/withdrawalExchangeFO 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"
}

교환 대상상품 옵션변경 가능여부 체크

post

기능 설명

BO에서 교환클레임옵션변경대상이 유효한지 체크합니다.

상세 설명

상품 번호(goodsNo), **단품번호(itmNo)**는 필수로 있어야합니다.
다음의 조건을 모두 체크합니다.
- 옵션변경대상의 **판매상태코드(PR005)**가 **판매중(10)**인지 체크합니다.
- 옵션변경대상의 **판매방식코드가(PR003)**가 **일반판매(10)**인지 체크합니다.
- 옵션변경대상이 기존대상과 동일한 가격인지 체크합니다.
- 옵션변경대상의 재고를 체크합니다.

Header parameters

AuthorizationanyOptional

Access Token

Bodyobject · ClaimGoodsItmInfoRequest[]

교환클레임 옵션변경대상 요청 DTO

goodsNostringRequired

상품번호

Default: 10001861Example: 10001861

itmNostringRequired

단품번호

Default: 001Example: 001

claimQtyinteger · int32Optional

클레임수량

Default: 1Example: 1

salePrcinteger · int64Optional

판매가

Example: 25000

Responses

200

성공

No content

900

업무처리 오류 내용

*/*

post/v1/claim/exchange/isExistsExchangeGoodsItm

POST /api/order/v1/claim/exchange/isExistsExchangeGoodsItm HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 67

[
  {
    "goodsNo": "10001861",
    "itmNo": "001",
    "claimQty": 1,
    "salePrc": 25000
  }
]

No content

Deprecated

반품/교환 철회대상 조회

post

기능 설명

BO에서 반품/교환 철회대상을 조회합니다.

상세 설명

주문 번호(ordNo), **시스템 유형(systemType)**은 필수로 있어야합니다.
다음의 조건을 모두 충족하는 대상에 대해 반품/교환 철회 처리가 가능합니다.
- 주문내역구분(OM003) 값이 반품(20) 이거나 **교환(30)**인 경우
- 주문내역상태(OM005) 값이 결제대기(31), 반품/교환접수(32), **회수지시(32)**인 경우
- 반품 가능여부(rtnPsbYn) 값이 Y 인 경우
- 일반 상품인 경우**(사은품 제외)**
- 철회 가능 수량이 1개 이상인 경우 ( 주문수량 – 취소수량 – 반품수량 > 0 )

수정번호

release_231204_01 : Deprecated 처리됨, 클레임 공통으로 이동(변경된 API 경로 : api/order/v1/claim/common/getReturnExchangeCancelTargetInfo)

Header parameters

AuthorizationanyOptional

Access Token

Body

클레임 가능 대상 조회 요청 DTO

ordNostringRequired

주문번호

Example: 20230808O007404

claimBusinessTypestring · enumOptional

Example: 11Possible values:

orgClmNostringOptional

원클레임 번호

Example: 20230808C010663

systemTypestring · enumRequired

SYSTEM(시스템유형) * 10 : FO * 20 : BO

Default: 20Example: 10Possible values:

dlvpSeqstringOptional

배송지순번

Example: 1

systemCdNmAndButtonCodestringOptional

claimBusinessstring · enumOptional

Example: 11Possible values:

systemstring · enumOptional

SYSTEM(시스템유형) * 10 : FO * 20 : BO

Example: 10Possible values:

Responses

200

성공

*/*

클레임 처리대상 응답 DTO

ordNostringOptional

주문번호

Example: 20231231O000001

mbrNostringOptional

회원번호

Example: 100001311

mbrGradeCdstring · enumOptional

회원등급코드(ME008) 10 : GREEN , 20 : FAMILY , 30 : GOLD , 40 : VIP , 50 : VVIP

Example: 10Possible values:

ordGbCdstring · enumOptional

OM002(주문 구분 코드) 10: 일반주문 , 20: 선물하기 , 30: e-쿠폰 , 40: 제휴

Example: 10Possible values:

mbrMgrCdstring · enumOptional

ME002(회원관리코드) 10: UNION_MEMBER(통합회원) ,20: GENERAL_MEMBER(일반회원) ,30: SOCIAL_MEMBER(소셜회원) ,99: NO_MEMBER(비회원)

Example: 10Possible values:

ordManNmstringOptional

주문자명

Example: 홍길동

ordManEmailAddrstringOptional

주문자이메일주소

Example: test@plateer.com

ordManCellSctNostringOptional

주문자휴대폰구분번호

Example: 010

ordManCellTxnoNostringOptional

주문자휴대폰국번번호

Example: 1234

ordManCellEndNostringOptional

주문자휴대폰끝번호

Example: 5678

ordMediaCdstring · enumOptional

주문매체 코드(OM007) 10 : 전화상담(CC) , 20 : PC , 30 : 모바일웹 , 40 : 안드로이드앱 , 50 : IOS앱 , 60 : 정기주문

Example: 20Possible values:

ordAccpDtmstring · date-timeOptional

주문접수일자

sctnCnclPsbYnstring · enumOptional

부분취소가능여부

Example: NPossible values:

allNonReturnablebooleanOptional

vbankPaymentPendingbooleanOptional

allEcouponbooleanOptional

900

업무처리 오류 내용

*/*

post/v1/claim/exchange/getReturnExchangeCancelTargetInfo

POST /api/order/v1/claim/exchange/getReturnExchangeCancelTargetInfo 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"
}

{
  "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
}

교환 대상 조회(BO)

post

기능 설명

BO에서 주문교환대상을 조회합니다.

상세 설명

주문 번호(ordNo), 클레임업무유형(claimBusinessType), **시스템 유형(systemType)**은 필수로 있어야합니다.
다음의 조건을 모두 충족하는 대상에 대해 교환 접수 처리가 가능합니다.
- 주문내역구분(OM003) 값이 주문일반(10) 이거나 **교환(30)**인 경우
- 주문내역상태(OM005) 값이 출고완료(26) 이거나 **배송완료(27)**인 경우
- 반품 가능여부(rtnPsbYn) 값이 Y 인 경우
- 일반 상품인 경우**(사은품 제외)**
- 교환 가능 수량이 1개 이상인 경우 ( 주문수량 – 취소수량 – 반품수량 > 0 )

특이 사항

**클레임업무유형(claimBusinessType)**이 **교환(30)**인 경우에 교환대상을 가져옵니다.

수정 번호

release_231204_01 : Request DTO 배송지순번(dlvpSeq) 추가, 대상 조회시 배송지 순번 값이 있는경우 필터링 추가 실행
release v2.00_240409 : Response DTO 오타 수정 ( CaimTargetResponse -> ClaimTargetResponse )
Release v2.00_240729 : 회수여부(wthdYn), 회수불필요주문여부(isAllNonReturnable) 추가

Header parameters

AuthorizationanyOptional

Access Token

Body

클레임 가능 대상 조회 요청 DTO

ordNostringRequired

주문번호

Example: 20230808O007404

claimBusinessTypestring · enumOptional

Example: 11Possible values:

orgClmNostringOptional

원클레임 번호

Example: 20230808C010663

systemTypestring · enumRequired

SYSTEM(시스템유형) * 10 : FO * 20 : BO

Default: 20Example: 10Possible values:

dlvpSeqstringOptional

배송지순번

Example: 1

systemCdNmAndButtonCodestringOptional

claimBusinessstring · enumOptional

Example: 11Possible values:

systemstring · enumOptional

SYSTEM(시스템유형) * 10 : FO * 20 : BO

Example: 10Possible values:

Responses

200

성공

*/*

주문교환 가능대상 조회 응답 DTO

900

업무처리 오류 내용

*/*

post/v1/claim/exchange/getExchageTargetInfo

POST /api/order/v1/claim/exchange/getExchageTargetInfo 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
  },
  "codeMap": {
    "ANY_ADDITIONAL_PROPERTY": [
      {
        "cd": "302",
        "cdNm": "색상변경",
        "cdDesc": "[단순변심]",
        "sortSeq": "22",
        "ref1Val": "30",
        "ref2Val": "10",
        "ref3Val": "10",
        "ref4Val": "10",
        "ref5Val": "Y",
        "ref6Val": "null",
        "ref7Val": "null"
      }
    ]
  }
}

교환 대상 조회(FO)

post

기능 설명

FO에서 주문교환대상을 조회합니다.

상세 설명

주문 번호(ordNo), 클레임업무유형(claimBusinessType), **시스템 유형(systemType)**은 필수로 있어야합니다.
다음의 조건을 모두 충족하는 대상에 대해 교환 접수 처리가 가능합니다.
- 주문내역구분(OM003) 값이 주문일반(10) 이거나 **교환(30)**인 경우
- 주문내역상태(OM005) 값이 출고완료(26) 이거나 **배송완료(27)**인 경우
- 반품 가능여부(rtnPsbYn) 값이 Y 인 경우
- 일반 상품인 경우**(사은품 제외)**
- 교환 가능 수량이 1개 이상인 경우 ( 주문수량 – 취소수량 – 반품수량 > 0 )

특이 사항

**클레임업무유형(claimBusinessType)**이 **교환(30)**인 경우에 교환대상을 가져옵니다.

수정 번호

release_231204_01 : Request DTO 배송지순번(dlvpSeq) 추가, 대상 조회시 배송지 순번 값이 있는경우 필터링 추가 실행
release v2.00_240409 : Response DTO 오타 수정 ( CaimTargetResponse -> ClaimTargetResponse )
Release v2.00_240729 : 회수여부(wthdYn), 회수불필요주문여부(isAllNonReturnable) 추가

Header parameters

AuthorizationanyOptional

Access Token

Body

클레임 가능 대상 조회 요청 DTO

ordNostringRequired

주문번호

Example: 20230808O007404

claimBusinessTypestring · enumOptional

Example: 11Possible values:

orgClmNostringOptional

원클레임 번호

Example: 20230808C010663

systemTypestring · enumRequired

SYSTEM(시스템유형) * 10 : FO * 20 : BO

Default: 20Example: 10Possible values:

dlvpSeqstringOptional

배송지순번

Example: 1

systemCdNmAndButtonCodestringOptional

claimBusinessstring · enumOptional

Example: 11Possible values:

systemstring · enumOptional

SYSTEM(시스템유형) * 10 : FO * 20 : BO

Example: 10Possible values:

Responses

200

성공

*/*

주문교환 가능대상 조회 응답 DTO

900

업무처리 오류 내용

*/*

post/v1/claim/exchange/getExchageTargetInfoFO

POST /api/order/v1/claim/exchange/getExchageTargetInfoFO 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
  },
  "codeMap": {
    "ANY_ADDITIONAL_PROPERTY": [
      {
        "cd": "302",
        "cdNm": "색상변경",
        "cdDesc": "[단순변심]",
        "sortSeq": "22",
        "ref1Val": "30",
        "ref2Val": "10",
        "ref3Val": "10",
        "ref4Val": "10",
        "ref5Val": "Y",
        "ref6Val": "null",
        "ref7Val": "null"
      }
    ]
  }
}

Deprecated

클레임 배송비 결제대기상태 대상 정보

post

기능 설명

FO에서 클레임 배송비 결제대기상태 대상 정보를 조회합니다.

상세 설명

주문 번호(ordNo), **클레임번호(claimNo)**는 필수로 있어야합니다.
대상 클레임의 추가배송비를 조회합니다.
대상 클레임의 상품목록을 조회합니다.
- 주문내역구분(OM003) 값이 반품(20) 이거나 **교환(30)**인 경우
- 주문내역상태(OM005) 값이 **결제대기(31)**인 경우
- 반품 가능여부(rtnPsbYn) 값이 Y 인 경우
- 대상 클레임 수량이 1개 이상인 경우 ( 주문수량 – 취소수량 – 반품수량 > 0 )

수정번호

release_231204_01 : Deprecated 처리됨, 클레임 공통으로 이동(변경된 API 경로 : api/order/v1/claim/common/getClaimPayWaitStateInfo)

Header parameters

AuthorizationanyOptional

Access Token

Body

클레임 상세 내역 조회 요청 DTO

ordNostringRequired

주문번호

Example: 20230808O007404

claimNostringRequired

클레임번호

Example: 20230801C008072

Responses

200

성공

*/*

클레임 배송비 결제대기상태 대상 응답 DTO

ordNostringOptional

주문번호

Example: 20230808O007404

ordAccpDtmstring · date-timeOptional

주문접수일자

deliAmtSuminteger · int64Optional

배송비합계

Example: 3000

totAplyAdtnAmtinteger · int64Optional

추가비용합계

Example: 3000

addtionPayAmtinteger · int64Optional

추가금액

Example: 3000

foSystemNmAndDeliveryButtonCodestringOptional

900

업무처리 오류 내용

*/*

post/v1/claim/exchange/getClaimPayWaitStateInfo

POST /api/order/v1/claim/exchange/getClaimPayWaitStateInfo HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 55

{
  "ordNo": "20230808O007404",
  "claimNo": "20230801C008072"
}

{
  "ordNo": "20230808O007404",
  "ordAccpDtm": "2026-01-01T00:00:00.000Z",
  "deliAmtSum": 3000,
  "totAplyAdtnAmt": 3000,
  "addtionPayAmt": 3000,
  "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
  },
  "opOrdAdtnCostList": [
    {
      "ordAdtnSn": "100001315",
      "ordNo": "20231231O000001",
      "claimNo": "20231231C000001",
      "deliNo": "100000001",
      "uprOrdAdtnSn": "100000842",
      "entrNo": "1000002",
      "adtnOcurGbCd": "10",
      "ordCostGbCd": "10",
      "stdAdtnAmt": 100000,
      "aplyAdtnAmt": 0,
      "cnclAdtnAmt": 0,
      "fvrAdtnAmt": 0,
      "deliPolcNo": "10000431",
      "dlexTypCd": "30",
      "dlexCnclCausCd": "10",
      "dlexAmt": 3000,
      "adtnBassNo": "C1001182",
      "adtnDtlBassNo": "105962",
      "fvrPolcTypCd": "00",
      "fvrPolcAplyVal": 0,
      "fvrMinBuyAmt": 0,
      "fvrMaxDcAmt": 0,
      "entrChrgRate": 0,
      "entrChrgAmt": 0,
      "ourChrgRate": 100,
      "ourChrgAmt": 0,
      "promoNm": "무료배송쿠폰"
    }
  ],
  "payWayInfoMap": [
    {
      "payWayCd": "11",
      "useYn": "Y",
      "langCd": "ko",
      "cdNm": "text",
      "cdDesc": "text",
      "pgGbCd": "text",
      "memberSubPaymethodAmount": 1,
      "cardCompanyList": [
        {
          "cd": "302",
          "cdNm": "색상변경",
          "cdDesc": "[단순변심]",
          "sortSeq": "22",
          "ref1Val": "30",
          "ref2Val": "10",
          "ref3Val": "10",
          "ref4Val": "10",
          "ref5Val": "Y",
          "ref6Val": "null",
          "ref7Val": "null"
        }
      ],
      "mainPaymethod": true
    }
  ],
  "foSystemNmAndDeliveryButtonCode": "text"
}

교환접수(BO)

post

기능 설명

BO에서 교환대상을 접수처리합니다.

상세 설명

주문 번호(ordNo), 클레임업무유형(claimBusinessType), **시스템 유형(systemType)**은 필수로 있어야합니다.
교환 접수 대상은 모두 같은 배송번호여야 접수 가능합니다.
교환 접수 대상에 사은품 여부 확인(사은품 포항 될 경우 부분클레임 불가능)
다음의 조건을 모두 충족하는 교환 대상에 대해 교환 처리가 가능합니다.
- 유효한 상품인지 체크합니다.
  - 교환받을 상품의 **판매상태코드(PR005)**가 **판매중(10)**인지 체크합니다.
  - 교환받을 상품의 **판매방식코드가(PR003)**가 **일반판매(10)**인지 체크합니다.
  - 교환받을 상품이 교환대상 상품과 동일한 가격인지 체크합니다.
  - 교환받을 상품의 재고를 체크합니다.
주문교환데이터를 생성하고 업데이트 처리합니다.
- **클레임 대분류 코드(claimLgrpCd)**가 **단순변심(10)**인 경우 배송비가 발생합니다.
  - **추가결제금액(배송비)**이 발생할 경우 주문내역상태(OM005) 값이 **교환접수(32)**가 아닌 **결제대기(31)**상태로 변경됩니다.
  - **결제대기(31)**일 경우에는 FO에서 배송비결제 화면을 통한 결제를 진행해야 **교환접수(32)**가 됩니다.
교환 접수시 발생하는 결제 정보를 검증처리합니다.
재고 증감처리를 수행합니다.
교환 접수 후 알림메시지 발송 처리합니다.

특이 사항

**클레임업무유형(claimBusinessType)**이 **교환(30)**인 경우에만 교환접수가 진행됩니다.

수정번호

release_231009_01 : 주문혜택관계테이블 주문수량, 취소수량 컬럼 추가
release v2.00_240409 : 교환 접수 이메일 템플릿 변경에 따른 세팅 정보 추가 및 변경
Release v2.00_240729 : 교환 접수 대상이 모두 '회수여부'가 'N'인 경우, 회수 배송비 부과 제외, 알림 템플릿 변경

Header parameters

AuthorizationanyOptional

Access Token

Body

클레임 처리 요청 DTO

systemTypestring · enumRequired

SYSTEM(시스템유형) * 10 : FO * 20 : BO

Example: 10Possible values:

claimBusinessTypestring · enumRequired

Example: 11Possible values:

ordMediaCdstring · enumRequired

주문매체 코드(OM007) 10 : 전화상담(CC) , 20 : PC , 30 : 모바일웹 , 40 : 안드로이드앱 , 50 : IOS앱 , 60 : 정기주문

Example: 20Possible values:

ordNostringRequired

주문번호

Example: 20230808O007404

mbrNostringOptional

회원번호

Example: 100001311

claimNostringRequired

클레임번호

Example: 20230808C010663

wthdFnshWaitProcCausstringRequired

회수완료 대기처리 사유

Example: 불량반품

occurPaymentbooleanOptional

existAddtionPayAmtbooleanOptional

claimBusinessstring · enumOptional

Example: 11Possible values:

Responses

200

성공

*/*

ordNostringOptional

주문번호

Example: 20230808O007404

claimNostringOptional

클레임번호

Example: 20230808C010663

900

업무처리 오류 내용

*/*

post/v1/claim/exchange/acceptExchange

POST /api/order/v1/claim/exchange/acceptExchange 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"
}

교환접수(FO)

post

기능 설명

FO에서 교환대상을 접수처리합니다.

상세 설명

주문 번호(ordNo), 클레임업무유형(claimBusinessType), **시스템 유형(systemType)**은 필수로 있어야합니다.
교환 접수 대상은 모두 같은 배송번호여야 접수 가능합니다.
교환 접수 대상에 사은품 여부 확인(사은품 포항 될 경우 부분클레임 불가능)
다음의 조건을 모두 충족하는 교환 대상에 대해 교환 처리가 가능합니다.
- 유효한 상품인지 체크합니다.
  - 교환받을 상품의 **판매상태코드(PR005)**가 **판매중(10)**인지 체크합니다.
  - 교환받을 상품의 **판매방식코드가(PR003)**가 **일반판매(10)**인지 체크합니다.
  - 교환받을 상품이 교환대상 상품과 동일한 가격인지 체크합니다.
  - 교환받을 상품의 재고를 체크합니다.
주문교환데이터를 생성하고 업데이트 처리합니다.
- **클레임 대분류 코드(claimLgrpCd)**가 **단순변심(10)**인 경우 배송비가 발생합니다.
교환 접수시 발생하는 결제 승인 정보를 저장합니다.
교환 접수시 발생하는 결제 정보를 검증처리합니다.
재고 증감처리를 수행합니다.
교환 접수 후 알림메시지 발송 처리합니다.

특이 사항

**클레임업무유형(claimBusinessType)**이 **교환(30)**인 경우에만 교환접수가 진행됩니다.

수정번호

release_231009_01 : 주문혜택관계테이블 주문수량, 취소수량 컬럼 추가
release v2.00_240409 : 교환 접수 이메일 템플릿 변경에 따른 세팅 정보 추가 및 변경
Release v2.00_240729 : 교환 접수 대상이 모두 '회수여부'가 'N'인 경우, 회수 배송비 부과 제외, 알림 템플릿 변경

Header parameters

AuthorizationanyOptional

Access Token

Body

클레임 처리 요청 DTO

systemTypestring · enumRequired

SYSTEM(시스템유형) * 10 : FO * 20 : BO

Example: 10Possible values:

claimBusinessTypestring · enumRequired

Example: 11Possible values:

ordMediaCdstring · enumRequired

주문매체 코드(OM007) 10 : 전화상담(CC) , 20 : PC , 30 : 모바일웹 , 40 : 안드로이드앱 , 50 : IOS앱 , 60 : 정기주문

Example: 20Possible values:

ordNostringRequired

주문번호

Example: 20230808O007404

mbrNostringOptional

회원번호

Example: 100001311

claimNostringRequired

클레임번호

Example: 20230808C010663

wthdFnshWaitProcCausstringRequired

회수완료 대기처리 사유

Example: 불량반품

occurPaymentbooleanOptional

existAddtionPayAmtbooleanOptional

claimBusinessstring · enumOptional

Example: 11Possible values:

Responses

200

성공

*/*

ordNostringOptional

주문번호

Example: 20230808O007404

claimNostringOptional

클레임번호

Example: 20230808C010663

900

업무처리 오류 내용

*/*

post/v1/claim/exchange/acceptExchangeFO

POST /api/order/v1/claim/exchange/acceptExchangeFO 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"
}

이전클레임공통

다음정기주문내역조회

마지막 업데이트 4개월 전