List trailers

GET

api

{version}

trailers

List trailers

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

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

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

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://integrations.alvys.com/api/p/v{version}/trailers",
  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}/trailers"

	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>",
    "TrailerNum": "<string>",
    "Status": "<string>",
    "Notes": [
      {
        "id": "<string>",
        "Description": "<string>",
        "NoteType": "<string>",
        "User": "<string>",
        "Time": "2023-11-07T05:31:56Z",
        "UserId": "<string>"
      }
    ],
    "CreatedAt": "2023-11-07T05:31:56Z",
    "Fleet": {
      "Id": "<string>",
      "Name": "<string>",
      "InvoiceNumberPrefix": "<string>"
    },
    "Year": 123,
    "Make": "<string>",
    "LicenseNum": "<string>",
    "LicenseState": "<string>",
    "LicenseCountry": "<string>",
    "PlateExpiresAt": "2023-12-25",
    "LicenseExpiresAt": "2023-12-25",
    "VinNum": "<string>",
    "SubsidiaryId": "<string>",
    "EquipmentType": "<string>",
    "EquipmentSize": "<string>",
    "Capacity": {
      "Pallets": 123,
      "Weight": 123
    },
    "InsuranceCompany": "<string>",
    "InsurancePolicyNumber": "<string>",
    "InsuranceExpiresAt": "2023-12-25",
    "InspectionExpiresAt": "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>"
}

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.
LicenseCountry	String	No	The country where the trailer is licensed (USA, Canada, Mexico).
PlateExpiresAt	String (Date)	No	The expiration date of the trailer’s plate.
LicenseExpiresAt	String (Date)	No	The expiration date of the trailer’s license (registration).
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.
InsuranceCompany	String	No	The name of the insurance company.
InsurancePolicyNumber	String	No	The insurance policy number.
InsuranceExpiresAt	String (Date)	No	The expiration date of the insurance policy.
InspectionExpiresAt	String (Date)	No	The expiration date of the trailer’s inspection.
Notes	Array	No	An optional list of notes related to the trailer.
References	Array	No	An optional list of custom references associated with 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.

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"

Response

string

required

TrailerNum

string

required

Status

string

required

Notes

object[]

required

Show child attributes

CreatedAt

string<date-time>

required

Fleet

object | null

Show child attributes

Year

integer<int32> | null

Make

string | null

LicenseNum

string | null

LicenseState

string | null

LicenseCountry

string | null

PlateExpiresAt

string<date> | null

LicenseExpiresAt

string<date> | null

VinNum

string | null

SubsidiaryId

string | null

EquipmentType

string | null

EquipmentSize

string | null

Capacity

object | null

Show child attributes

InsuranceCompany

string | null

InsurancePolicyNumber

string | null

InsuranceExpiresAt

string<date> | null

InspectionExpiresAt

string<date> | null

References

object[] | null

Show child attributes

⌘I

List trailers

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

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

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

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://integrations.alvys.com/api/p/v{version}/trailers",
  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}/trailers"

	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>",
    "TrailerNum": "<string>",
    "Status": "<string>",
    "Notes": [
      {
        "id": "<string>",
        "Description": "<string>",
        "NoteType": "<string>",
        "User": "<string>",
        "Time": "2023-11-07T05:31:56Z",
        "UserId": "<string>"
      }
    ],
    "CreatedAt": "2023-11-07T05:31:56Z",
    "Fleet": {
      "Id": "<string>",
      "Name": "<string>",
      "InvoiceNumberPrefix": "<string>"
    },
    "Year": 123,
    "Make": "<string>",
    "LicenseNum": "<string>",
    "LicenseState": "<string>",
    "LicenseCountry": "<string>",
    "PlateExpiresAt": "2023-12-25",
    "LicenseExpiresAt": "2023-12-25",
    "VinNum": "<string>",
    "SubsidiaryId": "<string>",
    "EquipmentType": "<string>",
    "EquipmentSize": "<string>",
    "Capacity": {
      "Pallets": 123,
      "Weight": 123
    },
    "InsuranceCompany": "<string>",
    "InsurancePolicyNumber": "<string>",
    "InsuranceExpiresAt": "2023-12-25",
    "InspectionExpiresAt": "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>"
}

​Request Parameters

​Example CURL request

​Response Parameters

​Example Response

​Versioning

​Rate Limits

Authorizations

Path Parameters

Response

Request Parameters

Example CURL request

Response Parameters

Example Response

Versioning

Rate Limits