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

Order Exchange

Withdraw Exchange Request (BO)

post

Function Description

  • Withdraws an exchange registration target in BO.

Detailed Description

  • Order No. (ordNo), Claim Business Type (claimBusinessType), and System Type (systemType) are required.

  • Exchange withdrawal is possible for targets that satisfy all of the following conditions:

    • Order History Type (OM003) value is Exchange (30)

    • Order History Status (OM005) value is Payment Pending (31), Exchange Registered (32), or Collection Instructed (34)

  • Updates the existing order exchange data and creates the order exchange withdrawal data.

  • Validates the payment information arising from the exchange withdrawal.

  • Performs stock adjustment processing.

Special Notes

  • Exchange withdrawal is processed only when the Claim Business Type (claimBusinessType) is Exchange Withdrawal (31).

Revision History

  • release_231009_01 : Added order quantity and cancel quantity columns to the order benefit relationship table

Header parameters
AuthorizationanyOptional

Access Token

Body

Claim Processing Request DTO

systemTypestring · enumRequired

SYSTEM (System Type) * 10 : FO * 20 : BO

Example: 10Possible values:
claimBusinessTypestring · enumRequired

ClaimBusiness (Claim Business Type) * 11 : Order Cancellation * 20 : Return Receipt * 21 : Return Cancellation * 30 : Exchange Receipt * 31 : Exchange Cancellation * 22 : Return Completed * 23 : Return Not Possible * 24 : Exchange Return * 25 : Return On Hold

Example: 11Possible values:
ordMediaCdstring · enumRequired

Order Channel Code (OM007) 10 : Phone Consultation (CC) , 20 : PC , 30 : Mobile Web , 40 : Android App , 50 : iOS App , 60 : Subscription Order

Example: 20Possible values:
ordNostringRequired

Order No.

Example: 20230808O007404
mbrNostringOptional

Member No.

Example: 100001311
claimNostringRequired

Claim No.

Example: 20230808C010663
wthdFnshWaitProcCausstringRequired

Pickup Completion Pending Reason

Example: 불량반품
occurPaymentbooleanOptional
existAddtionPayAmtbooleanOptional
claimBusinessstring · enumOptional

ClaimBusiness (Claim Business Type) * 11 : Order Cancellation * 20 : Return Receipt * 21 : Return Cancellation * 30 : Exchange Receipt * 31 : Exchange Cancellation * 22 : Return Completed * 23 : Return Not Possible * 24 : Exchange Return * 25 : Return On Hold

Example: 11Possible values:
Responses
200

Success

*/*
ordNostringOptional

Order No.

Example: 20230808O007404
claimNostringOptional

Claim No.

Example: 20230808C010663
post/v1/claim/exchange/withdrawalExchange
POST /api/order/v1/claim/exchange/withdrawalExchange HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 4998

{
  "systemType": "10",
  "claimBusinessType": "11",
  "ordMediaCd": "20",
  "ordNo": "20230808O007404",
  "mbrNo": "100001311",
  "claimNo": "20230808C010663",
  "claimGoodsList": [
    {
      "ordSeq": 1,
      "ordProcSeq": 1,
      "goodsNo": "10002297",
      "itmNo": "001",
      "exchangeGoodsNo": "10002297",
      "exchangeItmNo": "001",
      "exchangeItmNm": "001",
      "claimQty": 1,
      "claimLgrpCd": "10",
      "claimMgrpCd": "100",
      "claimCausEtcCont": "배송이 늦어짐",
      "withdrawalDeliNo": "100013106",
      "shipmentDeliNo": "100013105",
      "prOrdDtlAtchFileInfoList": [
        {
          "ordNo": "20230808O007404",
          "ordSeq": 1,
          "ordProcSeq": 1,
          "fileSeq": "1",
          "filePathNm": "files/order/2023/08/03/",
          "fileNm": "d732ec3b-e044-43ca-8ecb-80051b2b36f8_10.png"
        }
      ],
      "ordSeqAndOrdProcSeq": "text"
    }
  ],
  "paymentRequest": {
    "siteNo": "1",
    "orderInfo": {
      "ordNo": "20990101O000001",
      "claimNo": "20990101C000001",
      "goodsNm": "플래티어커피",
      "ordManNm": "김플래티어",
      "ordmnCellNo": 1012345678,
      "ordmnEmailAddr": "kim@plateer.com",
      "crcUnitCd": "KRW",
      "ordMediaCd": "30",
      "mbrNo": "100000001",
      "ordDtlGbCd": "10",
      "clientIp": "127.0.0.1",
      "taxFreeAmt": 1
    },
    "payInfoList": [
      {
        "payNo": "1",
        "payWayCd": "11",
        "payAmt": 1000,
        "mersNo": "1",
        "pgGbCd": "10",
        "trdNo": "INIMX_DBNKINIpayTest20990101090000685510",
        "selectCardCd": "01",
        "termlId": "INIBillTst",
        "billKey": "text",
        "authResultMap": "{P_STATUS:결과코드, P_RMESG1:결과메시지, P_TID:인증거래번호, P_AMT:거래금액, idc_name:IDC센터코드P_REQ_URL:승인요청 URL, P_NOTI:가맹점 임의 데이터}"
      }
    ]
  },
  "claimCpnInfoList": [
    {
      "cpnNo": "104224"
    }
  ],
  "claimReturnDlvp": {
    "mbrOrdDlvpGb": "10",
    "dlvpSeq": "1",
    "zipNoSeq": 1,
    "dlvpNm": "집",
    "rcvmnNm": "홍길동",
    "zipNo": 5836,
    "zipAddr": "서울 송파구 법원로9길 26",
    "dtlAddr": "에이치비지니스파크 D동 6층",
    "rcvmnEmailAddr": "x2bee@plateer.com",
    "rcvmnCellSctNo": "010",
    "rcvmnCellTxnoNo": "1234",
    "rcvmnCellEndNo": "5678",
    "rcvmnTelRgnNo": "02",
    "rcvmnTelTxnoNo": "123",
    "rcvmnTelEndNo": "4567",
    "deliMsg": "부재 시 문 앞에 놓아주세요.",
    "deliMsgCd": "30",
    "shopTrafMsg": "문 앞에 놓아주세요.",
    "comnFrdrCogoMethodCd": "20",
    "comnFrdrEtcMethod": "자유 출입 가능",
    "comnFrdrPwd": "1234"
  },
  "claimDlvp": {
    "mbrOrdDlvpGb": "10",
    "dlvpSeq": "1",
    "zipNoSeq": 1,
    "dlvpNm": "집",
    "rcvmnNm": "홍길동",
    "zipNo": 5836,
    "zipAddr": "서울 송파구 법원로9길 26",
    "dtlAddr": "에이치비지니스파크 D동 6층",
    "rcvmnEmailAddr": "x2bee@plateer.com",
    "rcvmnCellSctNo": "010",
    "rcvmnCellTxnoNo": "1234",
    "rcvmnCellEndNo": "5678",
    "rcvmnTelRgnNo": "02",
    "rcvmnTelTxnoNo": "123",
    "rcvmnTelEndNo": "4567",
    "deliMsg": "부재 시 문 앞에 놓아주세요.",
    "deliMsgCd": "30",
    "shopTrafMsg": "문 앞에 놓아주세요.",
    "comnFrdrCogoMethodCd": "20",
    "comnFrdrEtcMethod": "자유 출입 가능",
    "comnFrdrPwd": "1234"
  },
  "claimFinalAmtInfo": {
    "ordNo": "20230913O058186",
    "totAplyAdtnAmt": 6000,
    "totCnclAdtnAmt": 0,
    "totFvrAdtnAmt": 0,
    "totOrdPrc": 46000,
    "totDcAmt": 2200,
    "expectedRefundAmt": 37800,
    "addtionPayAmt": 0,
    "returnAcceptAmt": 37800,
    "refundAdditionAmtInfoList": [
      {
        "adtnOcurGbCd": "10",
        "adtnOcurGbNm": "발생",
        "type": "10",
        "typeNm": "회수배송비",
        "goodsNoItmNo": "10002762001",
        "goodsNm": "상품명",
        "ordAmt": 6000,
        "discountMethod": "11",
        "discountMethodNm": "상품할인쿠폰",
        "cnclDcAmt": 2000,
        "rtnDlvBenefitInfoList": [
          {
            "promoNo": "C1003841",
            "promoNm": "무료반품쿠폰",
            "promoTypCd": "11",
            "ourChrgRate": 100,
            "entrChrgRate": 0,
            "cpnIsuNo": "4364872",
            "aplyYn": "Y"
          }
        ],
        "reCalAdtnOcurGbCdAdtnAmt": 1
      }
    ],
    "refundPaymentMethodList": [
      {
        "payNo": "2",
        "mbrNo": "100000001",
        "ordNo": "20990101O000001",
        "claimNo": "20990101C000001",
        "uprPayNo": "1",
        "payGbCd": "10",
        "payGbCdNm": "결제",
        "payWayCd": "11",
        "payWayCdNm": "신용카드",
        "payStatCd": "12",
        "payStatCdNm": "결제완료",
        "payAmt": 10000,
        "taxFreeAmt": 10000,
        "rfdPsbAmt": 10000,
        "rfdAmt": 1000,
        "payFnshDtm": "2026-01-01T00:00:00.000Z",
        "trdNo": "INIMX_CARDINIpayTest20990101090000685510",
        "trdDtm": "2026-01-01T00:00:00.000Z",
        "iscmCd": "202",
        "iscmCdNm": "KB국민카드",
        "payReqCardcoCd": "06",
        "payReqCardcoCdNm": "국민카드",
        "cardNo": "카드번호 암호화",
        "cardNm": "국민카드",
        "cardValiTerm": "text",
        "nintDivYn": "N",
        "divMonCnt": 0,
        "cardPointUseYn": "N",
        "mersNo": "1",
        "acqrCd": "121",
        "acqrCdNm": "국민카드",
        "aprvNo": "12345678",
        "aprvDtm": "2026-01-01T00:00:00.000Z",
        "sctnCnclPsbYn": "Y",
        "bankCd": "148",
        "bankCdNm": "국민은행",
        "actnNo": "계좌번호 암호화",
        "dpmnNm": "김플래티어",
        "dptFcstDt": "2099-01-01 09:00:00.000000",
        "dptCnfmDtm": "2026-01-01T00:00:00.000Z",
        "rfdBankCd": "148",
        "rfdBankCdNm": "국민은행",
        "rfdActnNo": "계좌번호 암호화",
        "rfdActnDepositorNm": "홍길동",
        "vbankPaymentPending": true,
        "vbankDptCnfm": true
      }
    ],
    "paymentOrderInfo": {
      "ordNo": "20990101O000001",
      "claimNo": "20990101C000001",
      "goodsNm": "플래티어커피",
      "ordManNm": "김플래티어",
      "ordmnCellNo": 1012345678,
      "ordmnEmailAddr": "kim@plateer.com",
      "crcUnitCd": "KRW",
      "ordMediaCd": "30",
      "mbrNo": "100000001",
      "ordDtlGbCd": "10",
      "clientIp": "127.0.0.1",
      "taxFreeAmt": 1
    },
    "rfdInfoResponse": {
      "rfdBankCd": "203",
      "rfdBankNm": "KB국민은행",
      "rfdActnNo": "33330********",
      "rfdActnDepositorNm": "임성현",
      "rfdActnCertiYn": "Y"
    }
  },
  "wthdFnshWaitProcCaus": "불량반품",
  "occurPayment": true,
  "existAddtionPayAmt": true,
  "claimBusiness": "11"
}
{
  "ordNo": "20230808O007404",
  "claimNo": "20230808C010663"
}

Withdraw Exchange Request (FO)

post

Function Description

  • Withdraws an exchange registration target in FO.

Detailed Description

  • Order No. (ordNo), Claim Business Type (claimBusinessType), and System Type (systemType) are required.

  • Exchange withdrawal is possible for targets that satisfy all of the following conditions:

    • Order History Type (OM003) value is Exchange (30)

    • Order History Status (OM005) value is Payment Pending (31) or Exchange Registered (32)

  • Updates the existing order exchange data and creates the order exchange withdrawal data.

  • Validates the payment information arising from the exchange withdrawal.

  • Performs stock adjustment processing.

Header parameters
AuthorizationanyOptional

Access Token

Body

Claim Processing Request DTO

systemTypestring · enumRequired

SYSTEM (System Type) * 10 : FO * 20 : BO

Example: 10Possible values:
claimBusinessTypestring · enumRequired

ClaimBusiness (Claim Business Type) * 11 : Order Cancellation * 20 : Return Receipt * 21 : Return Cancellation * 30 : Exchange Receipt * 31 : Exchange Cancellation * 22 : Return Completed * 23 : Return Not Possible * 24 : Exchange Return * 25 : Return On Hold

Example: 11Possible values:
ordMediaCdstring · enumRequired

Order Channel Code (OM007) 10 : Phone Consultation (CC) , 20 : PC , 30 : Mobile Web , 40 : Android App , 50 : iOS App , 60 : Subscription Order

Example: 20Possible values:
ordNostringRequired

Order No.

Example: 20230808O007404
mbrNostringOptional

Member No.

Example: 100001311
claimNostringRequired

Claim No.

Example: 20230808C010663
wthdFnshWaitProcCausstringRequired

Pickup Completion Pending Reason

Example: 불량반품
occurPaymentbooleanOptional
existAddtionPayAmtbooleanOptional
claimBusinessstring · enumOptional

ClaimBusiness (Claim Business Type) * 11 : Order Cancellation * 20 : Return Receipt * 21 : Return Cancellation * 30 : Exchange Receipt * 31 : Exchange Cancellation * 22 : Return Completed * 23 : Return Not Possible * 24 : Exchange Return * 25 : Return On Hold

Example: 11Possible values:
Responses
200

Success

*/*
ordNostringOptional

