# 배송관리

주문 처리에 필요한 다양한 기능을 제공하여 효율적인 상품 배송 및 관리를 지원합니다. 이를 통해 회수처리, 배송관리, 출고완료, 배송조회 등 다양한 배송 관련 작업을 간편하게 수행할 수 있습니다.

***

## 주요 기능

* **회수처리**
  * **회수 상태 업데이트:** 회수 대상에 대해 상태를 업데이트합니다.
  * **회수 지시 처리:** 반품 및 교환 접수에 대한 회수지시를 처리합니다.
  * **반품/교환 처리:** 회수 확인 대상에 대해 반품전환 또는 반품불가를 처리합니다.
  * **회수 데이터 조회:** 회수대상 목록 및 상세 정보를 조회합니다.
* **배송관리**
  * **상태 처리:** 결품 및 배송 처리에 대한 상태를 변경합니다.
  * **처리 목록 조회:** 결품 및 배송처리대상 목록을 조회합니다.
* **출고완료**
  * **일괄 등록 조회:** 일괄 출고완료 처리에 필요한 정보를 조회합니다.
* **배송조회**
  * **상품내역 조회:** 배송상세팝업에서 주문상품내역 목록을 조회합니다.
  * **배송목록 조회:** 배송 처리를 위한 목록을 조회합니다.
  * **상세정보 조회:** 배송상세팝업에서 주문자 및 배송 정보를 조회합니다.

***

## 프로세스 정의 — 회수처리

<figure><img src="/files/YYgkRbUZibsePuviUyzJ" alt=""><figcaption></figcaption></figure>

{% stepper %}
{% step %}

### 회수대상 목록 조회

관리자는 회수대상(회수지시처리, 회수확인처리, 회수완료처리) 목록을 조회합니다.\
BO API의 “회수 조회”를 이용해서 목록을 조회합니다.
{% endstep %}

{% step %}

### 회수 상태 업데이트

관리자는 회수대상(회수확인처리, 회수완료처리) 목록을 조회 후 회수상태 값을 업데이트 합니다.

* 회수지시건은 회수확인으로 변경
* 회수확인건은 회수완료로 변경

BO API의 “회수 상태 업데이트”, ORDER API의 “회수 진행상태 수정”을 이용해서 회수 진행상태를 업데이트 합니다.
{% endstep %}

{% step %}

### 회수지시 처리

관리자는 접수 대상(반품접수, 교환접수) 목록을 조회 후 회수상태 값을 업데이트 합니다.

* 접수 대상건에 대해 회수지시로 상태를 변경

BO API의 “회수지시처리”, ORDER API의 “회수지시”를 이용해서 회수지시 처리를 진행합니다.
{% endstep %}

{% step %}

### 교환 중 반품 처리

관리자는 회수확인 상태의 목록을 조회 후 교환 중 반품처리를 합니다.\
BO API의 “교환중반품처리”, ORDER API의 “교환중반품”을 이용해서 처리를 진행합니다.
{% endstep %}

{% step %}

### 반품불가 처리

관리자는 회수확인 상태의 목록을 조회 후 반품불가 처리를 합니다.\
BO API의 “반품불가처리”, ORDER API의 “교환중반품”을 이용해서 처리를 진행합니다.
{% endstep %}

{% step %}

### 회수상세팝업 정보 조회

관리자는 회수배송번호를 이용해 회수상세팝업에 필요한 정보를 조회합니다.\
BO API의 “회수상세팝업조회” 를 이용해서 조회합니다.
{% endstep %}
{% endstepper %}

***

## API 기능 목록 — 회수 관리

