Developers

API reference

Loads, live truck positions and tracking events for brokers, carriers, TMSs and visibility networks.

Base URL: https://getloadsignal.com/api/v1
Version: 1.1.0
Machine-readable: OpenAPI 3.1 JSON

LoadSignal tracks truckload freight from the driver's phone and the truck's ELD. This API lets a TMS or visibility network create loads, read their status, stops and ETA, and follow the truck's position as it moves.

Authentication

Send an API key on every request: Authorization: Bearer ls_live_…. Keys are created under Settings → API & Webhooks, shown once, and belong to one organization; everything a key reads or writes is scoped to it. Revocation is immediate.

Scopes

A key has full access or a set of scopes. A partner that only follows trucks gets Tracking read-only (loads:read, positions:read), which can also be limited to some of the carrier's customers: it then sees only their loads, and any other load answers 404. A call outside the key's scopes answers 403 INSUFFICIENT_SCOPE.

Errors

Every error has the same envelope: { "error": { "code", "message", "details"? } }. code is stable and meant for programs; message is for people. Every response, errors included, carries X-Request-Id: quote it to support. Responses are Cache-Control: no-store. A path no endpoint owns answers 404 NOT_FOUND in the same envelope.

Pagination

Lists page with an opaque cursor. Pass back the nextCursor you were given. Cursors order on a timestamp and an id, so paging is stable while data changes. A cursor this API did not return is 400 INVALID_CURSOR.

Times

All times in responses are UTC ISO-8601. Times you send must carry an offset or Z; a bare local time is refused rather than guessed.

Webhooks

Instead of polling, subscribe a URL under Settings → API & Webhooks. Deliveries are signed (X-LoadSignal-Signature: t=…,v1=HMAC-SHA256(secret, "t.body")), retried after 1, 5, 30, 120 and 720 minutes, and listed with their responses for 30 days. See the webhooks section.

Limits

Bodies up to 1 MB. A 429 always carries Retry-After: wait that long before trying again. Poll the position feed about once a minute; it is built to be read that way, and the load.location webhook pushes the same positions if you would rather not poll.

Loads

Create, update, read and cancel loads, keyed by your own reference.

GET/loads

List loads

Loads ordered by last update, oldest first. Poll with updatedSince set to your last sync time. Needs loads:read.

Query parameters

updatedSincedate-time
Only loads updated at or after this time.
statusstring
One of active, completed, all. Default active
limitinteger
1 to 200. Default 100
cursorstring
nextCursor from the previous page.

Responses

200A page of loads. Load
400The request failed validation; details lists each problem.
401Missing, invalid or revoked API key.
403The key's scopes do not cover this call.
500Our fault. Nothing was applied; retrying is safe.

Request

curl https://getloadsignal.com/api/v1/loads \
  -H "Authorization: Bearer $LOADSIGNAL_API_KEY"

Response 200

{
  "loads": [
    {
      "id": "clxload001",
      "externalRef": "TMS-1001",
      "loadNumber": "LD-48213",
      "status": "IN_TRANSIT",
      "trackingStatus": "ACTIVE",
      "riskStatus": "NORMAL",
      "gpsTrust": "VERIFIED",
      "customerReferenceNo": "PO-88213",
      "customer": {
        "name": "Example Foods"
      },
      "carrier": {
        "name": "Example Carrier",
        "mcNumber": "123456",
        "dotNumber": "2345678"
      },
      "driver": {
        "firstName": "Sample",
        "lastName": "Driver",
        "phone": "+13125550100"
      },
      "stops": [
        {
          "sequence": 1,
          "type": "PICKUP",
          "status": "DEPARTED",
          "facility": {
            "name": "Example Foods DC 4",
            "addressLine1": "100 Cold St",
            "city": "Chicago",
            "state": "IL",
            "postalCode": "60601"
          },
          "timezone": "America/Chicago",
          "appointmentStart": "2026-09-25T13:00:00.000Z",
          "appointmentEnd": "2026-09-25T15:00:00.000Z",
          "arrivedAt": "2026-09-25T13:12:00.000Z",
          "departedAt": "2026-09-25T14:40:00.000Z",
          "eta": null,
          "referenceNumbers": [
            "PU-4471"
          ],
          "instructions": "Dock 7"
        }
      ],
      "location": {
        "latitude": 41.5102,
        "longitude": -87.0231,
        "capturedAt": "2026-09-25T14:02:11.000Z",
        "source": "NATIVE_APP"
      }
    }
  ],
  "nextCursor": null
}

