주문클레임처리

비회원 환불 계좌 등록

post

기능설명

• 비회원의 환불 계좌를 등록합니다.

---

상세설명

---

특이사항

• 예금주명은 주문자명과 일치해야합니다.

• 계좌 인증이 환료되어야 합니다.

• 필수 값 목록

  • 계좌번호

  • 은행코드

  • 계좌 인증 유무

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

rfdNostringOptional

ordNostringOptional

mbrNostring · min: 1Required

mbrNmstring · min: 1Required

loginIdstring · min: 1Required

rfdTypCdstring · min: 1Required

rfdPrgsStatCdstring · min: 1Required

rfdBankCdstring · min: 1Required

rfdActnNostring · min: 1Required

rfdActnDepositorNmstring · min: 1Required

rfdCausCdstring · min: 1Required

rfdActnCertiYnstring · min: 1Required

rfdAmtnumberRequired

rfdCmsnAmtnumberRequired

acptmnIdstring · min: 1Required

rfdSmsSndYnstring · min: 1Required

Responses

200

성공

*/*

stringOptional

900

업무처리 오류 내용

*/*

post

/v1/claim/orderClaimProc/saveNonMemberRefundActn

HTTPcURLJavaScriptPython

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

{
  "rfdNo": "text",
  "ordNo": "text",
  "mbrNo": "text",
  "mbrNm": "text",
  "loginId": "text",
  "rfdTypCd": "text",
  "rfdPrgsStatCd": "text",
  "rfdBankCd": "text",
  "rfdActnNo": "text",
  "rfdActnDepositorNm": "text",
  "rfdCausCd": "text",
  "rfdActnCertiYn": "text",
  "rfdAmt": 1,
  "rfdCmsnAmt": 1,
  "acptmnId": "text",
  "rfdSmsSndYn": "text"
}

text

주문관리 > 주문 클레임 처리 결제/환불 정보 중 프로모션 정보 조회

post

기능 설명

• 주문번호에 해당하는 사용한 프로모션 정보(쿠폰, 할인, 적립마일리지)를 조회합니다.

---

상세 설명

• 주문번호에 해당하는 사용한 프로모션 정보(쿠폰, 할인, 적립마일리지)를 조회합니다.

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

ordNoStringRequired

주문번호

Body

application/json

ordNostring · min: 1Required

주문번호

Example: 20230912O058151

Responses

200

성공

*/*

가상계좌 입금 확인 처리 응답

resultstringOptional

alreadyConfirmedbooleanOptional

900

업무처리 오류 내용

*/*

post

/v1/claim/orderClaimProc/saveManualConfirm

HTTPcURLJavaScriptPython

POST /api/bo/v1/claim/orderClaimProc/saveManualConfirm?ordNo=null HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 27

{
  "ordNo": "20230912O058151"
}

{
  "result": "text",
  "alreadyConfirmed": true
}

배송지를 변경합니다.

post

기능 설명

• 배송지를 변경합니다.

---

상세 설명

• 주문내역구분코드(OM003)가 주문완료(11)상태일 경우 배송지 변경 가능합니다.

• 배송번호와 관계없이 해당하는 주문번호의 모든 배송 순번을 업데이트 합니다.

• 추가배송비가 발생한 도서산간 지역간의 배송지 변경, 일반지역간의 배송지 변경만 가능합니다.

---

특이사항

• ST008 cd 92번(배송지변경)의 ref_1_val(OM005), ref_2_val(OM003)값 에 따라 배송지 변경 가능 상태 값이 변경될 수 있습니다.

---

수정번호

• Release v2.00_240711 : 추가 배송비 개선에 따른 배송정책번호(deli_polc_no) 추가

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

주문 배송지 변경 DTO

ordNostring · min: 1Required

주문번호

systemTypestringOptional

시스템구분코드

deliNostring · min: 1Required

배송번호

dlvpNmstringOptional

배송지명

rcvmnNmstring · min: 1Required

수취인명

zipNoSeqinteger · int32Optional

우편번호순번

zipNostringOptional

우편번호

originZipNostringOptional

원주문우편번호

zipAddrstringOptional

우편주소

dtlAddrstringOptional

상세주소

rcvmnCellSctNostring · min: 1Required

수취인휴대폰구분번호

rcvmnCellTxnoNostring · min: 1Required

수취인휴대폰국번번호

rcvmnCellEndNostring · min: 1Required

수취인휴대폰끝번호

deliMsgstringOptional

배송메시지

deliMsgCdstringOptional

배송메시지코드

deliPolcNostringOptional

배송정책번호

comnFrdrEtcMethodstringOptional

공동현관기타방법

comnFrdrPwdstringOptional

공동현관비밀번호

comnFrdrCogoMethodCdstringOptional

공동현관출입방법코드

deliGbCdstringOptional

배송구분코드

dlvpSeqstringOptional

배송순번

rcvmnEmailAddrstringOptional

수취인이메일

rcvmnTelRgnNostringOptional

수취인전화지역번호

rcvmnTelTxnoNostringOptional

수취인전화국번번호

rcvmnTelEndNostringOptional

수취인전화끝번호

orginDlvpSeqstringOptional

원배송순번

Example: 1

Responses

200

성공

*/*

stringOptional

900

업무처리 오류 내용

*/*

post

/v1/claim/orderClaimProc/ordDlvChange

HTTPcURLJavaScriptPython

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

{
  "ordNo": "text",
  "systemType": "text",
  "deliNo": "text",
  "dlvpNm": "text",
  "rcvmnNm": "text",
  "zipNoSeq": 1,
  "zipNo": "text",
  "originZipNo": "text",
  "zipAddr": "text",
  "dtlAddr": "text",
  "rcvmnCellSctNo": "text",
  "rcvmnCellTxnoNo": "text",
  "rcvmnCellEndNo": "text",
  "deliMsg": "text",
  "deliMsgCd": "text",
  "deliPolcNo": "text",
  "comnFrdrEtcMethod": "text",
  "comnFrdrPwd": "text",
  "comnFrdrCogoMethodCd": "text",
  "deliGbCd": "text",
  "dlvpSeq": "text",
  "rcvmnEmailAddr": "text",
  "rcvmnTelRgnNo": "text",
  "rcvmnTelTxnoNo": "text",
  "rcvmnTelEndNo": "text",
  "orginDlvpSeq": 1
}

text

주문변경 > 주문상품의 단품을 변경합니다.

post

기능 설명

• 주문상품의 단품을 변경합니다.

---

상세 설명

• 주문내역구분코드(OM003)가 주문완료(11)상태일 경우 옵션 변경 가능합니다.

• 다건의 옵션 변경이 가능합니다.

• 동일금액의 판매중인 상태의 재고가 있는 단품의 컬러+사이즈로 변경 가능합니다.

• 동일단품, 예약상품의 단품은 변경 불가능합니다.

---

특이사항

• ST008 cd 91번(옵션변경)의 ref_1_val(OM005), ref_2_val(OM003)값 에 따라 배송지 변경 가능 상태 값이 변경될 수 있습니다.

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Bodyobject[]

application/json

단품 변경 DTO

ordNostring · min: 1Required

주문번호

ordSeqinteger · int32Required

주문순번

ordProcSeqinteger · int32Required

주문처리순번

goodsNostring · min: 1Required

상품번호순번

itmNostring · min: 1Required

단품번호

chngItmNostring · min: 1Required

변경단품번호

ordQtyinteger · int32Optional

수량

salePrcnumberOptional

판매가

goodsNmstringOptional

상품명

Responses

