Ctrlk
X2BEE Home
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Delivery

Receive Waybill Tracking Information (BO)

post

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.

Header parameters
AuthorizationanyOptional

Access Token

Body
stringOptional
Responses
200

Success

*/*
stringOptional
post/v1/delivery/tracker/trackerCallback
POST /api/order/v1/delivery/tracker/trackerCallback HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 6

"text"
text

Look Up Delivery Region Group No.

post

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

Header parameters
AuthorizationanyOptional

Access Token

Body

Search Remote Area Status Request DTO

zipNostringOptional

Postal Code

Example: 5836
deliPolcNostringOptional

Delivery Policy No.

Example: 10000431
Responses
200

Success

*/*
stringOptional
post/v1/delivery/deliveryRegion/getDeliRegnGrpNo
POST /api/order/v1/delivery/deliveryRegion/getDeliRegnGrpNo HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "zipNo": 5836,
  "deliPolcNo": "10000431"
}
text

Check Whether Delivery Address Change Is Allowed

post

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

Header parameters
AuthorizationanyOptional

Access Token

Body

Order Delivery Address Change/Registration DTO

ordNostringRequired

Order No.

Example: 20230809O007943
clmNostringOptional

Claim No.

Example: 20230801C008072
systemTypestring · enumOptional

SYSTEM (System Type) * 10 : FO * 20 : BO

Example: 10Possible values:
mbrNostringOptional

Member No.

Example: 10000001
deliNostringRequired

Delivery No.

Example: 100008491
deliPolcNostringRequired

Delivery Policy No.

Example: 10000431
dlvpNmstringRequired

Delivery Address Name

Example: 집
rcvmnNmstringRequired

Recipient Name

Example: 홍길동
zipNoSeqinteger · int32Optional

Postal Code Sequence No.

Example: 1
zipNostringRequired

New Postal Code

Example: 8739
originZipNostringOptional

Previous Postal Code

Example: 5837
orginDlvpSeqstringOptional

Delivery Address Sequence No. Before Change

Example: 1
zipAddrstringRequired

Postal Address

Example: 서울 송파구 법원로9길
dtlAddrstringOptional

Detailed Address

Example: 에이치비지니스파크 D동 6층23
rcvmnCellSctNostringRequired

Recipient's Mobile Phone Prefix Code

Example: 010
rcvmnCellTxnoNostringRequired

Recipient's Mobile Phone Exchange Code

Example: 1234
rcvmnCellEndNostringRequired

Recipient's Mobile Phone Last Digits

Example: 5678
deliMsgstringOptional

Delivery Message

Example: 문 앞에 두고 가주세요.
deliMsgCdstringOptional

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

Example: 10
comnFrdrEtcMethodstringOptional

Other Common Entrance Access Method

Example: 자유출입가능
comnFrdrPwdstringOptional

Common Entrance Password

Example: 1234
comnFrdrCogoMethodCdstringOptional

Common Entrance Access Method Code (ME040) 10: Entrance access code, 20: Free access, 30: Other

Example: 10
deliGbCdstring · enumOptional

LO001(Delivery Type Code) * 10 : Shipment * 20 : Return

Example: 10Possible values:
dlvpSeqstringOptional

Delivery Sequence No.

Example: 1
rcvmnEmailAddrstringOptional

Recipient Email

Example: test@plateer.com
rcvmnTelRgnNostringOptional

Recipient's Phone Area Code

Example: 02
rcvmnTelTxnoNostringOptional

Recipient's Phone Exchange Code

Example: 1234
rcvmnTelEndNostringOptional

Recipient's Phone Last Digits

Example: 5678
frgnDirPurGoodsYnstringOptional

Overseas Direct Purchase Product Status

Responses
200

Success