GET/loads/{externalRef}

Get a load

Needs loads:read.

Path parameters

externalRefstringrequired
Your identifier for the load: the order or load number in your TMS. Percent-encode it once (PO/88 is PO%2F88, 100% is 100%25).
Up to 100 characters

Responses

200The load. Load
401Missing, invalid or revoked API key.
403The key's scopes do not cover this call.
404No such load or document in your organization.
500Our fault. Nothing was applied; retrying is safe.

Request

curl https://getloadsignal.com/api/v1/loads/TMS-1001 \
  -H "Authorization: Bearer $LOADSIGNAL_API_KEY"

Response 200

{
  "load": {
    "id": "clxload001",
    "externalRef": "TMS-1001",
    "loadNumber": "LD-48213",
    "status": "IN_TRANSIT",
    "trackingStatus": "ACTIVE",
    "riskStatus": "NORMAL",
    "gpsTrust": "VERIFIED",
    "customerReferenceNo": "PO-88213",
    "customer": {
      "name": "Example Foods"
    },
    "carrier": {
      "name": "Example Carrier",
      "mcNumber": "123456",
      "dotNumber": "2345678"
    },
    "driver": {
      "firstName": "Sample",
      "lastName": "Driver",
      "phone": "+13125550100"
    },
    "stops": [
      {
        "sequence": 1,
        "type": "PICKUP",
        "status": "DEPARTED",
        "facility": {
          "name": "Example Foods DC 4",
          "addressLine1": "100 Cold St",
          "city": "Chicago",
          "state": "IL",
          "postalCode": "60601"
        },
        "timezone": "America/Chicago",
        "appointmentStart": "2026-09-25T13:00:00.000Z",
        "appointmentEnd": "2026-09-25T15:00:00.000Z",
        "arrivedAt": "2026-09-25T13:12:00.000Z",
        "departedAt": "2026-09-25T14:40:00.000Z",
        "eta": null,
        "referenceNumbers": [
          "PU-4471"
        ],
        "instructions": "Dock 7"
      }
    ],
    "location": {
      "latitude": 41.5102,
      "longitude": -87.0231,
      "capturedAt": "2026-09-25T14:02:11.000Z",
      "source": "NATIVE_APP"
    }
  }
}

PUT/loads/{externalRef}

Create or update a load

Idempotent on externalRef: the first call creates the load (201), later calls update it (200). Send the whole load each time. Customers are matched by name, carriers by MC or DOT, drivers by phone, facilities by name and city. Stops can be added or removed only before dispatch. Needs loads:write.

Path parameters

externalRefstringrequired
Your identifier for the load: the order or load number in your TMS. Percent-encode it once (PO/88 is PO%2F88, 100% is 100%25).
Up to 100 characters

Body fields (49)

