Order Return

Withdraw Return (BO)

post

Function Description

Withdraws a registered return request.

Detailed Description

Withdrawal is possible when the order history type (OM003) value is Return (20) and the order history status (OM005) value is Payment Pending (31), Registered (32), or Collection Instructed (34).
Before withdrawing the return, checks the order status at the time the API is called to verify whether withdrawal is possible.
Creates and updates the return withdrawal data.
If the order history status (OM005) of the return withdrawal target is Collection Instructed (34), updates the delivery instruction cancellation quantity.
Cancels the payment for any costs incurred at the time of return registration.
Validates the payment and refund amounts arising from the return withdrawal.
If a free return coupon was used at the time of return registration, restores the coupon.
Sends a notification to the customer after the return withdrawal is completed. (Email/AlimTalk/Notification box)
Creates a processing history after the return withdrawal is completed.

Special Notes

This API is exclusively for BO use. Access is only allowed through BO.

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

Example: 11Possible values:

Responses

200

Success

*/*

ordNostringOptional

Order No.

Example: 20230808O007404

claimNostringOptional

Claim No.

Example: 20230808C010663

900

Business processing error details

*/*

post/v1/claim/return/withdrawalReturn

POST /api/order/v1/claim/return/withdrawalReturn 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 Return (FO)

post

Function Description

Withdraws a registered return request.

Detailed Description

Verifies authority by comparing the member information (including non-members) in the order base table with the login information.
Withdrawal is possible when the order history type (OM003) value is Return (20) and the order history status (OM005) value is Payment Pending (31), Registered (32), or Collection Instructed (34).
Before withdrawing the return, checks the order status at the time the API is called to verify whether withdrawal is possible.
Creates and updates the return withdrawal data.
If the order history status (OM005) of the return withdrawal target is Collection Instructed (34), updates the delivery instruction cancellation quantity.
Cancels the payment for any costs incurred at the time of return registration.
Validates the payment and refund amounts arising from the return withdrawal.
If a free return coupon was used at the time of return registration, restores the coupon.
Sends a notification to the customer after the return withdrawal is completed. (Email/AlimTalk/Notification box)
Creates a processing history after the return withdrawal is completed.

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

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

Example: 11Possible values:

Responses

200

Success

*/*

ordNostringOptional

Order No.

Example: 20230808O007404

claimNostringOptional

Claim No.

Example: 20230808C010663

900

Business processing error details

*/*

post/v1/claim/return/withdrawalReturnFO

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

Return During Exchange (BO)

post

Function Description

Processes a return while an exchange request is in progress.

Detailed Description

Processing is possible when the order history type (OM003) value is Exchange (30) and the order history status (OM005) value is Collection Confirmed (35).
Re-checks the order status at the time the API is called to verify whether the exchange-to-return processing is possible.
When processing a return during an exchange, withdraws the target exchange and proceeds with the return process. However, unlike a regular return registration, the return-during-exchange status (exchMidRtnYn) value is created as (Y).
Since the fault lies with the company in the case of a return during an exchange, no additional shipping fee payment is incurred.
Creates a processing history after the return-during-exchange processing.

Special Notes

This API is exclusively for BO use. Access is only allowed through BO.

Revision History

release_231009_01 : Added order quantity and cancel quantity columns to the order benefit relationship table
Release v2.00_240509 : Changed the default setting of the delivery instruction date/time from null to the current date/time when a return is registered after an exchange cancellation

Header parameters

AuthorizationanyOptional

Access Token

Body

Claim Processing Request DTO

systemTypestring · enumRequired

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

Example: 10Possible values:

claimBusinessTypestring · enumRequired

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

Example: 11Possible values:

Responses

200

Success

*/*

ordNostringOptional

Order No.

Example: 20230808O007404

claimNostringOptional

Claim No.

Example: 20230808C010663

900

Business processing error details

*/*

post/v1/claim/return/transformReturn

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

Search Return Request Targets (BO)

post

Function Description

Retrieves the order history, the list of products eligible for return, and other information needed for screen processing.

Detailed Description

Order No. (ordNo), Claim Business Type (claimBusinessType), and System Type (systemType) are required parameters.
Return processing is possible for targets that satisfy all of the following conditions:
1. Order history type (OM003) value is General Order (10) or Exchange (30)
2. Order history status (OM005) value is Shipped (26) or Delivered (27)
3. Return availability value is "Y"
4. The item is a general product (excluding free gifts)
5. Available return quantity is 1 or more ( Order Quantity – Cancel Quantity – Return Quantity > 0 )
The list of common codes included in the other information is as follows:
1. Claim Major Category Code (OM047)
2. Claim Medium Category Code (OM006)
3. Delivery Message Code (ME039)
4. Common Entrance Access Method Code (ME040)
5. Fault Type Code (CS020)
6. Additional Cost Detail Type Code (OM019)
7. Order Cost Type Code (OM043)
8. Payment Method Code (OM013)

