> ## Documentation Index > Fetch the complete documentation index at: https://docs.alvys.com/llms.txt > Use this file to discover all available pages before exploring further. # Search trailers > Search trailers with paginated POST filters — trailer number, type, ownership, current status, license, home terminal, and current load or trip. 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. ### Request Parameters The following parameter is required in the URL path: | Parameter | Type | Required | Description | | --------- | ------ | -------- | ----------------------- | | version | String | Yes | The API version to use. | #### Request Body The following fields are required in the request body to filter the search results: `` `
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.
` #### 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: ```bash theme={null} curl --location 'https://integrations.alvys.com/api/p/v1/trailers/search' \ --header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ...' \ --header 'Content-Type: application/json' \ --data '{ "Page": 0, "PageSize": 50, "Status": [ "Active" ], "TrailerNumber": "", "FleetName": "", "VinNumber": "" }' ``` ### Response Parameters The following table lists the parameters included in the response for trailer search requests: | Parameter | Type | Required | Description | | ------------------------------- | ------------------ | -------- | ------------------------------------------------------------------ | | Page | Integer | Yes | The current page number of the results. | | PageSize | Integer | Yes | The number of results per page. | | Total | Integer | Yes | The total number of matching trailers. | | Items | Array of Objects | Yes | The list of trailer records matching the criteria. | | Items.Id | String | Yes | The unique identifier of the trailer. | | Items.TrailerNum | String | No | The trailer number associated with the trailer. | | Items.Fleet | Object | No | The fleet information associated with the trailer. | | Items.Fleet.Id | String | No | The unique identifier of the fleet. | | Items.Fleet.Name | String | No | The name of the fleet. | | Items.Fleet.InvoiceNumberPrefix | String | No | The invoice number prefix for the fleet. | | Items.Year | Integer | No | The manufacturing year of the trailer. | | Items.Make | String | No | The make of the trailer. | | Items.LicenseNum | String | No | The license number of the trailer. | | Items.LicenseState | String | No | The state where the trailer is licensed. | | Items.LicenseCountry | String | No | The country where the trailer is licensed (USA, Canada, Mexico). | | Items.PlateExpiresAt | String (Date) | No | The expiration date of the trailer's plate. | | Items.LicenseExpiresAt | String (Date) | No | The expiration date of the trailer's license (registration). | | Items.VinNum | String | No | The Vehicle Identification Number (VIN) of the trailer. | | Items.Status | String | No | The current status of the trailer. | | Items.SubsidiaryId | String | No | The subsidiary ID associated with the trailer. | | Items.EquipmentType | String | No | The type of equipment of the trailer. | | Items.EquipmentSize | String | No | The size of the equipment. | | Items.Capacity | Object | No | The capacity information of the trailer. | | Items.Capacity.Pallets | Integer | No | The number of pallets the trailer can carry. | | Items.Capacity.Weight | Integer | No | The weight capacity of the trailer. | | Items.InsuranceCompany | String | No | The name of the insurance company. | | Items.InsurancePolicyNumber | String | No | The insurance policy number. | | Items.InsuranceExpiresAt | String (Date) | No | The expiration date of the insurance policy. | | Items.InspectionExpiresAt | String (Date) | No | The expiration date of the trailer's inspection. | | Items.Notes | Array | No | An optional list of notes related to the trailer. | | Items.References | Array | No | An optional list of custom references associated with the trailer. | | Items.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](/docs/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](/docs/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. ## OpenAPI ````yaml POST /api/p/v{version}/trailers/search openapi: 3.0.1 info: title: Alvys description: >- Alvys provides a robust set of REST APIs to allow you to integrate Alvys into virtually any platform. These APIs cover most of Alvys' major product areas with additional endpoints being added regularly based on customer requests. contact: name: Alvys Support url: https://www.alvys.com/resources/contact/ version: v1 servers: - url: https://integrations.alvys.com description: Public API Server - url: https://api.alvys.com/ description: Public API Server security: - Public: [] tags: - name: Authentication description: Obtain an OAuth 2.0 access token for the Alvys Public API. - name: Carrier Settlement Statements description: >- Search carrier settlement statements and retrieve a single statement by number. - name: Carriers description: Read carrier records, search carriers, and manage carrier documents. - name: Customers description: Create, read, update, delete, and search customer records. - name: Deductions description: >- Create one-time deductions and search or delete existing deduction records. - name: DispatchPreferences description: Dispatch preferences endpoints for reading dispatch rules and preferences. - name: Driver Settlement Statements description: >- Search driver settlement statements and retrieve a single statement by number. - name: Drivers description: >- Read driver records, search drivers and driver events, and manage driver documents. - name: Fuel description: Read and search fuel transactions. - name: Invoices description: >- Read invoices, create carrier invoices, and record carrier and customer payments. - name: Loads description: Read, update, search loads, and manage load documents and notes. - name: Locations description: Read and search company location details. - name: Maintenance description: Read and search maintenance records. - name: Tenders description: Create, accept, reject, cancel, update, and search inbound EDI tenders. - name: Tolls description: Read and search toll transactions. - name: Trailers description: Read trailers, search trailer events, and manage trailer documents. - name: Trips description: >- Read, search trips, manage trip documents, and record stop appointments, arrivals, and departures. - name: Trucks description: Read trucks, search truck events, and manage truck documents. - name: Users description: List and search users. - name: Visibility description: >- Read inbound and outbound visibility history and search outbound visibility errors. - name: Webhooks description: >- Create, read, update, delete, enable, disable, verify, test, and rotate secrets for webhook subscriptions; read event types, delivery logs, and health metrics. paths: /api/p/v{version}/trailers/search: post: tags: - Trailers summary: Search trailers parameters: - name: version in: path description: API version (e.g., 1.0) required: true schema: type: string default: '1.0' example: '1.0' requestBody: content: application/json-patch+json: schema: allOf: - $ref: >- #/components/schemas/Alvys.Models.Trailers.TrailerSearchRequest application/json: schema: allOf: - $ref: >- #/components/schemas/Alvys.Models.Trailers.TrailerSearchRequest text/json: schema: allOf: - $ref: >- #/components/schemas/Alvys.Models.Trailers.TrailerSearchRequest application/*+json: schema: allOf: - $ref: >- #/components/schemas/Alvys.Models.Trailers.TrailerSearchRequest required: true responses: '200': description: OK content: application/json: schema: $ref: >- #/components/schemas/Alvys.Helpers.PagedResponse1Alvys.Models.Trailers.TrailerResponse '400': description: Bad Request content: application/json: schema: $ref: >- #/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails '401': description: Unauthorized content: application/problem+json: schema: $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails' '403': description: Forbidden content: application/problem+json: schema: $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails' '429': description: Too Many Requests content: application/problem+json: schema: $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails' security: - Public: [] components: schemas: Alvys.Models.Trailers.TrailerSearchRequest: required: - Page - PageSize type: object properties: Page: type: integer format: int32 PageSize: type: integer format: int32 Status: type: array items: type: string nullable: true TrailerNumber: type: string nullable: true FleetName: type: string nullable: true VinNumber: type: string nullable: true additionalProperties: false Alvys.Helpers.PagedResponse1Alvys.Models.Trailers.TrailerResponse: required: - Items - Page - PageSize - Total type: object properties: Page: type: integer format: int32 PageSize: type: integer format: int32 Facets: type: object additionalProperties: type: array items: $ref: '#/components/schemas/Alvys.Helpers.ResultSetFacetItem' nullable: true Total: type: integer format: int64 Items: type: array items: $ref: '#/components/schemas/Alvys.Models.Trailers.TrailerResponse' additionalProperties: false Microsoft.AspNetCore.Mvc.ValidationProblemDetails: required: - Errors type: object properties: Errors: type: object additionalProperties: type: array items: type: string Type: type: string nullable: true Title: type: string nullable: true Status: type: integer format: int32 nullable: true Detail: type: string nullable: true Instance: type: string nullable: true additionalProperties: {} Microsoft.AspNetCore.Mvc.ProblemDetails: type: object properties: Type: type: string nullable: true Title: type: string nullable: true Status: type: integer format: int32 nullable: true Detail: type: string nullable: true Instance: type: string nullable: true additionalProperties: {} Alvys.Helpers.ResultSetFacetItem: required: - Count - Value type: object properties: Value: type: string Count: type: integer format: int64 additionalProperties: false Alvys.Models.Trailers.TrailerResponse: required: - CreatedAt - Id - Notes - Status - TrailerNum type: object properties: Id: type: string TrailerNum: type: string Fleet: allOf: - $ref: '#/components/schemas/FleetResponse' nullable: true Year: type: integer format: int32 nullable: true Make: type: string nullable: true LicenseNum: type: string nullable: true LicenseState: type: string nullable: true LicenseCountry: type: string nullable: true PlateExpiresAt: type: string format: date nullable: true LicenseExpiresAt: type: string format: date nullable: true VinNum: type: string nullable: true Status: type: string SubsidiaryId: type: string nullable: true EquipmentType: type: string nullable: true EquipmentSize: type: string nullable: true Capacity: allOf: - $ref: '#/components/schemas/Alvys.Models.Capacity' nullable: true InsuranceCompany: type: string nullable: true InsurancePolicyNumber: type: string nullable: true InsuranceExpiresAt: type: string format: date nullable: true InspectionExpiresAt: type: string format: date nullable: true Notes: type: array items: $ref: '#/components/schemas/Alvys.Models.Notes.NoteDto' CreatedAt: type: string format: date-time References: type: array items: $ref: '#/components/schemas/Alvys.Models.References.ReferenceResponse' nullable: true additionalProperties: false FleetResponse: type: object properties: Id: type: string nullable: true Name: type: string nullable: true InvoiceNumberPrefix: type: string nullable: true additionalProperties: false Alvys.Models.Capacity: required: - Pallets - Weight type: object properties: Pallets: type: integer format: int32 Weight: type: number format: double additionalProperties: false Alvys.Models.Notes.NoteDto: required: - Description - id - NoteType - User type: object properties: id: type: string Description: type: string NoteType: type: string Time: type: string format: date-time nullable: true User: type: string UserId: type: string nullable: true additionalProperties: false Alvys.Models.References.ReferenceResponse: required: - Name - Value type: object properties: Id: type: string nullable: true ReferenceId: type: string nullable: true Name: type: string Value: type: string Type: type: string nullable: true Access: type: string nullable: true Origin: type: string nullable: true additionalProperties: false securitySchemes: Public: type: http scheme: bearer bearerFormat: JWT description: >- 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 `. ````