customerobject
customer.namestringrequired
Up to 200 characters
customer.emailstring
carrierobject
carrier.mcNumberstring
Up to 20 characters
carrier.dotNumberstring
Up to 30 characters
carrier.namestring
Up to 200 characters
driverobject
driver.phonestringrequired
Up to 40 characters
driver.firstNamestring
Up to 80 characters
driver.lastNamestring
Up to 80 characters
loadNumberstring
Up to 40 characters
customerReferenceNostring
Up to 80 characters
commoditystring
Up to 200 characters
equipmentTypestring
One of DRY_VAN, REEFER, FLATBED, STEP_DECK, TANKER, CONTAINER, POWER_ONLY, OTHER
totalWeightnumber
weightUnitstring
One of LB, KG
pieceCountinteger
0 to 9007199254740991
isHazmatboolean
specialInstructionsstring
Up to 4000 characters
prioritystring
One of NORMAL, HIGH, EXPEDITED, TEAM_LOAD
ratenumber
externalTrackingUrlstring
Up to 2000 characters
stopsarray of objectrequired
stops[].sequenceintegerrequired
1 to 9007199254740991
stops[].typestringrequired
One of PICKUP, DELIVERY, TERMINAL, FUEL, REST, INSPECTION, OTHER
stops[].facilityobjectrequired
stops[].facility.namestringrequired
Up to 200 characters
stops[].facility.addressLine1string
Up to 200 characters
stops[].facility.addressLine2string
Up to 200 characters
stops[].facility.citystringrequired
Up to 120 characters
stops[].facility.statestringrequired
stops[].facility.postalCodestring
Up to 20 characters
stops[].facility.countrystring
Up to 2 characters
stops[].facility.latitudenumber
-90 to 90
stops[].facility.longitudenumber
-180 to 180
stops[].appointmentTypestring
One of FCFS, STRICT, WINDOW
stops[].appointmentStartdate-time
stops[].appointmentEnddate-time
stops[].referenceNumbersarray of string
stops[].orderNumbersarray of string
stops[].instructionsstring
Up to 2000 characters
stops[].contactNamestring
Up to 120 characters
stops[].contactPhonestring
Up to 40 characters
stops[].geofenceRadiusMetersinteger
50 to 10000
dispatchboolean
startingPointstring
One of NOT_STARTED, AT_PICKUP, PICKED_UP
pickupArrivedAtdate-time
pickupDepartedAtdate-time

Responses

200Updated. Load
201Created. Load
400The request failed validation; details lists each problem.
401Missing, invalid or revoked API key.
403The key's scopes do not cover this call.
409The load's state does not allow this (already delivered or cancelled; stops locked after dispatch).
413Body over 1 MB.
422A business rule refused the request.
500Our fault. Nothing was applied; retrying is safe.

Request

curl -X PUT https://getloadsignal.com/api/v1/loads/TMS-1001 \
  -H "Authorization: Bearer $LOADSIGNAL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "customer": {
    "name": "Example Foods"
  },
  "carrier": {
    "name": "Example Carrier",
    "mcNumber": "123456"
  },
  "customerReferenceNo": "PO-88213",
  "stops": [
    {
      "sequence": 1,
      "type": "PICKUP",
      "facility": {
        "name": "Example Foods DC 4",
        "city": "Chicago",
        "state": "IL"
      },
      "appointmentStart": "2026-09-25T13:00:00Z",
      "appointmentEnd": "2026-09-25T15:00:00Z"
    },
    {
      "sequence": 2,
      "type": "DELIVERY",
      "facility": {
        "name": "Example Foods Store 12",
        "city": "Columbus",
        "state": "OH"
      },
      "appointmentStart": "2026-09-26T14:00:00Z"
    }
  ]
}'

Response 200

{
  "load": {
    "id": "clxload001",
    "externalRef": "TMS-1001",
    "loadNumber": "LD-48213",
    "status": "IN_TRANSIT",
    "trackingStatus": "ACTIVE",
    "riskStatus": "NORMAL",
    "gpsTrust": "VERIFIED",
    "customerReferenceNo": "PO-88213",
    "customer": {
      "name": "Example Foods"
    },
    "carrier": {
      "name": "Example Carrier",
      "mcNumber": "123456",
      "dotNumber": "2345678"
    },
    "driver": {
      "firstName": "Sample",
      "lastName": "Driver",
      "phone": "+13125550100"
    },
    "stops": [
      {
        "sequence": 1,
        "type": "PICKUP",
        "status": "DEPARTED",
        "facility": {
          "name": "Example Foods DC 4",
          "addressLine1": "100 Cold St",
          "city": "Chicago",
          "state": "IL",
          "postalCode": "60601"
        },
        "timezone": "America/Chicago",
        "appointmentStart": "2026-09-25T13:00:00.000Z",
        "appointmentEnd": "2026-09-25T15:00:00.000Z",
        "arrivedAt": "2026-09-25T13:12:00.000Z",
        "departedAt": "2026-09-25T14:40:00.000Z",
        "eta": null,
        "referenceNumbers": [
          "PU-4471"
        ],
        "instructions": "Dock 7"
      }
    ],
    "location": {
      "latitude": 41.5102,
      "longitude": -87.0231,
      "capturedAt": "2026-09-25T14:02:11.000Z",
      "source": "NATIVE_APP"
    }
  }
}

