주문반품

반품철회

post

기능 설명

반품접수건을 철회합니다.

상세 내용

• 주문 반품철회(BO) API를 호출합니다. API URL : /api/order/v1/claim/return/withdrawalReturn

---

수정번호

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

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

클레임 처리 요청 DTO

systemTypestring · enum · min: 1Required

시스템유형

Example: 10Possible values:

claimBusinessTypestring · enum · min: 1Required

클레임 업무 유형

Example: 20Possible values:

ordMediaCdstring · min: 1Required

주문매체코드(OM007)

Example: 20

ordNostringOptional

주문번호

Example: 20230808O007404

mbrNostringOptional

회원번호

Example: 100001311

claimNostringOptional

클레임번호

Example: 20230808C010663

wthdFnshWaitProcCausstringOptional

회수완료 대기처리 사유

Responses

200

OK

No content

post

/v2/claim/return/withdrawalReturn

HTTPcURLJavaScriptPython

POST /api/bo/v2/claim/return/withdrawalReturn HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 3470

{
  "systemType": 10,
  "claimBusinessType": 20,
  "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
    }
  ],
  "claimCpnInfoList": [
    {
      "cpnNo": 104224
    }
  ],
  "claimReturnDlvp": {
    "mbrOrdDlvpGb": 10,
    "dlvpSeq": 1,
    "zipNoSeq": 1,
    "dlvpNm": "집",
    "rcvmnNm": "홍길동",
    "zipNo": "05836",
    "zipAddr": "서울 송파구 법원로9길 26",
    "dtlAddr": "에이치비지니스파크 D동 6층",
    "rcvmnEmailAddr": "[e-mail]",
    "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": "[e-mail]",
    "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": 20,
        "typeNm": "회수배송비",
        "goodsNoItmNo": 10002762001,
        "goodsNm": "상품명",
        "ordAmt": 6000,
        "discountMethod": 11,
        "discountMethodNm": "상품할인쿠폰",
        "cnclDcAmt": 2000,
        "rtnDlvBenefitInfoList": [
          {
            "promoNo": "C1003841",
            "promoNm": "무료반품쿠폰",
            "promoTypCd": 15,
            "ourChrgRate": 100,
            "entrChrgRate": 0,
            "cpnIsuNo": 4364872,
            "aplyYn": "Y"
          }
        ]
      }
    ],
    "refundPaymentMethodList": [
      {
        "payNo": 2,
        "ordNo": "20990101O000001",
        "claimNo": "20990101C000001",
        "uprPayNo": 1,
        "payGbCd": 10,
        "payGbCdNm": "결제",
        "payWayCd": 11,
        "payWayCdNm": "신용카드",
        "payStatCd": 12,
        "payStatCdNm": "결제완료",
        "payAmt": 10000,
        "rfdPsbAmt": 10000,
        "rfdAmt": 1000,
        "payFnshDtm": "2099-01-01 09:00:00.000000",
        "trdNo": "INIMX_CARDINIpayTest20990101090000685510",
        "trdDtm": "2099-01-01 09:00:00.000000",
        "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": "2099-01-01 09:00:00.000000",
        "sctnCnclPsbYn": "Y",
        "bankCd": 148,
        "bankCdNm": "국민은행",
        "actnNo": "계좌번호 암호화",
        "dpmnNm": "김플래티어",
        "dptFcstDt": "2099-01-01 09:00:00.000000",
        "dptCnfmDtm": "2099-01-01 09:00:00.000000",
        "rfdBankCd": 148,
        "rfdBankCdNm": "국민은행",
        "rfdActnNo": "계좌번호 암호화",
        "rfdActnDepositorNm": "홍길동"
      }
    ],
    "rfdInfoResponse": {
      "rfdBankCd": 203,
      "rfdBankNm": "KB국민은행",
      "rfdActnNo": "33330********",
      "rfdActnDepositorNm": "임성현",
      "rfdActnCertiYn": "Y"
    }
  },
  "wthdFnshWaitProcCaus": "text"
}

200

OK

No content

반품전환

post

기능 설명

교환 중 반품 접수처리 합니다.

상세 내용

• 주문 클레임 교환반품 API를 호출합니다. API URL : /api/order/v1/claim/return/transformReturn

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

클레임 처리 요청 DTO

systemTypestring · enum · min: 1Required

시스템유형

Example: 10Possible values:

claimBusinessTypestring · enum · min: 1Required

클레임 업무 유형

Example: 20Possible values:

ordMediaCdstring · min: 1Required

주문매체코드(OM007)

Example: 20

ordNostringOptional

주문번호

Example: 20230808O007404

mbrNostringOptional

회원번호

Example: 100001311

claimNostringOptional

클레임번호

Example: 20230808C010663

wthdFnshWaitProcCausstringOptional

회수완료 대기처리 사유

Responses

200

OK

No content

post

/v2/claim/return/transformReturn

HTTPcURLJavaScriptPython

POST /api/bo/v2/claim/return/transformReturn HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 3470

{
  "systemType": 10,
  "claimBusinessType": 20,
  "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
    }
  ],
  "claimCpnInfoList": [
    {
      "cpnNo": 104224
    }
  ],
  "claimReturnDlvp": {
    "mbrOrdDlvpGb": 10,
    "dlvpSeq": 1,
    "zipNoSeq": 1,
    "dlvpNm": "집",
    "rcvmnNm": "홍길동",
    "zipNo": "05836",
    "zipAddr": "서울 송파구 법원로9길 26",
    "dtlAddr": "에이치비지니스파크 D동 6층",
    "rcvmnEmailAddr": "[e-mail]",
    "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": "[e-mail]",
    "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": 20,
        "typeNm": "회수배송비",
        "goodsNoItmNo": 10002762001,
        "goodsNm": "상품명",
        "ordAmt": 6000,
        "discountMethod": 11,
        "discountMethodNm": "상품할인쿠폰",
        "cnclDcAmt": 2000,
        "rtnDlvBenefitInfoList": [
          {
            "promoNo": "C1003841",
            "promoNm": "무료반품쿠폰",
            "promoTypCd": 15,
            "ourChrgRate": 100,
            "entrChrgRate": 0,
            "cpnIsuNo": 4364872,
            "aplyYn": "Y"
          }
        ]
      }
    ],
    "refundPaymentMethodList": [
      {
        "payNo": 2,
        "ordNo": "20990101O000001",
        "claimNo": "20990101C000001",
        "uprPayNo": 1,
        "payGbCd": 10,
        "payGbCdNm": "결제",
        "payWayCd": 11,
        "payWayCdNm": "신용카드",
        "payStatCd": 12,
        "payStatCdNm": "결제완료",
        "payAmt": 10000,
        "rfdPsbAmt": 10000,
        "rfdAmt": 1000,
        "payFnshDtm": "2099-01-01 09:00:00.000000",
        "trdNo": "INIMX_CARDINIpayTest20990101090000685510",
        "trdDtm": "2099-01-01 09:00:00.000000",
        "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": "2099-01-01 09:00:00.000000",
        "sctnCnclPsbYn": "Y",
        "bankCd": 148,
        "bankCdNm": "국민은행",
        "actnNo": "계좌번호 암호화",
        "dpmnNm": "김플래티어",
        "dptFcstDt": "2099-01-01 09:00:00.000000",
        "dptCnfmDtm": "2099-01-01 09:00:00.000000",
        "rfdBankCd": 148,
        "rfdBankCdNm": "국민은행",
        "rfdActnNo": "계좌번호 암호화",
        "rfdActnDepositorNm": "홍길동"
      }
    ],
    "rfdInfoResponse": {
      "rfdBankCd": 203,
      "rfdBankNm": "KB국민은행",
      "rfdActnNo": "33330********",
      "rfdActnDepositorNm": "임성현",
      "rfdActnCertiYn": "Y"
    }
  },
  "wthdFnshWaitProcCaus": "text"
}

200

OK

No content

반품보류

post

기능 설명

반품 보류 처리를 합니다.

상세 내용

• 주문 클레임 반품보류 API를 호출합니다. _API URL : /api/order/v1/claim/return/returnPending

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

클레임 처리 요청 DTO

systemTypestring · enum · min: 1Required

시스템유형

Example: 10Possible values:

claimBusinessTypestring · enum · min: 1Required

클레임 업무 유형

Example: 20Possible values:

ordMediaCdstring · min: 1Required

주문매체코드(OM007)

Example: 20

ordNostringOptional

주문번호

Example: 20230808O007404

mbrNostringOptional

회원번호

