The GET Truck by ID API endpoint allows you to retrieve detailed information about a specific truck using its unique ID. This endpoint provides comprehensive data about the truck, facilitating effective truck management and tracking within the Alvys system.
The endpoint for retrieving trucks by ID requires specifying the API version in the URL path. 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.
Request Parameters
The following parameter is required in the URL path:
| Parameter | Type | Required | Description |
|---|---|---|---|
| version | String | Yes | The version of the API being requested. |
| id | String | Yes | The unique identifier of the truck. |
Example CURL request
curl --location 'https://integrations.alvys.com/api/p/v{version}/trucks/?id={truckId}' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN'
Replace {version} with the API version number, {truckId} with the actual truck ID, and YOUR_ACCESS_TOKEN with your actual Bearer token.
curl --location 'https://integrations.alvys.com/api/p/v1/trucks/?id=TL123456789123400402' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ...'
Response Parameters
The following table lists the parameters included in the response for truck-related requests.
| Parameter | Type | Description |
|---|---|---|
| id | String | The unique identifier of the truck. |
| truckNum | String | The truck number. |
| vinNumber | String | The Vehicle Identification Number (VIN) of the truck. |
| year | Integer | The manufacturing year of the truck. |
| make | String | The manufacturer of the truck. |
| model | String | The model of the truck. |
| licenseNum | String | The license plate number of the truck. |
| licenseState | String | The state that issued the truck's license plate. |
| plateExpirationDate | String (Date-Time) | The expiration date of the truck's license plate. |
| licenseExpirationDate | String (Date-Time) | The expiration date of the truck's license. |
| status | String | The current status of the truck (e.g., Active). |
| subsidiaryId | String | The subsidiary ID associated with the truck. |
| numberOfAxles | Integer | The number of axles on the truck. |
| fleet | Object | The fleet details associated with the truck. |
| fleet.id | String | The unique identifier of the fleet. |
| fleet.name | String | The name of the fleet. |
| fleet.invoiceNumberPrefix | String | The invoice number prefix for the fleet. |
| grossWeight | Object | The gross weight details of the truck. |
| grossWeight.value | Integer | The value of the gross weight. |
| grossWeight.unitOfMeasure | String | The unit of measure for the gross weight (e.g., Kilograms). |
| emptyWeight | Object | The empty weight details of the truck. |
| emptyWeight.value | Integer | The value of the empty weight. |
| emptyWeight.unitOfMeasure | String | The unit of measure for the empty weight (e.g., Kilograms). |
| color | String | The color of the truck. |
| fuelType | String | The type of fuel used by the truck. |
| fuelCards | Array of Objects | The list of fuel cards associated with the truck. |
| fuelCards.id | String | The unique identifier of the fuel card. |
| fuelCards.cardNumber | String | The card number of the fuel card. |
| fuelCards.provider | String | The provider of the fuel card. |
| fuelCards.deductFuel | Boolean | Indicates if fuel costs are deducted. |
| fuelCards.applyFuelDiscount | Boolean | Indicates if a fuel discount is applied. |
| fuelCards.deductFromId | String | The ID from which fuel costs are deducted. |
| fuelCards.deductFromName | String | The name from which fuel costs are deducted. |
| fuelCards.deductFromSubsidiary | String | The subsidiary from which fuel costs are deducted. |
| fuelCards.deductFromContractorType | String | The contractor type from which fuel costs are deducted. |
| insuranceCompany | String | The insurance company of the truck. |
| insurancePolicyNumber | String | The insurance policy number. |
| insuranceExpirationDate | String (Date-Time) | The expiration date of the insurance policy. |
| inspectionExpirationDate | String (Date-Time) | The expiration date of the truck's inspection. |
| notes | Array of Objects | An optional list of notes related to the truck. |
| notes.id | String | The unique identifier of the note. |
| notes.description | String | The description of the note. |
| notes.noteType | String | The type of note. |
| notes.time | String (Date-Time) | The time the note was created. |
| notes.user | String | The user who created the note. |
| createdAt | String (Date-Time) | The date and time when the truck record was created. |
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 providing the truck ID in the URL path. As you fill out the parameters, the Curl command on the right side of the page will be automatically updated. Alternatively, you can directly edit the Curl command. Make sure to authorize yourself before trying a request.