Overview

Guide

API Reference

Carrier Auto-detection

You can submit the courier tracking number through this API to determine the carrier ID to which the tracking number may belong. The returned data is a list of possible carrier IDs, and the carrier ID with high possibility ranks first.

Reminder: The tracking number of each carrier is constantly changing, and there is no standardized rule for tracking number naming. We cannot guarantee that the returned result is 100 percent accurate. Our existing mechanism uses our accumulated data to analyze each carrier’s tracking number naming rule and update the rules daily.

We will not provide legal commitments on the accuracy and validity of the returned result. If you provide this service to your users, it is recommended that you should use the following reminders when giving the tracking result to your users:

Add a description such as "Possible Results" or "Possible Results Powered by KeyDelivery" or "This Result Is for Reference Only."
The user can manually modify the carrier.

HTTP Request

POST：https://www.kd100.com/api/v1/carriers/detect

Url

                                    POST
                                    https://www.kd100.com/api/v1/carriers/detect

Header

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

Request Parameters

Name	Data Type	Required	Note
tracking_number	string	false	tracking number

Parameters

                                    {
  "tracking_number": "8247502336" 
}

Response

Name	Data Type	Required	Note
code	number	false	ok
message	string	false	event text
data	object []	false
carrier_id	string	true	carrier ID
carrier_name	string	true	carrier name

Response

200

                                    {
  "code": 200,
  "message": "OK",
  "data": [
    {
      "carrier_id": "dhl_de",
      "carrier_name": "DHL Deutschland"
    },
    {
      "carrier_id": "dhl_benelux",
      "carrier_name": "DHL Benelux"
    }
  ]
}