<table><thead><tr><th width="97.8887939453125">API</th><th width="348.666748046875">설명</th><th width="98">Server</th><th width="90.22216796875">메소드</th><th>비고</th></tr></thead><tbody><tr><td>회수 상태 업데이트</td><td>요청 받은 현재 주문내역 상태, 업데이트 예정 주문내역상태를 이용해 대상목록 회수상태를 업데이트 합니다.</td><td>API-BO</td><td>POST</td><td><p><a href="http://apibo.x2bee.com/content?bo=delivery&#x26;depth=%ED%9A%8C%EC%88%98%EC%B2%98%EB%A6%AC&#x26;path=saveWithdrawStatUpdateProcess">🔗API 확인하기 ></a></p><p>주문 api 호출</p></td></tr><tr><td>회수 지시 처리</td><td>주문내역상태가 반품접수 상태인 주문 목록을 회수지시 상태로 업데이트 합니다.</td><td>API-BO</td><td>POST</td><td><p><a href="http://apibo.x2bee.com/content?bo=delivery&#x26;depth=%ED%9A%8C%EC%88%98%EC%B2%98%EB%A6%AC&#x26;path=saveWithdrawInstructHandlingList">🔗API 확인하기 ></a></p><p>주문 api 호출</p></td></tr><tr><td>교환 중 반품 처리</td><td>회수 처리 진행중인 건에 대해 반품전환 처리를 진행합니다.</td><td>API-BO</td><td>POST</td><td><p><a href="http://apibo.x2bee.com/content?bo=delivery&#x26;depth=%ED%9A%8C%EC%88%98%EC%B2%98%EB%A6%AC&#x26;path=returnTrnsformProcess">🔗API 확인하기 ></a></p><p>주문 api 호출</p></td></tr><tr><td>반품불가 처리</td><td>회수 처리 진행중인 건에 대해 반품접수 불가 처리를 진행합니다.</td><td>API-BO</td><td>POST</td><td><p><a href="http://apibo.x2bee.com/content?bo=delivery&#x26;depth=%ED%9A%8C%EC%88%98%EC%B2%98%EB%A6%AC&#x26;path=noAllowedReturnProcess">🔗API 확인하기 ></a></p><p>주문 api 호출</p></td></tr><tr><td>회수 조회</td><td>회수지시처리, 회수확인처리, 회수완료처리 화면의 데이터를 조회합니다.</td><td>API-BO</td><td>GET</td><td><a href="http://apibo.x2bee.com/content?bo=delivery&#x26;depth=%ED%9A%8C%EC%88%98%EC%B2%98%EB%A6%AC&#x26;path=withdrawList">🔗API 확인하기 ></a></td></tr><tr><td>회수 상세 팝업 조회</td><td>회수상세 팝업에 필요한 주문자정보 및 반품상세정보를 조회합니다.</td><td>API-BO</td><td>GET</td><td><a href="http://apibo.x2bee.com/content?bo=delivery&#x26;depth=%ED%9A%8C%EC%88%98%EC%B2%98%EB%A6%AC&#x26;path=getWithdrawDetail">🔗API 확인하기 ></a></td></tr></tbody></table>

***

## 프로세스 정의 — 배송관리

<figure><img src="/files/8xIvGrLR7O74GLLANUBs" alt=""><figcaption></figcaption></figure>

{% stepper %}
{% step %}

### 배송처리 대상 목록 조회

관리자는 배송처리대상(배송지시처리, 출고지시처리, 출고완료처리, 배송완료처리, 결품처리)목록을 조회합니다.\
BO API의 “배송처리목록조회”를 이용해서 목록을 조회합니다.
{% endstep %}

{% step %}

### 배송 상태 업데이트

관리자는 배송처리대상(배송지시처리, 출고지시처리, 출고완료처리, 배송완료처리) 목록을 조회 후 배송상태 값을 아래와 같이 업데이트 합니다.

* 주문완료 -> 배송지시
* 배송지시 -> 출고지시
* 출고지시 -> 출고완료
* 출고완료 -> 배송완료

BO API의 “배송처리”, ORDER API의 “배송처리”를 이용해서 배송 처리상태를 업데이트 합니다.
{% endstep %}

{% step %}

### 결품 처리

관리자는 결품처리대상(결품등록처리, 결품해제처리) 목록을 조회 후 결품상태 값을 아래와 같이 업데이트 합니다.

* 출고지시 -> 출고대기(결품등록)
* 출고대기 -> 출고지시(결품해제)

BO API의 “결품처리”, ORDER API의 “결품처리”를 이용해서 결품 처리상태를 업데이트 합니다.
{% endstep %}

{% step %}

### 배송 완료 처리

외부 배송 추적 시스템(스윗트래커)에서 수신받은 정보 중 배송 완료 건에 대해 배송 처리를 진행합니다.\
외부 배송 추적 시스템에서 ORDER API의 “운송장 트래킹 정보 수신” URL 호출하여 배송완료처리를 진행합니다.
{% endstep %}
{% endstepper %}

다음은 자동배송완료 및 자동운송장등록 관련 절차입니다.

<figure><img src="/files/1w7WMx22pkWyrfBZhNC7" alt=""><figcaption></figcaption></figure>

{% stepper %}
{% step %}

