Search trucks

POST

api

{version}

trucks

Search trucks

curl --request POST \
  --url https://integrations.alvys.com/api/p/v{version}/trucks/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json-patch+json' \
  --data '
{
  "Page": 123,
  "PageSize": 123,
  "Status": [
    "<string>"
  ],
  "TruckNumber": "<string>",
  "FleetName": "<string>",
  "VinNumber": "<string>",
  "IsActive": true,
  "RegisteredName": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json-patch+json'},
  body: JSON.stringify({
    Page: 123,
    PageSize: 123,
    Status: ['<string>'],
    TruckNumber: '<string>',
    FleetName: '<string>',
    VinNumber: '<string>',
    IsActive: true,
    RegisteredName: '<string>'
  })
};

fetch('https://integrations.alvys.com/api/p/v{version}/trucks/search', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://integrations.alvys.com/api/p/v{version}/trucks/search"

payload = {
    "Page": 123,
    "PageSize": 123,
    "Status": ["<string>"],
    "TruckNumber": "<string>",
    "FleetName": "<string>",
    "VinNumber": "<string>",
    "IsActive": True,
    "RegisteredName": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json-patch+json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://integrations.alvys.com/api/p/v{version}/trucks/search",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'Page' => 123,
    'PageSize' => 123,
    'Status' => [
        '<string>'
    ],
    'TruckNumber' => '<string>',
    'FleetName' => '<string>',
    'VinNumber' => '<string>',
    'IsActive' => true,
    'RegisteredName' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json-patch+json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://integrations.alvys.com/api/p/v{version}/trucks/search"

	payload := strings.NewReader("{\n  \"Page\": 123,\n  \"PageSize\": 123,\n  \"Status\": [\n    \"<string>\"\n  ],\n  \"TruckNumber\": \"<string>\",\n  \"FleetName\": \"<string>\",\n  \"VinNumber\": \"<string>\",\n  \"IsActive\": true,\n  \"RegisteredName\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json-patch+json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://integrations.alvys.com/api/p/v{version}/trucks/search")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"Page\": 123,\n  \"PageSize\": 123,\n  \"Status\": [\n    \"<string>\"\n  ],\n  \"TruckNumber\": \"<string>\",\n  \"FleetName\": \"<string>\",\n  \"VinNumber\": \"<string>\",\n  \"IsActive\": true,\n  \"RegisteredName\": \"<string>\"\n}")
  .asString();

{
  "Page": 123,
  "PageSize": 123,
  "Total": 123,
  "Items": [
    {
      "Id": "<string>",
      "TruckNum": "<string>",
      "Status": "<string>",
      "SubsidiaryId": "<string>",
      "GrossWeight": {
        "Value": 123
      },
      "EmptyWeight": {
        "Value": 123
      },
      "FuelCards": [
        {
          "DeductFuel": true,
          "ApplyFuelDiscount": true,
          "id": "<string>",
          "CardNumber": "<string>",
          "Provider": "<string>",
          "DeductFromId": "<string>",
          "DeductFromName": "<string>",
          "DeductFromSubsidiary": "<string>",
          "DeductFromContractorType": "<string>",
          "FuelTypeConfigs": [
            {
              "FuelType": "<string>",
              "DeductFuel": true,
              "FuelDiscounted": true
            }
          ]
        }
      ],
      "Notes": [
        {
          "id": "<string>",
          "Description": "<string>",
          "NoteType": "<string>",
          "User": "<string>",
          "Time": "2023-11-07T05:31:56Z",
          "UserId": "<string>"
        }
      ],
      "CreatedAt": "2023-11-07T05:31:56Z",
      "VinNumber": "<string>",
      "Year": 123,
      "Make": "<string>",
      "Model": "<string>",
      "LicenseNum": "<string>",
      "LicenseState": "<string>",
      "LicenseCountry": "<string>",
      "PlateExpirationDate": "2023-12-25",
      "LicenseExpirationDate": "2023-12-25",
      "NumberOfAxles": 123,
      "Fleet": {
        "Id": "<string>",
        "Name": "<string>",
        "InvoiceNumberPrefix": "<string>"
      },
      "Color": "<string>",
      "FuelType": "<string>",
      "InsuranceCompany": "<string>",
      "InsurancePolicyNumber": "<string>",
      "InsuranceExpirationDate": "2023-12-25",
      "InspectionExpirationDate": "2023-12-25",
      "References": [
        {
          "Name": "<string>",
          "Value": "<string>",
          "Id": "<string>",
          "ReferenceId": "<string>",
          "Type": "<string>",
          "Access": "<string>",
          "Origin": "<string>"
        }
      ]
    }
  ],
  "Facets": {}
}

{
  "Errors": {},
  "Type": "<string>",
  "Title": "<string>",
  "Status": 123,
  "Detail": "<string>",
  "Instance": "<string>"
}

{
  "Type": "<string>",
  "Title": "<string>",
  "Status": 123,
  "Detail": "<string>",
  "Instance": "<string>"
}

{
  "Type": "<string>",
  "Title": "<string>",
  "Status": 123,
  "Detail": "<string>",
  "Instance": "<string>"
}

{
  "Type": "<string>",
  "Title": "<string>",
  "Status": 123,
  "Detail": "<string>",
  "Instance": "<string>"
}

{
  "Type": "<string>",
  "Title": "<string>",
  "Status": 123,
  "Detail": "<string>",
  "Instance": "<string>"
}

This endpoint provides detailed information about each truck that matches the search criteria, facilitating efficient management and retrieval of truck records.

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.

Request Body

The request body must include the following parameters to filter the search results. <Table> ParameterTypeRequiredDescription PageIntegerYesThe page number of the results to retrieve.PageSizeIntegerYesThe number of results per page.
PageSize must be greater than 0.StatusArray of StringsNoA list of truck statuses to filter by.TruckNumberStringConditionallyThe truck number to search for. This field is required if the other conditionally required fields are left empty.FleetNameStringConditionallyThe fleet name to filter by. This field is required if the other conditionally required fields are left empty.VinNumberStringConditionallyThe Vehicle Identification Number (VIN) to search for. This field is required if the other conditionally required fields are left empty.IsActiveBooleanConditionallyFilter by active status (true for active, false for inactive). This field is required if the other conditionally required fields are left empty.RegisteredNameStringConditionallyThe registered name of the truck to search for. This field is required if the other conditionally required fields are left empty. </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:

curl --location 'https://integrations.alvys.com/api/p/v1/trucks/search' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ....' \
--header 'Content-Type: application/json' \
--data '{
  "Page": 0,
  "PageSize": 100,
  "Status": [
      "Active"
  ],
  "TruckNumber": "",
  "FleetName": "",
  "VinNumber": "",
  "IsActive": true,
  "RegisteredName": ""
}'

Response Parameters

The following table lists the parameters included in the response for truck-related requests.

Parameter	Type	Description
Page	Integer	The current page number of the results.
PageSize	Integer	The number of results per page.
Total	Integer	The total number of results available.
Items	Array of Objects	The list of truck objects matching the search criteria.
Items.Id	String	The unique identifier of the truck.
Items.TruckNum	String	The truck number.
Items.VinNumber	String	The Vehicle Identification Number (VIN) of the truck.
Items.Year	Integer	The manufacturing year of the truck.
Items.Make	String	The manufacturer of the truck.
Items.Model	String	The model of the truck.
Items.LicenseNum	String	The license plate number of the truck.
Items.LicenseState	String	The state that issued the truck’s license plate.
Items.LicenseCountry	String	The country where the truck is licensed (USA, Canada, Mexico).
Items.PlateExpirationDate	String (Date-Time)	The expiration date of the truck’s license plate.
Items.LicenseExpirationDate	String (Date-Time)	The expiration date of the truck’s license.
Items.Status	String	The current status of the truck (e.g., Active).
Items.SubsidiaryId	String	The subsidiary ID associated with the truck.
Items.NumberOfAxles	Integer	The number of axles on the truck.
Items.Fleet	Object	The fleet details associated with the truck.
Items.Fleet.Id	String	The unique identifier of the fleet.
Items.Fleet.Name	String	The name of the fleet.
Items.Fleet.InvoiceNumberPrefix	String	The invoice number prefix for the fleet.
Items.GrossWeight	Object	The gross weight details of the truck.
Items.GrossWeight.Value	Integer	The value of the gross weight.
Items.GrossWeight.UnitOfMeasure	String	The unit of measure for the gross weight (e.g., Kilograms).
Items.EmptyWeight	Object	The empty weight details of the truck.
Items.EmptyWeight.Value	Integer	The value of the empty weight.
Items.EmptyWeight.UnitOfMeasure	String	The unit of measure for the empty weight (e.g., Kilograms).
Items.Color	String	The color of the truck.
Items.FuelType	String	The type of fuel used by the truck.
Items.FuelCards	Array of Objects	The list of fuel cards associated with the truck.
Items.FuelCards.id	String	The unique identifier of the fuel card.
Items.FuelCards.CardNumber	String	The card number of the fuel card.
Items.FuelCards.Provider	String	The provider of the fuel card.
Items.FuelCards.DeductFuel	Boolean	Indicates if fuel costs are deducted.
Items.FuelCards.ApplyFuelDiscount	Boolean	Indicates if a fuel discount is applied.
Items.FuelCards.DeductFromId	String	The ID from which fuel costs are deducted.
Items.FuelCards.DeductFromName	String	The name from which fuel costs are deducted.
Items.FuelCards.DeductFromSubsidiary	String	The subsidiary from which fuel costs are deducted.
Items.FuelCards.DeductFromContractorType	String	The contractor type from which fuel costs are deducted.
Items.InsuranceCompany	String	The insurance company of the truck.
Items.InsurancePolicyNumber	String	The insurance policy number.
Items.InsuranceExpirationDate	String (Date-Time)	The expiration date of the insurance policy.
Items.InspectionExpirationDate	String (Date-Time)	The expiration date of the truck’s inspection.
Items.Notes	Array of Objects	An optional list of notes related to the truck.
Items.Notes.id	String	The unique identifier of the note.
Items.Notes.Description	String	The description of the note.
Items.Notes.NoteType	String	The type of note.
Items.Notes.Time	String (Date-Time)	The time the note was created.
Items.Notes.User	String	The user who created the note.
Items.References	Array of Objects	An optional list of custom references associated with the truck.
Items.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 without any 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

Authorization

string

header

required

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

version

string

default:1.0

required

API version (e.g., 1.0)

Example:

"1.0"

Body

Page

integer<int32>

required

PageSize

integer<int32>

required

Status

string[] | null

TruckNumber

string | null

FleetName

string | null

VinNumber

string | null

IsActive

boolean | null

RegisteredName

string | null

Response

Page

integer<int32>

required

PageSize

integer<int32>

required

Total

integer<int64>

required

Items

object[]

required

Show child attributes

Facets

object | null

Show child attributes

⌘I

Search trucks

curl --request POST \
  --url https://integrations.alvys.com/api/p/v{version}/trucks/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json-patch+json' \
  --data '
{
  "Page": 123,
  "PageSize": 123,
  "Status": [
    "<string>"
  ],
  "TruckNumber": "<string>",
  "FleetName": "<string>",
  "VinNumber": "<string>",
  "IsActive": true,
  "RegisteredName": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json-patch+json'},
  body: JSON.stringify({
    Page: 123,
    PageSize: 123,
    Status: ['<string>'],
    TruckNumber: '<string>',
    FleetName: '<string>',
    VinNumber: '<string>',
    IsActive: true,
    RegisteredName: '<string>'
  })
};

fetch('https://integrations.alvys.com/api/p/v{version}/trucks/search', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://integrations.alvys.com/api/p/v{version}/trucks/search"

payload = {
    "Page": 123,
    "PageSize": 123,
    "Status": ["<string>"],
    "TruckNumber": "<string>",
    "FleetName": "<string>",
    "VinNumber": "<string>",
    "IsActive": True,
    "RegisteredName": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json-patch+json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://integrations.alvys.com/api/p/v{version}/trucks/search",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'Page' => 123,
    'PageSize' => 123,
    'Status' => [
        '<string>'
    ],
    'TruckNumber' => '<string>',
    'FleetName' => '<string>',
    'VinNumber' => '<string>',
    'IsActive' => true,
    'RegisteredName' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json-patch+json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://integrations.alvys.com/api/p/v{version}/trucks/search"

	payload := strings.NewReader("{\n  \"Page\": 123,\n  \"PageSize\": 123,\n  \"Status\": [\n    \"<string>\"\n  ],\n  \"TruckNumber\": \"<string>\",\n  \"FleetName\": \"<string>\",\n  \"VinNumber\": \"<string>\",\n  \"IsActive\": true,\n  \"RegisteredName\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json-patch+json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://integrations.alvys.com/api/p/v{version}/trucks/search")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"Page\": 123,\n  \"PageSize\": 123,\n  \"Status\": [\n    \"<string>\"\n  ],\n  \"TruckNumber\": \"<string>\",\n  \"FleetName\": \"<string>\",\n  \"VinNumber\": \"<string>\",\n  \"IsActive\": true,\n  \"RegisteredName\": \"<string>\"\n}")
  .asString();

{
  "Page": 123,
  "PageSize": 123,
  "Total": 123,
  "Items": [
    {
      "Id": "<string>",
      "TruckNum": "<string>",
      "Status": "<string>",
      "SubsidiaryId": "<string>",
      "GrossWeight": {
        "Value": 123
      },
      "EmptyWeight": {
        "Value": 123
      },
      "FuelCards": [
        {
          "DeductFuel": true,
          "ApplyFuelDiscount": true,
          "id": "<string>",
          "CardNumber": "<string>",
          "Provider": "<string>",
          "DeductFromId": "<string>",
          "DeductFromName": "<string>",
          "DeductFromSubsidiary": "<string>",
          "DeductFromContractorType": "<string>",
          "FuelTypeConfigs": [
            {
              "FuelType": "<string>",
              "DeductFuel": true,
              "FuelDiscounted": true
            }
          ]
        }
      ],
      "Notes": [
        {
          "id": "<string>",
          "Description": "<string>",
          "NoteType": "<string>",
          "User": "<string>",
          "Time": "2023-11-07T05:31:56Z",
          "UserId": "<string>"
        }
      ],
      "CreatedAt": "2023-11-07T05:31:56Z",
      "VinNumber": "<string>",
      "Year": 123,
      "Make": "<string>",
      "Model": "<string>",
      "LicenseNum": "<string>",
      "LicenseState": "<string>",
      "LicenseCountry": "<string>",
      "PlateExpirationDate": "2023-12-25",
      "LicenseExpirationDate": "2023-12-25",
      "NumberOfAxles": 123,
      "Fleet": {
        "Id": "<string>",
        "Name": "<string>",
        "InvoiceNumberPrefix": "<string>"
      },
      "Color": "<string>",
      "FuelType": "<string>",
      "InsuranceCompany": "<string>",
      "InsurancePolicyNumber": "<string>",
      "InsuranceExpirationDate": "2023-12-25",
      "InspectionExpirationDate": "2023-12-25",
      "References": [
        {
          "Name": "<string>",
          "Value": "<string>",
          "Id": "<string>",
          "ReferenceId": "<string>",
          "Type": "<string>",
          "Access": "<string>",
          "Origin": "<string>"
        }
      ]
    }
  ],
  "Facets": {}
}

{
  "Errors": {},
  "Type": "<string>",
  "Title": "<string>",
  "Status": 123,
  "Detail": "<string>",
  "Instance": "<string>"
}

{
  "Type": "<string>",
  "Title": "<string>",
  "Status": 123,
  "Detail": "<string>",
  "Instance": "<string>"
}

{
  "Type": "<string>",
  "Title": "<string>",
  "Status": 123,
  "Detail": "<string>",
  "Instance": "<string>"
}

{
  "Type": "<string>",
  "Title": "<string>",
  "Status": 123,
  "Detail": "<string>",
  "Instance": "<string>"
}

{
  "Type": "<string>",
  "Title": "<string>",
  "Status": 123,
  "Detail": "<string>",
  "Instance": "<string>"
}

​Request Parameters

​Request Body

​Example CURL request

​Response Parameters

​Example Response

​Rate Limits

Authorizations

Path Parameters

Body

Response

Request Parameters

Request Body

Example CURL request

Response Parameters

Example Response

Rate Limits