Order No.

Example: 20230808O007404
claimNostringOptional

Claim No.

Example: 20230808C010663
post/v1/claim/exchange/withdrawalExchangeFO
POST /api/order/v1/claim/exchange/withdrawalExchangeFO HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 4998

{
  "systemType": "10",
  "claimBusinessType": "11",
  "ordMediaCd": "20",
  "ordNo": "20230808O007404",
  "mbrNo": "100001311",
  "claimNo": "20230808C010663",
  "claimGoodsList": [
    {
      "ordSeq": 1,
      "ordProcSeq": 1,
      "goodsNo": "10002297",
      "itmNo": "001",
      "exchangeGoodsNo": "10002297",
      "exchangeItmNo": "001",
      "exchangeItmNm": "001",
      "claimQty": 1,
      "claimLgrpCd": "10",
      "claimMgrpCd": "100",
      "claimCausEtcCont": "배송이 늦어짐",
      "withdrawalDeliNo": "100013106",
      "shipmentDeliNo": "100013105",
      "prOrdDtlAtchFileInfoList": [
        {
          "ordNo": "20230808O007404",
          "ordSeq": 1,
          "ordProcSeq": 1,
          "fileSeq": "1",
          "filePathNm": "files/order/2023/08/03/",
          "fileNm": "d732ec3b-e044-43ca-8ecb-80051b2b36f8_10.png"
        }
      ],
      "ordSeqAndOrdProcSeq": "text"
    }
  ],
  "paymentRequest": {
    "siteNo": "1",
    "orderInfo": {
      "ordNo": "20990101O000001",
      "claimNo": "20990101C000001",
      "goodsNm": "플래티어커피",
      "ordManNm": "김플래티어",
      "ordmnCellNo": 1012345678,
      "ordmnEmailAddr": "kim@plateer.com",
      "crcUnitCd": "KRW",
      "ordMediaCd": "30",
      "mbrNo": "100000001",
      "ordDtlGbCd": "10",
      "clientIp": "127.0.0.1",
      "taxFreeAmt": 1
    },
    "payInfoList": [
      {
        "payNo": "1",
        "payWayCd": "11",
        "payAmt": 1000,
        "mersNo": "1",
        "pgGbCd": "10",
        "trdNo": "INIMX_DBNKINIpayTest20990101090000685510",
        "selectCardCd": "01",
        "termlId": "INIBillTst",
        "billKey": "text",
        "authResultMap": "{P_STATUS:결과코드, P_RMESG1:결과메시지, P_TID:인증거래번호, P_AMT:거래금액, idc_name:IDC센터코드P_REQ_URL:승인요청 URL, P_NOTI:가맹점 임의 데이터}"
      }
    ]
  },
  "claimCpnInfoList": [
    {
      "cpnNo": "104224"
    }
  ],
  "claimReturnDlvp": {
    "mbrOrdDlvpGb": "10",
    "dlvpSeq": "1",
    "zipNoSeq": 1,
    "dlvpNm": "집",
    "rcvmnNm": "홍길동",
    "zipNo": 5836,
    "zipAddr": "서울 송파구 법원로9길 26",
    "dtlAddr": "에이치비지니스파크 D동 6층",
    "rcvmnEmailAddr": "x2bee@plateer.com",
    "rcvmnCellSctNo": "010",
    "rcvmnCellTxnoNo": "1234",
    "rcvmnCellEndNo": "5678",
    "rcvmnTelRgnNo": "02",
    "rcvmnTelTxnoNo": "123",
    "rcvmnTelEndNo": "4567",
    "deliMsg": "부재 시 문 앞에 놓아주세요.",
    "deliMsgCd": "30",
    "shopTrafMsg": "문 앞에 놓아주세요.",
    "comnFrdrCogoMethodCd": "20",
    "comnFrdrEtcMethod": "자유 출입 가능",
    "comnFrdrPwd": "1234"
  },
  "claimDlvp": {
    "mbrOrdDlvpGb": "10",
    "dlvpSeq": "1",
    "zipNoSeq": 1,
    "dlvpNm": "집",
    "rcvmnNm": "홍길동",
    "zipNo": 5836,
    "zipAddr": "서울 송파구 법원로9길 26",
    "dtlAddr": "에이치비지니스파크 D동 6층",
    "rcvmnEmailAddr": "x2bee@plateer.com",
    "rcvmnCellSctNo": "010",
    "rcvmnCellTxnoNo": "1234",
    "rcvmnCellEndNo": "5678",
    "rcvmnTelRgnNo": "02",
    "rcvmnTelTxnoNo": "123",
    "rcvmnTelEndNo": "4567",
    "deliMsg": "부재 시 문 앞에 놓아주세요.",
    "deliMsgCd": "30",
    "shopTrafMsg": "문 앞에 놓아주세요.",
    "comnFrdrCogoMethodCd": "20",
    "comnFrdrEtcMethod": "자유 출입 가능",
    "comnFrdrPwd": "1234"
  },
  "claimFinalAmtInfo": {
    "ordNo": "20230913O058186",
    "totAplyAdtnAmt": 6000,
    "totCnclAdtnAmt": 0,
    "totFvrAdtnAmt": 0,
    "totOrdPrc": 46000,
    "totDcAmt": 2200,
    "expectedRefundAmt": 37800,
    "addtionPayAmt": 0,
    "returnAcceptAmt": 37800,
    "refundAdditionAmtInfoList": [
      {
        "adtnOcurGbCd": "10",
        "adtnOcurGbNm": "발생",
        "type": "10",
        "typeNm": "회수배송비",
        "goodsNoItmNo": "10002762001",
        "goodsNm": "상품명",
        "ordAmt": 6000,
        "discountMethod": "11",
        "discountMethodNm": "상품할인쿠폰",
        "cnclDcAmt": 2000,
        "rtnDlvBenefitInfoList": [
          {
            "promoNo": "C1003841",
            "promoNm": "무료반품쿠폰",
            "promoTypCd": "11",
            "ourChrgRate": 100,
            "entrChrgRate": 0,
            "cpnIsuNo": "4364872",
            "aplyYn": "Y"
          }
        ],
        "reCalAdtnOcurGbCdAdtnAmt": 1
      }
    ],
    "refundPaymentMethodList": [
      {
        "payNo": "2",
        "mbrNo": "100000001",
        "ordNo": "20990101O000001",
        "claimNo": "20990101C000001",
        "uprPayNo": "1",
        "payGbCd": "10",
        "payGbCdNm": "결제",
        "payWayCd": "11",
        "payWayCdNm": "신용카드",
        "payStatCd": "12",
        "payStatCdNm": "결제완료",
        "payAmt": 10000,
        "taxFreeAmt": 10000,
        "rfdPsbAmt": 10000,
        "rfdAmt": 1000,
        "payFnshDtm": "2026-01-01T00:00:00.000Z",
        "trdNo": "INIMX_CARDINIpayTest20990101090000685510",
        "trdDtm": "2026-01-01T00:00:00.000Z",
        "iscmCd": "202",
        "iscmCdNm": "KB국민카드",
        "payReqCardcoCd": "06",
        "payReqCardcoCdNm": "국민카드",
        "cardNo": "카드번호 암호화",
        "cardNm": "국민카드",
        "cardValiTerm": "text",
        "nintDivYn": "N",
        "divMonCnt": 0,
        "cardPointUseYn": "N",
        "mersNo": "1",
        "acqrCd": "121",
        "acqrCdNm": "국민카드",
        "aprvNo": "12345678",
        "aprvDtm": "2026-01-01T00:00:00.000Z",
        "sctnCnclPsbYn": "Y",
        "bankCd": "148",
        "bankCdNm": "국민은행",
        "actnNo": "계좌번호 암호화",
        "dpmnNm": "김플래티어",
        "dptFcstDt": "2099-01-01 09:00:00.000000",
        "dptCnfmDtm": "2026-01-01T00:00:00.000Z",
        "rfdBankCd": "148",
        "rfdBankCdNm": "국민은행",
        "rfdActnNo": "계좌번호 암호화",
        "rfdActnDepositorNm": "홍길동",
        "vbankPaymentPending": true,
        "vbankDptCnfm": true
      }
    ],
    "paymentOrderInfo": {
      "ordNo": "20990101O000001",
      "claimNo": "20990101C000001",
      "goodsNm": "플래티어커피",
      "ordManNm": "김플래티어",
      "ordmnCellNo": 1012345678,
      "ordmnEmailAddr": "kim@plateer.com",
      "crcUnitCd": "KRW",
      "ordMediaCd": "30",
      "mbrNo": "100000001",
      "ordDtlGbCd": "10",
      "clientIp": "127.0.0.1",
      "taxFreeAmt": 1
    },
    "rfdInfoResponse": {
      "rfdBankCd": "203",
      "rfdBankNm": "KB국민은행",
      "rfdActnNo": "33330********",
      "rfdActnDepositorNm": "임성현",
      "rfdActnCertiYn": "Y"
    }
  },
  "wthdFnshWaitProcCaus": "불량반품",
  "occurPayment": true,
  "existAddtionPayAmt": true,
  "claimBusiness": "11"
}
{
  "ordNo": "20230808O007404",
  "claimNo": "20230808C010663"
}

Check Whether Exchange Target Product Option Can Be Changed

post

Function Description

  • Checks in BO whether the exchange claim option change target is valid.

Detailed Description

  • Product No. (goodsNo) and Unit Item No. (itmNo) are required.

  • Checks all of the following conditions:

    • Checks whether the Sales Status Code (PR005) of the option change target is On Sale (10).

    • Checks whether the Sales Method Code (PR003) of the option change target is General Sale (10).

    • Checks whether the option change target has the same price as the existing target.

    • Checks the stock of the option change target.

Header parameters
AuthorizationanyOptional

Access Token

Bodyobject · ClaimGoodsItmInfoRequest[]

Exchange Claim Option Change Target Request DTO

goodsNostringRequired

Product No.

Default: 10001861Example: 10001861
itmNostringRequired

Item No.

Default: 001Example: 001
claimQtyinteger · int32Optional

Claim Quantity

Default: 1Example: 1
salePrcinteger · int64Optional

Selling Price

Example: 25000
Responses
200

Success

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

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

Retrieve Return/Exchange Withdrawal Targets

post

Function Description

  • Retrieves return/exchange withdrawal targets in BO.

