Vehicle

Represents information about a vehicle. This object is available in API version 56.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Fields

Field Details
ActiveRecallCount
Type
int
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The number of active recalls for parts related to the vehicle.
ActiveServiceContractCount
Type
int
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The number of active service contracts for the vehicle.
ActiveSubscriptionCount
Type
int
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The number of active subscriptions for the vehicle.
ActiveWarrantyCount
Type
int
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The number of active warranties for the vehicle.
AssetId
Type
reference
Properties
Create, Filter, Group, Sort
Description
The asset associated with the vehicle. This field is unique within your organization.
This field is a relationship field.
Relationship Name
Asset
Relationship Type
Lookup
Refers To
Asset
AverageMarketValue
Type
currency
Properties
Create, Filter, Nillable, Sort, Update
Description
The average market value of the vehicle.
ChassisNumber
Type
string
Properties
Create, Filter, Group, idLookup, Nillable, Sort, Update
Description
The chassis number that is unique to the vehicle.
Classification
Type
string
Properties
Filter, Group, Nillable, Sort
Description
Auto-populated based on the vehicle classification specified on the related vehicle definition.
ConditionType
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Specifies the current status of the vehicle.
Possible values are:
  • New
  • Old
  • Scrap
CurrentOwnerId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The current owner of the vehicle.
This field is a relationship field.
Relationship Name
CurrentOwner
Relationship Type
Lookup
Refers To
Account
CylinderCount
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The number of cylinders in the engine of the vehicle.
DrivetrainSystem
Type
picklist
Properties
Filter, Group, Nillable, Sort
Description
Auto-populated based on the drivetrain system specified on the related vehicle definition.
EngineName
Type
string
Properties
Filter, Group, Nillable, Sort
Description
Auto-populated based on the engine name specified on the related vehicle definition.
EngineNumber
Type
string
Properties
Create, Filter, Group, idLookup, Nillable, Sort, Update
Description
The engine number of the vehicle.
ExteriorColor
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The exterior color of the vehicle.
FrontRimSize
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The rim size of the front wheel of the vehicle.
FrontTireSize
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The size of the front tire of the vehicle.
FuelSource
Type
picklist
Properties
Filter, Group, Nillable, Sort
Description
Auto-populated based on the fuel source specified on the related vehicle definition.
GearBoxType
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The gear box type for the vehicle.
HeadUnitName
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The head unit of the vehicle.
HeadUnitSecurityCode
Type
encryptedstring
Properties
Create, Nillable, Update
Description
The anti-theft code or security code that unlocks the head unit of a car. If the factory car stereo is stolen from the vehicle, the head unit becomes inoperable without this code.
HighestMarketValue
Type
currency
Properties
Create, Filter, Nillable, Sort, Update
Description
The highest market value of the vehicle.
IgnitionKeyCode
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The unique code associated with a vehicle's ignition key that is useful in case it's stolen or replaced.
InteriorColor
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The interior color of the vehicle.
IsConnectedServiceActive
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether connected services for a vehicle are active (true) or not (false).
The default value is false.
IsRecallOpen
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicate whether a recall is required for the vehicle.
The default value is false.
IsTelematicsServiceActive
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the vehicle has any subscription to Telematics Services or not. Telematics services collect key performance data related to a vehicle.
The default value is false.
LastOdometerReading
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
The last odometer reading that was recorded for the vehicle.
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The most recent date on which a user referenced this record.
LastServiceDate
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The date when the vehicle was last serviced.
LastViewedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The most recent date on which a user viewed this record.
Type
currency
Properties
Create, Filter, Nillable, Sort, Update
Description
The residual value of the vehicle.
LatestResidualValue
LatestResidualValueDate
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The date when the residual value is calculated.
Location
Type
address
Properties
Filter, Nillable
Description
The current location of the vehicle.
LocationCity
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The city where the vehicle is located.
LocationCountry
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The country where the vehicle is located.
LocationGeocodeAccuracy
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The level of accuracy of a location’s geographical coordinates compared with its physical address. A geocoding service typically provides this value based on the vehicle’s latitude and longitude coordinates.
Possible values are:
  • Address
  • Block
  • City
  • County
  • ExtendedZip
  • NearAddress
  • Neighborhood
  • State
  • Street
  • Unknown
  • Zip
