주문교환

교환접수철회

post

기능 설명

BO에서 교환접수대상을 철회처리 합니다.

상세 설명

주문 번호(ordNo), 클레임업무유형(claimBusinessType), **시스템 유형(systemType)**은 필수로 있어야 합니다.
다음의 조건을 모두 충족하는 대상에 대해 교환 철회 처리가 가능합니다.
- 주문내역구분(OM003) 값이 **교환(30)**인 경우
- 주문내역상태(OM005) 값이 결제대기(31) 이거나 교환접수(32) 이거나 **회수지시(34)**인 경우
기존 주문교환데이터를 업데이트하고 주문교환철회데이터를 생성 처리합니다.
교환 철회시 발생하는 결제 정보를 검증처리 합니다.
재고 증감처리를 수행 합니다.

특이 사항

**클레임업무유형(claimBusinessType)**이 **교환철회(31)**인 경우에만 교환접수철회가 진행됩니다.

수정번호

release_231009_01 : 주문혜택관계테이블 주문수량, 취소수량 컬럼 추가

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

클레임 처리 요청 DTO

systemTypestring · enum · min: 1Required

시스템유형

Example: 10Possible values:

claimBusinessTypestring · enum · min: 1Required

클레임 업무 유형

Example: 20Possible values:

ordMediaCdstring · min: 1Required

주문매체코드(OM007)

Example: 20

ordNostringOptional

주문번호

Example: 20230808O007404

mbrNostringOptional

회원번호

Example: 100001311

claimNostringOptional

클레임번호

Example: 20230808C010663

wthdFnshWaitProcCausstringOptional

회수완료 대기처리 사유

Responses

200

성공

No content

900

업무처리 오류 내용

*/*

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

교환클레임옵션변경대상체크

post

기능 설명

BO에서 교환클레임옵션변경대상이 유효한지 체크합니다.

상세 설명

상품 번호(goodsNo), **단품번호(itmNo)**는 필수로 있어야 합니다.
다음의 조건을 모두 체크합니다.
- 옵션변경대상의 **판매상태코드(PR005)**가 **판매중(10)**인지 체크합니다.
- 옵션변경대상의 **판매방식코드가(PR003)**가 **일반판매(10)**인지 체크합니다.
- 옵션변경대상이 기존대상과 동일한 가격인지 체크합니다.
- 옵션변경대상의 재고를 체크합니다.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Bodyobject[]

교환클레임 옵션변경대상 요청 DTO

goodsNostringRequired

상품번호

Example: 10002552

itmNostringRequired

단품번호

Example: 001

claimQtyinteger · int32Optional

클레임수량

Example: 1

salePrcnumberOptional

판매가

Example: 2500

Responses

200

성공

No content

900

업무처리 오류 내용

*/*

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

반품/교환 철회대상 조회

post

기능 설명

BO에서 반품/교환 철회대상을 조회합니다.

상세 설명

주문 번호(ordNo), 클레임업무유형(claimBusinessType), **시스템 유형(systemType)**은 필수로 있어야 합니다.
다음의 조건을 모두 충족하는 대상에 대해 반품/교환 철회 처리가 가능합니다.
- 주문내역구분(OM003) 값이 반품(20) 이거나 **교환(30)**인 경우
- 주문내역상태(OM005) 값이 결제대기(31), 반품/교환접수(32), **회수지시(32)**인 경우
- 반품 가능여부(rtnPsbYn) 값이 Y 인 경우
- 일반 상품인 경우**(사은품 제외)**
- 철회 가능 수량이 1개 이상인 경우 ( 주문수량 – 취소수량 – 반품수량 > 0 )

수정 번호

Release v2.00_240729 : 회수여부(wthdYn) 추가
Release v2.00_240829 : 마스킹 처리 현행화

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

클레임 가능 대상 조회 요청 DTO

ordNostringRequired

주문번호

Example: 20230808O007404

claimBusinessTypestring · enumOptional

클레임 업무 유형

Example: 20Possible values:

systemTypestringRequired

시스템유형

Example: 10

Responses

200

성공

