The GET Trailer by ID API endpoint allows you to retrieve detailed information about a specific trailer using its unique ID. This endpoint provides comprehensive data about the trailer, facilitating effective trailer management and tracking within the Alvys system.
This endpoint allows you to search for trailers within the Alvys system based on various criteria such as status, trailer number, fleet name, and VIN number. 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.
Request Parameters
The following parameters are required in the URL path:
| Parameter | Type | Required | Description |
|---|---|---|---|
| version | String | Yes | The API version to use. |
| id | String | Yes | The unique identifier of the trailer. |
Example CURL request
curl --location 'https://integrations.alvys.com/api/p/v{version}/trailers/?id={trailerId}' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN'
Replace {version} with the API version number, {trailerId} with the actual trailer ID, and YOUR_ACCESS_TOKEN with your actual Bearer token.
curl --location 'https://integrations.alvys.com/api/p/v1/trailers/?id=TL2512345678951234569' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ....'
Response Parameters
The following table lists the parameters included in the response for trailer-related requests:
| Parameter | Type | Required | Description |
|---|---|---|---|
| id | String | Yes | The unique identifier of the trailer. |
| trailerNum | String | No | The trailer number associated with the trailer. |
| fleet | Object | No | The fleet information associated with the trailer. |
| fleet.id | String | No | The unique identifier of the fleet. |
| fleet.name | String | No | The name of the fleet. |
| fleet.invoiceNumberPrefix | String | No | The invoice number prefix for the fleet. |
| year | Integer | No | The manufacturing year of the trailer. |
| make | String | No | The make of the trailer. |
| licenseNum | String | No | The license number of the trailer. |
| licenseState | String | No | The state where the trailer is licensed. |
| vinNum | String | No | The Vehicle Identification Number (VIN) of the trailer. |
| status | String | No | The current status of the trailer. |
| subsidiaryId | String | No | The subsidiary ID associated with the trailer. |
| equipmentType | String | No | The type of equipment of the trailer. |
| equipmentSize | String | No | The size of the equipment. |
| capacity | Object | No | The capacity information of the trailer. |
| capacity.pallets | Integer | No | The number of pallets the trailer can carry. |
| capacity.weight | Integer | No | The weight capacity of the trailer. |
| createdAt | String (Date-Time) | Yes | The date and time when the trailer was created in Alvys. |
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 trailer 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.