Products Pricing Contact Us Blog Login Start for free

Real-time Shipment Tracking

You can get real-time shipment status information through this API without creating a tracking command. Real-time shipment tracking API will get the shipment information from the carrier and respond, the tracking details after you submit the tracking number. The information includes shipment route, shipment status, date, and time, etc.

Reminder: If you need to obtain massive tracking information and update the information regularly, please use the Create Tracking API and set up a webhook for receiving updates.

HTTP Request

POST:https://www.kd100.com/api/v1/tracking/realtime

Url

                                    POST
                                    https://www.kd100.com/api/v1/tracking/realtime
                                

Header

                                    Content-Type: application/json
API-Key: Enter your API Key here
signature: MD5(json+API-Key+SecretAccessKey)
                                

Request Parameters

NameData TypeRequiredNote
carrier_idstringtruecarrier ID
tracking_numberstringtruetracking number
phonestringfalsesender & recipient phone number (fill in with a mobile phone number or landline number)
ship_fromstringfalsesender city
ship_tostringfalserecipient city. The tracking frequency will be increased when the shipment arrives at the recipient city.
area_shownumberfalseAdding this field means using the administrative area determination feature.
0: close (default)
1: return data about area_name, location, order_status_description
orderstringfalsefalse Returned data sort: desc(default), asc.

Parameters

                                    {
    "carrier_id": "DHL",
    "tracking_number": "9926933413",
    "phone": "95279527",
    "ship_from": "Toronto, Canada",
    "ship_to": "Los Angeles, CA, United States",
    "area_show": 1,
    "order": "desc"
}
                                

Response

NameData TypeRequiredNote
codenumberfalsecode 200 means "ok."
messagestringfalseevent text
--dataobjectfalse
carrier_idstringtruecarrier ID
tracking_numberstringtruetracking number
order_status_codenumbertruethe latest shipment status
--itemsobject []false
contextstringtrueshipment route description
timestringtrueshipment route timestamp
order_status_descriptionstringfalseshipment status description. You need to set the parameter (area_show) value to "1" to use this feature.
area_namenullstringfalseshipment route area information. You need to set the parameter (area_show) value to ,"1," to use this feature.
locationnullstringfalseshipment route location information. You need to set the parameter (area_show) value to ,"1," to use this feature.

Response

20060101
                                      {
    "code": 200,
    "message": "OK",
    "data": {
      "carrier_id": "DHL",
      "tracking_number": "9926933413",
      "order_status_code": 4,
      "items": [
        {
          "context": "Partial delivery",
          "time": "2021-07-09 18:47:17",
          "order_status_description": "Delivered",
          "area_name": "null",
          "location": "null"
        },
        {
          "context": "With delivery courier",
          "time": "2021-07-09 18:47:02",
          "order_status_description": "Out for delivery",
          "area_name": "null",
          "location": "null"
        },
        {
          "context": "Arrived at Delivery Facility",
          "time": "2021-07-08 19:13:10",
          "order_status_description": "In transit",
          "area_name": "null",
          "location": "null"
        },
        {
          "context": "Shipment picked up",
          "time": "2021-05-25 04:57:39",
          "order_status_description": "Accepted",
          "area_name": null,
          "location": null
        }
      ]
    }
  }
                                
                                    {
    "code": 60101,     
    "message": "No result found" 
}