> 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-guide/api-guides-en/back-office/delivery-bo/delivery-management.md).

# Delivery Management

Provides various functions needed for order processing to support efficient product delivery and management. This enables convenient handling of collection processing, delivery management, shipment completion, delivery lookup, and other delivery-related tasks.

***

## Key Features

* **Collection Processing**
  * **Collection Status Update:** Updates the status for collection targets.
  * **Collection Instruction Processing:** Processes collection instructions for return and exchange requests.
  * **Return/Exchange Processing:** Processes return conversion or return rejection for collection-confirmed targets.
  * **Collection Data Lookup:** Looks up the collection target list and detail information.
* **Delivery Management**
  * **Status Processing:** Changes the status for out-of-stock and delivery processing.
  * **Processing List Lookup:** Looks up the list of out-of-stock and delivery processing targets.
* **Shipment Completion**
  * **Bulk Registration Lookup:** Looks up information needed for bulk shipment completion processing.
* **Delivery Lookup**
  * **Product History Lookup:** Looks up the order product history list in the delivery detail popup.
  * **Delivery List Lookup:** Looks up the list for delivery processing.
  * **Detail Information Lookup:** Looks up orderer and delivery information in the delivery detail popup.

***

## Process Definition — Collection Processing

<figure><img src="https://2999922013-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FXTxKSWMmuxEkop1pvuwe%2Fuploads%2FKipNTv9TyaTH5NQvaIUe%2F%E1%84%92%E1%85%AC%E1%84%89%E1%85%AE%E1%84%8E%E1%85%A5%E1%84%85%E1%85%B5.png?alt=media&#x26;token=562b6f35-daea-4e31-92a4-c9fb92782fff" alt=""><figcaption></figcaption></figure>

{% stepper %}
{% step %}

### Collection Target List Lookup

The administrator looks up the list of collection targets (collection instruction processing, collection confirmation processing, collection completion processing).\
Uses the BO API's "Collection Lookup" to look up the list.
{% endstep %}

{% step %}

### Collection Status Update

The administrator looks up the collection target list (collection confirmation processing, collection completion processing) and updates the collection status value.

* Collection-instructed cases are changed to collection-confirmed
* Collection-confirmed cases are changed to collection-completed

Uses the BO API's "Collection Status Update" and the ORDER API's "Collection Progress Status Modification" to update the collection progress status.
{% endstep %}

{% step %}

### Collection Instruction Processing

The administrator looks up the list of received cases (return requests, exchange requests) and updates the collection status value.

* Changes the status of received cases to collection-instructed

Uses the BO API's "Collection Instruction Processing" and the ORDER API's "Collection Instruction" to process the collection instruction.
{% endstep %}

{% step %}

### Return During Exchange Processing

The administrator looks up the list of collection-confirmed status and processes return during exchange.\
Uses the BO API's "Return During Exchange Processing" and the ORDER API's "Return During Exchange" to proceed with processing.
{% endstep %}

{% step %}

### Return Rejection Processing

The administrator looks up the list of collection-confirmed status and processes return rejection.\
Uses the BO API's "Return Rejection Processing" and the ORDER API's "Return During Exchange" to proceed with processing.
{% endstep %}

{% step %}

### Collection Detail Popup Information Lookup

The administrator uses the collection delivery number to look up the information needed for the collection detail popup.\
Uses the BO API's "Collection Detail Popup Lookup" to perform the lookup.
{% endstep %}
{% endstepper %}

***

## API Function List — Collection Management

<table><thead><tr><th width="97.8887939453125">API</th><th width="348.666748046875">Description</th><th width="98">Server</th><th width="90.22216796875">Method</th><th>Notes</th></tr></thead><tbody><tr><td>Collection Status Update</td><td>Updates the collection status of the target list using the requested current order history status and the order history status to be updated.</td><td>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">🔗View API ></a></p><p>Calls the order API</p></td></tr><tr><td>Collection Instruction Processing</td><td>Updates orders whose order history status is return-requested to the collection-instructed status.</td><td>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">🔗View API ></a></p><p>Calls the order API</p></td></tr><tr><td>Return During Exchange Processing</td><td>Processes return conversion for cases currently under collection processing.</td><td>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">🔗View API ></a></p><p>Calls the order API</p></td></tr><tr><td>Return Rejection Processing</td><td>Processes return-request rejection for cases currently under collection processing.</td><td>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">🔗View API ></a></p><p>Calls the order API</p></td></tr><tr><td>Collection Lookup</td><td>Looks up the data for the collection instruction processing, collection confirmation processing, and collection completion processing screens.</td><td>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">🔗View API ></a></td></tr><tr><td>Collection Detail Popup Lookup</td><td>Looks up orderer information and return detail information needed for the collection detail popup.</td><td>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">🔗View API ></a></td></tr></tbody></table>

***

## Process Definition — Delivery Management

