회수처리

회수 상태 업데이트

post

기능설명

• 회수 상태를 업데이트 합니다.

---

상세설명

• BO 회수확인 처리 화면 회수지시 처리 버튼 클릭, 회수완료 처리 화면 회수 완료 버튼 클릭시 회수 상태 업데이트를 진행합니다.

• API-ORDER에 있는 회수 상태 업데이트 API를 호출하여 상태 업데이트를 진행합니다.

• 현재 주문내역상태(OM005), 업데이트할 주문내역상태(OM005), 회수 진행상태 업데이트 대상 리스트는 필수값입니다.

---

수정번호

• Release v2.00_240729 : 택배사코드(hdcCd), 송장번호(invNo) e-쿠폰배송인 경우, null 허용

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

회수상태업데이트 요청 DTO

ordDtlStatCdstring · min: 1Required

현재 주문진행상태(OM005)

Example: 32

updateTargetOrdDtlStatCdstring · min: 1Required

업데이트할 주문진행상태(OM005)

Example: 34

Responses

200

회수 상태 업데이트 성공

No content

900

업무처리 오류 내용

*/*

post

/v1/delivery/withdrawMgmt/saveWithdrawStatUpdateProcess

HTTPcURLJavaScriptPython

POST /api/bo/v1/delivery/withdrawMgmt/saveWithdrawStatUpdateProcess HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 191

{
  "ordDtlStatCd": 32,
  "updateTargetOrdDtlStatCd": 34,
  "withdrawStatUpdateSaveInfoList": [
    {
      "ordNo": "20230816O009106",
      "deliNo": 100016628,
      "hdcCd": 10,
      "invNo": 123456789,
      "wthdFnshGbCd": 10,
      "wthdYn": "Y"
    }
  ]
}

No content

회수 지시 처리

post

기능 설명

• 회수 지시 처리를 진행합니다.

---

상세 내용

• BO 회수지시 처리 화면 회수지시 처리 버튼 클릭시 회수지시 처리를 진행합니다.

• API-ORDER에 있는 회수 지시처리 API를 호출하여 회수 지시 처리를 진행합니다.

• 회수지시대상리스트는 필수값입니다.

• 주문내역상태(OM005)가 반품접수(32)인 상태인 주문을 회수지시(34) 상태로 변경합니다.

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

회수지시대상처리 요청 DTO

Responses

200

회수 지시 처리 성공

No content

900

업무처리 오류 내용

*/*

post

/v1/delivery/withdrawMgmt/saveWithdrawInstructHandlingList

HTTPcURLJavaScriptPython

POST /api/bo/v1/delivery/withdrawMgmt/saveWithdrawInstructHandlingList HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 100

{
  "withdrawInstructHandlingSaveInfoList": [
    {
      "ordNo": "20230816O009106",
      "deliNo": 100016628,
      "rtnQty": 1
    }
  ]
}

No content

교환중 반품 처리

post

기능설명

• 반품전환 처리를 진행합니다.

---

상세설명

• BO 회수완료 처리 화면 반품전환 버튼 클릭시 교환중 반품전환 처리를 진행합니다.

• API-ORDER에 있는 반품전환 API를 호출하여 처리합니다.

• 주문번호, 클레임번호, 주문매체코드는 필수값입니다.

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

반품전환요청 DTO

ordNostring · min: 1Required

주문번호

Example: 20230808O007404

claimNostring · min: 1Required

클레임번호

Example: 20230801C008072

ordMediaCdstring · min: 1Required

주문매체코드(OM007)

Example: 30

Responses

200

교환중 반품 처리 성공

No content

900

업무처리 오류 내용

*/*

post

/v1/delivery/withdrawMgmt/returnTrnsformProcess

HTTPcURLJavaScriptPython

POST /api/bo/v1/delivery/withdrawMgmt/returnTrnsformProcess HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 71

{
  "ordNo": "20230808O007404",
  "claimNo": "20230801C008072",
  "ordMediaCd": 30
}

No content

반품불가 처리

post

기능설명

• 반품불가 처리를 진행합니다.

---

상세설명

• BO 회수완료 처리 화면 반품불가 버튼 클릭시 반품불가 처리를 진행합니다.

• API-ORDER에 있는 반품불가 API를 호출하여 처리합니다.

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

반품불가요청 DTO

ordNostring · min: 1Required

주문번호

Example: 20230808O007404

claimNostring · min: 1Required

클레임번호

Example: 20230801C008072

ordMediaCdstring · min: 1Required

주문매체코드(OM007)

Example: 30

wthdFnshWaitProcCausstringOptional

반품불가사유

Example: 불량반품

Responses

200

반품불가 처리 성공

No content

900

업무처리 오류 내용

*/*

