Skip to main content

Vehicle data model

This is the data structure of Vehicle entity when you are trying to create or update Vehicle in myKaarma.

Summary of the fields.

Parameter NameDescriptionRequired
vehicles.vinThe Vehicle Identification Number, a unique code for the vehicle.Yes ( only if vehicles is not empty and make, model & year are empty)
vehicles.vehicleYearThe year the vehicle was manufactured.No ( yes only vehicles is not empty and vin is empty)
vehicles.vehicleMakeThe manufacturer or brand of the vehicle.No ( yes only vehicles is not empty and vin is empty)
vehicles.vehicleModelThe specific model of the vehicle.No ( yes only vehicles is not empty and vin is empty)
vehicles.vehicleEngineThe type or specification of the vehicle's engine.No
vehicles.isValidBoolean indicating if the vehicle is owned by customer or not presently.No
vehicles.licensePlateThe vehicle's license plate number.No
vehicles.colorThe color of the vehicle.No
vehicles.estimatedMileageThe estimated mileage the vehicle has traveled.No
vehicles.vehicleTrimThe trim of the vehicle.No