POST/loads/{externalRef}/cancel

Cancel a load

Needs loads:write.

Path parameters

externalRefstringrequired
Your identifier for the load: the order or load number in your TMS. Percent-encode it once (PO/88 is PO%2F88, 100% is 100%25).
Up to 100 characters

Body fields (1)

reasonstringrequired
Up to 500 characters

Responses

200Cancelled. Load
400The request failed validation; details lists each problem.
401Missing, invalid or revoked API key.
403The key's scopes do not cover this call.
404No such load or document in your organization.
409The load's state does not allow this (already delivered or cancelled; stops locked after dispatch).
500Our fault. Nothing was applied; retrying is safe.

Request

curl -X POST https://getloadsignal.com/api/v1/loads/TMS-1001/cancel \
  -H "Authorization: Bearer $LOADSIGNAL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "reason": "The customer cancelled the order."
}'

Response 200

{
  "load": {
    "id": "clxload001",
    "externalRef": "TMS-1001",
    "loadNumber": "LD-48213",
    "status": "CANCELLED",
    "trackingStatus": "ACTIVE",
    "riskStatus": "NORMAL",
    "gpsTrust": "VERIFIED",
    "customerReferenceNo": "PO-88213",
    "customer": {
      "name": "Example Foods"
    },
    "carrier": {
      "name": "Example Carrier",
      "mcNumber": "123456",
      "dotNumber": "2345678"
    },
    "driver": {
      "firstName": "Sample",
      "lastName": "Driver",
      "phone": "+13125550100"
    },
    "stops": [
      {
        "sequence": 1,
        "type": "PICKUP",
        "status": "DEPARTED",
        "facility": {
          "name": "Example Foods DC 4",
          "addressLine1": "100 Cold St",
          "city": "Chicago",
          "state": "IL",
          "postalCode": "60601"
        },
        "timezone": "America/Chicago",
        "appointmentStart": "2026-09-25T13:00:00.000Z",
        "appointmentEnd": "2026-09-25T15:00:00.000Z",
        "arrivedAt": "2026-09-25T13:12:00.000Z",
        "departedAt": "2026-09-25T14:40:00.000Z",
        "eta": null,
        "referenceNumbers": [
          "PU-4471"
        ],
        "instructions": "Dock 7"
      }
    ],
    "location": {
      "latitude": 41.5102,
      "longitude": -87.0231,
      "capturedAt": "2026-09-25T14:02:11.000Z",
      "source": "NATIVE_APP"
    }
  }
}

Positions

Where the truck is: one load's trail, or a feed of every position across your loads.

GET/loads/{externalRef}/positions

Get a load's positions

The truck's trail on this load, oldest first by capture time. Needs positions:read.

Path parameters

externalRefstringrequired
Your identifier for the load: the order or load number in your TMS. Percent-encode it once (PO/88 is PO%2F88, 100% is 100%25).
Up to 100 characters

Query parameters

sincedate-time
Positions captured at or after this time.
untildate-time
Positions captured before this time.
limitinteger
1 to 1000. Default 500
cursorstring
nextCursor from the previous page.

Responses

200A page of positions. Position
400The request failed validation; details lists each problem.
401Missing, invalid or revoked API key.
403The key's scopes do not cover this call.
404No such load or document in your organization.
500Our fault. Nothing was applied; retrying is safe.

Request