*/*

클레임 처리대상 응답 DTO

ordNostringOptional

주문번호

Example: 20231231O000001

mbrNostringOptional

회원번호

Example: 100001311

ordManNmstringOptional

주문자명

Example: 홍길동

ordMediaCdstringOptional

주문매체코드(OM007) 20:PC, 30:모바일웹, 40:안드로이드앱, 50:IOS앱

Example: 10

sctnCnclPsbYnstring · enumOptional

부분취소가능여부

Example: NPossible values:

vbankPaymentPendingbooleanOptional

allNonReturnablebooleanOptional

allEcouponbooleanOptional

900

업무처리 오류 내용

*/*

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
}

교환주문목록 조회

post

기능 설명

BO에서 교환주문목록을 조회합니다.

상세 설명

주문교환수량이 1개 이상 ( 주문수량 – 취소수량 – 반품수량 > 0 )
주문내역구분(OM003) 값이 교환(30)
- 위의 조건(기본조건) 외 조회조건에 따라 조회조건에 추가됩니다.
- 교환사유코드는 클레임중분류코드(OM006)의 ref_1_val값이 30(교환)인 것으로 가져옵니다.

수정번호

Release v2.00_240613: 기간 검색 조건 개선
Release v2.00_240919: 사이트, 상품멀티, 주문멀티 검색 조건 개선

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

교환주문조회 요청 DTO

siteNostringOptional

사이트 번호

Example: 1

entrNostringOptional

협력사번호

Example: 1000002

exchgStrtDtstring · dateOptional

검색조건 시작일

Example: 2023-01-01

exchgEndDtstring · dateOptional

검색조건 종료일

Example: 2023-12-31

allDateYnbooleanOptional

전체기간 여부

Example: true

loginIdstringOptional

회원ID

Example: id001

ordDtlStatCdstring · enumOptional

주문내역상태코드(OM005)

Example: 11Possible values:

ordNostringOptional

주문번호

Example: 20230101O000000

ordNoListstring[]Optional

주문번호목록

Example: 20230101O000000

manNmOptstringOptional

주문/수취인 조건

Example: ordManNm

manNmstringOptional

주문/수취인 내용

Example: 주문자명

ordGbCdstringOptional

주문구분코드(OM002) 10:일반주문

Example: 10

deliKindCdstringOptional

배송종류코드(LO009) 10:일반배송, 20:예약배송

Example: 10

claimCausCdstringOptional

교환사유코드(OM006)

Example: 302

goodsNoRngstringOptional

상품번호 조건

Example: st

goodsNostringOptional

상품번호

Example: 10002297

goodsNoListstringOptional

상품번호목록

Example: 10002297

goodsNosstring[]Optional

상품번호목록

Example: 10002297

goodsNoFromstringOptional

시작상품번호

Example: 10002297

goodsNoTostringOptional

종료상품번호

Example: 10002297

goodsNmstringOptional

상품명

Example: 상품명입니다

Responses

200

성공

*/*

totalCountinteger · int32Optional

900

업무처리 오류 내용

*/*

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

주문교환대상 조회

post

기능 설명

BO에서 주문교환대상을 조회합니다.

상세 설명

주문 번호(ordNo), 클레임업무유형(claimBusinessType), **시스템 유형(systemType)**은 필수로 있어야 합니다.
다음의 조건을 모두 충족하는 대상에 대해 교환 접수 처리가 가능합니다.
- 주문내역구분(OM003) 값이 주문일반(10) 이거나 **교환(30)**인 경우
- 주문내역상태(OM005) 값이 출고완료(26) 이거나 **배송완료(27)**인 경우
- 반품 가능여부(rtnPsbYn) 값이 Y 인 경우
- 일반 상품인 경우**(사은품 제외)**
- 교환 가능 수량이 1개 이상인 경우 ( 주문수량 – 취소수량 – 반품수량 > 0 )

특이 사항

**클레임업무유형(claimBusinessType)**이 **교환(30)**인 경우에 교환대상을 가져옵니다.

수정번호

release v2.00_240409 : Response DTO 오타 수정 ( CaimTargetResponse -> ClaimTargetResponse )
Release v2.00_240729 : 회수여부(wthdYn), 회수불필요주문여부(isAllNonReturnable) 추가

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

클레임 가능 대상 조회 요청 DTO

ordNostringRequired

