Tracking a Shipment

Adding Mobile Tracking to a Shipment

To POST a shipment's specific Track Object, you'll need to first provide the specific FreightProviderReferenceNumber with your 10-4 provided FreightHaulerProviderXID or the TenFourLicensePlate.

To POST a Track Object, the following fields are required:

1. FreightProviderReferenceNumber and FreightHaulerProviderXID
2. TenFourLicensePlate

Parameter

Type

Description

FreightProviderReferenceNumber

String

The external reference number of the shipper's given shipment (BOL).

FreightHaulerProviderXID

String

10-4's external reference id between a shipper and a carrier.

TenFourLicensePlate

String

The uniquely generated 10-4 response when creating a shipment within Freight Portal.

Here is an example JSON Object:

{
  "FreightProviderReferenceNumber":"12345670",
  "FreightHaulerProviderXID":"ABD3820AI"
}
{
  "TenFourLicensePlate":"T9302NB"
}

Adding the Carrier

Next, in order to assign a shipment to a specific carrier, you'll need to supply one of the following carrier identification parameters listed below:

Parameter

Type

Description

CarrierMC

String

The external reference to the carrier's MC-Number.

CarrierDOT

String

The external reference to the carrier's USDOT-Number.

CarrierSCAC

String

The external reference to the carrier's SCAC.

Here is an example of the JSON Object thus far:

{
  "FreightProviderReferenceNumber":"12345670",
  "FreightHaulerProviderXID":"ABD3820AI",
  "CarrierMC":"3829182"
}
{
  "FreightProviderReferenceNumber":"12345670",
  "FreightHaulerProviderXID":"ABD3820AI",
  "CarrierDOT":"110392"
}
{
  "FreightProviderReferenceNumber":"12345670",
  "FreightHaulerProviderXID":"ABD3820AI",
  "CarrierSCAC":"ABCD"
}

Adding Tracking Data Parameters

To update a specific shipment's tracking information, the following additional fields are required:

Parameter

Type

Description

DriverPhoneNumber

String

Phone number of the driver in E.164 format. US numbers will default to +1 if not provided. All numbers outside of the US must be in E.164 format.

ShipmentTrackingType

Enumeration

Enumeration type of the shipment's tracking type.

Here is an example of the JSON Object thus far:

{
  "FreightProviderReferenceNumber":"12345670",
  "FreightHaulerProviderXID":"ABD3820AI",
  "DriverPhoneNumber":"3035550101",
  "ShipmentTrackingType":3
}

Completed Set Shipment Tracking JSON Object

Here you can see an example of a completely valid Track Object:

{
  "FreightProviderReferenceNumber":"12345670",
  "FreightHaulerProviderXID":"ABD3820AI",
  "DriverPhoneNumber":"+15555551212",
  "ShipmentTrackingType":3
}