Features Pricing Developers Company Blog Login Start for free

Create Tracking


You can use this API to add tracking numbers to KeyDelivery's tracking system. Then you can receive shipment status updates automatically with our webhooks. You must submit the following two parameters to use this feature, the carrier ID and the tracking number. Besides, you also need to use a webhook to receive the updated information.

We will track your orders after receiving the tracking number. When the shipment status changes, we will send the tracking information to you by using the webhooks until the life cycle of these tracking numbers ends (usually we will end the tracking when the shipment is "Delivered").

For some tracking requests, we will usually check the shipment status for the first time in 15 minutes after activating the Create Tracking API correctly. If there is no shipment status information about it in the first 15 minutes, we will check it every 4 hours and adjust the tracking frequency based on factors such as the status of the shipment.




Key Value
Content-Type application/json
API-Key Your API-Key, find on API management

How to generate a signature?

Use the JSON format of body parameters, concatenate them in the order of Body+API-Key+Secret, and then perform MD5 encryption, converting the encrypted results into string and uppercase.

Example: DC0491A58035AB355061F54CB57161E5



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


Name Data Type Required Note
carrier_id string true carrier ID
tracking_number string true tracking number
phone string false sender & recipient phone number (fill in with a mobile phone number or landline number)
ship_from string false sender city
ship_to string false recipient city. The tracking frequency will be increased when the shipment arrives at the recipient city.
area_show number false Adding this field means using the administrative area determination feature.
0: close (default)
1: the responses of items return data about order_status_code,order_status_description,location, area_name.
order string false false Returned data sort: desc(default), asc.


  "carrier_id": "usps",
  "tracking_number": "LY811679807CN",
  "ship_from": "Toronto, Canada",
  "ship_to": "Los Angeles, CA, United States",
  "webhook_url": "https://www.kd100.com/webhook_url",
  "area_show": 1,
  "phone": "95279527"


NameData TypeRequiredNote
codenumberfalsecode 200 means "ok."
messagestringfalseevent text


  "code": 200,     
  "message": "OK" 
  "code": 60201,     
  "message": "Tracking already exists." 



                                    # coding = utf-8

import hashlib
import json
import requests

