GET api/vehicleLookup?registration={registration}&currentMileage={currentMileage}&applicationId={applicationId}&isSuggested={isSuggested}

Returns vehicle details

Request Information

URI Parameters

NameDescriptionTypeAdditional information
registration

Vehicle registration number

string

Required

currentMileage

Current mileage of the vehicle

integer

Required

applicationId

Application Id against which the vehicle search is being done (it will be mapped to that application to limit the number of searches per one application)

integer

Required

isSuggested

string

Required

Body Parameters

None.

Response Information

Resource Description

Returns vehicle object

ERP.Api.Models.CustomerPortal.Vehicle
NameDescriptionTypeAdditional information
IsShowroomPicked

Set to true if the vehicle came from the showroom

boolean

None.

isSuggested

Set to true if the vehicle was suggested

boolean

None.

Id

Vehicle Id in our crm system (db)

integer

None.

Make

Vehicle Make

string

None.

Model

Vehicle Model

string

None.

Derivative

Vehicle description

string

None.

Registration

Vehicle registration number

string

None.

DateOfRegistration

Vehicle date of registration

date

None.

VIN

Vehicle identification number

string

None.

newcar

Set to true if the vehicle is new or false - if it's used

boolean

None.

mockcar

Set to true if the vehicle is mocked

boolean

None.

EngineSize

Engine capacity in cubic centimetres

integer

None.

сO2Emissions

The value of Carbon Dioxide emitted through the exhaust (g/Km)

integer

None.

FuelType

Fuel type (petrol, diesel etc)

string

None.

Transmission

Transmission type (manual, automatic)

string

None.

Doors

Number of doors in the vehicle

integer

None.

Colour

Colour of the vehicle

string

None.

Mileage

Current mileage of the vehicle

integer

None.

Price

The sales price of the vehicle (as listed by the seller)

decimal number

None.

FullPrice

full price of the vehicle (as listed by the seller)

decimal number

None.

Errors

full price of the vehicle (as listed by the seller)

Object

None.

Valuation

Vehicle valuation provided by vehicle valuation provider service

ERP.Api.Models.CustomerPortal.PriceData

None.

ImageUrl

Vehicle image url

string

None.

CapDetails

The CAP identifiers.

ERP.Domain.Common.VehicleData.CapDetails

None.

Response Formats

application/json, text/json

Sample:
{
  "isShowroomPicked": true,
  "isSuggested": true,
  "id": 1,
  "make": "sample string 2",
  "model": "sample string 3",
  "derivative": "sample string 4",
  "registration": "sample string 5",
  "dateOfRegistration": "2025-01-19",
  "vin": "sample string 6",
  "newcar": true,
  "mockcar": true,
  "engineSize": 9,
  "сO2Emissions": 10,
  "fuelType": "sample string 11",
  "transmission": "sample string 12",
  "doors": 13,
  "colour": "sample string 14",
  "mileage": 15,
  "price": 16.0,
  "fullPrice": 17.0,
  "errors": {},
  "valuation": {
    "average": 1.0,
    "below": 2.0,
    "clean": 3.0,
    "retail": 4.0,
    "future": 5.0
  },
  "imageUrl": "https://crm.creditplus.finance/images/Cap/CapImage.asp?width=350&quality=60&CapID=1",
  "capDetails": {
    "id": 1,
    "code": "sample string 2"
  }
}

application/xml

Sample:

An exception has occurred while using the formatter 'System.Net.Http.Formatting.XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: No set method for property 'ImageUrl' in type 'ERP.Api.Models.CustomerPortal.Vehicle'.

text/xml

Sample:

An exception has occurred while using the formatter 'System.Net.Http.Formatting.XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: No set method for property 'ImageUrl' in type 'ERP.Api.Models.CustomerPortal.Vehicle'.