Detailed Description

  • Order No. (ordNo) and System Type (systemType) are required.

  • Return/exchange withdrawal processing is possible for targets that satisfy all of the following conditions:

    • Order History Type (OM003) value is Return (20) or Exchange (30)

    • Order History Status (OM005) value is Payment Pending (31), Return/Exchange Registered (32), or Collection Instructed (32)

    • Return Availability (rtnPsbYn) value is Y

    • The item is a general product (excluding free gifts)

    • Withdrawable quantity is 1 or more ( Order Quantity – Cancel Quantity – Return Quantity > 0 )

Revision History

  • release_231204_01 : Deprecated; moved to the common claim API (changed API path: api/order/v1/claim/common/getReturnExchangeCancelTargetInfo)

Header parameters
AuthorizationanyOptional

Access Token

Body

Claim Eligibility Search Request DTO

ordNostringRequired

Order No.

Example: 20230808O007404
claimBusinessTypestring · enumOptional

ClaimBusiness (Claim Business Type) * 11 : Order Cancellation * 20 : Return Receipt * 21 : Return Cancellation * 30 : Exchange Receipt * 31 : Exchange Cancellation * 22 : Return Completed * 23 : Return Not Possible * 24 : Exchange Return * 25 : Return On Hold

Example: 11Possible values:
orgClmNostringOptional

Original Claim No.

Example: 20230808C010663
systemTypestring · enumRequired

SYSTEM (System Type) * 10 : FO * 20 : BO

Default: 20Example: 10Possible values:
dlvpSeqstringOptional

Delivery Address Sequence No.

Example: 1
systemCdNmAndButtonCodestringOptional
claimBusinessstring · enumOptional

ClaimBusiness (Claim Business Type) * 11 : Order Cancellation * 20 : Return Receipt * 21 : Return Cancellation * 30 : Exchange Receipt * 31 : Exchange Cancellation * 22 : Return Completed * 23 : Return Not Possible * 24 : Exchange Return * 25 : Return On Hold

Example: 11Possible values:
systemstring · enumOptional

SYSTEM (System Type) * 10 : FO * 20 : BO

Example: 10Possible values:
Responses
200

Success

*/*

Claim Processing Target Response DTO

ordNostringOptional

Order No.

Example: 20231231O000001
mbrNostringOptional

Member No.

Example: 100001311
mbrGradeCdstring · enumOptional

Member Grade Code (ME008) 10 : GREEN , 20 : FAMILY , 30 : GOLD , 40 : VIP , 50 : VVIP

Example: 10Possible values:
ordGbCdstring · enumOptional

OM002 (Order Classification Code) 10: General Order , 20: Gift , 30: E-Coupon , 40: Affiliate

Example: 10Possible values:
mbrMgrCdstring · enumOptional

ME002 (Member Management Code) 10: UNION_MEMBER (Integrated Member) ,20: GENERAL_MEMBER (General Member) ,30: SOCIAL_MEMBER (Social Member) ,99: NO_MEMBER (Non-Member)

Example: 10Possible values:
ordManNmstringOptional

Orderer Name

Example: 홍길동
ordManEmailAddrstringOptional

Orderer Email Address

Example: test@plateer.com
ordManCellSctNostringOptional

Orderer's Mobile Phone Prefix Code

Example: 010
ordManCellTxnoNostringOptional

Orderer's Mobile Phone Exchange Code

Example: 1234
ordManCellEndNostringOptional

Orderer's Mobile Phone Last Digits

Example: 5678
ordMediaCdstring · enumOptional

Order Channel Code (OM007) 10 : Phone Consultation (CC) , 20 : PC , 30 : Mobile Web , 40 : Android App , 50 : iOS App , 60 : Subscription Order

Example: 20Possible values:
ordAccpDtmstring · date-timeOptional

Order Receipt Date

sctnCnclPsbYnstring · enumOptional

Partial Cancellation Availability Status

Example: NPossible values:
allNonReturnablebooleanOptional
vbankPaymentPendingbooleanOptional
allEcouponbooleanOptional
post/v1/claim/exchange/getReturnExchangeCancelTargetInfo
POST /api/order/v1/claim/exchange/getReturnExchangeCancelTargetInfo HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 181

{
  "ordNo": "20230808O007404",
  "claimBusinessType": "11",
  "orgClmNo": "20230808C010663",
  "systemType": "10",
  "dlvpSeq": "1",
  "systemCdNmAndButtonCode": "text",
  "claimBusiness": "11",
  "system": "10"
}
{
  "ordNo": "20231231O000001",
  "mbrNo": "100001311",
  "mbrGradeCd": "10",
  "ordGbCd": "10",
  "mbrMgrCd": "10",
  "ordManNm": "홍길동",
  "ordManEmailAddr": "test@plateer.com",
  "ordManCellSctNo": "010",
  "ordManCellTxnoNo": "1234",
  "ordManCellEndNo": "5678",
  "ordMediaCd": "20",
  "ordAccpDtm": "2026-01-01T00:00:00.000Z",
  "sctnCnclPsbYn": "N",
  "claimTargetGoodsResponseList": [
    {
      "goodsNo": "10002297",
      "deliProcTypCd": "10",
      "deliPolcNo": "10000151",
      "deliNo": "100000021",
      "entrNo": "1000002",
      "ordQty": 1,
      "salePrc": 30000,
      "dcAmt": 3000,
      "sysModDtm": "2026-01-01T00:00:00.000Z",
      "ordNo": "20231231O000001",
      "ordSeq": 1,
      "ordProcSeq": 1,
      "uprOrdProcSeq": 1,
      "maxOrdProcSeq": 1,
      "claimNo": "20231231C000001",
      "itmNo": "001",
      "ordDtlGbCd": "10",
      "ordDtlGbCdNm": "주문일반",
      "ordDtlStatCd": "10",
      "ordDtlStatCdNm": "접수",
      "deliGbCd": "10",
      "ordAccpDtm": "2026-01-01T00:00:00.000Z",
      "ordFnshDtm": "2026-01-01T00:00:00.000Z",
      "cnclQty": 0,
      "rtnQty": 0,
      "claimQty": 0,
      "claimPossibleQty": 5,
      "deliIndiDtm": "2026-01-01T00:00:00.000Z",
      "deliIndiRsvDtm": "2026-01-01T00:00:00.000Z",
      "exchMidRtnYn": "N",
      "rtnPsbYn": "N",
      "exchPsbYn": "N",
      "ordCnclPsbYn": "N",
      "wthdYn": "Y",
      "ecpnNo": "ORD0001",
      "etcktNo": "ORD0001",
      "claimLgrpCd": "10",
      "claimLgrpCdNm": "단순변심",
      "claimMgrpCd": "100",
      "claimMgrpCdNm": "사이즈가 큼",
      "claimCausEtcCont": "사이즈가 생각보다 큽니다.",
      "ordSaleTypCd": "10",
      "chlNo": "1000001",
      "chlDtlNo": "1000001",
      "stdCtgNo": "HT01020000",
      "infDispCtgNoGbCd": "10",
      "infDispCtgNo": "213",
      "repDispCtgNo": "213",
      "conrNo": "10050",
      "brandNo": "100002",
      "brandNm": "플래티어",
      "goodsNm": "폴로티셔츠",
      "goodsImg": "files/goods/2023/12/31/goodsImg.jpg",
      "itmNm": "화이트>95",
      "prestNm": "우산 증정",
      "goodsCompCd": "10",
      "goodsTypCd": "10",
      "saleMethCd": "10",
      "taxGbCd": "01",
      "buyTypCd": "10",
      "supPcost": 14400,
      "norPrc": 25000,
      "mrgnRate": 4,
      "deliDday": 1,
      "deliGoodsGbCd": "10",
      "deliWayCd": "10",
      "bpckPsbYn": "Y",
      "hsCd": "0101",
      "goodsRevWrtYn": "N",
      "bnfAmt": 2000,
      "ordPrc": 25000,
      "aeGoodsYn": "N",
      "withdrawalDeliNo": "100000001",
      "shipmentDeliNo": "100000001",
      "deliTypCd": "10",
      "deliKindCd": "10",
      "deliMethodCd": "10",
      "deliProcTypCdNm": "업체배송",
      "puTypCd": "20",
      "wthdFnshGbCd": "10",
      "dlvpNm": "자택",
      "rcvmnNm": "홍길동",
      "dlvpSeq": "1",
      "maxDlvpSeq": "1",
      "zipNo": 5836,
      "zipAddr": "서울 송파구 법원로9길 26",
      "dtlAddr": "에이치비지니스파크 D동 6층",
      "rcvmnEmailAddr": "sample@plateer.com",
      "rcvmnCellSctNo": "010",
      "rcvmnCellTxnoNo": "1122",
      "rcvmnCellEndNo": "3546",
      "rcvmnTelRgnNo": "02",
      "rcvmnTelTxnoNo": "112",
      "rcvmnTelEndNo": "3546",
      "deliMsg": "부재시 문앞에 두고 가주세요",
      "deliMsgCd": "70",
      "shopTrafMsg": "없음",
      "comnFrdrCogoMethodCd": "10",
      "comnFrdrEtcMethod": "없음",
      "comnFrdrPwd": "1234",
      "orgDlvpInfo": {
        "mbrOrdDlvpGb": "10",
        "dlvpSeq": "1",
        "zipNoSeq": 1,
        "dlvpNm": "집",
        "rcvmnNm": "홍길동",
        "zipNo": 5836,
        "zipAddr": "서울 송파구 법원로9길 26",
        "dtlAddr": "에이치비지니스파크 D동 6층",
        "rcvmnEmailAddr": "x2bee@plateer.com",
        "rcvmnCellSctNo": "010",
        "rcvmnCellTxnoNo": "1234",
        "rcvmnCellEndNo": "5678",
        "rcvmnTelRgnNo": "02",
        "rcvmnTelTxnoNo": "123",
        "rcvmnTelEndNo": "4567",
        "deliMsg": "부재 시 문 앞에 놓아주세요.",
        "deliMsgCd": "30",
        "shopTrafMsg": "문 앞에 놓아주세요.",
        "comnFrdrCogoMethodCd": "20",
        "comnFrdrEtcMethod": "자유 출입 가능",
        "comnFrdrPwd": "1234"
      },
      "orgDeliNo": "100000021",
      "lastDeliResponse": {
        "ordNo": "text",
        "deliNo": "text",
        "ordSeq": "text",
        "ordProcSeq": "text",
        "shipIndiDtm": "2026-01-01T00:00:00.000Z",
        "shipCfmDtm": "2026-01-01T00:00:00.000Z",
        "shipFnshDtm": "2026-01-01T00:00:00.000Z",
        "deliFnshDtm": "2026-01-01T00:00:00.000Z",
        "hdcCd": "text",
        "invNo": "text",
        "deliDtlStatCd": "text"
      },
      "shippingDeliGbCd": true,
      "opOrdDtlUpdateKey": {
        "ordNo": "text",
        "ordSeq": 1,
        "ordProcSeq": 1,
        "uprOrdProcSeq": 1,
        "claimNo": "text",
        "goodsNo": "text",
        "itmNo": "text",
        "ordDtlGbCd": "text",
        "deliGbCd": "text",
        "ordAccpDtm": "2026-01-01T00:00:00.000Z",
        "ordFnshDtm": "2026-01-01T00:00:00.000Z",
        "ordDtlStatCd": "text",
        "ordQty": 1,
        "cnclQty": 1,
        "rtnQty": 1,
        "deliIndiDtm": "2026-01-01T00:00:00.000Z",
        "deliIndiRsvDtm": "2026-01-01T00:00:00.000Z",
        "deliNo": "text",
        "exchMidRtnYn": "text",
        "claimLgrpCd": "text",
        "claimMgrpCd": "text",
        "claimCausEtcCont": "text",
        "rtnPsbYn": "text",
        "exchPsbYn": "text",
        "ordCnclPsbYn": "text",
        "wthdYn": "text",
        "wthdFnshGbCd": "text",
        "shipFnshFcstDtm": "2026-01-01T00:00:00.000Z",
        "etcktNo": "text",
        "ecpnNo": "text"
      },
      "generalSalesProduct": true,
      "exchangeShipping": true,
      "withdrawalDeliGbCd": true,
      "withdrawShipping": true,
      "ordSeqAndUprOrdProcSeq": "text",
      "goodsNoAndItmNo": "text",
      "ordSeqAndOrdProcSeq": "text"
    }
  ],
  "allNonReturnable": true,
  "vbankPaymentPending": true,
  "allEcoupon": true
}

Search Exchange Targets (BO)

post

Function Description

  • Retrieves order exchange targets in BO.

Detailed Description

  • Order No. (ordNo), Claim Business Type (claimBusinessType), and System Type (systemType) are required.

  • Exchange registration processing is possible for targets that satisfy all of the following conditions:

    • Order History Type (OM003) value is General Order (10) or Exchange (30)

    • Order History Status (OM005) value is Shipped (26) or Delivered (27)

    • Return Availability (rtnPsbYn) value is Y

    • The item is a general product (excluding free gifts)

    • Exchangeable quantity is 1 or more ( Order Quantity – Cancel Quantity – Return Quantity > 0 )

Special Notes

  • Retrieves exchange targets when the Claim Business Type (claimBusinessType) is Exchange (30).

Revision History

  • release_231204_01 : Added delivery address sequence No. (dlvpSeq) to the request DTO; when a delivery address sequence value is present at target lookup, additional filtering by it is applied

  • release v2.00_240409 : Fixed a typo in the response DTO ( CaimTargetResponse -> ClaimTargetResponse )

  • Release v2.00_240729 : Added collection status (wthdYn), non-returnable order flag (isAllNonReturnable)

Header parameters
AuthorizationanyOptional

Access Token

Body

Claim Eligibility Search Request DTO

ordNostringRequired

Order No.

Example: 20230808O007404
claimBusinessTypestring · enumOptional

ClaimBusiness (Claim Business Type) * 11 : Order Cancellation * 20 : Return Receipt * 21 : Return Cancellation * 30 : Exchange Receipt * 31 : Exchange Cancellation * 22 : Return Completed * 23 : Return Not Possible * 24 : Exchange Return * 25 : Return On Hold

Example: 11Possible values:
orgClmNostringOptional

Original Claim No.

Example: 20230808C010663
systemTypestring · enumRequired

SYSTEM (System Type) * 10 : FO * 20 : BO

Default: 20Example: 10Possible values:
dlvpSeqstringOptional

Delivery Address Sequence No.

Example: 1
systemCdNmAndButtonCodestringOptional
claimBusinessstring · enumOptional

ClaimBusiness (Claim Business Type) * 11 : Order Cancellation * 20 : Return Receipt * 21 : Return Cancellation * 30 : Exchange Receipt * 31 : Exchange Cancellation * 22 : Return Completed * 23 : Return Not Possible * 24 : Exchange Return * 25 : Return On Hold

Example: 11Possible values:
systemstring · enumOptional

SYSTEM (System Type) * 10 : FO * 20 : BO

Example: 10Possible values:
Responses
200

Success

*/*