LocationLatitude
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
Used with Longitude to specify the precise geolocation of the vehicle. Acceptable values are numbers between –90 and 90 with up to 15 decimal places.
LocationLongitude
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
Used with Latitude to specify the precise geolocation of the vehicle. Acceptable values are numbers between –180 and 180 with up to 15 decimal places.
LocationPostalCode
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The postal code where the vehicle is located.
LocationState
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The state where the vehicle is located.
LocationStreet
Type
textarea
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The street where the vehicle is located.
LowestMarketValue
Type
currency
Properties
Create, Filter, Nillable, Sort, Update
Description
The lowest market value of the vehicle.
MakeName
Type
string
Properties
Filter, Group, Nillable, Sort
Description
Auto-populated based on the make name on the product record related to the vehicle definition.
ManufacturedDate
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The manufacturing date of the vehicle.
ManufacturerWarrantyEndDate
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The date until which the factory warranty is applicable for the vehicle.
ManufacturerWarrantyStartDt
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The date from which the factory warranty is applicable for the vehicle.
ManufacturingBatchNumber
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The manufacturing batch number of the vehicle.
ManufacturingPlantName
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The name of the manufacturing plant for the vehicle.
MarketPrice
Type
currency
Properties
Create, Filter, Nillable, Sort, Update
Description
The market price of the vehicle.
MarketPriceDate
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The date when the market price is calculated.
MarketPriceSource
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The source for the market price of the vehicle.
Possible values are:
  • NationalAutomobileDealersAssociation
  • KellyBluebook
ModelName
Type
string
Properties
Filter, Group, Nillable, Sort
Description
Auto-populated based on the model name on the product record related to the vehicle definition.
ModelYear
Type
string
Properties
Filter, Group, Nillable, Sort
Description
Auto-populated based on the model year on the product record related to the vehicle definition.
Name
Type
string
Properties
Create, Filter, Group, idLookup, Sort, Update
Description
The name of the vehicle.
OdometerReadingDate
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The most recent date when the odometer reading was taken.
OdometerReadingUomId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The odometer reading UOM associated with the vehicle.
This field is a relationship field.
Relationship Name
OdometerReadingUom
Relationship Type
Lookup
Refers To
UnitOfMeasure
OdometerState
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Specifies the current status of the odometer in the vehicle. Use this field because the field OdometerStatus will be deprecated soon.
OdometerStatus
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Specifies the condition of the odometer such as new, tampered, or replaced.
Possible values are:
  • Altered
  • ExceedsMechanicalLimit—Exceeds Mechanical Limit
  • Exempt
  • New
  • Normal
  • Replaced
  • Tampered
RearRimSize
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The rim size of the rear wheel of the vehicle.
RearTireSize
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The size of the rear tire of the vehicle.
RegistrationRegionCode
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Specifies the state code associated with this registration number.
Possible values are:
  • AZ
  • CA
  • IA
  • NJ
  • NY
  • TX
RegistrationValidityDate
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The date until which the registration of the vehicle is valid.
SourceSystemIdentifier
Type
string
Properties
Create, Filter, Group, idLookup, Nillable, Sort, Update
Description
The unique identifier of the vehicle in the external system.
SourceSystemName
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The external system from where this record was imported.
Status
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The status of the vehicle.
Possible values are:
  • At Dealer Location
  • In Service
  • In Repair
  • In Manufacturing
SteeringType
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The steering type of the vehicle.
StockCode
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The unique code assigned to a vehicle at the dealership to keep track of the inventory.
TrimLevel
Type
string
Properties
Filter, Group, Nillable, Sort
Description
Auto-populated based on the trim level on the product record related to the vehicle definition.
UpholsteryColor
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The color of the upholstery of the vehicle.
UpholsteryType
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The type of upholstery material of the vehicle.
VehicleDefinitionId
Type
reference
Properties
Create, Filter, Group, Sort, Update
Description
The vehicle specification associated with the vehicle.
This field is a relationship field.
Relationship Name
VehicleDefinition
Relationship Type
Lookup
Refers To
VehicleDefinition
VehicleIdentificationNumber
Type
string
Properties
Create, Filter, Group, idLookup, Sort, Update
Description
The number that uniquely identifies the vehicle. This field is unique within your organization.
VehicleRegistrationNumber
Type
string
Properties
Create, Filter, Group, idLookup, Nillable, Sort, Update
Description
The registration number issued for the vehicle.

Associated Objects

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.

VehicleChangeEvent (API Version 62.0)
Change events are available for the object.
VehicleFeed
Feed tracking is available for the object.
VehicleHistory
History is available for tracked fields of the object.