Special Notes

This API is exclusively for BO use. Access is only allowed through BO.

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_240729 : Added e-coupon usage status check; filters claim reasons by product type Added collection status (wthdYn) / e-coupon No. (ecpnNo) / e-ticket No. (etcktNo) / non-returnable order flag (isAllNonReturnable) / e-coupon order flag (isAllEcoupon)

Header parameters

AuthorizationanyOptional

Access Token

Body

Search Return Processing Targets Request DTO

ordNostringRequired

Order No.

Example: 20230809O000001

claimBusinessTypestring · enumRequired

Example: 11Possible values:

systemTypestring · enumRequired

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

Example: 10Possible values:

dlvpSeqstringOptional

Delivery Address Sequence No.

Example: 1

Responses

200

Success

*/*

Search Return Processing Targets Response DTO

claimBusinessTypestring · enumOptional

Example: 11Possible values:

900

Business processing error details

*/*

post/v1/claim/return/returnTargetInfo

POST /api/order/v1/claim/return/returnTargetInfo HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 84

{
  "ordNo": "20230809O000001",
  "claimBusinessType": "11",
  "systemType": "10",
  "dlvpSeq": "1"
}

{
  "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"
      }
    ]
  },
  "claimBusinessType": "11"
}

Search Return Request Targets (FO)

post

Function Description

Retrieves the order history, the list of products eligible for return, and other information needed for screen processing.

Detailed Description

When retrieving return processing targets, verifies authority by comparing the order member information (including non-members) with the login information.
Order No. (ordNo), Claim Business Type (claimBusinessType), and System Type (systemType) are required parameters.
Return processing is possible for targets that satisfy all of the following conditions:
1. Order history type (OM003) value is General Order (10) or Exchange (30)
2. Order history status (OM005) value is Shipped (26) or Delivered (27)
3. Return availability value is "Y"
4. The item is a general product (excluding free gifts)
5. Available return quantity is 1 or more ( Order Quantity – Cancel Quantity – Return Quantity > 0 )
The list of common codes included in the other information is as follows:
1. Claim Major Category Code (OM047)
2. Claim Medium Category Code (OM006)
3. Delivery Message Code (ME039)
4. Common Entrance Access Method Code (ME040)
5. Fault Type Code (CS020)
6. Additional Cost Detail Type Code (OM019)
7. Order Cost Type Code (OM043)
8. Payment Method Code (OM013)

Revision History

release_231023 : For members, removed the process of looking up secondary payment method and mileage information (separated into a dedicated API)
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_240729 : Added e-coupon usage status check; filters claim reasons by product type Added collection status (wthdYn) / e-coupon No. (ecpnNo) / e-ticket No. (etcktNo) / non-returnable order flag (isAllNonReturnable) / e-coupon order flag (isAllEcoupon)

Header parameters

AuthorizationanyOptional

Access Token

Body

Search Return Processing Targets Request DTO

ordNostringRequired

Order No.

Example: 20230809O000001

claimBusinessTypestring · enumRequired

Example: 11Possible values:

systemTypestring · enumRequired

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

Example: 10Possible values:

dlvpSeqstringOptional

Delivery Address Sequence No.

Example: 1

Responses

200

Success

*/*

Search Return Processing Targets Response DTO

claimBusinessTypestring · enumOptional

Example: 11Possible values:

900

Business processing error details

*/*

post/v1/claim/return/returnTargetInfoFO

POST /api/order/v1/claim/return/returnTargetInfoFO HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 84

{
  "ordNo": "20230809O000001",
  "claimBusinessType": "11",
  "systemType": "10",
  "dlvpSeq": "1"
}

{
  "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"
      }
    ]
  },
  "claimBusinessType": "11"
}

Hold Return (BO)

post

Function Description

Processes a return hold.

Detailed Description

Processing is possible when the order history type (OM003) value is Return (20) and the order history status (OM005) value is Collection Confirmed (35) or Collection Completed (36).
Re-checks the order status at the time the API is called to verify whether the hold processing is possible.
If a shipping fee was incurred when processing the return hold, changes the order status to Payment Pending.
When processing a return as not possible, the collection-completion pending processing reason (wthdFnshWaitProcCaus) is a required value.

Special Notes

This API is exclusively for BO use. Access is only allowed through BO.

