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

# Delivery Management

## Out-of-Stock Processing

> \## Function Description\
> \* Processes out-of-stock handling on the Out-of-Stock Management screen.\
> \---\
> \## Detailed Description\
> \* Processes out-of-stock registration and out-of-stock release.\
> \* The Original Order History Status Code (ordDtlStatCd:OM005), Target Order History Status Code (targetOrdDtlStatCd:OM005), and the out-of-stock processing request list (insuffDeliveryProcessInfoList) are required.\
> \* Original Order History Status Code (OM005) -> Target Order History Status Code (OM005)\
>   \* Out-of-stock registration: 22 (Shipment Instructed) -> 23 (Awaiting Shipment)\
>   \* Out-of-stock release: 23 (Awaiting Shipment) -> 22 (Shipment Instructed)\
> \* Processed by calling the Out-of-Stock Processing API in API-ORDER.\
> \* After out-of-stock registration, the item is registered in the Customer Center OB list.\
> \* After out-of-stock registration, a notification message (Alimtalk, Notification Box) is sent.<br>

```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":"Out-of-Stock Processing Request DTO","properties":{"ordDtlStatCd":{"type":"string","description":"Original Order History Status Code (OM005) 22: Shipment Instructed, 23: Awaiting Shipment","minLength":1},"targetOrdDtlStatCd":{"type":"string","description":"Target Order History Status Code (OM005) 22: Shipment Instructed, 23: Awaiting Shipment","minLength":1},"insuffDeliveryProcessInfoList":{"type":"array","description":"Delivery Processing List","items":{"$ref":"#/components/schemas/InsuffDeliveryProcessInfo"}}},"required":["insuffDeliveryProcessInfoList","ordDtlStatCd","targetOrdDtlStatCd"]},"InsuffDeliveryProcessInfo":{"type":"object","description":"Out-of-Stock Processing Information DTO","properties":{"ordNo":{"type":"string","description":"Order No.","minLength":1},"deliNo":{"type":"string","description":"Delivery No.","minLength":1},"ordSeq":{"type":"integer","format":"int32","description":"Order Sequence No."},"ordProcSeq":{"type":"integer","format":"int32","description":"Order Processing Sequence No."},"shipWaitCaus":{"type":"string","description":"Out-of-Stock Reason (LO007) 10: Insufficient Stock, 20: Stock Available but Cannot Ship, 30: Customer Changed Mind","minLength":1},"shipWaitCausCont":{"type":"string","description":"Out-of-Stock Detail Reason"},"insuffQty":{"type":"integer","format":"int32","description":"Out of Stock Quantity"}},"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":["Delivery Management"],"summary":"Out-of-Stock Processing","description":"## Function Description\n* Processes out-of-stock handling on the Out-of-Stock Management screen.\n---\n## Detailed Description\n* Processes out-of-stock registration and out-of-stock release.\n* The Original Order History Status Code (ordDtlStatCd:OM005), Target Order History Status Code (targetOrdDtlStatCd:OM005), and the out-of-stock processing request list (insuffDeliveryProcessInfoList) are required.\n* Original Order History Status Code (OM005) -> Target Order History Status Code (OM005)\n  * Out-of-stock registration: 22 (Shipment Instructed) -> 23 (Awaiting Shipment)\n  * Out-of-stock release: 23 (Awaiting Shipment) -> 22 (Shipment Instructed)\n* Processed by calling the Out-of-Stock Processing API in API-ORDER.\n* After out-of-stock registration, the item is registered in the Customer Center OB list.\n* After out-of-stock registration, a notification message (Alimtalk, Notification Box) is sent.\n","operationId":"processInsuffDelivery","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InsuffDeliveryProcessRequest"}}},"required":true},"responses":{"200":{"description":"Out-of-Stock Processing Successful"},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Delivery Processing

> \## Function Description\
> \* Processes delivery handling on the Delivery Management screen.\
> \---\
> \## Detailed Description\
> \* Processes delivery instruction, shipment instruction, shipment completion, and delivery completion.\
> \* The Original Order History Status Code (ordDtlStatCd:OM005), Target Order History Status Code (targetOrdDtlStatCd:OM005), and the delivery processing list (deliveryProcessInfoList) are required.\
> \* Original Order History Status Code (OM005) -> Target Order History Status Code (OM005)\
> &#x20; \* Delivery instruction: 12 (Order Completed) -> 21 (Delivery Instructed)\
> &#x20; \* Shipment instruction: 21 (Delivery Instructed) -> 22 (Shipment Instructed)\
> &#x20; \* Shipment completion: 22 (Shipment Instructed) -> 26 (Shipment Completed)\
> &#x20; \* Delivery completion: 26 (Shipment Completed) -> 27 (Delivery Completed)\
> \* Processed by calling the Delivery Processing API in API-ORDER.\
> \* After delivery processing, a notification message (Alimtalk, Notification Box, email) is sent.<br>

```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":"Delivery Processing Request DTO","properties":{"ordDtlStatCd":{"type":"string","description":"Original Order History Status Code (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":"Target Order History Status Code (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":"Original Delivery History Status Code (LO016)"},"targetDeliDtlStatCd":{"type":"string","description":"Target Delivery History Status Code (LO016)"},"deliveryProcessInfoList":{"type":"array","description":"Delivery Processing List","items":{"$ref":"#/components/schemas/DeliveryProcessInfo"}}},"required":["deliveryProcessInfoList","ordDtlStatCd","targetOrdDtlStatCd"]},"DeliveryProcessInfo":{"type":"object","description":"Delivery Processing Information DTO","properties":{"ordNo":{"type":"string","description":"Order No."},"ordSeq":{"type":"integer","format":"int32","description":"Order Sequence No."},"shipQty":{"type":"integer","format":"int32","description":"Shipment Quantity"},"deliSeq":{"type":"integer","format":"int32","description":"Delivery Sequence No."},"deliNo":{"type":"string","description":"Delivery No.","minLength":1},"hdcCd":{"type":"string","description":"Courier Company Code (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":"Invoice No."},"alimYn":{"type":"string","description":"Notification Message Sent Status"}},"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":["Delivery Management"],"summary":"Delivery Processing","description":"## Function Description\n* Processes delivery handling on the Delivery Management screen.\n---\n## Detailed Description\n* Processes delivery instruction, shipment instruction, shipment completion, and delivery completion.\n* The Original Order History Status Code (ordDtlStatCd:OM005), Target Order History Status Code (targetOrdDtlStatCd:OM005), and the delivery processing list (deliveryProcessInfoList) are required.\n* Original Order History Status Code (OM005) -> Target Order History Status Code (OM005)\n  * Delivery instruction: 12 (Order Completed) -> 21 (Delivery Instructed)\n  * Shipment instruction: 21 (Delivery Instructed) -> 22 (Shipment Instructed)\n  * Shipment completion: 22 (Shipment Instructed) -> 26 (Shipment Completed)\n  * Delivery completion: 26 (Shipment Completed) -> 27 (Delivery Completed)\n* Processed by calling the Delivery Processing API in API-ORDER.\n* After delivery processing, a notification message (Alimtalk, Notification Box, email) is sent.\n","operationId":"processDelivery","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeliveryProcessRequest"}}},"required":true},"responses":{"200":{"description":"Delivery Processing Successful"},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Retrieve Delivery Processing List

> \## Function Description\
> \* Retrieves the delivery list on the Delivery Processing screen.\
> \---\
> \## Detailed Description\
> \* Used on the Delivery Instruction Processing, Shipment Instruction Processing, Shipment Completion Processing, Delivery Completion Processing, and Out-of-Stock Processing screens.\
> \* Only orders with a valid order quantity are retrieved. (Order Quantity - Cancelled Quantity > 0)\
> \* If the inflow channel is PO, only the corresponding vendor's data is retrieved.\
> \* Records whose order history status (OM005) is Order Cancelled (13), Return Cancelled (33), or Return Completed (37) are not retrieved.\
> \* The inquiry period can be up to a maximum of 30 days.<br>

```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":"Delivery Management Inquiry Request DTO","properties":{"entrNo":{"type":"string","description":"Vendor No."},"searchDateType":{"type":"string","description":"Search Period Type"},"startDate":{"type":"string","format":"date","description":"Search Period (Start Date)"},"endDate":{"type":"string","format":"date","description":"Search Period (End Date)"},"searchDeliveryType":{"type":"string","description":"Delivery Information Type"},"deliveryVal":{"type":"string","description":"Delivery Information Input Value"},"deliKindCd":{"type":"string","description":"Delivery Type (LO009) 10: Standard Delivery, 20: Reserved Delivery"},"searchOrdManType":{"type":"string","description":"Orderer Information Type"},"ordManVal":{"type":"string","description":"Orderer Information Input Value"},"deliProcTypCd":{"type":"string","description":"Delivery Processing Type (PR008) 10: Center Delivery, 20: Vendor Delivery, 30: e-Coupon Delivery"},"searchOrdDtlStatCd":{"type":"string","description":"Order History Status (Inquiry Condition)"},"ordDtlStatCd":{"type":"string","description":"Original Order History Status Code (OM005) 12: Order Completed, 21: Delivery Instructed, 22: Shipment Instructed, 23: Awaiting Shipment, 26: Shipment Completed, 33: Accepted"},"toOrdDtlStatCd":{"type":"string","description":"Target Order History Status Code (OM005) 21: Delivery Instructed, 22: Shipment Instructed, 23: Awaiting Shipment, 26: Shipment Completed, 27: Delivery Completed"},"hdcCd":{"type":"string","description":"Courier Company (LO005) 10: CJ Logistics, 11: Post Office Parcel, 12: GoodToLuck, 13: DHL, 14: Logen Logistics, 30: Vroong, 31: GoGoVan"},"shipWaitCaus":{"type":"string","description":"Reason for Awaiting Shipment (LO007) 10: Insufficient Stock, 20: Stock Available but Cannot Ship, 30: Customer Changed Mind"},"workType":{"type":"string","description":"Delivery Work Type (DeliveryWorkType) insuffMgmt: Out-of-Stock Management"}}},"RealGridListResponseDeliveryMgmtCommonResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/DeliveryMgmtCommonResponse"}}}},"DeliveryMgmtCommonResponse":{"type":"object","description":"Delivery Processing Inquiry Response DTO","properties":{"ordNo":{"type":"string","description":"Order No."},"ordSeq":{"type":"string","description":"Order Sequence No."},"ordProcSeq":{"type":"string","description":"Order Processing Sequence No."},"deliNo":{"type":"string","description":"Delivery No."},"deliSeq":{"type":"string","description":"Delivery Sequence No."},"ordGbCd":{"type":"string","description":"Order Type Code"},"ordAccpDtm":{"type":"string","format":"date-time","description":"Order Receipt Date/Time"},"ordDtlGbCd":{"type":"string","description":"Order History Type Code"},"ordDtlStatCd":{"type":"string","description":"Order Detail Status Code"},"ordDtlStatCdNm":{"type":"string","description":"Order Detail Status Code Name"},"deliKindCd":{"type":"string","description":"Delivery Type Code"},"deliProcTypCd":{"type":"string","description":"Delivery Processing Type (PR008)"},"hdcCd":{"type":"string","description":"Courier Company (LO005)"},"hdcCdNm":{"type":"string","description":"Courier Company Name"},"invNo":{"type":"string","description":"Invoice No."},"ordSaleTypCd":{"type":"string","description":"Order Sales Type (OM004)"},"partShipYn":{"type":"string","description":"Separate Shipment Available Status"},"goodsNo":{"type":"string","description":"Product No."},"goodsNm":{"type":"string","description":"Product Name"},"itmNo":{"type":"string","description":"Item No."},"itmNm":{"type":"string","description":"Item Name"},"prestNm":{"type":"string","description":"Gift Item Name"},"ordQty":{"type":"string","description":"Order Quantity"},"preShipQty":{"type":"string","description":"Previously Shipped Quantity"},"shipNeedQty":{"type":"string","description":"Required Shipping Quantity"},"shipQty":{"type":"string","description":"Shipment Quantity"},"norPrc":{"type":"number","description":"Regular Price"},"salePrc":{"type":"number","description":"Selling Price"},"entrNm":{"type":"string","description":"Vendor Name"},"loginId":{"type":"string","description":"Login ID"},"mbrNo":{"type":"string","description":"Member No."},"ordManNm":{"type":"string","description":"Orderer Name"},"ordManCellNo":{"type":"string","description":"Orderer's Mobile Phone Number"},"ordManCellSctNo":{"type":"string","description":"Orderer's Mobile Phone Prefix Code"},"ordManCellTxnoNo":{"type":"string","description":"Orderer's Mobile Phone Exchange Code"},"ordManCellEndNo":{"type":"string","description":"Orderer's Mobile Phone Last Digits"},"rcvmnNm":{"type":"string","description":"Recipient Name"},"rcvmnCellNo":{"type":"string","description":"Recipient Mobile Phone Number"},"rcvmnCellSctNo":{"type":"string","description":"Recipient's Mobile Phone Prefix Code"},"rcvmnCellTxnoNo":{"type":"string","description":"Recipient's Mobile Phone Exchange Code"},"rcvmnCellEndNo":{"type":"string","description":"Recipient's Mobile Phone Last Digits"},"zipAddr":{"type":"string","description":"Postal Address"},"dtlAddr":{"type":"string","description":"Detailed Address"},"deliMsgCd":{"type":"string","description":"Delivery Message Code (ME039)"},"deliMsg":{"type":"string","description":"Delivery Message"},"deliIndiDtm":{"type":"string","format":"date-time","description":"Delivery Instruction Date/Time"},"shipWaitCaus":{"type":"string","description":"Shipping Hold Reason (LO007)"},"shipWaitCausCont":{"type":"string","description":"Awaiting Shipment Reason Detail"},"shipWaitDtm":{"type":"string","format":"date-time","description":"Shipping Hold Date/Time"},"insuffElpsdDay":{"type":"string","description":"Out of Stock Elapsed Days"},"insuffQty":{"type":"integer","format":"int32","description":"Out of Stock Quantity"},"shipIndiDtm":{"type":"string","format":"date-time","description":"Shipment Instruction Date/Time"},"shipFnshDtm":{"type":"string","format":"date-time","description":"Shipment Completion Date/Time"},"ordFnshDtm":{"type":"string","format":"date-time","description":"Order Completion Date/Time"}}},"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":["Delivery Management"],"summary":"Retrieve Delivery Processing List","description":"## Function Description\n* Retrieves the delivery list on the Delivery Processing screen.\n---\n## Detailed Description\n* Used on the Delivery Instruction Processing, Shipment Instruction Processing, Shipment Completion Processing, Delivery Completion Processing, and Out-of-Stock Processing screens.\n* Only orders with a valid order quantity are retrieved. (Order Quantity - Cancelled Quantity > 0)\n* If the inflow channel is PO, only the corresponding vendor's data is retrieved.\n* Records whose order history status (OM005) is Order Cancelled (13), Return Cancelled (33), or Return Completed (37) are not retrieved.\n* The inquiry period can be up to a maximum of 30 days.\n","operationId":"getDeliveryMgmtList","parameters":[{"name":"deliveryMgmtCommonRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/DeliveryMgmtCommonRequest"}},{"name":"searchDateType","in":"query","description":"Search Period Type","required":true,"schema":{"type":"String"}},{"name":"startDate","in":"query","description":"Search Period (Start Date)","required":true,"schema":{"type":"LocalDate"}},{"name":"endDate","in":"query","description":"Search Period (End Date)","required":true,"schema":{"type":"LocalDate"}},{"name":"searchOrdDtlStatCd","in":"query","description":"Order Detail Status (OM005)","schema":{"type":"String"}},{"name":"searchDeliveryType","in":"query","description":"Delivery Information Type","schema":{"type":"String"}},{"name":"deliveryVal","in":"query","description":"Delivery Information Input Value","schema":{"type":"String"}},{"name":"deliKindCd","in":"query","description":"Delivery Type Code (LO009)","schema":{"type":"String"}},{"name":"entrNo","in":"query","description":"Vendor No.","schema":{"type":"String"}},{"name":"searchOrdManType","in":"query","description":"Orderer Information Type","schema":{"type":"String"}},{"name":"ordManVal","in":"query","description":"Orderer Information Input Value","schema":{"type":"String"}},{"name":"deliProcTypCd","in":"query","description":"Delivery Processing Type (PR008)","schema":{"type":"String"}},{"name":"hdcCd","in":"query","description":"Courier Company (LO005)","schema":{"type":"String"}},{"name":"shipWaitCaus","in":"query","description":"Shipping Hold Reason (LO007)","schema":{"type":"String"}}],"responses":{"200":{"description":"Delivery Management List Inquiry Successful","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RealGridListResponseDeliveryMgmtCommonResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```