The Car object

The Car object

A car is one vehicle you can hire for the dates you searched. bookingOptions is the short list of sellers and prices. id is stable for the life of the search token and meaningless after it expires.

Attributes

idstringRequired

Opaque identifier of this car. Pass it as resultId to /cars/details.

carobject

The vehicle.

namestring

Vehicle name as listed, for example Nissan Versa.

classstring

Display class, for example Compact or Intermediate SUV.

classGroupsarray of strings

Groups this car belongs to, such as small or suv. Matches carClass on a new search.

imagestring

Image URL.

passengersinteger

Seat count.

bagsinteger

Bag count.

doorsinteger

Door count.

transmissionstring

automatic or manual.

airConditioningboolean

True when the car has air conditioning.

fuelTypestring

Fuel label, for example Gas or Fully electric.

sipCodestring

ACRISS / SIP code when the supplier publishes one.

agencyobject

The rental company that owns the car.

codestring

Agency code.

namestring

Display name, for example Europcar.

pickupobject

The pickup desk.

locationIdstring

Desk id. Different from the city id you sent as pickupLocation.

typestring

Desk type, for example IN_TERMINAL or NON_AIRPORT.

isAirportboolean

True when the desk is at an airport.

airportCodestring

IATA airport code when isAirport is true.

addressstring

Street address when the supplier publishes one.

citystring

City of the desk.

countrystring

ISO 3166-1 alpha-2 country code.

distancestring

Distance from the city centre, already formatted.

latnumber

Latitude.

lngnumber

Longitude.

ratingobject

Desk reviews.

overallnumber

Desk score on a 0–10 scale.

labelstring

Short label for the score, for example good.

countinteger

How many reviews the score is based on.

breakdownsarray of objects

Per-category scores when the supplier publishes them.

operatingHoursarray of objects

Opening hours. open and close are HHMM integers, for example 730 is 07:30.

priceobject

Lowest total price on this car.

amountnumber

Numeric amount in the country’s native currency.

currencystring

ISO 4217 code of that country’s native currency.

formattedstring

Same amount, already formatted for display.

bestOptionobject

The cheapest seller for this car. Details expands every seller.

providerstring

Seller code of the cheapest option.

priceobject

Total price.

amountnumber

Numeric amount in the country’s native currency.

currencystring

ISO 4217 code of that country’s native currency.

formattedstring

Same amount, already formatted for display.

perDayobject

Average daily price.

amountnumber

Numeric amount in the country’s native currency.

currencystring

ISO 4217 code of that country’s native currency.

formattedstring

Same amount, already formatted for display.

paymentTypestring

PREPAY or PAY_AT_PICKUP.

freeCancellationboolean

True when this option can be cancelled without a fee.

mileagestring

Mileage allowance, already formatted.

fuelPolicystring

Fuel policy name, for example full-to-full.

bookingOptionsarray of objects

Sellers for this car. Details fills in providerUrl on each one.

providerstring

Seller code. providers on the page maps it to a display name.

providerNamestring

Display name of the seller.

priceobject

Total price for the hire.

amountnumber

Numeric amount in the country’s native currency.

currencystring

ISO 4217 code of that country’s native currency.

formattedstring

Same amount, already formatted for display.

perDayobject

Average daily price.

amountnumber

Numeric amount in the country’s native currency.

currencystring

ISO 4217 code of that country’s native currency.

formattedstring

Same amount, already formatted for display.

paymentTypestring

PREPAY or PAY_AT_PICKUP.

freeCancellationboolean

True when this option can be cancelled without a fee.

optionCountinteger

How many sellers offered this car.

badgesarray of objects

Highlights such as a discount label.

discountobject

How this price compares with the class average, when published.

viewRankinteger

Rank of this car in the search.