Example: 100001311

claimNostringOptional

클레임번호

Example: 20230808C010663

wthdFnshWaitProcCausstringOptional

회수완료 대기처리 사유

Responses

200

OK

No content

post

/v2/claim/return/returnPending

HTTPcURLJavaScriptPython

POST /api/bo/v2/claim/return/returnPending HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 3470

{
  "systemType": 10,
  "claimBusinessType": 20,
  "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
    }
  ],
  "claimCpnInfoList": [
    {
      "cpnNo": 104224
    }
  ],
  "claimReturnDlvp": {
    "mbrOrdDlvpGb": 10,
    "dlvpSeq": 1,
    "zipNoSeq": 1,
    "dlvpNm": "집",
    "rcvmnNm": "홍길동",
    "zipNo": "05836",
    "zipAddr": "서울 송파구 법원로9길 26",
    "dtlAddr": "에이치비지니스파크 D동 6층",
    "rcvmnEmailAddr": "[e-mail]",
    "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": "[e-mail]",
    "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": 20,
        "typeNm": "회수배송비",
        "goodsNoItmNo": 10002762001,
        "goodsNm": "상품명",
        "ordAmt": 6000,
        "discountMethod": 11,
        "discountMethodNm": "상품할인쿠폰",
        "cnclDcAmt": 2000,
        "rtnDlvBenefitInfoList": [
          {
            "promoNo": "C1003841",
            "promoNm": "무료반품쿠폰",
            "promoTypCd": 15,
            "ourChrgRate": 100,
            "entrChrgRate": 0,
            "cpnIsuNo": 4364872,
            "aplyYn": "Y"
          }
        ]
      }
    ],
    "refundPaymentMethodList": [
      {
        "payNo": 2,
        "ordNo": "20990101O000001",
        "claimNo": "20990101C000001",
        "uprPayNo": 1,
        "payGbCd": 10,
        "payGbCdNm": "결제",
        "payWayCd": 11,
        "payWayCdNm": "신용카드",
        "payStatCd": 12,
        "payStatCdNm": "결제완료",
        "payAmt": 10000,
        "rfdPsbAmt": 10000,
        "rfdAmt": 1000,
        "payFnshDtm": "2099-01-01 09:00:00.000000",
        "trdNo": "INIMX_CARDINIpayTest20990101090000685510",
        "trdDtm": "2099-01-01 09:00:00.000000",
        "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": "2099-01-01 09:00:00.000000",
        "sctnCnclPsbYn": "Y",
        "bankCd": 148,
        "bankCdNm": "국민은행",
        "actnNo": "계좌번호 암호화",
        "dpmnNm": "김플래티어",
        "dptFcstDt": "2099-01-01 09:00:00.000000",
        "dptCnfmDtm": "2099-01-01 09:00:00.000000",
        "rfdBankCd": 148,
        "rfdBankCdNm": "국민은행",
        "rfdActnNo": "계좌번호 암호화",
        "rfdActnDepositorNm": "홍길동"
      }
    ],
    "rfdInfoResponse": {
      "rfdBankCd": 203,
      "rfdBankNm": "KB국민은행",
      "rfdActnNo": "33330********",
      "rfdActnDepositorNm": "임성현",
      "rfdActnCertiYn": "Y"
    }
  },
  "wthdFnshWaitProcCaus": "text"
}

200

OK

No content

반품불가

post

기능 설명

반품 불가 처리를 합니다.

상세 내용

• 주문 클레임 반품불가 API를 호출합니다. _API URL : /api/order/v1/claim/return/rejectReturn

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

클레임 처리 요청 DTO

systemTypestring · enum · min: 1Required

시스템유형

Example: 10Possible values:

claimBusinessTypestring · enum · min: 1Required

클레임 업무 유형

Example: 20Possible values:

ordMediaCdstring · min: 1Required

주문매체코드(OM007)

Example: 20

ordNostringOptional

주문번호

Example: 20230808O007404

mbrNostringOptional

회원번호

Example: 100001311

claimNostringOptional

클레임번호

Example: 20230808C010663

wthdFnshWaitProcCausstringOptional

회수완료 대기처리 사유

Responses

200

OK

No content

post

/v2/claim/return/rejectReturn

HTTPcURLJavaScriptPython

POST /api/bo/v2/claim/return/rejectReturn HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 3470

{
  "systemType": 10,
  "claimBusinessType": 20,
  "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
    }
  ],
  "claimCpnInfoList": [
    {
      "cpnNo": 104224
    }
  ],
  "claimReturnDlvp": {
    "mbrOrdDlvpGb": 10,
    "dlvpSeq": 1,
    "zipNoSeq": 1,
    "dlvpNm": "집",
    "rcvmnNm": "홍길동",
    "zipNo": "05836",
    "zipAddr": "서울 송파구 법원로9길 26",
    "dtlAddr": "에이치비지니스파크 D동 6층",
    "rcvmnEmailAddr": "[e-mail]",
    "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": "[e-mail]",
    "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": 20,
        "typeNm": "회수배송비",
        "goodsNoItmNo": 10002762001,
        "goodsNm": "상품명",
        "ordAmt": 6000,
        "discountMethod": 11,
        "discountMethodNm": "상품할인쿠폰",
        "cnclDcAmt": 2000,
        "rtnDlvBenefitInfoList": [
          {
            "promoNo": "C1003841",
            "promoNm": "무료반품쿠폰",
            "promoTypCd": 15,
            "ourChrgRate": 100,
            "entrChrgRate": 0,
            "cpnIsuNo": 4364872,
            "aplyYn": "Y"
          }
        ]
      }
    ],
    "refundPaymentMethodList": [
      {
        "payNo": 2,
        "ordNo": "20990101O000001",
        "claimNo": "20990101C000001",
        "uprPayNo": 1,
        "payGbCd": 10,
        "payGbCdNm": "결제",
        "payWayCd": 11,
        "payWayCdNm": "신용카드",
        "payStatCd": 12,
        "payStatCdNm": "결제완료",
        "payAmt": 10000,
        "rfdPsbAmt": 10000,
        "rfdAmt": 1000,
        "payFnshDtm": "2099-01-01 09:00:00.000000",
        "trdNo": "INIMX_CARDINIpayTest20990101090000685510",
        "trdDtm": "2099-01-01 09:00:00.000000",
        "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": "2099-01-01 09:00:00.000000",
        "sctnCnclPsbYn": "Y",
        "bankCd": 148,
        "bankCdNm": "국민은행",
        "actnNo": "계좌번호 암호화",
        "dpmnNm": "김플래티어",
        "dptFcstDt": "2099-01-01 09:00:00.000000",
        "dptCnfmDtm": "2099-01-01 09:00:00.000000",
        "rfdBankCd": 148,
        "rfdBankCdNm": "국민은행",
        "rfdActnNo": "계좌번호 암호화",
        "rfdActnDepositorNm": "홍길동"
      }
    ],
    "rfdInfoResponse": {
      "rfdBankCd": 203,
      "rfdBankNm": "KB국민은행",
      "rfdActnNo": "33330********",
      "rfdActnDepositorNm": "임성현",
      "rfdActnCertiYn": "Y"
    }
  },
  "wthdFnshWaitProcCaus": "text"
}

200

OK

No content

반품전환 처리대상조회

post

기능 설명

반품전환팝업 호출 시 필요한 주문 정보와 반품 전환 가능 상품 목록 그외 기타 정보를 조회합니다.

상세 내용

• 주문 반품처리대상조회(BO) API를 호출합니다. API URL : /api/order/v1/claim/return/returnTargetInfo

---

수정 번호

• Release v2.00_240729 : 회수여부(wthdYn) 추가

• Release v2.00_240829 : 마스킹 처리 현행화

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

반품팝업 요청 DTO

ordNostringOptional

주문번호

Example: 20230809O000001

claimBusinessTypestring · enumOptional

클레임 업무 유형

Example: 20Possible values:

systemTypestring · enumOptional

시스템유형

Example: 10Possible values:

Responses

200

OK