200

성공

*/*

stringOptional

900

업무처리 오류 내용

*/*

post

/v1/claim/orderClaimProc/ordChange

HTTPcURLJavaScriptPython

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

[
  {
    "ordNo": "text",
    "ordSeq": 1,
    "ordProcSeq": 1,
    "goodsNo": "text",
    "itmNo": "text",
    "chngItmNo": "text",
    "ordQty": 1,
    "salePrc": 1,
    "goodsNm": "text"
  }
]

text

주문변경 > 주문 배송지 목록을 조회합니다.

post

기능 설명

• 주문 배송지를 조회합니다.

---

상세 설명

• 주문 배송지를 조회합니다.

---

수정번호

• Release v2.00_240827: 주문 번호로 주문 배송지 목록을 조회

• Release v2.00_240829: 마스킹 처리 현행화

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

ordNoStringRequired

주문번호

Body

application/json

ordNostringOptional

deliNostringOptional

dlvpSeqstringOptional

Responses

200

성공

*/*

주문 배송지 조회 DTO

ordNostringOptional

주문번호

Example: 20230809O007943

dlvpSeqstringOptional

배송순번

Example: 1

deliNostringOptional

배송번호

Example: 10001

dlvpNmstringOptional

배송지명

Example: 집

rcvmnNmstringOptional

수취인명

Example: 홍길동

rcvmnCellSctNostringOptional

수취인휴대폰구분번호

Example: 010

rcvmnCellTxnoNostringOptional

수취인휴대폰국번번호

Example: 1234

rcvmnCellEndNostringOptional

수취인휴대폰끝번호

Example: 5678

rcvmnTelRgnNostringOptional

수취인전화지역번호

Example: 02

rcvmnTelTxnoNostringOptional

수취인전화국번번호

Example: 1234

rcvmnTelEndNostringOptional

수취인전화끝번호

Example: 5678

zipNostringOptional

우편번호

Example: 111111

zipAddrstringOptional

주소

Example: 서울 송파구 법원로9길 26

dtlAddrstringOptional

상세주소

Example: 비지니스파크 D동 6층

deliMsgstringOptional

배송메시지

Example: 문앞에 두고 가주세요

comnFrdrPwdstringOptional

공동현관비밀번호

Example: 1234

comnFrdrEtcMethodstringOptional

공동현관기타방법

Example: 기타

deliRegnGrpYnstringOptional

도서산간지역여부

Example: Y

deliGbCdstringOptional

배송구분코드(LO001)

Example: 10

goodsNostringOptional

상품번호

Example: 10002042

goodsNmstringOptional

상품명

Example: 상품명

itmNostringOptional

단품번호

Example: 001

itmNmstringOptional

단품명

Example: 단품명

ordQtyinteger · int32Optional

주문수량

Example: 1

ordDtlStatNmstringOptional

주문내역상태

Example: 배송지시

ordDtlGbNmstringOptional

주문내역구분

Example: 주문일반

ordGbCdstringOptional

주문구분코드

Example: 10

ordGbNmstringOptional

주문구분

Example: 일반주문

ordPrcinteger · int64Optional

주문금액

Example: 30000

goodsTypNmstringOptional

상품유형

Example: 일반상품

deliPolcNostringOptional

배송정책번호

Example: 10000152

frgnDirPurGoodsYnstringOptional

직구상품 여부

Example: Y

900

업무처리 오류 내용

*/*

post

/v1/claim/orderClaimProc/getOrderChangeDlvp

HTTPcURLJavaScriptPython

POST /api/bo/v1/claim/orderClaimProc/getOrderChangeDlvp?ordNo=null HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 49

{
  "ordNo": "text",
  "deliNo": "text",
  "dlvpSeq": "text"
}

[
  {
    "ordNo": "20230809O007943",
    "dlvpSeq": 1,
    "deliNo": 10001,
    "dlvpNm": "집",
    "rcvmnNm": "홍길동",
    "rcvmnCellSctNo": "010",
    "rcvmnCellTxnoNo": 1234,
    "rcvmnCellEndNo": 5678,
    "rcvmnTelRgnNo": "02",
    "rcvmnTelTxnoNo": 1234,
    "rcvmnTelEndNo": 5678,
    "zipNo": 111111,
    "zipAddr": "서울 송파구 법원로9길 26",
    "dtlAddr": "비지니스파크 D동 6층",
    "deliMsg": "문앞에 두고 가주세요",
    "comnFrdrPwd": 1234,
    "comnFrdrEtcMethod": "기타",
    "deliRegnGrpYn": "Y",
    "deliGbCd": 10,
    "goodsNo": 10002042,
    "goodsNm": "상품명",
    "itmNo": "001",
    "itmNm": "단품명",
    "ordQty": 1,
    "ordDtlStatNm": "배송지시",
    "ordDtlGbNm": "주문일반",
    "ordGbCd": 10,
    "ordGbNm": "일반주문",
    "ordPrc": 30000,
    "goodsTypNm": "일반상품",
    "deliPolcNo": 10000152,
    "frgnDirPurGoodsYn": "Y"
  }
]

도서산간 지역 여부를 조회합니다.

post

기능 설명

• 도서 산간 지역 여부를 조회합니다.

---

상세 설명

• 도서 산간 지역 여부를 조회합니다.

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

도서산간 조회 DTO

zipNostringOptional

변경후우편번호

Example: 08739

originZipNostringOptional

변경전우편번호

Example: 05837

deliPolcNostringOptional

배송정책번호

Example: 10000431

Responses

200

성공

*/*

stringOptional

900

업무처리 오류 내용

*/*

post

/v1/claim/orderClaimProc/deliveryRegionCheck

HTTPcURLJavaScriptPython

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

{
  "zipNo": "08739",
  "originZipNo": "05837",
  "deliPolcNo": 10000431
}

text

주문관리 > 주문 클레임 처리 > 결제/환불 현황 팝업 조회

get

기능설명

• 주문 관리 > 주문 클레임 처리 화면의 결제/환불 정보에서 결제/환불 현황 버튼 클릭 시 해당 주문의 결제/환불 이력 목록을 조회합니다.

---

상세설명

• 주결제수단과 보조결제수단으로 0원 초과의 금액 결제/환불이 발생했을 경우 쌓이는 결제 데이터입니다.

---

수정번호

• Release v2.00_240829 : 우편주소 마스킹 처리 추가

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

Responses

200

성공

*/*

totalCountinteger · int32Optional

900

업무처리 오류 내용

*/*

get

/v1/claim/orderClaimProc/getPaymentRefundPrcondList

HTTPcURLJavaScriptPython

GET /api/bo/v1/claim/orderClaimProc/getPaymentRefundPrcondList?paymentMgmtPopupRequest=[object+Object] HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "totalCount": 1,
  "payloads": [
    {
      "payGbNm": "결제",
      "payWayCd": 32,
      "payWayNm": "신용카드",
      "payStatNm": "결제완료",
      "payFnshDtm": "2023-09-07 15:58:27",
      "payAmt": 53200,
      "methodType": "C",
      "cardBank": "국민카드",
      "cardNo": "457973*********8",
      "actnNo": "text",
      "mid": "INIpayTest",
      "dpmnNm": null,
      "dptFcstDt": 20990101,
      "dptCnfmDtm": "2099-01-01 09:00:00.000000",
      "aprvNo": 30015564,
      "nintDivYn": "N",
      "divMonCnt": 0,
      "claimNo": null
    }
  ]
}

주문변경 > 옵션 변경이 가능한 상품을 조회 합니다.