Revision History

Release v2.00_240729 : If the collection status of all return registration targets is 'N', return shipping fee is excluded from being charged

Header parameters

AuthorizationanyOptional

Access Token

Body

Claim Processing Request DTO

systemTypestring · enumRequired

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

Example: 10Possible values:

claimBusinessTypestring · enumRequired

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

Example: 11Possible values:

Responses

200

Success

*/*

ordNostringOptional

Order No.

Example: 20230808O007404

claimNostringOptional

Claim No.

Example: 20230808C010663

900

Business processing error details

*/*

post/v1/claim/return/returnPending

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

Reject Return (BO)

post

Function Description

Processes a return as not possible.

Detailed Description

Processing is possible when the order history type (OM003) value is Return (20) and the order history status (OM005) value is Collection Confirmed (35) or Collection Completed (36).
Re-checks the order status at the time the API is called to verify whether the not-possible processing is possible.
When processing a return as not possible, withdraws the target return, and the return availability (rtnPsbYn) attribute value in the order detail table is changed to (N).
When processing a return as not possible, the collection-completion pending processing reason (wthdFnshWaitProcCaus) is a required value.
The collection completion type code value in the order delivery information (OP_ORD_DELI_INFO) table is automatically saved as Defective Return (20).
Creates a processing history after the return is processed as not possible.

Special Notes

This API is exclusively for BO use. Access is only allowed through BO.

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

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

Example: 11Possible values:

Responses

200

Success

*/*

ordNostringOptional

Order No.

Example: 20230808O007404

claimNostringOptional

Claim No.

Example: 20230808C010663

900

Business processing error details

*/*

post/v1/claim/return/rejectReturn

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

Complete Return (BO)

post

Function Description

Completes processing of a return request.

Detailed Description

Processing is possible when the order history type (OM003) value is Return (20) and the order history status (OM005) value is Collection Completed (36).
Re-checks the order status at the time the API is called to verify whether the completion processing is possible.
The order history status code (OM005) value in the order detail table is changed to Return Completed (37) (including free gifts), and the order completion date/time (ordFnshDtm) is updated.
Updates the delivery completion date/time (deliFnshDtm) in the order delivery information table.
The stock of coupons used at the time of order and of the order product (including free gifts) is restored. However, if the return-during-exchange status (exchMidRtnYn) in the order detail is (Y) and the order history status is Collection Completed (36), it is excluded from stock restoration.
Proceeds with the refund process.
Sends a notification to the customer after the return is completed. (Email/AlimTalk/Notification box)
Creates a processing history after the return is completed.

Special Notes

This API is exclusively for BO use. Access is only allowed through BO.

Revision History

Release v2.00_240729 : If the collection status of the return registration target is 'N', excludes it from stock restoration
Release v2.00_250801 : Fixed an issue where the exchange product's shipping fee was refunded when a return was completed after an exchange application that incurred an additional payment

Header parameters

AuthorizationanyOptional

Access Token

Body

Claim Processing Request DTO

systemTypestring · enumRequired

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

Example: 10Possible values:

claimBusinessTypestring · enumRequired

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

Example: 11Possible values:

Responses

200

Success

*/*

ordNostringOptional

Order No.

Example: 20230808O007404

claimNostringOptional

Claim No.

Example: 20230808C010663

900

Business processing error details

*/*

post/v1/claim/return/completeReturn

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

Complete Return (Batch)

post

Function Description

Completes processing of a return request.

Detailed Description

Processing is possible when the order history type (OM003) value is Return (20) and the order history status (OM005) value is Collection Completed (36).
Re-checks the order status at the time the API is called to verify whether the completion processing is possible.
The order history status code (OM005) value in the order detail table is changed to Return Completed (37) (including free gifts), and the order completion date/time (ordFnshDtm) is updated.
Updates the delivery completion date/time (deliFnshDtm) in the order delivery information table.
The stock of coupons used at the time of order and of the order product (including free gifts) is restored. However, if the return-during-exchange status (exchMidRtnYn) in the order detail is (Y) and the order history status is Collection Completed (36), it is excluded from stock restoration.
Proceeds with the refund process.
Sends a notification to the customer after the return is completed. (Email/AlimTalk/Notification box)
Creates a processing history after the return is completed.

Special Notes

This API is exclusively for BATCH use.

Revision History

Release v2.00_240729 : If the collection status of the return registration target is 'N', excludes it from stock restoration

Header parameters

AuthorizationanyOptional

Access Token

Bodyobject · ClaimRequest[]

Claim Processing Request DTO

systemTypestring · enumRequired

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

