Skip to main content
POST
Log a trip check call
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

Request Parameters

Request Body

Example CURL request

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

Response Body

The created check-call object:

Example Response (201 Created)

Status Codes


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.

Authorizations

Authorization
string
header
required

OAuth 2.0 client-credentials access token. Obtain one from https://auth.alvys.com/oauth/token (grant_type=client_credentials, audience=https://api.alvys.com/public/), then paste it here. The playground sends it as Authorization: Bearer <token>.

Path Parameters

tripId
string
required
version
string
default:1.0
required

API version (e.g., 1.0)

Example:

"1.0"

Body

Description
string
required

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

Required string length: 1 - 4000
Activity
string | null

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

Maximum string length: 100
DriverId
string | null

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

Maximum string length: 100
Location
object
SetpointTemperature
object
ReturnTemperature
object

Response

Created

Id
string
required

Unique identifier of the check call.

LoadNumber
string
required

Load number the check call belongs to.

Description
string
required

Free-text note captured with the check call.

TripId
string
required

Id of the trip the check call belongs to.

Location
object
CreatedAt
string<date-time> | null

When the check call was recorded (UTC).

Activity
string | null

The activity reported.

ResponseType
string | null

Categorization of the response (e.g. arrival, departure).

CreatedBy
string | null

Name of the user or integration that logged the check call.

DriverName
string | null

Assigned driver's name, if known.

TripNumber
string | null

Related trip number, if known.

SetpointTemperature
object
ReturnTemperature
object