get

기능 설명

• 현재 주문 상품 중 옵션 변경이 가능한 상품 목록을 조회 합니다.

---

상세 설명

• 현재 주문 상품 중 옵션 변경이 가능한 상품 목록을 조회 합니다.

---

수정번호

• Release v2.00_240711: 추가 배송비 개선에 따른 배송정책번호(deli_polc_no) 조회 추가

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

ordNoStringRequired

주문번호

Responses

200

성공

*/*

totalCountinteger · int32Optional

900

업무처리 오류 내용

*/*

get

/v1/claim/orderClaimProc/getOrderChangeItmList

HTTPcURLJavaScriptPython

GET /api/bo/v1/claim/orderClaimProc/getOrderChangeItmList?orderClaimRequest=[object+Object]&ordNo=null HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "totalCount": 1,
  "payloads": [
    {
      "ordNo": "20230809O007943",
      "ordSeq": 1,
      "ordProcSeq": 1,
      "deliNo": 1,
      "dlvpSeq": 1,
      "deliPolcNo": 10000151,
      "goodsNo": 1000001,
      "goodsNm": "상품명",
      "itmNo": "001",
      "itmNm": "단품명",
      "salePrc": 1000,
      "ordQty": 100,
      "ordSaleTypNm": "일반판매",
      "ordDtlStatCd": 11,
      "ordDtlStatNm": "주문완료",
      "ordManNm": "홍길동"
    }
  ]
}

주문관리 > 주문 클레임 처리 결제/환불 정보 중 프로모션 정보 조회

get

기능 설명

• 주문번호에 해당하는 사용한 프로모션 정보(쿠폰, 할인, 적립마일리지)를 조회합니다.

---

상세 설명

• 주문번호에 해당하는 사용한 프로모션 정보(쿠폰, 할인, 적립마일리지)를 조회합니다.

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

ordNoStringRequired

주문번호

Responses

200

성공

*/*

주문클레임 처리 프로모션 정보 조회 DTO

ordNostringOptional

주문번호

Example: 20230809O007943

cpnGoodsDcGoodsNmstringOptional

상품할인쿠폰 상품명

Example: 청바지

cpnGoodsDcAmtinteger · int32Optional

상품할인쿠폰

Example: 100

cpnCartDcAmtinteger · int32Optional

장바구니쿠폰

Example: 100

stafDcAmtinteger · int32Optional

임직원할인

Example: 100

cpnOvrlpDcAmtinteger · int32Optional

중복할인쿠폰

Example: 100

cpnFreeDlvrycAmtinteger · int32Optional

무료배송비쿠폰

Example: 3000

cpnFreeRtnDlvrycAmtinteger · int32Optional

무료반품비쿠폰

Example: 3000

acclmMileageAmtinteger · int32Optional

적립마일리지

Example: 100

goodsDirectAmtinteger · int32Optional

상품즉시할인

Example: 100

900

업무처리 오류 내용

*/*

get

/v1/claim/orderClaimProc/getOrdClmProcPromotionInfo

HTTPcURLJavaScriptPython

GET /api/bo/v1/claim/orderClaimProc/getOrdClmProcPromotionInfo?orderClaimRequest=[object+Object]&ordNo=null HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ordNo": "20230809O007943",
  "cpnGoodsDcGoodsNm": "청바지",
  "cpnGoodsDcAmt": 100,
  "cpnCartDcAmt": 100,
  "stafDcAmt": 100,
  "cpnOvrlpDcAmt": 100,
  "cpnFreeDlvrycAmt": 3000,
  "cpnFreeRtnDlvrycAmt": 3000,
  "acclmMileageAmt": 100,
  "goodsDirectAmt": 100
}

주문관리 > 주문 클레임 처리 결제/환불 정보 중 결제수단 정보 조회

get

기능 설명

• 주문번호에 해당하는 결제수단 정보를 조회합니다.

---

상세 설명

• 주문번호에 해당하는 결제수단 정보를 조회합니다.

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

ordNoStringRequired

주문번호

Responses

200

성공

*/*

결제수단 정보 조회 DTO

ordNostringOptional

주문번호

Example: 20230809O007943

payWayCdstringOptional

결제수단코드(OM013)

Example: 11

payWayCdNmstringOptional

결제수단코드명

Example: 신용카드

lclPayAmtstringOptional

로컬결제금액

Example: 10000

payStatCdstringOptional

결제상태코드(OM014)

Example: 11

payStatCdNmstringOptional

결제상태코드명

Example: 결제대기

bankCdstringOptional

은행코드(OM026)

Example: 104

bankCdNmstringOptional

은행코드명(OM026)

Example: 국민은행

actnNostringOptional

계좌번호

Example: 계좌번호 암호화

dpmnNmstringOptional

입금자명

Example: 김플래티어

dptFcstDtstringOptional

입금예정일자

Example: 20990101

dptCnfmDtmstring · date-timeOptional

입금확인일시

Example: 2099-01-01 09:00:00.000000

900

업무처리 오류 내용

*/*

get

/v1/claim/orderClaimProc/getOrdClmProcPayWayInfoList

HTTPcURLJavaScriptPython

GET /api/bo/v1/claim/orderClaimProc/getOrdClmProcPayWayInfoList?orderClaimRequest=[object+Object]&ordNo=null HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "ordNo": "20230809O007943",
    "payWayCd": 11,
    "payWayCdNm": "신용카드",
    "lclPayAmt": 10000,
    "payStatCd": 11,
    "payStatCdNm": "결제대기",
    "bankCd": 104,
    "bankCdNm": "국민은행",
    "actnNo": "계좌번호 암호화",
    "dpmnNm": "김플래티어",
    "dptFcstDt": 20990101,
    "dptCnfmDtm": "2099-01-01 09:00:00.000000"
  }
]

주문관리 > 주문 클레임 처리 결제/환불 정보 중 결제상세 정보 조회

get

기능 설명

• 주문번호에 해당하는 결제상세 정보를 조회합니다.

---

상세 설명

• 결제 상세 정보 및 미결제 금액, 환불대기금액, 미환불금액, 결제/환불 오류 금액을 조회합니다.

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

ordNoStringRequired

주문번호

Responses

200

성공

*/*

결제상세 정보 조회 DTO

ordNostringOptional

주문번호

Example: 20230809O007943

nonPayAmtinteger · int32Optional

미결제금액

Example: 1000

rfndWaitAmtinteger · int32Optional

환불대기금액

Example: 1000

nonRfndAmtinteger · int32Optional

미환불금액

Example: 100

rfndErrorAmtinteger · int32Optional

환불오류금액

Example: 100

goodsAmtinteger · int32Optional

상품금액

Example: 1000

dcAmtnumberOptional

할인금액

Example: 1000

dlvryChrginteger · int32Optional

배송비

Example: 3000

payAmtnumberOptional

결제금액

Example: 5000

900

업무처리 오류 내용

*/*

get

/v1/claim/orderClaimProc/getOrdClmProcPayDtlInfo

HTTPcURLJavaScriptPython

GET /api/bo/v1/claim/orderClaimProc/getOrdClmProcPayDtlInfo?orderClaimRequest=[object+Object]&ordNo=null HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ordNo": "20230809O007943",
  "nonPayAmt": 1000,
  "rfndWaitAmt": 1000,
  "nonRfndAmt": 100,
  "rfndErrorAmt": 100,
  "goodsAmt": 1000,
  "dcAmt": 1000,
  "dlvryChrg": 3000,
  "payAmt": 5000
}

