Trailers
Search trailers
Search trailers with paginated POST filters — trailer number, type, ownership, current status, license, home terminal, and current load or trip.
POST
Search trailers
The Search Trailers API 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. This endpoint provides detailed information about each trailer that matches the search criteria, facilitating efficient management and retrieval of trailer records.
Parameter Type Required Description
Page Integer Yes The page number to retrieve. PageSize Integer Yes The number of results per page.
PageSize must be greater than 0. Status Array of Strings No A list of status values to filter by. TrailerNumber String Conditionally The trailer number to search for. This field is required if the other conditionally required fields are left empty. FleetName String Conditionally The name of the fleet to search for. This field is required if the other conditionally required fields are left empty. VinNumber String Conditionally The VIN number of the trailer. This field is required if the other conditionally required fields are left empty.

Request Parameters
The following parameter is required in the URL path:Request Body
The following fields are required in the request body to filter the search results:<Table>
PageSize must be greater than 0.
</Table>
Example CURL request
Use the Current API version number and make sure to replace the Authorization header value with your actual Bearer token for the request:Response Parameters
The following table lists the parameters included in the response for trailer search requests: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 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 directly edit the Curl command. Make sure to authorize yourself before trying a request.Authorizations
OAuth 2.0 client-credentials access token. Obtain one from https://auth.alvys.com/oauth/token (grant_type=client_credentials, audience=https://api.alvys.com/public/), then paste it here. The playground sends it as Authorization: Bearer <token>.
Path Parameters
API version (e.g., 1.0)
Example:
"1.0"