Search Order Exchange-Eligible Targets Response DTO

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

{
  "ordNo": "20230808O007404",
  "claimBusinessType": "11",
  "orgClmNo": "20230808C010663",
  "systemType": "10",
  "dlvpSeq": "1",
  "systemCdNmAndButtonCode": "text",
  "claimBusiness": "11",
  "system": "10"
}
{
  "claimTargetResponse": {
    "ordNo": "20231231O000001",
    "mbrNo": "100001311",
    "mbrGradeCd": "10",
    "ordGbCd": "10",
    "mbrMgrCd": "10",
    "ordManNm": "홍길동",
    "ordManEmailAddr": "test@plateer.com",
    "ordManCellSctNo": "010",
    "ordManCellTxnoNo": "1234",
    "ordManCellEndNo": "5678",
    "ordMediaCd": "20",
    "ordAccpDtm": "2026-01-01T00:00:00.000Z",
    "sctnCnclPsbYn": "N",
    "claimTargetGoodsResponseList": [
      {
        "goodsNo": "10002297",
        "deliProcTypCd": "10",
        "deliPolcNo": "10000151",
        "deliNo": "100000021",
        "entrNo": "1000002",
        "ordQty": 1,
        "salePrc": 30000,
        "dcAmt": 3000,
        "sysModDtm": "2026-01-01T00:00:00.000Z",
        "ordNo": "20231231O000001",
        "ordSeq": 1,
        "ordProcSeq": 1,
        "uprOrdProcSeq": 1,
        "maxOrdProcSeq": 1,
        "claimNo": "20231231C000001",
        "itmNo": "001",
        "ordDtlGbCd": "10",
        "ordDtlGbCdNm": "주문일반",
        "ordDtlStatCd": "10",
        "ordDtlStatCdNm": "접수",
        "deliGbCd": "10",
        "ordAccpDtm": "2026-01-01T00:00:00.000Z",
        "ordFnshDtm": "2026-01-01T00:00:00.000Z",
        "cnclQty": 0,
        "rtnQty": 0,
        "claimQty": 0,
        "claimPossibleQty": 5,
        "deliIndiDtm": "2026-01-01T00:00:00.000Z",
        "deliIndiRsvDtm": "2026-01-01T00:00:00.000Z",
        "exchMidRtnYn": "N",
        "rtnPsbYn": "N",
        "exchPsbYn": "N",
        "ordCnclPsbYn": "N",
        "wthdYn": "Y",
        "ecpnNo": "ORD0001",
        "etcktNo": "ORD0001",
        "claimLgrpCd": "10",
        "claimLgrpCdNm": "단순변심",
        "claimMgrpCd": "100",
        "claimMgrpCdNm": "사이즈가 큼",
        "claimCausEtcCont": "사이즈가 생각보다 큽니다.",
        "ordSaleTypCd": "10",
        "chlNo": "1000001",
        "chlDtlNo": "1000001",
        "stdCtgNo": "HT01020000",
        "infDispCtgNoGbCd": "10",
        "infDispCtgNo": "213",
        "repDispCtgNo": "213",
        "conrNo": "10050",
        "brandNo": "100002",
        "brandNm": "플래티어",
        "goodsNm": "폴로티셔츠",
        "goodsImg": "files/goods/2023/12/31/goodsImg.jpg",
        "itmNm": "화이트>95",
        "prestNm": "우산 증정",
        "goodsCompCd": "10",
        "goodsTypCd": "10",
        "saleMethCd": "10",
        "taxGbCd": "01",
        "buyTypCd": "10",
        "supPcost": 14400,
        "norPrc": 25000,
        "mrgnRate": 4,
        "deliDday": 1,
        "deliGoodsGbCd": "10",
        "deliWayCd": "10",
        "bpckPsbYn": "Y",
        "hsCd": "0101",
        "goodsRevWrtYn": "N",
        "bnfAmt": 2000,
        "ordPrc": 25000,
        "aeGoodsYn": "N",
        "withdrawalDeliNo": "100000001",
        "shipmentDeliNo": "100000001",
        "deliTypCd": "10",
        "deliKindCd": "10",
        "deliMethodCd": "10",
        "deliProcTypCdNm": "업체배송",
        "puTypCd": "20",
        "wthdFnshGbCd": "10",
        "dlvpNm": "자택",
        "rcvmnNm": "홍길동",
        "dlvpSeq": "1",
        "maxDlvpSeq": "1",
        "zipNo": 5836,
        "zipAddr": "서울 송파구 법원로9길 26",
        "dtlAddr": "에이치비지니스파크 D동 6층",
        "rcvmnEmailAddr": "sample@plateer.com",
        "rcvmnCellSctNo": "010",
        "rcvmnCellTxnoNo": "1122",
        "rcvmnCellEndNo": "3546",
        "rcvmnTelRgnNo": "02",
        "rcvmnTelTxnoNo": "112",
        "rcvmnTelEndNo": "3546",
        "deliMsg": "부재시 문앞에 두고 가주세요",
        "deliMsgCd": "70",
        "shopTrafMsg": "없음",
        "comnFrdrCogoMethodCd": "10",
        "comnFrdrEtcMethod": "없음",
        "comnFrdrPwd": "1234",
        "orgDlvpInfo": {
          "mbrOrdDlvpGb": "10",
          "dlvpSeq": "1",
          "zipNoSeq": 1,
          "dlvpNm": "집",
          "rcvmnNm": "홍길동",
          "zipNo": 5836,
          "zipAddr": "서울 송파구 법원로9길 26",
          "dtlAddr": "에이치비지니스파크 D동 6층",
          "rcvmnEmailAddr": "x2bee@plateer.com",
          "rcvmnCellSctNo": "010",
          "rcvmnCellTxnoNo": "1234",
          "rcvmnCellEndNo": "5678",
          "rcvmnTelRgnNo": "02",
          "rcvmnTelTxnoNo": "123",
          "rcvmnTelEndNo": "4567",
          "deliMsg": "부재 시 문 앞에 놓아주세요.",
          "deliMsgCd": "30",
          "shopTrafMsg": "문 앞에 놓아주세요.",
          "comnFrdrCogoMethodCd": "20",
          "comnFrdrEtcMethod": "자유 출입 가능",
          "comnFrdrPwd": "1234"
        },
        "orgDeliNo": "100000021",
        "lastDeliResponse": {
          "ordNo": "text",
          "deliNo": "text",
          "ordSeq": "text",
          "ordProcSeq": "text",
          "shipIndiDtm": "2026-01-01T00:00:00.000Z",
          "shipCfmDtm": "2026-01-01T00:00:00.000Z",
          "shipFnshDtm": "2026-01-01T00:00:00.000Z",
          "deliFnshDtm": "2026-01-01T00:00:00.000Z",
          "hdcCd": "text",
          "invNo": "text",
          "deliDtlStatCd": "text"
        },
        "shippingDeliGbCd": true,
        "opOrdDtlUpdateKey": {
          "ordNo": "text",
          "ordSeq": 1,
          "ordProcSeq": 1,
          "uprOrdProcSeq": 1,
          "claimNo": "text",
          "goodsNo": "text",
          "itmNo": "text",
          "ordDtlGbCd": "text",
          "deliGbCd": "text",
          "ordAccpDtm": "2026-01-01T00:00:00.000Z",
          "ordFnshDtm": "2026-01-01T00:00:00.000Z",
          "ordDtlStatCd": "text",
          "ordQty": 1,
          "cnclQty": 1,
          "rtnQty": 1,
          "deliIndiDtm": "2026-01-01T00:00:00.000Z",
          "deliIndiRsvDtm": "2026-01-01T00:00:00.000Z",
          "deliNo": "text",
          "exchMidRtnYn": "text",
          "claimLgrpCd": "text",
          "claimMgrpCd": "text",
          "claimCausEtcCont": "text",
          "rtnPsbYn": "text",
          "exchPsbYn": "text",
          "ordCnclPsbYn": "text",
          "wthdYn": "text",
          "wthdFnshGbCd": "text",
          "shipFnshFcstDtm": "2026-01-01T00:00:00.000Z",
          "etcktNo": "text",
          "ecpnNo": "text"
        },
        "generalSalesProduct": true,
        "exchangeShipping": true,
        "withdrawalDeliGbCd": true,
        "withdrawShipping": true,
        "ordSeqAndUprOrdProcSeq": "text",
        "goodsNoAndItmNo": "text",
        "ordSeqAndOrdProcSeq": "text"
      }
    ],
    "allNonReturnable": true,
    "vbankPaymentPending": true,
    "allEcoupon": true
  },
  "codeMap": {
    "ANY_ADDITIONAL_PROPERTY": [
      {
        "cd": "302",
        "cdNm": "색상변경",
        "cdDesc": "[단순변심]",
        "sortSeq": "22",
        "ref1Val": "30",
        "ref2Val": "10",
        "ref3Val": "10",
        "ref4Val": "10",
        "ref5Val": "Y",
        "ref6Val": "null",
        "ref7Val": "null"
      }
    ]
  }
}

Search Exchange Targets (FO)

post

