Vehicle Elements#
External ID#
externalId - Used for various purposes, usually as a tracking code for a Vehicle, or to store internal Vehicle-related information. It is not a unique value.
Reference#
reference - Reference from your external system. Additional custom data can be saved using the customData field.
Name#
name - Indicates the displayed name of the vehicle. It is a mandatory field, and it can be no less than 2 characters.
Photo#
photo - The display photo of the vehicle
url - URL of the photo.
Category#
category - Indicates the category specifications of the vehicle. When selecting a vehicle category, you are selecting speed and dimension presets, which are sent to the routing provider, and based on those, routes are generated. Routes may differ depending on the vehicle category (e.g., large trucks will not be directed to roads with short overpasses).
Enum: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8Vehicle category:#
Vehicle Type#
vehicleType - Vehicle types allow you to set specifications for a particular subset of your vehicle fleet and then select this 'type' when adding vehicles, saving you from duplicating inputs across multiple vehicles of the same type. In short, it is a template with specification presets that get applied to vehicles with the selected type.
vehicleTypeInfo#
Description#
description - Information about the vehicle.
Capacity#
capacity - Vehicle capacity, specified as an object with values given for any/all configured dimensions (Configuration → Dimensions). Configuration of multiple dimensions is available to customers using the Professional plan or higher.
License Plate#
licensePlate - Stores information on the vehicle license plate.
Capabilities#
capabilities - Vehicle Capabilities ensure that Tasks with specific requirements are only assigned to vehicles that meet those attributes.
Teams#
teams - Allows users to specify which Teams of Drivers can utilize the vehicle.
Notes#
notes - Stores additional information about the vehicle.
tags -User-generated entity labels used for analytics and filtering.
Specs#
specs - Stores vehicle specifications. Cost#
cost - Stores information about specific vehicle costs.
perHour - Vehicle’s hourly costs
perDay - Vehicle daily cost
perKM - Vehicle costs per KM travelled
perDimension - Vehicle costs dimension it carries
Custom data#
customData - Holds additional reference, external IDs, or any other desired data
Modified at 2025-12-04 15:23:50