The Retrieve All Trailers API endpoint allows you to retrieve a list of all trailers in the Alvys system. This endpoint provides comprehensive data about each trailer, facilitating effective asset management and tracking 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. |
Example CURL request
curl --location 'https://integrations.alvys.com/api/p/v{version}/trailers' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN'
Replace {version} with the API version number and YOUR_ACCESS_TOKEN with your actual Bearer token.
curl --location 'https://integrations.alvys.com/api/p/v1/trailers' \
--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.
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.
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. 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.