*/*

반품팝업 응답 DTO

claimBusinessTypestring · enumOptional

클레임업무유형

Example: 11Possible values:

post

/v2/claim/return/getReturnTransformPopupBaseInfo

HTTPcURLJavaScriptPython

POST /api/bo/v2/claim/return/getReturnTransformPopupBaseInfo HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 66

{
  "ordNo": "20230809O000001",
  "claimBusinessType": 20,
  "systemType": 10
}

200

OK

{
  "claimTargetResponse": {
    "ordNo": "20231231O000001",
    "mbrNo": 100001311,
    "ordManNm": "홍길동",
    "ordMediaCd": 10,
    "sctnCnclPsbYn": "N",
    "claimTargetGoodsResponseList": [
      {
        "ordNo": "20231231O000001",
        "ordSeq": 1,
        "ordProcSeq": 1,
        "uprOrdProcSeq": 1,
        "maxOrdProcSeq": 1,
        "claimNo": "20231231C000001",
        "goodsNo": 10002297,
        "itmNo": "001",
        "ordDtlGbCd": 10,
        "ordDtlGbCdNm": "주문일반",
        "ordDtlStatCd": 11,
        "ordDtlStatCdNm": "접수",
        "deliGbCd": 10,
        "ordAccpDtm": "2023-12-31 00:00:00",
        "ordFnshDtm": "2023-12-31 00:00:00",
        "ordQty": 1,
        "cnclQty": 0,
        "rtnQty": 0,
        "claimQty": 0,
        "claimPossibleQty": 5,
        "deliIndiDtm": "2023-12-31 00:00:00",
        "deliIndiRsvDtm": "2023-12-31 00:00:00",
        "exchMidRtnYn": "N",
        "rtnPsbYn": "N",
        "exchPsbYn": "N",
        "ordCnclPsbYn": "N",
        "wthdYn": "Y",
        "ecpnNo": "ORD0001",
        "etcktNo": "ORD0001",
        "claimLgrpCd": 10,
        "claimLgrpCdNm": "단순변심",
        "claimMgrpCd": 300,
        "claimMgrpCdNm": "사이즈가 큼",
        "claimCausEtcCont": "사이즈가 생각보다 큽니다.",
        "ordSaleTypCd": 10,
        "chlNo": 1000001,
        "chlDtlNo": 1000001,
        "stdCtgNo": "HT01020000",
        "infDispCtgNoGbCd": "01",
        "infDispCtgNo": 213,
        "repDispCtgNo": 213,
        "conrNo": 10050,
        "brandNo": 100002,
        "brandNm": "플래티어",
        "goodsNm": "폴로티셔츠",
        "itmNm": "화이트>95",
        "prestNm": "우산 증정",
        "goodsCompCd": 10,
        "goodsTypCd": 10,
        "saleMethCd": 10,
        "taxGbCd": "01",
        "buyTypCd": 10,
        "supPcost": 14400,
        "norPrc": 25000,
        "salePrc": 30000,
        "preSalePrc": 3000,
        "mrgnRate": 4,
        "entrNo": 1000002,
        "deliPolcNo": 10000431,
        "deliDday": 1,
        "deliGoodsGbCd": "01",
        "deliWayCd": 10,
        "bpckPsbYn": "Y",
        "hsCd": "0101",
        "goodsRevWrtYn": "N",
        "bnfAmt": 2000,
        "ordPrc": 25000,
        "aeGoodsYn": "N",
        "deliNo": 100008491,
        "deliMethodCd": 10,
        "deliProcTypCd": 10,
        "deliProcTypCdNm": "업체배송",
        "deliFnshDtm": "2023-12-31 00:00:00",
        "puTypCd": 20,
        "dlvpNm": "자택",
        "rcvmnNm": "홍길동",
        "dlvpSeq": 1,
        "zipNo": "05836",
        "zipAddr": "서울 송파구 법원로9길 26",
        "dtlAddr": "에이치비지니스파크 D동 6층",
        "dlvZipNo": "05836",
        "dlvZipAddr": "서울 송파구 법원로9길 26",
        "dlvDtlAddr": "에이치비지니스파크 D동 6층",
        "rcvmnEmailAddr": "[e-mail]",
        "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": "[e-mail]",
          "rcvmnCellSctNo": "010",
          "rcvmnCellTxnoNo": 1234,
          "rcvmnCellEndNo": 5678,
          "rcvmnTelRgnNo": "02",
          "rcvmnTelTxnoNo": 123,
          "rcvmnTelEndNo": 4567,
          "deliMsg": "부재 시 문 앞에 놓아주세요.",
          "deliMsgCd": 30,
          "shopTrafMsg": "문 앞에 놓아주세요.",
          "comnFrdrCogoMethodCd": 20,
          "comnFrdrEtcMethod": "자유 출입 가능",
          "comnFrdrPwd": 1234
        },
        "orgDeliNo": 100000021,
        "withdrawalDeliNo": 100000001,
        "dlvpInfo": {
          "mbrOrdDlvpGb": 10,
          "dlvpSeq": 1,
          "zipNoSeq": 1,
          "dlvpNm": "집",
          "rcvmnNm": "홍길동",
          "zipNo": "05836",
          "zipAddr": "서울 송파구 법원로9길 26",
          "dtlAddr": "에이치비지니스파크 D동 6층",
          "rcvmnEmailAddr": "[e-mail]",
          "rcvmnCellSctNo": "010",
          "rcvmnCellTxnoNo": 1234,
          "rcvmnCellEndNo": 5678,
          "rcvmnTelRgnNo": "02",
          "rcvmnTelTxnoNo": 123,
          "rcvmnTelEndNo": 4567,
          "deliMsg": "부재 시 문 앞에 놓아주세요.",
          "deliMsgCd": 30,
          "shopTrafMsg": "문 앞에 놓아주세요.",
          "comnFrdrCogoMethodCd": 20,
          "comnFrdrEtcMethod": "자유 출입 가능",
          "comnFrdrPwd": 1234
        },
        "shippingDeliGbCd": true,
        "withdrawalDeliGbCd": true,
        "exchangeShipping": true,
        "withdrawShipping": true
      }
    ],
    "vbankPaymentPending": true,
    "allNonReturnable": true,
    "allEcoupon": true
  },
  "codeMap": {
    "ANY_ADDITIONAL_PROPERTY": [
      {
        "grpCd": "ME001",
        "cd": 11,
        "cdNm": "상품즉시할인",
        "cdDesc": "다국어 코드설명",
        "useYn": "Y",
        "sortSeq": 1,
        "ref1Val": "기준코드 참조1값에 대한 설명",
        "ref2Val": "기준코드 참조2값에 대한 설명",
        "ref3Val": "기준코드 참조3값에 대한 설명",
        "ref4Val": "기준코드 참조4값에 대한 설명",
        "ref5Val": "기준코드 참조5값에 대한 설명",
        "ref6Val": "기준코드 참조6값에 대한 설명",
        "ref7Val": "기준코드 참조7값에 대한 설명"
      }
    ]
  },
  "claimBusinessType": 11
}

반품불가 대상 조회

post

기능 설명

반품불가팝업 호출 시 필요한 주문 정보와 반품 불가 가능 상품 목록을 조회합니다.

상세 내용

• 주문 반품처리대상조회(BO) API를 호출합니다. API URL : /api/order/v1/claim/return/returnTargetInfo

---

수정번호

• Release v2.00_240729 : 회수여부(wthdYn) 추가

• Release v2.00_240829 : 마스킹 처리 현행화

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

반품팝업 요청 DTO

ordNostringOptional

주문번호

Example: 20230809O000001

claimBusinessTypestring · enumOptional

클레임 업무 유형

Example: 20Possible values:

systemTypestring · enumOptional

시스템유형

Example: 10Possible values:

Responses

200

OK

*/*

반품팝업 응답 DTO

claimBusinessTypestring · enumOptional

클레임업무유형

Example: 11Possible values:

post

/v2/claim/return/getReturnRejectPopupInfo

HTTPcURLJavaScriptPython

POST /api/bo/v2/claim/return/getReturnRejectPopupInfo HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 66

{
  "ordNo": "20230809O000001",
  "claimBusinessType": 20,
  "systemType": 10
}

200

OK