class KuaiDi100:
    def __init__(self):
        self.API_Key = ''  # You can find your API Key on https://app.kd100.com/api-managment
        self.Secret = ''  # You can find your Secret on https://app.kd100.com/api-managment
        self.url = 'https://www.kd100.com/api/v1/tracking/create'

    def track(self, com, num, phone, ship_from, ship_to):
        Request Parameters
        :param carrier_id: carrier ID, you can find it on https://app.kd100.com/api-management
        :param tracking_number: tracking number
        :param phone: sender & recipient phone number (fill in with a mobile phone number or landline number)
        :param ship_from: sender city
        :param ship_to: recipient city. The tracking frequency will be increased when the shipment arrives at the recipient city.
        :param area_show: Adding this field means using the administrative area determination feature.0: close (default) 1: return data about area_name, location, order_status_description
        :param webhook_url: the URL to which we'll send webhook notifications.
        :return: requests.Response.text
        param = {
            'carrier_id': com,
            'tracking_number': num,
            'phone': phone,
            'ship_from': ship_from,
            'ship_to': ship_to,
            'area_show': 1,
            'webhook_url': 'https://www.kd100.com/webhook_url'

        param_str = json.dumps(param)
        temp_sign = param_str + self.API_Key + self.Secret
        md = hashlib.md5()
        sign = md.hexdigest().upper()

        headers = {
            'API-Key': self.API_Key,
            'signature': sign,
            'Content-Type': 'application/json'

        response = requests.request("POST", self.url, headers=headers, data=param_str)

        return response.text

result = KuaiDi100().track('usps', 'LY811679807CN', '95279527', 'Toronto, Canada', 'Los Angeles, CA, United States')
                                     'dhl',                // the carrier code, you can find from https://app.kd100.com/api-management
        'tracking_number' => '9926933413',    // The tracking number you want to query
        'ship_from' => '',                    // City of departure
        'ship_to' => '',                      // Destination city
        'webhook_url' => '',                  // the URL to which we'll send webhook notifications.
        'area_show' => 1,                     // 0: close (default); 1: return data about area_name, location, order_status_description
        'phone' => ''                         // Phone number
    // Request Json
    $json = json_encode($param, JSON_UNESCAPED_UNICODE);
    $signature = strtoupper(md5($json.$key.$secret));
    $url = 'https://www.kd100.com/api/v1/tracking/create';    // Create-tracking request address
echo 'request headers key: '.$key;
echo '
request headers signature: '.$signature; echo '
request json: '.$json; $headers = array ( 'Content-Type:application/json', 'API-Key:'.$key, 'signature:'.$signature, 'Content-Length:'.strlen($json) ); // Send post request $ch = curl_init(); curl_setopt($ch, CURLOPT_URL, $url); curl_setopt($ch, CURLOPT_HEADER, 0); curl_setopt($ch, CURLOPT_HTTPHEADER, $headers); curl_setopt($ch, CURLOPT_POST, 1); curl_setopt($ch, CURLOPT_POSTFIELDS, $json); curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1); curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false); curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false); $result = curl_exec($ch); $data = json_decode($result, true); echo '

Return data:
echo print_r($data);
//echo var_dump($data);
echo '
'; ?>
                                    import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.io.OutputStream;
import java.net.HttpURLConnection;
import java.net.URL;
import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException;

 * Create Tracking
 * @author https://www.kd100.com/
public class CreateTracking {

	private static final String URL = "https://www.kd100.com/api/v1/tracking/create";
	//You can find your ApiKey on https://app.kd100.com/api-managment
	private static final String API_KEY = "";
	//You can find your Secret on https://app.kd100.com/api-managment
	private static final String SECRET = "";
	private static final int CONNECT_TIMEOUT = 1000;
	private static final int READ_TIMEOUT = 5000;

	public static void main(String[] args) {
		String carrier_id = "dhl";
		String tracking_number = "9926933413";
		String phone = "95279527";
		String ship_from = "Toronto, Canada";
		String ship_to = "Los Angeles, CA, United States";
		String webhook_url = "https://www.kd100.com/webhook_url";

		CreateTracking demo = new CreateTracking();
		String result = demo.getData(carrier_id, tracking_number, phone, ship_from, ship_to,webhook_url);

	public String getData(String carrier_id, String tracking_number, String phone, String ship_from, String ship_to,String webhook_url) {

		String param = "{" +
				"\"carrier_id\": \""+carrier_id+"\"," +
				"\"tracking_number\": \""+tracking_number+"\"," +
				"\"phone\": \""+phone+"\"," +
				"\"ship_from\": \""+ship_from+"\"," +
				"\"ship_to\": \""+ship_to+"\"," +
				"\"area_show\": 1," +
				"\"webhook_url\": \""+webhook_url+"\"" +

		String signature = MD5Utils.encode(param + API_KEY + SECRET);
		return this.post(param,signature);

	public String post(String param,String signature) {
		StringBuffer response = new StringBuffer("");

		byte[] data = param.getBytes();

		BufferedReader reader = null;
		OutputStream out = null;
		try {

			URL url = new URL(URL);
			HttpURLConnection conn = (HttpURLConnection) url.openConnection();
			conn.setRequestProperty("accept", "*/*");
            conn.setRequestProperty("connection", "Keep-Alive");
			conn.setRequestProperty("Content-Type", "application/json");
			conn.setRequestProperty("Content-Length", String.valueOf(data.length));

			out = conn.getOutputStream();

			reader = new BufferedReader(new InputStreamReader(conn.getInputStream(), "UTF-8"));
			String line = "";
            while ((line = reader.readLine()) != null) {
		} catch (Exception e) {
		} finally {
			try {
				if (null != out){
				if (null != reader) {
			} catch (IOException e) {
		return response.toString();

 * md5 sign
class MD5Utils {
	private static MessageDigest mdigest = null;
	private static char digits[] = {'0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'A', 'B', 'C', 'D', 'E', 'F'};

	private static MessageDigest getMdInst() {
		if (null == mdigest) {
			try {
				mdigest = MessageDigest.getInstance("MD5");
			} catch (NoSuchAlgorithmException e) {
		return mdigest;

	public static String encode(String s) {
		if(null == s) {
			return "";

		try {
			byte[] bytes = s.getBytes();
			byte[] md = getMdInst().digest();
			int j = md.length;
			char str[] = new char[j * 2];
			int k = 0;
			for (int i = 0; i < j; i++) {
				byte byte0 = md[i];
				str[k++] = digits[byte0 >>> 4 & 0xf];
				str[k++] = digits[byte0 & 0xf];
			return new String(str);
		} catch (Exception e) {
			return null;