Get truck - Alvys

GET

api

{version}

trucks

{id}

Get truck

curl --request GET \
  --url https://integrations.alvys.com/api/p/v{version}/trucks/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://integrations.alvys.com/api/p/v{version}/trucks/{id}', 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/{id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://integrations.alvys.com/api/p/v{version}/trucks/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

{
  "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>"
    }
  ]
}

{
  "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>"
}

The endpoint for retrieving trucks by ID requires specifying the API version in the URL path. 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 parameter is required in the URL path:

Parameter	Type	Required	Description
version	String	Yes	The version of the API being requested.
id	String	Yes	The unique identifier of the truck.

Example CURL request

curl --location 'https://integrations.alvys.com/api/p/v{version}/trucks/{truckId}' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace {version} with the API version number, {truckId} with the actual truck ID, and YOUR_ACCESS_TOKEN with your actual Bearer token.

curl --location 'https://integrations.alvys.com/api/p/v1/trucks/TL123456789123400402' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ...'

Response Parameters

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

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

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

string

required

version

string

default:1.0

required

API version (e.g., 1.0)

Example:

"1.0"

Response

string

required

TruckNum

string

required

Status

string

required

SubsidiaryId

string

required

GrossWeight

object

required

Show child attributes

EmptyWeight

object

required

Show child attributes

FuelCards

object[]

required

Show child attributes

Notes

object[]

required

Show child attributes

CreatedAt

string<date-time>

required

VinNumber

string | null

Year

integer<int32> | null

Make

string | null

Model

string | null

LicenseNum

string | null

LicenseState

string | null

LicenseCountry

string | null

PlateExpirationDate

string<date> | null

LicenseExpirationDate

string<date> | null

NumberOfAxles

integer<int32> | null

Fleet

object | null

Show child attributes

Color

string | null

FuelType

string | null

InsuranceCompany

string | null

InsurancePolicyNumber

string | null

InsuranceExpirationDate

string<date> | null

InspectionExpirationDate

string<date> | null

References

object[] | null

Show child attributes

⌘I

Get truck

curl --request GET \
  --url https://integrations.alvys.com/api/p/v{version}/trucks/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://integrations.alvys.com/api/p/v{version}/trucks/{id}', 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/{id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://integrations.alvys.com/api/p/v{version}/trucks/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

{
  "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>"
    }
  ]
}

{
  "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

​Example CURL request

​Response Parameters

​Example Response

​Rate Limits

Authorizations

Path Parameters

Response

Request Parameters

Example CURL request

Response Parameters

Example Response

Rate Limits