{
  "claimTargetResponse": {
    "ordNo": "20231231O000001",
    "mbrNo": 100001311,
    "ordManNm": "홍길동",
    "ordMediaCd": 10,
    "sctnCnclPsbYn": "N",
    "claimTargetGoodsResponseList": [
      {
        "ordNo": "20231231O000001",
        "ordSeq": 1,
        "ordProcSeq": 1,
        "uprOrdProcSeq": 1,
        "maxOrdProcSeq": 1,
        "claimNo": "20231231C000001",
        "goodsNo": 10002297,
        "itmNo": "001",
        "ordDtlGbCd": 10,
        "ordDtlGbCdNm": "주문일반",
        "ordDtlStatCd": 11,
        "ordDtlStatCdNm": "접수",
        "deliGbCd": 10,
        "ordAccpDtm": "2023-12-31 00:00:00",
        "ordFnshDtm": "2023-12-31 00:00:00",
        "ordQty": 1,
        "cnclQty": 0,
        "rtnQty": 0,
        "claimQty": 0,
        "claimPossibleQty": 5,
        "deliIndiDtm": "2023-12-31 00:00:00",
        "deliIndiRsvDtm": "2023-12-31 00:00:00",
        "exchMidRtnYn": "N",
        "rtnPsbYn": "N",
        "exchPsbYn": "N",
        "ordCnclPsbYn": "N",
        "wthdYn": "Y",
        "ecpnNo": "ORD0001",
        "etcktNo": "ORD0001",
        "claimLgrpCd": 10,
        "claimLgrpCdNm": "단순변심",
        "claimMgrpCd": 300,
        "claimMgrpCdNm": "사이즈가 큼",
        "claimCausEtcCont": "사이즈가 생각보다 큽니다.",
        "ordSaleTypCd": 10,
        "chlNo": 1000001,
        "chlDtlNo": 1000001,
        "stdCtgNo": "HT01020000",
        "infDispCtgNoGbCd": "01",
        "infDispCtgNo": 213,
        "repDispCtgNo": 213,
        "conrNo": 10050,
        "brandNo": 100002,
        "brandNm": "플래티어",
        "goodsNm": "폴로티셔츠",
        "itmNm": "화이트>95",
        "prestNm": "우산 증정",
        "goodsCompCd": 10,
        "goodsTypCd": 10,
        "saleMethCd": 10,
        "taxGbCd": "01",
        "buyTypCd": 10,
        "supPcost": 14400,
        "norPrc": 25000,
        "salePrc": 30000,
        "preSalePrc": 3000,
        "mrgnRate": 4,
        "entrNo": 1000002,
        "deliPolcNo": 10000431,
        "deliDday": 1,
        "deliGoodsGbCd": "01",
        "deliWayCd": 10,
        "bpckPsbYn": "Y",
        "hsCd": "0101",
        "goodsRevWrtYn": "N",
        "bnfAmt": 2000,
        "ordPrc": 25000,
        "aeGoodsYn": "N",
        "deliNo": 100008491,
        "deliMethodCd": 10,
        "deliProcTypCd": 10,
        "deliProcTypCdNm": "업체배송",
        "deliFnshDtm": "2023-12-31 00:00:00",
        "puTypCd": 20,
        "dlvpNm": "자택",
        "rcvmnNm": "홍길동",
        "dlvpSeq": 1,
        "zipNo": "05836",
        "zipAddr": "서울 송파구 법원로9길 26",
        "dtlAddr": "에이치비지니스파크 D동 6층",
        "dlvZipNo": "05836",
        "dlvZipAddr": "서울 송파구 법원로9길 26",
        "dlvDtlAddr": "에이치비지니스파크 D동 6층",
        "rcvmnEmailAddr": "[e-mail]",
        "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": "[e-mail]",
          "rcvmnCellSctNo": "010",
          "rcvmnCellTxnoNo": 1234,
          "rcvmnCellEndNo": 5678,
          "rcvmnTelRgnNo": "02",
          "rcvmnTelTxnoNo": 123,
          "rcvmnTelEndNo": 4567,
          "deliMsg": "부재 시 문 앞에 놓아주세요.",
          "deliMsgCd": 30,
          "shopTrafMsg": "문 앞에 놓아주세요.",
          "comnFrdrCogoMethodCd": 20,
          "comnFrdrEtcMethod": "자유 출입 가능",
          "comnFrdrPwd": 1234
        },
        "orgDeliNo": 100000021,
        "withdrawalDeliNo": 100000001,
        "dlvpInfo": {
          "mbrOrdDlvpGb": 10,
          "dlvpSeq": 1,
          "zipNoSeq": 1,
          "dlvpNm": "집",
          "rcvmnNm": "홍길동",
          "zipNo": "05836",
          "zipAddr": "서울 송파구 법원로9길 26",
          "dtlAddr": "에이치비지니스파크 D동 6층",
          "rcvmnEmailAddr": "[e-mail]",
          "rcvmnCellSctNo": "010",
          "rcvmnCellTxnoNo": 1234,
          "rcvmnCellEndNo": 5678,
          "rcvmnTelRgnNo": "02",
          "rcvmnTelTxnoNo": 123,
          "rcvmnTelEndNo": 4567,
          "deliMsg": "부재 시 문 앞에 놓아주세요.",
          "deliMsgCd": 30,
          "shopTrafMsg": "문 앞에 놓아주세요.",
          "comnFrdrCogoMethodCd": 20,
          "comnFrdrEtcMethod": "자유 출입 가능",
          "comnFrdrPwd": 1234
        },
        "shippingDeliGbCd": true,
        "withdrawalDeliGbCd": true,
        "exchangeShipping": true,
        "withdrawShipping": true
      }
    ],
    "vbankPaymentPending": true,
    "allNonReturnable": true,
    "allEcoupon": true
  },
  "codeMap": {
    "ANY_ADDITIONAL_PROPERTY": [
      {
        "grpCd": "ME001",
        "cd": 11,
        "cdNm": "상품즉시할인",
        "cdDesc": "다국어 코드설명",
        "useYn": "Y",
        "sortSeq": 1,
        "ref1Val": "기준코드 참조1값에 대한 설명",
        "ref2Val": "기준코드 참조2값에 대한 설명",
        "ref3Val": "기준코드 참조3값에 대한 설명",
        "ref4Val": "기준코드 참조4값에 대한 설명",
        "ref5Val": "기준코드 참조5값에 대한 설명",
        "ref6Val": "기준코드 참조6값에 대한 설명",
        "ref7Val": "기준코드 참조7값에 대한 설명"
      }
    ]
  },
  "claimBusinessType": 11
}

반품접수 처리대상조회

post

기능 설명

     반품접수팝업 호출 시 필요한 주문 정보와 반품 대상 상품 목록 그외 기타 정보를 조회합니다.
     <br><br>
     ---
     ## 상세 내용
     * 주문 반품처리대상조회(BO) API를 호출합니다.<br><br>
     _API URL : /api/order/v1/claim/return/returnTargetInfo_
     ---
     ## 수정 번호
     * Release v2.00_240729 : 취소 가능 여부(ordCnclPsbYn), 회수여부(wthdYn), e쿠폰번호(ecpnNo), e티켓번호(etcktNo) 추가

• Release v2.00_240829 : 마스킹 처리 현행화

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

반품팝업 요청 DTO

ordNostringOptional

주문번호

Example: 20230809O000001

claimBusinessTypestring · enumOptional

클레임 업무 유형

Example: 20Possible values:

systemTypestring · enumOptional

시스템유형

Example: 10Possible values:

Responses

200

OK