curl https://getloadsignal.com/api/v1/loads/TMS-1001/positions \
  -H "Authorization: Bearer $LOADSIGNAL_API_KEY"

Response 200

{
  "positions": [
    {
      "id": "clxping001",
      "load": {
        "id": "clxload001",
        "externalRef": "TMS-1001",
        "loadNumber": "LD-48213"
      },
      "carrier": {
        "mcNumber": "123456",
        "dotNumber": "2345678"
      },
      "truck": {
        "unitNumber": "T-114"
      },
      "latitude": 41.5102,
      "longitude": -87.0231,
      "accuracyMeters": 8,
      "headingDegrees": 92,
      "speedMph": 61.3,
      "capturedAt": "2026-09-25T14:02:11.000Z",
      "receivedAt": "2026-09-25T14:02:13.402Z",
      "source": "NATIVE_APP",
      "flagged": false,
      "simulated": false
    }
  ],
  "nextCursor": null
}

GET/positions

Read the position feed

Every position recorded on any of your loads, in the order LoadSignal received it. Built for a system that follows many trucks: poll it about once a minute.

Start with since (or nothing, for the last 24 hours). Every response carries nextCursor, an empty page included: store it and pass it back next time, and no position is skipped or repeated. The feed orders on receipt, not capture, so a phone that uploads a backlog after a dead zone still reaches you. Positions from the last few seconds are held back until they settle. When hasMore is true, call again at once.

Needs positions:read.

Query parameters

cursorstring
nextCursor from the previous call. Takes precedence over since.
sincedate-time
Start of a new feed: positions received at or after this time.
limitinteger
1 to 1000. Default 500

Responses

200A page of the feed. Position
400The request failed validation; details lists each problem.
401Missing, invalid or revoked API key.
403The key's scopes do not cover this call.
500Our fault. Nothing was applied; retrying is safe.

Request

curl https://getloadsignal.com/api/v1/positions \
  -H "Authorization: Bearer $LOADSIGNAL_API_KEY"

Response 200

{
  "positions": [
    {
      "id": "clxping001",
      "load": {
        "id": "clxload001",
        "externalRef": "TMS-1001",
        "loadNumber": "LD-48213"
      },
      "carrier": {
        "mcNumber": "123456",
        "dotNumber": "2345678"
      },
      "truck": {
        "unitNumber": "T-114"
      },
      "latitude": 41.5102,
      "longitude": -87.0231,
      "accuracyMeters": 8,
      "headingDegrees": 92,
      "speedMph": 61.3,
      "capturedAt": "2026-09-25T14:02:11.000Z",
      "receivedAt": "2026-09-25T14:02:13.402Z",
      "source": "NATIVE_APP",
      "flagged": false,
      "simulated": false
    }
  ],
  "nextCursor": "2026-09-25T14:02:13.402Z|clxping001",
  "hasMore": false
}

Documents

Bills of lading and proofs of delivery uploaded by drivers.

GET/loads/{externalRef}/documents/{documentId}

Download a document

The file itself (PDF or image). Needs loads:read.

Path parameters

externalRefstringrequired
Your identifier for the load: the order or load number in your TMS. Percent-encode it once (PO/88 is PO%2F88, 100% is 100%25).
Up to 100 characters
documentIdstringrequired
documents[].id from the Load.

Responses

200The file.
401Missing, invalid or revoked API key.
403The key's scopes do not cover this call.
404No such load or document in your organization.
500Our fault. Nothing was applied; retrying is safe.

Request

curl https://getloadsignal.com/api/v1/loads/TMS-1001/documents/cldoc001 \
  -H "Authorization: Bearer $LOADSIGNAL_API_KEY"

Webhook events

POSTyour webhook URL

A load event

POSTed to each endpoint subscribed to the event's type. Verify X-LoadSignal-Signature against the raw body before trusting it, answer 2xx within 5 seconds, and de-duplicate on X-LoadSignal-Delivery. Events can arrive out of order under retries: order by createdAt and the load's updatedAt.

Header parameters

