put
https://integrations.alvys.com/api/p/v/trips//stops//appointment
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
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
PUT /api/p/v{version}/trips/{tripId}/stops/{stopId}/appointmentRequest 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 |
|---|---|---|---|
| ScheduleType | string | Yes | Schedule type of the stop (APPT or FCFS). |
| LoadingType | string | Yes | Loading type (Live, Drop, Hook, Drop&Hook). |
| AppointmentDate | string (datetime) | Conditional | Appointment date and time in ISO-8601 UTC format. Required when ScheduleType = APPT. |
| AppointmentRequested | boolean | Yes | Indicates whether an appointment has been requested. |
| AppointmentConfirmed | boolean | Yes | Indicates whether the appointment has been confirmed. |
| WindowBegin | string (datetime) | Conditional | Start of the delivery window in ISO-8601 UTC format. Required when ScheduleType = FCFS. |
| WindowEnd | string (datetime) | No | End of the delivery window in ISO-8601 UTC format. Used when ScheduleType = FCFS. If provided alongside WindowBegin, must be after WindowBegin. |
Conditional validation rules:
- If
ScheduleType = APPT, you must provideAppointmentDate.- If
ScheduleType = FCFS, you must provideWindowBegin.- If both
WindowBeginandWindowEndare provided,WindowBeginmust be earlier thanWindowEnd.
Example Request Body
{
"ScheduleType": "string",
"LoadingType": "string",
"AppointmentDate": "string",
"AppointmentRequested": true,
"AppointmentConfirmed": true,
"WindowBegin": "string",
"WindowEnd": "string"
}Example CURL request
curl --location --request PUT 'https://integrations.alvys.com/api/p/v1/trips/{tripId}/stops/{stopId}/appointment' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
--header 'Content-Type: application/json' \
--data '{
"ScheduleType": "APPT",
"LoadingType": "Live",
"AppointmentDate": "2026-03-16T12:45:43.262Z",
"AppointmentRequested": true,
"AppointmentConfirmed": true
}'Replace:
{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
| 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 marked as 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 (Public, Internal). |
| 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:45:43.262Z",
"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:45:43.262Z",
"DepartedAt": "2026-03-16T12:45:43.262Z",
"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 appointment successfully updated. |
| 400 Bad Request | Invalid request body. |
| 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.