Function Description

  • Retrieves order exchange targets in FO.

Detailed Description

  • Order No. (ordNo), Claim Business Type (claimBusinessType), and System Type (systemType) are required.

  • Exchange registration processing is possible for targets that satisfy all of the following conditions:

    • Order History Type (OM003) value is General Order (10) or Exchange (30)

    • Order History Status (OM005) value is Shipped (26) or Delivered (27)

    • Return Availability (rtnPsbYn) value is Y

    • The item is a general product (excluding free gifts)

    • Exchangeable quantity is 1 or more ( Order Quantity – Cancel Quantity – Return Quantity > 0 )

Special Notes

  • Retrieves exchange targets when the Claim Business Type (claimBusinessType) is Exchange (30).

Revision History

  • release_231204_01 : Added delivery address sequence No. (dlvpSeq) to the request DTO; when a delivery address sequence value is present at target lookup, additional filtering by it is applied

  • release v2.00_240409 : Fixed a typo in the response DTO ( CaimTargetResponse -> ClaimTargetResponse )

  • Release v2.00_240729 : Added collection status (wthdYn), non-returnable order flag (isAllNonReturnable)

Header parameters
AuthorizationanyOptional

Access Token

Body

Claim Eligibility Search Request DTO

ordNostringRequired

Order No.

Example: 20230808O007404
claimBusinessTypestring · enumOptional

ClaimBusiness (Claim Business Type) * 11 : Order Cancellation * 20 : Return Receipt * 21 : Return Cancellation * 30 : Exchange Receipt * 31 : Exchange Cancellation * 22 : Return Completed * 23 : Return Not Possible * 24 : Exchange Return * 25 : Return On Hold

Example: 11Possible values:
orgClmNostringOptional

Original Claim No.

Example: 20230808C010663
systemTypestring · enumRequired

SYSTEM (System Type) * 10 : FO * 20 : BO

Default: 20Example: 10Possible values:
dlvpSeqstringOptional

Delivery Address Sequence No.

Example: 1
systemCdNmAndButtonCodestringOptional
claimBusinessstring · enumOptional

ClaimBusiness (Claim Business Type) * 11 : Order Cancellation * 20 : Return Receipt * 21 : Return Cancellation * 30 : Exchange Receipt * 31 : Exchange Cancellation * 22 : Return Completed * 23 : Return Not Possible * 24 : Exchange Return * 25 : Return On Hold

Example: 11Possible values:
systemstring · enumOptional

SYSTEM (System Type) * 10 : FO * 20 : BO

Example: 10Possible values:
Responses
200

Success

*/*

Search Order Exchange-Eligible Targets Response DTO

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

{
  "ordNo": "20230808O007404",
  "claimBusinessType": "11",
  "orgClmNo": "20230808C010663",
  "systemType": "10",
  "dlvpSeq": "1",
  "systemCdNmAndButtonCode": "text",
  "claimBusiness": "11",
  "system": "10"
}
{
  "claimTargetResponse": {
    "ordNo": "20231231O000001",
    "mbrNo": "100001311",
    "mbrGradeCd": "10",
    "ordGbCd": "10",
    "mbrMgrCd": "10",
    "ordManNm": "홍길동",
    "ordManEmailAddr": "test@plateer.com",
    "ordManCellSctNo": "010",
    "ordManCellTxnoNo": "1234",
    "ordManCellEndNo": "5678",
    "ordMediaCd": "20",
    "ordAccpDtm": "2026-01-01T00:00:00.000Z",
    "sctnCnclPsbYn": "N",
    "claimTargetGoodsResponseList": [
      {
        "goodsNo": "10002297",
        "deliProcTypCd": "10",
        "deliPolcNo": "10000151",
        "deliNo": "100000021",
        "entrNo": "1000002",
        "ordQty": 1,
        "salePrc": 30000,
        "dcAmt": 3000,
        "sysModDtm": "2026-01-01T00:00:00.000Z",
        "ordNo": "20231231O000001",
        "ordSeq": 1,
        "ordProcSeq": 1,
        "uprOrdProcSeq": 1,
        "maxOrdProcSeq": 1,
        "claimNo": "20231231C000001",
        "itmNo": "001",
        "ordDtlGbCd": "10",
        "ordDtlGbCdNm": "주문일반",
        "ordDtlStatCd": "10",
        "ordDtlStatCdNm": "접수",
        "deliGbCd": "10",
        "ordAccpDtm": "2026-01-01T00:00:00.000Z",
        "ordFnshDtm": "2026-01-01T00:00:00.000Z",
        "cnclQty": 0,
        "rtnQty": 0,
        "claimQty": 0,
        "claimPossibleQty": 5,
        "deliIndiDtm": "2026-01-01T00:00:00.000Z",
        "deliIndiRsvDtm": "2026-01-01T00:00:00.000Z",
        "exchMidRtnYn": "N",
        "rtnPsbYn": "N",
        "exchPsbYn": "N",
        "ordCnclPsbYn": "N",
        "wthdYn": "Y",
        "ecpnNo": "ORD0001",
        "etcktNo": "ORD0001",
        "claimLgrpCd": "10",
        "claimLgrpCdNm": "단순변심",
        "claimMgrpCd": "100",
        "claimMgrpCdNm": "사이즈가 큼",
        "claimCausEtcCont": "사이즈가 생각보다 큽니다.",
        "ordSaleTypCd": "10",
        "chlNo": "1000001",
        "chlDtlNo": "1000001",
        "stdCtgNo": "HT01020000",
        "infDispCtgNoGbCd": "10",
        "infDispCtgNo": "213",
        "repDispCtgNo": "213",
        "conrNo": "10050",
        "brandNo": "100002",
        "brandNm": "플래티어",
        "goodsNm": "폴로티셔츠",
        "goodsImg": "files/goods/2023/12/31/goodsImg.jpg",
        "itmNm": "화이트>95",
        "prestNm": "우산 증정",
        "goodsCompCd": "10",
        "goodsTypCd": "10",
        "saleMethCd": "10",
        "taxGbCd": "01",
        "buyTypCd": "10",
        "supPcost": 14400,
        "norPrc": 25000,
        "mrgnRate": 4,
        "deliDday": 1,
        "deliGoodsGbCd": "10",
        "deliWayCd": "10",
        "bpckPsbYn": "Y",
        "hsCd": "0101",
        "goodsRevWrtYn": "N",
        "bnfAmt": 2000,
        "ordPrc": 25000,
        "aeGoodsYn": "N",
        "withdrawalDeliNo": "100000001",
        "shipmentDeliNo": "100000001",
        "deliTypCd": "10",
        "deliKindCd": "10",
        "deliMethodCd": "10",
        "deliProcTypCdNm": "업체배송",
        "puTypCd": "20",
        "wthdFnshGbCd": "10",
        "dlvpNm": "자택",
        "rcvmnNm": "홍길동",
        "dlvpSeq": "1",
        "maxDlvpSeq": "1",
        "zipNo": 5836,
        "zipAddr": "서울 송파구 법원로9길 26",
        "dtlAddr": "에이치비지니스파크 D동 6층",
        "rcvmnEmailAddr": "sample@plateer.com",
        "rcvmnCellSctNo": "010",
        "rcvmnCellTxnoNo": "1122",
        "rcvmnCellEndNo": "3546",
        "rcvmnTelRgnNo": "02",
        "rcvmnTelTxnoNo": "112",
        "rcvmnTelEndNo": "3546",
        "deliMsg": "부재시 문앞에 두고 가주세요",
        "deliMsgCd": "70",
        "shopTrafMsg": "없음",
        "comnFrdrCogoMethodCd": "10",
        "comnFrdrEtcMethod": "없음",
        "comnFrdrPwd": "1234",
        "orgDlvpInfo": {
          "mbrOrdDlvpGb": "10",
          "dlvpSeq": "1",
          "zipNoSeq": 1,
          "dlvpNm": "집",
          "rcvmnNm": "홍길동",
          "zipNo": 5836,
          "zipAddr": "서울 송파구 법원로9길 26",
          "dtlAddr": "에이치비지니스파크 D동 6층",
          "rcvmnEmailAddr": "x2bee@plateer.com",
          "rcvmnCellSctNo": "010",
          "rcvmnCellTxnoNo": "1234",
          "rcvmnCellEndNo": "5678",
          "rcvmnTelRgnNo": "02",
          "rcvmnTelTxnoNo": "123",
          "rcvmnTelEndNo": "4567",
          "deliMsg": "부재 시 문 앞에 놓아주세요.",
          "deliMsgCd": "30",
          "shopTrafMsg": "문 앞에 놓아주세요.",
          "comnFrdrCogoMethodCd": "20",
          "comnFrdrEtcMethod": "자유 출입 가능",
          "comnFrdrPwd": "1234"
        },
        "orgDeliNo": "100000021",
        "lastDeliResponse": {
          "ordNo": "text",
          "deliNo": "text",
          "ordSeq": "text",
          "ordProcSeq": "text",
          "shipIndiDtm": "2026-01-01T00:00:00.000Z",
          "shipCfmDtm": "2026-01-01T00:00:00.000Z",
          "shipFnshDtm": "2026-01-01T00:00:00.000Z",
          "deliFnshDtm": "2026-01-01T00:00:00.000Z",
          "hdcCd": "text",
          "invNo": "text",
          "deliDtlStatCd": "text"
        },
        "shippingDeliGbCd": true,
        "opOrdDtlUpdateKey": {
          "ordNo": "text",
          "ordSeq": 1,
          "ordProcSeq": 1,
          "uprOrdProcSeq": 1,
          "claimNo": "text",
          "goodsNo": "text",
          "itmNo": "text",
          "ordDtlGbCd": "text",
          "deliGbCd": "text",
          "ordAccpDtm": "2026-01-01T00:00:00.000Z",
          "ordFnshDtm": "2026-01-01T00:00:00.000Z",
          "ordDtlStatCd": "text",
          "ordQty": 1,
          "cnclQty": 1,
          "rtnQty": 1,
          "deliIndiDtm": "2026-01-01T00:00:00.000Z",
          "deliIndiRsvDtm": "2026-01-01T00:00:00.000Z",
          "deliNo": "text",
          "exchMidRtnYn": "text",
          "claimLgrpCd": "text",
          "claimMgrpCd": "text",
          "claimCausEtcCont": "text",
          "rtnPsbYn": "text",
          "exchPsbYn": "text",
          "ordCnclPsbYn": "text",
          "wthdYn": "text",
          "wthdFnshGbCd": "text",
          "shipFnshFcstDtm": "2026-01-01T00:00:00.000Z",
          "etcktNo": "text",
          "ecpnNo": "text"
        },
        "generalSalesProduct": true,
        "exchangeShipping": true,
        "withdrawalDeliGbCd": true,
        "withdrawShipping": true,
        "ordSeqAndUprOrdProcSeq": "text",
        "goodsNoAndItmNo": "text",
        "ordSeqAndOrdProcSeq": "text"
      }
    ],
    "allNonReturnable": true,
    "vbankPaymentPending": true,
    "allEcoupon": true
  },
  "codeMap": {
    "ANY_ADDITIONAL_PROPERTY": [
      {
        "cd": "302",
        "cdNm": "색상변경",
        "cdDesc": "[단순변심]",
        "sortSeq": "22",
        "ref1Val": "30",
        "ref2Val": "10",
        "ref3Val": "10",
        "ref4Val": "10",
        "ref5Val": "Y",
        "ref6Val": "null",
        "ref7Val": "null"
      }
    ]
  }
}
Deprecated

Claim Delivery Fee Payment-Pending Status Target Information

post

Function Description

  • Retrieves information on targets in the claim shipping fee payment-pending status in FO.

Detailed Description

  • Order No. (ordNo) and Claim No. (claimNo) are required.

  • Retrieves the additional shipping fee for the target claim.

  • Retrieves the product list for the target claim.

    • Order History Type (OM003) value is Return (20) or Exchange (30)

    • Order History Status (OM005) value is Payment Pending (31)

    • Return Availability (rtnPsbYn) value is Y

    • Target claim quantity is 1 or more ( Order Quantity – Cancel Quantity – Return Quantity > 0 )

Revision History

  • release_231204_01 : Deprecated; moved to the common claim API (changed API path: api/order/v1/claim/common/getClaimPayWaitStateInfo)

Header parameters
AuthorizationanyOptional

Access Token

Body

Claim Detail Search Request DTO

ordNostringRequired

Order No.

Example: 20230808O007404
claimNostringRequired

Claim No.

Example: 20230801C008072
Responses
200

Success

*/*

