Order Exchange

Withdraw Exchange Receipt

post

Function Description

Withdraws an exchange receipt target in BO.

Detailed Description

Order No. (ordNo), Claim Business Type (claimBusinessType), and System Type (systemType) are required.
Exchange withdrawal processing is possible for targets that satisfy all of the following conditions.
- The Order History Type (OM003) value is Exchange (30)
- The Order History Status (OM005) value is Payment Pending (31), Exchange Received (32), or Collection Instruction (34)
Updates the existing order exchange data and creates order exchange withdrawal data.
Verifies the payment information that occurs upon exchange withdrawal.
Performs stock adjustment processing.

Notes

Exchange receipt withdrawal proceeds only when Claim Business Type (claimBusinessType) is Exchange Withdrawal (31).

Revision History

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Claim Processing Request DTO

systemTypestring · enum · min: 1Required

System Type

Example: 10Possible values:

claimBusinessTypestring · enum · min: 1Required

Claim Business Type

Example: 20Possible values:

ordMediaCdstring · min: 1Required

Order Channel Code (OM007)

Example: 20

ordNostringOptional

Order No.

Example: 20230808O007404

mbrNostringOptional

Member No.

Example: 100001311

claimNostringOptional

Claim No.

Example: 20230808C010663

wthdFnshWaitProcCausstringOptional

Pickup Completion Pending Reason

Responses

200

Success

No content

900

Business processing error details