주문관리 > 주문 클레임 처리 주문정보 및 회원정보 조회

get

기능 설명

• 주문목록에서 선택한 주문 row의 주문정보와 주문자 정보를 조회합니다.

---

상세 설명

• 선택한 주문 row의 주문번호로 주문정보와 주문자 정보를 조회합니다.

• 회원일 경우에 한해서 쿠폰 개수는 프로모션 api, 현재 사용 가능한 마일리지는 회원 api 통해 조회해 옵니다.

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

ordNoStringRequired

주문번호

Responses

200

성공

*/*

주문정보 및 회원정보 조회 DTO

siteNostringOptional

사이트번호

Example: 1

ordNostringOptional

주문번호

Example: 20230809O007943

ordAccpDtmstring · date-timeOptional

주문접수일시

Example: 2023-12-31 00:00:00

ordMediaCdstringOptional

주문매체코드(OM007)

Example: 30

ordMediaCdNmstringOptional

주문매체코드명

Example: 모바일웹

siteNmstringOptional

사이트명

Example: 플래티어닷컴

ordManNmstringOptional

회원명

Example: 홍길동

mbrGradeCdstringOptional

회원등급코드(ME008)

Example: 10

mbrGradeCdNmstringOptional

회원등급명

Example: GREEN

mbrMgrCdstringOptional

회원관리코드(ME002)

Example: 10

mbrMgrCdNmstringOptional

회원등급코드명

Example: 통합회원

cashRcptYnstringOptional

현금영수증신청여부

Example: Y

emailAddrstringOptional

이메일

Example: [e-mail]

cellSctNostringOptional

휴대폰구분번호

Example: 010

cellTxnoNostringOptional

휴대폰국번번호

Example: 1234

cellEndNostringOptional

휴대폰끝번호

Example: 5678

telRgnNostringOptional

전화지역번호

Example: 02

telTxnoNostringOptional

전화국번번호

Example: 1234

telEndNostringOptional

전화끝번호

Example: 5678

instMbrYnstringOptional

관심고객

Example: Y

instMbrGbNmstringOptional

관심고객 구분

Example: 주문주의/블랙컨슈머/VIP

loginIdstringOptional

회원ID

Example: id079

mbrNostringOptional

회원번호

Example: 1000002

dlvCntinteger · int32Optional

무료배송쿠폰 개수

Example: 10

cpnCntinteger · int32Optional

쿠폰 개수

Example: 10

mlgAvalAmtinteger · int64Optional

가용 마일리지 금액

Example: 10000

900

업무처리 오류 내용

*/*

get

/v1/claim/orderClaimProc/getOrdClmProcOrdMbrInfo

HTTPcURLJavaScriptPython

GET /api/bo/v1/claim/orderClaimProc/getOrdClmProcOrdMbrInfo?orderClaimRequest=[object+Object]&ordNo=null HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "siteNo": 1,
  "ordNo": "20230809O007943",
  "ordAccpDtm": "2023-12-31 00:00:00",
  "ordMediaCd": 30,
  "ordMediaCdNm": "모바일웹",
  "siteNm": "플래티어닷컴",
  "ordManNm": "홍길동",
  "mbrGradeCd": 10,
  "mbrGradeCdNm": "GREEN",
  "mbrMgrCd": 10,
  "mbrMgrCdNm": "통합회원",
  "cashRcptYn": "Y",
  "emailAddr": "[e-mail]",
  "cellSctNo": "010",
  "cellTxnoNo": 1234,
  "cellEndNo": 5678,
  "telRgnNo": "02",
  "telTxnoNo": 1234,
  "telEndNo": 5678,
  "instMbrYn": "Y",
  "instMbrGbNm": "주문주의/블랙컨슈머/VIP",
  "loginId": "id079",
  "mbrNo": 1000002,
  "dlvCnt": 10,
  "cpnCnt": 10,
  "mlgAvalAmt": 10000
}

주문관리 > 주문 클레임 처리 주문내역 조회

get

기능 설명

• 주문 관리 > 주문 클레임 처리에서 고객 목록 조회 후 선택한 고객 row의 주문목록을 조회합니다.

---

상세 설명

• 선택한 고객 row의 mbrNo와 cellNo를 조건으로 하여 주문목록을 조회합니다.

• 주문번호 입력 시에는 주문번호 또한 조건으로 하여 주문목록을 조회합니다.

---

수정번호

• Release v2.00_240530: 날짜조회 쿼리 변경

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

cellNoStringOptional

휴대전화번호

ordNoStringOptional

주문번호

mbrNoStringOptional

회원번호

ordAccpStrtDtLocalDateOptional

주문접수시작일

ordAccpEndDtLocalDateOptional

주문접수종료일

Responses

200

성공

*/*

totalCountinteger · int32Optional

900

업무처리 오류 내용

*/*

get

/v1/claim/orderClaimProc/getOrdClmProcOrdInfoList

HTTPcURLJavaScriptPython

GET /api/bo/v1/claim/orderClaimProc/getOrdClmProcOrdInfoList?orderClaimRequest=[object+Object] HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "totalCount": 1,
  "payloads": [
    {
      "rglrDeliNo": 1,
      "ordNo": "20230809O007943",
      "ordManNm": "홍길동",
      "siteNm": "플래티어닷컴",
      "ordMediaCd": 30,
      "ordMediaCdNm": "모바일웹",
      "ordGbCd": 10,
      "ordGbCdNm": "일반주문",
      "ordAccpDtm": "2023-12-31 00:00:00",
      "salePrc": 100000,
      "dcAmt": 100,
      "dlvryCost": 3000,
      "totalSalePrc": 100000
    }
  ]
}

주문관리 > 주문 클레임 처리 주문상품내역 조회

get

기능 설명

• 주문번호에 해당하는 주문상품 내역을 조회합니다.

---

상세 설명

• BO 시스템 클레임처리 가능상태(ST008) 그룹코드의 주문내역상태코드(ref_1_val) 과 주문내역구분코드(ref_2_val)에 해당하는 각 코드를 조회 후 해당하는 버튼을 노출합니다.

---

수정번호

• release_231009_01: 주문혜택관계 테이블 컬럼 추가(ORD_QTY, CNCL_QTY)로 인한 쿼리 수정

• Release v2.00_240729: 취소 가능 여부(ordCnclPsbYn), 회수여부(wthdYn), e쿠폰번호(ecpnNo), e티켓번호(etcktNo) 추가

• Release v2.00_240829: 마스킹 처리 현행화

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

ordNoStringRequired

주문번호

Responses

200

성공

*/*

totalCountinteger · int32Optional

900

업무처리 오류 내용

*/*

get

/v1/claim/orderClaimProc/getOrdClmProcOrdGoodsList

HTTPcURLJavaScriptPython

