Vehicles

Vehicles represent fleet assets that can be tracked, assigned, and used to fulfill orders. Use vehicle endpoints to manage registration details, assignment state, live location, and operational status.

The Vehicle object

A vehicle represents a trackable asset used for FleetOps assignment, routing, and capacity planning. It stores vehicle identity, status, assignment, current position, capacity, orchestrator constraints, and metadata.

Attributes

idstringoptional

Public vehicle identifier.

internal_idstringoptional

Optional internal identifier.

photo_urlstringoptional

Vehicle photo URL.

avatar_urlstringoptional

Vehicle avatar URL.

namestringoptional

Vehicle display name.

descriptionstringoptional

Vehicle description.

driverobjectoptional

Assigned driver, when loaded.

devicesarray of objectsoptional

Vehicle devices, when loaded.

makestringoptional

Vehicle manufacturer.

modelstringoptional

Vehicle model.

model_typestringoptional

Vehicle model type.

yearintegeroptional

Model year.

trimstringoptional

Vehicle trim.

typestringoptional

Vehicle type.

classstringoptional

Vehicle class.

colorstringoptional

Vehicle color.

serial_numberstringoptional

Vehicle serial number.

plate_numberstringoptional

License plate number.

call_signstringoptional

Vehicle call sign.

vinstringoptional

Vehicle identification number.

vin_dataobjectoptional

Decoded VIN data.

specsobjectoptional

Vehicle specification data.

detailsobjectoptional

Additional vehicle detail data.

statusstringoptional

Vehicle operational status.

onlinebooleanoptional

Whether the vehicle is online.

slugstringoptional

URL-friendly vehicle slug.

financing_statusstringoptional

Vehicle financing status.

measurement_systemstringoptional

Measurement system used for vehicle metrics.

odometernumberoptional

Current odometer reading.

odometer_unitstringoptional

Unit for odometer readings.

fuel_typestringoptional

Vehicle fuel type.

payload_capacitynumberoptional

Payload capacity.

towing_capacitynumberoptional

Towing capacity.

seating_capacityintegeroptional

Seating capacity.

weightnumberoptional

Vehicle weight.

lengthnumberoptional

Vehicle length.

widthnumberoptional

Vehicle width.

heightnumberoptional

Vehicle height.

currencycurrencyoptional

Currency for vehicle financial fields.

acquisition_costcurrencyoptional

Acquisition cost.

current_valuecurrencyoptional

Current vehicle value.

purchased_attimestampoptional

Purchase timestamp.

lease_expires_attimestampoptional

Lease expiration timestamp.

deleted_attimestampoptional

Deletion timestamp when soft deleted.

updated_attimestampoptional

Timestamp when the vehicle was last updated.

created_attimestampoptional

Timestamp when the vehicle was created.

locationobjectoptional

Current vehicle coordinates.

headingintegeroptional

Current heading in degrees.

altitudeintegeroptional

Current altitude.

speedintegeroptional

Current speed.

telematicsobjectoptional

Telematics payload.

notesstringoptional

Vehicle notes.

metaobjectoptional

Additional vehicle metadata.

The Vehicle object

{
  "id": "vehicle_7YqM3KpL2n",
  "internal_id": "VEH-1001",
  "photo_url": null,
  "avatar_url": null,
  "name": "ABC123",
  "description": null,
  "driver": null,
  "make": "Toyota",
  "model": "Camry",
  "year": 2023,
  "trim": "SE",
  "type": "sedan",
  "plate_number": "ABC123",
  "vin": "1GCGSBEA0G1111111",
  "status": "operational",
  "online": false,
  "payload_capacity": 500,
  "location": {
    "latitude": 40.7484,
    "longitude": -73.9857
  },
  "heading": 0,
  "altitude": 0,
  "speed": 0,
  "notes": null,
  "meta": {},
  "updated_at": "2026-05-07T08:30:00.000000Z",
  "created_at": "2026-05-07T08:30:00.000000Z"
}

POST/v1/vehicles

Create a Vehicle

Creates a vehicle for the current company. Send VIN, make/model fields, assignment fields, status, location, capacity, or orchestrator constraints as needed.

Body parameters

vinstringoptional

Vehicle identification number.

yearintegeroptional

Model year of the vehicle.

makestringoptional

Vehicle manufacturer.

modelstringoptional

Vehicle model.

trimstringoptional

Vehicle trim or variant.

typestringoptional

Vehicle type.

plate_numberstringoptional