*/*
booleanOptional
post/v1/delivery/deliveryRegion/deliveryRegionCheck
POST /api/order/v1/delivery/deliveryRegion/deliveryRegionCheck HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 715

{
  "ordNo": "20230809O007943",
  "clmNo": "20230801C008072",
  "systemType": "10",
  "mbrNo": "10000001",
  "deliNo": "100008491",
  "deliPolcNo": "10000431",
  "dlvpNm": "집",
  "rcvmnNm": "홍길동",
  "zipNoSeq": 1,
  "zipNo": 8739,
  "originZipNo": 5837,
  "orginDlvpSeq": "1",
  "zipAddr": "서울 송파구 법원로9길",
  "dtlAddr": "에이치비지니스파크 D동 6층23",
  "rcvmnCellSctNo": "010",
  "rcvmnCellTxnoNo": "1234",
  "rcvmnCellEndNo": "5678",
  "deliMsg": "문 앞에 두고 가주세요.",
  "deliMsgCd": "10",
  "comnFrdrEtcMethod": "자유출입가능",
  "comnFrdrPwd": "1234",
  "comnFrdrCogoMethodCd": "10",
  "deliGbCd": "10",
  "dlvpSeq": "1",
  "rcvmnEmailAddr": "test@plateer.com",
  "rcvmnTelRgnNo": "02",
  "rcvmnTelTxnoNo": "1234",
  "rcvmnTelEndNo": "5678",
  "frgnDirPurGoodsYn": "text"
}
true

Process Out-of-Stock (BO)

post

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

Header parameters
AuthorizationanyOptional

Access Token

Body

Out-of-Stock Processing Request Info

ordDtlStatCdstring · enumRequired

OM005 (Order Detail Status Code) 10: REPAY_REQ(Repayment Requested) ,11: ORDER_ACCEPT(Order Accepted) ,12: ORDER_COMPLETE(Order Completed) ,13: ORDER_CANCEL(Order Cancelled) ,21: DELIVERY_ORDER(Delivery Instructed) ,22: SHIPPING_ORDER(Shipment Instructed) ,23: SHIPPING_WAIT(Awaiting Shipment) ,25: SHIPPING_CONFIRM(Shipment Confirmed) ,26: SHIPPING_FINISH(Shipment Completed) ,27: DELIVERY_FINISH(Delivery Completed) ,31: RETURN_APPLY(Payment Pending) ,32: RETURN_ACCEPT(Return Accepted) ,33: RETURN_CANCEL(Return Cancelled) ,34: WITHDRAWAL_ORDER(Collection Instructed) ,35: WITHDRAWAL_CONFIRM(Collection Confirmed) ,36: WITHDRAWAL_FINISH(Collection Completed) ,37: RETURN_FINISH(Return Completed)

Example: 10Possible values:
targetOrdDtlStatCdstring · enumRequired

OM005 (Order Detail Status Code) 10: REPAY_REQ(Repayment Requested) ,11: ORDER_ACCEPT(Order Accepted) ,12: ORDER_COMPLETE(Order Completed) ,13: ORDER_CANCEL(Order Cancelled) ,21: DELIVERY_ORDER(Delivery Instructed) ,22: SHIPPING_ORDER(Shipment Instructed) ,23: SHIPPING_WAIT(Awaiting Shipment) ,25: SHIPPING_CONFIRM(Shipment Confirmed) ,26: SHIPPING_FINISH(Shipment Completed) ,27: DELIVERY_FINISH(Delivery Completed) ,31: RETURN_APPLY(Payment Pending) ,32: RETURN_ACCEPT(Return Accepted) ,33: RETURN_CANCEL(Return Cancelled) ,34: WITHDRAWAL_ORDER(Collection Instructed) ,35: WITHDRAWAL_CONFIRM(Collection Confirmed) ,36: WITHDRAWAL_FINISH(Collection Completed) ,37: RETURN_FINISH(Return Completed)

Example: 10Possible values:
Responses
200

Success

No content
post/v1/delivery/deliveryProcess/processInsuffDelivery
POST /api/order/v1/delivery/deliveryProcess/processInsuffDelivery HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 230

{
  "ordDtlStatCd": "10",
  "targetOrdDtlStatCd": "10",
  "insuffDeliveryProcessInfoList": [
    {
      "ordNo": "20230809O000001",
      "deliNo": "100000001",
      "ordSeq": 1,
      "ordProcSeq": 1,
      "shipWaitCaus": "10",
      "shipWaitCausCont": "수급물량부족",
      "insuffQty": 1
    }
  ]
}
No content

Process Delivery (BO)

post

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.

Header parameters
AuthorizationanyOptional

Access Token

Body

Delivery Processing Request DTO

ordDtlStatCdstring · enumRequired

OM005 (Order Detail Status Code) 10: REPAY_REQ(Repayment Requested) ,11: ORDER_ACCEPT(Order Accepted) ,12: ORDER_COMPLETE(Order Completed) ,13: ORDER_CANCEL(Order Cancelled) ,21: DELIVERY_ORDER(Delivery Instructed) ,22: SHIPPING_ORDER(Shipment Instructed) ,23: SHIPPING_WAIT(Awaiting Shipment) ,25: SHIPPING_CONFIRM(Shipment Confirmed) ,26: SHIPPING_FINISH(Shipment Completed) ,27: DELIVERY_FINISH(Delivery Completed) ,31: RETURN_APPLY(Payment Pending) ,32: RETURN_ACCEPT(Return Accepted) ,33: RETURN_CANCEL(Return Cancelled) ,34: WITHDRAWAL_ORDER(Collection Instructed) ,35: WITHDRAWAL_CONFIRM(Collection Confirmed) ,36: WITHDRAWAL_FINISH(Collection Completed) ,37: RETURN_FINISH(Return Completed)

Example: 10Possible values:
targetOrdDtlStatCdstring · enumRequired

OM005 (Order Detail Status Code) 10: REPAY_REQ(Repayment Requested) ,11: ORDER_ACCEPT(Order Accepted) ,12: ORDER_COMPLETE(Order Completed) ,13: ORDER_CANCEL(Order Cancelled) ,21: DELIVERY_ORDER(Delivery Instructed) ,22: SHIPPING_ORDER(Shipment Instructed) ,23: SHIPPING_WAIT(Awaiting Shipment) ,25: SHIPPING_CONFIRM(Shipment Confirmed) ,26: SHIPPING_FINISH(Shipment Completed) ,27: DELIVERY_FINISH(Delivery Completed) ,31: RETURN_APPLY(Payment Pending) ,32: RETURN_ACCEPT(Return Accepted) ,33: RETURN_CANCEL(Return Cancelled) ,34: WITHDRAWAL_ORDER(Collection Instructed) ,35: WITHDRAWAL_CONFIRM(Collection Confirmed) ,36: WITHDRAWAL_FINISH(Collection Completed) ,37: RETURN_FINISH(Return Completed)

Example: 10Possible values:
deliDtlStatCdstring · enumOptional

LO016(Delivery History Status Code) 10: DELIVERY_ORDER (Delivery Instruction) 11: SHIPPING_ORDER (Shipping Instruction) 12: SHIPPING_WAIT (Shipping Pending) 13: SHIPPING_CONFIRM (Shipping Confirmed) 14: SHIPPING_FINISH (Shipping Completed) 15: DELIVERY_FINISH (Delivery Completed) 20: WITHDRAWAL_ORDER (Pickup Instruction) 21: WITHDRAWAL_CONFIRM (Pickup Confirmed) 22: WITHDRAWAL_FINISH (Pickup Completed)

Example: 10Possible values:
targetDeliDtlStatCdstring · enumOptional

LO016(Delivery History Status Code) 10: DELIVERY_ORDER (Delivery Instruction) 11: SHIPPING_ORDER (Shipping Instruction) 12: SHIPPING_WAIT (Shipping Pending) 13: SHIPPING_CONFIRM (Shipping Confirmed) 14: SHIPPING_FINISH (Shipping Completed) 15: DELIVERY_FINISH (Delivery Completed) 20: WITHDRAWAL_ORDER (Pickup Instruction) 21: WITHDRAWAL_CONFIRM (Pickup Confirmed) 22: WITHDRAWAL_FINISH (Pickup Completed)

Example: 10Possible values:
Responses
200

Success

No content
post/v1/delivery/deliveryProcess/processDelivery
POST /api/order/v1/delivery/deliveryProcess/processDelivery HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 256

{
  "ordDtlStatCd": "10",
  "targetOrdDtlStatCd": "10",
  "deliDtlStatCd": "10",
  "targetDeliDtlStatCd": "10",
  "deliveryProcessInfoList": [
    {
      "ordNo": "20230809O000001",
      "ordSeq": 1,
      "shipQty": 1,
      "deliSeq": 1,
      "deliNo": "100000001",
      "hdcCd": "10",
      "invNo": "123456789123",
      "alimYn": "Y"
    }
  ]
}
No content

Process Receipt Confirmation (FO)

post

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.

Header parameters
AuthorizationanyOptional

Access Token

Body

FO Receipt Completion Processing Request DTO

ordDtlStatCdstringRequired

Original Order History Status Code

Example: 22
targetOrdDtlStatCdstringRequired

Changed Status

Example: 26
targetDeliDtlStatCdstring · enumRequired

LO016(Delivery History Status Code) 10: DELIVERY_ORDER (Delivery Instruction) 11: SHIPPING_ORDER (Shipping Instruction) 12: SHIPPING_WAIT (Shipping Pending) 13: SHIPPING_CONFIRM (Shipping Confirmed) 14: SHIPPING_FINISH (Shipping Completed) 15: DELIVERY_FINISH (Delivery Completed) 20: WITHDRAWAL_ORDER (Pickup Instruction) 21: WITHDRAWAL_CONFIRM (Pickup Confirmed) 22: WITHDRAWAL_FINISH (Pickup Completed)

Example: 10Possible values:
systemTypestringOptional

System Classification Code

Example: 10
ordNostringOptional

Order No.

Example: 20230809O000001
Responses
200

Success

No content
post/v1/delivery/deliveryProcess/processDeliveryFO
POST /api/order/v1/delivery/deliveryProcess/processDeliveryFO HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 279

{
  "ordDtlStatCd": "22",
  "targetOrdDtlStatCd": "26",
  "targetDeliDtlStatCd": "10",
  "systemType": "10",
  "ordNo": "20230809O000001",
  "deliveryProcessInfoList": [
    {
      "ordNo": "20230809O000001",
      "ordSeq": 1,
      "shipQty": 1,
      "deliSeq": 1,
      "deliNo": "100000001",
      "hdcCd": "10",
      "invNo": "123456789123",
      "alimYn": "Y"
    }
  ]
}
No content

Delivery Completion Instruction Batch (BATCH)

post

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.

Header parameters
AuthorizationanyOptional

Access Token

Bodyobject · DeliveryFinishInstructionInfo[]
ordNostringOptional
ordSeqinteger · int32Optional
ordProcSeqinteger · int32Optional
deliNostringOptional
deliSeqinteger · int32Optional
invNostringOptional
ordDtlStatCdstringOptional
Responses
200

Success

No content
post/v1/delivery/batchProcess/deliveryFinishInstructionProcess
POST /api/order/v1/delivery/batchProcess/deliveryFinishInstructionProcess HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 109

[
  {
    "ordNo": "text",
    "ordSeq": 1,
    "ordProcSeq": 1,
    "deliNo": "text",
    "deliSeq": 1,
    "invNo": "text",
    "ordDtlStatCd": "text"
  }
]
No content

Single Delivery Tracking

get

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)

Query parameters
fidstringRequired

string

Header parameters
AuthorizationanyOptional

Access Token

Responses
200

Success

application/json

Search Delivery Tracking Response DTO

completeYnstringOptional

Delivery Completion Status

Example: Y
hdcNmstringOptional

Courier Company Name

Example: CJ대한통운
invoiceNostringOptional

Invoice No.

Example: 1122410479
get/v1/delivery/tracker/deliveryTracking/{fid}
GET /api/order/v1/delivery/tracker/deliveryTracking/{fid}?fid=text HTTP/1.1
Host: api-order.x2bee.com/
Accept: */*

{
  "completeYn": "Y",
  "hdcNm": "CJ대한통운",
  "invoiceNo": "1122410479",
  "detailsList": [
    {
      "time": "2019-12-25 09:46:53",
      "where": "화성비봉발송",
      "kind": "화성비봉발송"
    }
  ]
}
PreviousCollection
NextOrder Claim Dashboard

Last updated