GET /api/bo/v1/claim/orderClaimProc/getOrdClmProcOrdGoodsList?orderClaimRequest=[object+Object]&ordNo=null HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "totalCount": 1,
  "payloads": [
    {
      "ordNo": "20230809O007943",
      "ordDtlGbCd": 10,
      "ordDtlGbCdNm": "주문일반",
      "ordGbCd": 10,
      "ordGbCdNm": "일반주문",
      "ordSeq": 1,
      "ordProcSeq": 1,
      "claimNo": 1,
      "goodsNo": 1,
      "goodsNm": "상품1",
      "itmNo": "001",
      "itmNm": "그레이",
      "goodsTypCd": 10,
      "goodsTypCdNm": "일반상품",
      "brandNm": "멀버리",
      "ordDtlStatCd": 11,
      "ordDtlStatCdNm": "주문완료",
      "prestNm": "증정품",
      "salePrc": 1000,
      "dcAmt": 1000,
      "ordQty": 1,
      "cnclQty": 1,
      "rtnQty": 1,
      "ordAmt": 1000,
      "deliNo": 1,
      "deliKindCd": 10,
      "deliKindCdNm": "일반배송",
      "shipWaitCaus": 10,
      "shipWaitCausNm": "재고부족",
      "shipWaitCausCont": "수급물량부족",
      "deliProcTypCd": 10,
      "deliProcTypCdNm": "센터배송",
      "rcvmnNm": "홍길동",
      "zipNo": "05836",
      "zipAddr": "서울 송파구 법원로9길 26",
      "dtlAddr": "디동 제6층 (문정동,에이치비지니스파크)",
      "deliAddr": "서울 송파구 법원로9길 26 디동 제6층 (문정동,에이치비지니스파크)",
      "deliMethodCd": 10,
      "deliMethodCdNm": "택배배송",
      "ordAccpDtm": "2023-12-31 00:00:00",
      "ordFnshDtm": "2023-12-31 00:00:00",
      "entrNo": 1000002,
      "orginDeliNo": 100000040,
      "rtnDeliNo": 100000040,
      "deliPolcNo": 10000020,
      "deliGbCd": 10,
      "claimMgrpCd": 100,
      "claimCauseFaultType": 10,
      "wthdFnshGbCd": 10,
      "rtnPsbYn": "N",
      "exchPsbYn": "N",
      "ordCnclPsbYn": "Y",
      "wthdYn": "Y",
      "ecpnNo": "ORD0001",
      "rtnRejectProcSeq": 1,
      "buttonCdList": [
        "text"
      ],
      "deliSeq": 1,
      "deliDtlStatCd": "배송완료",
      "deliDtlStatCdNm": 15,
      "shipQty": 1
    }
  ]
}

주문관리 > 주문 클레임 처리 > 적립마일리지 상세 팝업 조회

get

기능설명

• 주문 관리 > 주문 클레임 처리 화면의 결제/환불 정보에서 프로모션 > 적립마일리지 클릭 시 해당 주문의 적립/적립(예정)/취소 상태의 마일리지 이력 목록을 조회합니다.

---

상세설명

• 주문/클레임 발생 시에 혜택 테이블에 쌓인 적립 이력들을 클레임 번호 단위로 조회합니다.

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

Responses

200

성공

*/*

totalCountinteger · int32Optional

900

업무처리 오류 내용

*/*

get

/v1/claim/orderClaimProc/getOrdClmProcMileageHistList

HTTPcURLJavaScriptPython

GET /api/bo/v1/claim/orderClaimProc/getOrdClmProcMileageHistList?ordBaseRequest=[object+Object] HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "totalCount": 1,
  "payloads": [
    {
      "claimNo": "20230906C017302",
      "purchaseAmt": 24000,
      "mileage": 8040,
      "procDtm": "2023-09-06 13:16:57",
      "rsrvYn": "Y"
    }
  ]
}

주문관리 > 주문 클레임 처리 고객목록 조회

get

기능 설명

• 주문 관리 > 주문 클레임 처리에서 조회 버튼 클릭 시 고객목록을 조회합니다.

---

상세 설명

• 회원ID/명, 휴대폰번호, 주문번호에 해당하는 고객목록을 조회 합니다.

• 비회원의 경우 회원ID/명 입력 후 조회 시 조회 되지 않습니다.

• 주문을 한번이라도 했던 고객에 한하여 조회됩니다. 주문을 하지 않은 고객에 대해서는 조회되지 않습니다.

수정번호

• Release v2.00_241120: 회원 정보 테이블을 기준으로 주문이 있는 고객 목록을 조회하도록 변경(기존:주문기본 테이블 기준)

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

mbrIdNmStringOptional

회원ID/명

cellNoStringOptional

휴대전화번호

ordNoStringOptional

주문번호

Responses

200

성공

*/*

totalCountinteger · int32Optional

900

업무처리 오류 내용

*/*

get

/v1/claim/orderClaimProc/getOrdClmProcMbrInfoList

HTTPcURLJavaScriptPython

GET /api/bo/v1/claim/orderClaimProc/getOrdClmProcMbrInfoList?orderClaimRequest=[object+Object] HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "totalCount": 1,
  "payloads": [
    {
      "siteNo": 1,
      "ordNo": "20230809O007943",
      "mbrNo": 1000002,
      "loginId": "id079",
      "mbrNm": "홍길동",
      "mbrGbCd": 10,
      "mbrGbCdNm": "정회원",
      "mbrGradeCd": 10,
      "mbrGradeCdNm": "GREEN",
      "telRgnNo": "02",
      "telTxnoNo": 1234,
      "telEndNo": 5678,
      "cellSctNo": "010",
      "cellTxnoNo": 1234,
      "cellEndNo": 5678,
      "emailAddr": "[e-mail]",
      "zipNo": "05836",
      "zipAddr": "서울 송파구 법원로9길 26",
      "dtlAddr": "디동 제6층 (문정동,에이치비지니스파크)",
      "siteNm": "플래티어",
      "telNo": "02-1234-5678",
      "cellNo": "010-1234-5678",
      "mgrGbCd": 10,
      "mgrGbCdNm": "주문주의"
    }
  ]
}

주문관리 > 주문 클레임 처리 상품 정보 및 협력사 정보 조회

get

기능 설명

• 하나의 주문 상품 row에 해당하는 상품 정보와 상품 협력사 정보를 조회합니다.

---

상세 설명

• 하나의 주문 상품 row에 해당하는 상품 정보와 상품 협력사 정보를 조회합니다.

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

entrNoStringRequired

협력사번호

itmNoStringRequired

단품번호

goodsNoStringRequired

상품번호

deliPolcNoStringRequired

배송정책번호

Responses

200

성공

*/*

상품 정보 및 협력사 정보 조회 DTO

900

업무처리 오류 내용

*/*

get

/v1/claim/orderClaimProc/getOrdClmProcGoodsEntrInfo

HTTPcURLJavaScriptPython