<figure><img src="https://2999922013-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FXTxKSWMmuxEkop1pvuwe%2Fuploads%2FDSK5VvJaGCWI0iGjmQDL%2F%E1%84%87%E1%85%A2%E1%84%89%E1%85%A9%E1%86%BC%E1%84%80%E1%85%AA%E1%86%AB%E1%84%85%E1%85%B51.png?alt=media&#x26;token=7465ab10-c245-4263-87bc-9abced604224" alt=""><figcaption></figcaption></figure>

{% stepper %}
{% step %}

### Delivery Processing Target List Lookup

The administrator looks up the delivery processing target list (delivery instruction processing, shipment instruction processing, shipment completion processing, delivery completion processing, out-of-stock processing).\
Uses the BO API's "Delivery Processing List Lookup" to look up the list.
{% endstep %}

{% step %}

### Delivery Status Update

The administrator looks up the delivery processing target list (delivery instruction processing, shipment instruction processing, shipment completion processing, delivery completion processing) and updates the delivery status value as follows.

* Order complete -> Delivery instructed
* Delivery instructed -> Shipment instructed
* Shipment instructed -> Shipment completed
* Shipment completed -> Delivery completed

Uses the BO API's "Delivery Processing" and the ORDER API's "Delivery Processing" to update the delivery processing status.
{% endstep %}

{% step %}

### Out-of-Stock Processing

The administrator looks up the out-of-stock processing target list (out-of-stock registration processing, out-of-stock release processing) and updates the out-of-stock status value as follows.

* Shipment instructed -> Awaiting shipment (out-of-stock registered)
* Awaiting shipment -> Shipment instructed (out-of-stock released)

Uses the BO API's "Out-of-Stock Processing" and the ORDER API's "Out-of-Stock Processing" to update the out-of-stock processing status.
{% endstep %}

{% step %}

### Delivery Completion Processing

Among the information received from the external delivery tracking system (Sweet Tracker), processes delivery completion for delivery-completed cases.\
The external delivery tracking system calls the ORDER API's "Tracking Number Tracking Information Receipt" URL to process delivery completion.
{% endstep %}
{% endstepper %}

Below is the procedure related to automatic delivery completion and automatic tracking number registration.

<figure><img src="https://2999922013-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FXTxKSWMmuxEkop1pvuwe%2Fuploads%2FHYTH5EGMQ4NqxVtY1IfR%2F%E1%84%87%E1%85%A2%E1%84%89%E1%85%A9%E1%86%BC%E1%84%80%E1%85%AA%E1%86%AB%E1%84%85%E1%85%B52.png?alt=media&#x26;token=6ab30376-c5b0-4971-b652-1e52ba533f81" alt=""><figcaption></figcaption></figure>

{% stepper %}
{% step %}

### Shipment Completion List Lookup

The automatic delivery completion batch looks up the shipment completion list, then processes delivery completion.
{% endstep %}

{% step %}

### When the Delivery Method Is Parcel Delivery

For data in the shipment completion list whose delivery method is parcel delivery (delivery method code: 10, courier company code reference value 1: Y), looks up delivery-completed data from the delivery tracking system and processes delivery completion.
{% endstep %}

{% step %}

### When the Delivery Method Is Not Parcel Delivery

When the delivery method is not parcel delivery, processes all data as delivery-completed.
{% endstep %}

{% step %}

### Delivery Completion Processing

Delivery completion processing is performed using the ORDER API's "Delivery Completion Instruction Batch."
{% endstep %}

{% step %}

### Tracking Number Registration Target List Lookup

The automatic tracking number registration batch looks up data matching the following conditions before registration.

* Order history status: Shipment completed
* Delivery method: Parcel delivery
* Delivery number not registered in the order delivery information linkage history table
  {% endstep %}

{% step %}

### Delivery Tracking System Tracking Number Registration

When registering the tracking number, sends the data to the external delivery tracking system and saves the history data in the order delivery information linkage history table.
{% endstep %}
{% endstepper %}

***

## API Function List — Delivery Management

<table><thead><tr><th width="101.22216796875">API</th><th width="306.5555419921875">Description</th><th>Server</th><th>Method</th><th>Notes</th></tr></thead><tbody><tr><td>Out-of-Stock Processing</td><td>Performs out-of-stock registration and out-of-stock release by updating the order history status code.</td><td>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">🔗View API ></a></p><p>Calls the order API</p></td></tr><tr><td>Delivery Processing</td><td>Performs delivery processing (delivery instruction, shipment instruction, shipment completion, delivery completion) by updating the order history status code.</td><td>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">🔗View API ></a></p><p>Calls the order API</p></td></tr><tr><td>Delivery Processing List Lookup</td><td>Looks up the list currently under delivery processing. Only orders with a valid order quantity are looked up, and cancelled orders, cancelled returns, and completed returns are not looked up.</td><td>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">🔗View API ></a></td></tr></tbody></table>

***

## Process Definition — Shipment Completion