Vehicle license plate number.

statusenumoptional

Vehicle operational status. One of operational, maintenance, decommissioned.

vendorstringoptional

Vendor ID to assign to the vehicle.

driverstringoptional

Driver ID to assign this vehicle to after creation.

onlinebooleanoptionalDefault: false

Whether the vehicle is online.

locationobjectoptional

Resolvable point used as the vehicle's current location.

latitudenumberoptional

Decimal latitude. Required with longitude.

longitudenumberoptional

Decimal longitude. Required with latitude.

altitudenumberoptional

Current altitude.

headingnumberoptional

Current heading in degrees.

speednumberoptional

Current speed.

payload_capacitynumberoptional

Payload capacity value used by orchestrator assignment.

payload_capacity_volumenumberoptional

Payload volume capacity.

payload_capacity_palletsintegeroptional

Pallet capacity.

payload_capacity_parcelsintegeroptional

Parcel capacity.

skillsarray of stringsoptional

Skills supported by the vehicle for orchestrator assignment.

max_tasksintegeroptional

Maximum concurrent tasks for orchestrator assignment.

time_window_starttimestampoptional

Earliest time the vehicle is available.

time_window_endtimestampoptional

Latest time the vehicle is available.

return_to_depotbooleanoptional

Whether the vehicle should return to depot after assigned work.

metaobjectoptional

Additional vehicle metadata.

POST/v1/vehicles

curl -X POST https://api.fleetbase.io/v1/vehicles \
  -H "Authorization: Bearer flb_live_…" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
  "vin": "1GCGSBEA0G1111111",
  "year": 2023,
  "make": "Toyota",
  "model": "Camry",
  "trim": "SE",
  "plate_number": "ABC123",
  "status": "maintenance",
  "online": false
}'

201 OK

{
  "id": "<string>",
  "name": "<string>",
  "vin": "<string>",
  "driver": "<string>",
  "photo_url": "<string>",
  "make": "<string>",
  "model": "<string>",
  "year": "<string>",
  "trim": "<string>",
  "type": "<string>",
  "plate_number": "<string>",
  "status": "<string>",
  "updated_at": "<string>",
  "created_at": "<string>"
}

GET/v1/vehicles

Query Vehicles

This endpoint allows you to query vehicles you have created, it also provides paginated results on all the vehicles in your Fleetbase.

Query parameters

querystringoptional

Search term matched against vehicle fields.

limitintegeroptional

Maximum number of vehicles to return.

offsetintegeroptional

Number of vehicles to skip before returning results.

sortstringoptional

Sort expression for the vehicle query.

vendorstringoptional

Vendor ID used to filter vehicles assigned to a vendor.

GET/v1/vehicles

curl https://api.fleetbase.io/v1/vehicles?query={{vehicle_name}}&limit=25&offset=0&sort=created_at \
  -H "Authorization: Bearer flb_live_…" \
  -H "Accept: application/json"

200 OK

{
  "id": "<string>",
  "name": "<string>",
  "vin": "<string>",
  "driver": "<string>",
  "photo_url": "<string>",
  "make": "<string>",
  "model": "<string>",
  "year": "<string>",
  "trim": "<string>",
  "type": "<string>",
  "plate_number": "<string>",
  "vin_data": {
    "make": "<string>",
    "manufacturer": "<string>",
    "plant_country": "<string>",
    "product_type": "<string>",
    "manufacturer_address": "<string>",
    "check_digit": "<string>",
    "model_year": "<string>",
    "sequential_number": "<string>",
    "model": "<string>",
    "plant_city": "<string>",
    "trim": "<string>",
    "plant_state": "<string>",
    "body": "<string>",
    "number_of_doors": "<string>",
    "transmission": "<string>",
    "number_of_gears": "<string>",
    "engine_displacement_ccm": "<number>",
    "engine_model": "<string>",
    "engine_power_kw": "<number>",
    "series": "<string>",
    "fuel_type_primary": "<string>",
    "production_stopped": "<number>"
  },
  "model_data": {
    "0_to_100_kph": "<string>",
    "body": "<string>",
    "co2": "<string>",
    "doors": "<number>",
    "drive": "<string>",
    "engine_bore_mm": "<string>",
    "engine_cc": "<number>",
    "engine_compression": "<string>",
    "engine_cyl": "<number>",
    "engine_fuel": "<string>",
    "engine_position": "<string>",
    "engine_power_ps": "<number>",
    "engine_power_rpm": "<number>",
    "engine_stroke_mm": "<string>",
    "engine_torque_nm": "<number>",
    "engine_torque_rpm": "<number>",
    "engine_valves_per_cyl": "<number>",
    "fuel_cap_l": "<number>",
    "length_mm": "<number>",
    "lkm_city": "<string>",
    "lkm_hwy": "<string>",
    "lkm_mixed": "<string>",
    "make_display": "<string>",
    "seats": "<number>",
    "sold_in_us": "<number>",
    "top_speed_kph": "<string>",
    "transmission_type": "<string>",
    "weight_kg": "<number>",
    "wheelbase_mm": "<number>",
    "width_mm": "<number>"
  },
  "status": "<string>",
  "updated_at": "<string>",
  "created_at": "<string>"
}

