Create truck

POST

api

{version}

trucks

Create truck

curl --request POST \
  --url https://integrations.alvys.com/api/p/v{version}/trucks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json-patch+json' \
  --data '
{
  "TruckNum": "<string>",
  "VinNumber": "<string>",
  "Year": 123,
  "Make": "<string>",
  "Model": "<string>",
  "LicenseNum": "<string>",
  "LicenseState": "<string>",
  "LicenseCountry": "<string>",
  "LicenseExpirationDate": "2023-12-25",
  "Status": "<string>",
  "SubsidiaryId": "<string>",
  "FleetId": "<string>",
  "NumberOfAxles": 123,
  "GrossWeight": {
    "Value": 123
  },
  "EmptyWeight": {
    "Value": 123
  },
  "Dimensions": {
    "Height": {
      "Value": 123
    },
    "Width": {
      "Value": 123
    },
    "Length": {
      "Value": 123
    }
  },
  "GrossCombinationWeightRating": {
    "Value": 123
  },
  "TireCount": 123,
  "Color": "<string>",
  "FuelType": "<string>",
  "FuelProfile": {
    "MpgLoaded": 123,
    "MpgEmpty": 123,
    "TankCapacity": {
      "Value": 123
    },
    "TankCount": 123
  },
  "DeductToll": true,
  "InsuranceCompany": "<string>",
  "InsurancePolicyNumber": "<string>",
  "InsuranceExpirationDate": "2023-12-25",
  "InspectionExpirationDate": "2023-12-25",
  "InsuranceValue": 123,
  "LossPayee": "<string>",
  "LeasedFrom": {
    "CompanyId": "<string>",
    "DriverName": "<string>",
    "StartDate": "2023-12-25",
    "EndDate": "2023-12-25"
  },
  "LeasedTo": {
    "CompanyId": "<string>",
    "DriverName": "<string>",
    "StartDate": "2023-12-25",
    "EndDate": "2023-12-25"
  },
  "StartDate": "2023-12-25",
  "EndDate": "2023-12-25",
  "OwnerOperatorId": "<string>",
  "SteerTire": "<string>",
  "DriveTire": "<string>",
  "TollPasses": [
    {
      "PassType": "<string>",
      "PassValue": "<string>"
    }
  ],
  "IftaEnrollments": [
    {
      "State": "<string>",
      "Sticker": "<string>"
    }
  ],
  "EldProviders": [
    {
      "IntegrationType": "<string>",
      "Id": "<string>",
      "DatagateWayId": "<string>",
      "SensorId": "<string>"
    }
  ],
  "References": [
    {
      "Id": "<string>",
      "TenantReferenceId": "<string>",
      "Value": "<string>"
    }
  ]
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json-patch+json'},
  body: JSON.stringify({
    TruckNum: '<string>',
    VinNumber: '<string>',
    Year: 123,
    Make: '<string>',
    Model: '<string>',
    LicenseNum: '<string>',
    LicenseState: '<string>',
    LicenseCountry: '<string>',
    LicenseExpirationDate: '2023-12-25',
    Status: '<string>',
    SubsidiaryId: '<string>',
    FleetId: '<string>',
    NumberOfAxles: 123,
    GrossWeight: {Value: 123},
    EmptyWeight: {Value: 123},
    Dimensions: {Height: {Value: 123}, Width: {Value: 123}, Length: {Value: 123}},
    GrossCombinationWeightRating: {Value: 123},
    TireCount: 123,
    Color: '<string>',
    FuelType: '<string>',
    FuelProfile: {MpgLoaded: 123, MpgEmpty: 123, TankCapacity: {Value: 123}, TankCount: 123},
    DeductToll: true,
    InsuranceCompany: '<string>',
    InsurancePolicyNumber: '<string>',
    InsuranceExpirationDate: '2023-12-25',
    InspectionExpirationDate: '2023-12-25',
    InsuranceValue: 123,
    LossPayee: '<string>',
    LeasedFrom: {
      CompanyId: '<string>',
      DriverName: '<string>',
      StartDate: '2023-12-25',
      EndDate: '2023-12-25'
    },
    LeasedTo: {
      CompanyId: '<string>',
      DriverName: '<string>',
      StartDate: '2023-12-25',
      EndDate: '2023-12-25'
    },
    StartDate: '2023-12-25',
    EndDate: '2023-12-25',
    OwnerOperatorId: '<string>',
    SteerTire: '<string>',
    DriveTire: '<string>',
    TollPasses: [{PassType: '<string>', PassValue: '<string>'}],
    IftaEnrollments: [{State: '<string>', Sticker: '<string>'}],
    EldProviders: [
      {
        IntegrationType: '<string>',
        Id: '<string>',
        DatagateWayId: '<string>',
        SensorId: '<string>'
      }
    ],
    References: [{Id: '<string>', TenantReferenceId: '<string>', Value: '<string>'}]
  })
};

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

