Trips
Set stop appointment
Set or update the appointment window on a trip stop by trip and stop ID, including scheduled date, start and end time, and appointment type.
PUT
Set stop appointment
Updates the scheduling information for a specific stop within a trip.
This endpoint allows updating the stop appointment details including:
Replace:
- schedule type
- loading type
- appointment date
- appointment request / confirmation flags
- delivery window (for FCFS stops)
Endpoint
Request Parameters
Request Body
Accepted date/time formats.
yyyy-MM-dd, optionally followed by THH:mm, THH:mm:ss, or fractional seconds, and optionally a Z or ±hh:mm offset. A value in any other format — including MM/dd/yyyy — is rejected with 400 and the offending field named. A value sent without a UTC offset is read as the stop’s local time.WindowBegin and WindowEnd are compared as points in time, not as digits, so a pair sent with different offsets is accepted when it is correctly ordered.Example Request Body
Example CURL request
{version}with the API version (for example1){tripId}with the actual trip ID{stopId}with the stop IDYOUR_ACCESS_TOKENwith your Bearer token
Response Parameters
Example Response
Status Codes
Rate Limits
All endpoints are subject to API rate limits to ensure service stability and protect against traffic spikes. Refer to the Rate Limits documentation for more information.Authorizations
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
API version (e.g., 1.0)
Example:
"1.0"
Body
Response
OK
- Option 1
- Option 2
- Option 3
Type discriminator for polymorphic serialization
Estimated time of arrival at this stop. Null when no estimate exists.