Delivery Management
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.
Out-of-Stock Processing Request DTO
Original Order History Status Code (OM005) 22: Shipment Instructed, 23: Awaiting Shipment
22Target Order History Status Code (OM005) 22: Shipment Instructed, 23: Awaiting Shipment
26Out-of-Stock Processing Successful
No content
Business processing error details
POST /api/bo/v1/delivery/deliveryCommon/processInsuffDelivery HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 222
{
"ordDtlStatCd": 22,
"targetOrdDtlStatCd": 26,
"insuffDeliveryProcessInfoList": [
{
"ordNo": "20230809O000001",
"deliNo": 100000001,
"ordSeq": 1,
"ordProcSeq": 1,
"shipWaitCaus": 10,
"shipWaitCausCont": "수급물량부족",
"insuffQty": 1
}
]
}No content
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)
Delivery instruction: 12 (Order Completed) -> 21 (Delivery Instructed)
Shipment instruction: 21 (Delivery Instructed) -> 22 (Shipment Instructed)
Shipment completion: 22 (Shipment Instructed) -> 26 (Shipment Completed)
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.
Delivery Processing Request DTO
Original Order History Status Code (OM005)
22Possible values: Target Order History Status Code (OM005)
26Possible values: Original Delivery History Status Code (LO016)
22Target Delivery History Status Code (LO016)
26Delivery Processing Successful
No content
Business processing error details
POST /api/bo/v1/delivery/deliveryCommon/processDelivery HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 239
{
"ordDtlStatCd": 22,
"targetOrdDtlStatCd": 26,
"deliDtlStatCd": 22,
"targetDeliDtlStatCd": 26,
"deliveryProcessInfoList": [
{
"ordNo": "20230816O009106",
"ordSeq": 1,
"shipQty": 1,
"deliSeq": 1,
"deliNo": 100016628,
"hdcCd": 10,
"invNo": 123456789,
"alimYn": "Y"
}
]
}No content
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.
Search Period Type
Search Period (Start Date)
Search Period (End Date)
Order Detail Status (OM005)
Delivery Information Type
Delivery Information Input Value
Delivery Type Code (LO009)
Vendor No.
Orderer Information Type
Orderer Information Input Value
Delivery Processing Type (PR008)
Courier Company (LO005)
Shipping Hold Reason (LO007)
Delivery Management List Inquiry Successful
Business processing error details
GET /api/bo/v1/delivery/deliveryCommon/getDeliveryMgmtList?deliveryMgmtCommonRequest=[object+Object]&searchDateType=null&startDate=null&endDate=null HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"totalCount": 1,
"payloads": [
{
"ordNo": "20230816O009106",
"ordSeq": 1,
"ordProcSeq": 1,
"deliNo": 100016628,
"deliSeq": 1,
"ordGbCd": 10,
"ordAccpDtm": "2023-12-31 00:00:00",
"ordDtlGbCd": 10,
"ordDtlStatCd": 22,
"ordDtlStatCdNm": "배송완료",
"deliKindCd": 10,
"deliProcTypCd": 10,
"hdcCd": 10,
"hdcCdNm": "CJ대한통운",
"invNo": 123456789,
"ordSaleTypCd": 10,
"partShipYn": "Y",
"goodsNo": 100000001,
"goodsNm": "상품명",
"itmNo": "001",
"itmNm": "파랑",
"prestNm": "우산 증정",
"ordQty": 1,
"preShipQty": 1,
"shipNeedQty": 1,
"shipQty": 1,
"norPrc": 2500,
"salePrc": 2500,
"entrNm": "협력사1",
"loginId": "x2admin",
"mbrNo": 100001311,
"ordManNm": "홍길동",
"ordManCellNo": "010-xxxx-5678",
"ordManCellSctNo": "010",
"ordManCellTxnoNo": 1234,
"ordManCellEndNo": 3546,
"rcvmnNm": "홍길동",
"rcvmnCellNo": "010-xxxx-5678",
"rcvmnCellSctNo": "010",
"rcvmnCellTxnoNo": 1234,
"rcvmnCellEndNo": 3546,
"zipAddr": "서울 송파구 법원로9길 26",
"dtlAddr": "에이치비지니스파크 D동 6층",
"deliMsgCd": "배송 전 연락 바랍니다",
"deliMsg": "벨X, 노크X",
"deliIndiDtm": "2023-12-31 00:00:00",
"shipWaitCaus": "재고있지만출고불가능",
"shipWaitCausCont": "불량품",
"shipWaitDtm": "2023-12-31 00:00:00",
"insuffElpsdDay": 1,
"insuffQty": 1,
"shipIndiDtm": "2023-12-31 00:00:00",
"shipFnshDtm": "2023-12-31 00:00:00",
"ordFnshDtm": "2023-12-31 00:00:00"
}
]
}Last updated