### 출고완료 목록 조회

자동배송완료배치는 출고완료목록 조회 후 배송완료 처리를 진행합니다.
{% endstep %}

{% step %}

### 배송방법이 택배인 경우

출고완료목록 중 배송방법이 택배(배송방법코드 : 10, 택배사코드 참조1값 : Y)인 데이터에 대해 배송추적시스템에서 배송완료인 데이터 조회 후 배송완료 처리합니다.
{% endstep %}

{% step %}

### 배송방법이 택배가 아닌 경우

배송방법이 택배가 아닌 경우는 모든 데이터를 배송완료 처리합니다.
{% endstep %}

{% step %}

### 배송완료처리

배송완료처리는 ORDER API의 “배송완료지시배치”를 이용해 처리합니다.
{% endstep %}

{% step %}

### 운송장 등록 대상 목록 조회

자동운송장등록배치는 아래 조건에 해당하는 데이터 조회 후 등록을 진행합니다.

* 주문내역상태 : 출고완료
* 배송방법 : 택배
* 주문배송정보연동이력 테이블 미등록 배송번호
  {% endstep %}

{% step %}

### 배송 추적 시스템 운송장 등록

운송장 등록시 외부배송추적시스템에 데이터를 전송하고, 주문배송정보연동이력 테이블에 이력 데이터를 저장합니다.
{% endstep %}
{% endstepper %}

***

## API 기능 목록 — 배송관리

<table><thead><tr><th width="101.22216796875">API</th><th width="306.5555419921875">설명</th><th>Server</th><th>메소드</th><th>비고</th></tr></thead><tbody><tr><td>결품처리</td><td>주문내역상태코드 업데이트를 통해 <br>결품등록, 결품해제를 진행합니다.</td><td>API-BO</td><td>POST</td><td><p><a href="http://apibo.x2bee.com/content?bo=delivery&#x26;depth=%ED%9A%8C%EC%88%98%EC%B2%98%EB%A6%AC&#x26;path=getWithdrawDetail">🔗API 확인하기 ></a></p><p>주문 api 호출</p></td></tr><tr><td>배송처리</td><td>주문내역상태코드 업데이트를 통해 <br>배송처리(배송지시, 출고지시, 출고완료, 배송완료)를 진행합니다.</td><td>API-BO</td><td>POST</td><td><p><a href="http://apibo.x2bee.com/content?bo=delivery&#x26;depth=%EB%B0%B0%EC%86%A1%EA%B4%80%EB%A6%AC&#x26;path=processDelivery">🔗API 확인하기 ></a></p><p>주문 api 호출</p></td></tr><tr><td>배송처리목록조회</td><td>배송처리 진행중인 목록을 조회합니다. 주문수량이 유효한 주문만 조회하고, <br>주문취소, 반품취소, 반품완료인 건은 조회하지 않습니다.</td><td>API-BO</td><td>GET</td><td><a href="http://apibo.x2bee.com/content?bo=delivery&#x26;depth=%EB%B0%B0%EC%86%A1%EA%B4%80%EB%A6%AC&#x26;path=getDeliveryMgmtList">🔗API 확인하기 ></a></td></tr></tbody></table>

***

## 프로세스 정의 — 출고완료

<figure><img src="/files/qRZHvAWMLL7VDq0hgEef" alt=""><figcaption></figcaption></figure>

{% stepper %}
{% step %}

### 출고 완료 일괄 등록 정보 조회

관리자는 엑셀 대량 데이터 일괄 출고완료 처리를 위해 데이터 조회 후 유효성 체크를 진행합니다.\
정보 조회는 BO API의 “출고완료일괄등록정보조회”를 이용합니다.
{% endstep %}

{% step %}

### 출고완료 상태로 업데이트

유효성 체크가 완료된 데이터는 BO API의 “배송처리”, ORDER API의 “배송처리”를 이용해서 배송상태를 출고 완료 상태로 업데이트 합니다.
{% endstep %}
{% endstepper %}

***

## API 기능 목록 — 출고완료

