TrackingMore API

API key

In order to use this API, you need to generate a TrackingMore API key in the API Keys.Apply for free use of API.

The base URL

http://api.trackingmore.com/v2

Header

In order to verify and authenticate your application (e.g. your site), all of the requests that you make to the API must include your unique TrackingMore API Key header (Trackingmore-Api-Key), which you can generate and/or find in the TrackingMore Panel.

Content-Type: application/json
Trackingmore-Api-Key: YOUR_API_KEY

List of Tracking Status

StringDescription
pendingNew shipments added that are pending to track
notfoundItem is not found at this moment.
transitItem has shipped from originating and is en route to its destination
pickupItem is out for delivery or arrived at local facility, you may schedule for delivery or pickup
deliveredThe shipment was delivered sucessfully.
undeliveredCarrier attempted to deliver but failed, and usually leaves a notice and will try to delivery again.
exceptionItem might undergo unusual shipping condition, this may due to several reasons, most likely item was returned to sender, customs issue, lost, damaged etc.
expiredItem was in transportation period for a long time still has no delivered results.

Typical Server Responses

We will respond with one of the following status codes.

CodeDescription
200OK - The request was successful (some API calls may return 201 instead).
201Created - The request was successful and a resource was created.
202Created - The request was successful but exceeding the limit.
401Unauthorized - Authentication failed or user does not have permissions for the requested operation.
4001Unauthorized - Invalid API key.
4002Unauthorized - API key has been deleted.
4012Bad Request - The request could not be understood or was missing required parameters.
4013Bad Request - Tracking_number is required.
4014Bad Request - The value of `tracking_number` is invalid.
4015Bad Request - The value of `carrier_code` is invalid.
4016Bad Request - Tracking already exists.
4017Bad Request - Tracking does not exist.
4018Bad Request - Due to overload risks this feature requires custom activation. Contact [email protected] for more information.
4020Bad Request - Up to 200 at a time
4021Bad Request - Your remaining balance is not enough, so you can not call the API request data.
4031No Content - The request was successful but the response is empty.
4032No Content - Cannot detect courier.
4033No Content - The value of `status` is invalid.
402Payment Required - Payment required.
403Forbidden - Access denied.
404Not Found - Resource was not found.
405Method Not Allowed - Requested method is not supported for the specified resource.
409Conflict - The request could not be completed due to a conflict.
429Too Many Requests - Exceeded API limits. Pause requests, wait two minute, and try again.
500Server error
503Service Unavailable - The service is temporary unavailable (e.g. scheduled Platform Maintenance). Try again later.

Request Rate Limiting

We do have a small amount of rate limit. Please be aware that if you exceed these limits, you will receive a 429 error prompt..

  • Real-time tracking: each IP, maximum 3 requests per second.

  • List all trackings; each IP, maximum 1 request with up to 2000 trackings per second.