The Retrieve All Trips API endpoint allows you to retrieve a list of all trips in the Alvys system. This endpoint provides comprehensive data about each trip, facilitating effective management and tracking of trips within the system.
Request Parameters
The following parameter is required in the URL path:
| Parameter | Type | Required | Description |
|---|---|---|---|
| version | String | Yes | The API version to use. |
| tripNumber | String | Conditionally | The trip number to filter results. This field is required if the other conditionally required fields are left empty. |
| id | String | Conditionally | The trip id to filter results. This field is required if the other conditionally required fields are left empty. |
Example CURL request
Example using Trip ID:
curl --location 'https://integrations.alvys.com/api/p/v{version}/trips?id={tripId}' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN'Example using Trip Number:
curl --location 'https://integrations.alvys.com/api/p/v{version}/trips?tripNumber={tripNumber}' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN'Replace {version} with the API version number, {tripId} with the actual trip ID, {tripNumber} with the actual trip number, and YOUR_ACCESS_TOKEN with your actual Bearer token:
Using Trip ID:
curl --location 'https://integrations.alvys.com/api/p/v1/trips?id=000c3a9bf0000000bf000d000e000a0b' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ...'Using Trip Number:
curl --location 'https://integrations.alvys.com/api/p/v1/trips?tripNumber=123456789' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ....'Response Parameters
The following table lists the parameters included in the response for trip-related requests:
| Parameter | Type | Required | Description |
| id | string | Yes | Unique ID of the trip. |
|---|---|---|---|
| tripNumber | string | Yes | Trip number. |
| status | string | Yes | Current status of the trip. |
| loadNumber | string | No | Associated load number. |
| tenderAs | string | No | Tendered as Broker or Carrier. |
| pickupDate | string (datetime) | No | Planned pickup date (UTC). |
| deliveryDate | string (datetime) | No | Planned delivery date (UTC). |
| pickedUpAt | string (datetime) | No | Actual pickup timestamp (UTC). |
| deliveredAt | string (datetime) | No | Actual delivery timestamp (UTC). |
| carrierAssignedAt | string (datetime) | No | When the carrier was assigned. |
| releasedAt | string (datetime) | No | When the trip was released. |
| releasedBy | string | No | User who released the trip. |
| dispatchedBy | string | No | User who dispatched the trip. |
| dispatcherId | string | No | Dispatcher user ID. |
| carrierSalesAgentId | string | No | Carrier sales agent user ID. |
| carrierPayOnHold | boolean | No | Whether carrier pay is on hold. |
| updatedAt | string (datetime) | No | When the trip was last updated (UTC). |
| updatedBy | string | No | User who last updated the trip. |
| isDeleted | boolean | No | Indicates if the trip is marked as deleted. |
| totalMileage.distance.value | number | No | Total trip distance. |
| totalMileage.distance.unitOfMeasure | string | No | Unit for total mileage. |
| emptyMileage.distance.value | number | No | Empty mileage distance. |
| emptyMileage.distance.unitOfMeasure | string | No | Unit for empty mileage. |
| loadedMileage.distance.value | number | No | Loaded mileage distance. |
| loadedMileage.distance.unitOfMeasure | string | No | Unit for loaded mileage. |
| tripValue.amount | number | No | Total payable amount for the trip. |
| tripValue.currency | string | No | Currency of the trip value. |
| truck.id | string | No | ID of the assigned truck. |
| trailer.id | string | No | ID of the assigned trailer. |
| trailer.equipmentType | string | No | Type of trailer equipment. |
| trailer.equipmentLength.value | number | No | Length of the trailer. |
| trailer.equipmentLength.unitOfMeasure | string | No | Unit for trailer length (e.g., Feet). |
| driver1.accessorialsDetails[] | array of objects | No | List of driver1 accessorials. |
| driver2.accessorialsDetails[] | array of objects | No | List of driver2 accessorials. |
| ownerOperator.accessorialsDetails[] | array of objects | No | List of owner-operator accessorials. |
| carrier.accessorialsDetails[] | array of objects | No | List of carrier accessorials. |
| [*.accessorialsDetails[]].id | string | Yes | Unique ID of the accessorial. |
| [*.accessorialsDetails[]].type | string | Yes | Type of accessorial (e.g., Detention). |
| [*.accessorialsDetails[]].total.amount | number | Yes | Total charge amount. |
| [*.accessorialsDetails[]].total.currency | string | Yes | Currency of the total. |
| [*.accessorialsDetails[]].rate.amount | number | No | Rate per unit. |
| [*.accessorialsDetails[]].rate.currency | string | No | Currency of the rate. |
| [*.accessorialsDetails[]].rateType | string | No | Rate type (Flat, PerHour, etc). |
| [*.accessorialsDetails[]].uom | string | No | Unit of measure (e.g., Hours, Miles). |
| [*.accessorialsDetails[]].quantity | number | No | Quantity of units billed. |
| [*.accessorialsDetails[]].isPaid | boolean | No | If present, indicates whether accessorial has been paid. |
| [*.accessorialsDetails[]].stopId | string | No | ID of the stop this accessorial is linked to (if applicable). |
| [*.accessorialsDetails[]].eCheckNumber | string | No | Associated ECheck number if applicable. |
| [*.accessorialsDetails[]].createdAt | string (datetime) | No | When the accessorial was created (UTC). |
| [*.accessorialsDetails[]].createdBy | string | No | User who created the accessorial. |
| [*.accessorialsDetails[]].updatedAt | string (datetime) | No | When the accessorial was last updated (UTC). |
| [*.accessorialsDetails[]].updatedBy | string | No | User who last updated the accessorial. |
| driver1.eChecks[] | array of objects | No | List of EChecks for driver1. |
| driver2.eChecks[] | array of objects | No | List of EChecks for driver2. |
| ownerOperator.eChecks[] | array of objects | No | List of EChecks for owner operator. |
| carrier.eChecks[] | array of objects | No | List of EChecks for carrier. |
| [*.eChecks[]].id | string | Yes | Unique ID of the ECheck. |
| [*.eChecks[]].checkNumber | string | Yes | ECheck number. |
| [*.eChecks[]].amount.amount | number | Yes | Amount value of the ECheck. |
| [*.eChecks[]].amount.currency | string | Yes | Currency of the ECheck amount. |
| [*.eChecks[]].fee.amount | number | No | Fee value of the ECheck. |
| [*.eChecks[]].fee.currency | string | No | Currency of the fee. |
| [*.eChecks[]].type | string | No | Type of ECheck. |
| [*.eChecks[]].isPaid | boolean | No | Indicates whether the ECheck is paid. |
| [*.eChecks[]].createdAt | string (datetime) | No | When the ECheck was created (UTC). |
Versioning
The version parameter in the URL path specifies which version of the API you are using. Including the version number ensures that your application interacts with the correct version of the API, providing stability and compatibility as the API evolves. For more information on how versioning works and how to include it in your requests, please refer to the Versioning page.
Example Response
On the right side, you can see examples of different error codes by clicking "Example" and selecting the response code.
Rate Limits
All endpoints are subject to rate limits to protect the API from traffic spikes. For detailed information on rate limits, please refer to the Rate Limits section.
This page is interactive, allowing you to try a request by specifying the API version in the URL path and providing the necessary request body. As you fill out the parameters, the Curl command on the right side of the page will be automatically updated. Alternatively, you can fork our Public API Postman Collection directly. Make sure to authorize yourself before trying a request.