Skip to content

Update an existing track

Request

Bodyapplication/jsonrequired

Load Track object that needs to be added to the load track system.

partnerIdinteger, (int64), >= 0required

This is a unique integer id that is assigned to the Partner system to identify the Partner system by the Load Track system. This has to be sent on each webservice call.

Example:12345
accountIdstringrequired

Unique identifier of the Agent in the Broker System that entered the Load Track. This accountId has to be encrypted with the shared secret of the partner. This shared secret will be shared during the integration process.

Example:"E++p1waC69ktJerPRkJHQg=="
loadNumberstring, [ 0 .. 50 ] characters

Load Number that is specified by the Broker. This could be the pro number.

Example:12345
loadTrackExternalIdstringrequired

The unique identifier of the Load in the Partner system.

Example:54321
dispatcherIdstring, [ 0 .. 200 ] characters

Dispatcher id of the TMS software. Used to group the loads on Load Track website.

Example:123
dispatcherEmailstring, (email), [ 0 .. 200 ] characters

Dispatcher email of the TMS software. Used to send the broker emails a CC.

dispatcherPhoneNumberstring, (phone), [ 0 .. 200 ] characters

Dispatcher phone of the TMS software. Used to group the loads on Load Track website.

Example:7035551234
trackMethodstring

Designate the type of tracking preferred. If "APP" is sent, the load will automatically track via the mobile app and not try to track via ELD. If the field is null or "ELD" is sent, the load will go through the standard waterfall process trying ELD if the carrier is ELD integrated then app tracking if ELD tracking is not successful. If the carrier is not ELD integrated, it will automatically waterfall to app tracking.

Enum:"APP""ELD"
scacstring

Broker's SCAC tied to the load. This field is only used to support 3rd party tracking provider integrations (e.g., 4Kites) when the broker has multiple carrier accounts that supply load updates to the 3rd party tracking provider.

Example:"ABCD"
textmessagestring, [ 0 .. 100 ] characters

Text message that will be used as the text that is sent to the driver.

loadTypestring, [ 0 .. 100 ] characters

The type of load. This can be an equipment type as well, such as R for Reefer.

Example:"R"
trailerTypestring, [ 0 .. 100 ] characters

Some customers use this for the type of load or DAT trailer type This can be equipment type as well such as R for Reefer.

Example:"R"
revenueTypestring, [ 0 .. 100 ] characters

Optional flag for the type of load.

Default:null
Example:"TMS"
driverCellstring, (phone)

Ten-digit or twelve-digit cell phone number of driver that will haul the load. This is an optional field and if omitted an email is sent to the Carrier Dispatcher to update the cell phone number. This number should be a valid cell phone number that is either an iPhone or an Android.

Example:7035554321
trailerNumberstring, [ 0 .. 45 ] characters

Number assigned to cargo trailer.

Example:67890
truckNumberstring, [ 0 .. 45 ] characters

Number assigned to truck or vehicle.

Example:12345
driverNamestring, [ 0 .. 120 ] characters

Name of the driver tracking the Load.

Example:"Jon Doe"
driverTypestring

Type of the driver tracking the Load.

Enum:"companyDriver""ownerOperatorLeased""ownerOperatorIndependent""otherCarrierCompanyDriver"
driverCommentsstring, [ 0 .. 2000 ] characters

Comment for the driver to see.

Example:"Driver comments."
loadNotesstring, [ 0 .. 2000 ] characters

Notes about the load. Driver will not see this.

isTeamLoadboolean

Indicate if load is handled by multiple drivers.

Default:false
minTempnumber

Minimum temperature asset is supposed to reach.

Example:30
maxTempnumber

Maximum temperature asset is supposed to reach.

Example:40
tempUoMstring

How temperature of asset is measured.

Enum:"fahrenheit""celsius"
Example:"fahrenheit"
carrierDispatcherEmailstring, (email), [ 0 .. 100 ] characters