GET /api/bo/v1/claim/orderClaimProc/getOrdClmProcGoodsEntrInfo?goodsEntrInfoRequest=[object+Object]&entrNo=null&itmNo=null&goodsNo=null&deliPolcNo=null HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "orderClaimEntrInfoResponses": [
    {
      "entrNo": 1000002,
      "entrNm": "B사 위탁",
      "entrGbCd": 10,
      "entrGbCdNm": "상품공급업자",
      "latt": 37.123456,
      "lngt": 127.123456,
      "trdTypCd": 10,
      "trdStatCd": 10,
      "trdStatCdNm": "거래대기",
      "lgcEntrNo": 1000001,
      "rpstmnNm": "홍길동",
      "bmanNo": "123-45-67890",
      "corpnNo": "123-45-67890",
      "btyp": "제조",
      "bkind": "식품",
      "contStrtDy": "2021-01-01",
      "contEndDy": "2029-12-31",
      "aempNm": "홍길동",
      "aempTelRgnNo": "02",
      "aempTelTxnoNo": 1234,
      "aempTelEndNo": 5678,
      "aempCellSctNo": "010",
      "aempCellTxnoNo": 1234,
      "aempCellEndNo": 5678,
      "faxRgnNo": "02",
      "faxTxnoNo": 1234,
      "faxEndNo": 5678,
      "bmanKindCd": 10,
      "zipNoSeq": 1,
      "zipNo": 123,
      "zipAddr": "서울시 강남구",
      "dtlAddr": "테헤란로 123",
      "rmkCont": "비고내용",
      "mrgnRateGbCd": 10,
      "mrgnRate1": 10,
      "mrgnRate2": 20
    }
  ],
  "orderClaimGoodsInfoResponses": [
    {
      "goodsNo": 10002297,
      "goodsNm": "상품명",
      "entrNo": 1000001,
      "stdCtgNo": 1,
      "goodsCompCd": 10,
      "goodsCompCdNm": "일반상품",
      "goodsTypCd": 10,
      "goodsTypCdNm": "일반상품",
      "saleMethCd": 10,
      "saleMethCdNm": "일반판매",
      "brandNo": 1,
      "brandNm": 1,
      "buyrAgeLmtCd": 15,
      "dispYn": "Y",
      "saleStatCd": "01",
      "saleStatCdNm": "임시저장",
      "saleStrDtm": "2021-01-01 00:00:00",
      "saleEndDtm": "2029-01-01 00:00:00",
      "buyTypCd": 10,
      "taxGbCd": 10,
      "stkMgrYn": "Y",
      "buyQtyLmtYn": "Y",
      "minLmtQty": 1,
      "maxLmtQty": 10,
      "safeStkNotiYn": "Y",
      "deliGoodsGbCd": "01",
      "deliWayCd": "01",
      "deliPsbRgnCd": "01",
      "deliDday": 1,
      "deliPolcNo": 1,
      "bpckPsbYn": "Y",
      "rtnPsbYn": "Y",
      "exchPsbYn": "Y",
      "supPcost": 10000,
      "norPrc": 10000,
      "preSalePrc": 10000,
      "salePrc": 10000,
      "mrgnRate": "20%",
      "payMeanInfo": "text",
      "itmNo": "001",
      "itmNm": "아이템명1>아이템명2>아이템명3",
      "stkQty": 999,
      "prestNm": "증정품",
      "rsvStrtDtm": "2021-01-01 00:00:00",
      "rsvEndDtm": "2021-01-01 00:00:00",
      "fwdidcPrarDy": "2021-01-01 00:00:00",
      "tsupPrc": 1,
      "tsalePrc": 1
    }
  ],
  "orderClaimEtDeliPolcInfoResponses": [
    {
      "deliPolcNo": 1,
      "entrNo": 1,
      "dlexTypCd": 10,
      "stdAmt": 100,
      "dlexAmt": 100,
      "wthdRtnAmt": 100,
      "exchDlex": 100,
      "addDlexInfoList": 100,
      "useYn": "Y"
    }
  ]
}

주문관리 > 주문 클레임 처리 > 혜택 적용이력 팝업 조회

get

기능설명

• 주문 관리 > 주문 클레임 처리 화면의 결제/환불 정보에서 혜택적용 이력 버튼 클릭 시 해당 주문에 적용/취소 된 혜택 이력 목록을 조회합니다.

---

상세설명

• 주문/클레임 발생 시에 혜택 테이블에 쌓인 할인 이력들을 클레임 번호 단위로 조회합니다.

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

Responses

200

성공

*/*

totalCountinteger · int32Optional

900

업무처리 오류 내용

*/*

get

/v1/claim/orderClaimProc/getOrdClmProcFvrAplyHistList

HTTPcURLJavaScriptPython

GET /api/bo/v1/claim/orderClaimProc/getOrdClmProcFvrAplyHistList?ordBaseRequest=[object+Object] HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "totalCount": 1,
  "payloads": [
    {
      "cpnIsuNo": 4364833,
      "adtnBassNo": "C1002701",
      "adtnDtlGbNm": "상품할인쿠폰",
      "promoNm": "성능테스트 쿠폰발급2",
      "adtnOcurGbCd": 10,
      "useCnclDtm": "2023-09-06 09:10:55",
      "aplyAdtnAmt": 110,
      "goodsNo": 10002298,
      "goodsNm": "성능테스트_8번째 상품",
      "entrNo": 1000002,
      "entrNm": "플래티어 협력사",
      "claimNo": 100981196
    }
  ]
}

주문관리 > 주문 클레임 처리 > 배송비 상세 내역 팝업 조회

get

기능설명

• 주문 관리 > 주문 클레임 처리 화면의 결제/환불 정보에서 배송비 클릭 시 배송비 상세 내역을 조회합니다.

---

상세설명

• 해당하는 주문번호에 해당하는 배송비 상세 내역이 조회됩니다.

• 배송비 무료 쿠폰 사용 주문 건의 경우 쿠폰 발급 번호가 함께 조회됩니다.

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

Responses

200

성공

*/*

totalCountinteger · int32Optional

900

업무처리 오류 내용

*/*

get

/v1/claim/orderClaimProc/getOrdClmProcDeliveryHistList

HTTPcURLJavaScriptPython

GET /api/bo/v1/claim/orderClaimProc/getOrdClmProcDeliveryHistList?request=[object+Object] HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "totalCount": 1,
  "payloads": [
    {
      "deliNo": 100981196,
      "stdAmt": 10000,
      "dlexAmt": 3500,
      "deliPolcNo": 10000431,
      "entrNm": "B사 위탁",
      "dlexAmtSum": 9000,
      "dlvpNm": "회사",
      "adtnOcurGbNm": "발생",
      "dlexOcurGbNm": "배송비",
      "aplyAdtnAmt": 6000,
      "fvrPolcAplyVal": 0,
      "adtnDtlBassNo": "C1000620",
      "claimNo": "20230616C002033"
    }
  ]
}

주문관리 > 주문 클레임 처리 배송상세 및 반품/회수정보 조회

get

기능 설명

• 주문번호에 해당하는 배송상세 및 반품/회수정보 내역을 조회합니다.

---

상세 설명

• 교환 주문의 경우, 교환건의 출하 row의 배송정보 회수 row의 반품 회수정보를 조회합니다.

---

수정번호

• Release v2.00_240829 : 마스킹 처리 현행화

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

ordNoStringRequired

주문번호

ordSeqIntegerOptional

주문순번

ordProcSeqIntegerOptional

주문처리순번

originDeliNoStringOptional

원배송번호

rtnDeliNoStringOptional

회수배송번호

deliSeqIntegerOptional

배송순번

Responses

200

성공