GET/v1/vehicles/:id

Retrieve a Vehicle

Retrieve details for a specific Vehicle.

GET/v1/vehicles/:id

curl https://api.fleetbase.io/v1/vehicles/:id \
  -H "Authorization: Bearer flb_live_…" \
  -H "Accept: application/json"

200 OK

{
  "id": "<string>",
  "name": "<string>",
  "vin": "<string>",
  "driver": "<string>",
  "photo_url": "<string>",
  "make": "<string>",
  "model": "<string>",
  "year": "<string>",
  "trim": "<string>",
  "type": "<string>",
  "plate_number": "<string>",
  "vin_data": {
    "make": "<string>",
    "manufacturer": "<string>",
    "plant_country": "<string>",
    "product_type": "<string>",
    "manufacturer_address": "<string>",
    "check_digit": "<string>",
    "model_year": "<string>",
    "sequential_number": "<string>",
    "model": "<string>",
    "plant_city": "<string>",
    "trim": "<string>",
    "plant_state": "<string>",
    "body": "<string>",
    "number_of_doors": "<string>",
    "transmission": "<string>",
    "number_of_gears": "<string>",
    "engine_displacement_ccm": "<number>",
    "engine_model": "<string>",
    "engine_power_kw": "<number>",
    "series": "<string>",
    "fuel_type_primary": "<string>",
    "production_stopped": "<number>"
  },
  "model_data": {
    "0_to_100_kph": "<string>",
    "body": "<string>",
    "co2": "<string>",
    "doors": "<number>",
    "drive": "<string>",
    "engine_bore_mm": "<string>",
    "engine_cc": "<number>",
    "engine_compression": "<string>",
    "engine_cyl": "<number>",
    "engine_fuel": "<string>",
    "engine_position": "<string>",
    "engine_power_ps": "<number>",
    "engine_power_rpm": "<number>",
    "engine_stroke_mm": "<string>",
    "engine_torque_nm": "<number>",
    "engine_torque_rpm": "<number>",
    "engine_valves_per_cyl": "<number>",
    "fuel_cap_l": "<number>",
    "length_mm": "<number>",
    "lkm_city": "<string>",
    "lkm_hwy": "<string>",
    "lkm_mixed": "<string>",
    "make_display": "<string>",
    "seats": "<number>",
    "sold_in_us": "<number>",
    "top_speed_kph": "<string>",
    "transmission_type": "<string>",
    "weight_kg": "<number>",
    "wheelbase_mm": "<number>",
    "width_mm": "<number>"
  },
  "status": "<string>",
  "updated_at": "<string>",
  "created_at": "<string>"
}

PUT/v1/vehicles/:id

Update a Vehicle

Updates a vehicle's identity, operational status, vendor assignment, location, capacity, or orchestrator constraints. Updating the VIN refreshes decoded VIN data.

Body parameters

vinstringoptional

Vehicle identification number. Updating the VIN refreshes decoded VIN data.

yearintegeroptional

Model year of the vehicle.

makestringoptional

Vehicle manufacturer.

modelstringoptional

Vehicle model.

trimstringoptional

Vehicle trim or variant.

typestringoptional

Vehicle type.

plate_numberstringoptional

Vehicle license plate number.

statusenumoptional

Vehicle operational status. One of operational, maintenance, decommissioned.

vendorstringoptional

Vendor ID to assign to the vehicle.

onlinebooleanoptionalDefault: false

Whether the vehicle is online.

locationobjectoptional

Resolvable point used as the vehicle's current location.

latitudenumberoptional

Decimal latitude. Required with longitude.

longitudenumberoptional

Decimal longitude. Required with latitude.

altitudenumberoptional

Current altitude.

headingnumberoptional