*/*

반품팝업 응답 DTO

claimBusinessTypestring · enumOptional

클레임업무유형

Example: 11Possible values:

post

/v2/claim/return/getReturnPopupBaseInfo

HTTPcURLJavaScriptPython

POST /api/bo/v2/claim/return/getReturnPopupBaseInfo HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 66

{
  "ordNo": "20230809O000001",
  "claimBusinessType": 20,
  "systemType": 10
}

200

OK

{
  "claimTargetResponse": {
    "ordNo": "20231231O000001",
    "mbrNo": 100001311,
    "ordManNm": "홍길동",
    "ordMediaCd": 10,
    "sctnCnclPsbYn": "N",
    "claimTargetGoodsResponseList": [
      {
        "ordNo": "20231231O000001",
        "ordSeq": 1,
        "ordProcSeq": 1,
        "uprOrdProcSeq": 1,
        "maxOrdProcSeq": 1,
        "claimNo": "20231231C000001",
        "goodsNo": 10002297,
        "itmNo": "001",
        "ordDtlGbCd": 10,
        "ordDtlGbCdNm": "주문일반",
        "ordDtlStatCd": 11,
        "ordDtlStatCdNm": "접수",
        "deliGbCd": 10,
        "ordAccpDtm": "2023-12-31 00:00:00",
        "ordFnshDtm": "2023-12-31 00:00:00",
        "ordQty": 1,
        "cnclQty": 0,
        "rtnQty": 0,
        "claimQty": 0,
        "claimPossibleQty": 5,
        "deliIndiDtm": "2023-12-31 00:00:00",
        "deliIndiRsvDtm": "2023-12-31 00:00:00",
        "exchMidRtnYn": "N",
        "rtnPsbYn": "N",
        "exchPsbYn": "N",
        "ordCnclPsbYn": "N",
        "wthdYn": "Y",
        "ecpnNo": "ORD0001",
        "etcktNo": "ORD0001",
        "claimLgrpCd": 10,
        "claimLgrpCdNm": "단순변심",
        "claimMgrpCd": 300,
        "claimMgrpCdNm": "사이즈가 큼",
        "claimCausEtcCont": "사이즈가 생각보다 큽니다.",
        "ordSaleTypCd": 10,
        "chlNo": 1000001,
        "chlDtlNo": 1000001,
        "stdCtgNo": "HT01020000",
        "infDispCtgNoGbCd": "01",
        "infDispCtgNo": 213,
        "repDispCtgNo": 213,
        "conrNo": 10050,
        "brandNo": 100002,
        "brandNm": "플래티어",
        "goodsNm": "폴로티셔츠",
        "itmNm": "화이트>95",
        "prestNm": "우산 증정",
        "goodsCompCd": 10,
        "goodsTypCd": 10,
        "saleMethCd": 10,
        "taxGbCd": "01",
        "buyTypCd": 10,
        "supPcost": 14400,
        "norPrc": 25000,
        "salePrc": 30000,
        "preSalePrc": 3000,
        "mrgnRate": 4,
        "entrNo": 1000002,
        "deliPolcNo": 10000431,
        "deliDday": 1,
        "deliGoodsGbCd": "01",
        "deliWayCd": 10,
        "bpckPsbYn": "Y",
        "hsCd": "0101",
        "goodsRevWrtYn": "N",
        "bnfAmt": 2000,
        "ordPrc": 25000,
        "aeGoodsYn": "N",
        "deliNo": 100008491,
        "deliMethodCd": 10,
        "deliProcTypCd": 10,
        "deliProcTypCdNm": "업체배송",
        "deliFnshDtm": "2023-12-31 00:00:00",
        "puTypCd": 20,
        "dlvpNm": "자택",
        "rcvmnNm": "홍길동",
        "dlvpSeq": 1,
        "zipNo": "05836",
        "zipAddr": "서울 송파구 법원로9길 26",
        "dtlAddr": "에이치비지니스파크 D동 6층",
        "dlvZipNo": "05836",
        "dlvZipAddr": "서울 송파구 법원로9길 26",
        "dlvDtlAddr": "에이치비지니스파크 D동 6층",
        "rcvmnEmailAddr": "[e-mail]",
        "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": "[e-mail]",
          "rcvmnCellSctNo": "010",
          "rcvmnCellTxnoNo": 1234,
          "rcvmnCellEndNo": 5678,
          "rcvmnTelRgnNo": "02",
          "rcvmnTelTxnoNo": 123,
          "rcvmnTelEndNo": 4567,
          "deliMsg": "부재 시 문 앞에 놓아주세요.",
          "deliMsgCd": 30,
          "shopTrafMsg": "문 앞에 놓아주세요.",
          "comnFrdrCogoMethodCd": 20,
          "comnFrdrEtcMethod": "자유 출입 가능",
          "comnFrdrPwd": 1234
        },
        "orgDeliNo": 100000021,
        "withdrawalDeliNo": 100000001,
        "dlvpInfo": {
          "mbrOrdDlvpGb": 10,
          "dlvpSeq": 1,
          "zipNoSeq": 1,
          "dlvpNm": "집",
          "rcvmnNm": "홍길동",
          "zipNo": "05836",
          "zipAddr": "서울 송파구 법원로9길 26",
          "dtlAddr": "에이치비지니스파크 D동 6층",
          "rcvmnEmailAddr": "[e-mail]",
          "rcvmnCellSctNo": "010",
          "rcvmnCellTxnoNo": 1234,
          "rcvmnCellEndNo": 5678,
          "rcvmnTelRgnNo": "02",
          "rcvmnTelTxnoNo": 123,
          "rcvmnTelEndNo": 4567,
          "deliMsg": "부재 시 문 앞에 놓아주세요.",
          "deliMsgCd": 30,
          "shopTrafMsg": "문 앞에 놓아주세요.",
          "comnFrdrCogoMethodCd": 20,
          "comnFrdrEtcMethod": "자유 출입 가능",
          "comnFrdrPwd": 1234
        },
        "shippingDeliGbCd": true,
        "withdrawalDeliGbCd": true,
        "exchangeShipping": true,
        "withdrawShipping": true
      }
    ],
    "vbankPaymentPending": true,
    "allNonReturnable": true,
    "allEcoupon": true
  },
  "codeMap": {
    "ANY_ADDITIONAL_PROPERTY": [
      {
        "grpCd": "ME001",
        "cd": 11,
        "cdNm": "상품즉시할인",
        "cdDesc": "다국어 코드설명",
        "useYn": "Y",
        "sortSeq": 1,
        "ref1Val": "기준코드 참조1값에 대한 설명",
        "ref2Val": "기준코드 참조2값에 대한 설명",
        "ref3Val": "기준코드 참조3값에 대한 설명",
        "ref4Val": "기준코드 참조4값에 대한 설명",
        "ref5Val": "기준코드 참조5값에 대한 설명",
        "ref6Val": "기준코드 참조6값에 대한 설명",
        "ref7Val": "기준코드 참조7값에 대한 설명"
      }
    ]
  },
  "claimBusinessType": 11
}

반품보류 처리대상조회

post

기능 설명

반품보류팝업 호출 시 필요한 주문 정보와 반품 보류 가능 상품 목록 그외 기타 정보를 조회합니다.

상세 내용

• 주문 반품처리대상조회(BO) API를 호출합니다. API URL : /api/order/v1/claim/return/returnTargetInfo

---

수정 번호

• Release v2.00_240729 : 회수여부(wthdYn) 추가

• Release v2.00_240829 : 마스킹 처리 현행화

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

반품팝업 요청 DTO

ordNostringOptional

주문번호

Example: 20230809O000001

claimBusinessTypestring · enumOptional

클레임 업무 유형

Example: 20Possible values:

systemTypestring · enumOptional

시스템유형

Example: 10Possible values:

Responses

200

OK

*/*

반품팝업 응답 DTO

claimBusinessTypestring · enumOptional

클레임업무유형

Example: 11Possible values:

post

/v2/claim/return/getReturnPendingPopupBaseInfo

HTTPcURLJavaScriptPython

POST /api/bo/v2/claim/return/getReturnPendingPopupBaseInfo HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 66

{
  "ordNo": "20230809O000001",
  "claimBusinessType": 20,
  "systemType": 10
}

200

OK

