# 배송
## 운송장 트래킹 정보 수신(BO)
> \## 기능설명\
> \* 외부 배송추적시스템 운송장 정보를 수신 받습니다.\
> \---\
> \## 상세설명\
> \* 외부 배송추적 시스템 정보를 수신받고, 배송완료인 경우 주문내역상태를 배송완료로 변경합니다.\
> \* 스윗트래커(외부시스템)와 연동하는 컨트롤러입니다.\
> \* 스윗트래커와 연동하는 식별값은 배송번호입니다.\
> \* 요청/응답은 json 형식으로 처리합니다.
```json
{"openapi":"3.0.1","info":{"title":"X2BEE Order API","version":"v1"},"servers":[{"url":"https://api-order.x2bee.com/api/order/","description":"prd"}],"paths":{"/v1/delivery/tracker/trackerCallback":{"post":{"tags":["배송"],"summary":"운송장 트래킹 정보 수신(BO)","description":"## 기능설명\n* 외부 배송추적시스템 운송장 정보를 수신 받습니다.\n---\n## 상세설명\n* 외부 배송추적 시스템 정보를 수신받고, 배송완료인 경우 주문내역상태를 배송완료로 변경합니다.\n* 스윗트래커(외부시스템)와 연동하는 컨트롤러입니다.\n* 스윗트래커와 연동하는 식별값은 배송번호입니다.\n* 요청/응답은 json 형식으로 처리합니다.\n","operationId":"trackerCallback","parameters":[{"name":"Authorization","in":"header","description":"Access Token","required":false}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"description":"성공","content":{"*/*":{"schema":{"type":"string"}}}},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"components":{"schemas":{"Response":{"type":"object","properties":{"timestamp":{"type":"string","description":"result time","format":"date-time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"type":"object","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"}},"description":"validation error list"}}}}
```
## 배송지역그룹번호 조회
> \## 기능 설명\
> \* 배송지의 도서산간 여부를 조회합니다.\
> \---\
> \## 상세 설명\
> \* 배송지의 우편번호를 사용하여 배송지역그룹번호를 조회합니다.\
> \* 추가배송비가 있는 경우, 배송지역그룹번호를 리턴합니다.\
> \---\
> \## 수정번호\
> \* \`\`\`Release v2.00\_240711\`\`\`: 배송 지역그룹 별 추가 배송비 적용
````json
{"openapi":"3.0.1","info":{"title":"X2BEE Order API","version":"v1"},"servers":[{"url":"https://api-order.x2bee.com/api/order/","description":"prd"}],"paths":{"/v1/delivery/deliveryRegion/getDeliRegnGrpNo":{"post":{"tags":["배송"],"summary":"배송지역그룹번호 조회","description":"## 기능 설명\n* 배송지의 도서산간 여부를 조회합니다.\n---\n## 상세 설명\n* 배송지의 우편번호를 사용하여 배송지역그룹번호를 조회합니다.\n* 추가배송비가 있는 경우, 배송지역그룹번호를 리턴합니다.\n---\n## 수정번호\n* ```Release v2.00_240711```: 배송 지역그룹 별 추가 배송비 적용\n","operationId":"getDeliRegnGrpNo","parameters":[{"name":"Authorization","in":"header","description":"Access Token","required":false}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeliveryRegionCheckRequest"}}},"required":true},"responses":{"200":{"description":"성공","content":{"*/*":{"schema":{"type":"string"}}}},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"components":{"schemas":{"DeliveryRegionCheckRequest":{"type":"object","properties":{"zipNo":{"type":"string","description":"우편번호"},"deliPolcNo":{"type":"string","description":"배송정책번호"}},"description":"도서 산간 여부 조회 Request DTO"},"Response":{"type":"object","properties":{"timestamp":{"type":"string","description":"result time","format":"date-time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"type":"object","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"}},"description":"validation error list"}}}}
````
## 배송지 변경 가능 여부 조회
> \## 기능 설명\
> \* 배송지 변경 가능 여부를 조회합니다.\
> \---\
> \## 상세 설명\
> \* 우편번호와 배송정책번호를 사용하여 추가배송비를 조회합니다.\
> \* 추가배송비 금액이 동일한 배송지역그룹으로 배송지 변경이 가능합니다.\
> \---\
> \## 수정번호\
> \* \`\`\`Release v2.00\_240711\`\`\`: 추가배송비 금액이 동일한 배송지역그룹으로 배송지 변경 가능하도록 수정
````json
{"openapi":"3.0.1","info":{"title":"X2BEE Order API","version":"v1"},"servers":[{"url":"https://api-order.x2bee.com/api/order/","description":"prd"}],"paths":{"/v1/delivery/deliveryRegion/deliveryRegionCheck":{"post":{"tags":["배송"],"summary":"배송지 변경 가능 여부 조회","description":"## 기능 설명\n* 배송지 변경 가능 여부를 조회합니다.\n---\n## 상세 설명\n* 우편번호와 배송정책번호를 사용하여 추가배송비를 조회합니다.\n* 추가배송비 금액이 동일한 배송지역그룹으로 배송지 변경이 가능합니다.\n---\n## 수정번호\n* ```Release v2.00_240711```: 추가배송비 금액이 동일한 배송지역그룹으로 배송지 변경 가능하도록 수정\n","operationId":"deliveryRegionCheck","parameters":[{"name":"Authorization","in":"header","description":"Access Token","required":false}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeliveryInfoChangeRequest"}}},"required":true},"responses":{"200":{"description":"성공","content":{"*/*":{"schema":{"type":"boolean"}}}},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"components":{"schemas":{"DeliveryInfoChangeRequest":{"required":["deliNo","deliPolcNo","dlvpNm","ordNo","rcvmnCellEndNo","rcvmnCellSctNo","rcvmnCellTxnoNo","rcvmnNm","zipAddr","zipNo"],"type":"object","properties":{"ordNo":{"type":"string","description":"주문번호"},"clmNo":{"type":"string","description":"클레임번호"},"systemType":{"type":"string","description":" SYSTEM(시스템유형)\n * 10 : FO\n * 20 : BO\n","enum":["FO","BO"]},"mbrNo":{"type":"string","description":"회원번호"},"deliNo":{"type":"string","description":"배송번호"},"deliPolcNo":{"type":"string","description":"배송정책번호"},"dlvpNm":{"type":"string","description":"배송지명"},"rcvmnNm":{"type":"string","description":"수취인명"},"zipNoSeq":{"type":"integer","description":"우편번호순번","format":"int32"},"zipNo":{"type":"string","description":"변경후우편번호"},"originZipNo":{"type":"string","description":"변경전우편번호"},"orginDlvpSeq":{"type":"string","description":"변경전배송지순번"},"zipAddr":{"type":"string","description":"우편주소"},"dtlAddr":{"type":"string","description":"상세주소"},"rcvmnCellSctNo":{"type":"string","description":"수취인휴대폰구분번호"},"rcvmnCellTxnoNo":{"type":"string","description":"수취인휴대폰국번번호"},"rcvmnCellEndNo":{"type":"string","description":"수취인휴대폰끝번호"},"deliMsg":{"type":"string","description":"배송메시지"},"deliMsgCd":{"type":"string","description":"배송메시지코드(ME039) 10:배송메시지 입력 안함, 20:배송 전 연락 바랍니다, 30:부재 시 문 앞에 놓아주세요, 40: 부재 시 경비실에 맡겨주세요, 50: 빠른 배송 부탁 드립니다, 60: 부재 시 핸드폰으로 연락 바랍니다, 70: 직접입력"},"comnFrdrEtcMethod":{"type":"string","description":"공동현관기타방법"},"comnFrdrPwd":{"type":"string","description":"공동현관비밀번호"},"comnFrdrCogoMethodCd":{"type":"string","description":"공동현관출입방법코드(ME040) 10: 공동현관 출입번호, 20: 자유 출입 가능, 30: 기타"},"deliGbCd":{"type":"string","description":" LO001(배송구분코드)\n * 10 : 출하\n * 20 : 회수\n","enum":["SHIPPING","WITHDRAWAL"]},"dlvpSeq":{"type":"string","description":"배송순번"},"rcvmnEmailAddr":{"type":"string","description":"수취인이메일"},"rcvmnTelRgnNo":{"type":"string","description":"수취인전화지역번호"},"rcvmnTelTxnoNo":{"type":"string","description":"수취인전화국번번호"},"rcvmnTelEndNo":{"type":"string","description":"수취인전화끝번호"},"frgnDirPurGoodsYn":{"type":"string","description":"해외직구상품여부"}},"description":"주문 배송지 변경/등록 DTO"},"Response":{"type":"object","properties":{"timestamp":{"type":"string","description":"result time","format":"date-time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"type":"object","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"}},"description":"validation error list"}}}}
````
## 결품처리(BO)
> \## 기능설명\
> \* \[BO] 결품처리를 진행합니다.\
> \---\
> \## 상세설명\
> \* 원주문내역상태코드(ordDtlStatCd:OM005), 처리주문내역상태코드(targetOrdDtlStatCd:OM005), 결품처리 요청목록(insuffDeliveryProcessInfoList)은 필수로 있어야합니다.\
> \* 원주문내역상태코드(OM005) -> 처리주문내역상태코드(OM005)\
> \* 결품등록 : 22(출고지시) -> 23(출고대기)\
> \* 결품해제 : 23(출고대기) -> 22(출고지시)\
> \* 결품등록, 결품해제 처리를 진행합니다.\
> \* 원주문내역상태코드와 처리할 주문내역상태코드를 요청값으로 받아서 원주문내역상태코드리스트를 조회하여 검증 후 처리할 주문내역상태코드로 업데이트를 진행합니다.\
> \* 결품등록 후 주문자에게 배송지연 알림(알림톡, 알림함)이 발송됩니다.\
> \* 결품등록 후 고객센터 OB목록에 자동으로 등록됩니다.\
> \---\
> \## 수정번호\
> \* Release v1.01\_251030: 결품등록 및 결품해제 시 요청된 목록 중 상태변경 validation 체크추가
```json
{"openapi":"3.0.1","info":{"title":"X2BEE Order API","version":"v1"},"servers":[{"url":"https://api-order.x2bee.com/api/order/","description":"prd"}],"paths":{"/v1/delivery/deliveryProcess/processInsuffDelivery":{"post":{"tags":["배송"],"summary":"결품처리(BO)","description":"## 기능설명\n* [BO] 결품처리를 진행합니다.\n---\n## 상세설명\n* 원주문내역상태코드(ordDtlStatCd:OM005), 처리주문내역상태코드(targetOrdDtlStatCd:OM005), 결품처리 요청목록(insuffDeliveryProcessInfoList)은 필수로 있어야합니다.\n* 원주문내역상태코드(OM005) -> 처리주문내역상태코드(OM005)\n * 결품등록 : 22(출고지시) -> 23(출고대기)\n * 결품해제 : 23(출고대기) -> 22(출고지시)\n* 결품등록, 결품해제 처리를 진행합니다.\n* 원주문내역상태코드와 처리할 주문내역상태코드를 요청값으로 받아서 원주문내역상태코드리스트를 조회하여 검증 후 처리할 주문내역상태코드로 업데이트를 진행합니다.\n* 결품등록 후 주문자에게 배송지연 알림(알림톡, 알림함)이 발송됩니다.\n* 결품등록 후 고객센터 OB목록에 자동으로 등록됩니다.\n---\n## 수정번호\n* Release v1.01_251030: 결품등록 및 결품해제 시 요청된 목록 중 상태변경 validation 체크추가\n","operationId":"processInsuffDelivery","parameters":[{"name":"Authorization","in":"header","description":"Access Token","required":false}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InsuffDeliveryProcessRequest"}}},"required":true},"responses":{"200":{"description":"성공"},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"components":{"schemas":{"InsuffDeliveryProcessRequest":{"required":["insuffDeliveryProcessInfoList","ordDtlStatCd","targetOrdDtlStatCd"],"type":"object","properties":{"ordDtlStatCd":{"type":"string","description":"OM005(주문내역상태코드)\n 10: REPAY_REQ(재결제요청)\n,11: ORDER_ACCEPT(주문접수)\n,12: ORDER_COMPLETE(주문완료)\n,13: ORDER_CANCEL(주문취소)\n,21: DELIVERY_ORDER(배송지시)\n,22: SHIPPING_ORDER(출고지시)\n,23: SHIPPING_WAIT(출고대기)\n,25: SHIPPING_CONFIRM(출고확정)\n,26: SHIPPING_FINISH(출고완료)\n,27: DELIVERY_FINISH(배송완료)\n,31: RETURN_APPLY(결제대기)\n,32: RETURN_ACCEPT(반품접수)\n,33: RETURN_CANCEL(반품취소)\n,34: WITHDRAWAL_ORDER(회수지시)\n,35: WITHDRAWAL_CONFIRM(회수확인)\n,36: WITHDRAWAL_FINISH(회수완료)\n,37: RETURN_FINISH(반품완료)\n","enum":["REPAY_REQ","ORDER_ACCEPT","ORDER_COMPLETE","ORDER_CANCEL","DELIVERY_ORDER","SHIPPING_ORDER","SHIPPING_WAIT","SHIPPING_CONFIRM","SHIPPING_FINISH","DELIVERY_FINISH","PARTIAL_SHIPPING","RETURN_APPLY","RETURN_ACCEPT","RETURN_CANCEL","WITHDRAWAL_ORDER","WITHDRAWAL_CONFIRM","WITHDRAWAL_FINISH","RETURN_FINISH"]},"targetOrdDtlStatCd":{"type":"string","description":"OM005(주문내역상태코드)\n 10: REPAY_REQ(재결제요청)\n,11: ORDER_ACCEPT(주문접수)\n,12: ORDER_COMPLETE(주문완료)\n,13: ORDER_CANCEL(주문취소)\n,21: DELIVERY_ORDER(배송지시)\n,22: SHIPPING_ORDER(출고지시)\n,23: SHIPPING_WAIT(출고대기)\n,25: SHIPPING_CONFIRM(출고확정)\n,26: SHIPPING_FINISH(출고완료)\n,27: DELIVERY_FINISH(배송완료)\n,31: RETURN_APPLY(결제대기)\n,32: RETURN_ACCEPT(반품접수)\n,33: RETURN_CANCEL(반품취소)\n,34: WITHDRAWAL_ORDER(회수지시)\n,35: WITHDRAWAL_CONFIRM(회수확인)\n,36: WITHDRAWAL_FINISH(회수완료)\n,37: RETURN_FINISH(반품완료)\n","enum":["REPAY_REQ","ORDER_ACCEPT","ORDER_COMPLETE","ORDER_CANCEL","DELIVERY_ORDER","SHIPPING_ORDER","SHIPPING_WAIT","SHIPPING_CONFIRM","SHIPPING_FINISH","DELIVERY_FINISH","PARTIAL_SHIPPING","RETURN_APPLY","RETURN_ACCEPT","RETURN_CANCEL","WITHDRAWAL_ORDER","WITHDRAWAL_CONFIRM","WITHDRAWAL_FINISH","RETURN_FINISH"]},"insuffDeliveryProcessInfoList":{"type":"array","description":"결품처리 요청목록","items":{"$ref":"#/components/schemas/InsuffDeliveryProcessInfo"}}},"description":"결품처리 요청정보"},"InsuffDeliveryProcessInfo":{"required":["deliNo","ordNo","ordProcSeq","ordSeq","shipWaitCaus"],"type":"object","properties":{"ordNo":{"type":"string","description":"주문번호"},"deliNo":{"type":"string","description":"배송번호"},"ordSeq":{"type":"integer","description":"주문순번","format":"int32"},"ordProcSeq":{"type":"integer","description":"주문처리순번","format":"int32"},"shipWaitCaus":{"type":"string","description":"결품사유(LO007)"},"shipWaitCausCont":{"type":"string","description":"결품상세사유"},"insuffQty":{"type":"integer","description":"결품수량","format":"int32"}},"description":"결품처리정보"},"Response":{"type":"object","properties":{"timestamp":{"type":"string","description":"result time","format":"date-time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"type":"object","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"}},"description":"validation error list"}}}}
```
## 배송처리(BO)
> \## 기능설명\
> \* \[BO] 배송처리를 진행합니다.\
> \---\
> \## 상세설명\
> \* 원주문내역상태코드(ordDtlStatCd:OM005), 처리주문내역상태코드(targetOrdDtlStatCd:OM005), 배송처리 목록(deliveryProcessInfoList)은 필수로 있어야합니다.\
> \* 원주문내역상태코드(OM005) -> 처리주문내역상태코드(OM005)\
> \* 배송지시 : 12(주문완료) -> 21(배송지시)\
> \* 출고지시 : 21(배송지시) -> 22(출고지시)\
> \* 출고완료 : 22(출고지시) -> 26(출고완료)\
> \* 배송완료 : 26(출고완료) -> 27(배송완료)\
> \* 배송지시, 출고지시, 출고완료, 배송완료를 진행합니다.\
> \* 원주문내역상태코드와 처리할 주문내역상태코드를 요청값으로 받아서 원주문내역상태코드리스트를 조회하여 검증 후 처리할 주문내역상태코드로 업데이트를 진행합니다.\
> \* 출고완료 후 주문자에게 알림(알림톡, 알림함)이 발송됩니다.\
> \* 교환주문 출고완료시 이메일 알림이 발송됩니다.
```json
{"openapi":"3.0.1","info":{"title":"X2BEE Order API","version":"v1"},"servers":[{"url":"https://api-order.x2bee.com/api/order/","description":"prd"}],"paths":{"/v1/delivery/deliveryProcess/processDelivery":{"post":{"tags":["배송"],"summary":"배송처리(BO)","description":"## 기능설명\n* [BO] 배송처리를 진행합니다.\n---\n## 상세설명\n* 원주문내역상태코드(ordDtlStatCd:OM005), 처리주문내역상태코드(targetOrdDtlStatCd:OM005), 배송처리 목록(deliveryProcessInfoList)은 필수로 있어야합니다.\n* 원주문내역상태코드(OM005) -> 처리주문내역상태코드(OM005)\n * 배송지시 : 12(주문완료) -> 21(배송지시)\n * 출고지시 : 21(배송지시) -> 22(출고지시)\n * 출고완료 : 22(출고지시) -> 26(출고완료)\n * 배송완료 : 26(출고완료) -> 27(배송완료)\n* 배송지시, 출고지시, 출고완료, 배송완료를 진행합니다.\n* 원주문내역상태코드와 처리할 주문내역상태코드를 요청값으로 받아서 원주문내역상태코드리스트를 조회하여 검증 후 처리할 주문내역상태코드로 업데이트를 진행합니다.\n* 출고완료 후 주문자에게 알림(알림톡, 알림함)이 발송됩니다.\n* 교환주문 출고완료시 이메일 알림이 발송됩니다.\n","operationId":"processDelivery","parameters":[{"name":"Authorization","in":"header","description":"Access Token","required":false}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeliveryProcessRequest"}}},"required":true},"responses":{"200":{"description":"성공"},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"components":{"schemas":{"DeliveryProcessRequest":{"required":["deliveryProcessInfoList","ordDtlStatCd","targetOrdDtlStatCd"],"type":"object","properties":{"ordDtlStatCd":{"type":"string","description":"OM005(주문내역상태코드)\n 10: REPAY_REQ(재결제요청)\n,11: ORDER_ACCEPT(주문접수)\n,12: ORDER_COMPLETE(주문완료)\n,13: ORDER_CANCEL(주문취소)\n,21: DELIVERY_ORDER(배송지시)\n,22: SHIPPING_ORDER(출고지시)\n,23: SHIPPING_WAIT(출고대기)\n,25: SHIPPING_CONFIRM(출고확정)\n,26: SHIPPING_FINISH(출고완료)\n,27: DELIVERY_FINISH(배송완료)\n,31: RETURN_APPLY(결제대기)\n,32: RETURN_ACCEPT(반품접수)\n,33: RETURN_CANCEL(반품취소)\n,34: WITHDRAWAL_ORDER(회수지시)\n,35: WITHDRAWAL_CONFIRM(회수확인)\n,36: WITHDRAWAL_FINISH(회수완료)\n,37: RETURN_FINISH(반품완료)\n","enum":["REPAY_REQ","ORDER_ACCEPT","ORDER_COMPLETE","ORDER_CANCEL","DELIVERY_ORDER","SHIPPING_ORDER","SHIPPING_WAIT","SHIPPING_CONFIRM","SHIPPING_FINISH","DELIVERY_FINISH","PARTIAL_SHIPPING","RETURN_APPLY","RETURN_ACCEPT","RETURN_CANCEL","WITHDRAWAL_ORDER","WITHDRAWAL_CONFIRM","WITHDRAWAL_FINISH","RETURN_FINISH"]},"targetOrdDtlStatCd":{"type":"string","description":"OM005(주문내역상태코드)\n 10: REPAY_REQ(재결제요청)\n,11: ORDER_ACCEPT(주문접수)\n,12: ORDER_COMPLETE(주문완료)\n,13: ORDER_CANCEL(주문취소)\n,21: DELIVERY_ORDER(배송지시)\n,22: SHIPPING_ORDER(출고지시)\n,23: SHIPPING_WAIT(출고대기)\n,25: SHIPPING_CONFIRM(출고확정)\n,26: SHIPPING_FINISH(출고완료)\n,27: DELIVERY_FINISH(배송완료)\n,31: RETURN_APPLY(결제대기)\n,32: RETURN_ACCEPT(반품접수)\n,33: RETURN_CANCEL(반품취소)\n,34: WITHDRAWAL_ORDER(회수지시)\n,35: WITHDRAWAL_CONFIRM(회수확인)\n,36: WITHDRAWAL_FINISH(회수완료)\n,37: RETURN_FINISH(반품완료)\n","enum":["REPAY_REQ","ORDER_ACCEPT","ORDER_COMPLETE","ORDER_CANCEL","DELIVERY_ORDER","SHIPPING_ORDER","SHIPPING_WAIT","SHIPPING_CONFIRM","SHIPPING_FINISH","DELIVERY_FINISH","PARTIAL_SHIPPING","RETURN_APPLY","RETURN_ACCEPT","RETURN_CANCEL","WITHDRAWAL_ORDER","WITHDRAWAL_CONFIRM","WITHDRAWAL_FINISH","RETURN_FINISH"]},"deliDtlStatCd":{"type":"string","description":"LO016(배송내역상태코드)\n 10: DELIVERY_ORDER (배송지시)\n 11: SHIPPING_ORDER (출고지시)\n 12: SHIPPING_WAIT (출고대기)\n 13: SHIPPING_CONFIRM (출고확정)\n 14: SHIPPING_FINISH (출고완료)\n 15: DELIVERY_FINISH (배송완료)\n 20: WITHDRAWAL_ORDER (회수지시)\n 21: WITHDRAWAL_CONFIRM (회수확인)\n 22: WITHDRAWAL_FINISH (회수완료)\n","enum":["DELIVERY_ORDER","SHIPPING_ORDER","SHIPPING_WAIT","SHIPPING_CONFIRM","SHIPPING_FINISH","DELIVERY_FINISH","WITHDRAWAL_ORDER","WITHDRAWAL_CONFIRM","WITHDRAWAL_FINISH"]},"targetDeliDtlStatCd":{"type":"string","description":"LO016(배송내역상태코드)\n 10: DELIVERY_ORDER (배송지시)\n 11: SHIPPING_ORDER (출고지시)\n 12: SHIPPING_WAIT (출고대기)\n 13: SHIPPING_CONFIRM (출고확정)\n 14: SHIPPING_FINISH (출고완료)\n 15: DELIVERY_FINISH (배송완료)\n 20: WITHDRAWAL_ORDER (회수지시)\n 21: WITHDRAWAL_CONFIRM (회수확인)\n 22: WITHDRAWAL_FINISH (회수완료)\n","enum":["DELIVERY_ORDER","SHIPPING_ORDER","SHIPPING_WAIT","SHIPPING_CONFIRM","SHIPPING_FINISH","DELIVERY_FINISH","WITHDRAWAL_ORDER","WITHDRAWAL_CONFIRM","WITHDRAWAL_FINISH"]},"deliveryProcessInfoList":{"type":"array","description":"배송처리 목록","items":{"$ref":"#/components/schemas/DeliveryProcessInfo"}}},"description":"배송처리 요청 DTO"},"DeliveryProcessInfo":{"required":["deliNo"],"type":"object","properties":{"ordNo":{"type":"string","description":"주문번호"},"ordSeq":{"type":"integer","description":"주문순번","format":"int32"},"shipQty":{"type":"integer","description":"출고수량","format":"int32"},"deliSeq":{"type":"integer","description":"배송순번","format":"int32"},"deliNo":{"type":"string","description":"배송번호"},"hdcCd":{"type":"string","description":"LO005(주문내역상태코드)\n 10: CJ(CJ대한통운)\n,11: EPOST(우체국택배)\n,12: GOODSTOLUCK(굿투럭)\n,13: DHL(DHL택배)\n,14: LOGEN(로젠택배)\n,30: VROONG(부릉)\n,31: GOGOVAN(고고밴)\n","enum":["CJ","EPOST","GOODSTOLUCK","DHL","LOGEN","VROONG","GOGOVAN"]},"invNo":{"type":"string","description":"송장번호"},"alimYn":{"type":"string","description":"알림메시지여부"}},"description":"배송처리정보"},"Response":{"type":"object","properties":{"timestamp":{"type":"string","description":"result time","format":"date-time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"type":"object","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"}},"description":"validation error list"}}}}
```
## 수령완료처리(FO)
> \## 기능설명\
> \* \[FO] 주문 배송 완료 처리합니다.\
> \---\
> \## 상세설명\
> \* 단건의 주문을 배송완료 처리합니다.\
> \* 원주문의 주문내역상태코드와 변경할 상태코드(배송완료 : 27)를 넘겨, 배송완료 상태로 업데이트합니다.
```json
{"openapi":"3.0.1","info":{"title":"X2BEE Order API","version":"v1"},"servers":[{"url":"https://api-order.x2bee.com/api/order/","description":"prd"}],"paths":{"/v1/delivery/deliveryProcess/processDeliveryFO":{"post":{"tags":["배송"],"summary":"수령완료처리(FO)","description":" ## 기능설명\n * [FO] 주문 배송 완료 처리합니다.\n ---\n ## 상세설명\n * 단건의 주문을 배송완료 처리합니다.\n * 원주문의 주문내역상태코드와 변경할 상태코드(배송완료 : 27)를 넘겨, 배송완료 상태로 업데이트합니다.\n","operationId":"processDeliveryFO","parameters":[{"name":"Authorization","in":"header","description":"Access Token","required":false}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeliveryProcessFORequest"}}},"required":true},"responses":{"200":{"description":"성공"},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"components":{"schemas":{"DeliveryProcessFORequest":{"required":["deliveryProcessInfoList","ordDtlStatCd","targetDeliDtlStatCd","targetOrdDtlStatCd"],"type":"object","properties":{"ordDtlStatCd":{"type":"string","description":"원주문내역상태코드"},"targetOrdDtlStatCd":{"type":"string","description":"변경상태"},"targetDeliDtlStatCd":{"type":"string","description":"LO016(배송내역상태코드)\n 10: DELIVERY_ORDER (배송지시)\n 11: SHIPPING_ORDER (출고지시)\n 12: SHIPPING_WAIT (출고대기)\n 13: SHIPPING_CONFIRM (출고확정)\n 14: SHIPPING_FINISH (출고완료)\n 15: DELIVERY_FINISH (배송완료)\n 20: WITHDRAWAL_ORDER (회수지시)\n 21: WITHDRAWAL_CONFIRM (회수확인)\n 22: WITHDRAWAL_FINISH (회수완료)\n","enum":["DELIVERY_ORDER","SHIPPING_ORDER","SHIPPING_WAIT","SHIPPING_CONFIRM","SHIPPING_FINISH","DELIVERY_FINISH","WITHDRAWAL_ORDER","WITHDRAWAL_CONFIRM","WITHDRAWAL_FINISH"]},"systemType":{"type":"string","description":"시스템구분코드"},"ordNo":{"type":"string","description":"주문번호"},"deliveryProcessInfoList":{"type":"array","description":"배송처리대상정보","items":{"$ref":"#/components/schemas/DeliveryProcessInfo"}}},"description":"FO 수령완료 처리 요청 DTO"},"DeliveryProcessInfo":{"required":["deliNo"],"type":"object","properties":{"ordNo":{"type":"string","description":"주문번호"},"ordSeq":{"type":"integer","description":"주문순번","format":"int32"},"shipQty":{"type":"integer","description":"출고수량","format":"int32"},"deliSeq":{"type":"integer","description":"배송순번","format":"int32"},"deliNo":{"type":"string","description":"배송번호"},"hdcCd":{"type":"string","description":"LO005(주문내역상태코드)\n 10: CJ(CJ대한통운)\n,11: EPOST(우체국택배)\n,12: GOODSTOLUCK(굿투럭)\n,13: DHL(DHL택배)\n,14: LOGEN(로젠택배)\n,30: VROONG(부릉)\n,31: GOGOVAN(고고밴)\n","enum":["CJ","EPOST","GOODSTOLUCK","DHL","LOGEN","VROONG","GOGOVAN"]},"invNo":{"type":"string","description":"송장번호"},"alimYn":{"type":"string","description":"알림메시지여부"}},"description":"배송처리정보"},"Response":{"type":"object","properties":{"timestamp":{"type":"string","description":"result time","format":"date-time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"type":"object","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"}},"description":"validation error list"}}}}
```
## 배송완료 지시 배치(BATCH)
> \## 기능설명\
> \* 배송완료 지시 대량 데이터 일괄 처리를 진행합니다.\
> \---\
> \## 상세설명\
> \* 배치서비스에서 요청받은 출고완료 주문을 배송완료 처리합니다.\
> \* 주문내역상태(OM005)가 출고완료(26)인 주문을 배송완료(27) 처리합니다.\
> \* 출고완료 후 특정 기일(ST004:자동배송완료처리 REF\_1\_VAL 값)이 경과한 주문에 대해 처리합니다.\
> \* 주문번호, 배송번호, 배송완료 대상 목록은 필수 값입니다.\
> \* 목록은 1000건씩 분할해서 처리합니다.
```json
{"openapi":"3.0.1","info":{"title":"X2BEE Order API","version":"v1"},"servers":[{"url":"https://api-order.x2bee.com/api/order/","description":"prd"}],"paths":{"/v1/delivery/batchProcess/deliveryFinishInstructionProcess":{"post":{"tags":["배송"],"summary":"배송완료 지시 배치(BATCH)","description":"## 기능설명\n* 배송완료 지시 대량 데이터 일괄 처리를 진행합니다.\n---\n## 상세설명\n* 배치서비스에서 요청받은 출고완료 주문을 배송완료 처리합니다.\n* 주문내역상태(OM005)가 출고완료(26)인 주문을 배송완료(27) 처리합니다.\n* 출고완료 후 특정 기일(ST004:자동배송완료처리 REF_1_VAL 값)이 경과한 주문에 대해 처리합니다.\n* 주문번호, 배송번호, 배송완료 대상 목록은 필수 값입니다.\n* 목록은 1000건씩 분할해서 처리합니다.\n","operationId":"deliveryFinishInstructionProcess","parameters":[{"name":"Authorization","in":"header","description":"Access Token","required":false}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DeliveryFinishInstructionInfo"}}}},"required":true},"responses":{"200":{"description":"성공"},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"components":{"schemas":{"DeliveryFinishInstructionInfo":{"type":"object","properties":{"ordNo":{"type":"string"},"ordSeq":{"type":"integer","format":"int32"},"ordProcSeq":{"type":"integer","format":"int32"},"deliNo":{"type":"string"},"deliSeq":{"type":"integer","format":"int32"},"invNo":{"type":"string"},"ordDtlStatCd":{"type":"string"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","description":"result time","format":"date-time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"type":"object","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"}},"description":"validation error list"}}}}
```
## 단건 배송 트래킹
> \## 기능설명\
> \* 배송 상태를 조회합니다.\
> \---\
> \## 상세설명\
> \* 배송번호(단건)를 이용해 현재 배송상태를 조회합니다.\
> \* 스윗트래커(외부시스템)와 연동하여 조회합니다.\
> \* 응답값으로 완료여부, 택배사명, 운송장번호, 배송상세정보(배송진행시간, 진행위치, 진행상태)를 전달합니다.\
> \* 스윗트래커와 연동하는 식별값은 배송번호입니다.\
> \## 수정번호\
> \* Release v2.00\_240401: 이벤트 배송상품 스위트래커 조회 개발\
> \* Release v2.00\_250618: fid 사용하여 hdc 조회하는 로직 변경 (분리출고 DB 변경 대응)
```json
{"openapi":"3.0.1","info":{"title":"X2BEE Order API","version":"v1"},"servers":[{"url":"https://api-order.x2bee.com/api/order/","description":"prd"}],"paths":{"/v1/delivery/tracker/deliveryTracking/{fid}":{"get":{"tags":["배송"],"summary":"단건 배송 트래킹","description":"## 기능설명\n* 배송 상태를 조회합니다.\n---\n## 상세설명\n* 배송번호(단건)를 이용해 현재 배송상태를 조회합니다.\n* 스윗트래커(외부시스템)와 연동하여 조회합니다.\n* 응답값으로 완료여부, 택배사명, 운송장번호, 배송상세정보(배송진행시간, 진행위치, 진행상태)를 전달합니다.\n* 스윗트래커와 연동하는 식별값은 배송번호입니다.\n## 수정번호\n* Release v2.00_240401: 이벤트 배송상품 스위트래커 조회 개발\n* Release v2.00_250618: fid 사용하여 hdc 조회하는 로직 변경 (분리출고 DB 변경 대응)\n","operationId":"deliveryTracking","parameters":[{"name":"fid","in":"query","description":"배송번호","required":true,"schema":{"type":"string","description":"string"}},{"name":"Authorization","in":"header","description":"Access Token","required":false}],"responses":{"200":{"description":"성공","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TrackerTrackingInfoResponse"}}}},"900":{"description":"업무처리 오류 내용","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"components":{"schemas":{"TrackerTrackingInfoResponse":{"type":"object","properties":{"completeYn":{"type":"string","description":"배송완료여부"},"hdcNm":{"type":"string","description":"택배사명"},"invoiceNo":{"type":"string","description":"송장번호"},"detailsList":{"type":"array","description":"배송조회상세정보","items":{"$ref":"#/components/schemas/TrackerTrackingDetailsResponse"}}},"description":"배송 조회 응답 DTO"},"TrackerTrackingDetailsResponse":{"type":"object","properties":{"time":{"type":"string","description":"진행시간"},"where":{"type":"string","description":"진행위치 (지점)"},"kind":{"type":"string","description":"진행상태"}},"description":"배송 조회 응답 상세 DTO"},"Response":{"type":"object","properties":{"timestamp":{"type":"string","description":"result time","format":"date-time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"type":"object","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"}},"description":"validation error list"}}}}
```
---
# Agent Instructions: 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/store-front-api/order-api/undefined-19.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.