TLS DTDC Rest Tracking Api - Final - V4
TLS DTDC Rest Tracking Api - Final - V4
Introduction
Representational state transfer (REST) or RESTful web service are one way of providing interoperability
between computer systems on the Internet. REST-compliant web services allow requesting systems to
access and manipulate textual representations of web services using a uniform and predefined set
of stateless operations. Other forms of web service exist, which expose their own arbitrary sets of
operations such as WSDL and SOAP.
To make a web API call from a client application, you must supply an authentication token on the call.
The token acts like an electronic key that lets you access the API.
DTDC Tracking services allow third party provider to integrate DTDC tracking services into a platform or
website. Once integrated your application will access DTDC servers over REST style architecture using
XML/JSON.
Staging :
http://dtdcstagingapi.dtdc.com/dtdc-tracking-api/dtdc-api/api/dtdc/authenticate?username=<userna
me>&password=<password>
Production : https://blktracksvc.dtdc.com/dtdc-api/api/dtdc/authenticate?username=<username>
&password=<password>
Page 1 | 25
Query request parameters
Response Status
Production : https://blktracksvc.dtdc.com/dtdc-api/rest/XMLCnTrk/getDetails?strcnno=<AWB
No>&TrkType=cnno&addtnlDtl=Y&apikey=<Token Key>
Page 2 | 25
Response XML Consignment Data
Page 3 | 25
strModeCode The billing mode of the AR1/SF1/AC1
consignment Code
‘Booked By’
‘Received From’
‘Scanned At’
‘Booked At’
DELIVERED
Page 4 | 25
DELIVERY PROCESS IN
PROGRESS
ATTEMPTED
HELDUP
RTO
(DDMMYYYY)
(HHMM)
Page 5 | 25
available if shipment is
RTO'ed
Ex:
DISPATCHED
Page 6 | 25
RECEIVED
DELIVERED
NOT DELIVERED
HELDUP
CONSIGNMENT
RELEASED
CONSIGNMENT HAS
RETURNED
POD DISPATCHED
ARRIVAL AT AIRPORT
CUSTOMS CLEARED
HELDUP AT CUSTOMS
https://docs.google.co
m/spreadsheets/d/10K
olSYlWhN4eFZsVSPUxk
3YEBsxJvELNpWt-CWx
GcFM/edit?usp=drive_
web&ouid=113448660
306017136829
Page 7 | 25
returned from /Heldup
at
<DTDCREPLY xmlns="http://dtdc.com">
<CONSIGNMENT xmlns="">
<CNHEADER>
<CNTRACK>true</CNTRACK>
Page 8 | 25
<FIELD name="strRefNo"/>
<FIELD name="strModeCode"/>
<FIELD name="strCNProdCODFOD"/>
<FIELD name="strRtoNumber"/>
Page 9 | 25
<FIELD name="strActualAgent" value=""/>
</CNHEADER>
<CNBODY>
<CNACTIONTRACK>true</CNACTIONTRACK>
<CNACTION>
</CNACTION>
<CNACTION>
Page 10 | 25
<FIELD name="sTrRemarks" value=""/>
</CNACTION>
<CNACTION>
<FIELD name="sTrRemarks"/>
</CNACTION>
<CNACTION>
<FIELD name="strDestination"/>
</CNACTION>
<CNACTION>
Page 11 | 25
<FIELD name="strOrigin" value="COCHIN APEX"/>
<FIELD name="sTrRemarks"/>
</CNACTION>
<CNACTION>
<FIELD name="sTrRemarks"/>
</CNACTION>
<CNACTION>
<FIELD name="sTrRemarks"/>
</CNACTION>
Page 12 | 25
<CNACTION>
</CNACTION>
<CNACTION>
</CNACTION>
<CNACTION>
Page 13 | 25
<FIELD name="strActionDate" value="09022017"/>
<FIELD name="sTrRemarks"/>
</CNACTION>
<CNACTION>
<FIELD name="strManifestNo"/>
</CNACTION>
<CNACTION>
</CNACTION>
<CNACTION>
Page 14 | 25
<FIELD name="strAction" value="In Transit"/>
</CNACTION>
<CNACTION>
</CNACTION>
<CNACTION>
Page 15 | 25
<FIELD name="sTrRemarks" value="SIGNTURE"/>
</CNACTION>
</CNBODY>
</CONSIGNMENT>
</DTDCREPLY>
Production : https://blktracksvc.dtdc.com/dtdc-api/rest/JSONCnTrk/getTrackDetails
Page 16 | 25
Status: 200 - Will send
statusCode Standard Http request code Success and tracking
details
Status: 206 – `Partial
content` (validation failed
for request parameters)
Status: 400 - `Bad Request
` (wrong data passed as
request parameter)
Status: 401 -
`Unauthorized`
Status: 500 - `Error
Occurred `
"name":
"strShipmentNo",
"value": "11111"
},
"name": "strError",
Page 17 | 25
strCNTypeCode Direct Party Code LL676
‘Booked By’
‘Received From’
‘Scanned At’
‘Booked At’
1. DELIVERED
Page 18 | 25
2. DELIVERY PROCESS IN
PROGRESS
3. ATTEMPTED
4. HELDUP
5. RTO
(DDMMYYYY)
(HHMM)
Ex:
6. DISPATCHED
7. RECEIVED
8. OUT FOR DELIVERY
9. DELIVERED
10. NOT DELIVERED
Page 19 | 25
11. HELDUP
12. CONSIGNMENT RELEASED
13. CONSIGNMENT HAS
RETURNED
14. POD DISPATCHED
15. ARRIVAL AT AIRPORT
16. CUSTOMS CLEARED
17. HELDUP AT CUSTOMS
"statusCode": 200,
"statusFlag": true,
"status": "SUCCESS",
"errorDetails": null,
Page 20 | 25
"trackHeader": {
"strShipmentNo": "B32242001",
"strRefNo": "",
"strCNType": "CP",
"strCNTypeCode": "BF014",
"strCNProduct": "LITE",
"strModeCode": "",
"strMode": "",
"strCNProdCODFOD": "",
"strOrigin": "BANGALORE",
"strBookedDate": "21062017",
"strBookedTime": "15:30:25",
"strPieces": "1",
"strWeightUnit": "KG",
"strWeight": "0.1000",
"strDestination": "MUMBAI",
"strStatus": "Delivered",
"strStatusTransOn": "21062017",
"strStatusTransTime": "1614",
"strStatusRelCode": "",
"strStatusRelName": "",
"strRemarks": "SIGN",
"strNoOfAttempts": "1",
"strRtoNumber": ""
},
"trackDetails": [
"strCode": "BKD",
"strAction": "Booked",
"strManifestNo": "",
Page 21 | 25
"strOrigin": "BANGALORE SURFACE APEX",
"strDestination": "",
"strActionDate": "21062017",
"strActionTime": "1530",
"sTrRemarks": ""
},
"strCode": "OBMD",
"strManifestNo": "B7701202",
"strActionDate": "21062017",
"strActionTime": "1533",
"sTrRemarks": ""
},
"strCode": "OPMF",
"strManifestNo": "B7701203",
"strActionDate": "21062017",
"strActionTime": "1533",
"sTrRemarks": ""
},
"strCode": "IBMD",
"strManifestNo": "B7701202",
Page 22 | 25
"strActionDate": "21062017",
"strActionTime": "1533",
"sTrRemarks": ""
},
"strCode": "CDOUT",
"strManifestNo": "",
"strActionDate": "21062017",
"strActionTime": "1546",
"sTrRemarks": ""
},
"strCode": "CDIN",
"strManifestNo": "",
"strActionDate": "21062017",
"strActionTime": "1555",
"sTrRemarks": ""
},
"strCode": "IPMF",
"strManifestNo": "B7701203",
"strActionDate": "21062017",
"strActionTime": "1603",
Page 23 | 25
"sTrRemarks": "0.00"
},
"strCode": "IBMD",
"strManifestNo": "B7701202",
"strActionDate": "21062017",
"strActionTime": "1603",
"sTrRemarks": ""
},
"strCode": "OBMD",
"strManifestNo": "B7701202",
"strActionDate": "21062017",
"strActionTime": "1603",
"sTrRemarks": ""
},
"strCode": "OUTDLV",
"strManifestNo": "",
"strDestination": "",
"strActionDate": "21062017",
"strActionTime": "1611",
"sTrRemarks": ""
},
Page 24 | 25
{
"strCode": "DLV",
"strAction": "Delivered",
"strManifestNo": "",
"strDestination": "",
"strActionDate": "21062017",
"strActionTime": "1614",
"sTrRemarks": "SIGN"
Page 25 | 25