> 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-5.md).
# 배송관리
## 결품처리
> \## 기능설명\
> \* 결품관리 화면의 결품처리를 진행합니다.\
> \---\
> \## 상세설명\
> \* 결품등록, 결품해제를 진행합니다.\
> \* 원주문내역상태코드(ordDtlStatCd:OM005), 처리주문내역상태코드(targetOrdDtlStatCd:OM005), 결품처리 요청목록(insuffDeliveryProcessInfoList)은 필수로 있어야 합니다.\
> \* 원주문내역상태코드(OM005) -> 처리주문내역상태코드(OM005)\
> \* 결품등록 : 22(출고지시) -> 23(출고대기)\
> \* 결품해제 : 23(출고대기) -> 22(출고지시)\
> \* API-ORDER에 있는 결품처리 API를 호출하여 처리를 진행합니다.\
> \* 결품 등록 후 고객센터 OB목록에 등록됩니다.\
> \* 결품 등록 후 알림메시지(알림톡, 알림함)를 전송합니다.
```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":{"InsuffDeliveryProcessRequest":{"type":"object","description":"결품처리요청 DTO","properties":{"ordDtlStatCd":{"type":"string","description":"원주문내역상태코드(OM005) 22:출고지시, 23:출고대기","minLength":1},"targetOrdDtlStatCd":{"type":"string","description":"처리주문내역상태코드(OM005) 22:출고지시, 23:출고대기","minLength":1},"insuffDeliveryProcessInfoList":{"type":"array","description":"배송처리 목록","items":{"$ref":"#/components/schemas/InsuffDeliveryProcessInfo"}}},"required":["insuffDeliveryProcessInfoList","ordDtlStatCd","targetOrdDtlStatCd"]},"InsuffDeliveryProcessInfo":{"type":"object","description":"결품처리정보 DTO","properties":{"ordNo":{"type":"string","description":"주문번호","minLength":1},"deliNo":{"type":"string","description":"배송번호","minLength":1},"ordSeq":{"type":"integer","format":"int32","description":"주문순번"},"ordProcSeq":{"type":"integer","format":"int32","description":"주문처리순번"},"shipWaitCaus":{"type":"string","description":"결품사유(LO007) 10:재고부족, 20:재고있지만출고불가능, 30:고객변심","minLength":1},"shipWaitCausCont":{"type":"string","description":"결품상세사유"},"insuffQty":{"type":"integer","format":"int32","description":"결품수량"}},"required":["deliNo","ordNo","ordProcSeq","ordSeq","shipWaitCaus"]},"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/deliveryCommon/processInsuffDelivery":{"post":{"tags":["배송관리"],"summary":"결품처리","description":"## 기능설명\n* 결품관리 화면의 결품처리를 진행합니다.\n---\n## 상세설명\n* 결품등록, 결품해제를 진행합니다.\n* 원주문내역상태코드(ordDtlStatCd:OM005), 처리주문내역상태코드(targetOrdDtlStatCd:OM005), 결품처리 요청목록(insuffDeliveryProcessInfoList)은 필수로 있어야 합니다.\n* 원주문내역상태코드(OM005) -> 처리주문내역상태코드(OM005)\n * 결품등록 : 22(출고지시) -> 23(출고대기)\n * 결품해제 : 23(출고대기) -> 22(출고지시)\n* API-ORDER에 있는 결품처리 API를 호출하여 처리를 진행합니다.\n* 결품 등록 후 고객센터 OB목록에 등록됩니다.\n* 결품 등록 후 알림메시지(알림톡, 알림함)를 전송합니다.\n","operationId":"processInsuffDelivery","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InsuffDeliveryProcessRequest"}}},"required":true},"responses":{"200":{"description":"결품 처리 성공"},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## 배송처리
> \## 기능설명\
> \* 배송관리 화면의 배송처리를 진행합니다.\
> \---\
> \## 상세설명\
> \* 배송지시, 출고지시, 출고완료, 배송완료를 진행합니다.\
> \* 원주문내역상태코드(ordDtlStatCd:OM005), 처리주문내역상태코드(targetOrdDtlStatCd:OM005), 배송처리 목록(deliveryProcessInfoList)은 필수로 있어야 합니다.\
> \* 원주문내역상태코드(OM005) -> 처리주문내역상태코드(OM005)\
> \* 배송지시 : 12(주문완료) -> 21(배송지시)\
> \* 출고지시 : 21(배송지시) -> 22(출고지시)\
> \* 출고완료 : 22(출고지시) -> 26(출고완료)\
> \* 배송완료 : 26(출고완료) -> 27(배송완료)\
> \* 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":{"DeliveryProcessRequest":{"type":"object","description":"배송처리 요청 DTO","properties":{"ordDtlStatCd":{"type":"string","description":"원주문내역상태코드(OM005)","enum":["REPAY_REQ","ORDER_ACCEPT","ORDER_COMPLETE","ORDER_CANCEL","DELIVERY_ORDER","SHIPPING_ORDER","SHIPPING_WAIT","SHIPPING_CONFIRM","SHIPPING_FINISH","DELIVERY_FINISH","RETURN_APPLY","RETURN_ACCEPT","RETURN_CANCEL","WITHDRAWAL_ORDER","WITHDRAWAL_FINISH_WAIT","WITHDRAWAL_FINISH","RETURN_FINISH"],"minLength":1},"targetOrdDtlStatCd":{"type":"string","description":"처리주문내역상태코드(OM005)","enum":["REPAY_REQ","ORDER_ACCEPT","ORDER_COMPLETE","ORDER_CANCEL","DELIVERY_ORDER","SHIPPING_ORDER","SHIPPING_WAIT","SHIPPING_CONFIRM","SHIPPING_FINISH","DELIVERY_FINISH","RETURN_APPLY","RETURN_ACCEPT","RETURN_CANCEL","WITHDRAWAL_ORDER","WITHDRAWAL_FINISH_WAIT","WITHDRAWAL_FINISH","RETURN_FINISH"],"minLength":1},"deliDtlStatCd":{"type":"string","description":"원배송내역상태코드(LO016)"},"targetDeliDtlStatCd":{"type":"string","description":"처리배송내역상태코드(LO016)"},"deliveryProcessInfoList":{"type":"array","description":"배송처리 목록","items":{"$ref":"#/components/schemas/DeliveryProcessInfo"}}},"required":["deliveryProcessInfoList","ordDtlStatCd","targetOrdDtlStatCd"]},"DeliveryProcessInfo":{"type":"object","description":"배송처리 정보 DTO","properties":{"ordNo":{"type":"string","description":"주문번호"},"ordSeq":{"type":"integer","format":"int32","description":"주문순번"},"shipQty":{"type":"integer","format":"int32","description":"출고수량"},"deliSeq":{"type":"integer","format":"int32","description":"배송순번"},"deliNo":{"type":"string","description":"배송번호","minLength":1},"hdcCd":{"type":"string","description":"택배사코드(LO005)","enum":["REPAY_REQ","ORDER_ACCEPT","ORDER_COMPLETE","ORDER_CANCEL","DELIVERY_ORDER","SHIPPING_ORDER","SHIPPING_WAIT","SHIPPING_CONFIRM","SHIPPING_FINISH","DELIVERY_FINISH","RETURN_APPLY","RETURN_ACCEPT","RETURN_CANCEL","WITHDRAWAL_ORDER","WITHDRAWAL_FINISH_WAIT","WITHDRAWAL_FINISH","RETURN_FINISH"]},"invNo":{"type":"string","description":"송장번호"},"alimYn":{"type":"string","description":"알림메시지전송여부"}},"required":["deliNo"]},"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/deliveryCommon/processDelivery":{"post":{"tags":["배송관리"],"summary":"배송처리","description":"## 기능설명\n* 배송관리 화면의 배송처리를 진행합니다.\n---\n## 상세설명\n* 배송지시, 출고지시, 출고완료, 배송완료를 진행합니다.\n* 원주문내역상태코드(ordDtlStatCd:OM005), 처리주문내역상태코드(targetOrdDtlStatCd:OM005), 배송처리 목록(deliveryProcessInfoList)은 필수로 있어야 합니다.\n* 원주문내역상태코드(OM005) -> 처리주문내역상태코드(OM005)\n * 배송지시 : 12(주문완료) -> 21(배송지시)\n * 출고지시 : 21(배송지시) -> 22(출고지시)\n * 출고완료 : 22(출고지시) -> 26(출고완료)\n * 배송완료 : 26(출고완료) -> 27(배송완료)\n* API-ORDER에 있는 배송처리 API를 호출하여 처리를 진행합니다.\n* 배송 처리 후 알림메시지(알림톡, 알림함, 이메일)를 전송합니다.\n","operationId":"processDelivery","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeliveryProcessRequest"}}},"required":true},"responses":{"200":{"description":"배송 처리 성공"},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## 배송처리목록조회
> \## 기능설명\
> \* 배송처리 화면의 배송목록을 조회합니다.\
> \---\
> \## 상세설명\
> \* 배송지시처리, 출고지시처리, 출고완료처리, 배송완료처리, 결품처리 화면에서 사용합니다.\
> \* 주문수량이 유효한 주문만 조회합니다.(주문수량 - 취소수량 > 0)\
> \* 유입경로가 PO인 경우에는 해당 협력사 데이터만 조회합니다.\
> \* 주문내역상태(OM005)가 주문취소(13), 반품취소(33), 반품완료(37)인 건은 조회하지 않습니다.\
> \* 조회기간은 최대 30일까지만 조회 가능합니다.
```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":{"DeliveryMgmtCommonRequest":{"type":"object","description":"배송관리조회 요청 DTO","properties":{"entrNo":{"type":"string","description":"협력사번호"},"searchDateType":{"type":"string","description":"조회기간구분"},"startDate":{"type":"string","format":"date","description":"조회기간(시작일)"},"endDate":{"type":"string","format":"date","description":"조회기간(종료일)"},"searchDeliveryType":{"type":"string","description":"배송정보 구분"},"deliveryVal":{"type":"string","description":"배송정보 입력값"},"deliKindCd":{"type":"string","description":"배송종류(LO009) 10:일반배송, 20:예약배송"},"searchOrdManType":{"type":"string","description":"주문자정보구분"},"ordManVal":{"type":"string","description":"주문자정보입력값"},"deliProcTypCd":{"type":"string","description":"배송처리유형(PR008) 10:센터배송, 20:업체배송, 30:e-쿠폰배송"},"searchOrdDtlStatCd":{"type":"string","description":"주문내역상태(조회조건)"},"ordDtlStatCd":{"type":"string","description":"원주문내역상태코드(OM005) 12:주문완료, 21:배송지시, 22:출고지시, 23:출고대기, 26:출고완료, 33:접수"},"toOrdDtlStatCd":{"type":"string","description":"처리주문내역상태코드(OM005) 21:배송지시, 22:출고지시, 23:출고대기, 26:출고완료, 27:배송완료"},"hdcCd":{"type":"string","description":"택배사(LO005) 10:CJ대한통운, 11:우체국택배, 12:굿투럭, 13:DHL택배, 14:로젠택배, 30:부릉, 31:고고밴"},"shipWaitCaus":{"type":"string","description":"출고대기사유(LO007) 10:재고부족, 20:재고있지만출고불가능, 30:고객변심"},"workType":{"type":"string","description":"배송 업무 유형(DeliveryWorkType) insuffMgmt:결품 관리"}}},"RealGridListResponseDeliveryMgmtCommonResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/DeliveryMgmtCommonResponse"}}}},"DeliveryMgmtCommonResponse":{"type":"object","description":"배송처리조회 응답 DTO","properties":{"ordNo":{"type":"string","description":"주문번호"},"ordSeq":{"type":"string","description":"주문순번"},"ordProcSeq":{"type":"string","description":"주문처리순번"},"deliNo":{"type":"string","description":"배송번호"},"deliSeq":{"type":"string","description":"배송순번"},"ordGbCd":{"type":"string","description":"주문구분코드"},"ordAccpDtm":{"type":"string","format":"date-time","description":"주문접수일시"},"ordDtlGbCd":{"type":"string","description":"주문내역구분코드"},"ordDtlStatCd":{"type":"string","description":"주문내역상태코드"},"ordDtlStatCdNm":{"type":"string","description":"주문내역상태코드명"},"deliKindCd":{"type":"string","description":"배송종류코드"},"deliProcTypCd":{"type":"string","description":"배송처리유형(PR008)"},"hdcCd":{"type":"string","description":"택배사(LO005)"},"hdcCdNm":{"type":"string","description":"택배사명"},"invNo":{"type":"string","description":"송장번호"},"ordSaleTypCd":{"type":"string","description":"주문판매유형(OM004)"},"partShipYn":{"type":"string","description":"분리출고가능여부"},"goodsNo":{"type":"string","description":"상품번호"},"goodsNm":{"type":"string","description":"상품명"},"itmNo":{"type":"string","description":"단품번호"},"itmNm":{"type":"string","description":"단품명"},"prestNm":{"type":"string","description":"증정품명"},"ordQty":{"type":"string","description":"주문수량"},"preShipQty":{"type":"string","description":"기출고수량"},"shipNeedQty":{"type":"string","description":"출고필요수량"},"shipQty":{"type":"string","description":"출고수량"},"norPrc":{"type":"number","description":"정상가"},"salePrc":{"type":"number","description":"판매가"},"entrNm":{"type":"string","description":"협력사명"},"loginId":{"type":"string","description":"로그인ID"},"mbrNo":{"type":"string","description":"회원번호"},"ordManNm":{"type":"string","description":"주문자명"},"ordManCellNo":{"type":"string","description":"주문자휴대폰번호"},"ordManCellSctNo":{"type":"string","description":"주문자휴대폰구분번호"},"ordManCellTxnoNo":{"type":"string","description":"주문자휴대폰국번번호"},"ordManCellEndNo":{"type":"string","description":"주문자휴대폰끝번호"},"rcvmnNm":{"type":"string","description":"수취인명"},"rcvmnCellNo":{"type":"string","description":"수취인휴대폰번호"},"rcvmnCellSctNo":{"type":"string","description":"수취인휴대폰구분번호"},"rcvmnCellTxnoNo":{"type":"string","description":"수취인휴대폰국번번호"},"rcvmnCellEndNo":{"type":"string","description":"수취인휴대폰끝번호"},"zipAddr":{"type":"string","description":"우편주소"},"dtlAddr":{"type":"string","description":"상세주소"},"deliMsgCd":{"type":"string","description":"배송메시지코드(ME039)"},"deliMsg":{"type":"string","description":"배송메시지"},"deliIndiDtm":{"type":"string","format":"date-time","description":"배송지시일시"},"shipWaitCaus":{"type":"string","description":"출고대기사유(LO007)"},"shipWaitCausCont":{"type":"string","description":"출고대기사유상세내용"},"shipWaitDtm":{"type":"string","format":"date-time","description":"출고대기일시"},"insuffElpsdDay":{"type":"string","description":"결품경과일"},"insuffQty":{"type":"integer","format":"int32","description":"결품수량"},"shipIndiDtm":{"type":"string","format":"date-time","description":"출고지시일시"},"shipFnshDtm":{"type":"string","format":"date-time","description":"출고완료일시"},"ordFnshDtm":{"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/deliveryCommon/getDeliveryMgmtList":{"get":{"tags":["배송관리"],"summary":"배송처리목록조회","description":"## 기능설명\n* 배송처리 화면의 배송목록을 조회합니다.\n---\n## 상세설명\n* 배송지시처리, 출고지시처리, 출고완료처리, 배송완료처리, 결품처리 화면에서 사용합니다.\n* 주문수량이 유효한 주문만 조회합니다.(주문수량 - 취소수량 > 0)\n* 유입경로가 PO인 경우에는 해당 협력사 데이터만 조회합니다.\n* 주문내역상태(OM005)가 주문취소(13), 반품취소(33), 반품완료(37)인 건은 조회하지 않습니다.\n* 조회기간은 최대 30일까지만 조회 가능합니다.\n","operationId":"getDeliveryMgmtList","parameters":[{"name":"deliveryMgmtCommonRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/DeliveryMgmtCommonRequest"}},{"name":"searchDateType","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":"searchOrdDtlStatCd","in":"query","description":"주문내역상태(OM005)","schema":{"type":"String"}},{"name":"searchDeliveryType","in":"query","description":"배송정보구분","schema":{"type":"String"}},{"name":"deliveryVal","in":"query","description":"배송정보입력값","schema":{"type":"String"}},{"name":"deliKindCd","in":"query","description":"배송종류코드(LO009)","schema":{"type":"String"}},{"name":"entrNo","in":"query","description":"협력사번호","schema":{"type":"String"}},{"name":"searchOrdManType","in":"query","description":"주문자정보구분","schema":{"type":"String"}},{"name":"ordManVal","in":"query","description":"주문자정보입력값","schema":{"type":"String"}},{"name":"deliProcTypCd","in":"query","description":"배송처리유형(PR008)","schema":{"type":"String"}},{"name":"hdcCd","in":"query","description":"택배사(LO005)","schema":{"type":"String"}},{"name":"shipWaitCaus","in":"query","description":"출고대기사유(LO007)","schema":{"type":"String"}}],"responses":{"200":{"description":"배송관리 목록 조회 성공","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RealGridListResponseDeliveryMgmtCommonResponse"}}}},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```