<figure><img src="https://2999922013-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FXTxKSWMmuxEkop1pvuwe%2Fuploads%2FXYXqKCH5T2kIdJZY45kB%2F%E1%84%8E%E1%85%AE%E1%86%AF%E1%84%80%E1%85%A9%E1%84%8B%E1%85%AA%E1%86%AB%E1%84%85%E1%85%AD.png?alt=media&#x26;token=c1b146d2-2703-49b7-8375-d9201777bba3" alt=""><figcaption></figcaption></figure>

{% stepper %}
{% step %}

### Shipment Completion Bulk Registration Information Lookup

The administrator looks up data and performs validity checks for bulk shipment completion processing of large-volume Excel data.\
The information lookup uses the BO API's "Shipment Completion Bulk Registration Information Lookup."
{% endstep %}

{% step %}

### Update to Shipment Completed Status

For data that has passed the validity check, uses the BO API's "Delivery Processing" and the ORDER API's "Delivery Processing" to update the delivery status to shipment completed.
{% endstep %}
{% endstepper %}

***

## API Function List — Shipment Completion

| API                                                      | Description                                                                                                                  | Server | Method | Notes                                                                                                                               |
| -------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ------ | ------ | ----------------------------------------------------------------------------------------------------------------------------------- |
| Shipment Completion Bulk Registration Information Lookup | Looks up delivery detail information for the validity check when performing bulk shipment completion registration via Excel. | BO     | GET    | [🔗View API >](http://apibo.x2bee.com/content?bo=delivery\&depth=%EC%B6%9C%EA%B3%A0%EC%99%84%EB%A3%8C\&path=getSendFinishPopupList) |

***

## Process Definition — Delivery Lookup

<figure><img src="https://2999922013-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FXTxKSWMmuxEkop1pvuwe%2Fuploads%2FbWu8jQE1iDCRrjXLnhXs%2F%E1%84%87%E1%85%A2%E1%84%89%E1%85%A9%E1%86%BC%E1%84%8C%E1%85%A9%E1%84%92%E1%85%AC.png?alt=media&#x26;token=e0f7c9dd-e721-4985-9da7-5849ddf32419" alt=""><figcaption></figcaption></figure>

{% stepper %}
{% step %}

### Delivery Management Screen List Lookup

The administrator looks up the list on the delivery management screen for delivery processing.\
The information lookup uses the BO API's "Delivery List Lookup."
{% endstep %}

{% step %}

### Delivery Detail Information Lookup

The administrator looks up orderer and delivery information in the delivery detail popup.\
The information lookup uses the BO API's "Delivery Detail Information Lookup."\
When looking up the information, masked information is displayed according to the personal information viewing permission.
{% endstep %}

{% step %}

### Order Product History Lookup

The administrator looks up the order product history list in the delivery detail popup.\
The information lookup uses the BO API's "Order Product History Lookup."
{% endstep %}
{% endstepper %}

***

## API Function List — Delivery Lookup

<table><thead><tr><th width="131.22216796875">API</th><th width="285.111083984375">Description</th><th width="99.111083984375">Server</th><th width="89.111083984375">Method</th><th></th></tr></thead><tbody><tr><td>Order Product History Lookup</td><td>Looks up the order product history for a specific delivery number.</td><td>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">🔗View API ></a></td></tr><tr><td>Delivery List Lookup</td><td>Looks up the delivery list. Only orders with a valid order quantity are looked up, and cancelled orders, cancelled returns, and completed returns are not looked up.</td><td>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">🔗View API ></a></td></tr><tr><td>Delivery Detail Information Lookup</td><td>Looks up orderer information and delivery detail information for a specific delivery number.</td><td>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">🔗View API ></a></td></tr></tbody></table>

***

## Other Notes

* Sweet Tracker development guide - [Go to guide document >](https://img.sweettracker.net/smartapi_doc/smartAPI_Trace%20API_v1.5.pdf)
* Delivery tracking system configuration - BATCH-MBOD

<table data-header-hidden><thead><tr><th width="143.4444580078125">application-local.properties / application-dev.properties</th><th width="306.4444580078125">Configuration Item and Description</th><th>Notes</th></tr></thead><tbody><tr><td>application-local.properties<br>application-dev.properties</td><td>delivery.api.externalUrl = externally accessible order api url<br>delivery.api.provider = db registration/modification user id<br>delivery.api.url = delivery tracking system (Sweet Tracker) url<br>delivery.api.tier = tier issued by the delivery tracking system<br>delivery.api.key = key issued by the delivery tracking system<br>delivery.api.type = request data type delivery.tracking.path = delivery information lookup request path<br>delivery.register.path = tracking number registration request<br>path delivery.callback.path = delivery tracking information receipt path</td><td>Delivery tracking information receipt full url: delivery.api.externalUrl + delivery.callback.path<br><br>Delivery information lookup full url: delivery.api.url + delivery.tracking.path<br><br>Tracking number registration full url: delivery.api.url + delivery.register.path</td></tr></tbody></table>

***