Claim Shipping Fee Payment-Pending Status Target Response DTO

ordNostringOptional

Order No.

Example: 20230808O007404
ordAccpDtmstring · date-timeOptional

Order Receipt Date

deliAmtSuminteger · int64Optional

Total Shipping Fee

Example: 3000
totAplyAdtnAmtinteger · int64Optional

Total Additional Cost

Example: 3000
addtionPayAmtinteger · int64Optional

Additional Amount

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

{
  "ordNo": "20230808O007404",
  "claimNo": "20230801C008072"
}
{
  "ordNo": "20230808O007404",
  "ordAccpDtm": "2026-01-01T00:00:00.000Z",
  "deliAmtSum": 3000,
  "totAplyAdtnAmt": 3000,
  "addtionPayAmt": 3000,
  "claimTargetResponse": {
    "ordNo": "20231231O000001",
    "mbrNo": "100001311",
    "mbrGradeCd": "10",
    "ordGbCd": "10",
    "mbrMgrCd": "10",
    "ordManNm": "홍길동",
    "ordManEmailAddr": "test@plateer.com",
    "ordManCellSctNo": "010",
    "ordManCellTxnoNo": "1234",
    "ordManCellEndNo": "5678",
    "ordMediaCd": "20",
    "ordAccpDtm": "2026-01-01T00:00:00.000Z",
    "sctnCnclPsbYn": "N",
    "claimTargetGoodsResponseList": [
      {
        "goodsNo": "10002297",
        "deliProcTypCd": "10",
        "deliPolcNo": "10000151",
        "deliNo": "100000021",
        "entrNo": "1000002",
        "ordQty": 1,
        "salePrc": 30000,
        "dcAmt": 3000,
        "sysModDtm": "2026-01-01T00:00:00.000Z",
        "ordNo": "20231231O000001",
        "ordSeq": 1,
        "ordProcSeq": 1,
        "uprOrdProcSeq": 1,
        "maxOrdProcSeq": 1,
        "claimNo": "20231231C000001",
        "itmNo": "001",
        "ordDtlGbCd": "10",
        "ordDtlGbCdNm": "주문일반",
        "ordDtlStatCd": "10",
        "ordDtlStatCdNm": "접수",
        "deliGbCd": "10",
        "ordAccpDtm": "2026-01-01T00:00:00.000Z",
        "ordFnshDtm": "2026-01-01T00:00:00.000Z",
        "cnclQty": 0,
        "rtnQty": 0,
        "claimQty": 0,
        "claimPossibleQty": 5,
        "deliIndiDtm": "2026-01-01T00:00:00.000Z",
        "deliIndiRsvDtm": "2026-01-01T00:00:00.000Z",
        "exchMidRtnYn": "N",
        "rtnPsbYn": "N",
        "exchPsbYn": "N",
        "ordCnclPsbYn": "N",
        "wthdYn": "Y",
        "ecpnNo": "ORD0001",
        "etcktNo": "ORD0001",
        "claimLgrpCd": "10",
        "claimLgrpCdNm": "단순변심",
        "claimMgrpCd": "100",
        "claimMgrpCdNm": "사이즈가 큼",
        "claimCausEtcCont": "사이즈가 생각보다 큽니다.",
        "ordSaleTypCd": "10",
        "chlNo": "1000001",
        "chlDtlNo": "1000001",
        "stdCtgNo": "HT01020000",
        "infDispCtgNoGbCd": "10",
        "infDispCtgNo": "213",
        "repDispCtgNo": "213",
        "conrNo": "10050",
        "brandNo": "100002",
        "brandNm": "플래티어",
        "goodsNm": "폴로티셔츠",
        "goodsImg": "files/goods/2023/12/31/goodsImg.jpg",
        "itmNm": "화이트>95",
        "prestNm": "우산 증정",
        "goodsCompCd": "10",
        "goodsTypCd": "10",
        "saleMethCd": "10",
        "taxGbCd": "01",
        "buyTypCd": "10",
        "supPcost": 14400,
        "norPrc": 25000,
        "mrgnRate": 4,
        "deliDday": 1,
        "deliGoodsGbCd": "10",
        "deliWayCd": "10",
        "bpckPsbYn": "Y",
        "hsCd": "0101",
        "goodsRevWrtYn": "N",
        "bnfAmt": 2000,
        "ordPrc": 25000,
        "aeGoodsYn": "N",
        "withdrawalDeliNo": "100000001",
        "shipmentDeliNo": "100000001",
        "deliTypCd": "10",
        "deliKindCd": "10",
        "deliMethodCd": "10",
        "deliProcTypCdNm": "업체배송",
        "puTypCd": "20",
        "wthdFnshGbCd": "10",
        "dlvpNm": "자택",
        "rcvmnNm": "홍길동",
        "dlvpSeq": "1",
        "maxDlvpSeq": "1",
        "zipNo": 5836,
        "zipAddr": "서울 송파구 법원로9길 26",
        "dtlAddr": "에이치비지니스파크 D동 6층",
        "rcvmnEmailAddr": "sample@plateer.com",
        "rcvmnCellSctNo": "010",
        "rcvmnCellTxnoNo": "1122",
        "rcvmnCellEndNo": "3546",
        "rcvmnTelRgnNo": "02",
        "rcvmnTelTxnoNo": "112",
        "rcvmnTelEndNo": "3546",
        "deliMsg": "부재시 문앞에 두고 가주세요",
        "deliMsgCd": "70",
        "shopTrafMsg": "없음",
        "comnFrdrCogoMethodCd": "10",
        "comnFrdrEtcMethod": "없음",
        "comnFrdrPwd": "1234",
        "orgDlvpInfo": {
          "mbrOrdDlvpGb": "10",
          "dlvpSeq": "1",
          "zipNoSeq": 1,
          "dlvpNm": "집",
          "rcvmnNm": "홍길동",
          "zipNo": 5836,
          "zipAddr": "서울 송파구 법원로9길 26",
          "dtlAddr": "에이치비지니스파크 D동 6층",
          "rcvmnEmailAddr": "x2bee@plateer.com",
          "rcvmnCellSctNo": "010",
          "rcvmnCellTxnoNo": "1234",
          "rcvmnCellEndNo": "5678",
          "rcvmnTelRgnNo": "02",
          "rcvmnTelTxnoNo": "123",
          "rcvmnTelEndNo": "4567",
          "deliMsg": "부재 시 문 앞에 놓아주세요.",
          "deliMsgCd": "30",
          "shopTrafMsg": "문 앞에 놓아주세요.",
          "comnFrdrCogoMethodCd": "20",
          "comnFrdrEtcMethod": "자유 출입 가능",
          "comnFrdrPwd": "1234"
        },
        "orgDeliNo": "100000021",
        "lastDeliResponse": {
          "ordNo": "text",
          "deliNo": "text",
          "ordSeq": "text",
          "ordProcSeq": "text",
          "shipIndiDtm": "2026-01-01T00:00:00.000Z",
          "shipCfmDtm": "2026-01-01T00:00:00.000Z",
          "shipFnshDtm": "2026-01-01T00:00:00.000Z",
          "deliFnshDtm": "2026-01-01T00:00:00.000Z",
          "hdcCd": "text",
          "invNo": "text",
          "deliDtlStatCd": "text"
        },
        "shippingDeliGbCd": true,
        "opOrdDtlUpdateKey": {
          "ordNo": "text",
          "ordSeq": 1,
          "ordProcSeq": 1,
          "uprOrdProcSeq": 1,
          "claimNo": "text",
          "goodsNo": "text",
          "itmNo": "text",
          "ordDtlGbCd": "text",
          "deliGbCd": "text",
          "ordAccpDtm": "2026-01-01T00:00:00.000Z",
          "ordFnshDtm": "2026-01-01T00:00:00.000Z",
          "ordDtlStatCd": "text",
          "ordQty": 1,
          "cnclQty": 1,
          "rtnQty": 1,
          "deliIndiDtm": "2026-01-01T00:00:00.000Z",
          "deliIndiRsvDtm": "2026-01-01T00:00:00.000Z",
          "deliNo": "text",
          "exchMidRtnYn": "text",
          "claimLgrpCd": "text",
          "claimMgrpCd": "text",
          "claimCausEtcCont": "text",
          "rtnPsbYn": "text",
          "exchPsbYn": "text",
          "ordCnclPsbYn": "text",
          "wthdYn": "text",
          "wthdFnshGbCd": "text",
          "shipFnshFcstDtm": "2026-01-01T00:00:00.000Z",
          "etcktNo": "text",
          "ecpnNo": "text"
        },
        "generalSalesProduct": true,
        "exchangeShipping": true,
        "withdrawalDeliGbCd": true,
        "withdrawShipping": true,
        "ordSeqAndUprOrdProcSeq": "text",
        "goodsNoAndItmNo": "text",
        "ordSeqAndOrdProcSeq": "text"
      }
    ],
    "allNonReturnable": true,
    "vbankPaymentPending": true,
    "allEcoupon": true
  },
  "opOrdAdtnCostList": [
    {
      "ordAdtnSn": "100001315",
      "ordNo": "20231231O000001",
      "claimNo": "20231231C000001",
      "deliNo": "100000001",
      "uprOrdAdtnSn": "100000842",
      "entrNo": "1000002",
      "adtnOcurGbCd": "10",
      "ordCostGbCd": "10",
      "stdAdtnAmt": 100000,
      "aplyAdtnAmt": 0,
      "cnclAdtnAmt": 0,
      "fvrAdtnAmt": 0,
      "deliPolcNo": "10000431",
      "dlexTypCd": "30",
      "dlexCnclCausCd": "10",
      "dlexAmt": 3000,
      "adtnBassNo": "C1001182",
      "adtnDtlBassNo": "105962",
      "fvrPolcTypCd": "00",
      "fvrPolcAplyVal": 0,
      "fvrMinBuyAmt": 0,
      "fvrMaxDcAmt": 0,
      "entrChrgRate": 0,
      "entrChrgAmt": 0,
      "ourChrgRate": 100,
      "ourChrgAmt": 0,
      "promoNm": "무료배송쿠폰"
    }
  ],
  "payWayInfoMap": [
    {
      "payWayCd": "11",
      "useYn": "Y",
      "langCd": "ko",
      "cdNm": "text",
      "cdDesc": "text",
      "pgGbCd": "text",
      "memberSubPaymethodAmount": 1,
      "cardCompanyList": [
        {
          "cd": "302",
          "cdNm": "색상변경",
          "cdDesc": "[단순변심]",
          "sortSeq": "22",
          "ref1Val": "30",
          "ref2Val": "10",
          "ref3Val": "10",
          "ref4Val": "10",
          "ref5Val": "Y",
          "ref6Val": "null",
          "ref7Val": "null"
        }
      ],
      "mainPaymethod": true
    }
  ],
  "foSystemNmAndDeliveryButtonCode": "text"
}

Register Exchange (BO)

post

Function Description

  • Registers an exchange target in BO.

Detailed Description

  • Order No. (ordNo), Claim Business Type (claimBusinessType), and System Type (systemType) are required.

  • All exchange registration targets must share the same delivery number to be registered.

  • Checks whether the exchange registration target includes a free gift (partial claim not possible if a free gift is included).

  • Exchange processing is possible for exchange targets that satisfy all of the following conditions:

    • Checks whether the product is valid.

      • Checks whether the Sales Status Code (PR005) of the product to be received in exchange is On Sale (10).

      • Checks whether the Sales Method Code (PR003) of the product to be received in exchange is General Sale (10).

      • Checks whether the product to be received in exchange is the same price as the exchange target product.

      • Checks the stock of the product to be received in exchange.

  • Creates and updates the order exchange data.

    • If the Claim Major Category Code (claimLgrpCd) is Simple Change of Mind (10), a shipping fee is incurred.

      • If an additional payment amount (shipping fee) is incurred, the Order History Status (OM005) value is changed to Payment Pending (31) instead of Exchange Registered (32).

      • When in Payment Pending (31) status, payment must be made through the shipping fee payment screen in FO for the status to become Exchange Registered (32).

  • Validates the payment information arising from the exchange registration.

  • Performs stock adjustment processing.

  • Sends the notification message after the exchange is registered.