*/*

배송상세 및 반품/회수정보 조회 DTO

ordNostringOptional

주문번호

Example: 20230809O007943

ordSeqstringOptional

주문순번

Example: 1

ordProcSeqstringOptional

주문처리순번

Example: 1

ordDtlStatCdstringOptional

주문내역상태코드(OM005)

Example: 11

ordDtlStatCdNmstringOptional

주문내역상태코드명

Example: 주문완료

deliProcTypCdstringOptional

배송처리유형코드(PR008)

Example: 10

deliProcTypCdNmstringOptional

배송처리유형코드명

Example: 센터배송

hdcCdstringOptional

택배사코드(LO005)

Example: 10

hdcCdNmstringOptional

택배사명

Example: CJ대한통운

invNostringOptional

송장번호

Example: 111111111

ordManNmstringOptional

주문자명

Example: 홍길동

rcvmnNmstringOptional

수취인명

Example: 홍길동

rcvmnTelRgnNostringOptional

수취인전화지역번호

Example: 02

rcvmnTelTxnoNostringOptional

수취인전화국번번호

Example: 1234

rcvmnTelEndNostringOptional

수취인전화끝번호

Example: 5678

rcvmnCellSctNostringOptional

수취인휴대폰구분번호

Example: 010

rcvmnCellTxnoNostringOptional

수취인휴대폰국번번호

Example: 1234

rcvmnCellEndNostringOptional

수취인휴대폰끝번호

Example: 5678

zipNostringOptional

우편번호

Example: 05836

zipAddrstringOptional

우편주소

Example: 서울 송파구 법원로9길 26

dtlAddrstringOptional

상세주소

Example: 디동 제6층 (문정동,에이치비지니스파크)

deliMsgstringOptional

배송메시지

Example: 문 앞에 놓아주세요

deliMsgCdstringOptional

배송메시지코드(ME039)

Example: 10

deliMsgCdNmstringOptional

배송메시지코드명

Example: 배송메시지 입력 안함

exRtnGbCdstringOptional

회수구분코드(OM002)

Example: 10

exRtnGbCdNmstringOptional

회수구분코드명

Example: 일반주문

exRtnStatCdstringOptional

반품진행상태코드(OM005)

Example: 11

exRtnStatCdNmstringOptional

반품진행상태코드명

Example: 주문완료

claimMgrpCdstringOptional

클레임중분류코드(OM006)

Example: 100

claimMgrpCdNmstringOptional

클레임중분류코드명

Example: 배송이 늦어짐

claimCausEtcContstringOptional

클레임사유기타내용

Example: 배송이 너무 늦습니다.

rtnDeliProcTypCdstringOptional

회수처리유형코드(PR008)

Example: 10

rtnDeliProcTypCdNmstringOptional

회수처리유형코드명

Example: 센터배송

rtnHdcCdstringOptional

수거택배사코드(LO005)

Example: 10

rtnHdcCdNmstringOptional

수거택배사코드명

Example: CJ대한통운

rtnInvNostringOptional

수거송장번호

Example: 111111111

rtnZipNostringOptional

반품우편번호

Example: 05836

rtnZipAddrstringOptional

반품우편주소

Example: 서울 송파구 법원로9길 26

rtnDtlAddrstringOptional

반품상세주소

Example: 디동 제6층 (문정동,에이치비지니스파크)

rtnDeliMsgstringOptional

반품배송메시지

Example: 문 앞에 놓아주세요

rtnDeliMsgCdstringOptional

반품배송메시지코드(ME039)

Example: 10

rtnDeliMsgCdNmstringOptional

반품배송메시지코드명

Example: 배송메시지 입력 안함

wthdFnshGbCdNmstringOptional

회수완료구분(LO011)

Example: 정상반품

deliDtlStatCdNmstringOptional

배송내역상태코드명

Example: 배송지시

persCstmCdstringOptional

개인통관고유번호

Example: P1234567890123

900

업무처리 오류 내용

*/*

get

/v1/claim/orderClaimProc/getOrdClmProcDeliRtnInfo

HTTPcURLJavaScriptPython

GET /api/bo/v1/claim/orderClaimProc/getOrdClmProcDeliRtnInfo?deliveryReturnInfoRequest=[object+Object]&ordNo=null HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ordNo": "20230809O007943",
  "ordSeq": 1,
  "ordProcSeq": 1,
  "ordDtlStatCd": 11,
  "ordDtlStatCdNm": "주문완료",
  "deliProcTypCd": 10,
  "deliProcTypCdNm": "센터배송",
  "hdcCd": 10,
  "hdcCdNm": "CJ대한통운",
  "invNo": 111111111,
  "ordManNm": "홍길동",
  "rcvmnNm": "홍길동",
  "rcvmnTelRgnNo": "02",
  "rcvmnTelTxnoNo": 1234,
  "rcvmnTelEndNo": 5678,
  "rcvmnCellSctNo": "010",
  "rcvmnCellTxnoNo": 1234,
  "rcvmnCellEndNo": 5678,
  "zipNo": "05836",
  "zipAddr": "서울 송파구 법원로9길 26",
  "dtlAddr": "디동 제6층 (문정동,에이치비지니스파크)",
  "deliMsg": "문 앞에 놓아주세요",
  "deliMsgCd": 10,
  "deliMsgCdNm": "배송메시지 입력 안함",
  "exRtnGbCd": 10,
  "exRtnGbCdNm": "일반주문",
  "exRtnStatCd": 11,
  "exRtnStatCdNm": "주문완료",
  "claimMgrpCd": 100,
  "claimMgrpCdNm": "배송이 늦어짐",
  "claimCausEtcCont": "배송이 너무 늦습니다.",
  "rtnDeliProcTypCd": 10,
  "rtnDeliProcTypCdNm": "센터배송",
  "rtnHdcCd": 10,
  "rtnHdcCdNm": "CJ대한통운",
  "rtnInvNo": 111111111,
  "rtnZipNo": "05836",
  "rtnZipAddr": "서울 송파구 법원로9길 26",
  "rtnDtlAddr": "디동 제6층 (문정동,에이치비지니스파크)",
  "rtnDeliMsg": "문 앞에 놓아주세요",
  "rtnDeliMsgCd": 10,
  "rtnDeliMsgCdNm": "배송메시지 입력 안함",
  "wthdFnshGbCdNm": "정상반품",
  "deliDtlStatCdNm": "배송지시",
  "persCstmCd": "P1234567890123"
}

진행상태이력을 조회합니다.

get

기능 설명

• 배송의 진행상태이력 조회, 반품/회수의 진행상태이력을 조회합니다.

---

상세 설명

• 배송의 진행상태이력 조회, 반품/회수의 진행상태이력을 조회합니다.

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

ordNoStringRequired

주문번호

ordSeqintRequired

주문순번

deliNoStringRequired

배송번호

returnTabYnStringRequired

반품회수탭여부

ordDtlGbCdStringRequired

주문상세구분코드

chgDtmLocalDateOptional

상태변경일시

Responses

200

성공

*/*

totalCountinteger · int32Optional

900

업무처리 오류 내용

*/*

get

/v1/claim/orderClaimProc/getOrdClmOrdDtlStatChgHistList

HTTPcURLJavaScriptPython

GET /api/bo/v1/claim/orderClaimProc/getOrdClmOrdDtlStatChgHistList?searchRequest=[object+Object]&ordNo=null&ordSeq=null&deliNo=null&returnTabYn=null&ordDtlGbCd=null HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "totalCount": 1,
  "payloads": [
    {
      "ordNo": "20230809O007943",
      "ordSeq": 1,
      "ordDtlStatCd": 11,
      "ordDtlStatCdNm": "주문완료",
      "chgDtm": "2023-12-31 00:00:00",
      "ordDtlGbCd": 10,
      "ordDtlGbCdNm": "일반주문",
      "goodsNm": "상품명",
      "itmNm": "단품명",
      "ordDtlChgGbCd": 10,
      "ordDtlChgGbCdNm": "일반주문",
      "orderClaimOrdDtlGbCdResponseList": [
        {
          "chgDate": "2023-12-31 00:00:00",
          "ordDtlGbCd": 10,
          "ordDtlGbCdNm": "일반주문"
        }
      ]
    }
  ]
}

고객서비스 > 통합 상담관리 > 상담등록 팝업 > 고객 주문 목록 조회 팝업

get

기능 설명

• 고객 주문 목록 조회 팝업에서 고객의 주문 목록을 조회합니다.

---

상세 내용

• 회원번호, 주문일자, 상품명에 해당하는 고객의 주문목록을 조회합니다.

---

수정번호

• Release v2.00_240830: OM003(주문내역구분코드) 10: 주문일반, 30: 교환주문 조건 추가

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

Responses

200

성공