{
  "claimTargetResponse": {
    "ordNo": "20231231O000001",
    "mbrNo": 100001311,
    "ordManNm": "홍길동",
    "ordMediaCd": 10,
    "sctnCnclPsbYn": "N",
    "claimTargetGoodsResponseList": [
      {
        "ordNo": "20231231O000001",
        "ordSeq": 1,
        "ordProcSeq": 1,
        "uprOrdProcSeq": 1,
        "maxOrdProcSeq": 1,
        "claimNo": "20231231C000001",
        "goodsNo": 10002297,
        "itmNo": "001",
        "ordDtlGbCd": 10,
        "ordDtlGbCdNm": "주문일반",
        "ordDtlStatCd": 11,
        "ordDtlStatCdNm": "접수",
        "deliGbCd": 10,
        "ordAccpDtm": "2023-12-31 00:00:00",
        "ordFnshDtm": "2023-12-31 00:00:00",
        "ordQty": 1,
        "cnclQty": 0,
        "rtnQty": 0,
        "claimQty": 0,
        "claimPossibleQty": 5,
        "deliIndiDtm": "2023-12-31 00:00:00",
        "deliIndiRsvDtm": "2023-12-31 00:00:00",
        "exchMidRtnYn": "N",
        "rtnPsbYn": "N",
        "exchPsbYn": "N",
        "ordCnclPsbYn": "N",
        "wthdYn": "Y",
        "ecpnNo": "ORD0001",
        "etcktNo": "ORD0001",
        "claimLgrpCd": 10,
        "claimLgrpCdNm": "단순변심",
        "claimMgrpCd": 300,
        "claimMgrpCdNm": "사이즈가 큼",
        "claimCausEtcCont": "사이즈가 생각보다 큽니다.",
        "ordSaleTypCd": 10,
        "chlNo": 1000001,
        "chlDtlNo": 1000001,
        "stdCtgNo": "HT01020000",
        "infDispCtgNoGbCd": "01",
        "infDispCtgNo": 213,
        "repDispCtgNo": 213,
        "conrNo": 10050,
        "brandNo": 100002,
        "brandNm": "플래티어",
        "goodsNm": "폴로티셔츠",
        "itmNm": "화이트>95",
        "prestNm": "우산 증정",
        "goodsCompCd": 10,
        "goodsTypCd": 10,
        "saleMethCd": 10,
        "taxGbCd": "01",
        "buyTypCd": 10,
        "supPcost": 14400,
        "norPrc": 25000,
        "salePrc": 30000,
        "preSalePrc": 3000,
        "mrgnRate": 4,
        "entrNo": 1000002,
        "deliPolcNo": 10000431,
        "deliDday": 1,
        "deliGoodsGbCd": "01",
        "deliWayCd": 10,
        "bpckPsbYn": "Y",
        "hsCd": "0101",
        "goodsRevWrtYn": "N",
        "bnfAmt": 2000,
        "ordPrc": 25000,
        "aeGoodsYn": "N",
        "deliNo": 100008491,
        "deliMethodCd": 10,
        "deliProcTypCd": 10,
        "deliProcTypCdNm": "업체배송",
        "deliFnshDtm": "2023-12-31 00:00:00",
        "puTypCd": 20,
        "dlvpNm": "자택",
        "rcvmnNm": "홍길동",
        "dlvpSeq": 1,
        "zipNo": "05836",
        "zipAddr": "서울 송파구 법원로9길 26",
        "dtlAddr": "에이치비지니스파크 D동 6층",
        "dlvZipNo": "05836",
        "dlvZipAddr": "서울 송파구 법원로9길 26",
        "dlvDtlAddr": "에이치비지니스파크 D동 6층",
        "rcvmnEmailAddr": "[e-mail]",
        "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": "[e-mail]",
          "rcvmnCellSctNo": "010",
          "rcvmnCellTxnoNo": 1234,
          "rcvmnCellEndNo": 5678,
          "rcvmnTelRgnNo": "02",
          "rcvmnTelTxnoNo": 123,
          "rcvmnTelEndNo": 4567,
          "deliMsg": "부재 시 문 앞에 놓아주세요.",
          "deliMsgCd": 30,
          "shopTrafMsg": "문 앞에 놓아주세요.",
          "comnFrdrCogoMethodCd": 20,
          "comnFrdrEtcMethod": "자유 출입 가능",
          "comnFrdrPwd": 1234
        },
        "orgDeliNo": 100000021,
        "withdrawalDeliNo": 100000001,
        "dlvpInfo": {
          "mbrOrdDlvpGb": 10,
          "dlvpSeq": 1,
          "zipNoSeq": 1,
          "dlvpNm": "집",
          "rcvmnNm": "홍길동",
          "zipNo": "05836",
          "zipAddr": "서울 송파구 법원로9길 26",
          "dtlAddr": "에이치비지니스파크 D동 6층",
          "rcvmnEmailAddr": "[e-mail]",
          "rcvmnCellSctNo": "010",
          "rcvmnCellTxnoNo": 1234,
          "rcvmnCellEndNo": 5678,
          "rcvmnTelRgnNo": "02",
          "rcvmnTelTxnoNo": 123,
          "rcvmnTelEndNo": 4567,
          "deliMsg": "부재 시 문 앞에 놓아주세요.",
          "deliMsgCd": 30,
          "shopTrafMsg": "문 앞에 놓아주세요.",
          "comnFrdrCogoMethodCd": 20,
          "comnFrdrEtcMethod": "자유 출입 가능",
          "comnFrdrPwd": 1234
        },
        "shippingDeliGbCd": true,
        "withdrawalDeliGbCd": true,
        "exchangeShipping": true,
        "withdrawShipping": true
      }
    ],
    "vbankPaymentPending": true,
    "allNonReturnable": true,
    "allEcoupon": true
  },
  "codeMap": {
    "ANY_ADDITIONAL_PROPERTY": [
      {
        "grpCd": "ME001",
        "cd": 11,
        "cdNm": "상품즉시할인",
        "cdDesc": "다국어 코드설명",
        "useYn": "Y",
        "sortSeq": 1,
        "ref1Val": "기준코드 참조1값에 대한 설명",
        "ref2Val": "기준코드 참조2값에 대한 설명",
        "ref3Val": "기준코드 참조3값에 대한 설명",
        "ref4Val": "기준코드 참조4값에 대한 설명",
        "ref5Val": "기준코드 참조5값에 대한 설명",
        "ref6Val": "기준코드 참조6값에 대한 설명",
        "ref7Val": "기준코드 참조7값에 대한 설명"
      }
    ]
  },
  "claimBusinessType": 11
}

반품완료 처리대상조회

post

기능 설명

반품완료팝업 호출 시 필요한 주문 정보와 반품 완료 가능 상품 목록 그외 기타 정보를 조회합니다.

상세 내용

• 주문 반품처리대상조회(BO) API를 호출합니다. API URL : /api/order/v1/claim/return/returnTargetInfo

---

수정 번호

• Release v2.00_240729 : 회수여부(wthdYn), e쿠폰번호(ecpnNo) 추가

• Release v2.00_240829 : 마스킹 처리 현행화

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

반품팝업 요청 DTO

ordNostringOptional

주문번호

Example: 20230809O000001

claimBusinessTypestring · enumOptional

클레임 업무 유형

Example: 20Possible values:

systemTypestring · enumOptional

시스템유형

Example: 10Possible values:

Responses

200

OK