Special Notes

  • Exchange registration is processed only when the Claim Business Type (claimBusinessType) is Exchange (30).

Revision History

  • release_231009_01 : Added order quantity and cancel quantity columns to the order benefit relationship table

  • release v2.00_240409 : Added and changed setting information due to a change in the exchange registration email template

  • Release v2.00_240729 : If the collection status of all exchange registration targets is 'N', excludes the collection shipping fee from being charged; changed notification template

Header parameters
AuthorizationanyOptional

Access Token

Body

Claim Processing Request DTO

systemTypestring · enumRequired

SYSTEM (System Type) * 10 : FO * 20 : BO

Example: 10Possible values:
claimBusinessTypestring · enumRequired

ClaimBusiness (Claim Business Type) * 11 : Order Cancellation * 20 : Return Receipt * 21 : Return Cancellation * 30 : Exchange Receipt * 31 : Exchange Cancellation * 22 : Return Completed * 23 : Return Not Possible * 24 : Exchange Return * 25 : Return On Hold

Example: 11Possible values:
ordMediaCdstring · enumRequired

Order Channel Code (OM007) 10 : Phone Consultation (CC) , 20 : PC , 30 : Mobile Web , 40 : Android App , 50 : iOS App , 60 : Subscription Order

Example: 20Possible values:
ordNostringRequired

Order No.

Example: 20230808O007404
mbrNostringOptional

Member No.

Example: 100001311
claimNostringRequired

Claim No.

Example: 20230808C010663
wthdFnshWaitProcCausstringRequired

Pickup Completion Pending Reason

Example: 불량반품
occurPaymentbooleanOptional
existAddtionPayAmtbooleanOptional
claimBusinessstring · enumOptional

ClaimBusiness (Claim Business Type) * 11 : Order Cancellation * 20 : Return Receipt * 21 : Return Cancellation * 30 : Exchange Receipt * 31 : Exchange Cancellation * 22 : Return Completed * 23 : Return Not Possible * 24 : Exchange Return * 25 : Return On Hold

Example: 11Possible values:
Responses
200

Success

*/*
ordNostringOptional

Order No.

Example: 20230808O007404
claimNostringOptional

Claim No.

Example: 20230808C010663
post/v1/claim/exchange/acceptExchange
POST /api/order/v1/claim/exchange/acceptExchange HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 4998

{
  "systemType": "10",
  "claimBusinessType": "11",
  "ordMediaCd": "20",
  "ordNo": "20230808O007404",
  "mbrNo": "100001311",
  "claimNo": "20230808C010663",
  "claimGoodsList": [
    {
      "ordSeq": 1,
      "ordProcSeq": 1,
      "goodsNo": "10002297",
      "itmNo": "001",
      "exchangeGoodsNo": "10002297",
      "exchangeItmNo": "001",
      "exchangeItmNm": "001",
      "claimQty": 1,
      "claimLgrpCd": "10",
      "claimMgrpCd": "100",
      "claimCausEtcCont": "배송이 늦어짐",
      "withdrawalDeliNo": "100013106",
      "shipmentDeliNo": "100013105",
      "prOrdDtlAtchFileInfoList": [
        {
          "ordNo": "20230808O007404",
          "ordSeq": 1,
          "ordProcSeq": 1,
          "fileSeq": "1",
          "filePathNm": "files/order/2023/08/03/",
          "fileNm": "d732ec3b-e044-43ca-8ecb-80051b2b36f8_10.png"
        }
      ],
      "ordSeqAndOrdProcSeq": "text"
    }
  ],
  "paymentRequest": {
    "siteNo": "1",
    "orderInfo": {
      "ordNo": "20990101O000001",
      "claimNo": "20990101C000001",
      "goodsNm": "플래티어커피",
      "ordManNm": "김플래티어",
      "ordmnCellNo": 1012345678,
      "ordmnEmailAddr": "kim@plateer.com",
      "crcUnitCd": "KRW",
      "ordMediaCd": "30",
      "mbrNo": "100000001",
      "ordDtlGbCd": "10",
      "clientIp": "127.0.0.1",
      "taxFreeAmt": 1
    },
    "payInfoList": [
      {
        "payNo": "1",
        "payWayCd": "11",
        "payAmt": 1000,
        "mersNo": "1",
        "pgGbCd": "10",
        "trdNo": "INIMX_DBNKINIpayTest20990101090000685510",
        "selectCardCd": "01",
        "termlId": "INIBillTst",
        "billKey": "text",
        "authResultMap": "{P_STATUS:결과코드, P_RMESG1:결과메시지, P_TID:인증거래번호, P_AMT:거래금액, idc_name:IDC센터코드P_REQ_URL:승인요청 URL, P_NOTI:가맹점 임의 데이터}"
      }
    ]
  },
  "claimCpnInfoList": [
    {
      "cpnNo": "104224"
    }
  ],
  "claimReturnDlvp": {
    "mbrOrdDlvpGb": "10",
    "dlvpSeq": "1",
    "zipNoSeq": 1,
    "dlvpNm": "집",
    "rcvmnNm": "홍길동",
    "zipNo": 5836,
    "zipAddr": "서울 송파구 법원로9길 26",
    "dtlAddr": "에이치비지니스파크 D동 6층",
    "rcvmnEmailAddr": "x2bee@plateer.com",
    "rcvmnCellSctNo": "010",
    "rcvmnCellTxnoNo": "1234",
    "rcvmnCellEndNo": "5678",
    "rcvmnTelRgnNo": "02",
    "rcvmnTelTxnoNo": "123",
    "rcvmnTelEndNo": "4567",
    "deliMsg": "부재 시 문 앞에 놓아주세요.",
    "deliMsgCd": "30",
    "shopTrafMsg": "문 앞에 놓아주세요.",
    "comnFrdrCogoMethodCd": "20",
    "comnFrdrEtcMethod": "자유 출입 가능",
    "comnFrdrPwd": "1234"
  },
  "claimDlvp": {
    "mbrOrdDlvpGb": "10",
    "dlvpSeq": "1",
    "zipNoSeq": 1,
    "dlvpNm": "집",
    "rcvmnNm": "홍길동",
    "zipNo": 5836,
    "zipAddr": "서울 송파구 법원로9길 26",
    "dtlAddr": "에이치비지니스파크 D동 6층",
    "rcvmnEmailAddr": "x2bee@plateer.com",
    "rcvmnCellSctNo": "010",
    "rcvmnCellTxnoNo": "1234",
    "rcvmnCellEndNo": "5678",
    "rcvmnTelRgnNo": "02",
    "rcvmnTelTxnoNo": "123",
    "rcvmnTelEndNo": "4567",
    "deliMsg": "부재 시 문 앞에 놓아주세요.",
    "deliMsgCd": "30",
    "shopTrafMsg": "문 앞에 놓아주세요.",
    "comnFrdrCogoMethodCd": "20",
    "comnFrdrEtcMethod": "자유 출입 가능",
    "comnFrdrPwd": "1234"
  },
  "claimFinalAmtInfo": {
    "ordNo": "20230913O058186",
    "totAplyAdtnAmt": 6000,
    "totCnclAdtnAmt": 0,
    "totFvrAdtnAmt": 0,
    "totOrdPrc": 46000,
    "totDcAmt": 2200,
    "expectedRefundAmt": 37800,
    "addtionPayAmt": 0,
    "returnAcceptAmt": 37800,
    "refundAdditionAmtInfoList": [
      {
        "adtnOcurGbCd": "10",
        "adtnOcurGbNm": "발생",
        "type": "10",
        "typeNm": "회수배송비",
        "goodsNoItmNo": "10002762001",
        "goodsNm": "상품명",
        "ordAmt": 6000,
        "discountMethod": "11",
        "discountMethodNm": "상품할인쿠폰",
        "cnclDcAmt": 2000,
        "rtnDlvBenefitInfoList": [
          {
            "promoNo": "C1003841",
            "promoNm": "무료반품쿠폰",
            "promoTypCd": "11",
            "ourChrgRate": 100,
            "entrChrgRate": 0,
            "cpnIsuNo": "4364872",
            "aplyYn": "Y"
          }
        ],
        "reCalAdtnOcurGbCdAdtnAmt": 1
      }
    ],
    "refundPaymentMethodList": [
      {
        "payNo": "2",
        "mbrNo": "100000001",
        "ordNo": "20990101O000001",
        "claimNo": "20990101C000001",
        "uprPayNo": "1",
        "payGbCd": "10",
        "payGbCdNm": "결제",
        "payWayCd": "11",
        "payWayCdNm": "신용카드",
        "payStatCd": "12",
        "payStatCdNm": "결제완료",
        "payAmt": 10000,
        "taxFreeAmt": 10000,
        "rfdPsbAmt": 10000,
        "rfdAmt": 1000,
        "payFnshDtm": "2026-01-01T00:00:00.000Z",
        "trdNo": "INIMX_CARDINIpayTest20990101090000685510",
        "trdDtm": "2026-01-01T00:00:00.000Z",
        "iscmCd": "202",
        "iscmCdNm": "KB국민카드",
        "payReqCardcoCd": "06",
        "payReqCardcoCdNm": "국민카드",
        "cardNo": "카드번호 암호화",
        "cardNm": "국민카드",
        "cardValiTerm": "text",
        "nintDivYn": "N",
        "divMonCnt": 0,
        "cardPointUseYn": "N",
        "mersNo": "1",
        "acqrCd": "121",
        "acqrCdNm": "국민카드",
        "aprvNo": "12345678",
        "aprvDtm": "2026-01-01T00:00:00.000Z",
        "sctnCnclPsbYn": "Y",
        "bankCd": "148",
        "bankCdNm": "국민은행",
        "actnNo": "계좌번호 암호화",
        "dpmnNm": "김플래티어",
        "dptFcstDt": "2099-01-01 09:00:00.000000",
        "dptCnfmDtm": "2026-01-01T00:00:00.000Z",
        "rfdBankCd": "148",
        "rfdBankCdNm": "국민은행",
        "rfdActnNo": "계좌번호 암호화",
        "rfdActnDepositorNm": "홍길동",
        "vbankPaymentPending": true,
        "vbankDptCnfm": true
      }
    ],
    "paymentOrderInfo": {
      "ordNo": "20990101O000001",
      "claimNo": "20990101C000001",
      "goodsNm": "플래티어커피",
      "ordManNm": "김플래티어",
      "ordmnCellNo": 1012345678,
      "ordmnEmailAddr": "kim@plateer.com",
      "crcUnitCd": "KRW",
      "ordMediaCd": "30",
      "mbrNo": "100000001",
      "ordDtlGbCd": "10",
      "clientIp": "127.0.0.1",
      "taxFreeAmt": 1
    },
    "rfdInfoResponse": {
      "rfdBankCd": "203",
      "rfdBankNm": "KB국민은행",
      "rfdActnNo": "33330********",
      "rfdActnDepositorNm": "임성현",
      "rfdActnCertiYn": "Y"
    }
  },
  "wthdFnshWaitProcCaus": "불량반품",
  "occurPayment": true,
  "existAddtionPayAmt": true,
  "claimBusiness": "11"
}
{
  "ordNo": "20230808O007404",
  "claimNo": "20230808C010663"
}

Register Exchange (FO)

post

Function Description

  • Registers an exchange target in FO.

Detailed Description

  • Order No. (ordNo), Claim Business Type (claimBusinessType), and System Type (systemType) are required.

  • All exchange registration targets must share the same delivery number to be registered.

  • Checks whether the exchange registration target includes a free gift (partial claim not possible if a free gift is included).

  • Exchange processing is possible for exchange targets that satisfy all of the following conditions:

    • Checks whether the product is valid.

      • Checks whether the Sales Status Code (PR005) of the product to be received in exchange is On Sale (10).

      • Checks whether the Sales Method Code (PR003) of the product to be received in exchange is General Sale (10).

      • Checks whether the product to be received in exchange is the same price as the exchange target product.

      • Checks the stock of the product to be received in exchange.

  • Creates and updates the order exchange data.

    • If the Claim Major Category Code (claimLgrpCd) is Simple Change of Mind (10), a shipping fee is incurred.

  • Saves the payment approval information incurred at exchange registration.

  • Validates the payment information arising from the exchange registration.

  • Performs stock adjustment processing.

  • Sends the notification message after the exchange is registered.

Special Notes

  • Exchange registration is processed only when the Claim Business Type (claimBusinessType) is Exchange (30).

Revision History

  • release_231009_01 : Added order quantity and cancel quantity columns to the order benefit relationship table

  • release v2.00_240409 : Added and changed setting information due to a change in the exchange registration email template

  • Release v2.00_240729 : If the collection status of all exchange registration targets is 'N', excludes the collection shipping fee from being charged; changed notification template

Header parameters
AuthorizationanyOptional

Access Token

Body

Claim Processing Request DTO

systemTypestring · enumRequired

SYSTEM (System Type) * 10 : FO * 20 : BO

Example: 10Possible values:
claimBusinessTypestring · enumRequired

ClaimBusiness (Claim Business Type) * 11 : Order Cancellation * 20 : Return Receipt * 21 : Return Cancellation * 30 : Exchange Receipt * 31 : Exchange Cancellation * 22 : Return Completed * 23 : Return Not Possible * 24 : Exchange Return * 25 : Return On Hold

Example: 11Possible values:
ordMediaCdstring · enumRequired

Order Channel Code (OM007) 10 : Phone Consultation (CC) , 20 : PC , 30 : Mobile Web , 40 : Android App , 50 : iOS App , 60 : Subscription Order

Example: 20Possible values:
ordNostringRequired

Order No.

Example: 20230808O007404
mbrNostringOptional

Member No.

Example: 100001311
claimNostringRequired

Claim No.

Example: 20230808C010663
wthdFnshWaitProcCausstringRequired

Pickup Completion Pending Reason

Example: 불량반품
occurPaymentbooleanOptional
existAddtionPayAmtbooleanOptional
claimBusinessstring · enumOptional

ClaimBusiness (Claim Business Type) * 11 : Order Cancellation * 20 : Return Receipt * 21 : Return Cancellation * 30 : Exchange Receipt * 31 : Exchange Cancellation * 22 : Return Completed * 23 : Return Not Possible * 24 : Exchange Return * 25 : Return On Hold

Example: 11Possible values:
Responses
200

Success

*/*
ordNostringOptional

