> 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/store-front-api-reference/order-api/delivery.md).
# Delivery
## Receive Waybill Tracking Information (BO)
> \## Function Description\
> \* Receives waybill information from an external delivery tracking system.\
> \---\
> \## Detailed Description\
> \* Receives information from an external delivery tracking system, and if delivery is complete, changes the order history status to delivery complete.\
> \* A controller that integrates with SweetTracker (an external system).\
> \* The identifier used to integrate with SweetTracker is the delivery number.\
> \* Requests/responses are processed in JSON format.
```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":["Delivery"],"summary":"Receive Waybill Tracking Information (BO)","description":"## Function Description\n* Receives waybill information from an external delivery tracking system.\n---\n## Detailed Description\n* Receives information from an external delivery tracking system, and if delivery is complete, changes the order history status to delivery complete.\n* A controller that integrates with SweetTracker (an external system).\n* The identifier used to integrate with SweetTracker is the delivery number.\n* Requests/responses are processed in JSON format.\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":"Success","content":{"*/*":{"schema":{"type":"string"}}}},"900":{"description":"Business processing error details","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"}}}}
```
## Look Up Delivery Region Group No.
> \## Function Description\
> \* Looks up whether a delivery address is in a remote area.\
> \---\
> \## Detailed Description\
> \* Looks up the delivery region group number using the delivery address's postal code.\
> \* If additional delivery fees apply, returns the delivery region group number.\
> \---\
> \## Revision History\
> \* \`\`\`Release v2.00\_240711\`\`\`: Applied additional delivery fees by delivery region group
````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":["Delivery"],"summary":"Look Up Delivery Region Group No.","description":"## Function Description\n* Looks up whether a delivery address is in a remote area.\n---\n## Detailed Description\n* Looks up the delivery region group number using the delivery address's postal code.\n* If additional delivery fees apply, returns the delivery region group number.\n---\n## Revision History\n* ```Release v2.00_240711```: Applied additional delivery fees by delivery region group\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":"Success","content":{"*/*":{"schema":{"type":"string"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"components":{"schemas":{"DeliveryRegionCheckRequest":{"type":"object","properties":{"zipNo":{"type":"string","description":"Postal Code"},"deliPolcNo":{"type":"string","description":"Delivery Policy No."}},"description":"Search Remote Area Status 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"}}}}
````
## Check Whether Delivery Address Change Is Allowed
> \## Function Description\
> \* Looks up whether the delivery address can be changed.\
> \---\
> \## Detailed Description\
> \* Looks up the additional delivery fee using the postal code and delivery policy number.\
> \* The delivery address can be changed to a delivery region group with the same additional delivery fee amount.\
> \---\
> \## Revision History\
> \* \`\`\`Release v2.00\_240711\`\`\`: Modified to allow delivery address changes to a delivery region group with the same additional delivery fee amount
````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":["Delivery"],"summary":"Check Whether Delivery Address Change Is Allowed","description":"## Function Description\n* Looks up whether the delivery address can be changed.\n---\n## Detailed Description\n* Looks up the additional delivery fee using the postal code and delivery policy number.\n* The delivery address can be changed to a delivery region group with the same additional delivery fee amount.\n---\n## Revision History\n* ```Release v2.00_240711```: Modified to allow delivery address changes to a delivery region group with the same additional delivery fee amount\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":"Success","content":{"*/*":{"schema":{"type":"boolean"}}}},"900":{"description":"Business processing error details","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":"Order No."},"clmNo":{"type":"string","description":"Claim No."},"systemType":{"type":"string","description":" SYSTEM (System Type)\n * 10 : FO\n * 20 : BO\n","enum":["FO","BO"]},"mbrNo":{"type":"string","description":"Member No."},"deliNo":{"type":"string","description":"Delivery No."},"deliPolcNo":{"type":"string","description":"Delivery Policy No."},"dlvpNm":{"type":"string","description":"Delivery Address Name"},"rcvmnNm":{"type":"string","description":"Recipient Name"},"zipNoSeq":{"type":"integer","description":"Postal Code Sequence No.","format":"int32"},"zipNo":{"type":"string","description":"New Postal Code"},"originZipNo":{"type":"string","description":"Previous Postal Code"},"orginDlvpSeq":{"type":"string","description":"Delivery Address Sequence No. Before Change"},"zipAddr":{"type":"string","description":"Postal Address"},"dtlAddr":{"type":"string","description":"Detailed Address"},"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"},"deliMsg":{"type":"string","description":"Delivery Message"},"deliMsgCd":{"type":"string","description":"Delivery Message Code (ME039) 10: No delivery message, 20: Please call before delivery, 30: Leave at the door if absent, 40: Leave with security desk if absent, 50: Please deliver quickly, 60: Please call my mobile if absent, 70: Enter manually"},"comnFrdrEtcMethod":{"type":"string","description":"Other Common Entrance Access Method"},"comnFrdrPwd":{"type":"string","description":"Common Entrance Password"},"comnFrdrCogoMethodCd":{"type":"string","description":"Common Entrance Access Method Code (ME040) 10: Entrance access code, 20: Free access, 30: Other"},"deliGbCd":{"type":"string","description":" LO001(Delivery Type Code)\n * 10 : Shipment\n * 20 : Return\n","enum":["SHIPPING","WITHDRAWAL"]},"dlvpSeq":{"type":"string","description":"Delivery Sequence No."},"rcvmnEmailAddr":{"type":"string","description":"Recipient Email"},"rcvmnTelRgnNo":{"type":"string","description":"Recipient's Phone Area Code"},"rcvmnTelTxnoNo":{"type":"string","description":"Recipient's Phone Exchange Code"},"rcvmnTelEndNo":{"type":"string","description":"Recipient's Phone Last Digits"},"frgnDirPurGoodsYn":{"type":"string","description":"Overseas Direct Purchase Product Status"}},"description":"Order Delivery Address Change/Registration 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"}}}}
````
## Process Out-of-Stock (BO)
> \## Function Description\
> \* \[BO] Processes out-of-stock handling.\
> \---\
> \## Detailed Description\
> \* The original order history status code (ordDtlStatCd:OM005), the 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)\
> \* Register out-of-stock: 22 (Shipment Instructed) -> 23 (Awaiting Shipment)\
> \* Release out-of-stock: 23 (Awaiting Shipment) -> 22 (Shipment Instructed)\
> \* Processes registering and releasing out-of-stock status.\
> \* Takes the original order history status code and the target order history status code as request values, looks up and validates the original order history status code list, then updates to the target order history status code.\
> \* A delivery-delay notification (notification message, notification inbox) is sent to the orderer after registering out-of-stock status.\
> \* Automatically registered to the Customer Center OB list after registering out-of-stock status.\
> \---\
> \## Revision History\
> \* Release v1.01\_251030: Added status-change validation check for the requested list when registering/releasing out-of-stock status
```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":["Delivery"],"summary":"Process Out-of-Stock (BO)","description":"## Function Description\n* [BO] Processes out-of-stock handling.\n---\n## Detailed Description\n* The original order history status code (ordDtlStatCd:OM005), the 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 * Register out-of-stock: 22 (Shipment Instructed) -> 23 (Awaiting Shipment)\n * Release out-of-stock: 23 (Awaiting Shipment) -> 22 (Shipment Instructed)\n* Processes registering and releasing out-of-stock status.\n* Takes the original order history status code and the target order history status code as request values, looks up and validates the original order history status code list, then updates to the target order history status code.\n* A delivery-delay notification (notification message, notification inbox) is sent to the orderer after registering out-of-stock status.\n* Automatically registered to the Customer Center OB list after registering out-of-stock status.\n---\n## Revision History\n* Release v1.01_251030: Added status-change validation check for the requested list when registering/releasing out-of-stock status\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":"Success"},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"components":{"schemas":{"InsuffDeliveryProcessRequest":{"required":["insuffDeliveryProcessInfoList","ordDtlStatCd","targetOrdDtlStatCd"],"type":"object","properties":{"ordDtlStatCd":{"type":"string","description":"OM005 (Order Detail Status Code)\n 10: REPAY_REQ(Repayment Requested)\n,11: ORDER_ACCEPT(Order Accepted)\n,12: ORDER_COMPLETE(Order Completed)\n,13: ORDER_CANCEL(Order Cancelled)\n,21: DELIVERY_ORDER(Delivery Instructed)\n,22: SHIPPING_ORDER(Shipment Instructed)\n,23: SHIPPING_WAIT(Awaiting Shipment)\n,25: SHIPPING_CONFIRM(Shipment Confirmed)\n,26: SHIPPING_FINISH(Shipment Completed)\n,27: DELIVERY_FINISH(Delivery Completed)\n,31: RETURN_APPLY(Payment Pending)\n,32: RETURN_ACCEPT(Return Accepted)\n,33: RETURN_CANCEL(Return Cancelled)\n,34: WITHDRAWAL_ORDER(Collection Instructed)\n,35: WITHDRAWAL_CONFIRM(Collection Confirmed)\n,36: WITHDRAWAL_FINISH(Collection Completed)\n,37: RETURN_FINISH(Return Completed)\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 (Order Detail Status Code)\n 10: REPAY_REQ(Repayment Requested)\n,11: ORDER_ACCEPT(Order Accepted)\n,12: ORDER_COMPLETE(Order Completed)\n,13: ORDER_CANCEL(Order Cancelled)\n,21: DELIVERY_ORDER(Delivery Instructed)\n,22: SHIPPING_ORDER(Shipment Instructed)\n,23: SHIPPING_WAIT(Awaiting Shipment)\n,25: SHIPPING_CONFIRM(Shipment Confirmed)\n,26: SHIPPING_FINISH(Shipment Completed)\n,27: DELIVERY_FINISH(Delivery Completed)\n,31: RETURN_APPLY(Payment Pending)\n,32: RETURN_ACCEPT(Return Accepted)\n,33: RETURN_CANCEL(Return Cancelled)\n,34: WITHDRAWAL_ORDER(Collection Instructed)\n,35: WITHDRAWAL_CONFIRM(Collection Confirmed)\n,36: WITHDRAWAL_FINISH(Collection Completed)\n,37: RETURN_FINISH(Return Completed)\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":"Out-of-Stock Processing Request List","items":{"$ref":"#/components/schemas/InsuffDeliveryProcessInfo"}}},"description":"Out-of-Stock Processing Request Info"},"InsuffDeliveryProcessInfo":{"required":["deliNo","ordNo","ordProcSeq","ordSeq","shipWaitCaus"],"type":"object","properties":{"ordNo":{"type":"string","description":"Order No."},"deliNo":{"type":"string","description":"Delivery No."},"ordSeq":{"type":"integer","description":"Order Sequence No.","format":"int32"},"ordProcSeq":{"type":"integer","description":"Order Processing Sequence No.","format":"int32"},"shipWaitCaus":{"type":"string","description":"Out-of-Stock Reason (LO007)"},"shipWaitCausCont":{"type":"string","description":"Out-of-Stock Detail Reason"},"insuffQty":{"type":"integer","description":"Out of Stock Quantity","format":"int32"}},"description":"Out-of-Stock Processing Info"},"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"}}}}
```
## Process Delivery (BO)
> \## Function Description\
> \* \[BO] Processes delivery.\
> \---\
> \## Detailed Description\
> \* The original order history status code (ordDtlStatCd:OM005), the 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 completed: 22 (Shipment Instructed) -> 26 (Shipment Completed)\
> \* Delivery completed: 26 (Shipment Completed) -> 27 (Delivery Completed)\
> \* Processes delivery instruction, shipment instruction, shipment completion, and delivery completion.\
> \* Takes the original order history status code and the target order history status code as request values, looks up and validates the original order history status code list, then updates to the target order history status code.\
> \* A notification (notification message, notification inbox) is sent to the orderer after shipment completion.\
> \* An email notification is sent upon shipment completion for an exchange order.
```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":["Delivery"],"summary":"Process Delivery (BO)","description":"## Function Description\n* [BO] Processes delivery.\n---\n## Detailed Description\n* The original order history status code (ordDtlStatCd:OM005), the 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 completed: 22 (Shipment Instructed) -> 26 (Shipment Completed)\n * Delivery completed: 26 (Shipment Completed) -> 27 (Delivery Completed)\n* Processes delivery instruction, shipment instruction, shipment completion, and delivery completion.\n* Takes the original order history status code and the target order history status code as request values, looks up and validates the original order history status code list, then updates to the target order history status code.\n* A notification (notification message, notification inbox) is sent to the orderer after shipment completion.\n* An email notification is sent upon shipment completion for an exchange order.\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":"Success"},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"components":{"schemas":{"DeliveryProcessRequest":{"required":["deliveryProcessInfoList","ordDtlStatCd","targetOrdDtlStatCd"],"type":"object","properties":{"ordDtlStatCd":{"type":"string","description":"OM005 (Order Detail Status Code)\n 10: REPAY_REQ(Repayment Requested)\n,11: ORDER_ACCEPT(Order Accepted)\n,12: ORDER_COMPLETE(Order Completed)\n,13: ORDER_CANCEL(Order Cancelled)\n,21: DELIVERY_ORDER(Delivery Instructed)\n,22: SHIPPING_ORDER(Shipment Instructed)\n,23: SHIPPING_WAIT(Awaiting Shipment)\n,25: SHIPPING_CONFIRM(Shipment Confirmed)\n,26: SHIPPING_FINISH(Shipment Completed)\n,27: DELIVERY_FINISH(Delivery Completed)\n,31: RETURN_APPLY(Payment Pending)\n,32: RETURN_ACCEPT(Return Accepted)\n,33: RETURN_CANCEL(Return Cancelled)\n,34: WITHDRAWAL_ORDER(Collection Instructed)\n,35: WITHDRAWAL_CONFIRM(Collection Confirmed)\n,36: WITHDRAWAL_FINISH(Collection Completed)\n,37: RETURN_FINISH(Return Completed)\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 (Order Detail Status Code)\n 10: REPAY_REQ(Repayment Requested)\n,11: ORDER_ACCEPT(Order Accepted)\n,12: ORDER_COMPLETE(Order Completed)\n,13: ORDER_CANCEL(Order Cancelled)\n,21: DELIVERY_ORDER(Delivery Instructed)\n,22: SHIPPING_ORDER(Shipment Instructed)\n,23: SHIPPING_WAIT(Awaiting Shipment)\n,25: SHIPPING_CONFIRM(Shipment Confirmed)\n,26: SHIPPING_FINISH(Shipment Completed)\n,27: DELIVERY_FINISH(Delivery Completed)\n,31: RETURN_APPLY(Payment Pending)\n,32: RETURN_ACCEPT(Return Accepted)\n,33: RETURN_CANCEL(Return Cancelled)\n,34: WITHDRAWAL_ORDER(Collection Instructed)\n,35: WITHDRAWAL_CONFIRM(Collection Confirmed)\n,36: WITHDRAWAL_FINISH(Collection Completed)\n,37: RETURN_FINISH(Return Completed)\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(Delivery History Status Code)\n 10: DELIVERY_ORDER (Delivery Instruction)\n 11: SHIPPING_ORDER (Shipping Instruction)\n 12: SHIPPING_WAIT (Shipping Pending)\n 13: SHIPPING_CONFIRM (Shipping Confirmed)\n 14: SHIPPING_FINISH (Shipping Completed)\n 15: DELIVERY_FINISH (Delivery Completed)\n 20: WITHDRAWAL_ORDER (Pickup Instruction)\n 21: WITHDRAWAL_CONFIRM (Pickup Confirmed)\n 22: WITHDRAWAL_FINISH (Pickup Completed)\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(Delivery History Status Code)\n 10: DELIVERY_ORDER (Delivery Instruction)\n 11: SHIPPING_ORDER (Shipping Instruction)\n 12: SHIPPING_WAIT (Shipping Pending)\n 13: SHIPPING_CONFIRM (Shipping Confirmed)\n 14: SHIPPING_FINISH (Shipping Completed)\n 15: DELIVERY_FINISH (Delivery Completed)\n 20: WITHDRAWAL_ORDER (Pickup Instruction)\n 21: WITHDRAWAL_CONFIRM (Pickup Confirmed)\n 22: WITHDRAWAL_FINISH (Pickup Completed)\n","enum":["DELIVERY_ORDER","SHIPPING_ORDER","SHIPPING_WAIT","SHIPPING_CONFIRM","SHIPPING_FINISH","DELIVERY_FINISH","WITHDRAWAL_ORDER","WITHDRAWAL_CONFIRM","WITHDRAWAL_FINISH"]},"deliveryProcessInfoList":{"type":"array","description":"Delivery Processing List","items":{"$ref":"#/components/schemas/DeliveryProcessInfo"}}},"description":"Delivery Processing Request DTO"},"DeliveryProcessInfo":{"required":["deliNo"],"type":"object","properties":{"ordNo":{"type":"string","description":"Order No."},"ordSeq":{"type":"integer","description":"Order Sequence No.","format":"int32"},"shipQty":{"type":"integer","description":"Shipment Quantity","format":"int32"},"deliSeq":{"type":"integer","description":"Delivery Sequence No.","format":"int32"},"deliNo":{"type":"string","description":"Delivery No."},"hdcCd":{"type":"string","description":"LO005 (Delivery Carrier Code)\n 10: CJ (CJ Logistics)\n,11: EPOST (Korea Post)\n,12: GOODSTOLUCK (GoodToLuck)\n,13: DHL (DHL)\n,14: LOGEN (Logen)\n,30: VROONG (Vroong)\n,31: GOGOVAN (GoGoVan)\n","enum":["CJ","EPOST","GOODSTOLUCK","DHL","LOGEN","VROONG","GOGOVAN"]},"invNo":{"type":"string","description":"Invoice No."},"alimYn":{"type":"string","description":"Notification Message Status"}},"description":"Delivery Processing Info"},"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"}}}}
```
## Process Receipt Confirmation (FO)
> \## Function Description\
> \* \[FO] Processes order delivery completion.\
> \---\
> \## Detailed Description\
> \* Marks a single order as delivery-completed.\
> \* Passes the original order's order history status code and the status code to change to (Delivery Completed: 27) and updates it to delivery-completed status.
```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":["Delivery"],"summary":"Process Receipt Confirmation (FO)","description":" ## Function Description\n * [FO] Processes order delivery completion.\n ---\n ## Detailed Description\n * Marks a single order as delivery-completed.\n * Passes the original order's order history status code and the status code to change to (Delivery Completed: 27) and updates it to delivery-completed status.\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":"Success"},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"components":{"schemas":{"DeliveryProcessFORequest":{"required":["deliveryProcessInfoList","ordDtlStatCd","targetDeliDtlStatCd","targetOrdDtlStatCd"],"type":"object","properties":{"ordDtlStatCd":{"type":"string","description":"Original Order History Status Code"},"targetOrdDtlStatCd":{"type":"string","description":"Changed Status"},"targetDeliDtlStatCd":{"type":"string","description":"LO016(Delivery History Status Code)\n 10: DELIVERY_ORDER (Delivery Instruction)\n 11: SHIPPING_ORDER (Shipping Instruction)\n 12: SHIPPING_WAIT (Shipping Pending)\n 13: SHIPPING_CONFIRM (Shipping Confirmed)\n 14: SHIPPING_FINISH (Shipping Completed)\n 15: DELIVERY_FINISH (Delivery Completed)\n 20: WITHDRAWAL_ORDER (Pickup Instruction)\n 21: WITHDRAWAL_CONFIRM (Pickup Confirmed)\n 22: WITHDRAWAL_FINISH (Pickup Completed)\n","enum":["DELIVERY_ORDER","SHIPPING_ORDER","SHIPPING_WAIT","SHIPPING_CONFIRM","SHIPPING_FINISH","DELIVERY_FINISH","WITHDRAWAL_ORDER","WITHDRAWAL_CONFIRM","WITHDRAWAL_FINISH"]},"systemType":{"type":"string","description":"System Classification Code"},"ordNo":{"type":"string","description":"Order No."},"deliveryProcessInfoList":{"type":"array","description":"Delivery Processing Target Info","items":{"$ref":"#/components/schemas/DeliveryProcessInfo"}}},"description":"FO Receipt Completion Processing Request DTO"},"DeliveryProcessInfo":{"required":["deliNo"],"type":"object","properties":{"ordNo":{"type":"string","description":"Order No."},"ordSeq":{"type":"integer","description":"Order Sequence No.","format":"int32"},"shipQty":{"type":"integer","description":"Shipment Quantity","format":"int32"},"deliSeq":{"type":"integer","description":"Delivery Sequence No.","format":"int32"},"deliNo":{"type":"string","description":"Delivery No."},"hdcCd":{"type":"string","description":"LO005 (Delivery Carrier Code)\n 10: CJ (CJ Logistics)\n,11: EPOST (Korea Post)\n,12: GOODSTOLUCK (GoodToLuck)\n,13: DHL (DHL)\n,14: LOGEN (Logen)\n,30: VROONG (Vroong)\n,31: GOGOVAN (GoGoVan)\n","enum":["CJ","EPOST","GOODSTOLUCK","DHL","LOGEN","VROONG","GOGOVAN"]},"invNo":{"type":"string","description":"Invoice No."},"alimYn":{"type":"string","description":"Notification Message Status"}},"description":"Delivery Processing Info"},"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"}}}}
```
## Delivery Completion Instruction Batch (BATCH)
> \## Function Description\
> \* Performs bulk batch processing for delivery completion instructions.\
> \---\
> \## Detailed Description\
> \* Marks orders requested from the batch service, whose shipment is complete, as delivery-completed.\
> \* Marks orders with order history status (OM005) Shipment Completed (26) as Delivery Completed (27).\
> \* Processes orders for which a certain number of days (ST004: Auto Delivery Completion Processing REF\_1\_VAL value) have passed since shipment completion.\
> \* Order number, delivery number, and the delivery-completion target list are required.\
> \* The list is processed in batches of 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":["Delivery"],"summary":"Delivery Completion Instruction Batch (BATCH)","description":"## Function Description\n* Performs bulk batch processing for delivery completion instructions.\n---\n## Detailed Description\n* Marks orders requested from the batch service, whose shipment is complete, as delivery-completed.\n* Marks orders with order history status (OM005) Shipment Completed (26) as Delivery Completed (27).\n* Processes orders for which a certain number of days (ST004: Auto Delivery Completion Processing REF_1_VAL value) have passed since shipment completion.\n* Order number, delivery number, and the delivery-completion target list are required.\n* The list is processed in batches of 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":"Success"},"900":{"description":"Business processing error details","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"}}}}
```
## Single Delivery Tracking
> \## Function Description\
> \* Retrieves the delivery status.\
> \---\
> \## Detailed Description\
> \* Retrieves the current delivery status using the delivery number (single).\
> \* Retrieved by integrating with SweetTracker (external system).\
> \* Returns the completion status, courier company name, tracking number, and delivery details (progress time, location, progress status) as the response.\
> \* The delivery number is the identifier used to integrate with SweetTracker.\
> \## Revision History\
> \* Release v2.00\_240401: Developed SweetTracker lookup for event delivery products\
> \* Release v2.00\_250618: Changed the logic that looks up hdc using fid (to support the split shipment DB change)
```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":["Delivery"],"summary":"Single Delivery Tracking","description":"## Function Description\n* Retrieves the delivery status.\n---\n## Detailed Description\n* Retrieves the current delivery status using the delivery number (single).\n* Retrieved by integrating with SweetTracker (external system).\n* Returns the completion status, courier company name, tracking number, and delivery details (progress time, location, progress status) as the response.\n* The delivery number is the identifier used to integrate with SweetTracker.\n## Revision History\n* Release v2.00_240401: Developed SweetTracker lookup for event delivery products\n* Release v2.00_250618: Changed the logic that looks up hdc using fid (to support the split shipment DB change)\n","operationId":"deliveryTracking","parameters":[{"name":"fid","in":"query","description":"Delivery No.","required":true,"schema":{"type":"string","description":"string"}},{"name":"Authorization","in":"header","description":"Access Token","required":false}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TrackerTrackingInfoResponse"}}}},"900":{"description":"Business processing error details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"components":{"schemas":{"TrackerTrackingInfoResponse":{"type":"object","properties":{"completeYn":{"type":"string","description":"Delivery Completion Status"},"hdcNm":{"type":"string","description":"Courier Company Name"},"invoiceNo":{"type":"string","description":"Invoice No."},"detailsList":{"type":"array","description":"Delivery Tracking Detail Info","items":{"$ref":"#/components/schemas/TrackerTrackingDetailsResponse"}}},"description":"Search Delivery Tracking Response DTO"},"TrackerTrackingDetailsResponse":{"type":"object","properties":{"time":{"type":"string","description":"Progress Time"},"where":{"type":"string","description":"Progress Location (Branch)"},"kind":{"type":"string","description":"Progress Status"}},"description":"Search Delivery Tracking Response Detail 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"}}}}
```