클레임 공통

변경 가능 단품 목록 조회

post

기능설명

• 변경 가능 단품 목록 조회

--- ## 상세내용 * 주문/교환 대상 상품의 단품 변경 시 변경 가능한 단품 목록 제공 * 상품 API 호출 ( API URL : **/api/goods/v1/detail/otherItms** )

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Bodyobject[]

application/json

주문 변경 단품 목록 조회 요청 DTO

goodsNostringOptional

상품번호

Example: 10002297

itmNostring[]Optional

단품번호목록

stkQtyinteger · int64Optional

재고수량

Responses

200

OK

*/*

주문 변경 단품 목록 조회 DTO

goodsNostringOptional

상품번호

Example: 1000001

reqIteNostringOptional

변경할단품번호

Example: 002

post

/v1/claim/claimCommon/itmListOtherInfo

HTTPcURLJavaScriptPython

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

[
  {
    "goodsNo": 10002297,
    "itmNo": [
      "text"
    ],
    "stkQty": 1
  }
]

200

OK

[
  {
    "goodsNo": 1000001,
    "reqIteNo": "002",
    "itmNos": [
      {
        "goodsNo": 1000001,
        "itmNo": "001",
        "itmNm": "단품명",
        "stkQty": 1,
        "supPcost": 1000,
        "norPrc": 1000,
        "salePrc": 1000,
        "tsalePrc": 1000,
        "tsupPrc": 1000
      }
    ]
  }
]

배송 번호 채번 목록 조회

post

기능설명

• 배송 번호 채번 목록 조회

---

상세내용

• 요청 데이터의 배송번호 리스트(dlvpList)길이 만큼 신규 배송번호 채번

• 결과 데이터로 채번한 배송번호 목록 전달

• 배송 번호 채번 리스트 조회 API 호출 ( API URL : /api/order/v1/claim/common/getNewNumberedDeliNo )

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

클레임 배송번호 요청 DTO

dlvpListstring[]Optional

배송번호 리스트

Example: shipment

Responses

200

OK

*/*

string[]Optional

post

/v1/claim/claimCommon/getNewNumberedDeliNo

HTTPcURLJavaScriptPython

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

{
  "dlvpList": "shipment"
}

200

OK

[
  "text"
]

클레임 상세 내역 조회

post

기능설명

• 클레임 상세 내역을 조회

--- ## 상세내용 * 요청 주문번호, 클레임번호에 해당하는 클레임 상세 내역 제공 * 주문 내역 정보, 클레임 상품 정보, 환불/결제 내역, 환불예정쿠폰, 배송지정보 제공 * 클레임 상세 내역 조회 API 호출 ( API URL : **/api/order/v1/claim/common/claimDetailsInfo** )

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

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

ordNostringOptional

주문번호

Example: 20230808O007404

claimNostringOptional

클레임번호

Example: 20230801C008072

claimBusinessTypestring · enumOptional

클레임 업무 유형

Example: 20Possible values:

Responses

200

OK

*/*

클레임 상세 내역 조회 응답 DTO

post

/v1/claim/claimCommon/claimDetailsInfo

HTTPcURLJavaScriptPython

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

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

200

OK

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

클레임 비용 계산 조회

post

기능설명

• 클레임 비용 계산 조회

--- ## 상세내용 * 클레임 업무 별 화면 추가 결제/환불 금액 정보 및 환불수단 정보 제공 * 클레임 업무 처리 시 DB 기준 부가비용, 혜택정보 추가결제/환불 예정 데이터 생성 정보 및 쿠폰 사용/복원 정보 제공 * BO 클레임 비용 계산 조회 API 호출 ( API URL : **/api/order/v1/claim/common/claimCalculateCost** )

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

클레임 비용 계산 조회 요청 DTO

ordNostring · min: 1Required

주문번호

Example: 20230912O058151

ordMediaCdstring · min: 1Required

주문매체코드(OM007)

orgClmNostringOptional

현재 클레임 번호

Example: 20230912C018562

newNumberedclmNostringOptional

새로 채번된 클레임 번호

Example: 20230912C018563

claimBusinessTypestring · enum · min: 1Required

클레임 업무 유형

Example: 11Possible values:

systemTypestring · enum · min: 1Required

시스템유형

Example: 10Possible values:

claimCalculateWorkTypestring · enum · min: 1Required

클레임 혜택/비용 처리 업무 유형

Example: 10Possible values:

deliMethodCdstring · min: 1Required

배송방법코드(LO010)

Example: 10

selectedRtnDlvBenefitYnstring · enumOptional

반품무료쿠폰 화면선택여부

Example: NPossible values:

customerCauseFaultbooleanOptional

Responses

200

OK

*/*

클레임 비용 계산 조회 응답 DTO

ordNostringOptional

주문번호

Example: 20230808O007404

post

/v1/claim/claimCommon/claimCalculateCost

HTTPcURLJavaScriptPython

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

{
  "ordNo": "20230912O058151",
  "ordMediaCd": "text",
  "orgClmNo": "20230912C018562",
  "newNumberedclmNo": "20230912C018563",
  "claimBusinessType": 11,
  "systemType": 10,
  "claimCalculateWorkType": 10,
  "deliMethodCd": 10,
  "selectedRtnDlvBenefitYn": "N",
  "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
  },
  "withdrawalInfo": {
    "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
  },
  "rtnDlvBenefitInfo": {
    "promoNo": "C1003841",
    "promoNm": "무료반품쿠폰",
    "promoTypCd": 15,
    "ourChrgRate": 100,
    "entrChrgRate": 0,
    "cpnIsuNo": 4364872,
    "aplyYn": "Y"
  },
  "claimGoodsList": [
    {
      "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,
      "withDlvpInfo": {
        "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
      }
    }
  ],
  "customerCauseFault": true
}

200

OK

{
  "ordNo": "20230808O007404",
  "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"
    }
  }
}