post

/v1/delivery/withdrawMgmt/noAllowedReturnProcess

HTTPcURLJavaScriptPython

POST /api/bo/v1/delivery/withdrawMgmt/noAllowedReturnProcess HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 109

{
  "ordNo": "20230808O007404",
  "claimNo": "20230801C008072",
  "ordMediaCd": 30,
  "wthdFnshWaitProcCaus": "불량반품"
}

No content

회수 조회

get

기능 설명

• 회수 데이터를 조회합니다.

---

상세 내용

• 회수지시처리, 회수확인처리, 회수완료처리 화면 목록을 조회합니다.

• 조회기간구분, 조회시작일, 조회종료일, 배송유형은 필수값입니다.

• 회수지시처리 화면은 접수상태인 주문목록을 조회하고, 회수확인처리 화면은 회수지시인 주문목록을 조회합니다.

---

수정 번호

• Release v2.00_240729 : 회수여부(wthdYn), 배송처리유형코드명(deliProcTypCdNm), 회수불필요주문여부(isAllNonReturnable) 추가

• Release v2.01_240910 : 배송유형코드명(deliTypCdNm) & 주문내역상태코드명(ordDtlStatCdNm) & 택배사명(hdcCdNm) 조회 추가

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

searchPeriodTypeStringRequired

조회기간 구분

startDateLocalDateRequired

조회 시작일

endDateLocalDateRequired

조회 종료일

searchOrdDeliTypeStringOptional

배송정보

deliveryTypeStringOptional

배송정보 구분

deliTypCdStringRequired

배송유형

deliTypCdNmStringRequired

배송유형코드명

deliProcTypCdStringOptional

배송처리유형

searchOrdManTypeStringOptional

주문자정보 구분

ordManValStringOptional

주문자정보

deliKindCdStringOptional

배송종류코드

entrNoStringOptional

협력사정보

ordDtlStatCdStringOptional

주문내역상태

ordDtlStatCdNmStringOptional

주문내역상태코드명

ordDtlStatCdInputStringOptional

회수확인 화면 주문내역상태(회수지시)

targetOrdDtlStatCdStringOptional

회수확인 화면 주문내역상태(회수확인)

wthdYnStringOptional

회수필요여부

Responses

200

회수 조회 성공

*/*

totalCountinteger · int32Optional

900

업무처리 오류 내용

*/*

get

/v1/delivery/withdrawMgmt/getWithdrawList

HTTPcURLJavaScriptPython

GET /api/bo/v1/delivery/withdrawMgmt/getWithdrawList?withdrawSearchRequest=[object+Object]&searchPeriodType=null&startDate=null&endDate=null&deliTypCd=null&deliTypCdNm=null HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "totalCount": 1,
  "payloads": [
    {
      "ordNo": "20230808O007404",
      "ordMediaCd": 30,
      "deliNo": 100016628,
      "rtnAccpDtm": "2023-12-31 00:00:00",
      "ordFnshDtm": "2023-12-31 00:00:00",
      "deliTypCd": 10,
      "deliTypCdNm": "반품회수",
      "ordDtlGbCd": 30,
      "ordDtlStatCd": 34,
      "ordDtlStatCdNm": "회수지시",
      "deliProcTypCd": 10,
      "deliProcTypCdNm": "센터배송",
      "deliKindCd": 10,
      "ordSaleTypCd": 10,
      "entrNm": "플래티어 협력사",
      "loginId": "x2admin",
      "ordManNm": "홍길동",
      "ordManCellSctNo": "010",
      "ordManCellTxnoNo": 1234,
      "ordManCellEndNo": 5678,
      "rcvmnNm": "홍길동",
      "rcvmnCellSctNo": "010",
      "rcvmnCellTxnoNo": 1234,
      "rcvmnCellEndNo": 3546,
      "goodsNo": 100000001,
      "goodsNm": "상품이름",
      "itmNm": "파랑",
      "rtnQty": 1,
      "mbrNo": 100001311,
      "invNo": 123456789,
      "hdcCd": 10,
      "hdcCdNm": "우체국택배",
      "wthdFnshGbCd": 10,
      "claimNo": "20230801C008072",
      "wthdYn": "Y",
      "isAllNonReturnable": "Y",
      "shipIndiDtm": "2023-12-31 00:00:00",
      "deliIndiDtm": "2023-12-31 00:00:00",
      "shipCfmDtm": "2023-12-31 00:00:00"
    }
  ]
}

