Ctrlk
X2BEE Home
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Claim Common

Retrieve Changeable Item (SKU) List

post

Function Description

  • Retrieves the list of changeable items (SKUs)

--- ## Detailed Content * Provides the list of changeable items when changing the item of an order/exchange target product * Calls the Product API ( API URL : **/api/goods/v1/detail/otherItms** )

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Bodyobject · ClaimItmOtherInfoRequest[]

Order Changed SKU List Search Request DTO

goodsNostringOptional

Product No.

Example: 10002297
itmNostring[]Optional

Item No. List

stkQtyinteger · int64Optional

Stock Quantity

Responses
200

OK

*/*

Order Change Item (SKU) List Inquiry DTO

goodsNostringOptional

Product No.

Example: 1000001
reqIteNostringOptional

Item No. to Change

Example: 002
post/v1/claim/claimCommon/itmListOtherInfo
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
      }
    ]
  }
]

Retrieve Delivery Number Issuance List

post

Function Description

  • Retrieves the delivery number issuance list

Detailed Content

  • Issues new delivery numbers for as many entries as the length of the delivery number list (dlvpList) in the request data

  • Returns the list of issued delivery numbers as the result data

  • Calls the Delivery Number Issuance List Inquiry API ( API URL : /api/order/v1/claim/common/getNewNumberedDeliNo )

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body

Claim Delivery No. Request DTO

dlvpListstring[]Optional

Delivery No. List

Example: shipment
Responses
200

OK

*/*
string[]Optional
post/v1/claim/claimCommon/getNewNumberedDeliNo
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"
]

Retrieve Claim Detail History

post

Function Description

  • Retrieves claim detail history

--- ## Detailed Content * Provides the claim detail history corresponding to the requested order number and claim number * Provides order history information, claim product information, refund/payment history, coupons scheduled for refund, and delivery address information * Calls the Claim Detail History Inquiry API ( API URL : **/api/order/v1/claim/common/claimDetailsInfo** )

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body

Claim Detail Search Request DTO

ordNostringOptional

Order No.

Example: 20230808O007404
claimNostringOptional

Claim No.

Example: 20230801C008072
claimBusinessTypestring · enumOptional

Claim Business Type

Example: 20Possible values:
Responses
200

OK

*/*

Claim Detail Search Response DTO

post/v1/claim/claimCommon/claimDetailsInfo
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"
    }
  }
}

Retrieve Claim Cost Calculation

post

Function Description

  • Retrieves the claim cost calculation

--- ## Detailed Content * Provides additional payment/refund amount information and refund method information for the screen by claim task * Provides information for generating additional payment/refund scheduled data based on DB-level additional costs and benefit information, and coupon use/restoration information, during claim task processing * Calls the BO Claim Cost Calculation Inquiry API ( API URL : **/api/order/v1/claim/common/claimCalculateCost** )

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body

Claim Cost Calculation Search Request DTO

ordNostring · min: 1Required

Order No.

Example: 20230912O058151
ordMediaCdstring · min: 1Required

Order Channel Code (OM007)

orgClmNostringOptional

Current Claim No.

Example: 20230912C018562
newNumberedclmNostringOptional

Newly Issued Claim No.

Example: 20230912C018563
claimBusinessTypestring · enum · min: 1Required

Claim Business Type

Example: 11Possible values:
systemTypestring · enum · min: 1Required

System Type

Example: 10Possible values:
claimCalculateWorkTypestring · enum · min: 1Required

Claim Benefit/Cost Processing Task Type

Example: 10Possible values:
deliMethodCdstring · min: 1Required

Delivery Method Code (LO010)

Example: 10
selectedRtnDlvBenefitYnstring · enumOptional

Return Free Coupon Screen Selection Status

Example: NPossible values:
customerCauseFaultbooleanOptional
Responses
200

OK

*/*

Claim Cost Calculation Search Response DTO

ordNostringOptional

Order No.

Example: 20230808O007404
post/v1/claim/claimCommon/claimCalculateCost
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": "x2bee@plateer.com",
    "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": "x2bee@plateer.com",
    "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": "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,
      "withdrawalDeliNo": 100000001,
      "dlvpInfo": {
        "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
      },
      "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": "x2bee@plateer.com",
        "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"
    }
  }
}
PreviousOrder Exchange
NextModels

Last updated