get
https://integrations.alvys.com/api/p/v/trips//stops
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Each stop contains scheduling information, location details, operational timestamps (arrival and departure), and optional references such as PO numbers or other identifiers.
Endpoint
GET /api/p/v{version}/trips/{tripId}/stopsRequest Parameters
The following parameters are required in the URL path:
| Parameter | Type | Required | Description |
|---|---|---|---|
| version | String | Yes | The API version to use. |
| tripId | String | Yes | Unique identifier of the trip. |
Example CURL request
curl --location 'https://integrations.alvys.com/api/p/v1/trips/{tripId}/stops' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN'Replace:
{version}with the API version (for example1){tripId}with the actual trip IDYOUR_ACCESS_TOKENwith your Bearer token
Example:
curl --location 'https://integrations.alvys.com/api/p/v1/trips/000c3a9bf0000000bf000d000e000a0b/stops' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ...'Response Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | Yes | Unique identifier of the stop. |
| address.street | string | No | Street address of the stop location. |
| address.city | string | No | City of the stop location. |
| address.state | string | No | State of the stop location. |
| address.zipCode | string | No | ZIP code of the stop location. |
| appointmentConfirmed | boolean | No | Indicates whether the appointment has been confirmed. |
| appointmentDate | string (datetime) | No | Appointment date/time when scheduleType = APPT. |
| appointmentRequested | boolean | No | Indicates whether an appointment has been requested. |
| arrivedAt | string (datetime) | No | Timestamp when the stop was arrived at (UTC). |
| companyId | string | No | Unique identifier of the company associated with the stop. |
| companyName | string | No | Name of the company associated with the stop. |
| companyNumber | string | No | Company registration or identification number. |
| coordinates.latitude | string | No | Latitude of the stop location. |
| coordinates.longitude | string | No | Longitude of the stop location. |
| departedAt | string (datetime) | No | Timestamp when the stop was departed from (UTC). |
| loadingType | string | No | Loading type at the stop (for example Live, Drop, Hook, Drop&Hook). |
| references[] | array | No | List of references associated with the stop. |
| references[].access | string | No | Access level of the reference (Internal, Public). |
| references[].id | string | No | Unique identifier of the reference. |
| references[].name | string | No | Name of the reference field. |
| references[].origin | string | No | Origin of the reference (for example Manual, Integration). |
| references[].referenceId | string | No | External reference identifier. |
| references[].type | string | No | Reference type (for example Text, Date). |
| references[].value | string | No | Value of the reference. |
| scheduleType | string | No | Schedule type of the stop (APPT or FCFS). |
| status | string | No | Current operational status of the stop. |
| stopType | string | No | Type of stop (for example Pickup, Delivery, Waypoint). |
| stopWindow.begin | string (datetime) | No | Start of the delivery window when scheduleType = FCFS. |
| stopWindow.end | string (datetime) | No | End of the delivery window when scheduleType = FCFS. |
| $type | string | No | Polymorphic type discriminator for the stop representation (appointment, delivery_window, waypoint). |
Example Response
[
{
"appointmentRequested": true,
"appointmentConfirmed": true,
"appointmentDate": "2026-03-16T11:05:40.106Z",
"scheduleType": "APPT",
"loadingType": "Live",
"id": "string",
"address": {
"street": "123 Industrial Rd",
"city": "Dallas",
"state": "TX",
"zipCode": "75201"
},
"coordinates": {
"latitude": "32.7767",
"longitude": "-96.7970"
},
"status": "Open",
"stopType": "Pickup",
"arrivedAt": "2026-03-16T11:05:40.106Z",
"departedAt": "2026-03-16T11:45:40.106Z",
"references": [
{
"id": "string",
"referenceId": "PO123456",
"name": "PO Number",
"value": "PO123456",
"type": "Text",
"access": "Public",
"origin": "Manual"
}
],
"companyId": "string",
"companyNumber": "GT530",
"companyName": "Alvys Distribution",
"$type": "appointment"
}
]Status Codes
| Status Code | Description |
|---|---|
| 200 OK | Trip stops successfully retrieved. |
| 404 Not Found | Trip does not exist or is not visible. |
Versioning
The version parameter in the URL path specifies which version of the API you are using. Including the version ensures that your integration interacts with the correct API contract and remains compatible as the API evolves.
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.