get https://integrations.alvys.com/api/p/v/trips
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 | The unique identifier of the trip. |
| tripNumber | string | Yes | The number associated with the trip. |
| status | string | No | The current status of the trip. |
| loadNumber | string | No | The load number associated with the trip. |
| tenderAs | string | No | Role under which the trip was tendered. |
| stops[] | array of objects | No | The list of stops associated with the trip. |
| stops[].id | string | No | The unique identifier of the stop. |
| stops[].address.street | string | No | The street address of the stop. |
| stops[].address.city | string | No | The city of the stop. |
| stops[].address.state | string | No | The state of the stop. |
| stops[].address.zipCode | string | No | The ZIP code of the stop. |
| stops[].coordinates.latitude | string | No | The latitude of the stop location. |
| stops[].coordinates.longitude | string | No | The longitude of the stop location. |
| stops[].status | string | No | The current status of the stop. |
| stops[].stopType | string | No | The type of stop (e.g., Pickup, Delivery). |
| stops[].scheduleType | string | No | The schedule type of the stop. If APPT, see appointmentDate; if FCFS, see stopWindow.*. |
| stops[].appointmentDate | string (datetime) | No | Appointment date/time for the stop. Only populated when scheduleType = APPT. |
| stops[].stopWindow.begin | string (datetime) | No | Window begin time for the stop. Only populated when scheduleType = FCFS. |
| stops[].stopWindow.end | string (datetime) | No | Window end time for the stop. Only populated when scheduleType = FCFS. |
| stops[].loadingType | string | No | The loading type at the stop. |
| stops[].arrivedAt | string (datetime) | No | When the stop was arrived at (UTC). |
| stops[].departedAt | string (datetime) | No | When the stop was departed from (UTC). |
| stops[].references[] | array of objects | No | A list of references associated with the stop. |
| stops[].references[].id | string | No | The unique identifier of the reference. |
| stops[].references[].referenceId | string | No | The external reference ID. |
| stops[].references[].name | string | No | The name of the reference. |
| stops[].references[].value | string | No | The value of the reference. |
| stops[].references[].type | string | No | The type of reference (e.g., Text, Date). |
| stops[].references[].access | string | No | The access level (e.g., Internal, Public). |
| stops[].references[].origin | string | No | Origin of the reference field (e.g., Manual, Integration). |
| stops[].companyId | string | No | The unique identifier of the company associated with the stop. |
| totalMileage.distance.value | number | No | Total mileage value. |
| totalMileage.distance.unitOfMeasure | string | No | Unit of measure for total mileage (e.g., Miles). |
| totalMileage.source | string | No | Source of total mileage. |
| totalMileage.profileId | string | No | ID of mileage profile used. |
| totalMileage.profileName | string | No | Name of mileage profile used. |
| emptyMileage.distance.value | number | No | Empty mileage value. |
| emptyMileage.distance.unitOfMeasure | string | No | Unit of measure for empty mileage. |
| loadedMileage.distance.value | number | No | Loaded mileage value. |
| loadedMileage.distance.unitOfMeasure | string | No | Unit of measure for loaded mileage. |
| pickupDate | string (datetime) | No | Scheduled pickup date. |
| deliveryDate | string (datetime) | No | Scheduled delivery date. |
| pickedUpAt | string (datetime) | No | Actual pickup timestamp. |
| deliveredAt | string (datetime) | No | Actual delivery timestamp. |
| carrierAssignedAt | string (datetime) | No | Carrier assignment timestamp. |
| releasedAt | string (datetime) | No | Timestamp when the trip was marked as released. |
| tripValue.amount | number | No | Total trip value. |
| tripValue.currency | string | No | Currency for trip value. |
| truck.id | string | No | ID of the truck. |
| truck.fleet.id | string | No | Fleet ID of the truck. |
| truck.fleet.name | string | No | Fleet name of the truck. |
| truck.fleet.invoiceNumberPrefix | string | No | Invoice number prefix for the truck fleet. |
| trailer.id | string | No | ID of the trailer. |
| trailer.equipmentType | string | No | Equipment type of trailer. |
| trailer.equipmentLength.value | number | No | Trailer length. |
| trailer.equipmentLength.unitOfMeasure | string | No | Unit for trailer length (e.g., Feet). |
| trailer.fleet.id | string | No | Fleet ID of the trailer. |
| trailer.fleet.name | string | No | Fleet name of the trailer. |
| trailer.fleet.invoiceNumberPrefix | string | No | Invoice number prefix for the trailer fleet. |
| driver1.id | string | No | Unique ID of driver 1. |
| driver1.contractorType | string | No | Contractor type of driver 1. |
| driver1.rates[] | array of objects | No | Rates applied to driver 1 (rate, extraStops, rateType, perDiemRateType, freeUnit, source). |
| driver1.fleet.id | string | No | Fleet ID of driver 1. |
| driver1.fleet.name | string | No | Fleet name of driver 1. |
| driver1.fleet.invoiceNumberPrefix | string | No | Invoice number prefix for driver 1 fleet. |
| driver1.accessorialsDetails[] | array of objects | No | List of driver1 accessorials. |
| driver1.eChecks[] | array of objects | No | List of EChecks for driver1. |
| driver2.id | string | No | Unique ID of driver 2. |
| driver2.contractorType | string | No | Contractor type of driver 2. |
| driver2.rates[] | array of objects | No | Rates applied to driver 2. |
| driver2.fleet.id | string | No | Fleet ID of driver 2. |
| driver2.fleet.name | string | No | Fleet name of driver 2. |
| driver2.fleet.invoiceNumberPrefix | string | No | Invoice number prefix for driver 2 fleet. |
| driver2.accessorialsDetails[] | array of objects | No | List of driver2 accessorials. |
| driver2.eChecks[] | array of objects | No | List of EChecks for driver2. |
| ownerOperator.id | string | No | Unique ID of the owner-operator. |
| ownerOperator.accessorialsDetails[] | array of objects | No | List of owner-operator accessorials. |
| ownerOperator.eChecks[] | array of objects | No | List of EChecks for the owner-operator. |
| carrier.id | string | No | Unique ID of the carrier. |
| carrier.carrierInvoiceNumber | string | No | Invoice number from the carrier. |
| carrier.linehaul.amount | number | No | Carrier linehaul amount. |
| carrier.linehaul.currency | string | No | Currency of linehaul. |
| carrier.accessorials.amount | number | No | Total accessorials amount for carrier. |
| carrier.accessorials.currency | string | No | Currency for carrier accessorials. |
| carrier.totalPayable.amount | number | No | Total amount payable to carrier. |
| carrier.totalPayable.currency | string | No | Currency for total payable amount. |
| carrier.accessorialsDetails[] | array of objects | No | List of carrier accessorials. |
| carrier.eChecks[] | array of objects | No | List of carrier EChecks. |
| *.accessorialsDetails[].id | string | No | Unique ID of the accessorial. |
| *.accessorialsDetails[].type | string | No | Type of accessorial (e.g., Detention). |
| *.accessorialsDetails[].total.amount | number | No | Total charge amount. |
| *.accessorialsDetails[].total.currency | string | No | 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. |
| *.eChecks[].id | string | No | Unique ID of the ECheck. |
| *.eChecks[].checkNumber | string | No | ECheck number. |
| *.eChecks[].amount.amount | number | No | Amount value of the ECheck. |
| *.eChecks[].amount.currency | string | No | 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). |
| releasedBy | string | No | User who released the trip. |
| dispatchedBy | string | No | User who dispatched the trip. |
| dispatcherId | string | No | ID of the dispatcher. |
| carrierSalesAgentId | string | No | ID of the carrier sales agent. |
| carrierPayOnHold | boolean | No | Indicates if carrier payment is on hold. |
| updatedAt | string (datetime) | No | Timestamp when the trip was last updated. |
| updatedBy | string | No | User who last updated the trip. |
| isDeleted | boolean | No | Indicates if trip is deleted (true) or active (false). Only shown when IncludeDeleted: true. |
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.