v1

latestOpenAPI 3.1.02026-07-2617501.1 MB

Create a new vehicle

post/v1/vehicles

Headers

X-Time-Zonestring

Specify the timezone for formatting the timestamps.

X-Metric-Unitsboolean

Specify if you want to use the Metric units or the Imperial units. TRUE: Metric units. FALSE: Imperial Units

X-User-Idinteger

Specify the ID of the Fleet Admin or the Fleet Manager who is accessing this endpoint.

Request body

numberinteger required

A unique number assigned to the vehicle that you are creating. NOTE: Ensure to add a unique number for each vehicle that you create. If you use an existing number, the system will notify that you are using an existing number.

eld_device_idinteger

Specify the ID number of the vehicle gateway that is assigned to the vehicle.

statusstring

Specify the status of the vehicle. Allowed values are <b>active</b>, and <b>inactive</b>.

iftaboolean

Specify if the vehicle is part of the IFTA calculations. TRUE: Denotes that the vehicle is part of the calculations. FALSE: The vehicle is not part of the calculations.

metric_unitsboolean

Specify if the is using Metric Units or the Imperial Units. TRUE: Uses the metric units. FALSE: Uses the imperial units.

fuel_typestring

Specify the type of the fuel the vehicle is using. Allowed values are: diesel, gasoline, propane, lng, cng, ethanol, methanol, e85, m85, a55, biodiesel, and other.

vinstring

Specify the Vehicle Identification Number (VIN).

license_plate_statestring

Specify the state where the license number was issued.

license_plate_numberstring

Specify the license number plate of the vehicle.

makestring

Specify the make of the vehicle.

modelstring

Specify the model of the vehicle.

yearstring

Specify the year when the vehicle was manufactured.

prevent_auto_odometer_entryboolean

Specify if the vehicle prevents an auto odometer entry. TRUE: The vehicle prevents the odometer entry. FALSE: The vehicle does not prevent the odometer entry.

permanent_driver_idinteger

Specify the permanent driver ID that is assigned to the driver of the vehicle.

notesstring

Mention any notes for the vehicle that you are creating.

driver_facing_camerainteger

Denotes if the recording of the driver facing camera is enabled or not. Allowed values are: -1: no_override (meaning cannot be overridden), 0: No recording, 1: Recording enabled, 2: No recording while idling, & 3: Recording enabled if engine in ON.

incab_audio_recordinginteger

Denotes if the audio from the driver's cab is being recorded or not. Allowed values are: -1: No manual override, 0: No recording of audio, 1: Audio recording enabled.

Response

200

Example response

{
  "vehicle": {
    "company_id": 285945,
    "number": "139",
    "status": "active",
    "ifta": true,
    "fuel_type": "diesel"
  },
  "availability_details": {
    "availability_status": "out_of_service",
    "out_of_service_reason": "Vehicle Maintenance",
    "updated_at": "2024-07-31T05:30:53Z",
    "additional_note": "This vehicle is scheduled for maintenance",
    "custom_driver_app_warning_prompt": "This vehicle is scheduled for maintenance, please don't operate",
    "updated_by_user": {
      "id": 123,
      "first_name": "First",
      "last_name": "Last",
      "user_name": "demo_dispatcher",
      "email": "demo.dispatcher@gmail.com",
      "company_reference_id": 1234,
      "status": "active",
      "role": "dispatcher"
    }
  }
}