Overview

Guide

API Reference

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.

HTTP Request

POST：https://www.kd100.com/api/v1/tracking/create

Url

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

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
carrier_id	string	true	carrier ID
tracking_number	string	true	tracking number
ship_from	string	false	containing sender address information. It’s optional. Fill in it can improve the accuracy of the shipment status determination. The monitoring frequency will be increased after arriving at the destination area. Please provide the information as much as possible.
ship_to	string	false	containing recipient address information. It’s optional. Fill in it can improve the accuracy of the shipment status determination. The monitoring frequency will be increased after arriving at the destination area. Please provide the information as much as possible.
webhook_url	string	true	the URL to which we'll send webhook notifications.
area_show	number	false	Adding this field means using the administrative area determination feature. 0: close (default) 1: return data about area_name, location, order_status_description
phone	string	false	sender & recipient phone number (fill in with a mobile phone number or landline number)

Parameters

                                    {
  "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"
}

Response

Name	Data Type	Required	Note
code	number	false	code 200 means "ok."
message	string	false	event text

Response

20060201

                                    {
  "code": 200,     
  "message": "OK" 
}

                                    {
  "code": 60201,     
  "message": "Tracking already exists." 
}