Skip to main content
PUT
Set stop appointment
Updates the scheduling information for a specific stop within a trip. This endpoint allows updating the stop appointment details including:
  • schedule type
  • loading type
  • appointment date
  • appointment request / confirmation flags
  • delivery window (for FCFS stops)
The response returns the updated stop object.

Endpoint


Request Parameters


Request Body

Conditional validation rules:
  • If ScheduleType = APPT, you must provide AppointmentDate.
  • If ScheduleType = FCFS, you must provide WindowBegin.
  • If both WindowBegin and WindowEnd are provided, WindowBegin must be earlier than WindowEnd.

Example Request Body


Example CURL request

Replace:
  • {version} with the API version (for example 1)
  • {tripId} with the actual trip ID
  • {stopId} with the stop ID
  • YOUR_ACCESS_TOKEN with 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

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
stopId
string
required
version
string
default:1.0
required

API version (e.g., 1.0)

Example:

"1.0"

Body

ScheduleType
string
required
LoadingType
string
required
AppointmentRequested
boolean
required
AppointmentConfirmed
boolean
required
AppointmentDate
string | null
WindowBegin
string | null
WindowEnd
string | null

Response

OK

AppointmentRequested
boolean
required
AppointmentConfirmed
boolean
required
ScheduleType
string
required
Id
string
required
StopType
string
required
References
object[]
required
$type
string
required

Type discriminator for polymorphic serialization

AppointmentDate
string<date-time> | null
LoadingType
string | null
Address
object | null
Coordinates
object | null
Status
string | null
ArrivedAt
string<date-time> | null
DepartedAt
string<date-time> | null
CompanyId
string | null
CompanyNumber
string | null
CompanyName
string | null