> For the complete documentation index, see [llms.txt](https://tech.x2bee.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://tech.x2bee.com/api/back-office-api/delivery-bo-api/undefined-1.md).
# 회수처리
## 회수 상태 업데이트
> \## 기능설명\
> \* 회수 상태를 업데이트 합니다.\
> \---\
> \## 상세설명\
> \* BO 회수확인 처리 화면 회수지시 처리 버튼 클릭, 회수완료 처리 화면 회수 완료 버튼 클릭시 회수 상태 업데이트를 진행합니다.\
> \* API-ORDER에 있는 회수 상태 업데이트 API를 호출하여 상태 업데이트를 진행합니다.\
> \* 현재 주문내역상태(OM005), 업데이트할 주문내역상태(OM005), 회수 진행상태 업데이트 대상 리스트는 필수값입니다.\
> \---\
> \## 수정번호\
> \* Release v2.00\_240729 : 택배사코드(hdcCd), 송장번호(invNo) e-쿠폰배송인 경우, null 허용
```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"WithdrawStatUpdateSaveRequest":{"type":"object","description":"회수상태업데이트 요청 DTO","properties":{"ordDtlStatCd":{"type":"string","description":"현재 주문진행상태(OM005)","minLength":1},"updateTargetOrdDtlStatCd":{"type":"string","description":"업데이트할 주문진행상태(OM005)","minLength":1},"withdrawStatUpdateSaveInfoList":{"type":"array","description":"회수 진행상태 업데이트 대상 리스트","items":{"$ref":"#/components/schemas/WithdrawStatUpdateSaveInfo"},"minItems":1}},"required":["ordDtlStatCd","updateTargetOrdDtlStatCd","withdrawStatUpdateSaveInfoList"]},"WithdrawStatUpdateSaveInfo":{"type":"object","description":"회수상태업데이트 정보 DTO","properties":{"ordNo":{"type":"string","description":"주문번호","minLength":1},"deliNo":{"type":"string","description":"배송번호","minLength":1},"hdcCd":{"type":"string","description":"택배사코드"},"invNo":{"type":"string","description":"송장번호"},"wthdFnshGbCd":{"type":"string","description":"회수완료구분코드(LO011)"},"wthdYn":{"type":"string","description":"회수여부"}},"required":["deliNo","hdcCd","invNo","ordNo"]},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/delivery/withdrawMgmt/saveWithdrawStatUpdateProcess":{"post":{"tags":["회수처리"],"summary":"회수 상태 업데이트","description":"## 기능설명\n* 회수 상태를 업데이트 합니다.\n---\n## 상세설명\n* BO 회수확인 처리 화면 회수지시 처리 버튼 클릭, 회수완료 처리 화면 회수 완료 버튼 클릭시 회수 상태 업데이트를 진행합니다.\n* API-ORDER에 있는 회수 상태 업데이트 API를 호출하여 상태 업데이트를 진행합니다.\n* 현재 주문내역상태(OM005), 업데이트할 주문내역상태(OM005), 회수 진행상태 업데이트 대상 리스트는 필수값입니다.\n---\n## 수정번호\n* Release v2.00_240729 : 택배사코드(hdcCd), 송장번호(invNo) e-쿠폰배송인 경우, null 허용\n","operationId":"saveWithdrawStatUpdateProcess","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WithdrawStatUpdateSaveRequest"}}},"required":true},"responses":{"200":{"description":"회수 상태 업데이트 성공"},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## 회수 지시 처리
> \## 기능 설명\
> \* 회수 지시 처리를 진행합니다.\
> \---\
> \## 상세 내용\
> \* BO 회수지시 처리 화면 회수지시 처리 버튼 클릭시 회수지시 처리를 진행합니다.\
> \* API-ORDER에 있는 회수 지시처리 API를 호출하여 회수 지시 처리를 진행합니다.\
> \* 회수지시대상리스트는 필수값입니다.\
> \* 주문내역상태(OM005)가 반품접수(32)인 상태인 주문을 회수지시(34) 상태로 변경합니다.
```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"WithdrawInstructHandlingSaveRequest":{"type":"object","description":"회수지시대상처리 요청 DTO","properties":{"withdrawInstructHandlingSaveInfoList":{"type":"array","description":"회수 지시 대상 리스트","items":{"$ref":"#/components/schemas/WithdrawInstructHandlingSaveInfo"}}}},"WithdrawInstructHandlingSaveInfo":{"type":"object","description":"회수지시대상정보 DTO","properties":{"ordNo":{"type":"string","description":"주문번호","minLength":1},"deliNo":{"type":"string","description":"배송번호","minLength":1},"rtnQty":{"type":"integer","format":"int32","description":"반품수량"}},"required":["deliNo","ordNo","rtnQty"]},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/delivery/withdrawMgmt/saveWithdrawInstructHandlingList":{"post":{"tags":["회수처리"],"summary":"회수 지시 처리","description":"## 기능 설명\n* 회수 지시 처리를 진행합니다.\n---\n## 상세 내용\n* BO 회수지시 처리 화면 회수지시 처리 버튼 클릭시 회수지시 처리를 진행합니다.\n* API-ORDER에 있는 회수 지시처리 API를 호출하여 회수 지시 처리를 진행합니다.\n* 회수지시대상리스트는 필수값입니다.\n* 주문내역상태(OM005)가 반품접수(32)인 상태인 주문을 회수지시(34) 상태로 변경합니다.\n","operationId":"saveWithdrawInstructHandlingList","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WithdrawInstructHandlingSaveRequest"}}},"required":true},"responses":{"200":{"description":"회수 지시 처리 성공"},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## 교환중 반품 처리
> \## 기능설명\
> \* 반품전환 처리를 진행합니다.\
> \---\
> \## 상세설명\
> \* BO 회수완료 처리 화면 반품전환 버튼 클릭시 교환중 반품전환 처리를 진행합니다.\
> \* API-ORDER에 있는 반품전환 API를 호출하여 처리합니다.\
> \* 주문번호, 클레임번호, 주문매체코드는 필수값입니다.
```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ReturnTrnsformRequest":{"type":"object","description":"반품전환요청 DTO","properties":{"ordNo":{"type":"string","description":"주문번호","minLength":1},"claimNo":{"type":"string","description":"클레임번호","minLength":1},"ordMediaCd":{"type":"string","description":"주문매체코드(OM007)","minLength":1}},"required":["claimNo","ordMediaCd","ordNo"]},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/delivery/withdrawMgmt/returnTrnsformProcess":{"post":{"tags":["회수처리"],"summary":"교환중 반품 처리","description":"## 기능설명\n* 반품전환 처리를 진행합니다.\n---\n## 상세설명\n* BO 회수완료 처리 화면 반품전환 버튼 클릭시 교환중 반품전환 처리를 진행합니다.\n* API-ORDER에 있는 반품전환 API를 호출하여 처리합니다.\n* 주문번호, 클레임번호, 주문매체코드는 필수값입니다.\n","operationId":"returnTrnsformProcess","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReturnTrnsformRequest"}}},"required":true},"responses":{"200":{"description":"교환중 반품 처리 성공"},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## 반품불가 처리
> \## 기능설명\
> \* 반품불가 처리를 진행합니다.\
> \---\
> \## 상세설명\
> \* BO 회수완료 처리 화면 반품불가 버튼 클릭시 반품불가 처리를 진행합니다.\
> \* API-ORDER에 있는 반품불가 API를 호출하여 처리합니다.
```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"NoAllowedReturnRequest":{"type":"object","description":"반품불가요청 DTO","properties":{"ordNo":{"type":"string","description":"주문번호","minLength":1},"claimNo":{"type":"string","description":"클레임번호","minLength":1},"ordMediaCd":{"type":"string","description":"주문매체코드(OM007)","minLength":1},"wthdFnshWaitProcCaus":{"type":"string","description":"반품불가사유"}},"required":["claimNo","ordMediaCd","ordNo"]},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/delivery/withdrawMgmt/noAllowedReturnProcess":{"post":{"tags":["회수처리"],"summary":"반품불가 처리","description":"## 기능설명\n* 반품불가 처리를 진행합니다.\n---\n## 상세설명\n* BO 회수완료 처리 화면 반품불가 버튼 클릭시 반품불가 처리를 진행합니다.\n* API-ORDER에 있는 반품불가 API를 호출하여 처리합니다.\n","operationId":"noAllowedReturnProcess","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoAllowedReturnRequest"}}},"required":true},"responses":{"200":{"description":"반품불가 처리 성공"},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## 회수 조회
> \## 기능 설명\
> \* 회수 데이터를 조회합니다.\
> \---\
> \## 상세 내용\
> \* 회수지시처리, 회수확인처리, 회수완료처리 화면 목록을 조회합니다.\
> \* 조회기간구분, 조회시작일, 조회종료일, 배송유형은 필수값입니다.\
> \* 회수지시처리 화면은 접수상태인 주문목록을 조회하고, 회수확인처리 화면은 회수지시인 주문목록을 조회합니다.\
> \---\
> \## 수정 번호\
> \* Release v2.00\_240729 : 회수여부(wthdYn), 배송처리유형코드명(deliProcTypCdNm), 회수불필요주문여부(isAllNonReturnable) 추가\
> \* Release v2.01\_240910 : 배송유형코드명(deliTypCdNm) & 주문내역상태코드명(ordDtlStatCdNm) & 택배사명(hdcCdNm) 조회 추가
```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"WithdrawSearchRequest":{"type":"object","description":"회수정보조회 요청 DTO","properties":{"searchDateType":{"type":"string","description":"조회기간 구분","minLength":1},"startDate":{"type":"string","format":"date","description":"조회 시작일"},"endDate":{"type":"string","format":"date","description":"조회 종료일"},"searchOrdDeliType":{"type":"string","description":"배송정보"},"deliveryType":{"type":"string","description":"배송정보 구분"},"deliTypCd":{"type":"string","description":"배송유형(LO002)"},"deliProcTypCd":{"type":"string","description":"배송처리유형(PR008)"},"searchOrdManType":{"type":"string","description":"주문자정보 구분"},"ordManVal":{"type":"string","description":"주문자정보"},"deliKindCd":{"type":"string","description":"배송종류코드(LO009)"},"entrNo":{"type":"string","description":"협력사번호"},"hdcCd":{"type":"string","description":"택배사 코드"},"ordDtlStatCd":{"type":"string","description":"주문내역상태(OM005)"},"ordDtlStatCdInput":{"type":"string","description":"회수확인 화면 주문내역상태(OM005)"},"targetOrdDtlStatCd":{"type":"string","description":"회수확인 화면 주문내역상태(OM005)"},"wthdYn":{"type":"string","description":"회수필요여부"}},"required":["deliKindCd","deliProcTypCd","entrNo","hdcCd","ordDtlStatCd","ordManVal","searchDateType","searchOrdManType"]},"RealGridListResponseWithdrawSearchResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/WithdrawSearchResponse"}}}},"WithdrawSearchResponse":{"type":"object","description":"회수정보조회 응답 DTO","properties":{"ordNo":{"type":"string","description":"주문번호"},"ordMediaCd":{"type":"string","description":"주문매체코드(OM007)"},"deliNo":{"type":"string","description":"배송번호"},"rtnAccpDtm":{"type":"string","format":"date-time","description":"반품접수일시"},"ordFnshDtm":{"type":"string","format":"date-time","description":"주문완료일시"},"deliTypCd":{"type":"string","description":"배송유형코드(LO002)"},"deliTypCdNm":{"type":"string","description":"배송유형코드명"},"ordDtlGbCd":{"type":"string","description":"주문내역구분코드(OM003)"},"ordDtlStatCd":{"type":"string","description":"주문내역상태코드(OM005)"},"ordDtlStatCdNm":{"type":"string","description":"주문내역상태코드명"},"deliProcTypCd":{"type":"string","description":"배송처리유형코드(PR008)"},"deliProcTypCdNm":{"type":"string","description":"배송처리유형코드명"},"deliKindCd":{"type":"string","description":"배송종류코드(LO009)"},"ordSaleTypCd":{"type":"string","description":"주문판매유형코드(OM004)"},"entrNm":{"type":"string","description":"협력사명"},"loginId":{"type":"string","description":"로그인ID"},"ordManNm":{"type":"string","description":"주문자명"},"ordManCellSctNo":{"type":"string","description":"주문자휴대폰구분번호"},"ordManCellTxnoNo":{"type":"string","description":"주문자휴대폰국번번호"},"ordManCellEndNo":{"type":"string","description":"주문자휴대폰끝번호"},"rcvmnNm":{"type":"string","description":"수취인명"},"rcvmnCellSctNo":{"type":"string","description":"수취인휴대폰구분번호"},"rcvmnCellTxnoNo":{"type":"string","description":"수취인휴대폰국번번호"},"rcvmnCellEndNo":{"type":"string","description":"수취인휴대폰끝번호"},"goodsNo":{"type":"string","description":"상품번호"},"goodsNm":{"type":"string","description":"상품명"},"itmNm":{"type":"string","description":"단품명"},"rtnQty":{"type":"integer","format":"int32","description":"반품수량"},"mbrNo":{"type":"string","description":"회원번호"},"invNo":{"type":"string","description":"송장번호"},"hdcCd":{"type":"string","description":"택배사코드"},"hdcCdNm":{"type":"string","description":"택배사코드명"},"wthdFnshGbCd":{"type":"string","description":"회수완료구분코드(LO011)"},"claimNo":{"type":"string","description":"클레임번호"},"wthdYn":{"type":"string","description":"회수필요여부"},"isAllNonReturnable":{"type":"string","description":"회수불필요주문여부"},"shipIndiDtm":{"type":"string","description":"회수지시일시"},"deliIndiDtm":{"type":"string","description":"배송/회수지시일시"},"shipCfmDtm":{"type":"string","format":"date-time","description":"회수확인일시"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/delivery/withdrawMgmt/getWithdrawList":{"get":{"tags":["회수처리"],"summary":"회수 조회","description":" ## 기능 설명\n * 회수 데이터를 조회합니다.\n ---\n ## 상세 내용\n * 회수지시처리, 회수확인처리, 회수완료처리 화면 목록을 조회합니다.\n * 조회기간구분, 조회시작일, 조회종료일, 배송유형은 필수값입니다.\n * 회수지시처리 화면은 접수상태인 주문목록을 조회하고, 회수확인처리 화면은 회수지시인 주문목록을 조회합니다.\n ---\n ## 수정 번호\n * Release v2.00_240729 : 회수여부(wthdYn), 배송처리유형코드명(deliProcTypCdNm), 회수불필요주문여부(isAllNonReturnable) 추가\n * Release v2.01_240910 : 배송유형코드명(deliTypCdNm) & 주문내역상태코드명(ordDtlStatCdNm) & 택배사명(hdcCdNm) 조회 추가\n","operationId":"withdrawList","parameters":[{"name":"withdrawSearchRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/WithdrawSearchRequest"}},{"name":"searchPeriodType","in":"query","description":"조회기간 구분","required":true,"schema":{"type":"String"}},{"name":"startDate","in":"query","description":"조회 시작일","required":true,"schema":{"type":"LocalDate"}},{"name":"endDate","in":"query","description":"조회 종료일","required":true,"schema":{"type":"LocalDate"}},{"name":"searchOrdDeliType","in":"query","description":"배송정보","schema":{"type":"String"}},{"name":"deliveryType","in":"query","description":"배송정보 구분","schema":{"type":"String"}},{"name":"deliTypCd","in":"query","description":"배송유형","required":true,"schema":{"type":"String"}},{"name":"deliTypCdNm","in":"query","description":"배송유형코드명","required":true,"schema":{"type":"String"}},{"name":"deliProcTypCd","in":"query","description":"배송처리유형","schema":{"type":"String"}},{"name":"searchOrdManType","in":"query","description":"주문자정보 구분","schema":{"type":"String"}},{"name":"ordManVal","in":"query","description":"주문자정보","schema":{"type":"String"}},{"name":"deliKindCd","in":"query","description":"배송종류코드","schema":{"type":"String"}},{"name":"entrNo","in":"query","description":"협력사정보","schema":{"type":"String"}},{"name":"ordDtlStatCd","in":"query","description":"주문내역상태","schema":{"type":"String"}},{"name":"ordDtlStatCdNm","in":"query","description":"주문내역상태코드명","schema":{"type":"String"}},{"name":"ordDtlStatCdInput","in":"query","description":"회수확인 화면 주문내역상태(회수지시)","schema":{"type":"String"}},{"name":"targetOrdDtlStatCd","in":"query","description":"회수확인 화면 주문내역상태(회수확인)","schema":{"type":"String"}},{"name":"wthdYn","in":"query","description":"회수필요여부","schema":{"type":"String"}}],"responses":{"200":{"description":"회수 조회 성공","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RealGridListResponseWithdrawSearchResponse"}}}},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## 회수 상세 팝업 조회
> \## 기능설명\
> \* 회수상세 팝업 정보를 조회합니다.\
> \---\
> \## 상세설명\
> \* 배송번호를 이용해 주문자정보 및 반품상세정보를 조회합니다.\
> \* 유입경로가 PO인 경우에는 해당 협력사 데이터만 조회합니다.\
> \* 응답값 중 개인정보는 마스킹 처리됩니다.\
> \---\
> \## 수정번호\
> \* Release v2.00\_241122 : 회수필요여부(wthdYn)와 반품/교환 사유 팝업 호출을 위한 주문번호(ordNo), 주문순번(ordSeq), 주문처리순번(ordProcSeq) 조회 추가\
> \* Release v2.00\_2508829 : 권한여부에 따른 마스킹처리 추가
```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"WithdrawDetailRequest":{"type":"object","description":"회수상세정보조회 요청 DTO","properties":{"deliNo":{"type":"string","description":"배송번호","minLength":1}},"required":["deliNo"]},"WithdrawDetailResponse":{"type":"object","description":"회수상세 응답 DTO","properties":{"withdrawDeliNo":{"type":"string","description":"회수배송번호"},"rtnAccpDtm":{"type":"string","format":"date-time","description":"반품접수일시"},"ordNo":{"type":"string","description":"주문번호"},"ordSeq":{"type":"integer","format":"int32","description":"주문순번"},"ordProcSeq":{"type":"integer","format":"int32","description":"주문처리순번"},"ordFnshDtm":{"type":"string","format":"date-time","description":"주문완료일시"},"deliTypCd":{"type":"string","description":"배송유형코드명(LO002)"},"deliTypCdNm":{"type":"string","description":"배송유형코드명(LO002)"},"deliProcTypCd":{"type":"string","description":"배송처리유형코드(PR008)"},"deliProcTypCdNm":{"type":"string","description":"배송처리유형코드명"},"ordManNm":{"type":"string","description":"주문자명"},"ordManCellSctNo":{"type":"string","description":"주문자휴대폰구분번호"},"ordManCellTxnoNo":{"type":"string","description":"주문자휴대폰국번번호"},"ordManCellEndNo":{"type":"string","description":"주문자휴대폰끝번호"},"rcvmnNm":{"type":"string","description":"수취인명"},"rcvmnCellSctNo":{"type":"string","description":"수취인휴대폰구분번호"},"rcvmnCellTxnoNo":{"type":"string","description":"수취인휴대폰국번번호"},"rcvmnCellEndNo":{"type":"string","description":"수취인휴대폰끝번호"},"zipAddr":{"type":"string","description":"기본주소"},"dtlAddr":{"type":"string","description":"상세주소"},"wthdYn":{"type":"string","description":"회수필요여부"},"withdrawDetailGoodsInfoList":{"type":"array","description":"회수상품정보리스트","items":{"$ref":"#/components/schemas/WithdrawDetailGoodsInfo"}}}},"WithdrawDetailGoodsInfo":{"type":"object","description":"회수상세상품목록 응답 DTO","properties":{"ordNo":{"type":"string","description":"주문번호"},"ordSeq":{"type":"integer","format":"int32","description":"주문순번"},"ordProcSeq":{"type":"integer","format":"int32","description":"주문처리순번"},"goodsNo":{"type":"string","description":"상품번호"},"goodsNm":{"type":"string","description":"상품명"},"itmNm":{"type":"string","description":"단품명"},"puTypCd":{"type":"string","description":"수거유형코드명(LO006)"},"ordDtlStatCd":{"type":"string","description":"주문내역상태코드(OM005)"},"ordDtlStatCdNm":{"type":"string","description":"주문내역상태코드명(OM005)"},"hdcCd":{"type":"string","description":"택배사코드명(LO005)"},"invNo":{"type":"string","description":"송장번호"},"claimCause":{"type":"string","description":"클레임중분류코드명(OM006)"},"claimDtlCause":{"type":"string","description":"클레임사유기타내용"},"wthdFnshGbCd":{"type":"string","description":"회수완료구분코드명(LO011)"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/delivery/withdrawMgmt/getWithdrawDetail":{"get":{"tags":["회수처리"],"summary":"회수 상세 팝업 조회","description":"## 기능설명\n* 회수상세 팝업 정보를 조회합니다.\n---\n## 상세설명\n* 배송번호를 이용해 주문자정보 및 반품상세정보를 조회합니다.\n* 유입경로가 PO인 경우에는 해당 협력사 데이터만 조회합니다.\n* 응답값 중 개인정보는 마스킹 처리됩니다.\n---\n## 수정번호\n* Release v2.00_241122 : 회수필요여부(wthdYn)와 반품/교환 사유 팝업 호출을 위한 주문번호(ordNo), 주문순번(ordSeq), 주문처리순번(ordProcSeq) 조회 추가\n* Release v2.00_2508829 : 권한여부에 따른 마스킹처리 추가\n","operationId":"getWithdrawDetail","parameters":[{"name":"withdrawDetailRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/WithdrawDetailRequest"}},{"name":"deliNo","in":"query","description":"배송번호","required":true,"schema":{"type":"String"}}],"responses":{"200":{"description":"회수 상세 팝업 조회 성공","content":{"*/*":{"schema":{"$ref":"#/components/schemas/WithdrawDetailResponse"}}}},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://tech.x2bee.com/api/back-office-api/delivery-bo-api/undefined-1.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.