Order No.

Example: 20230808O007404
claimNostringOptional

Claim No.

Example: 20230808C010663
post/v1/claim/exchange/acceptExchangeFO
POST /api/order/v1/claim/exchange/acceptExchangeFO HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 4998

{
  "systemType": "10",
  "claimBusinessType": "11",
  "ordMediaCd": "20",
  "ordNo": "20230808O007404",
  "mbrNo": "100001311",
  "claimNo": "20230808C010663",
  "claimGoodsList": [
    {
      "ordSeq": 1,
      "ordProcSeq": 1,
      "goodsNo": "10002297",
      "itmNo": "001",
      "exchangeGoodsNo": "10002297",
      "exchangeItmNo": "001",
      "exchangeItmNm": "001",
      "claimQty": 1,
      "claimLgrpCd": "10",
      "claimMgrpCd": "100",
      "claimCausEtcCont": "배송이 늦어짐",
      "withdrawalDeliNo": "100013106",
      "shipmentDeliNo": "100013105",
      "prOrdDtlAtchFileInfoList": [
        {
          "ordNo": "20230808O007404",
          "ordSeq": 1,
          "ordProcSeq": 1,
          "fileSeq": "1",
          "filePathNm": "files/order/2023/08/03/",
          "fileNm": "d732ec3b-e044-43ca-8ecb-80051b2b36f8_10.png"
        }
      ],
      "ordSeqAndOrdProcSeq": "text"
    }
  ],
  "paymentRequest": {
    "siteNo": "1",
    "orderInfo": {
      "ordNo": "20990101O000001",
      "claimNo": "20990101C000001",
      "goodsNm": "플래티어커피",
      "ordManNm": "김플래티어",
      "ordmnCellNo": 1012345678,
      "ordmnEmailAddr": "kim@plateer.com",
      "crcUnitCd": "KRW",
      "ordMediaCd": "30",
      "mbrNo": "100000001",
      "ordDtlGbCd": "10",
      "clientIp": "127.0.0.1",
      "taxFreeAmt": 1
    },
    "payInfoList": [
      {
        "payNo": "1",
        "payWayCd": "11",
        "payAmt": 1000,
        "mersNo": "1",
        "pgGbCd": "10",
        "trdNo": "INIMX_DBNKINIpayTest20990101090000685510",
        "selectCardCd": "01",
        "termlId": "INIBillTst",
        "billKey": "text",
        "authResultMap": "{P_STATUS:결과코드, P_RMESG1:결과메시지, P_TID:인증거래번호, P_AMT:거래금액, idc_name:IDC센터코드P_REQ_URL:승인요청 URL, P_NOTI:가맹점 임의 데이터}"
      }
    ]
  },
  "claimCpnInfoList": [
    {
      "cpnNo": "104224"
    }
  ],
  "claimReturnDlvp": {
    "mbrOrdDlvpGb": "10",
    "dlvpSeq": "1",
    "zipNoSeq": 1,
    "dlvpNm": "집",
    "rcvmnNm": "홍길동",
    "zipNo": 5836,
    "zipAddr": "서울 송파구 법원로9길 26",
    "dtlAddr": "에이치비지니스파크 D동 6층",
    "rcvmnEmailAddr": "x2bee@plateer.com",
    "rcvmnCellSctNo": "010",
    "rcvmnCellTxnoNo": "1234",
    "rcvmnCellEndNo": "5678",
    "rcvmnTelRgnNo": "02",
    "rcvmnTelTxnoNo": "123",
    "rcvmnTelEndNo": "4567",
    "deliMsg": "부재 시 문 앞에 놓아주세요.",
    "deliMsgCd": "30",
    "shopTrafMsg": "문 앞에 놓아주세요.",
    "comnFrdrCogoMethodCd": "20",
    "comnFrdrEtcMethod": "자유 출입 가능",
    "comnFrdrPwd": "1234"
  },
  "claimDlvp": {
    "mbrOrdDlvpGb": "10",
    "dlvpSeq": "1",
    "zipNoSeq": 1,
    "dlvpNm": "집",
    "rcvmnNm": "홍길동",
    "zipNo": 5836,
    "zipAddr": "서울 송파구 법원로9길 26",
    "dtlAddr": "에이치비지니스파크 D동 6층",
    "rcvmnEmailAddr": "x2bee@plateer.com",
    "rcvmnCellSctNo": "010",
    "rcvmnCellTxnoNo": "1234",
    "rcvmnCellEndNo": "5678",
    "rcvmnTelRgnNo": "02",
    "rcvmnTelTxnoNo": "123",
    "rcvmnTelEndNo": "4567",
    "deliMsg": "부재 시 문 앞에 놓아주세요.",
    "deliMsgCd": "30",
    "shopTrafMsg": "문 앞에 놓아주세요.",
    "comnFrdrCogoMethodCd": "20",
    "comnFrdrEtcMethod": "자유 출입 가능",
    "comnFrdrPwd": "1234"
  },
  "claimFinalAmtInfo": {
    "ordNo": "20230913O058186",
    "totAplyAdtnAmt": 6000,
    "totCnclAdtnAmt": 0,
    "totFvrAdtnAmt": 0,
    "totOrdPrc": 46000,
    "totDcAmt": 2200,
    "expectedRefundAmt": 37800,
    "addtionPayAmt": 0,
    "returnAcceptAmt": 37800,
    "refundAdditionAmtInfoList": [
      {
        "adtnOcurGbCd": "10",
        "adtnOcurGbNm": "발생",
        "type": "10",
        "typeNm": "회수배송비",
        "goodsNoItmNo": "10002762001",
        "goodsNm": "상품명",
        "ordAmt": 6000,
        "discountMethod": "11",
        "discountMethodNm": "상품할인쿠폰",
        "cnclDcAmt": 2000,
        "rtnDlvBenefitInfoList": [
          {
            "promoNo": "C1003841",
            "promoNm": "무료반품쿠폰",
            "promoTypCd": "11",
            "ourChrgRate": 100,
            "entrChrgRate": 0,
            "cpnIsuNo": "4364872",
            "aplyYn": "Y"
          }
        ],
        "reCalAdtnOcurGbCdAdtnAmt": 1
      }
    ],
    "refundPaymentMethodList": [
      {
        "payNo": "2",
        "mbrNo": "100000001",
        "ordNo": "20990101O000001",
        "claimNo": "20990101C000001",
        "uprPayNo": "1",
        "payGbCd": "10",
        "payGbCdNm": "결제",
        "payWayCd": "11",
        "payWayCdNm": "신용카드",
        "payStatCd": "12",
        "payStatCdNm": "결제완료",
        "payAmt": 10000,
        "taxFreeAmt": 10000,
        "rfdPsbAmt": 10000,
        "rfdAmt": 1000,
        "payFnshDtm": "2026-01-01T00:00:00.000Z",
        "trdNo": "INIMX_CARDINIpayTest20990101090000685510",
        "trdDtm": "2026-01-01T00:00:00.000Z",
        "iscmCd": "202",
        "iscmCdNm": "KB국민카드",
        "payReqCardcoCd": "06",
        "payReqCardcoCdNm": "국민카드",
        "cardNo": "카드번호 암호화",
        "cardNm": "국민카드",
        "cardValiTerm": "text",
        "nintDivYn": "N",
        "divMonCnt": 0,
        "cardPointUseYn": "N",
        "mersNo": "1",
        "acqrCd": "121",
        "acqrCdNm": "국민카드",
        "aprvNo": "12345678",
        "aprvDtm": "2026-01-01T00:00:00.000Z",
        "sctnCnclPsbYn": "Y",
        "bankCd": "148",
        "bankCdNm": "국민은행",
        "actnNo": "계좌번호 암호화",
        "dpmnNm": "김플래티어",
        "dptFcstDt": "2099-01-01 09:00:00.000000",
        "dptCnfmDtm": "2026-01-01T00:00:00.000Z",
        "rfdBankCd": "148",
        "rfdBankCdNm": "국민은행",
        "rfdActnNo": "계좌번호 암호화",
        "rfdActnDepositorNm": "홍길동",
        "vbankPaymentPending": true,
        "vbankDptCnfm": true
      }
    ],
    "paymentOrderInfo": {
      "ordNo": "20990101O000001",
      "claimNo": "20990101C000001",
      "goodsNm": "플래티어커피",
      "ordManNm": "김플래티어",
      "ordmnCellNo": 1012345678,
      "ordmnEmailAddr": "kim@plateer.com",
      "crcUnitCd": "KRW",
      "ordMediaCd": "30",
      "mbrNo": "100000001",
      "ordDtlGbCd": "10",
      "clientIp": "127.0.0.1",
      "taxFreeAmt": 1
    },
    "rfdInfoResponse": {
      "rfdBankCd": "203",
      "rfdBankNm": "KB국민은행",
      "rfdActnNo": "33330********",
      "rfdActnDepositorNm": "임성현",
      "rfdActnCertiYn": "Y"
    }
  },
  "wthdFnshWaitProcCaus": "불량반품",
  "occurPayment": true,
  "existAddtionPayAmt": true,
  "claimBusiness": "11"
}
{
  "ordNo": "20230808O007404",
  "claimNo": "20230808C010663"
}
PreviousClaim Common
NextRegular Order History Lookup

Last updated