*/*

post/v1/claim/exchange/withdrawalExchange

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

{
  "systemType": 10,
  "claimBusinessType": 20,
  "ordMediaCd": 20,
  "ordNo": "20230808O007404",
  "mbrNo": 100001311,
  "claimNo": "20230808C010663",
  "claimGoodsList": [
    {
      "ordSeq": 1,
      "ordProcSeq": 1,
      "goodsNo": 10002297,
      "itmNo": "001",
      "exchangeGoodsNo": 10002297,
      "exchangeItmNo": "001",
      "exchangeItmNm": "001",
      "claimQty": 1,
      "claimLgrpCd": 10,
      "claimMgrpCd": 100,
      "claimCausEtcCont": "배송이 늦어짐",
      "withdrawalDeliNo": 100013106,
      "shipmentDeliNo": 100013105
    }
  ],
  "claimCpnInfoList": [
    {
      "cpnNo": 104224
    }
  ],
  "claimReturnDlvp": {
    "mbrOrdDlvpGb": 10,
    "dlvpSeq": 1,
    "zipNoSeq": 1,
    "dlvpNm": "집",
    "rcvmnNm": "홍길동",
    "zipNo": "05836",
    "zipAddr": "서울 송파구 법원로9길 26",
    "dtlAddr": "에이치비지니스파크 D동 6층",
    "rcvmnEmailAddr": "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": "05836",
    "zipAddr": "서울 송파구 법원로9길 26",
    "dtlAddr": "에이치비지니스파크 D동 6층",
    "rcvmnEmailAddr": "x2bee@plateer.com",
    "rcvmnCellSctNo": "010",
    "rcvmnCellTxnoNo": 1234,
    "rcvmnCellEndNo": 5678,
    "rcvmnTelRgnNo": "02",
    "rcvmnTelTxnoNo": 123,
    "rcvmnTelEndNo": 4567,
    "deliMsg": "부재 시 문 앞에 놓아주세요.",
    "deliMsgCd": 30,
    "shopTrafMsg": "문 앞에 놓아주세요.",
    "comnFrdrCogoMethodCd": 20,
    "comnFrdrEtcMethod": "자유 출입 가능",
    "comnFrdrPwd": 1234
  },
  "claimFinalAmtInfo": {
    "ordNo": "20230913O058186",
    "totAplyAdtnAmt": 6000,
    "totCnclAdtnAmt": 0,
    "totFvrAdtnAmt": 0,
    "totOrdPrc": 46000,
    "totDcAmt": 2200,
    "expectedRefundAmt": 37800,
    "addtionPayAmt": 0,
    "returnAcceptAmt": 37800,
    "refundAdditionAmtInfoList": [
      {
        "adtnOcurGbCd": 10,
        "adtnOcurGbNm": "발생",
        "type": 20,
        "typeNm": "회수배송비",
        "goodsNoItmNo": 10002762001,
        "goodsNm": "상품명",
        "ordAmt": 6000,
        "discountMethod": 11,
        "discountMethodNm": "상품할인쿠폰",
        "cnclDcAmt": 2000,
        "rtnDlvBenefitInfoList": [
          {
            "promoNo": "C1003841",
            "promoNm": "무료반품쿠폰",
            "promoTypCd": 15,
            "ourChrgRate": 100,
            "entrChrgRate": 0,
            "cpnIsuNo": 4364872,
            "aplyYn": "Y"
          }
        ]
      }
    ],
    "refundPaymentMethodList": [
      {
        "payNo": 2,
        "ordNo": "20990101O000001",
        "claimNo": "20990101C000001",
        "uprPayNo": 1,
        "payGbCd": 10,
        "payGbCdNm": "결제",
        "payWayCd": 11,
        "payWayCdNm": "신용카드",
        "payStatCd": 12,
        "payStatCdNm": "결제완료",
        "payAmt": 10000,
        "rfdPsbAmt": 10000,
        "rfdAmt": 1000,
        "payFnshDtm": "2099-01-01 09:00:00.000000",
        "trdNo": "INIMX_CARDINIpayTest20990101090000685510",
        "trdDtm": "2099-01-01 09:00:00.000000",
        "iscmCd": 202,
        "iscmCdNm": "KB국민카드",
        "payReqCardcoCd": "06",
        "payReqCardcoCdNm": "국민카드",
        "cardNo": "카드번호 암호화",
        "cardNm": "국민카드",
        "cardValiTerm": "text",
        "nintDivYn": "N",
        "divMonCnt": 0,
        "cardPointUseYn": "N",
        "mersNo": 1,
        "acqrCd": 121,
        "acqrCdNm": "국민카드",
        "aprvNo": 12345678,
        "aprvDtm": "2099-01-01 09:00:00.000000",
        "sctnCnclPsbYn": "Y",
        "bankCd": 148,
        "bankCdNm": "국민은행",
        "actnNo": "계좌번호 암호화",
        "dpmnNm": "김플래티어",
        "dptFcstDt": "2099-01-01 09:00:00.000000",
        "dptCnfmDtm": "2099-01-01 09:00:00.000000",
        "rfdBankCd": 148,
        "rfdBankCdNm": "국민은행",
        "rfdActnNo": "계좌번호 암호화",
        "rfdActnDepositorNm": "홍길동"
      }
    ],
    "rfdInfoResponse": {
      "rfdBankCd": 203,
      "rfdBankNm": "KB국민은행",
      "rfdActnNo": "33330********",
      "rfdActnDepositorNm": "임성현",
      "rfdActnCertiYn": "Y"
    }
  },
  "wthdFnshWaitProcCaus": "text"
}

No content

Check Exchange Claim Option Change Target

post

Function Description

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

Detailed Description

Product No. (goodsNo) and Item No. (itmNo) are required.
Checks all of the following conditions.
- Checks whether the option change target's Sales Status Code (PR005) is On Sale (10).
- Checks whether the option change target's Sales Method Code (PR003) is General Sale (10).
- Checks whether the option change target has the same price as the existing target.
- Checks the stock of the option change target.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Bodyobject · ClaimGoodsItmInfoRequest[]

Exchange Claim Option Change Target Request DTO

goodsNostringRequired

Product No.

Example: 10002552

itmNostringRequired

Item No.

Example: 001

claimQtyinteger · int32Optional

Claim Quantity

Example: 1

salePrcnumberOptional

Selling Price

Example: 2500

Responses

200

Success

No content

900

Business processing error details

*/*

post/v1/claim/exchange/isExistsExchangeGoodsItm

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

[
  {
    "goodsNo": 10002552,
    "itmNo": "001",
    "claimQty": 1,
    "salePrc": 2500
  }
]