X-LoadSignal-Eventstringrequired
One of load.created, load.updated, load.dispatched, driver.accepted, driver.rejected, tracking.started, tracking.stopped, tracking.lost, stop.arrived, stop.departed, eta.changed, document.uploaded, document.extracted, exception.opened, exception.resolved, load.delivered, load.completed, load.cancelled, load.location, ping
X-LoadSignal-Deliverystringrequired
One id per delivery, the same on every retry of it: de-duplicate on it.
X-LoadSignal-Signaturestringrequired
t=<unix seconds>,v1=<hex HMAC-SHA256(secret, "<t>.<raw body>")>. Reject when |now − t| > 300 s.

Body fields (16)

idstringrequired
Stable per event across retries.
typestringrequired
One of load.created, load.updated, load.dispatched, driver.accepted, driver.rejected, tracking.started, tracking.stopped, tracking.lost, stop.arrived, stop.departed, eta.changed, document.uploaded, document.extracted, exception.opened, exception.resolved, load.delivered, load.completed, load.cancelled, load.location, ping
createdAtdate-timerequired
organizationIdstringrequired
dataobjectrequired
data.loadLoad
data.stopobject
stop.arrived / stop.departed.
data.stop.typestring
data.stop.idstring or null
data.locationobject
load.location.
data.location.latitudenumber
data.location.longitudenumber
data.location.capturedAtdate-time
data.messagestring or null
data.actorstring or null
data.sourcestring or null

Responses

200Received. Any 2xx counts; anything else is retried.

Error object

errorobjectrequired
error.codestringrequired
Stable, machine-readable.
error.messagestringrequired
For people; may change.
error.detailsarray of object
error.details[].pathstring
error.details[].messagestring

Position object

idstringrequired
loadobjectrequired
load.idstringrequired
load.externalRefstring or nullrequired
load.loadNumberstringrequired
carrierobject or nullrequired
carrier.mcNumberstring or null
carrier.dotNumberstring or null
truckobject or nullrequired
truck.unitNumberstring
latitudenumberrequired
-90 to 90
longitudenumberrequired
-180 to 180
accuracyMetersnumber or nullrequired
headingDegreesnumber or nullrequired
Course over ground, 0 = north.
speedMphnumber or nullrequired
capturedAtdate-timerequired
When the device took the fix.
receivedAtdate-timerequired
When LoadSignal stored it; the feed's order.
sourcestringrequired
One of DRIVER_BROWSER, NATIVE_APP, SMS_LINK, ELD, TRACTOR_GPS, CARRIER_API, MANUAL_CHECKIN, DRIVER_REPORTED, SIMULATED
flaggedbooleanrequired
LoadSignal's GPS trust checks or the phone's mock-location flag doubted this fix. Treat it as unverified.
simulatedbooleanrequired
A demo position, never a real truck.

Stop object

sequenceinteger
typestring
One of PICKUP, DELIVERY, TERMINAL, FUEL, REST, INSPECTION, OTHER
statusstring
One of PENDING, EN_ROUTE, ARRIVED, IN_PROGRESS, DEPARTED, SKIPPED, CANCELLED
facilityobject or null
facility.namestring
facility.addressLine1string
facility.citystring
facility.statestring
facility.postalCodestring
timezonestring
IANA zone of the stop, for showing times locally.
appointmentStartdate-time or null
appointmentEnddate-time or null
arrivedAtdate-time or null
departedAtdate-time or null
etadate-time or null
referenceNumbersarray of string
orderNumbersarray of string
The TMS's order numbers on this stop; not pickup numbers.
instructionsstring or null

Load object