*/*

반품팝업 응답 DTO

claimBusinessTypestring · enumOptional

클레임업무유형

Example: 11Possible values:

post

/v2/claim/return/getReturnCompletePopupBaseInfo

HTTPcURLJavaScriptPython

POST /api/bo/v2/claim/return/getReturnCompletePopupBaseInfo HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 66

{
  "ordNo": "20230809O000001",
  "claimBusinessType": 20,
  "systemType": 10
}

200

OK

{
  "claimTargetResponse": {
    "ordNo": "20231231O000001",
    "mbrNo": 100001311,
    "ordManNm": "홍길동",
    "ordMediaCd": 10,
    "sctnCnclPsbYn": "N",
    "claimTargetGoodsResponseList": [
      {
        "ordNo": "20231231O000001",
        "ordSeq": 1,
        "ordProcSeq": 1,
        "uprOrdProcSeq": 1,
        "maxOrdProcSeq": 1,
        "claimNo": "20231231C000001",
        "goodsNo": 10002297,
        "itmNo": "001",
        "ordDtlGbCd": 10,
        "ordDtlGbCdNm": "주문일반",
        "ordDtlStatCd": 11,
        "ordDtlStatCdNm": "접수",
        "deliGbCd": 10,
        "ordAccpDtm": "2023-12-31 00:00:00",
        "ordFnshDtm": "2023-12-31 00:00:00",
        "ordQty": 1,
        "cnclQty": 0,
        "rtnQty": 0,
        "claimQty": 0,
        "claimPossibleQty": 5,
        "deliIndiDtm": "2023-12-31 00:00:00",
        "deliIndiRsvDtm": "2023-12-31 00:00:00",
        "exchMidRtnYn": "N",
        "rtnPsbYn": "N",
        "exchPsbYn": "N",
        "ordCnclPsbYn": "N",
        "wthdYn": "Y",
        "ecpnNo": "ORD0001",
        "etcktNo": "ORD0001",
        "claimLgrpCd": 10,
        "claimLgrpCdNm": "단순변심",
        "claimMgrpCd": 300,
        "claimMgrpCdNm": "사이즈가 큼",
        "claimCausEtcCont": "사이즈가 생각보다 큽니다.",
        "ordSaleTypCd": 10,
        "chlNo": 1000001,
        "chlDtlNo": 1000001,
        "stdCtgNo": "HT01020000",
        "infDispCtgNoGbCd": "01",
        "infDispCtgNo": 213,
        "repDispCtgNo": 213,
        "conrNo": 10050,
        "brandNo": 100002,
        "brandNm": "플래티어",
        "goodsNm": "폴로티셔츠",
        "itmNm": "화이트>95",
        "prestNm": "우산 증정",
        "goodsCompCd": 10,
        "goodsTypCd": 10,
        "saleMethCd": 10,
        "taxGbCd": "01",
        "buyTypCd": 10,
        "supPcost": 14400,
        "norPrc": 25000,
        "salePrc": 30000,
        "preSalePrc": 3000,
        "mrgnRate": 4,
        "entrNo": 1000002,
        "deliPolcNo": 10000431,
        "deliDday": 1,
        "deliGoodsGbCd": "01",
        "deliWayCd": 10,
        "bpckPsbYn": "Y",
        "hsCd": "0101",
        "goodsRevWrtYn": "N",
        "bnfAmt": 2000,
        "ordPrc": 25000,
        "aeGoodsYn": "N",
        "deliNo": 100008491,
        "deliMethodCd": 10,
        "deliProcTypCd": 10,
        "deliProcTypCdNm": "업체배송",
        "deliFnshDtm": "2023-12-31 00:00:00",
        "puTypCd": 20,
        "dlvpNm": "자택",
        "rcvmnNm": "홍길동",
        "dlvpSeq": 1,
        "zipNo": "05836",
        "zipAddr": "서울 송파구 법원로9길 26",
        "dtlAddr": "에이치비지니스파크 D동 6층",
        "dlvZipNo": "05836",
        "dlvZipAddr": "서울 송파구 법원로9길 26",
        "dlvDtlAddr": "에이치비지니스파크 D동 6층",
        "rcvmnEmailAddr": "[e-mail]",
        "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": "[e-mail]",
          "rcvmnCellSctNo": "010",
          "rcvmnCellTxnoNo": 1234,
          "rcvmnCellEndNo": 5678,
          "rcvmnTelRgnNo": "02",
          "rcvmnTelTxnoNo": 123,
          "rcvmnTelEndNo": 4567,
          "deliMsg": "부재 시 문 앞에 놓아주세요.",
          "deliMsgCd": 30,
          "shopTrafMsg": "문 앞에 놓아주세요.",
          "comnFrdrCogoMethodCd": 20,
          "comnFrdrEtcMethod": "자유 출입 가능",
          "comnFrdrPwd": 1234
        },
        "orgDeliNo": 100000021,
        "withdrawalDeliNo": 100000001,
        "dlvpInfo": {
          "mbrOrdDlvpGb": 10,
          "dlvpSeq": 1,
          "zipNoSeq": 1,
          "dlvpNm": "집",
          "rcvmnNm": "홍길동",
          "zipNo": "05836",
          "zipAddr": "서울 송파구 법원로9길 26",
          "dtlAddr": "에이치비지니스파크 D동 6층",
          "rcvmnEmailAddr": "[e-mail]",
          "rcvmnCellSctNo": "010",
          "rcvmnCellTxnoNo": 1234,
          "rcvmnCellEndNo": 5678,
          "rcvmnTelRgnNo": "02",
          "rcvmnTelTxnoNo": 123,
          "rcvmnTelEndNo": 4567,
          "deliMsg": "부재 시 문 앞에 놓아주세요.",
          "deliMsgCd": 30,
          "shopTrafMsg": "문 앞에 놓아주세요.",
          "comnFrdrCogoMethodCd": 20,
          "comnFrdrEtcMethod": "자유 출입 가능",
          "comnFrdrPwd": 1234
        },
        "shippingDeliGbCd": true,
        "withdrawalDeliGbCd": true,
        "exchangeShipping": true,
        "withdrawShipping": true
      }
    ],
    "vbankPaymentPending": true,
    "allNonReturnable": true,
    "allEcoupon": true
  },
  "codeMap": {
    "ANY_ADDITIONAL_PROPERTY": [
      {
        "grpCd": "ME001",
        "cd": 11,
        "cdNm": "상품즉시할인",
        "cdDesc": "다국어 코드설명",
        "useYn": "Y",
        "sortSeq": 1,
        "ref1Val": "기준코드 참조1값에 대한 설명",
        "ref2Val": "기준코드 참조2값에 대한 설명",
        "ref3Val": "기준코드 참조3값에 대한 설명",
        "ref4Val": "기준코드 참조4값에 대한 설명",
        "ref5Val": "기준코드 참조5값에 대한 설명",
        "ref6Val": "기준코드 참조6값에 대한 설명",
        "ref7Val": "기준코드 참조7값에 대한 설명"
      }
    ]
  },
  "claimBusinessType": 11
}

반품완료

post

기능 설명

반품접수 완료처리 합니다.

상세 내용

• 주문 반품완료 API를 호출합니다. API URL : /api/order/v1/claim/return/completeReturn

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

클레임 처리 요청 DTO

systemTypestring · enum · min: 1Required

시스템유형

Example: 10Possible values:

claimBusinessTypestring · enum · min: 1Required

클레임 업무 유형

Example: 20Possible values:

ordMediaCdstring · min: 1Required

주문매체코드(OM007)

Example: 20

ordNostringOptional

주문번호

Example: 20230808O007404

mbrNostringOptional

회원번호

Example: 100001311

claimNostringOptional

클레임번호

Example: 20230808C010663

wthdFnshWaitProcCausstringOptional

회수완료 대기처리 사유

Responses

200

OK

No content

post

/v2/claim/return/completeReturn

HTTPcURLJavaScriptPython

POST /api/bo/v2/claim/return/completeReturn HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 3470

{
  "systemType": 10,
  "claimBusinessType": 20,
  "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
    }
  ],
  "claimCpnInfoList": [
    {
      "cpnNo": 104224
    }
  ],
  "claimReturnDlvp": {
    "mbrOrdDlvpGb": 10,
    "dlvpSeq": 1,
    "zipNoSeq": 1,
    "dlvpNm": "집",
    "rcvmnNm": "홍길동",
    "zipNo": "05836",
    "zipAddr": "서울 송파구 법원로9길 26",
    "dtlAddr": "에이치비지니스파크 D동 6층",
    "rcvmnEmailAddr": "[e-mail]",
    "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": "[e-mail]",
    "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": 20,
        "typeNm": "회수배송비",
        "goodsNoItmNo": 10002762001,
        "goodsNm": "상품명",
        "ordAmt": 6000,
        "discountMethod": 11,
        "discountMethodNm": "상품할인쿠폰",
        "cnclDcAmt": 2000,
        "rtnDlvBenefitInfoList": [
          {
            "promoNo": "C1003841",
            "promoNm": "무료반품쿠폰",
            "promoTypCd": 15,
            "ourChrgRate": 100,
            "entrChrgRate": 0,
            "cpnIsuNo": 4364872,
            "aplyYn": "Y"
          }
        ]
      }
    ],
    "refundPaymentMethodList": [
      {
        "payNo": 2,
        "ordNo": "20990101O000001",
        "claimNo": "20990101C000001",
        "uprPayNo": 1,
        "payGbCd": 10,
        "payGbCdNm": "결제",
        "payWayCd": 11,
        "payWayCdNm": "신용카드",
        "payStatCd": 12,
        "payStatCdNm": "결제완료",
        "payAmt": 10000,
        "rfdPsbAmt": 10000,
        "rfdAmt": 1000,
        "payFnshDtm": "2099-01-01 09:00:00.000000",
        "trdNo": "INIMX_CARDINIpayTest20990101090000685510",
        "trdDtm": "2099-01-01 09:00:00.000000",
        "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": "2099-01-01 09:00:00.000000",
        "sctnCnclPsbYn": "Y",
        "bankCd": 148,
        "bankCdNm": "국민은행",
        "actnNo": "계좌번호 암호화",
        "dpmnNm": "김플래티어",
        "dptFcstDt": "2099-01-01 09:00:00.000000",
        "dptCnfmDtm": "2099-01-01 09:00:00.000000",
        "rfdBankCd": 148,
        "rfdBankCdNm": "국민은행",
        "rfdActnNo": "계좌번호 암호화",
        "rfdActnDepositorNm": "홍길동"
      }
    ],
    "rfdInfoResponse": {
      "rfdBankCd": 203,
      "rfdBankNm": "KB국민은행",
      "rfdActnNo": "33330********",
      "rfdActnDepositorNm": "임성현",
      "rfdActnCertiYn": "Y"
    }
  },
  "wthdFnshWaitProcCaus": "text"
}

200

OK

No content

반품접수

post

기능 설명

반품대상을 접수처리 합니다.

상세 내용

• 주문 반품접수(BO) API를 호출합니다. API URL : /api/order/v1/claim/return/acceptReturn

---

수정번호

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

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

클레임 처리 요청 DTO

systemTypestring · enum · min: 1Required

시스템유형

Example: 10Possible values:

claimBusinessTypestring · enum · min: 1Required

클레임 업무 유형

Example: 20Possible values:

ordMediaCdstring · min: 1Required

주문매체코드(OM007)

Example: 20

ordNostringOptional

주문번호

Example: 20230808O007404

mbrNostringOptional

회원번호

Example: 100001311

claimNostringOptional

클레임번호

Example: 20230808C010663

wthdFnshWaitProcCausstringOptional

회수완료 대기처리 사유

Responses

200

OK

No content

post

/v2/claim/return/acceptReturn

HTTPcURLJavaScriptPython

POST /api/bo/v2/claim/return/acceptReturn HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 3470

{
  "systemType": 10,
  "claimBusinessType": 20,
  "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
    }
  ],
  "claimCpnInfoList": [
    {
      "cpnNo": 104224
    }
  ],
  "claimReturnDlvp": {
    "mbrOrdDlvpGb": 10,
    "dlvpSeq": 1,
    "zipNoSeq": 1,
    "dlvpNm": "집",
    "rcvmnNm": "홍길동",
    "zipNo": "05836",
    "zipAddr": "서울 송파구 법원로9길 26",
    "dtlAddr": "에이치비지니스파크 D동 6층",
    "rcvmnEmailAddr": "[e-mail]",
    "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": "[e-mail]",
    "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": 20,
        "typeNm": "회수배송비",
        "goodsNoItmNo": 10002762001,
        "goodsNm": "상품명",
        "ordAmt": 6000,
        "discountMethod": 11,
        "discountMethodNm": "상품할인쿠폰",
        "cnclDcAmt": 2000,
        "rtnDlvBenefitInfoList": [
          {
            "promoNo": "C1003841",
            "promoNm": "무료반품쿠폰",
            "promoTypCd": 15,
            "ourChrgRate": 100,
            "entrChrgRate": 0,
            "cpnIsuNo": 4364872,
            "aplyYn": "Y"
          }
        ]
      }
    ],
    "refundPaymentMethodList": [
      {
        "payNo": 2,
        "ordNo": "20990101O000001",
        "claimNo": "20990101C000001",
        "uprPayNo": 1,
        "payGbCd": 10,
        "payGbCdNm": "결제",
        "payWayCd": 11,
        "payWayCdNm": "신용카드",
        "payStatCd": 12,
        "payStatCdNm": "결제완료",
        "payAmt": 10000,
        "rfdPsbAmt": 10000,
        "rfdAmt": 1000,
        "payFnshDtm": "2099-01-01 09:00:00.000000",
        "trdNo": "INIMX_CARDINIpayTest20990101090000685510",
        "trdDtm": "2099-01-01 09:00:00.000000",
        "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": "2099-01-01 09:00:00.000000",
        "sctnCnclPsbYn": "Y",
        "bankCd": 148,
        "bankCdNm": "국민은행",
        "actnNo": "계좌번호 암호화",
        "dpmnNm": "김플래티어",
        "dptFcstDt": "2099-01-01 09:00:00.000000",
        "dptCnfmDtm": "2099-01-01 09:00:00.000000",
        "rfdBankCd": 148,
        "rfdBankCdNm": "국민은행",
        "rfdActnNo": "계좌번호 암호화",
        "rfdActnDepositorNm": "홍길동"
      }
    ],
    "rfdInfoResponse": {
      "rfdBankCd": 203,
      "rfdBankNm": "KB국민은행",
      "rfdActnNo": "33330********",
      "rfdActnDepositorNm": "임성현",
      "rfdActnCertiYn": "Y"
    }
  },
  "wthdFnshWaitProcCaus": "text"
}

200

OK

No content

반품주문조회

post

기능 설명

주문 반품 내역을 조회합니다.

상세 내용

• 주문내역구분(OM003) 반품(20) 으로, 반품 관련 주문내역 중 검색 조건에 부합하는 대상을 조회합니다.(→ 철회된 경우 제외)

• 파트너 사이트를 통해 접근한 경우, 로그인 정보의 협력사 번호가 검색 조건에 추가됩니다.(→ 협력사 상품 관련 주문건만 조회)

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

반품주문조회 요청 DTO

siteNostringOptional

사이트번호

Example: 1

entrNostringOptional

협력사번호

Example: 1000002

rtnAccpDtRngstring · enumOptional

반품접수일자범위

Example: 3Possible values:

rtnAccpStrDtstring · dateOptional

반품접수시작일자

Example: 2023-09-03

rtnAccpEndDtstring · dateOptional

반품접수종료일자

Example: 2023-09-06

loginIdstringOptional

로그인 ID

Example: helloWorld01

ordDtlStatCdstringOptional

주문내역상태코드(OM005)

Example: 11

ordNoArrstring[]Optional

주문번호배열

Example: ['20231231O000001', '20231231O000002']

ordManNmstringOptional

주문자명

Example: 홍길동

rcvmnNmstringOptional

수취인명

Example: 홍길동

ordManCellNostringOptional

주문자핸드폰번호

Example: 01023344556

rcvmnCellNostringOptional

수취인핸드폰번호

Example: 01023344556

zipNostringOptional

수취인우편번호

Example: 08739

ordGbCdstringOptional

주문내역구분코드(OM003)

Example: 10

deliKindCdstringOptional

배송종류코드(LO009)

Example: 10

claimCausCdstringOptional

클레임중분류코드(OM006)

Example: 300

goodsNoRngstring · enumOptional

상품검색범위코드

Example: stPossible values:

goodsNostringOptional

상품번호

Example: 10000001

goodsNoFromstringOptional

상품시작번호

Example: 10

goodsNoTostringOptional

상품종료번호

Example: 20

goodsNoArrstring[]Optional

상품번호배열

Example: ['10000001', '10000002']

goodsNmstringOptional

상품명

Example: 상품명

Responses

200

OK

*/*