No content

Retrieve Return/Exchange Withdrawal Targets

post

Function Description

Retrieves return/exchange withdrawal targets in BO.

Detailed Description

Order No. (ordNo), Claim Business Type (claimBusinessType), and System Type (systemType) are required.
Return/exchange withdrawal processing is possible for targets that satisfy all of the following conditions.
- The Order History Type (OM003) value is Return (20) or Exchange (30)
- The Order History Status (OM005) value is Payment Pending (31), Return/Exchange Received (32), or Collection Instruction (32)
- The Return Available Status (rtnPsbYn) value is Y
- The item is a general product (excluding free gifts)
- The withdrawable quantity is 1 or more ( Order Quantity – Cancellation Quantity – Return Quantity > 0 )

Revision History

Release v2.00_240729 : Added collection status (wthdYn)
Release v2.00_240829 : Updated masking processing

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Claim Eligibility Search Request DTO

ordNostringRequired

Order No.

Example: 20230808O007404

claimBusinessTypestring · enumOptional

Claim Business Type

Example: 20Possible values:

systemTypestringRequired

System Type

Example: 10

Responses

200

Success

*/*

Claim Processing Target Response DTO

ordNostringOptional

Order No.

Example: 20231231O000001

mbrNostringOptional

Member No.

Example: 100001311

ordManNmstringOptional

Orderer Name

Example: 홍길동

ordMediaCdstringOptional

Order Channel Code (OM007) 20: PC, 30: Mobile Web, 40: Android App, 50: iOS App

Example: 10

sctnCnclPsbYnstring · enumOptional

Partial Cancellation Availability Status

Example: NPossible values:

vbankPaymentPendingbooleanOptional

allNonReturnablebooleanOptional

allEcouponbooleanOptional

900

Business processing error details

*/*

post/v1/claim/exchange/getReturnExchangeCancelTargetInfo

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

{
  "ordNo": "20230808O007404",
  "claimBusinessType": 20,
  "systemType": 10
}

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

Retrieve Exchange Order List

post

Function Description

Retrieves the exchange order list in BO.

Detailed Description

The order exchange quantity is 1 or more ( Order Quantity – Cancellation Quantity – Return Quantity > 0 )
The Order History Type (OM003) value is Exchange (30)
- In addition to the above (basic) conditions, further search conditions are added according to the given search conditions.
- The exchange reason code is taken from entries in the claim middle-category code (OM006) whose ref_1_val is 30 (Exchange).

Revision History

Release v2.00_240613: Improved period search conditions
Release v2.00_240919: Improved site, multi-product, and multi-order search conditions

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Exchange Order Inquiry Request DTO

siteNostringOptional

Site No.

Example: 1

entrNostringOptional

Vendor No.

Example: 1000002

exchgStrtDtstring · dateOptional

Search Condition Start Date

Example: 2023-01-01

exchgEndDtstring · dateOptional

Search Condition End Date

Example: 2023-12-31

allDateYnbooleanOptional

Full Period Status

Example: true

loginIdstringOptional

Member ID

Example: id001

ordDtlStatCdstring · enumOptional

Order Detail Status Code (OM005)

Example: 11Possible values:

ordNostringOptional

Order No.

Example: 20230101O000000

ordNoListstring[]Optional

Order No. List

Example: 20230101O000000

manNmOptstringOptional

Order/Recipient Condition

Example: ordManNm

manNmstringOptional

Order/Recipient Content

Example: 주문자명

ordGbCdstringOptional

Order Type Code (OM002) 10: General Order

Example: 10

deliKindCdstringOptional

Delivery Type Code (LO009) 10: General Delivery, 20: Reserved Delivery

Example: 10

claimCausCdstringOptional

Exchange Reason Code (OM006)

Example: 302

goodsNoRngstringOptional

Product No. Condition

Example: st

goodsNostringOptional

Product No.

Example: 10002297

goodsNoListstringOptional

Product No. List

Example: 10002297

goodsNosstring[]Optional

Product No. List

Example: 10002297

