Log a trip check call

Logs a check call (driver status update) on an in-progress trip. Only accepted while the trip is Covered, Dispatched, or In Transit.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Log a check call (driver status update) on a trip. Check calls are trip-level, so the load number, trip number, identity, and timestamp are resolved server-side from the trip in the URL path.

The trip must be in progress (Covered, Dispatched, or In Transit); a check call on a terminal, pre-dispatch, or post-delivery-billing trip is rejected with 422.

Endpoint

POST /api/p/v{version}/trips/{tripId}/check-calls

Request Parameters

ParameterTypeRequiredDescription
versionStringYesAPI version to use (2.0).
tripIdStringYesUnique identifier of the trip.

Request Body

FieldTypeRequiredDescription
DescriptionstringYesFree-text note for the check call (e.g. the driver's reply). Max 4000 characters.
ActivitystringNoThe activity reported (e.g. Driving, At Pickup). Max 100 characters.
DriverIdstringNoId of the driver to attribute the check call to. Must be one of the trip's assigned drivers (a team trip has two). Omit to record at the trip level.
LocationobjectNoStructured location: Street, City, State, Zip, Country, Coordinates (Longitude). All fields optional.
SetpointTemperatureobjectNoReefer set-point temperature: Value (number) + Unit (Fahrenheit / Celsius / Kelvin).
ReturnTemperatureobjectNoReefer return temperature: Value + Unit.

Example CURL request

curl --location 'https://integrations.alvys.com/api/p/v{version}/trips/{tripId}/check-calls' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
--header 'Content-Type: application/json' \
--data '{
  "Description": "Driver reports on schedule",
  "Activity": "Driving",
  "DriverId": "DR2517179655771527026",
  "Location": {
    "City": "Dallas",
    "State": "TX",
    "Coordinates": { "Latitude": "32.7767", "Longitude": "-96.7970" }
  },
  "SetpointTemperature": { "Value": 34, "Unit": "Fahrenheit" }
}'

Replace {version} with 2.0, {tripId} with the actual trip ID, and YOUR_ACCESS_TOKEN with a valid token.

Response Body

The created check-call object:

NameTypeDescription
IdstringUnique identifier of the check call.
LoadNumberstringLoad number the check call belongs to.
DescriptionstringFree-text note captured with the check call.
Locationobject, nullStructured location (Street, City, State, Zip, Country, Coordinates).
CreatedAtstring, nullUTC timestamp when the check call was recorded.
Activitystring, nullThe activity reported (e.g. Driving, At Pickup).
ResponseTypestring, nullCategorization of the response (e.g. arrival, departure).
CreatedBystring, nullName of the user or integration that logged the check call.
DriverNamestring, nullAssigned driver's name, if known.
TripIdstringId of the trip the check call belongs to.
TripNumberstring, nullRelated trip number, if known.
SetpointTemperatureobject, nullReefer set-point temperature (Value, Unit).
ReturnTemperatureobject, nullReefer return temperature (Value, Unit).

Example Response (201 Created)

{
  "Id": "9f1c2a7b3e4d4f8a9b0c1d2e3f4a5b6c",
  "LoadNumber": "L100245",
  "Description": "Driver reports on schedule",
  "Location": {
    "Street": "",
    "City": "Dallas",
    "State": "TX",
    "Zip": "",
    "Country": "",
    "Coordinates": { "Latitude": "32.7767", "Longitude": "-96.7970" }
  },
  "CreatedAt": "2026-07-08T15:04:07+00:00",
  "Activity": "Driving",
  "ResponseType": null,
  "CreatedBy": "public-api-tl743-integration",
  "DriverName": "Jordan Rivera",
  "TripId": "b93e5cf1b6134f5e9a78b07af2870d9b",
  "TripNumber": "T100245-1",
  "SetpointTemperature": { "Value": 34, "Unit": "Fahrenheit" },
  "ReturnTemperature": null
}

Status Codes

CodeMeaning
201Check call logged.
400Validation error (e.g. empty Description).
401Missing or invalid access token.
403Token lacks the required scope.
404Trip not found (or not accessible to your tenant).
422Trip is not in progress, or DriverId is not assigned to the trip.
429Rate limit exceeded.

Rate Limits

All endpoints are subject to rate limits to protect the API from traffic spikes.
For detailed information, see the Rate Limits section.


Try It Out

This page is interactive, allowing you to try a request by specifying the API version and tripId in the URL path and editing the request body.

As you fill out the parameters, the cURL command on the right side of the page will be automatically updated. Alternatively, you can directly edit the cURL command.

⚠️ Don’t forget: make sure to authorize yourself before trying a request.

Path Params
string
required
string
required
Defaults to 2.0

API version (e.g., 2.0)

Body Params
string
required
length between 1 and 4000

Free-text note for the check call (e.g. the driver's reply).

string | null

The activity reported (e.g. Driving, At Pickup).

string | null

Id of the driver to attribute the check call to. Must be one of the trip's assigned drivers.

Location
object
SetpointTemperature
object
ReturnTemperature
object
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json-patch+json

Generated from available request content types

Allowed:
Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json