Universal Tracking and Tracing
Endpoint
https://tms.targetfmi.com/index.php?p=api&r=xml&c=tracking&m=trackPRO&d=([PRO]/[SCAC]|[TargetTMS Tracking Code])
The REST endpoint allows you integrate our tracking system natively into your own system or Website.
https://tms.targetfmi.com/index.php?c=tracking&m=track&d=[PRO]/[SCAC]
The HTML - PRO (Secured) endpoint allows you create a link to the tracking information in TargetTMS using the PRO # and SCAC. The user would need to already have previously logged into TargetTMS for this to work.
https://tms.targetfmi.com/index.php?c=tracking&m=track&d=[TargetTMS Tracking Code]
The HTML - Tracking Code (Secured) endpoint allows you create a link to the tracking information in TargetTMS using the Tracking Code. The user would need to already have previously logged into TargetTMS for this to work.
https://tms.targetfmi.com/index.php?c=tracking&m=publicTrackPRO&d=[TargetTMS Tracking Code]
The HTML - (Public) endpoint allows you create a link to the tracking information in TargetTMS. The user does not need to be logged into the system at all, for instance if you wanted to distribute a tracking link to a user who does not have access to TargetTMS.
Request Parameters
Parameter | Required | Available Options/Data Type | Description |
---|---|---|---|
PRO | cond. | A Valid PRO # | This field can only be used in combination with the Standard Carrier Alpha Code (SCAC) for the carrier by whom the PRO was assigned. Only allowed when using a Secured endpoint. |
SCAC | cond. | Varchar(4) | A 4-Character Standard Carrier Alpha Code, in Upper Case. Only required when using a PRO to track a shipment. Only allowed when using a Secured endpoint. |
TargetTMS Tracking Code | cond. | Varchar(10) | A 10-Character Alpha-Numeric Tracking Code in Upper Case assigned by TargetTMS to every PRO it receives and enters into the UTTS. Can be used in place a PRO/SCAC combination, required for the Public Tracking Link. |
Examples
REST PRO Tracking https://tms.targetfmi.com/index.php?p=api&r=xml&c=tracking&m=trackPRO&d=9/ODFL REST Tracking Code Tracking https://tms.targetfmi.com/index.php?p=api&r=xml&c=tracking&m=trackPRO&d=EPJ332GISE HTML PRO Tracking https://tms.targetfmi.com/index.php?c=tracking&m=track&d=9/ODFL HTML Tracking Code Tracking https://tms.targetfmi.com/index.php?c=tracking&m=track&d=EPJ332GISE HTML Public Tracking Code Tracking https://tms.targetfmi.com/index.php?c=tracking&m=publicTrackPRO&d=EPJ332GISE
Response Parameters
Parameter Name | Description |
---|---|
/body/carrier | Carrier's Standard Carrier Alpha Code (SCAC) |
/body/tracking_number | TargetTMS UTTS Tracking Code |
/body/pro_number | Shipment PRO # |
/body/bol_number | BoL # as captured by Carrier |
/body/po_number | PO # as captured by Carrier |
/body/shipped_by | Shipper Container |
/body/shipped_by/name | Shipper Name |
/body/shipped_by/address1 | Shipper address line |
/body/shipped_by/address2 | Shipper address line |
/body/shipped_by/address3 | Shipper address line |
/body/shipped_by/city | Shipper City |
/body/shipped_by/state | Shipper State |
/body/shipped_by/zip | Shipper Zip |
/body/received_by | Consignee Container |
/body/received_by/name | Consignee Name |
/body/received_by/address1 | Consignee Address Line |
/body/received_by/address2 | Consignee Address Line |
/body/received_by/address3 | Consignee Address Line |
/body/received_by/city | Consignee City |
/body/received_by/state | Consignee State |
/body/received_by/zip | Consignee Zip |
/body/origin_service_center | Origin Service Center Container |
/body/origin_service_center/name | Service center name |
/body/origin_service_center/link | Service center link when provided |
/body/destination_service_center | Destination Service Center Container |
/body/destination_service_center/name | Service Center Name |
/body/destination_service_center/link | Service center link when provided |
/body/pickup_date | Pickup Date and Time |
/body/estimated_delivery_date | Estimated Delivery |
/body/delivery_date | Delivery Date Container |
/body/delivery_date/date | Date |
/body/delivery_date/time | Time |
/body/delivery_status | Carrier's Status Container |
/body/delivery_status/code | Carrier's status code |
/body/delivery_status/message | Carrier's status message |
/body/delivery_signature | Person signing for delivery when provided |
/body/shipment_weight | Total shipment weight reported by carrier |
/body/shipment_pieces | Total shipment pieces reported by carrier |
/body/system_status | UTTS Status |
/body/status_message | UTTS Status message |
/body/history | History Container |
/body/history/status_code | Status Code |
/body/history/status_message | Status Message |
/body/history/location | Location of Event |
/body/history/date | Event Date |
/body/history/time | Event Time |
/body/history/comments | Additional information |
Heads Up
- Dates are returned in
mm/dd/YYYY
format - Times are returned in
hh:mm AM|PM
format (12 hour with leading zero) - Date Time strings are returned in
mm/dd/YYYY hh:mm AM|PM
format
Attention
Some carriers return more information than others. We provide as much information as possible from what is returned by each carrier's API. All fields above, except the TargetTMS Tracking Code, SCAC, and PRO # should be considered Completely Optional.
Status Codes Explained
Code | Description |
---|---|
scheduled | Shipment has been scheduled for pickup |
picked up | The shipment was picked up from the origin location. |
in transit | The shipment is in transit. |
delivery pending | The shipment is out for delivery, or will be delivered soon. |
delivered | The shipment was delivered |
exception | The shipment encountered an exception. These are often related to:
|
error | UTTS encountered an error tracking the shipment |
never shipped | PRO was added to UTTS but the carrier never made tracking data available, we have to assume it was never shipped. (After 7 days with no tracking response from carrier) |
deletion flag | PROs with a "Never Shipped" status are marked for deletion after 14 days. (After 21 days, PROs without tracking data are deleted from the system) |
Example
<?xml version="1.0" encoding="UTF-8"?> <response> <body> <carrier>RDWY</carrier> <tracking_number>P87M7D8YAW</tracking_number> <pro_number>2130670634</pro_number> <bol_number></bol_number> <po_number></po_number> <shipped_by> <name></name> <address1></address1> <address2></address2> <address3></address3> <city>LEETSDALE</city> <state>PA</state> <zip>15056</zip> </shipped_by> <received_by> <name></name> <address1></address1> <address2></address2> <address3></address3> <city>RAPID CITY</city> <state>SD</state> <zip>57701</zip> </received_by> <origin_service_center/> <destination_service_center/> <pickup_date>01/30/14</pickup_date> <estimated_delivery_date>02/10/2014</estimated_delivery_date> <delivery_date> <date>02/10/2014</date> <time>4:59 PM</time> </delivery_date> <delivery_status> <code>Delivered</code> <message>Delivered </message> </delivery_status> <delivery_signature></delivery_signature> <shipment_weight></shipment_weight> <shipment_pieces></shipment_pieces> <system_status>delivered</system_status> <status_message>Delivered </status_message> <history> <status_code>Picked Up</status_code> <status_message>Picked Up from PITTSBURGH, PA</status_message> <location></location> <date>01/30/2014</date> <time>12:00 AM</time> <comments></comments> </history> <history> <status_code>Loaded</status_code> <status_message>Loaded to TRLR 123130 at PITTSBURGH, PA</status_message> <location></location> <date>01/30/2014</date> <time>10:19 PM</time> <comments></comments> </history> <history> <status_code>Unloaded</status_code> <status_message>Unloaded at CHICAGO, IL</status_message> <location></location> <date>02/03/2014</date> <time>5:38 PM</time> <comments></comments> </history> <history> <status_code>Loaded</status_code> <status_message>Loaded to TRLR 560850 at CHICAGO, IL</status_message> <location></location> <date>02/03/2014</date> <time>8:01 PM</time> <comments></comments> </history> <history> <status_code>Unloaded</status_code> <status_message>Unloaded at DENVER, CO</status_message> <location></location> <date>02/07/2014</date> <time>2:55 AM</time> <comments></comments> </history> <history> <status_code>Loaded</status_code> <status_message>Loaded to TRLR 118184 at DENVER, CO</status_message> <location></location> <date>02/07/2014</date> <time>2:55 AM</time> <comments></comments> </history> <history> <status_code>Unloaded</status_code> <status_message>Unloaded at RAPID CITY, SD</status_message> <location></location> <date>02/09/2014</date> <time>12:00 AM</time> <comments></comments> </history> <history> <status_code>Loaded</status_code> <status_message>Loaded to TRLR 132671 at RAPID CITY, SD</status_message> <location></location> <date>02/10/2014</date> <time>2:59 PM</time> <comments></comments> </history> <history> <status_code>Delivered</status_code> <status_message>Delivered </status_message> <location></location> <date>02/10/2014</date> <time>4:59 PM</time> <comments></comments> </history> </body> <message/> </response>