goodsNoFromstringOptional

Start Product No.

Example: 10002297

goodsNoTostringOptional

End Product No.

Example: 10002297

goodsNmstringOptional

Product Name

Example: 상품명입니다

Responses

200

Success

*/*

totalCountinteger · int32Optional

900

Business processing error details

*/*

post/v1/claim/exchange/getExchangeOrderList

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

{
  "siteNo": 1,
  "entrNo": 1000002,
  "exchgStrtDt": "2023-01-01",
  "exchgEndDt": "2023-12-31",
  "allDateYn": true,
  "loginId": "id001",
  "ordDtlStatCd": 11,
  "ordNo": "20230101O000000",
  "ordNoList": "20230101O000000",
  "manNmOpt": "ordManNm",
  "manNm": "주문자명",
  "ordGbCd": 10,
  "deliKindCd": 10,
  "claimCausCd": 302,
  "goodsNoRng": "st",
  "goodsNo": 10002297,
  "goodsNoList": 10002297,
  "goodsNos": 10002297,
  "goodsNoFrom": 10002297,
  "goodsNoTo": 10002297,
  "goodsNm": "상품명입니다"
}

{
  "totalCount": 1,
  "payloads": [
    {
      "siteNm": "플래티어닷컴",
      "ordNo": "20230101O000001",
      "ordSeq": 1,
      "ordDtlGbCd": 30,
      "ordDtlGbCdNm": "교환",
      "ordDtlStatCd": 32,
      "ordDtlStatCdNm": "교환접수",
      "ordAccpDtm": "2023-01-01 01:01:01",
      "goodsNo": 10002297,
      "goodsNm": "상품명",
      "itmNm": "블루/1",
      "brandNm": "플래티어",
      "ordQty": 1,
      "claimMgrpCd": 302,
      "claimMgrpCdNm": "색상변경",
      "claimCausEtcCont": "클레임사유",
      "loginId": "id001",
      "mbrGradeCdNm": "FAMILY",
      "mgrTypCd": 301,
      "mgrTypCdNm": "VIP회원",
      "ordManNm": "홍길동",
      "ordManCellSctNo": "010",
      "ordManCellTxnoNo": 1234,
      "ordManCellEndNo": 5678,
      "rcvmnNm": "홍길동",
      "deliIndiDtm": "2023-01-01 00:00:00",
      "hdcCd": 10,
      "hdcCdNm": "우체국택배",
      "invNo": 123456789,
      "mbrNo": 100001311,
      "ordGbCdNm": "일반주문",
      "entrNm": "플래티어",
      "mbrGbCdNm": "정회원",
      "rcvmnCellSctNo": "010",
      "rcvmnCellTxnoNo": 1234,
      "rcvmnCellEndNo": 5678,
      "instMbrYn": "text"
    }
  ]
}

Retrieve Order Exchange Targets

post

Function Description

Retrieves order exchange targets in BO.

Detailed Description

Order No. (ordNo), Claim Business Type (claimBusinessType), and System Type (systemType) are required.
Exchange receipt processing is possible for targets that satisfy all of the following conditions.
- The Order History Type (OM003) value is General Order (10) or Exchange (30)
- The Order History Status (OM005) value is Shipment Complete (26) or Delivery Complete (27)
- The Return Available Status (rtnPsbYn) value is Y
- The item is a general product (excluding free gifts)
- The exchangeable quantity is 1 or more ( Order Quantity – Cancellation Quantity – Return Quantity > 0 )

Notes

Exchange targets are retrieved only when Claim Business Type (claimBusinessType) is Exchange (30).

Revision History

release v2.00_240409 : Fixed a typo in the Response DTO ( CaimTargetResponse -> ClaimTargetResponse )
Release v2.00_240729 : Added collection status (wthdYn), collection-not-required order status (isAllNonReturnable)

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Claim Eligibility Search Request DTO

ordNostringRequired

Order No.

Example: 20230808O007404

claimBusinessTypestring · enumOptional

Claim Business Type

Example: 20Possible values:

systemTypestringRequired

System Type