Carrier dispatcher email address for carrier that will do the load track. It is important for this email to be a valid and functional email address. All communications are done to this email address by the TruckerTools system, including the email that is generated when a new load track is created in the system. This email will have the link for the carrier dispatcher to update the driver cell phone and also the map to show the status of the Load Track.

carrierobject
carriersArray of objects
brokerobject
shipperobject
metadataArray of objects(Metadata)

List of metadata that can be added to Load. These are typically used to tag the load for searching.

stopsArray of objects(Stop)required
curl -i -X PUT \
  https://developer.truckertools.com/_mock/apis/createloadtrack/loadtrackservice/LTL \
  -H 'Content-Type: application/json' \
  -d '{
    "partnerId": 12345,
    "accountId": "E++p1waC69ktJerPRkJHQg==",
    "loadNumber": 12345,
    "loadTrackExternalId": 54321,
    "dispatcherId": 123,
    "dispatcherEmail": "user@example.com",
    "dispatcherPhoneNumber": 7035551234,
    "trackMethod": "APP",
    "scac": "ABCD",
    "textmessage": "string",
    "loadType": "R",
    "trailerType": "R",
    "revenueType": "TMS",
    "driverCell": 7035554321,
    "trailerNumber": 67890,
    "truckNumber": 12345,
    "driverName": "Jon Doe",
    "driverType": "companyDriver",
    "driverComments": "Driver comments.",
    "loadNotes": "string",
    "isTeamLoad": false,
    "minTemp": 30,
    "maxTemp": 40,
    "tempUoM": "fahrenheit",
    "carrierDispatcherEmail": "user@example.com",
    "carrier": {
      "companyName": "string",
      "docketNumber": 12345,
      "contactName": "string",
      "contactPhone": "string",
      "contactPhoneExt": "string"
    },
    "carriers": [
      {
        "companyName": "string",
        "docketNumber": 12345,
        "contactName": "string",
        "contactPhone": "string",
        "contactPhoneExt": "string",
        "driverPhoneNumbers": [
          {
            "name": "Jon Doe",
            "phone": 7035554321
          }
        ]
      }
    ],
    "broker": {
      "companyName": "string",
      "docketNumber": "MC456123",
      "contactName": "string",
      "contactPhone": "string",
      "contactPhoneExt": "string",
      "contactEmail": "string"
    },
    "shipper": {
      "shipperId": "string",
      "loadNumber": "string",
      "emails": "string",
      "emailInterval": 1,
      "referenceNumber": "string"
    },
    "metadata": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "stops": [
      {
        "orderNumber": 1,
        "locationName": "string",
        "locationId": "string",
        "address": "string",
        "city": "string",
        "state": "VA",
        "zipcode": 20148,
        "lat": 0,
        "lon": 0,
        "datetime": "10/14/2021 12:14:45 EST",
        "stopGMTDiff": "string",
        "datetimeExit": "10/14/2021 12:14:45 EST",
        "geofenceRadius": 0,
        "notes": "string",
        "stopExternalId": "string",
        "actions": [
          {
            "id": "string",
            "name": "string",
            "item": "string",
            "required": true,
            "driverInput": true,
            "options": [
              {
                "name": "string"
              }
            ]
          }
        ],
        "metadata": [
          {
            "name": "string",
            "value": "string"
          }
        ]
      }
    ]
  }'

Responses

LoadTrack Response

Bodyapplication/json
responseobject
Response
{ "response": { "status": true, "timeStamp": "string", "loadId": 0, "trackingMethod": "ELD", "mapLink": "http://www.truckertools.com/us/f8ma90615f1dae80fbc", "statusPageLink": "http://www.truckertools.com/us/bcza73615f1daef3772", "detailsLink": "http://www.truckertools.com/us/t28qnc615f1daca5ee3", "detailsLinkNoAuth": "http://www.truckertools.com/us/77100x615f1dad23281", "carrierLink": "http://www.truckertools.com/us/8w3a3p615f1dad938fd", "shipperLink": "http://www.truckertools.com/us/59qf97615f1dae0fdda", "eldAsset": { … }, "errorCode": 101, "errorMessage": "Account not found" } }