Guides
Changelog
Back to All
Added

Manage Stop Arrivals, Departures & Appointments via the Public API

4 months ago

Release Date: March 13, 2026

What's New?

The Public API now supports full stop-level trip execution: read a trip's stops, record (or clear) arrivals, record departures, and manage stop appointments — so dispatch events can flow into Alvys from your own systems in real time.

What Changed?

Previously, stop arrivals, departures, and appointment changes could only be recorded inside the Alvys platform.

Now, the Public API includes the following endpoints:

GET    /api/p/v{version}/trips/{tripId}/stops
GET    /api/p/v{version}/trips/{tripId}/stops/{stopId}
PUT    /api/p/v{version}/trips/{tripId}/stops/{stopId}/arrival
DELETE /api/p/v{version}/trips/{tripId}/stops/{stopId}/arrival
PUT    /api/p/v{version}/trips/{tripId}/stops/{stopId}/departure
PUT    /api/p/v{version}/trips/{tripId}/stops/{stopId}/appointment
  • Record stop arrival — body takes a required arrivedAt timestamp; returns the updated stop.
  • Clear stop arrival — removes a previously recorded arrival.
  • Record stop departure — body takes a required departedAt timestamp; returns 422 if the stop is not in a state that can be departed.
  • Set stop appointment — update the stop's scheduleType, loadingType, and appointment window.

All mutation endpoints return the updated StopResponse, so callers get fresh state without a follow-up read.

Why?

EDI providers, driver apps, and dispatch systems generate arrival/departure events outside Alvys. These endpoints let those events land directly on the trip's stops, keeping statuses, timestamps, and downstream billing (e.g. detention) accurate.