Example: 10

Responses

200

Success

*/*

Exchange Order Claim Target Response DTO

900

Business processing error details

*/*

post/v1/claim/exchange/getExchageTargetInfo

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

{
  "ordNo": "20230808O007404",
  "claimBusinessType": 20,
  "systemType": 10
}

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

Exchange Receipt

post

Function Description

Processes the receipt of an exchange target in BO.

Detailed Description

Order No. (ordNo), Claim Business Type (claimBusinessType), and System Type (systemType) are required.
All exchange receipt targets must have the same delivery number to be received.
Checks whether the exchange receipt target includes a free gift (if a free gift is included, partial claim is not possible)
Exchange processing is possible for exchange targets that satisfy all of the following conditions.
- Checks whether the product is valid.
  - Checks whether the Sales Status Code (PR005) of the product to be exchanged is On Sale (10).
  - Checks whether the Sales Method Code (PR003) of the product to be exchanged is General Sale (10).
  - Checks whether the product to be exchanged has the same price as the exchange target product.
  - Checks the stock of the product to be exchanged.
Creates and updates order exchange data.
- If the Claim Major Category Code (claimLgrpCd) is Simple Change of Mind (10), a shipping fee is incurred.
  - If an additional payment amount (shipping fee) occurs, the Order History Status (OM005) value changes to Payment Pending (31) instead of Exchange Received (32).
  - If the status is Payment Pending (31), payment must be made through the shipping fee payment screen in the FO for the status to become Exchange Received (32).
Verifies the payment information that occurs upon exchange receipt.
Performs stock adjustment processing.
Processes notification message sending after exchange receipt.

Notes

Exchange receipt proceeds only when Claim Business Type (claimBusinessType) is Exchange (30).

Revision History

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Claim Processing Request DTO

systemTypestring · enum · min: 1Required

System Type

Example: 10Possible values:

claimBusinessTypestring · enum · min: 1Required

Claim Business Type

Example: 20Possible values:

ordMediaCdstring · min: 1Required

Order Channel Code (OM007)

Example: 20

ordNostringOptional

Order No.

Example: 20230808O007404

mbrNostringOptional

Member No.

Example: 100001311

claimNostringOptional

Claim No.

Example: 20230808C010663

wthdFnshWaitProcCausstringOptional

Pickup Completion Pending Reason

Responses

200

Success

No content

900

Business processing error details

