Pull load track updates via load numbers

Request

Bodyapplication/jsonrequired

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 account. 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=="

loadNumbersArray of strings

The identifiers of the loads in the broker's system.

Example:

[
  "Load-1234"
]

sendNewDatastring

When "yes", only updates since the last update request call are returned. When "no", all updates on the track are returned.

Enum:"yes""no"

Example:"yes"

includeLocationsboolean

Flag to indicate whether location updates should be returned. Default is true.

includeEventsboolean

Flag to indicate whether status updates should be returned. Default is true.

includeDocumentsboolean

Flag to indicate whether uploaded document updates should be returned. Default is true.

includeCommentsboolean

Flag to indicate whether driver comment updates should be returned. Default is true.

curl -i -X POST \
  https://developer.truckertools.com/_mock/apis/getloadtrackupdates/loadtrackservice/getLoadTrackDetailsServiceByLoadNumber \
  -H 'Content-Type: application/json' \
  -d '{
    "partnerId": 12345,
    "accountId": "E++p1waC69ktJerPRkJHQg==",
    "loadNumbers": [
      "Load-1234"
    ],
    "sendNewData": "yes",
    "includeLocations": true,
    "includeEvents": true,
    "includeDocuments": true,
    "includeComments": true
  }'

Responses

Successful update pull response.

Bodyapplication/json

statusbooleanrequired

Call success indicator.

timeStampstringrequired

Server timestamp at the time of response.

Example:"09/26/2023 03:24:41 UTC"

detailsArray of objects

Response

{
  "status": true,
  "timeStamp": "09/26/2023 03:24:41 UTC",
  "details": [
    { … }
  ]
}