Parameter Groups
Request parameters are organised into six named groups. Quote accepts all six; other endpoints accept specific subsets, listed on each endpoint's page.
Group A. Core booking
Required by: Quote, InstantBooking, Purchase, Update
FromDate
datetime
Vehicle pickup date/time. Format: yyyy-mm-dd hh:mm:ss.
ToDate
datetime
Vehicle drop-off date/time. Format: yyyy-mm-dd hh:mm:ss.
DestinationCountry
string(2)
ISO 3166-1 alpha-2 country code for the country of travel.
CustomerAge
integer
Age of the primary driver.
Email
string
Customer email address.
FirstName
string
Customer first name. Pass NULL if unknown.
LastName
string
Customer last name. Pass NULL if unknown.
Country
string(2)
ISO 3166-1 alpha-2 country code for the customer's country of residence or IP geolocation.
Group B. Customer
Optional
Region
string
Customer's state, region, or territory code (2–3 letters). Required for AU, BR, CA, and US customers. See Supported Regions.
Address1
string(50)
Customer street address line 1.
Address2
string(50)
Customer street address line 2.
City
string
Customer city or suburb.
PostalCode
string
Customer postcode or zip code.
Phone
string
Customer phone number.
OtherEmail
string
Secondary email address.
OtherDriveAge1
integer
Age of second driver.
OtherDriveAge2
integer
Age of third driver.
Group C. Vehicle
Optional. Not accepted by InstantBooking.
VehicleCode
string
Vehicle SIPP code.
VehicleName
string
Vehicle name.
VehicleCategory
string
Vehicle category (use when SIPP code is not available).
VehicleClass
string
Vehicle class.
VehicleBerths
string
Number of berths (for motorhomes/campervans).
VehicleOffroad4x4
boolean
Whether the vehicle is an off-road 4WD. Default: false.
VehicleTypes
string(100)
Comma-separated vehicle types. Values: car, motorhome, campervan, 4x4, minibus, lighttruck, bus.
VehicleSupplierId
string
Vehicle supplier ID.
VehicleSupplierIdTwo
string
Second vehicle supplier ID.
VehicleSupplierName
string
Vehicle supplier name.
VehicleSupplierCountryId
string(2)
Vehicle supplier country code.
VehiclePickupTime
datetime (UTC Atom)
Local pickup time with UTC offset. Example: 2025-08-01T10:00:00+02:00. Determines the cancellation grace period (pickup time + 15 minutes).
VehiclePickupCity
string(50)
Pickup city. Pass your own identifier, unstructured.
VehiclePickupCountry
string(2)
Pickup country code.
VehiclePickupRegion
string(50)
State, region, or territory code for the pickup location. Example: NY for New York.
VehicleDropoffTime
datetime (UTC Atom)
Drop-off time with UTC offset.
VehicleDropoffCity
string(50)
Drop-off city.
VehicleDropoffCountry
string(2)
Drop-off country code.
FromLocationName
string
Full geographical pickup location. Comma-separated values in order of increasing specificity; append a colon and IATA code for airports. Example: Paris,Paris Le Bourget Airport:LBG.
ToLocationName
string
Full geographical drop-off location. Same format as FromLocationName.
Group D. Pricing & coverage
Optional
VehicleStdLiabilityHigh
float
Higher standard excess for the vehicle. Use this field if only one excess level is available.
VehicleStdLiabilityLow
float
Lower standard excess. Used to determine cover required. If omitted, CoverAmount is used.
VehicleStdLiabilityCurrency
string(3)
Currency of the vehicle's standard excess.
VehicleNettPrice
float
Wholesale price of the vehicle paid by the online travel agent (OTA).
VehicleRentalGross
float
Retail price of the vehicle.
CoverAmount
float
Amount of cover required.
PolicyPrice
float
Partner-set protection price. If less than the RentalCover price, the partner price is used.
LDWIncluded
boolean [0|1]
Whether Loss Damage Waiver (LDW) is included in the rental. Removes theft from the comparison table in the Content response.
CDWIncluded
boolean [0|1]
Whether Collision Damage Waiver (CDW) is included. Default: 0.
SLIIncluded
boolean [0|1]
Whether Supplementary Liability Insurance (SLI) is included.
Group E. Display & behaviour
Optional
Type
string
Requested protection type. Values: ExcessReduction, CDW, Comprehensive, RoadsideAssistance, FullProtection. Defaults to ExcessReduction and Comprehensive. Use RoadsideAssistance for customers travelling to the US; CDW for US residents travelling elsewhere.
Currency
string(3)
ISO 4217 currency code. If passed, all amounts in the response and in subsequent calls use this currency. See Supported Currencies.
ContactCustomer
boolean [0|1]
Whether RentalCover may contact the customer by email. Default: 1.
ExpressCode
string(50)
Requests a specific product for experiments. Provided by your CSE. Disabled by default.
RoadSideAssistanceCoverOption
boolean [0|1]
Requests a roadside assistance cover option.
Group F. Partner & integration
Optional
PartnerSite
string(50)
Partner subdomain identifier for partners with multiple sites. Format: yoursitecom (no dots).
PartnerCollectingPayment
boolean
Whether the partner is collecting payment.
UserIpAddress
string(20)
End user's IP address.
BWCookie
string
BW Cookie ID.
MetaData
JSON object
Additional user-defined data. Structure is entirely defined by the client.
Last updated
Was this helpful?