Skip to main content

Vehicle

vehicleIdstring<uuid>

Unique vehicle identifier

userIdstring<uuid>

User who owns the vehicle

orgSlugstring

Organisation slug

targetOrgSlugstring

Target organisation slug

evspProviderSlugstring

EVSP provider slug

evspVehicleIdstring

Vehicle ID from EVSP provider

namestring | nullnullable

Vehicle name

makestring

Vehicle manufacturer

modelstring

Vehicle model

vinstring

Vehicle identification number

yearinteger

Vehicle year

isReachableboolean | nullnullable

Whether the vehicle is currently reachable

lastSeenstring<date-time>

Last time the vehicle was seen

enabledboolean

Whether the vehicle is enabled for forwarding events

createdAtstring<date-time>

When the vehicle was created

updatedAtstring<date-time>

When the vehicle was last updated

battery object
capacitynumber | nullnullable

Battery capacity in kWh

levelnumber | nullnullable

Battery charge level percentage

rangenumber | nullnullable

Estimated range in km

chargeLimitnumber | nullnullable

Charge limit percentage

isChargingboolean | nullnullable

Whether the vehicle is currently charging

isPluggedboolean | nullnullable

Whether the vehicle is plugged in

chargeRatenumber | nullnullable

Current charge rate

powerDeliveryStatestring

Power delivery state

maxCurrentnumber | nullnullable

Maximum current

lastUpdatedAtstring,null<date-time>nullable

When battery data was last updated

location object
latitudenumber | nullnullable

Latitude coordinate

longitudenumber | nullnullable

Longitude coordinate

addressstring | nullnullable

Address string

headingnumber | nullnullable

Vehicle heading in degrees

speednumber | nullnullable

Vehicle speed

lastUpdatedAtstring,null<date-time>nullable

When location data was last updated

odometer object
distancestring

Total distance traveled in km

lastUpdatedAtstring<date-time>

When odometer data was last updated

Vehicle
{
"vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"orgSlug": "string",
"targetOrgSlug": "string",
"evspProviderSlug": "string",
"evspVehicleId": "string",
"name": "string",
"make": "string",
"model": "string",
"vin": "string",
"year": 0,
"isReachable": true,
"lastSeen": "2024-07-29T15:51:28.071Z",
"enabled": true,
"createdAt": "2024-07-29T15:51:28.071Z",
"updatedAt": "2024-07-29T15:51:28.071Z",
"battery": {
"capacity": 0,
"level": 0,
"range": 0,
"chargeLimit": 0,
"isCharging": true,
"isPlugged": true,
"chargeRate": 0,
"powerDeliveryState": "string",
"maxCurrent": 0,
"lastUpdatedAt": "2024-07-29T15:51:28.071Z"
},
"location": {
"latitude": 0,
"longitude": 0,
"address": "string",
"heading": 0,
"speed": 0,
"lastUpdatedAt": "2024-07-29T15:51:28.071Z"
},
"odometer": {
"distance": "string",
"lastUpdatedAt": "2024-07-29T15:51:28.071Z"
}
}