| API          | 설명                                              | Server | 메소드 | 비고                                                                                                                                  |
| ------------ | ----------------------------------------------- | ------ | --- | ----------------------------------------------------------------------------------------------------------------------------------- |
| 출고완료일괄등록정보조회 | 엑셀을 이용해 출고완료 일괄등록 진행시 유효성 체크를 위한 배송상세정보를 조회합니다. | API-BO | GET | [🔗API 확인하기 >](http://apibo.x2bee.com/content?bo=delivery\&depth=%EC%B6%9C%EA%B3%A0%EC%99%84%EB%A3%8C\&path=getSendFinishPopupList) |

***

## 프로세스 정의 — 배송 조회

<figure><img src="/files/CFBV3WMz3iFASwd6Lk6h" alt=""><figcaption></figcaption></figure>

{% stepper %}
{% step %}

### 배송관리 화면 목록 조회

관리자는 배송 처리를 위한 배송관리 화면의 목록을 조회합니다.\
정보 조회는 BO API의 “배송목록조회”를 이용합니다.
{% endstep %}

{% step %}

### &#x20;배송상세 정보 조회

관리자는 배송상세팝업의 주문자 및 배송 정보를 조회합니다.\
정보 조회는 BO API의 “배송상세정보조회”를 이용합니다.\
정보 조회시 개인정보조회 권한에 따른 마스킹 정보가 조회됩니다.
{% endstep %}

{% step %}

### &#x20;주문상품내역 조회

관리자는 배송상세팝업의 주문상품내역 목록을 조회합니다.\
정보 조회는 BO API의 “주문상품내역조회”를 이용합니다.
{% endstep %}
{% endstepper %}

***

## API 기능 목록 — 배송 조회

<table><thead><tr><th width="131.22216796875">API</th><th width="285.111083984375">설명</th><th width="99.111083984375">Server</th><th width="89.111083984375">메소드</th><th></th></tr></thead><tbody><tr><td>주문상품내역조회</td><td>특정 배송번호의 주문상품내역을 조회합니다.</td><td>API-BO</td><td>GET</td><td><a href="http://apibo.x2bee.com/content?bo=delivery&#x26;depth=%EB%B0%B0%EC%86%A1%EC%A1%B0%ED%9A%8C&#x26;path=getDeliveryOrderDetailList">🔗API 확인하기 ></a></td></tr><tr><td>배송목록조회</td><td>배송 목록을 조회합니다. 주문수량이 유효한 주문만 조회하고, 주문취소, 반품취소, 반품완료인 건은 조회하지 않습니다.</td><td>API-BO</td><td>GET</td><td><a href="http://apibo.x2bee.com/content?bo=delivery&#x26;depth=%EB%B0%B0%EC%86%A1%EC%A1%B0%ED%9A%8C&#x26;path=getDeliveryOrderDetailList">🔗API 확인하기 ></a></td></tr><tr><td>배송상세정보조회</td><td>특정 배송번호의 주문자정보 및 배송상세정보를 조회합니다.</td><td>API-BO</td><td>GET</td><td><a href="http://apibo.x2bee.com/content?bo=delivery&#x26;depth=%EB%B0%B0%EC%86%A1%EC%A1%B0%ED%9A%8C&#x26;path=getDeliveryDetail">🔗API 확인하기 ></a></td></tr></tbody></table>

***

## 기타 참고사항

* 스윗트래커 개발 가이드 - [가이드 문서 바로가기 >](https://img.sweettracker.net/smartapi_doc/smartAPI_Trace%20API_v1.5.pdf)
* 배송추적시스템 설정 - BATCH-MBOD

<table data-header-hidden><thead><tr><th width="143.4444580078125">application-local.properties / application-dev.properties</th><th width="306.4444580078125">설정 항목 및 설명</th><th>비고</th></tr></thead><tbody><tr><td>application-local.properties<br>application-dev.properties</td><td>delivery.api.externalUrl =외부에서 접근 가능한 order api url<br>delivery.api.provider=db 등록/수정 사용자 id <br>delivery.api.url=배송추적시스템(스윗트래커) url <br>delivery.api.tier=배송추적시스템에서 발급받은 tier <br>delivery.api.key=배송추적시스템에서 발급받은 key <br>delivery.api.type=요청 데이터 type delivery.tracking.path=배송정보조회요청path <br>delivery.register.path=운송장등록요청<br>path delivery.callback.path=배송추적정보수신path</td><td>배송추적정보수신 full url : delivery.api.externalUrl + delivery.callback.path <br><br>배송정보조회 full url : delivery.api.url + delivery.tracking.path <br><br>운송장등록 full url : delivery.api.url + delivery.register.path</td></tr></tbody></table>

***


---

# 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-guide/back-office/delivery-bo/undefined-1.md?ask=<question>
```

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.
