Tracking
API
Revision history
Version Date Comments
1.0 2002-12-05 Document created.
1.1 2009-06-01 Uppdated with new URL and requirements of authentication.
New variables in request: request.user.id and request.user.password New variables in respone: status_event_time, estimated_delivery_date, agreed_delivery_date.
New value in request.service, CTTSTYPEA_PLUGIN. 1.2 2010-02-23 Uppdated with new URL.
1.3 2010-12-06 Added information regarding e-service authentication including link to application form. 1.4 2011-09-27 Added HTML-request.
1.5 2011-10-19 Some changes/amendments/additions to 1.4 1.6 2012-05-02 URLs updated to secured HTTPS
1.7 2014-02-20 Not valid link removed from chapter 1. 1.71 2014-10-15 Changed link for apply for authorization.
TABLE OF CONTENTS
REVISION HISTORY ... 2
1
TRACKING ... 4
2
GENERAL VARIABLES ... 5
3
INFORMATION CONCERNING ONE CONSIGNMENT (WAYBILL)... 5
3.1
Request ... 5
3.2
Response ... 6
4
EDIFACT STANDARD VARIABLES ... 9
1 Tracking
Tracking is a user-authenticated service. Authorization is applied for here (only in Swedish):
http://www.schenker.se/access
The service gives customers the possibility to connect to Schenker´s systems and always get accurate tracking information.
The API gives the user the possibility to get current status of a consignment by waybill number or chosen references.
Examples ready to run will be found in the documentation. Just copy and paste them in to your web browser to get an overview of the possibilities.
The service can be invoked using httpRequest via HQF (Http Query Format) and can be returned in three ways: in HTML, XML or XMLEdifact format.
Figure 1 Flow chart of the service
URL to use:
2 General variables
The general variables are for administrating communication and are mutual for all communication. The title ’M’ symbolizes mandatory field.
3 Information concerning one consignment (waybill)
3.1 Request
Contains information to the service.
Name M Typ
e
Standard Length Explanation
request.service M Value: ’CTTSTYPEA_PLUGIN’ request.method M Value: ’search’
(used for shipment overview with *SHP, *CGN, *FF, *DWB searches)
Value: ’detail’
(used if the reference type is *FF or *COR to obtain detailed results)
request.format M Value: ’html’ for html response Value: ’xml’ for compact variable tags Value: ’xmledifact’ for EDIFACT standard tags reference_type 4 Value: ’*SHP’ Shipper reference
Value: ’*CGN’ Consignee reference Value: ’*FF’ Freight forwarder’s reference Value: ’*DWB’ Waybill number
Value: ’*COR’ Client order reference Value: ’*PKG’ Package ID
reference_number 240 Value of reference
request.user.id M 10 Mandatory user-id for CTTSTYPEA_PLUGIN request. request.user.password M Mandatory password for CTTSTYPEA_PLUGIN request. country 2 ISO 3166 country code (SE, GB, DE, FI, NO etc) language* 2 ISO 639-1 language code (se, en, de, fi, no etc) *Note: Localization of tracking is handled by respective Schenker country. If not translated, English will be used.
Examples of searches with different reference types: Search with Shipment number, format xmledifact
https://was.schenker.nu/ctts-a/com.dcs.servicebroker.http.HttpXSLTServlet?request.service=CTTSTYPEA_PLUGIN&request. method=search&request.format=xmledifact&reference_type=*DWB&reference_number=0000000 000&language=en&country=GB&request.user.id=userid&request.user.password=password
Search with Shipment number, format html
https://was.schenker.nu/ctts-a/com.dcs.servicebroker.http.HttpXSLTServlet?request.service=CTTSTYPEA_PLUGIN&request. method=search&request.format=html&reference_type=*DWB&reference_number=0000000000&l anguage=en&country=GB&request.user.id=userid&request.user.password=password
Search with Shipper reference
https://was.schenker.nu/ctts-a/com.dcs.servicebroker.http.HttpXSLTServlet?request.service=CTTSTYPEA_PLUGIN&request. method=search&request.format=xmledifact&reference_type=*SHP&reference_number=A&langua ge=en&country=GB&request.user.id=userid&request.user.password=password
Search with Schenker reference (Freight forwarder’s reference)
https://was.schenker.nu/ctts-a/com.dcs.servicebroker.http.HttpXSLTServlet?request.service=CTTSTYPEA_PLUGIN&request. method=detail&request.format=xmledifact&reference_type=*FF&reference_number=TKU1234568 7&language=en&country=GB&request.user.id=userid&request.user.password=password
Search with Client order
https://was.schenker.nu/ctts-a/com.dcs.servicebroker.http.HttpXSLTServlet?request.service=CTTSTYPEA_PLUGIN&request. method=detail&request.format=xmledifact&reference_type=*COR&reference_number=42500017 4776&language=en&country=GB&request.user.id=userid&request.user.password=password
3.2 Response
Contains information from the service.
The xml response variables are the same for multiple and single hits, except that the full event list is returned for a single hit and just the last event is returned for each hit is the case of more than one result. Below are the lists of xml variables used for Tracking for both available formats.
request.format=xmledifact - <consignment> <freight_forwarder_reference_number>xxxx</freight_forwarder_reference_number> <domestic_waybill_number>xxxx</domestic_waybill_number> <email>xxxx</email> <departure_location /> <departure_postcode /> <destination_location />
<destination_postcode /> <place_of_departure>xxxx</place_of_departure> <country_of_departure>xxxx</country_of_departure> <place_of_destination>xxxx</place_of_destination> <country_of_destination>xxxx</country_of_destination> <number_of_packages>xxxx</number_of_packages> <weight>xxxx</weight> <estimated_delivery_date>yyyymmdd</estimated_delivery_date> <agreed_delivery_date /> - <status_event_list> - <status_event> <status_event_text>xxxxl</status_event_text> <status_event_type>xxxx</status_event_type> <status_event_code>xxx</status_event_code> <status_event_place_name>xxxxxx</status_event_place_name> <status_event_place_code>xxx</status_event_place_code> <status_event_country_code>xx</status_event_country_code> <status_event_country_name>xxxx</status_event_country_name> <status_event_date>yyyy-mm-dd</status_event_date> <status_event_time>hh:mm</status_event_time> </status_event> - <status_event> </status_event> </status_event_list> </consignment> - <request> <reference_type>xxxx</reference_type> <reference_number>xxxxxxxxxx</reference_number> </request> <record_count>x</record_count> </xml>
request.format=html
Below is an html-response for a single hit.
4 Edifact standard variables
Variable name Standard Explanation
freight_forwarder_reference RFF-1153-FF Schenker’s reference domestic_waybill_number RFF-1153-AAM Waybill number consignor_reference_number RFF-1153-CU Shipper’s reference consignee_reference_number RFF-1153-CN Consignee’s reference
email Schenker contact e-mail
status_event_list
status_event STS-C555
status_event_text STS-C556-4404 Event description status_event_type Event type status_event_code STS-C556-4404 Event code status_event_place_name LOC-3225 Event place name status_event_place_code LOC-ZZZ Event place code status_event_country_name NAD-3207-CA Event country name status_event_country_code NAD-3229-CA Event country code status_event_date DTM-2005-183 Event date status_event_time Event time
reference_type Search reference type reference_number Search reference value record_count Number of records found
5 Event codes, types and descriptions
Event Type Event Code Event Description
*001 *800 Booked
DOMO COL Collected
DOMO DET Delivered to terminal by shipper
*101 *800 Departed
*101 *950 Arrived
DOMD DIS To consignee’s disposal DOMD PUP Picked up by consignee
DOMD DOT Out for delivery
DOMD DLV Delivered