*/*

totalCountinteger · int32Optional

900

업무처리 오류 내용

*/*

get

/v1/claim/orderClaimProc/getOrdClmCustomerOrderList

HTTPcURLJavaScriptPython

GET /api/bo/v1/claim/orderClaimProc/getOrdClmCustomerOrderList?customerOrderSearchRequest=[object+Object] HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "totalCount": 1,
  "payloads": [
    {
      "ordNo": "text",
      "ordSeq": "text",
      "ordAccpDtm": "2026-02-27T18:14:19.431Z",
      "mbrNo": "text",
      "goodsNo": "text",
      "goodsNm": "text",
      "itmNo": "text",
      "itmNm": "text",
      "salePrc": 1,
      "entrNo": "text",
      "entrNm": "text",
      "ordDtlGbCdNm": "text",
      "ordDtlStatCdNm": "text",
      "rcvmnNm": "text",
      "rcvmnCellSctNo": "text",
      "rcvmnCellTxnoNo": "text",
      "rcvmnCellEndNo": "text",
      "rcvmnCellNo": "text"
    }
  ]
}

주문변경 > 변경 가능한 단품 목록을 조회합니다.

get

기능 설명

• 변경 가능한 단품 목록를 조회 합니다.

---

상세 설명

• 변경 가능한 단품 목록를 조회 합니다.

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

ordNoStringRequired

주문번호

Responses

200

성공

*/*

주문 변경 단품 목록 조회 DTO

goodsNostringOptional

상품번호

Example: 1000001

reqIteNostringOptional

변경할단품번호

Example: 002

900

업무처리 오류 내용

*/*

get

/v1/claim/orderClaimProc/getGoodsItmInfoList

HTTPcURLJavaScriptPython

GET /api/bo/v1/claim/orderClaimProc/getGoodsItmInfoList?orderClaimRequest=[object+Object]&ordNo=null HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "goodsNo": 1000001,
    "reqIteNo": "002",
    "itmNos": [
      {
        "goodsNo": 1000001,
        "itmNo": "001",
        "itmNm": "단품명",
        "stkQty": 1,
        "supPcost": 1000,
        "norPrc": 1000,
        "salePrc": 1000,
        "tsalePrc": 1000,
        "tsupPrc": 1000
      }
    ]
  }
]

주문관리 > 주문 클레임 처리 > 배송비 상세 내역 팝업 내 배송번호 옵션 리스트

get

기능설명

• 배송비 상세 내역 팝업 호출 시, 해당하는 주문번호의 모든 배송번호를 조회합니다.

---

상세설명

• 팝업 화면의 옵션 리스트 용 배송번호 목록입니다.

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

Responses

200

성공

*/*

string[]Optional

900

업무처리 오류 내용

*/*

get

/v1/claim/orderClaimProc/getDeliNoListByOrdNo

HTTPcURLJavaScriptPython

GET /api/bo/v1/claim/orderClaimProc/getDeliNoListByOrdNo?request=[object+Object] HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  "text"
]

반품/교환사유조회

get

기능설명

반품 및 교환 접수 시 사용자가 선택한 반품 교환 사유를 조회합니다.

상세내용

• 주문번호(ordNo), 주문순번(ordSeq), 주문처리순번(ordProcSeq) 기준으로 조회합니다.

• 클레임 정보 및 클레임 대분류/중분류/기타 사유 정보를 조회합니다.

• 반품 교환 접수 시 사유 선택은 필수 값이므로, 조회 결과 값이 없는경우 ValidationException 발생합니다.

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

ordNoStringRequired

주문번호

ordSeqIntegerRequired

주문순번

ordProcSeqIntegerRequired

주문처리순번

Responses

200

성공

*/*

클레임 반품/교환 사유 팝업 응답 DTO

ordNostringOptional

주문번호

Example: 20230808O007404

ordSeqinteger · int32Optional

주문순번

Example: 1

ordProcSeqinteger · int32Optional

주문처리순번

Example: 1

goodsNmstringOptional

상품명

Example: 폴로티셔츠

itmNmstringOptional

단품명

Example: 화이트>95

claimLgrpCdstringOptional

클레임대분류코드(OM047)

Example: 10

claimLgrpCdNmstringOptional

클레임대분류코드명

Example: 단순변심

claimMgrpCdstringOptional

클레임중분류코드(OM006)

Example: 300

claimMgrpCdNmstringOptional

클레임중분류코드명

Example: 사이즈가 큼

claimCausEtcContstringOptional

클레임사유기타내용

Example: 사이즈가 생각보다 큽니다.

filePathstringOptional

파일경로

Example: files/order/2023/08/16/9a908fa8-7a17-480c-bf2b-06ab3439807f_10.jpg

wthdFnshWaitProcCausstringOptional

회수완료대기처리사유

Example: 반품보류

900

업무처리 오류 내용

*/*

get

/v1/claim/orderClaimProc/getClaimCauseInfo

HTTPcURLJavaScriptPython

GET /api/bo/v1/claim/orderClaimProc/getClaimCauseInfo?request=[object+Object]&ordNo=null&ordSeq=null&ordProcSeq=null HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ordNo": "20230808O007404",
  "ordSeq": 1,
  "ordProcSeq": 1,
  "goodsNm": "폴로티셔츠",
  "itmNm": "화이트>95",
  "claimLgrpCd": 10,
  "claimLgrpCdNm": "단순변심",
  "claimMgrpCd": 300,
  "claimMgrpCdNm": "사이즈가 큼",
  "claimCausEtcCont": "사이즈가 생각보다 큽니다.",
  "filePath": "files/order/2023/08/16/9a908fa8-7a17-480c-bf2b-06ab3439807f_10.jpg",
  "wthdFnshWaitProcCaus": "반품보류"
}

반품/교환사유 첨부 이미지 목록 조회

get

기능설명

반품 및 교환 접수 시, 사용자가 첨부한 이미지 목록을 조회합니다.

상세내용

• 주문번호(ordNo), 주문순번(ordSeq), 주문처리순번(ordProcSeq) 기준으로 조회합니다.

• 클레임 사유 선택 시 첨부한 이미지 목록과 이미지 갯수 정보를 조회합니다.

• 사유 이미지 첨부는 최대 5개 까지 허용되며, 결과 목록은 그리드 Response 형태로 리턴됩니다.

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

ordNoStringRequired

주문번호

ordSeqIntegerRequired

주문순번

ordProcSeqIntegerRequired

주문처리순번

Responses

200

성공

*/*

totalCountinteger · int32Optional

900

업무처리 오류 내용

*/*

get

/v1/claim/orderClaimProc/getClaimCauseAttachFileList

HTTPcURLJavaScriptPython

GET /api/bo/v1/claim/orderClaimProc/getClaimCauseAttachFileList?request=[object+Object]&ordNo=null&ordSeq=null&ordProcSeq=null HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "totalCount": 1,
  "payloads": [
    {
      "ordNo": "20230808O007404",
      "ordSeq": 1,
      "ordProcSeq": 1,
      "goodsNm": "폴로티셔츠",
      "itmNm": "화이트>95",
      "claimLgrpCd": 10,
      "claimLgrpCdNm": "단순변심",
      "claimMgrpCd": 300,
      "claimMgrpCdNm": "사이즈가 큼",
      "claimCausEtcCont": "사이즈가 생각보다 큽니다.",
      "filePath": "files/order/2023/08/16/9a908fa8-7a17-480c-bf2b-06ab3439807f_10.jpg",
      "wthdFnshWaitProcCaus": "반품보류"
    }
  ]
}