*/*

post/v1/claim/exchange/acceptExchange

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

{
  "systemType": 10,
  "claimBusinessType": 20,
  "ordMediaCd": 20,
  "ordNo": "20230808O007404",
  "mbrNo": 100001311,
  "claimNo": "20230808C010663",
  "claimGoodsList": [
    {
      "ordSeq": 1,
      "ordProcSeq": 1,
      "goodsNo": 10002297,
      "itmNo": "001",
      "exchangeGoodsNo": 10002297,
      "exchangeItmNo": "001",
      "exchangeItmNm": "001",
      "claimQty": 1,
      "claimLgrpCd": 10,
      "claimMgrpCd": 100,
      "claimCausEtcCont": "배송이 늦어짐",
      "withdrawalDeliNo": 100013106,
      "shipmentDeliNo": 100013105
    }
  ],
  "claimCpnInfoList": [
    {
      "cpnNo": 104224
    }
  ],
  "claimReturnDlvp": {
    "mbrOrdDlvpGb": 10,
    "dlvpSeq": 1,
    "zipNoSeq": 1,
    "dlvpNm": "집",
    "rcvmnNm": "홍길동",
    "zipNo": "05836",
    "zipAddr": "서울 송파구 법원로9길 26",
    "dtlAddr": "에이치비지니스파크 D동 6층",
    "rcvmnEmailAddr": "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": "05836",
    "zipAddr": "서울 송파구 법원로9길 26",
    "dtlAddr": "에이치비지니스파크 D동 6층",
    "rcvmnEmailAddr": "x2bee@plateer.com",
    "rcvmnCellSctNo": "010",
    "rcvmnCellTxnoNo": 1234,
    "rcvmnCellEndNo": 5678,
    "rcvmnTelRgnNo": "02",
    "rcvmnTelTxnoNo": 123,
    "rcvmnTelEndNo": 4567,
    "deliMsg": "부재 시 문 앞에 놓아주세요.",
    "deliMsgCd": 30,
    "shopTrafMsg": "문 앞에 놓아주세요.",
    "comnFrdrCogoMethodCd": 20,
    "comnFrdrEtcMethod": "자유 출입 가능",
    "comnFrdrPwd": 1234
  },
  "claimFinalAmtInfo": {
    "ordNo": "20230913O058186",
    "totAplyAdtnAmt": 6000,
    "totCnclAdtnAmt": 0,
    "totFvrAdtnAmt": 0,
    "totOrdPrc": 46000,
    "totDcAmt": 2200,
    "expectedRefundAmt": 37800,
    "addtionPayAmt": 0,
    "returnAcceptAmt": 37800,
    "refundAdditionAmtInfoList": [
      {
        "adtnOcurGbCd": 10,
        "adtnOcurGbNm": "발생",
        "type": 20,
        "typeNm": "회수배송비",
        "goodsNoItmNo": 10002762001,
        "goodsNm": "상품명",
        "ordAmt": 6000,
        "discountMethod": 11,
        "discountMethodNm": "상품할인쿠폰",
        "cnclDcAmt": 2000,
        "rtnDlvBenefitInfoList": [
          {
            "promoNo": "C1003841",
            "promoNm": "무료반품쿠폰",
            "promoTypCd": 15,
            "ourChrgRate": 100,
            "entrChrgRate": 0,
            "cpnIsuNo": 4364872,
            "aplyYn": "Y"
          }
        ]
      }
    ],
    "refundPaymentMethodList": [
      {
        "payNo": 2,
        "ordNo": "20990101O000001",
        "claimNo": "20990101C000001",
        "uprPayNo": 1,
        "payGbCd": 10,
        "payGbCdNm": "결제",
        "payWayCd": 11,
        "payWayCdNm": "신용카드",
        "payStatCd": 12,
        "payStatCdNm": "결제완료",
        "payAmt": 10000,
        "rfdPsbAmt": 10000,
        "rfdAmt": 1000,
        "payFnshDtm": "2099-01-01 09:00:00.000000",
        "trdNo": "INIMX_CARDINIpayTest20990101090000685510",
        "trdDtm": "2099-01-01 09:00:00.000000",
        "iscmCd": 202,
        "iscmCdNm": "KB국민카드",
        "payReqCardcoCd": "06",
        "payReqCardcoCdNm": "국민카드",
        "cardNo": "카드번호 암호화",
        "cardNm": "국민카드",
        "cardValiTerm": "text",
        "nintDivYn": "N",
        "divMonCnt": 0,
        "cardPointUseYn": "N",
        "mersNo": 1,
        "acqrCd": 121,
        "acqrCdNm": "국민카드",
        "aprvNo": 12345678,
        "aprvDtm": "2099-01-01 09:00:00.000000",
        "sctnCnclPsbYn": "Y",
        "bankCd": 148,
        "bankCdNm": "국민은행",
        "actnNo": "계좌번호 암호화",
        "dpmnNm": "김플래티어",
        "dptFcstDt": "2099-01-01 09:00:00.000000",
        "dptCnfmDtm": "2099-01-01 09:00:00.000000",
        "rfdBankCd": 148,
        "rfdBankCdNm": "국민은행",
        "rfdActnNo": "계좌번호 암호화",
        "rfdActnDepositorNm": "홍길동"
      }
    ],
    "rfdInfoResponse": {
      "rfdBankCd": 203,
      "rfdBankNm": "KB국민은행",
      "rfdActnNo": "33330********",
      "rfdActnDepositorNm": "임성현",
      "rfdActnCertiYn": "Y"
    }
  },
  "wthdFnshWaitProcCaus": "text"
}

No content

PreviousOrder Cancellation

NextClaim Common

Last updated 2 months ago