This endpoint marks the stop as arrived and updates the stop’s ArrivedAt timestamp.
If an arrival time is provided in the request body, that value will be used. Otherwise, the system records the current UTC time.

The response returns the updated stop object.

Endpoint

PUT /api/p/v{version}/trips/{tripId}/stops/{stopId}/arrival

Request Parameters

Parameter	Type	Required	Description
version	string	Yes	API version (e.g. `1.0`).
tripId	string	Yes	Unique identifier of the trip.
stopId	string	Yes	Unique identifier of the stop.

Request Body

Field	Type	Required	Description
ArrivedAt	string (datetime)	No	Arrival timestamp in ISO-8601 UTC format. If not provided, the system records the current UTC time.

Example Request Body

{
  "ArrivedAt": "2026-03-16T12:34:30.277Z"
}

Example CURL request

curl --location --request PUT 'https://integrations.alvys.com/api/p/v1/trips/{tripId}/stops/{stopId}/arrival' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
--header 'Content-Type: application/json' \
--data '{
  "ArrivedAt": "2026-03-16T12:34:30.277Z"
}'

Response Parameters

Parameter	Type	Description
id	string	Unique identifier of the stop.
address.street	string	Street address of the stop location.
address.city	string	City of the stop location.
address.state	string	State of the stop location.
address.zipCode	string	ZIP code of the stop location.
appointmentConfirmed	boolean	Indicates whether the appointment has been confirmed.
appointmentDate	string (datetime)	Appointment date and time for the stop.
appointmentRequested	boolean	Indicates whether an appointment has been requested.
arrivedAt	string (datetime)	Timestamp when the stop was marked as arrived (UTC).
departedAt	string (datetime)	Timestamp when the stop was departed (UTC).
scheduleType	string	Schedule type (`APPT` or `FCFS`).
loadingType	string	Loading type (`Live`, `Drop`, `Hook`, etc.).
stopType	string	Type of stop (`Pickup`, `Delivery`, `Waypoint`).
status	string	Operational status of the stop.
coordinates.latitude	string	Latitude of the stop location.
coordinates.longitude	string	Longitude of the stop location.
references[]	array	List of references associated with the stop.
references[].id	string	Reference identifier.
references[].referenceId	string	External reference identifier.
references[].name	string	Name of the reference field.
references[].value	string	Value of the reference.
references[].type	string	Type of reference.
references[].access	string	Access level.
references[].origin	string	Origin of the reference.
companyId	string	Identifier of the company associated with the stop.
companyNumber	string	Company registration or identification number.
companyName	string	Company name associated with the stop.

Example Response

{
  "AppointmentRequested": true,
  "AppointmentConfirmed": true,
  "AppointmentDate": "2026-03-16T12:34:30.277Z",
  "ScheduleType": "string",
  "LoadingType": "string",
  "Id": "string",
  "Address": {
    "Street": "string",
    "City": "string",
    "State": "string",
    "ZipCode": "string"
  },
  "Coordinates": {
    "Latitude": "string",
    "Longitude": "string"
  },
  "Status": "string",
  "StopType": "string",
  "ArrivedAt": "2026-03-16T12:34:30.277Z",
  "DepartedAt": "2026-03-16T12:34:30.277Z",
  "References": [
    {
      "Id": "string",
      "ReferenceId": "string",
      "Name": "string",
      "Value": "string",
      "Type": "string",
      "Access": "string",
      "Origin": "string"
    }
  ],
  "CompanyId": "string",
  "CompanyNumber": "string",
  "CompanyName": "string"
}

Status Codes

Status Code	Description
200 OK	Stop arrival successfully recorded.
400 Bad Request	Invalid request body or timestamp format.
404 Not Found	Trip or stop could not be found.

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.