회수 상세 팝업 조회

get

기능설명

• 회수상세 팝업 정보를 조회합니다.

---

상세설명

• 배송번호를 이용해 주문자정보 및 반품상세정보를 조회합니다.

• 유입경로가 PO인 경우에는 해당 협력사 데이터만 조회합니다.

• 응답값 중 개인정보는 마스킹 처리됩니다.

---

수정번호

• Release v2.00_241122 : 회수필요여부(wthdYn)와 반품/교환 사유 팝업 호출을 위한 주문번호(ordNo), 주문순번(ordSeq), 주문처리순번(ordProcSeq) 조회 추가

• Release v2.00_2508829 : 권한여부에 따른 마스킹처리 추가

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

deliNoStringRequired

배송번호

Responses

200

회수 상세 팝업 조회 성공

*/*

회수상세 응답 DTO

withdrawDeliNostringOptional

회수배송번호

Example: 100016628

rtnAccpDtmstring · date-timeOptional

반품접수일시

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

ordNostringOptional

주문번호

Example: 20230808O007404

ordSeqinteger · int32Optional

주문순번

Example: 1

ordProcSeqinteger · int32Optional

주문처리순번

Example: 1

ordFnshDtmstring · date-timeOptional

주문완료일시

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

deliTypCdstringOptional

배송유형코드명(LO002)

Example: 10

deliTypCdNmstringOptional

배송유형코드명(LO002)

Example: 정상출하

deliProcTypCdstringOptional

배송처리유형코드(PR008)

Example: 10

deliProcTypCdNmstringOptional

배송처리유형코드명

Example: 센터배송

ordManNmstringOptional

주문자명

Example: 홍길동

ordManCellSctNostringOptional

주문자휴대폰구분번호

Example: 010

ordManCellTxnoNostringOptional

주문자휴대폰국번번호

Example: 1324

ordManCellEndNostringOptional

주문자휴대폰끝번호

Example: 5678

rcvmnNmstringOptional

수취인명

Example: 홍길동

rcvmnCellSctNostringOptional

수취인휴대폰구분번호

Example: 010

rcvmnCellTxnoNostringOptional

수취인휴대폰국번번호

Example: 1324

rcvmnCellEndNostringOptional

수취인휴대폰끝번호

Example: 5678

zipAddrstringOptional

기본주소

Example: 서울시 강남구

dtlAddrstringOptional

상세주소

Example: 테헤란로 123

wthdYnstringOptional

회수필요여부

Example: Y

900

업무처리 오류 내용

*/*

get

/v1/delivery/withdrawMgmt/getWithdrawDetail

HTTPcURLJavaScriptPython

GET /api/bo/v1/delivery/withdrawMgmt/getWithdrawDetail?withdrawDetailRequest=[object+Object]&deliNo=null HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "withdrawDeliNo": 100016628,
  "rtnAccpDtm": "2023-12-31 00:00:00",
  "ordNo": "20230808O007404",
  "ordSeq": 1,
  "ordProcSeq": 1,
  "ordFnshDtm": "2023-12-31 00:00:00",
  "deliTypCd": 10,
  "deliTypCdNm": "정상출하",
  "deliProcTypCd": 10,
  "deliProcTypCdNm": "센터배송",
  "ordManNm": "홍길동",
  "ordManCellSctNo": "010",
  "ordManCellTxnoNo": 1324,
  "ordManCellEndNo": 5678,
  "rcvmnNm": "홍길동",
  "rcvmnCellSctNo": "010",
  "rcvmnCellTxnoNo": 1324,
  "rcvmnCellEndNo": 5678,
  "zipAddr": "서울시 강남구",
  "dtlAddr": "테헤란로 123",
  "wthdYn": "Y",
  "withdrawDetailGoodsInfoList": [
    {
      "ordNo": "20230808O007404",
      "ordSeq": 1,
      "ordProcSeq": 1,
      "goodsNo": 10002042,
      "goodsNm": "상품명",
      "itmNm": "파랑",
      "puTypCd": "회수",
      "ordDtlStatCd": 10,
      "ordDtlStatCdNm": "접수",
      "hdcCd": "CJ대한통운",
      "invNo": 123456789,
      "claimCause": "유사상품 구매",
      "claimDtlCause": "text",
      "wthdFnshGbCd": "정상반품"
    }
  ]
}