Skip to main content
GET
Get tracking for a load
Provisional endpoint
This endpoint is available for early access. The core schema is stable, but minor details — such as field names or added fields — may change before it becomes generally available. Backward compatibility is not guaranteed.

See API Stability & Versioning for details on provisional endpoints.

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

load_id
string<uuid>
required

Response

Successful Response

Where a load stands right now.

load_id
string<uuid>
required

Catena identifier of the load.

load_ref
string
required

Your reference for the load, as posted.

tracking_health
enum<string>
default:unknown
required

How far to trust last_position. See the values for what each means.

Available options:
live,
stale,
no_signal,
not_shared,
unassigned,
unknown
vehicle_assignment
LoadTrackingVehicleAssignmentRead · object | null
required

The vehicle carrying the load. If you sent vehicle identifiers, the best vehicle they matched, or null when none matched a vehicle you can see. If you sent none, the best vehicle matched from location data, or null when no vehicle has been seen at the origin yet, none matched well enough, or none is in a fleet that shares vehicle and location data with you.

last_position
LoadTrackingPositionRead · object | null
required

The last position the assigned vehicle reported, however long ago. Null when there is no vehicle_assignment, the vehicle has not reported a position, or the vehicle's fleet does not share location data with you.

stops
LoadTrackingStopRead · object[]
required

The load's stops in travel order, origin first and destination last. Each is meant to say when the vehicle is expected to arrive and leave (as you posted them) and when it actually did, but actual times are not recorded yet.