idstring
LoadSignal's id.
externalRefstring or null
Yours.
loadNumberstring
The number the load shows in LoadSignal.
statusstring
One of UNASSIGNED, ASSIGNED, AWAITING_DRIVER_ACCEPTANCE, SCHEDULED, EN_ROUTE_TO_PICKUP, AT_PICKUP, LOADING, IN_TRANSIT, AT_DELIVERY, UNLOADING, DELIVERED, COMPLETED, CANCELLED
trackingStatusstring
One of NOT_STARTED, PENDING_PERMISSION, ACTIVE, STALE, LOST, STOPPED, COMPLETED
riskStatusstring
One of NORMAL, WATCH, AT_RISK, CRITICAL
gpsTruststring
One of UNKNOWN, VERIFIED, UNVERIFIED
commoditystring or null
equipmentTypestring
totalWeightnumber or null
weightUnitstring
pieceCountinteger or null
isHazmatboolean
specialInstructionsstring or null
prioritystring
customerReferenceNostring or null
ratenumber or null
customerobject or null
customer.namestring
carrierobject or null
carrier.namestring
carrier.mcNumberstring or null
carrier.dotNumberstring or null
driverobject or null
driver.firstNamestring
driver.lastNamestring
driver.phonestring
stopsarray of Stop
locationobject or null
The latest position; null until the truck reports.
location.latitudenumber
location.longitudenumber
location.capturedAtdate-time
location.sourcestring
etaobject or null
state is unverified once the evidence behind it is stale; treat it as history then.
eta.atdate-time
eta.confidencestring or null
eta.sourcestring
eta.includesRestboolean
eta.statestring
One of current, unverified
eta.unverifiedReasonstring or null
eta.asOfdate-time or null
pickupReachobject or null
pickupReach.remainingMilesnumber
pickupReach.driveMinutesnumber
pickupReach.spareMinutesnumber
pickupReach.verdictstring
One of can_make, tight, cannot_make
pickupReach.labelstring
lastPositionobject or null
lastPosition.atdate-time
lastPosition.sourcestring
lastPosition.ageMinutesinteger
lastPosition.freshnessstring
One of fresh, stale, lost
lastPosition.labelstring
documentsarray of object
documents[].idstring
documents[].typestring
documents[].uploadedAtdate-time
documents[].stopSequenceinteger or null
documents[].urlstring
openExceptionsarray of object
openExceptions[].idstring
openExceptions[].typestring
openExceptions[].severitystring
openExceptions[].summarystring
openExceptions[].detectedAtdate-time
openExceptions[].statusstring
openExceptions[].recommendedActionstring or null
watcherUserIdsarray of string
trackingobject or null
tracking.coveragePercentnumber or null
tracking.gapMinutesnumber
tracking.gapsarray of object
tracking.gaps[].fromdate-time
tracking.gaps[].todate-time
tracking.gaps[].minutesnumber
tracking.gaps[].kindstring
dispatchedAtdate-time or null
deliveredAtdate-time or null
completedAtdate-time or null
cancelledAtdate-time or null
cancellationReasonstring or null
createdAtdate-time
updatedAtdate-time

Webhook Event object

idstringrequired
Stable per event across retries.
typestringrequired
One of load.created, load.updated, load.dispatched, driver.accepted, driver.rejected, tracking.started, tracking.stopped, tracking.lost, stop.arrived, stop.departed, eta.changed, document.uploaded, document.extracted, exception.opened, exception.resolved, load.delivered, load.completed, load.cancelled, load.location, ping
createdAtdate-timerequired
organizationIdstringrequired
dataobjectrequired
data.loadLoad
data.stopobject
stop.arrived / stop.departed.
data.stop.typestring
data.stop.idstring or null
data.locationobject
load.location.
data.location.latitudenumber
data.location.longitudenumber
data.location.capturedAtdate-time
data.messagestring or null
data.actorstring or null
data.sourcestring or null

Authentication

Scopes

Errors

Pagination

Times

Positions and consent

Webhooks

Limits

Loads

List loads

Query parameters

Responses

Get a load

Path parameters

Responses

Create or update a load

Path parameters

Responses

Cancel a load

Path parameters

Responses

Positions

Get a load's positions

Path parameters

Query parameters

Responses

Read the position feed

Query parameters

Responses

Documents

Download a document

Path parameters

Responses

Webhook events

A load event

Header parameters

Responses

Error object

Position object

Stop object

Load object

Webhook Event object