totalCountinteger · int32Optional

post

/v1/claim/return/getReturnOrderList

HTTPcURLJavaScriptPython

POST /api/bo/v1/claim/return/getReturnOrderList HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 493

{
  "siteNo": 1,
  "entrNo": 1000002,
  "rtnAccpDtRng": 3,
  "rtnAccpStrDt": "2023-09-03",
  "rtnAccpEndDt": "2023-09-06",
  "loginId": "helloWorld01",
  "ordDtlStatCd": 11,
  "ordNoArr": "['20231231O000001', '20231231O000002']",
  "ordManNm": "홍길동",
  "rcvmnNm": "홍길동",
  "ordManCellNo": "01023344556",
  "rcvmnCellNo": "01023344556",
  "zipNo": "08739",
  "ordGbCd": 10,
  "deliKindCd": 10,
  "claimCausCd": 300,
  "goodsNoRng": "st",
  "goodsNo": 10000001,
  "goodsNoFrom": 10,
  "goodsNoTo": 20,
  "goodsNoArr": "['10000001', '10000002']",
  "goodsNm": "상품명"
}

200

OK

{
  "totalCount": 1,
  "payloads": [
    {
      "siteNm": "플래티어닷컴",
      "ordNo": "20231231O000001",
      "ordSeq": 1,
      "ordProcSeq": 2,
      "uprOrdProcSeq": 1,
      "claimNo": "20231231C000001",
      "ordDtlGbCd": 20,
      "ordDtlGbCdNm": "반품",
      "ordDtlStatCd": 32,
      "ordDtlStatCdNm": "반품접수",
      "ordAccpDtm": "2023-12-31 00:00:00",
      "ordFnshDtm": "2023-12-31 00:00:00",
      "ordQty": 0,
      "claimLgrpCd": 10,
      "claimLgrpCdNm": "단순변심",
      "claimMgrpCd": 300,
      "claimMgrpCdNm": "사이즈가 큼",
      "claimCausEtcCont": "사이즈가 생각보다 큽니다.",
      "wthdFnshGbCd": 10,
      "wthdFnshGbCdNm": "정상반품",
      "goodsNo": 10002297,
      "itmNo": "001",
      "goodsNm": "폴로티셔츠",
      "itmNm": "화이트>95",
      "brandNm": "플래티어",
      "mbrNo": 100001311,
      "loginId": "helloWorld01",
      "mbrMgrCd": 20,
      "mbrGradeCd": 20,
      "mbrGradeCdNm": "FAMILY",
      "instMbrYn": "N",
      "ordManNm": "홍길동",
      "ordManCellNo": "010-1324-3546",
      "ordManCellSctNo": "010",
      "ordManCellTxnoNo": 1324,
      "ordManCellEndNo": 3546,
      "rcvmnNm": "홍길동",
      "rcvmnCellSctNo": "010",
      "rcvmnCellTxnoNo": 1234,
      "rcvmnCellEndNo": 5678,
      "ordGbCdNm": "일반주문",
      "entrNm": "플래티어",
      "mbrGbCdNm": "정회원"
    }
  ]
}