주문번호

Example: 20230808O007404

claimBusinessTypestring · enumOptional

클레임 업무 유형

Example: 20Possible values:

systemTypestringRequired

시스템유형

Example: 10

Responses

200

성공

*/*

교환주문 클레임 대상 응답 DTO

900

업무처리 오류 내용

*/*

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값에 대한 설명"
      }
    ]
  }
}

교환접수

post

기능 설명

BO에서 교환대상을 접수처리 합니다.

상세 설명

주문 번호(ordNo), 클레임업무유형(claimBusinessType), **시스템 유형(systemType)**은 필수로 있어야 합니다.
교환 접수 대상은 모두 같은 배송번호여야 접수 가능 합니다.
교환 접수 대상에 사은품 여부 확인(사은품 포항 될 경우 부분클레임 불가능)
다음의 조건을 모두 충족하는 교환 대상에 대해 교환 처리가 가능합니다.
- 유효한 상품인지 체크합니다.
  - 교환받을 상품의 **판매상태코드(PR005)**가 **판매중(10)**인지 체크합니다.
  - 교환받을 상품의 **판매방식코드가(PR003)**가 **일반판매(10)**인지 체크합니다.
  - 교환받을 상품이 교환대상 상품과 동일한 가격인지 체크합니다.
  - 교환받을 상품의 재고를 체크합니다.
주문교환데이터를 생성하고 업데이트 처리합니다.
- **클레임 대분류 코드(claimLgrpCd)**가 **단순변심(10)**인 경우 배송비가 발생합니다.
  - **추가결제금액(배송비)**이 발생할 경우 주문내역상태(OM005) 값이 **교환접수(32)**가 아닌 **결제대기(31)**상태로 변경됩니다.
  - **결제대기(31)**일 경우에는 FO에서 배송비결제 화면을 통한 결제를 진행해야 **교환접수(32)**가 됩니다.
교환 접수시 발생하는 결제 정보를 검증처리 합니다.
재고 증감처리를 수행 합니다.
교환 접수 후 알림메세지 발송 처리합니다.

특이 사항

**클레임업무유형(claimBusinessType)**이 **교환(30)**인 경우에만 교환접수가 진행됩니다.

수정번호

release_231009_01 : 주문혜택관계테이블 주문수량, 취소수량 컬럼 추가

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

클레임 처리 요청 DTO

systemTypestring · enum · min: 1Required

시스템유형

Example: 10Possible values:

claimBusinessTypestring · enum · min: 1Required

클레임 업무 유형

Example: 20Possible values:

ordMediaCdstring · min: 1Required

주문매체코드(OM007)

Example: 20

ordNostringOptional

주문번호

Example: 20230808O007404

mbrNostringOptional

회원번호

Example: 100001311

claimNostringOptional

클레임번호

Example: 20230808C010663

wthdFnshWaitProcCausstringOptional

회수완료 대기처리 사유

Responses

200

성공

No content

900

업무처리 오류 내용

*/*

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

Previous주문취소 Next클레임 공통

Last updated 1 day ago

hashtag교환접수철회

hashtag기능 설명

hashtag상세 설명

hashtag특이 사항

hashtag수정번호

hashtag교환클레임옵션변경대상체크

hashtag기능 설명

hashtag상세 설명

hashtag반품/교환 철회대상 조회

hashtag기능 설명

hashtag상세 설명

hashtag수정 번호

hashtag교환주문목록 조회

hashtag기능 설명

hashtag상세 설명

hashtag수정번호

hashtag주문교환대상 조회

hashtag기능 설명

hashtag상세 설명

hashtag특이 사항

hashtag수정번호

hashtag교환접수

hashtag기능 설명

hashtag상세 설명

hashtag특이 사항

hashtag수정번호

교환접수철회

기능 설명

상세 설명

특이 사항

수정번호

교환클레임옵션변경대상체크

기능 설명

상세 설명

반품/교환 철회대상 조회

기능 설명

상세 설명

수정 번호

교환주문목록 조회

기능 설명

상세 설명

수정번호

주문교환대상 조회

기능 설명

상세 설명

특이 사항

수정번호

교환접수

기능 설명

상세 설명

특이 사항

수정번호