Example: 10Possible values:

claimBusinessTypestring · enumRequired

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

Example: 11Possible values:

Responses

200

Success

No content

900

Business processing error details

*/*

post/v1/claim/return/completeReturnBatch

POST /api/order/v1/claim/return/completeReturnBatch HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 5000

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

No content

Register Return (BO)

post

Function Description

Registers a return target.

Detailed Description

Before registering the return, checks the order status at the time the API is called to verify whether registration is possible.
Validates the return registration request data for the following items:
1. Checks whether the delivery number of the registered product matches (→ Claim not possible)
2. Checks whether the registered product includes a free gift (→ Partial quantity claim not possible)
3. Checks whether a payment method that does not allow partial cancellation was used (→ Partial claim not possible)
4. Based on the order number, checks whether there is a previously registered return with an initial shipping fee incurred and in a return-cancellable status (payment pending, registered, collection instructed) (→ Additional return registration not possible)
5. If the current return registration incurs an initial shipping fee, checks whether there is a previously registered return in a return-cancellable status (payment pending, registered, collection instructed) (→ Additional return registration not possible)
Creates and updates the return registration data.
If an additional payment amount is incurred,
1. If the additional payment amount is greater than the expected refund amount, the order history status (OM005) value is saved as Payment Pending (31), and the customer must pay the additional shipping fee.
2. If the additional payment amount is less than or equal to the expected refund amount, the refund is issued minus the additional payment amount.
Validates the payment and refund amounts arising from the return registration.
If a free return coupon was used at the time of return registration, marks the coupon as used.
Sends a notification to the customer after the return registration is completed. (Email/AlimTalk/Notification box)
Creates a processing history after the return registration is completed.

Special Notes

This API is exclusively for BO use. Access is only allowed through BO.

Revision History

release_231009_01 : Added order quantity and cancel quantity columns to the order benefit relationship table
Release v2.00_240729 : If the collection status of all return registration targets is 'N', return shipping fee is excluded from being charged For returns of e-coupon products, disables e-coupon usage

Header parameters

AuthorizationanyOptional

Access Token

Body

Claim Processing Request DTO

systemTypestring · enumRequired

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

Example: 10Possible values:

claimBusinessTypestring · enumRequired

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

Example: 11Possible values:

Responses

200

Success

*/*

ordNostringOptional

Order No.

Example: 20230808O007404

claimNostringOptional

Claim No.

Example: 20230808C010663

900

Business processing error details

*/*

post/v1/claim/return/acceptReturn

POST /api/order/v1/claim/return/acceptReturn 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 Return (FO)

post

Function Description

Registers a return target.

Detailed Description

Verifies authority by comparing the member information (including non-members) in the order base table with the login information.
Before registering the return, checks the order status at the time the API is called to verify whether registration is possible.
Validates the return registration request data for the following items:
1. Checks whether the delivery number of the registered product matches (→ Claim not possible)
2. Checks whether the registered product includes a free gift (→ Partial quantity claim not possible)
3. Checks whether a payment method that does not allow partial cancellation was used (→ Partial claim not possible)
4. Based on the order number, checks whether there is a previously registered return with an initial shipping fee incurred and in a return-cancellable status (payment pending, registered, collection instructed) (→ Additional return registration not possible)
5. If the current return registration incurs an initial shipping fee, checks whether there is a previously registered return in a return-cancellable status (payment pending, registered, collection instructed) (→ Additional return registration not possible)
Creates and updates the return registration data.
If an additional payment amount is incurred, proceeds with the payment.
Validates the payment and refund amounts arising from the return registration.
If a free return coupon was used at the time of return registration, marks the coupon as used.
Sends a notification to the customer after the return registration is completed. (Email/AlimTalk/Notification box)
Creates a processing history after the return registration is completed.

Revision History

release_231009_01 : Added order quantity and cancel quantity columns to the order benefit relationship table
Release v2.00_240700 : If the collection status of all return registration targets is 'N', return shipping fee is excluded from being charged For returns of e-coupon products, disables e-coupon usage

Header parameters

AuthorizationanyOptional

Access Token

Body

Claim Processing Request DTO

systemTypestring · enumRequired

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

Example: 10Possible values:

claimBusinessTypestring · enumRequired

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

Example: 11Possible values:

Responses

200

Success

*/*

ordNostringOptional

Order No.

Example: 20230808O007404

claimNostringOptional

Claim No.

Example: 20230808C010663

900

Business processing error details

*/*

post/v1/claim/return/acceptReturnFO

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

PreviousCustomer Center Provision

NextOrder Change

Last updated 1 month ago