Overview
IQAX Tracking Link allows you
| 1 | Tracking shipment quickly and easily regardless of your location |
| 2 | Synchronising information with other parties by sharing Tracking Link |
| 3 | Strengthening communication among the team |
| 4 | Integrating tracking information to your own system. Here is an example |
Getting Started for API
| 1 | Before you can use the Tracking Link API, you must apply for a unique identifier
i.e., the API Subscription Key with IQAX as each request to the interface requires the unique identifier to be provided. Contact us if you do not own an API Subscription Key |
| 2 | After getting your subscription key, the first step would be registering your shipment so that we know your concerned shipment and get data for you. Please reference to the steps here for shipment registration |
| If you are using Shipment Tracking API already, you may use the same key directly |
Tracking Link API
Tracking link is available for registered shipment only.
Description:
The gateway endpoint to generate Tracking Link UI for tracking by ocean carrier SCAC code and tracking number
| Before performing queries, be reminded that each client is assigned a rate limit for calling all the APIs. Rate limiting is defined as below, which: |
| Allowed 150 requests per minute. When client performed too many requests, they will receive a HTTP 429 Too Many Requests error |
Explore The APIs 
| 1 | Click "Authorize 🔒", paste your key (e.g. dr212fa991d84374bbp6f0cef8d2ab5c) to the field, then click "Authorize". |
| 2 | Select an API, click "Try it out", input parameters, then click "Execute". |
Response Status
Details
| Error (e.g 400 and 404) will return with a corresponding HTTP status code with the same response body signature, which usually explain themselves: |
1
2
3
4
5
{
"message": "Error message",
"status": "Response Status Code",
"error": " Response Status "
}
| Status Code | Status | Description |
|---|---|---|
200 |
OK |
|
204 |
No Content |
Registration record is found but no result yet. |
400 |
Bad Request |
The server could not understand the request due to invalid syntax. Usually it is parameter error, duplicate registration or business key conflict |
401 |
Unauthorized |
The request not be authorized. |
404 |
Not Found |
The server cannot find the requested resource. |
500 |
Internal Server Error |
The server has encountered a situation it does not know how to handle. |
Error Code
Common Error Responses by Code:
| Status Code | Error Message |
|---|---|
400 |
carrierScac is required |
400 |
trackingNumber is required |
400 |
trackingType should be one of [BKG, BL] |
401 |
Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription |
404 |
Related record not found! |
Push Tracking Link API
Description:
The gateway endpoint to push Tracking Link UI for registered shipment
| Customer needs to provide a gateway to receive the Tracking Link |
Response message example:
1
2
3
4
5
6
7
{
"messageID": "0s9qo718218ac8f9cvq7kgfu14v77s5g",
"carrierSCAC": "OOLU",
"trackingNumber": "xxxxxxxx",
"trackingType": "BKG",
"trackingLink": "https://trackinglink.iqax.com/track/93ohhdp49pgimmnr94v80jvbi5h9lp3b/OOLU_BKG_xxxxxxxx"
}
Security
For security concern, customer can provide the secret and customized header {KEY, VALUE} for authorization You may reference to this section
1
2
3
4
5
6
7
8
{
"X-DHST-HOOK-CATEGORY": ["TRACKING_LINK"],
"X-DHST-Target-ID": ["string"],
"Content-Type": ["application/json"],
"X-DHST-Signature": ["string"],
"X-DHST-Signature-256": ["string"],
"customized_request_header": ["string"] /** eg: "Authorization": [XXXX]
}
Supported Carriers
IQAX Tracking Link API supports a list of major Ocean Carriers. Unless specified, You may register a shipment by BL number or Booking number.
| Ocean Carrier | SCAC code | BL Registration | BKG Registration | CNTR Registration |
|---|---|---|---|---|
ANL Container Line 澳航 |
ANNU |
✓ |
✓ |
✓ |
CK Line 天敬海运 |
CKLU |
✓ |
✓ |
✕ |
CMA-CGM 法国达飞 |
CMDU |
✓ |
✓ |
✓ |
CNC Line 正利 |
CHNL |
✓ |
✓ |
✓ |
COSCO SHIPPING Lines 中远海 |
COSU |
✓ |
✓ |
✕ |
Emirates 阿联酋 |
ESPU |
✓ |
✓ |
✓ |
Evergreen Line 长荣海运 |
EGLV |
✓ |
✓ |
✓ |
Gold Star Line 金星 |
GOSU |
✓ |
✕ |
✓ |
Hapag-Lloyd 赫伯罗特 |
HLCU |
✓ |
✓ |
✓ |
Heung-a 兴亚 |
11QU |
✓ |
✓ |
✓ |
Hyundai 现代 |
HDMU |
✓ |
✓ |
✓ |
Interasia Lines 运达 |
12AT |
✓ |
✕ |
✓ |
KMTC 高丽 |
KMTC |
✓ |
✓ |
✓ |
Maersk 马士基 |
MAEU |
✓ |
✕ |
✓ |
MCC MCC运输 |
MCCQ |
✓ |
✕ |
✓ |
MSC 地中海航运 |
MSCU |
✓ |
✓ |
✓ |
Namsung 南星海运 |
NSRU |
✓ |
✓ |
✓ |
Ocean Network Express 海洋网联 |
ONEY |
✓ |
✓ |
✓ |
OOCL 东方海外 |
OOLU |
✓ |
✓ |
✓ |
PIL 太平 |
PABV |
✓ |
✓ |
✓ |
Regional Container Lines (RCL) 宏海 |
RCLU |
✓ |
✓ |
✓ |
Sealand 海陸 |
SEAU |
✓ |
✕ |
✓ |
Shanghai Jinjiang 锦江 |
11WJ |
✓ |
✕ |
✕ |
Sinokor 长锦 |
SKLU |
✓ |
✕ |
✓ |
Sinotrans 中外运 |
12IH |
✓ (Container# is required) |
✕ |
✓ |
SITC 海丰 |
12PD |
✓ |
✕ |
✓ |
Swire Shipping 太古船务 |
CHVW |
✓ |
✓ |
✕ |
TS Line 德祥 |
13DF |
✓ |
✕ |
✓ |
Wan Hai 万海 |
WHLC |
✓ |
✓ |
✓ |
Yang Ming Line 阳明 |
YMJA |
✓ |
✓ |
✓ |
Zim Lines 以星 |
ZIMU |
✓ |
✓ |
✓ |
| If you find any carrier which is important to your business but not yet supported, please get in touch with us at customerservices@iqax.com. |