Current heading in degrees.

speednumberoptional

Current speed.

payload_capacitynumberoptional

Payload capacity value used by orchestrator assignment.

payload_capacity_volumenumberoptional

Payload volume capacity.

payload_capacity_palletsintegeroptional

Pallet capacity.

payload_capacity_parcelsintegeroptional

Parcel capacity.

skillsarray of stringsoptional

Skills supported by the vehicle for orchestrator assignment.

max_tasksintegeroptional

Maximum concurrent tasks for orchestrator assignment.

time_window_starttimestampoptional

Earliest time the vehicle is available.

time_window_endtimestampoptional

Latest time the vehicle is available.

return_to_depotbooleanoptional

Whether the vehicle should return to depot after assigned work.

metaobjectoptional

Additional vehicle metadata.

PUT/v1/vehicles/:id

curl -X PUT https://api.fleetbase.io/v1/vehicles/:id \
  -H "Authorization: Bearer flb_live_…" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "plate_number": "ABC123",
    "status": "operational",
    "latitude": 40.7484,
    "longitude": -73.9857,
    "speed": 90
}'

200 OK

{
  "id": "<string>",
  "name": "<string>",
  "vin": "<string>",
  "driver": "<string>",
  "photo_url": "<string>",
  "make": "<string>",
  "model": "<string>",
  "year": "<string>",
  "trim": "<string>",
  "type": "<string>",
  "plate_number": "<string>",
  "model_data": {
    "0_to_100_kph": "<string>",
    "body": "<string>",
    "co2": "<string>",
    "doors": "<number>",
    "drive": "<string>",
    "engine_bore_mm": "<string>",
    "engine_cc": "<number>",
    "engine_compression": "<string>",
    "engine_cyl": "<number>",
    "engine_fuel": "<string>",
    "engine_position": "<string>",
    "engine_power_ps": "<number>",
    "engine_power_rpm": "<number>",
    "engine_stroke_mm": "<string>",
    "engine_torque_nm": "<number>",
    "engine_torque_rpm": "<number>",
    "engine_valves_per_cyl": "<number>",
    "fuel_cap_l": "<number>",
    "length_mm": "<number>",
    "lkm_city": "<string>",
    "lkm_hwy": "<string>",
    "lkm_mixed": "<string>",
    "make_display": "<string>",
    "seats": "<number>",
    "sold_in_us": "<number>",
    "top_speed_kph": "<string>",
    "transmission_type": "<string>",
    "weight_kg": "<number>",
    "wheelbase_mm": "<number>",
    "width_mm": "<number>"
  },
  "vin_data": {
    "make": "<string>",
    "manufacturer": "<string>",
    "plant_country": "<string>",
    "product_type": "<string>",
    "manufacturer_address": "<string>",
    "check_digit": "<string>",
    "model_year": "<string>",
    "sequential_number": "<string>",
    "model": "<string>",
    "plant_city": "<string>",
    "trim": "<string>",
    "plant_state": "<string>",
    "body": "<string>",
    "number_of_doors": "<string>",
    "transmission": "<string>",
    "number_of_gears": "<string>",
    "engine_displacement_ccm": "<number>",
    "engine_model": "<string>",
    "engine_power_kw": "<number>",
    "series": "<string>",
    "fuel_type_primary": "<string>",
    "production_stopped": "<number>"
  },
  "status": "<string>",
  "updated_at": "<string>",
  "created_at": "<string>"
}

DELETE/v1/vehicles/:id

Delete a Vehicle

Permanently deletes a Vehicle. It cannot be undone.

DELETE/v1/vehicles/:id

curl -X DELETE https://api.fleetbase.io/v1/vehicles/:id \
  -H "Authorization: Bearer flb_live_…" \
  -H "Accept: application/json"

200 OK

{
  "deleted": "<boolean>",
  "id": "<string>"
}

PATCH/v1/vehicles/:id/track

Track Vehicle

Body parameters

latitudenumberoptional

Vehicle latitude. When omitted with longitude, Fleetbase returns the current vehicle resource without updating location.

longitudenumberoptional

Vehicle longitude. When omitted with latitude, Fleetbase returns the current vehicle resource without updating location.

altitudenumberoptional

Current altitude.

headingnumberoptional

Current heading in degrees.

speednumberoptional

Current speed.

PATCH/v1/vehicles/:id/track

curl -X PATCH https://api.fleetbase.io/v1/vehicles/:id/track \
  -H "Authorization: Bearer flb_live_…"