payload = {
    "TruckNum": "<string>",
    "VinNumber": "<string>",
    "Year": 123,
    "Make": "<string>",
    "Model": "<string>",
    "LicenseNum": "<string>",
    "LicenseState": "<string>",
    "LicenseCountry": "<string>",
    "LicenseExpirationDate": "2023-12-25",
    "Status": "<string>",
    "SubsidiaryId": "<string>",
    "FleetId": "<string>",
    "NumberOfAxles": 123,
    "GrossWeight": { "Value": 123 },
    "EmptyWeight": { "Value": 123 },
    "Dimensions": {
        "Height": { "Value": 123 },
        "Width": { "Value": 123 },
        "Length": { "Value": 123 }
    },
    "GrossCombinationWeightRating": { "Value": 123 },
    "TireCount": 123,
    "Color": "<string>",
    "FuelType": "<string>",
    "FuelProfile": {
        "MpgLoaded": 123,
        "MpgEmpty": 123,
        "TankCapacity": { "Value": 123 },
        "TankCount": 123
    },
    "DeductToll": True,
    "InsuranceCompany": "<string>",
    "InsurancePolicyNumber": "<string>",
    "InsuranceExpirationDate": "2023-12-25",
    "InspectionExpirationDate": "2023-12-25",
    "InsuranceValue": 123,
    "LossPayee": "<string>",
    "LeasedFrom": {
        "CompanyId": "<string>",
        "DriverName": "<string>",
        "StartDate": "2023-12-25",
        "EndDate": "2023-12-25"
    },
    "LeasedTo": {
        "CompanyId": "<string>",
        "DriverName": "<string>",
        "StartDate": "2023-12-25",
        "EndDate": "2023-12-25"
    },
    "StartDate": "2023-12-25",
    "EndDate": "2023-12-25",
    "OwnerOperatorId": "<string>",
    "SteerTire": "<string>",
    "DriveTire": "<string>",
    "TollPasses": [
        {
            "PassType": "<string>",
            "PassValue": "<string>"
        }
    ],
    "IftaEnrollments": [
        {
            "State": "<string>",
            "Sticker": "<string>"
        }
    ],
    "EldProviders": [
        {
            "IntegrationType": "<string>",
            "Id": "<string>",
            "DatagateWayId": "<string>",
            "SensorId": "<string>"
        }
    ],
    "References": [
        {
            "Id": "<string>",
            "TenantReferenceId": "<string>",
            "Value": "<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",
  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([
    'TruckNum' => '<string>',
    'VinNumber' => '<string>',
    'Year' => 123,
    'Make' => '<string>',
    'Model' => '<string>',
    'LicenseNum' => '<string>',
    'LicenseState' => '<string>',
    'LicenseCountry' => '<string>',
    'LicenseExpirationDate' => '2023-12-25',
    'Status' => '<string>',
    'SubsidiaryId' => '<string>',
    'FleetId' => '<string>',
    'NumberOfAxles' => 123,
    'GrossWeight' => [
        'Value' => 123
    ],
    'EmptyWeight' => [
        'Value' => 123
    ],
    'Dimensions' => [
        'Height' => [
                'Value' => 123
        ],
        'Width' => [
                'Value' => 123
        ],
        'Length' => [
                'Value' => 123
        ]
    ],
    'GrossCombinationWeightRating' => [
        'Value' => 123
    ],
    'TireCount' => 123,
    'Color' => '<string>',
    'FuelType' => '<string>',
    'FuelProfile' => [
        'MpgLoaded' => 123,
        'MpgEmpty' => 123,
        'TankCapacity' => [
                'Value' => 123
        ],
        'TankCount' => 123
    ],
    'DeductToll' => true,
    'InsuranceCompany' => '<string>',
    'InsurancePolicyNumber' => '<string>',
    'InsuranceExpirationDate' => '2023-12-25',
    'InspectionExpirationDate' => '2023-12-25',
    'InsuranceValue' => 123,
    'LossPayee' => '<string>',
    'LeasedFrom' => [
        'CompanyId' => '<string>',
        'DriverName' => '<string>',
        'StartDate' => '2023-12-25',
        'EndDate' => '2023-12-25'
    ],
    'LeasedTo' => [
        'CompanyId' => '<string>',
        'DriverName' => '<string>',
        'StartDate' => '2023-12-25',
        'EndDate' => '2023-12-25'
    ],
    'StartDate' => '2023-12-25',
    'EndDate' => '2023-12-25',
    'OwnerOperatorId' => '<string>',
    'SteerTire' => '<string>',
    'DriveTire' => '<string>',
    'TollPasses' => [
        [
                'PassType' => '<string>',
                'PassValue' => '<string>'
        ]
    ],
    'IftaEnrollments' => [
        [
                'State' => '<string>',
                'Sticker' => '<string>'
        ]
    ],
    'EldProviders' => [
        [
                'IntegrationType' => '<string>',
                'Id' => '<string>',
                'DatagateWayId' => '<string>',
                'SensorId' => '<string>'
        ]
    ],
    'References' => [
        [
                'Id' => '<string>',
                'TenantReferenceId' => '<string>',
                'Value' => '<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"

	payload := strings.NewReader("{\n  \"TruckNum\": \"<string>\",\n  \"VinNumber\": \"<string>\",\n  \"Year\": 123,\n  \"Make\": \"<string>\",\n  \"Model\": \"<string>\",\n  \"LicenseNum\": \"<string>\",\n  \"LicenseState\": \"<string>\",\n  \"LicenseCountry\": \"<string>\",\n  \"LicenseExpirationDate\": \"2023-12-25\",\n  \"Status\": \"<string>\",\n  \"SubsidiaryId\": \"<string>\",\n  \"FleetId\": \"<string>\",\n  \"NumberOfAxles\": 123,\n  \"GrossWeight\": {\n    \"Value\": 123\n  },\n  \"EmptyWeight\": {\n    \"Value\": 123\n  },\n  \"Dimensions\": {\n    \"Height\": {\n      \"Value\": 123\n    },\n    \"Width\": {\n      \"Value\": 123\n    },\n    \"Length\": {\n      \"Value\": 123\n    }\n  },\n  \"GrossCombinationWeightRating\": {\n    \"Value\": 123\n  },\n  \"TireCount\": 123,\n  \"Color\": \"<string>\",\n  \"FuelType\": \"<string>\",\n  \"FuelProfile\": {\n    \"MpgLoaded\": 123,\n    \"MpgEmpty\": 123,\n    \"TankCapacity\": {\n      \"Value\": 123\n    },\n    \"TankCount\": 123\n  },\n  \"DeductToll\": true,\n  \"InsuranceCompany\": \"<string>\",\n  \"InsurancePolicyNumber\": \"<string>\",\n  \"InsuranceExpirationDate\": \"2023-12-25\",\n  \"InspectionExpirationDate\": \"2023-12-25\",\n  \"InsuranceValue\": 123,\n  \"LossPayee\": \"<string>\",\n  \"LeasedFrom\": {\n    \"CompanyId\": \"<string>\",\n    \"DriverName\": \"<string>\",\n    \"StartDate\": \"2023-12-25\",\n    \"EndDate\": \"2023-12-25\"\n  },\n  \"LeasedTo\": {\n    \"CompanyId\": \"<string>\",\n    \"DriverName\": \"<string>\",\n    \"StartDate\": \"2023-12-25\",\n    \"EndDate\": \"2023-12-25\"\n  },\n  \"StartDate\": \"2023-12-25\",\n  \"EndDate\": \"2023-12-25\",\n  \"OwnerOperatorId\": \"<string>\",\n  \"SteerTire\": \"<string>\",\n  \"DriveTire\": \"<string>\",\n  \"TollPasses\": [\n    {\n      \"PassType\": \"<string>\",\n      \"PassValue\": \"<string>\"\n    }\n  ],\n  \"IftaEnrollments\": [\n    {\n      \"State\": \"<string>\",\n      \"Sticker\": \"<string>\"\n    }\n  ],\n  \"EldProviders\": [\n    {\n      \"IntegrationType\": \"<string>\",\n      \"Id\": \"<string>\",\n      \"DatagateWayId\": \"<string>\",\n      \"SensorId\": \"<string>\"\n    }\n  ],\n  \"References\": [\n    {\n      \"Id\": \"<string>\",\n      \"TenantReferenceId\": \"<string>\",\n      \"Value\": \"<string>\"\n    }\n  ]\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")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"TruckNum\": \"<string>\",\n  \"VinNumber\": \"<string>\",\n  \"Year\": 123,\n  \"Make\": \"<string>\",\n  \"Model\": \"<string>\",\n  \"LicenseNum\": \"<string>\",\n  \"LicenseState\": \"<string>\",\n  \"LicenseCountry\": \"<string>\",\n  \"LicenseExpirationDate\": \"2023-12-25\",\n  \"Status\": \"<string>\",\n  \"SubsidiaryId\": \"<string>\",\n  \"FleetId\": \"<string>\",\n  \"NumberOfAxles\": 123,\n  \"GrossWeight\": {\n    \"Value\": 123\n  },\n  \"EmptyWeight\": {\n    \"Value\": 123\n  },\n  \"Dimensions\": {\n    \"Height\": {\n      \"Value\": 123\n    },\n    \"Width\": {\n      \"Value\": 123\n    },\n    \"Length\": {\n      \"Value\": 123\n    }\n  },\n  \"GrossCombinationWeightRating\": {\n    \"Value\": 123\n  },\n  \"TireCount\": 123,\n  \"Color\": \"<string>\",\n  \"FuelType\": \"<string>\",\n  \"FuelProfile\": {\n    \"MpgLoaded\": 123,\n    \"MpgEmpty\": 123,\n    \"TankCapacity\": {\n      \"Value\": 123\n    },\n    \"TankCount\": 123\n  },\n  \"DeductToll\": true,\n  \"InsuranceCompany\": \"<string>\",\n  \"InsurancePolicyNumber\": \"<string>\",\n  \"InsuranceExpirationDate\": \"2023-12-25\",\n  \"InspectionExpirationDate\": \"2023-12-25\",\n  \"InsuranceValue\": 123,\n  \"LossPayee\": \"<string>\",\n  \"LeasedFrom\": {\n    \"CompanyId\": \"<string>\",\n    \"DriverName\": \"<string>\",\n    \"StartDate\": \"2023-12-25\",\n    \"EndDate\": \"2023-12-25\"\n  },\n  \"LeasedTo\": {\n    \"CompanyId\": \"<string>\",\n    \"DriverName\": \"<string>\",\n    \"StartDate\": \"2023-12-25\",\n    \"EndDate\": \"2023-12-25\"\n  },\n  \"StartDate\": \"2023-12-25\",\n  \"EndDate\": \"2023-12-25\",\n  \"OwnerOperatorId\": \"<string>\",\n  \"SteerTire\": \"<string>\",\n  \"DriveTire\": \"<string>\",\n  \"TollPasses\": [\n    {\n      \"PassType\": \"<string>\",\n      \"PassValue\": \"<string>\"\n    }\n  ],\n  \"IftaEnrollments\": [\n    {\n      \"State\": \"<string>\",\n      \"Sticker\": \"<string>\"\n    }\n  ],\n  \"EldProviders\": [\n    {\n      \"IntegrationType\": \"<string>\",\n      \"Id\": \"<string>\",\n      \"DatagateWayId\": \"<string>\",\n      \"SensorId\": \"<string>\"\n    }\n  ],\n  \"References\": [\n    {\n      \"Id\": \"<string>\",\n      \"TenantReferenceId\": \"<string>\",\n      \"Value\": \"<string>\"\n    }\n  ]\n}")
  .asString();

{
  "Id": "<string>",
  "TruckNum": "<string>",
  "Status": "<string>",
  "SubsidiaryId": "<string>",
  "GrossWeight": {
    "Value": 123,
    "UnitOfMeasure": "Kilograms"
  },
  "EmptyWeight": {
    "Value": 123,
    "UnitOfMeasure": "Kilograms"
  },
  "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>"
    }
  ],
  "DeductToll": true,
  "InsuranceValue": 123,
  "LossPayee": "<string>",
  "LeasedFrom": {
    "CompanyId": "<string>",
    "DriverName": "<string>",
    "StartDate": "2023-12-25",
    "EndDate": "2023-12-25"
  },
  "LeasedTo": {
    "CompanyId": "<string>",
    "DriverName": "<string>",
    "StartDate": "2023-12-25",
    "EndDate": "2023-12-25"
  },
  "StartDate": "2023-12-25",
  "EndDate": "2023-12-25",
  "Dimensions": {
    "Height": {
      "Value": 123,
      "Unit": "Feet"
    },
    "Width": {
      "Value": 123,
      "Unit": "Feet"
    },
    "Length": {
      "Value": 123,
      "Unit": "Feet"
    }
  },
  "GrossCombinationWeightRating": {
    "Value": 123,
    "UnitOfMeasure": "Kilograms"
  },
  "TireCount": 123,
  "FuelProfile": {
    "MpgLoaded": 123,
    "MpgEmpty": 123,
    "TankCapacity": {
      "Value": 123,
      "UnitOfMeasure": "Gallons"
    },
    "TankCount": 123,
    "FuelKind": "Diesel"
  }
}

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

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

The Create Truck endpoint registers a company-owned truck. On success it returns the new truck and its optimistic-concurrency token in the ETag response header. Send that value in the If-Match header of a later Update truck request. For more information on how versioning works and how to include it in your requests, please refer to the Versioning page.

This endpoint requires the truck:create scope. See Authentication.

Truck number and VIN must be unique

TruckNum must be unique among your company’s trucks. When you supply VinNumber, it must be unique too. A request that would create a duplicate is rejected with 409 Conflict, and the problem type tells you which value clashed:

Problem `type`	Cause
`https://api.alvys.com/errors/Conflict/DuplicateAssetNumber`	Another truck in your company has this `TruckNum`.
`https://api.alvys.com/errors/Conflict/DuplicateVin`	Another truck in your company has this `VinNumber`.

The response does not identify the existing truck. If your credential also has the truck:read scope, find it with Search trucks and update that record instead. This lets an onboarding job that runs twice reconcile with what it already created.

Subsidiary

SubsidiaryId must be a subsidiary that your credential may write to. Get the ids from List subsidiaries. If the credential can write to exactly one subsidiary, you can omit SubsidiaryId and the truck is created in that subsidiary.

Truck status

Status is shown in the dispatch planner. It does not by itself block dispatch. A maintenance work order started in Alvys moves the truck to In Shop, and back to Active when the work order completes. Crashed and Inactive remove the truck from the ELD live map and from the truck lists you pick from in Alvys.

Request parameters

The following parameter is required in the URL path:

Parameter	Type	Required	Description
version	String	Yes	The version of the API.

Request body

Only TruckNum is required. Dates are date-only values in yyyy-MM-dd format.

Field	Type	Required	Description
TruckNum	String	Yes	The truck number. Must be unique among your company’s trucks.
VinNumber	String	No	The Vehicle Identification Number (VIN). Must be unique among your company’s trucks.
Year	Integer	No	The manufacturing year of the truck.
Make	String	No	The manufacturer of the truck.
Model	String	No	The model of the truck.
LicenseNum	String	No	The license plate number of the truck.
LicenseState	String	No	The state that issued the license plate.
LicenseCountry	String	No	The country where the truck is licensed.
LicenseExpirationDate	String (Date)	No	The plate registration expiration date (“License Expiration” in Alvys).
Status	String	No	One of `Active`, `Planned`, `Temporary`, `Repair`, `In Shop`, `Leased Out`, `Crashed`, `Inactive` (case-insensitive). Defaults to `Active`.
SubsidiaryId	String	No	The subsidiary of the truck. See Subsidiary.
FleetId	String	No	An active fleet of your account, as returned in `Fleet.Id` by List trucks.
NumberOfAxles	Integer	No	The number of axles on the truck.
GrossWeight	Object	No	The maximum gross weight. Stored and returned in pounds.
GrossWeight.Value	Number	No	The weight value.
GrossWeight.UnitOfMeasure	String	No	One of `Pounds`, `Kilograms`, `Grams`, `Ounces`, `Tons`, `CWT`, `MetricTon`, `LongTon`.
EmptyWeight	Object	No	The empty (tare) weight, with `Value` and `UnitOfMeasure` as in `GrossWeight`. Stored and returned in pounds.
GrossCombinationWeightRating	Object	No	The gross combination weight rating (what the truck can pull), with `Value` and `UnitOfMeasure` as in `GrossWeight`.
Dimensions	Object	No	The outside dimensions for the routing vehicle profile.
Dimensions.Height	Object	No	The height, with `Value` (Number) and `Unit` (`Feet`, `Inches`, `Yards`, or `Meters`).
Dimensions.Width	Object	No	The width, with `Value` and `Unit`.
Dimensions.Length	Object	No	The length, with `Value` and `Unit`.
TireCount	Integer	No	The number of tires on the power unit.
SteerTire	String	No	The steer axle tire size, free text (for example `295/75R22.5`).
DriveTire	String	No	The drive axle tire size, free text.
Color	String	No	The color of the truck.
FuelType	String	No	The type of fuel used by the truck.
FuelProfile	Object	No	The fuel-cost inputs of the truck.
FuelProfile.MpgLoaded	Number	No	Miles per gallon when loaded.
FuelProfile.MpgEmpty	Number	No	Miles per gallon when empty.
FuelProfile.TankCapacity	Object	No	The capacity of one tank, with `Value` (Number) and `UnitOfMeasure` (for example `Gallons` or `Liters`).
FuelProfile.TankCount	Integer	No	The number of fuel tanks.
FuelProfile.FuelKind	String	No	One of `Diesel`, `Gasoline`, `Cng`, `Lng`, `Electric`, `Hybrid`.
DeductToll	Boolean	No	Deduct the tolls of this truck from the driver’s settlement.
InsuranceCompany	String	No	The insurance company of the truck.
InsurancePolicyNumber	String	No	The insurance policy number.
InsuranceExpirationDate	String (Date)	No	The expiration date of the insurance policy.
InsuranceValue	Number	No	The insured value of the truck.
LossPayee	String	No	The loss payee on the insurance policy.
InspectionExpirationDate	String (Date)	No	The expiration date of the annual inspection.
LeasedFrom	Object	No	The lease under which your company holds the truck.
LeasedFrom.CompanyId	String	No	The id of the company the truck is leased from. Must be a company in your account.
LeasedFrom.DriverName	String	No	The driver name recorded on the lease.
LeasedFrom.StartDate	String (Date)	No	The start date of the lease.
LeasedFrom.EndDate	String (Date)	No	The end date of the lease.
LeasedTo	Object	No	The lease under which your company leases the truck to another company. Same fields as `LeasedFrom`.
StartDate	String (Date)	No	The date the truck entered service.
EndDate	String (Date)	No	The date the truck left service.
OwnerOperatorId	String	No	The driver id of the owner operator the truck belongs to (“Assigned to Owner Operator” in Alvys). The driver must exist in your account with contractor type Owner Operator.
TollPasses	Array	No	The toll passes of the truck. One pass per issuer.
TollPasses.PassType	String	No	The pass issuer, free text (for example `E-ZPass`, `PrePass`, or `BestPass`).
TollPasses.PassValue	String	No	The transponder or account number on the pass.
IftaEnrollments	Array	No	The IFTA enrollments of the truck.
IftaEnrollments.State	String	No	The code of a US state, Canadian province or territory, or Mexican state (for example `TX`, `ON`, or `NLE`). Case-insensitive.
IftaEnrollments.Sticker	String	No	The IFTA decal (sticker) number.
EldProviders	Array	No	The ELD links of the truck. One link per integration.
EldProviders.IntegrationType	String	No	The ELD integration by its Alvys name (for example `Samsara`, `Motive`, or `Orbcomm`). Case-insensitive.
EldProviders.Id	String	No	The id of the truck in that provider.
EldProviders.DatagateWayId	String	No	Orbcomm only: the data gateway id of the device. Rejected for any other integration.
EldProviders.SensorId	String	No	The sensor id on the device.
References	Array	No	The custom references of the truck.
References.TenantReferenceId	String	Yes	The `Id` of a truck reference definition of your company. Get it from List custom reference definitions with `entities=Truck`.
References.Value	String	No	The value, checked against the type of the definition: `true` or `false` for Bool, a date (`yyyy-MM-dd`) for Date, one of the definition’s values for List.

Example cURL request

curl --location 'https://integrations.alvys.com/api/p/v1/trucks' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
  "TruckNum": "T-417",
  "VinNumber": "1XKAD49X8PJ000417",
  "Year": 2023,
  "Make": "Kenworth",
  "Model": "T680",
  "LicenseNum": "ABC1234",
  "LicenseState": "TX",
  "LicenseCountry": "USA",
  "LicenseExpirationDate": "2027-03-31",
  "SubsidiaryId": "a1b2c3d4-0000-0000-0000-000000000001",
  "NumberOfAxles": 3,
  "GrossWeight": { "Value": 80000, "UnitOfMeasure": "Pounds" },
  "TireCount": 10,
  "SteerTire": "295/75R22.5",
  "DriveTire": "295/75R22.5",
  "FuelProfile": {
    "MpgLoaded": 6.5,
    "MpgEmpty": 7.8,
    "TankCapacity": { "Value": 150, "UnitOfMeasure": "Gallons" },
    "TankCount": 2,
    "FuelKind": "Diesel"
  },
  "StartDate": "2026-11-01",
  "TollPasses": [{ "PassType": "E-ZPass", "PassValue": "0001234567" }],
  "IftaEnrollments": [{ "State": "TX", "Sticker": "IF-000417" }]
}'

Replace YOUR_ACCESS_TOKEN with your actual Bearer token.

Response fields

A successful request returns 201 Created with the new truck, in the same shape as Get truck. The truck’s current ETag is in the ETag response header.

Example response

201 Created

{
  "Id": "TL100000000000000417",
  "TruckNum": "T-417",
  "VinNumber": "1XKAD49X8PJ000417",
  "Year": 2023,
  "Make": "Kenworth",
  "Model": "T680",
  "LicenseNum": "ABC1234",
  "LicenseState": "TX",
  "LicenseCountry": "USA",
  "LicenseExpirationDate": "2027-03-31",
  "Status": "Active",
  "SubsidiaryId": "a1b2c3d4-0000-0000-0000-000000000001",
  "NumberOfAxles": 3,
  "GrossWeight": { "Value": 80000, "UnitOfMeasure": "Pounds" },
  "TireCount": 10,
  "FuelProfile": {
    "MpgLoaded": 6.5,
    "MpgEmpty": 7.8,
    "TankCapacity": { "Value": 150, "UnitOfMeasure": "Gallons" },
    "TankCount": 2,
    "FuelKind": "Diesel"
  },
  "StartDate": "2026-11-01",
  "CreatedAt": "2026-11-13T15:04:05.000Z"
}

The example shows a subset of the response fields.

Status codes

Status	Meaning
201	The truck was created.
400	The request body failed validation. The response lists the invalid fields.
401	The request was not authenticated.
403	The caller lacks the `truck:create` scope.
409	Another truck in your company has the same `TruckNum` (`DuplicateAssetNumber`) or `VinNumber` (`DuplicateVin`).
422	A referenced record is not usable. See Why a request is refused with 422.
429	The rate limit was exceeded.

Why a request is refused with 422

The problem type is https://api.alvys.com/errors/UnprocessableEntity/ followed by the reason:

Reason	Cause
`SubsidiaryRequired`	You omitted `SubsidiaryId`, and the credential can write to more than one subsidiary, or to none.
`SubsidiaryNotInScope`	`SubsidiaryId` is not a subsidiary that this credential may write to.
`FleetNotFound`	`FleetId` is not an active fleet of your account.
`LeaseCompanyNotFound`	`LeasedFrom.CompanyId` or `LeasedTo.CompanyId` is not a company in your account.
`OwnerOperatorNotFound`	`OwnerOperatorId` is not a driver in your account with contractor type Owner Operator.
`ReferenceDefinitionNotFound`	A `References.TenantReferenceId` is not a truck reference definition of your account.

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 completing the fields for the parameters below. As you fill out the parameters, the CURL command on the right side of the page will be automatically updated.

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

TruckNum

string

required

VinNumber

string | null

Year

integer<int32> | null

Make

string | null

Model

string | null

LicenseNum

string | null

LicenseState

string | null

LicenseCountry

string | null

LicenseExpirationDate

string<date> | null

Plate registration expiration ("License Expiration" in the app). Date only (yyyy-MM-dd), stored as 00:00 UTC.

Status

string | null

One of Active, Planned, Temporary, Repair, In Shop, Leased Out, Crashed, Inactive (case-insensitive). Shown in the dispatch planner; does not by itself block dispatch. In Shop and Active are also written by the maintenance work-order sync. Crashed and Inactive remove the truck from the ELD live map and from truck pickers. Defaults to Active.

SubsidiaryId

string | null

Subsidiary id from GET /subsidiaries. Must be one this credential may write to. May be omitted only when the credential can write to exactly one subsidiary.

FleetId

string | null

Fleet id, as returned in Fleet.Id by GET /trucks. Must be an active fleet of your account.

NumberOfAxles

integer<int32> | null

GrossWeight

object | null

Maximum gross weight, with its unit (Pounds, Kilograms, ...). Stored and returned in pounds.

Show child attributes

EmptyWeight

object | null

Empty (tare) weight, with its unit (Pounds, Kilograms, ...). Stored and returned in pounds.

Show child attributes

Dimensions

object | null

Outside dimensions for the routing vehicle profile: Height, Width and Length, each with its unit (Feet, Inches, Meters, ...).

Show child attributes

GrossCombinationWeightRating

object | null

Gross combination weight rating: what the unit can pull, with its unit (Pounds, Kilograms, ...).

Show child attributes

TireCount

integer<int32> | null

Tires on the power unit.

Color

string | null

FuelType

string | null

FuelProfile

object | null

Fuel-cost inputs: MpgLoaded, MpgEmpty, TankCapacity (with its unit), TankCount and FuelKind (Diesel, Gasoline, Cng, Lng, Electric, Hybrid).

Show child attributes

DeductToll

boolean | null

Deduct this truck's tolls from the driver's settlement.

InsuranceCompany

string | null

InsurancePolicyNumber

string | null

InsuranceExpirationDate

string<date> | null

Date only (yyyy-MM-dd), stored as 00:00 UTC.

InspectionExpirationDate

string<date> | null

Annual inspection expiration. Date only (yyyy-MM-dd), stored as 00:00 UTC.

InsuranceValue

number<double> | null

LossPayee

string | null

LeasedFrom

object | null

Show child attributes

LeasedTo

object | null

Show child attributes

StartDate

string<date> | null

Date the truck entered service. Date only (yyyy-MM-dd), stored as 00:00 UTC.

EndDate

string<date> | null

Date the truck left service. Date only (yyyy-MM-dd), stored as 00:00 UTC.

OwnerOperatorId

string | null

Driver id of the owner operator the asset belongs to ("Assigned to Owner Operator" in the app). The driver must exist in your account with contractor type Owner Operator. null unassigns the asset: it goes back to its subsidiary's carrier. On a truck, fuel cards with Deduct Fuel follow the change in the same write: they stop deducting when the truck leaves its owner operator, and deduct from the new one when it moves.

SteerTire

string | null

Steer axle tire size. Tire size, free text (e.g. 295/75R22.5).

DriveTire

string | null

Drive axles tire size. Tire size, free text (e.g. 295/75R22.5).

TollPasses

object[] | null

Toll passes, replaced whole. One pass per issuer.

Show child attributes

IftaEnrollments

object[] | null

IFTA enrollments, replaced whole.

Show child attributes

EldProviders

object[] | null

ELD links, replaced whole. Moving an asset off a link stops its location updates from that provider.

Show child attributes

References

object[] | null

Custom references, replaced whole. Each new or changed reference must name a definition the tenant set up for this asset type; type, access and visibility come from the definition.

Show child attributes

Response

Created

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

DeductToll

boolean | null

InsuranceValue

number<double> | null

LossPayee

string | null

LeasedFrom

object | null

Show child attributes

LeasedTo

object | null

Show child attributes

StartDate

string<date> | null

EndDate

string<date> | null

Dimensions

object | null

Show child attributes

GrossCombinationWeightRating

object | null

Show child attributes

TireCount

integer<int32> | null

FuelProfile

object | null

Show child attributes

⌘I

Create truck

curl --request POST \
  --url https://integrations.alvys.com/api/p/v{version}/trucks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json-patch+json' \
  --data '
{
  "TruckNum": "<string>",
  "VinNumber": "<string>",
  "Year": 123,
  "Make": "<string>",
  "Model": "<string>",
  "LicenseNum": "<string>",
  "LicenseState": "<string>",
  "LicenseCountry": "<string>",
  "LicenseExpirationDate": "2023-12-25",
  "Status": "<string>",
  "SubsidiaryId": "<string>",
  "FleetId": "<string>",
  "NumberOfAxles": 123,
  "GrossWeight": {
    "Value": 123
  },
  "EmptyWeight": {
    "Value": 123
  },
  "Dimensions": {
    "Height": {
      "Value": 123
    },
    "Width": {
      "Value": 123
    },
    "Length": {
      "Value": 123
    }
  },
  "GrossCombinationWeightRating": {
    "Value": 123
  },
  "TireCount": 123,
  "Color": "<string>",
  "FuelType": "<string>",
  "FuelProfile": {
    "MpgLoaded": 123,
    "MpgEmpty": 123,
    "TankCapacity": {
      "Value": 123
    },
    "TankCount": 123
  },
  "DeductToll": true,
  "InsuranceCompany": "<string>",
  "InsurancePolicyNumber": "<string>",
  "InsuranceExpirationDate": "2023-12-25",
  "InspectionExpirationDate": "2023-12-25",
  "InsuranceValue": 123,
  "LossPayee": "<string>",
  "LeasedFrom": {
    "CompanyId": "<string>",
    "DriverName": "<string>",
    "StartDate": "2023-12-25",
    "EndDate": "2023-12-25"
  },
  "LeasedTo": {
    "CompanyId": "<string>",
    "DriverName": "<string>",
    "StartDate": "2023-12-25",
    "EndDate": "2023-12-25"
  },
  "StartDate": "2023-12-25",
  "EndDate": "2023-12-25",
  "OwnerOperatorId": "<string>",
  "SteerTire": "<string>",
  "DriveTire": "<string>",
  "TollPasses": [
    {
      "PassType": "<string>",
      "PassValue": "<string>"
    }
  ],
  "IftaEnrollments": [
    {
      "State": "<string>",
      "Sticker": "<string>"
    }
  ],
  "EldProviders": [
    {
      "IntegrationType": "<string>",
      "Id": "<string>",
      "DatagateWayId": "<string>",
      "SensorId": "<string>"
    }
  ],
  "References": [
    {
      "Id": "<string>",
      "TenantReferenceId": "<string>",
      "Value": "<string>"
    }
  ]
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json-patch+json'},
  body: JSON.stringify({
    TruckNum: '<string>',
    VinNumber: '<string>',
    Year: 123,
    Make: '<string>',
    Model: '<string>',
    LicenseNum: '<string>',
    LicenseState: '<string>',
    LicenseCountry: '<string>',
    LicenseExpirationDate: '2023-12-25',
    Status: '<string>',
    SubsidiaryId: '<string>',
    FleetId: '<string>',
    NumberOfAxles: 123,
    GrossWeight: {Value: 123},
    EmptyWeight: {Value: 123},
    Dimensions: {Height: {Value: 123}, Width: {Value: 123}, Length: {Value: 123}},
    GrossCombinationWeightRating: {Value: 123},
    TireCount: 123,
    Color: '<string>',
    FuelType: '<string>',
    FuelProfile: {MpgLoaded: 123, MpgEmpty: 123, TankCapacity: {Value: 123}, TankCount: 123},
    DeductToll: true,
    InsuranceCompany: '<string>',
    InsurancePolicyNumber: '<string>',
    InsuranceExpirationDate: '2023-12-25',
    InspectionExpirationDate: '2023-12-25',
    InsuranceValue: 123,
    LossPayee: '<string>',
    LeasedFrom: {
      CompanyId: '<string>',
      DriverName: '<string>',
      StartDate: '2023-12-25',
      EndDate: '2023-12-25'
    },
    LeasedTo: {
      CompanyId: '<string>',
      DriverName: '<string>',
      StartDate: '2023-12-25',
      EndDate: '2023-12-25'
    },
    StartDate: '2023-12-25',
    EndDate: '2023-12-25',
    OwnerOperatorId: '<string>',
    SteerTire: '<string>',
    DriveTire: '<string>',
    TollPasses: [{PassType: '<string>', PassValue: '<string>'}],
    IftaEnrollments: [{State: '<string>', Sticker: '<string>'}],
    EldProviders: [
      {
        IntegrationType: '<string>',
        Id: '<string>',
        DatagateWayId: '<string>',
        SensorId: '<string>'
      }
    ],
    References: [{Id: '<string>', TenantReferenceId: '<string>', Value: '<string>'}]
  })
};

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

payload = {
    "TruckNum": "<string>",
    "VinNumber": "<string>",
    "Year": 123,
    "Make": "<string>",
    "Model": "<string>",
    "LicenseNum": "<string>",
    "LicenseState": "<string>",
    "LicenseCountry": "<string>",
    "LicenseExpirationDate": "2023-12-25",
    "Status": "<string>",
    "SubsidiaryId": "<string>",
    "FleetId": "<string>",
    "NumberOfAxles": 123,
    "GrossWeight": { "Value": 123 },
    "EmptyWeight": { "Value": 123 },
    "Dimensions": {
        "Height": { "Value": 123 },
        "Width": { "Value": 123 },
        "Length": { "Value": 123 }
    },
    "GrossCombinationWeightRating": { "Value": 123 },
    "TireCount": 123,
    "Color": "<string>",
    "FuelType": "<string>",
    "FuelProfile": {
        "MpgLoaded": 123,
        "MpgEmpty": 123,
        "TankCapacity": { "Value": 123 },
        "TankCount": 123
    },
    "DeductToll": True,
    "InsuranceCompany": "<string>",
    "InsurancePolicyNumber": "<string>",
    "InsuranceExpirationDate": "2023-12-25",
    "InspectionExpirationDate": "2023-12-25",
    "InsuranceValue": 123,
    "LossPayee": "<string>",
    "LeasedFrom": {
        "CompanyId": "<string>",
        "DriverName": "<string>",
        "StartDate": "2023-12-25",
        "EndDate": "2023-12-25"
    },
    "LeasedTo": {
        "CompanyId": "<string>",
        "DriverName": "<string>",
        "StartDate": "2023-12-25",
        "EndDate": "2023-12-25"
    },
    "StartDate": "2023-12-25",
    "EndDate": "2023-12-25",
    "OwnerOperatorId": "<string>",
    "SteerTire": "<string>",
    "DriveTire": "<string>",
    "TollPasses": [
        {
            "PassType": "<string>",
            "PassValue": "<string>"
        }
    ],
    "IftaEnrollments": [
        {
            "State": "<string>",
            "Sticker": "<string>"
        }
    ],
    "EldProviders": [
        {
            "IntegrationType": "<string>",
            "Id": "<string>",
            "DatagateWayId": "<string>",
            "SensorId": "<string>"
        }
    ],
    "References": [
        {
            "Id": "<string>",
            "TenantReferenceId": "<string>",
            "Value": "<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",
  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([
    'TruckNum' => '<string>',
    'VinNumber' => '<string>',
    'Year' => 123,
    'Make' => '<string>',
    'Model' => '<string>',
    'LicenseNum' => '<string>',
    'LicenseState' => '<string>',
    'LicenseCountry' => '<string>',
    'LicenseExpirationDate' => '2023-12-25',
    'Status' => '<string>',
    'SubsidiaryId' => '<string>',
    'FleetId' => '<string>',
    'NumberOfAxles' => 123,
    'GrossWeight' => [
        'Value' => 123
    ],
    'EmptyWeight' => [
        'Value' => 123
    ],
    'Dimensions' => [
        'Height' => [
                'Value' => 123
        ],
        'Width' => [
                'Value' => 123
        ],
        'Length' => [
                'Value' => 123
        ]
    ],
    'GrossCombinationWeightRating' => [
        'Value' => 123
    ],
    'TireCount' => 123,
    'Color' => '<string>',
    'FuelType' => '<string>',
    'FuelProfile' => [
        'MpgLoaded' => 123,
        'MpgEmpty' => 123,
        'TankCapacity' => [
                'Value' => 123
        ],
        'TankCount' => 123
    ],
    'DeductToll' => true,
    'InsuranceCompany' => '<string>',
    'InsurancePolicyNumber' => '<string>',
    'InsuranceExpirationDate' => '2023-12-25',
    'InspectionExpirationDate' => '2023-12-25',
    'InsuranceValue' => 123,
    'LossPayee' => '<string>',
    'LeasedFrom' => [
        'CompanyId' => '<string>',
        'DriverName' => '<string>',
        'StartDate' => '2023-12-25',
        'EndDate' => '2023-12-25'
    ],
    'LeasedTo' => [
        'CompanyId' => '<string>',
        'DriverName' => '<string>',
        'StartDate' => '2023-12-25',
        'EndDate' => '2023-12-25'
    ],
    'StartDate' => '2023-12-25',
    'EndDate' => '2023-12-25',
    'OwnerOperatorId' => '<string>',
    'SteerTire' => '<string>',
    'DriveTire' => '<string>',
    'TollPasses' => [
        [
                'PassType' => '<string>',
                'PassValue' => '<string>'
        ]
    ],
    'IftaEnrollments' => [
        [
                'State' => '<string>',
                'Sticker' => '<string>'
        ]
    ],
    'EldProviders' => [
        [
                'IntegrationType' => '<string>',
                'Id' => '<string>',
                'DatagateWayId' => '<string>',
                'SensorId' => '<string>'
        ]
    ],
    'References' => [
        [
                'Id' => '<string>',
                'TenantReferenceId' => '<string>',
                'Value' => '<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"

	payload := strings.NewReader("{\n  \"TruckNum\": \"<string>\",\n  \"VinNumber\": \"<string>\",\n  \"Year\": 123,\n  \"Make\": \"<string>\",\n  \"Model\": \"<string>\",\n  \"LicenseNum\": \"<string>\",\n  \"LicenseState\": \"<string>\",\n  \"LicenseCountry\": \"<string>\",\n  \"LicenseExpirationDate\": \"2023-12-25\",\n  \"Status\": \"<string>\",\n  \"SubsidiaryId\": \"<string>\",\n  \"FleetId\": \"<string>\",\n  \"NumberOfAxles\": 123,\n  \"GrossWeight\": {\n    \"Value\": 123\n  },\n  \"EmptyWeight\": {\n    \"Value\": 123\n  },\n  \"Dimensions\": {\n    \"Height\": {\n      \"Value\": 123\n    },\n    \"Width\": {\n      \"Value\": 123\n    },\n    \"Length\": {\n      \"Value\": 123\n    }\n  },\n  \"GrossCombinationWeightRating\": {\n    \"Value\": 123\n  },\n  \"TireCount\": 123,\n  \"Color\": \"<string>\",\n  \"FuelType\": \"<string>\",\n  \"FuelProfile\": {\n    \"MpgLoaded\": 123,\n    \"MpgEmpty\": 123,\n    \"TankCapacity\": {\n      \"Value\": 123\n    },\n    \"TankCount\": 123\n  },\n  \"DeductToll\": true,\n  \"InsuranceCompany\": \"<string>\",\n  \"InsurancePolicyNumber\": \"<string>\",\n  \"InsuranceExpirationDate\": \"2023-12-25\",\n  \"InspectionExpirationDate\": \"2023-12-25\",\n  \"InsuranceValue\": 123,\n  \"LossPayee\": \"<string>\",\n  \"LeasedFrom\": {\n    \"CompanyId\": \"<string>\",\n    \"DriverName\": \"<string>\",\n    \"StartDate\": \"2023-12-25\",\n    \"EndDate\": \"2023-12-25\"\n  },\n  \"LeasedTo\": {\n    \"CompanyId\": \"<string>\",\n    \"DriverName\": \"<string>\",\n    \"StartDate\": \"2023-12-25\",\n    \"EndDate\": \"2023-12-25\"\n  },\n  \"StartDate\": \"2023-12-25\",\n  \"EndDate\": \"2023-12-25\",\n  \"OwnerOperatorId\": \"<string>\",\n  \"SteerTire\": \"<string>\",\n  \"DriveTire\": \"<string>\",\n  \"TollPasses\": [\n    {\n      \"PassType\": \"<string>\",\n      \"PassValue\": \"<string>\"\n    }\n  ],\n  \"IftaEnrollments\": [\n    {\n      \"State\": \"<string>\",\n      \"Sticker\": \"<string>\"\n    }\n  ],\n  \"EldProviders\": [\n    {\n      \"IntegrationType\": \"<string>\",\n      \"Id\": \"<string>\",\n      \"DatagateWayId\": \"<string>\",\n      \"SensorId\": \"<string>\"\n    }\n  ],\n  \"References\": [\n    {\n      \"Id\": \"<string>\",\n      \"TenantReferenceId\": \"<string>\",\n      \"Value\": \"<string>\"\n    }\n  ]\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")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"TruckNum\": \"<string>\",\n  \"VinNumber\": \"<string>\",\n  \"Year\": 123,\n  \"Make\": \"<string>\",\n  \"Model\": \"<string>\",\n  \"LicenseNum\": \"<string>\",\n  \"LicenseState\": \"<string>\",\n  \"LicenseCountry\": \"<string>\",\n  \"LicenseExpirationDate\": \"2023-12-25\",\n  \"Status\": \"<string>\",\n  \"SubsidiaryId\": \"<string>\",\n  \"FleetId\": \"<string>\",\n  \"NumberOfAxles\": 123,\n  \"GrossWeight\": {\n    \"Value\": 123\n  },\n  \"EmptyWeight\": {\n    \"Value\": 123\n  },\n  \"Dimensions\": {\n    \"Height\": {\n      \"Value\": 123\n    },\n    \"Width\": {\n      \"Value\": 123\n    },\n    \"Length\": {\n      \"Value\": 123\n    }\n  },\n  \"GrossCombinationWeightRating\": {\n    \"Value\": 123\n  },\n  \"TireCount\": 123,\n  \"Color\": \"<string>\",\n  \"FuelType\": \"<string>\",\n  \"FuelProfile\": {\n    \"MpgLoaded\": 123,\n    \"MpgEmpty\": 123,\n    \"TankCapacity\": {\n      \"Value\": 123\n    },\n    \"TankCount\": 123\n  },\n  \"DeductToll\": true,\n  \"InsuranceCompany\": \"<string>\",\n  \"InsurancePolicyNumber\": \"<string>\",\n  \"InsuranceExpirationDate\": \"2023-12-25\",\n  \"InspectionExpirationDate\": \"2023-12-25\",\n  \"InsuranceValue\": 123,\n  \"LossPayee\": \"<string>\",\n  \"LeasedFrom\": {\n    \"CompanyId\": \"<string>\",\n    \"DriverName\": \"<string>\",\n    \"StartDate\": \"2023-12-25\",\n    \"EndDate\": \"2023-12-25\"\n  },\n  \"LeasedTo\": {\n    \"CompanyId\": \"<string>\",\n    \"DriverName\": \"<string>\",\n    \"StartDate\": \"2023-12-25\",\n    \"EndDate\": \"2023-12-25\"\n  },\n  \"StartDate\": \"2023-12-25\",\n  \"EndDate\": \"2023-12-25\",\n  \"OwnerOperatorId\": \"<string>\",\n  \"SteerTire\": \"<string>\",\n  \"DriveTire\": \"<string>\",\n  \"TollPasses\": [\n    {\n      \"PassType\": \"<string>\",\n      \"PassValue\": \"<string>\"\n    }\n  ],\n  \"IftaEnrollments\": [\n    {\n      \"State\": \"<string>\",\n      \"Sticker\": \"<string>\"\n    }\n  ],\n  \"EldProviders\": [\n    {\n      \"IntegrationType\": \"<string>\",\n      \"Id\": \"<string>\",\n      \"DatagateWayId\": \"<string>\",\n      \"SensorId\": \"<string>\"\n    }\n  ],\n  \"References\": [\n    {\n      \"Id\": \"<string>\",\n      \"TenantReferenceId\": \"<string>\",\n      \"Value\": \"<string>\"\n    }\n  ]\n}")
  .asString();

{
  "Id": "<string>",
  "TruckNum": "<string>",
  "Status": "<string>",
  "SubsidiaryId": "<string>",
  "GrossWeight": {
    "Value": 123,
    "UnitOfMeasure": "Kilograms"
  },
  "EmptyWeight": {
    "Value": 123,
    "UnitOfMeasure": "Kilograms"
  },
  "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>"
    }
  ],
  "DeductToll": true,
  "InsuranceValue": 123,
  "LossPayee": "<string>",
  "LeasedFrom": {
    "CompanyId": "<string>",
    "DriverName": "<string>",
    "StartDate": "2023-12-25",
    "EndDate": "2023-12-25"
  },
  "LeasedTo": {
    "CompanyId": "<string>",
    "DriverName": "<string>",
    "StartDate": "2023-12-25",
    "EndDate": "2023-12-25"
  },
  "StartDate": "2023-12-25",
  "EndDate": "2023-12-25",
  "Dimensions": {
    "Height": {
      "Value": 123,
      "Unit": "Feet"
    },
    "Width": {
      "Value": 123,
      "Unit": "Feet"
    },
    "Length": {
      "Value": 123,
      "Unit": "Feet"
    }
  },
  "GrossCombinationWeightRating": {
    "Value": 123,
    "UnitOfMeasure": "Kilograms"
  },
  "TireCount": 123,
  "FuelProfile": {
    "MpgLoaded": 123,
    "MpgEmpty": 123,
    "TankCapacity": {
      "Value": 123,
      "UnitOfMeasure": "Gallons"
    },
    "TankCount": 123,
    "FuelKind": "Diesel"
  }
}

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

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

Getting Started

Carriers

Customers

Deductions

Dispatch Preferences

Drivers

Fuel

Invoices

Loads

Locations

Maintenance

References

Tenders

Tolls

Trailers

Trips

Trucks

Users

Subsidiaries

Visibility

Create truck

Truck number and VIN must be unique

Subsidiary

Truck status

Request parameters

Request body

Example cURL request

Response fields

Example response

Status codes

Why a request is refused with 422

Rate limits

Authorizations

Path Parameters

Body

Response