Upload
nicolasjmb
View
383
Download
20
Embed Size (px)
Citation preview
8/12/2019 Cartrawler OTA XML
1/92
CarTrawler OTA XML InterfaceVersion: 1.16Date: 15/04/14
http://www.cartrawler.com
http://www.cartrawler.com/http://www.cartrawler.com/8/12/2019 Cartrawler OTA XML
2/92
CarTrawler OTA XML Interface
DO NOT DO BOOKINGS ON CARTRAWLER PRODUCTION SERVER WITHOUTPRIOR PERMISSION
Copyright 2013 CarTrawler. All rights reserved. Page | 2
OTA Version ......................................................................................................................... 5Messages .............................................................................................................................. 5Mandatory fields / Maximum field lengths ........................................................................ 5Example XML messages ..................................................................................................... 6Support ................................................................................................................................. 6Communication to our test Server ..................................................................................... 6Client ID ................................................................................................................................ 6Region Sensitive Searching ............................................................................................... 7
Important Fields ..................................................................................................................... 7Transport .............................................................................................................................. 7Data Compression ............................................................................................................... 7Supported Currencies ......................................................................................................... 8Sample Java Client .............................................................................................................. 9
Command lines arguments for sample java client. .................................................................... 9Multi Language Support .................................................................................................... 10Supported Languages can be found at: .......................................................................... 10Static Files .......................................................................................................................... 11
ctlangauge ........................................................................................................................... 11ctcurrency ............................................................................................................................ 11isocountry............................................................................................................................. 11ctlocation .............................................................................................................................. 12
Example Messages ............................................................................................................ 13OTA_PingRQ ................................................................................................................................ 13
Important Fields ................................................................................................................... 13OTA_VehLocSearchRQ (sample 1) ............................................................................................. 13
Important Fields ................................................................................................................... 13Important Fields ................................................................................................................... 14Important Fields ................................................................................................................... 14
Important Fields ................................................................................................................... 16OTA_VehAvailRateRQ ................................................................................................................. 17Important Fields ................................................................................................................... 17
Note: ConsumerIP .................................................................................................................... 18Header...................................................................................................................................... 18
Important Fields ................................................................................................................... 19VehAvailRSCore element ........................................................................................................ 19
Important Fields ................................................................................................................... 19VehVendorAvails element ........................................................................................................ 19
Pickup Types ....................................................................................................................... 20VehAvail element ..................................................................................................................... 21
Important Fields ................................................................................................................... 22Explanation of Fee Purpose Codes ..................................................................................... 23
Special Offers ...................................................................................................................... 23Important Fields ................................................................................................................... 23Discounted Price Offers ....................................................................................................... 24Important Fields ................................................................................................................... 24Rate Qualifier / Rate Types ................................................................................................. 25Payment Types .................................................................................................................... 25Fuel Policy Information ........................................................................................................ 26
Supported Location Search Values ................................................................................. 34Important Fields ................................................................................................................... 35
Airport IATA Code .................................................................................................................... 36Important Fields ................................................................................................................... 36Important Fields ................................................................................................................... 37Important Fields ................................................................................................................... 38
8/12/2019 Cartrawler OTA XML
3/92
CarTrawler OTA XML Interface
DO NOT DO BOOKINGS ON CARTRAWLER PRODUCTION SERVER WITHOUTPRIOR PERMISSION
Copyright 2013 CarTrawler. All rights reserved. Page | 3
Multiple Search ........................................................................................................................ 39Important Fields ................................................................................................................... 39
Advanced One-way Rental Searching ..................................................................................... 41OTA_VehResRQ ................................................................................................................. 43Important Fields ................................................................................................................. 44Life Span for a quote ......................................................................................................... 45Credit Card required for booking car .............................................................................. 45
PaymentCard CardCode attribute ....................................................................................... 46PaymentCard CardType attribute ........................................................................................ 46Credit Card ExpireDate ........................................................................................................ 46Flight Information at Airports................................................................................................ 46Test Credit Cards on OTATest ............................................................................................ 46
OTA_VehCancelRQ ........................................................................................................... 47Important Fields ................................................................................................................... 48Example responses ............................................................................................................. 49Important Fields ................................................................................................................... 50Example Response .............................................................................................................. 50Important Fields ................................................................................................................... 51
No Excess Insurance Quote ............................................................................................. 52OTA_InsuranceQuoteRQ .................................................................................................. 52
Important Fields ................................................................................................................... 53OTA_InsuranceQuoteRS ............................................................................................................. 54
Important Fields ................................................................................................................... 54Insurance Display ......................................................................................................................... 55
Element Guide ......................................................................................................................... 57Display Only Elements ......................................................................................................... 57
Booking No Excess Insurance ......................................................................................... 58OTA_VehResRQ .......................................................................................................................... 59
Important Fields ................................................................................................................... 60
Cancelling No Excess Insurance ..................................................................................... 61Cartrawler Specific Messages .......................................................................................... 62CT_VehCountrySearchRQ ........................................................................................................... 62
Important Fields ................................................................................................................... 62Example Response .............................................................................................................. 62
CT_VehLocSearchRQ (Pickup locations, Verbose) ..................................................................... 63Important Fields ................................................................................................................... 63Example Response .............................................................................................................. 63
CT_VehLocSearchRQ (Pickup locations, Compact) ...................................................... 65Important Fields ................................................................................................................... 65Example Response .............................................................................................................. 65
CT_VehLocSearchRQ (Return locations, Verbose) ....................................................... 67Important Fields ................................................................................................................... 67
Example Response .............................................................................................................. 67CT_VehLocSearchRQ (Return locations, Compact) .................................................................... 68Important Fields ................................................................................................................... 68Example Response .............................................................................................................. 68
Important Fields................................................................................................................. 69Example Response .............................................................................................................. 70
CT_FleetRQ ........................................................................................................................ 71Important Fields................................................................................................................. 71Exampl e SIPP code returned in OTA_VehAvailRS mess age........................................ 71Example Respons e............................................................................................................ 72Country wide CT_FleetRQ ................................................................................................ 73Important Fields................................................................................................................. 73CT_SpecialOffersRQ ......................................................................................................... 74
8/12/2019 Cartrawler OTA XML
4/92
CarTrawler OTA XML Interface
DO NOT DO BOOKINGS ON CARTRAWLER PRODUCTION SERVER WITHOUTPRIOR PERMISSION
Copyright 2013 CarTrawler. All rights reserved. Page | 4
Feed URL Format ............................................................................................................... 74Example A: ......................................................................................................................... 74Example B: ......................................................................................................................... 74Important ............................................................................................................................ 74Sample Booking ................................................................................................................. 76Use OTA_VehLocSearchRQ to Search for Location ...................................................... 76Important Fields ................................................................................................................. 76
Location Response .................................................................................................................. 76Important Fields ................................................................................................................. 78Vehicle Avail Response .................................................................................................... 80Use OTA_VehResRQ to Make a Reservation .................................................................. 82Important Fields................................................................................................................. 82
Vehicle Reservation Response ................................................................................................ 83Important Fields ................................................................................................................... 84
Requesting Special Equipment ........................................................................................ 85Special Equipment availability ......................................................................................... 85Important Fields................................................................................................................. 86Requesting Special Equipment ........................................................................................ 87Important Fields................................................................................................................. 87Appendix B ......................................................................................................................... 88Common Er ror cond i t ions................................................................................................ 88Appendix C ......................................................................................................................... 91Certification Process ......................................................................................................... 91The typical Certification process will include ................................................................. 91NOTE : ONLY BOOK 1 CAR FOR EACH TEST. ............................................................... 91Booking Prepaid / Partpaid reservation .......................................................................... 92Booking prepaid/partpaid reservation ............................................................................. 92
8/12/2019 Cartrawler OTA XML
5/92
CarTrawler OTA XML Interface
DO NOT DO BOOKINGS ON CARTRAWLER PRODUCTION SERVERWITHOUT PRIOR PERMISSION
Copyright 2013 CarTrawler. All rights reserved. Page | 5
OTA VersionSupported OTA Version: 2009A
MessagesMessages Support;
OTA_PingRQ.xsd
OTA_PingRS.xsd
OTA_VehLocSearchRQ.xsd
OTA_VehLocSearchRS.xsd
OTA_VehLocDetailRQ.xsd
OTA_VehLocDetailRS.xsd
OTA_VehAvailRateRQ.xsd
OTA_VehAvailRateRS.xsd
OTA_VehResRQ.xsd
OTA_VehResRS.xsd
OTA_ErrorRS.xsd
OTA Document containing information about the messages and the OTA Schemascan be found and downloaded from;http://www.opentravel.org
The Messages are stateless. No Session is created.
Mandatory fields / Maximum field lengthsAll incoming messages are validated against the OTA Schemas.This defines mandatory fields, and min/max values of these fields.
One of the most common errors with the OTA Schema is to provide an emptyelement.e.g. the following element would cause a Schema error
but the following would be valid
Typically with the OTA Schemas, passing an empty attribute will be invalid, but theattribute itself will be optional.
A typical error when the XML is invalid could look like:
"Value '' is not facet-valid with respect to pattern '[0-9A-Z]{1
http://www.opentravel.org/http://www.opentravel.org/8/12/2019 Cartrawler OTA XML
6/92
CarTrawler OTA XML Interface
DO NOT DO BOOKINGS ON CARTRAWLER PRODUCTION SERVERWITHOUT PRIOR PERMISSION
Copyright 2013 CarTrawler. All rights reserved. Page | 6
Example XML messagesWe only support a subset of the OTA defined messages.
The XML examples in this document were designed to highlight the important fieldsupon which we rely on.
SupportIf you have any questions or technical problems regarding Cartrawler OTA XMLInterface use the support web page at;
https://partners.cartrawler.com/
Communication to our test ServerIP : otatest.cartrawler.comPort : 20002
The service is available at;http://otatest.cartrawler.com:20002/cartrawlerota
The service is also available over https at;https://otatest.cartrawler.com:20000/cartrawlerota
Client IDEvery message you send the OTA Servers must contain your Client IDThis is passed in every message in the POS element.
The ID with ID_Context CARTRAWLER should contain your client ID.
https://partners.cartrawler.com/https://partners.cartrawler.com/https://partners.cartrawler.com/8/12/2019 Cartrawler OTA XML
7/92
CarTrawler OTA XML Interface
DO NOT DO BOOKINGS ON CARTRAWLER PRODUCTION SERVERWITHOUT PRIOR PERMISSION
Copyright 2013 CarTrawler. All rights reserved. Page | 7
Region Sensitive SearchingThe region and residency of the end user can be passed in all requests within the
first Source element. This enables more accurate content searching.
Example above describes a request from a customer who is a resident in Ireland butis searching from a computer in America.
Imp ortant Fields
ISOCountry ISO 2-digit country code of the customerscountry of residence.
TerminalID ISO 2-digit country code of the customerscurrent location.
TransportAs per OTA Transport Protocol Reference HTTPV1.0, the transport protocol is basedon a simple HTTP POST transaction.
NOTE: Our OTA Server is not implemented as a Web Service. There are noWDSL files.
To accessOn receiving an XML request, the request is processed, and an XML response isreturned.
Data CompressionAll requests to CarTrawler should be gzip compression enabled. If gzip is enabled bythe client we will respond with a gzipped response. Enabling gzip increases the
speed at which messages are transferred and also reduces the bandwidth usage.We would encourage all clients to enable this.
Client IDEvery message you send the OTA Servers must contain your Client IDThis is passed in every message in the POS element.
8/12/2019 Cartrawler OTA XML
8/92
CarTrawler OTA XML Interface
DO NOT DO BOOKINGS ON CARTRAWLER PRODUCTION SERVERWITHOUT PRIOR PERMISSION
Copyright 2013 CarTrawler. All rights reserved. Page | 8
Most messages have a POS section that contains a RequestID tag with an IDelement.This ID code must be generated by Car Trawler and supplied to you for use in
your messages.
Attribute ID for RequestorID element. The unique id code which identifies you(supplied by cartrawler.com).
Optional attribute ISOCurrency inSource Element.
If supplied then all amounts returned inthe response will be converted to thiscurrency.By default all amounts will be returned inthe currency GBP.
Supported Currencies
The list of supported currencies can be found at:https://otageo.cartrawler.com/cartrawlerota/files/static/ctcurrency.xml
Note: The list of supported currencies can change at any time.
https://ota.cartrawler.com/cartrawlerota/files/static/ctcurrency.xmlhttps://ota.cartrawler.com/cartrawlerota/files/static/ctcurrency.xml8/12/2019 Cartrawler OTA XML
9/92
CarTrawler OTA XML Interface
DO NOT DO BOOKINGS ON CARTRAWLER PRODUCTION SERVERWITHOUT PRIOR PERMISSION
Copyright 2013 CarTrawler. All rights reserved. Page | 9
Sample Java ClientA sample Java Client is supplied which can be used to demonstrate the Car Trawler
OTA XML Interface.A compiled version of the client is supplied in the jar fileCartrawlerOTAXMLClient.jar.
Note: It Requires Java 1.5 to run.
Below is a sample command line to run the client.
C:\projects\cartrawlerota\build>java -jar CartrawlerOTAXMLClient.jar--server=http://otatest.cartrawler.com:20002/cartrawlerota--output=output OTA_PingRQ.xml
This client requires you to install the security certificate for Java.
Command lines arguments for sample java client.usage: java Http --server= [--output=] [...]--server= The http or https url of the server to connect too.--output=
A sequence number is appended to fileprefix and the response isoutput to this file. Existing files will be overwritten. Use '-' or nooption if the response should be output to standard output.
A list of input filenames which should be sent to the server. Use '-'or an empty list the input is from standard input.
8/12/2019 Cartrawler OTA XML
10/92
CarTrawler OTA XML Interface
DO NOT DO BOOKINGS ON CARTRAWLER PRODUCTION SERVERWITHOUT PRIOR PERMISSION
Copyright 2013 CarTrawler. All rights reserved. Page | 10
Multi Language Support
Some messages can return data in several languages.The PrimaryLangID attribute is used to specify what language you want theresponse to be in.If the language specified is not supported, the response will be returned in English.If no language is specified, the response will be returned in English.e.g.
All message support the PrimaryLangID attribute.
Supported Languages can be found at:https://otageo.cartrawler.com/cartrawlerota/files/static/ctlanguage.xmle.g.
Language Language Code ExampleEnglish EN PrimaryLangID=EN
French FR PrimaryLangID=FR
Polish PL PrimaryLangID=PL
Italian IT PrimaryLangID=IT
A language code can also be supplied in the format XX-XX.In this case only use the code before the - separator.i.e. The following codes are all valid and will be treated as English;
en English
en-us English (United States)
en-gb English (United Kingdom)
en-au English (Australia)
en-ca English (Canada)
en-nz English (New Zealand)
en-ie English (Ireland) en-za English (South Africa)
en-jm English (Jamaica)
en English (Caribbean)
en-bz English (Belize)
en-tt English (Trinidad)
https://ota.cartrawler.com/cartrawlerota/files/static/ctlanguage.xmlhttps://ota.cartrawler.com/cartrawlerota/files/static/ctlanguage.xml8/12/2019 Cartrawler OTA XML
11/92
CarTrawler OTA XML Interface
DO NOT DO BOOKINGS ON CARTRAWLER PRODUCTION SERVERWITHOUT PRIOR PERMISSION
Copyright 2013 CarTrawler. All rights reserved. Page | 11
Static Files
We provide several static files from the OTA Servers, some of which are available inmultiple languages.
Single Static files.There are only version of these files which include:
ct langauge
https://otageo.cartrawler.com/cartrawlerota/files/static/ctlanguage.xml
Contains list of languages supported.
ctcurrency
https://otageo.cartrawler.com/cartrawlerota/files/static/ctcurrency.xml
Contains list of currencies supported.
Multi lingual Static files.These files are available in all the languages which we support.
i socountry
This provides a list of countries and country codes in our supported languages.e.g.
https://otageo.cartrawler.com/cartrawlerota/files/static/isocountry.EN.xmlhttps://otageo.cartrawler.com/cartrawlerota/files/static/isocountry.PL.xmlhttps://otageo.cartrawler.com/cartrawlerota/files/static/isocountry.ES.xml
Sample xml
IrelandQatar
https://ota.cartrawler.com/cartrawlerota/files/static/ctlanguage.xmlhttps://ota.cartrawler.com/cartrawlerota/files/static/ctcurrency.xmlhttps://ota.cartrawler.com/cartrawlerota/files/static/isocountry.EN.xmlhttps://ota.cartrawler.com/cartrawlerota/files/static/isocountry.PL.xmlhttps://ota.cartrawler.com/cartrawlerota/files/static/isocountry.ES.xmlhttps://ota.cartrawler.com/cartrawlerota/files/static/isocountry.ES.xmlhttps://ota.cartrawler.com/cartrawlerota/files/static/isocountry.PL.xmlhttps://ota.cartrawler.com/cartrawlerota/files/static/isocountry.EN.xmlhttps://ota.cartrawler.com/cartrawlerota/files/static/ctcurrency.xmlhttps://ota.cartrawler.com/cartrawlerota/files/static/ctlanguage.xml8/12/2019 Cartrawler OTA XML
12/92
CarTrawler OTA XML Interface
DO NOT DO BOOKINGS ON CARTRAWLER PRODUCTION SERVERWITHOUT PRIOR PERMISSION
Copyright 2013 CarTrawler. All rights reserved. Page | 12
ct locat ion
This provides a list of all our locations with our Cartrawler location ID and Airport
IATA codes (for airport locations)e.g.https://otageo.cartrawler.com/cartrawlerota/files/static/ctlocation.EN.xmlhttps://otageo.cartrawler.com/cartrawlerota/files/static/ctlocation.FR.xmlhttps://otageo.cartrawler.com/cartrawlerota/files/static/ctlocation.DE.xml
Sample xml
...
otacodetableThis provides a list of ota codes in our supported languages.e.g.https://otageo.cartrawler.com/cartrawlerota/files/static/otacodetable.EN.xmlhttps://otageo.cartrawler.com/cartrawlerota/files/static/otacodetable.FR.xmlhttps://otageo.cartrawler.com/cartrawlerota/files/static/otacodetable.DE.xml
Sample xml
https://ota.cartrawler.com/cartrawlerota/files/static/ctlocation.EN.xmlhttps://ota.cartrawler.com/cartrawlerota/files/static/ctlocation.FR.xmlhttps://ota.cartrawler.com/cartrawlerota/files/static/ctlocation.DE.xmlhttps://ota.cartrawler.com/cartrawlerota/files/static/otacodetable.EN.xmlhttps://ota.cartrawler.com/cartrawlerota/files/static/otacodetable.FR.xmlhttps://ota.cartrawler.com/cartrawlerota/files/static/otacodetable.DE.xmlhttps://ota.cartrawler.com/cartrawlerota/files/static/otacodetable.DE.xmlhttps://ota.cartrawler.com/cartrawlerota/files/static/otacodetable.FR.xmlhttps://ota.cartrawler.com/cartrawlerota/files/static/otacodetable.EN.xmlhttps://ota.cartrawler.com/cartrawlerota/files/static/ctlocation.DE.xmlhttps://ota.cartrawler.com/cartrawlerota/files/static/ctlocation.FR.xmlhttps://ota.cartrawler.com/cartrawlerota/files/static/ctlocation.EN.xml8/12/2019 Cartrawler OTA XML
13/92
CarTrawler OTA XML Interface
DO NOT DO BOOKINGS ON CARTRAWLER PRODUCTION SERVERWITHOUT PRIOR PERMISSION
Copyright 2013 CarTrawler. All rights reserved. Page | 13
Example Messages
OTA_PingRQAre you there
Imp ortant Fields
Attribute Version for OTA_PingRQelement.
This must be 1.003
EchoData element. Contains text which will be returned toyou.
OTA_VehLocSearchRQ (sample 1)
London
Imp ortant Fields
Field Description
Attribute Version for
OTA_VehLocSearchRQ element.
This must be 1.005
Attribute ID for RequestorID element. The unique id code which identifies you(supplied by cartrawler.com).
Attribute Code for CountryNameelement.
The country code you wish search on.
Element CityName. Optional Cityname that can be used tonarrow the Search.
8/12/2019 Cartrawler OTA XML
14/92
CarTrawler OTA XML Interface
DO NOT DO BOOKINGS ON CARTRAWLER PRODUCTION SERVERWITHOUT PRIOR PERMISSION
Copyright 2013 CarTrawler. All rights reserved. Page | 14
OTA_VehLocSearchRQ (sample 2)
LGW
Imp ortant Fields
Field Description
Element RefPoint. This is a IATA airport code. Thesearch will return locations at thespecified airport.
OTA_VehLocSearchRQ (sample 3)
Imp ortant Fields
Field Description
Attribute 'Latitude' and 'Longitude' of'Position' element.
The Latitude and Longitude in decimaldegrees which is used as the centre pointof the location search.
Attribute 'Distance' and'DistanceMeasure' of 'Radius' element.
Return any locations that are within thegiven 'Distance' of centre point. Thesupported units for 'DistanceMeasure'are 'km', 'kilometre', or 'mile'.
Note :It is possible for a Location Search to return a result set that is to large.The OTA specifications will only allow the search to return 100 records.
8/12/2019 Cartrawler OTA XML
15/92
CarTrawler OTA XML Interface
DO NOT DO BOOKINGS ON CARTRAWLER PRODUCTION SERVERWITHOUT PRIOR PERMISSION
Copyright 2013 CarTrawler. All rights reserved. Page | 15
If the search returns more than 100 records, then the error message Search CriteriaInvalid error code 161 will be returned.Use the CT_VehLocSearchRQ if you need to get around the maximum number of
records restriction.
8/12/2019 Cartrawler OTA XML
16/92
CarTrawler OTA XML Interface
DO NOT DO BOOKINGS ON CARTRAWLER PRODUCTION SERVERWITHOUT PRIOR PERMISSION
Copyright 2013 CarTrawler. All rights reserved. Page | 16
OTA_VehLocDetailRQ
Imp ortant Fields
Field DescriptionAttribute Version forOTA_VehLocDetailRQ element.
This must be 1.005
Attribute ID for RequestorID element. The unique id code which identifies you(supplied by cartrawler.com).
Attribute LocationCode for Locationelement.
The unique location code you wish extrainformation about. This is returned in theOTA_VehLocSearshRS message.
8/12/2019 Cartrawler OTA XML
17/92
CarTrawler OTA XML Interface
DO NOT DO BOOKINGS ON CARTRAWLER PRODUCTION SERVERWITHOUT PRIOR PERMISSION
Copyright 2013 CarTrawler. All rights reserved. Page | 17
OTA_VehAvailRateRQ
This message is used to request car availability from a single Location.
182.456.432.123
Imp ortant Fields
Field Description
Attribute Version forOTA_VehAvailRateRQ element.
This must be 1.005
Attribute ISOCurrency for Sourceelement.
The Currency that amounts will bedisplayed in the response.
Attribute ID for RequestorID element. The unique id code which identifies you(supplied by cartrawler.com).
Attribute LocationCode for
PickUpLocation and ReturnLocationelements.
The unique location code you wish
availability returned from. This isreturned in the OTA_VehLocSearchRSmessage.
Attribute PickupDateTime for elementVehRentalCore
The Date & Time you wish to pickup theVehicle
Attribute ReturnDateTime for elementVehRentalCore
The Date & Time you wish to return theVehicle
Attribute Age for DriverType element This is mandatory.You need to supply the drivers age in thisfield.This will affect what cars are available,
8/12/2019 Cartrawler OTA XML
18/92
CarTrawler OTA XML Interface
DO NOT DO BOOKINGS ON CARTRAWLER PRODUCTION SERVERWITHOUT PRIOR PERMISSION
Copyright 2013 CarTrawler. All rights reserved. Page | 18
and the price of the cars.
Attribute PassengerQty forVehAvailRQInfo element.
This is the preferred passenger quantityfor the car based on the number of
passengers. The value should notinclude the driver.
Attribute Code for CitizenCountryNameelement.
This is mandatory.This is the country code for the driverscountry of residence.This is required as different rates may beavailable depending on it.
Element ConsumerIP inTPA_Extensions element.
This is mandatory.This is the IP address of your consumersmachine.
Note: ConsumerIPIt is a mandatory requirement that the consumers IP is included in theOTA_VehAvailRateRQ message. The Consumer IP is required so that our system isprotected from abusive traffic. Failure to include this information will result in an error.
The preferred Size of the car is taken from the OTA Code List table.Examples of ones commonly used are;
Size Description
1 Mini
3 Economy
4 Compact
6 Intermediate
7 Standard
8 Fullsize9 Luxury
10 Premium
11 Minivan
12 12 passenger van
24 Exotic
OTA_VehAvailRateRS overviewAll OTA_VehAvailRateRS have the same format, no matter what flavour of the
request message is used (single, multi, iata).
The message is large. For documentation purposes it is broken down into itscomponent parts.
Header
8/12/2019 Cartrawler OTA XML
19/92
CarTrawler OTA XML Interface
DO NOT DO BOOKINGS ON CARTRAWLER PRODUCTION SERVERWITHOUT PRIOR PERMISSION
Copyright 2013 CarTrawler. All rights reserved. Page | 19
Imp ortant Fields
Field DescriptionSuccess If present, then availability was
successful
VehAvailRSCore element
Imp ortant Fields
Field Description
Attribute PickUpDateTime ofVehRentalCore element
The pickup date & time
Attribute ReturnDateTime ofVehRentalCore element
The return date & time
Attribute LocationCode & Name ofPickupLocation element
The Cartrawler location code andlocation name for the pickup location.
Attribute LocationCode & Name of
ReturnLocation element
The Cartrawler location code and
location name for the return location.
VehVendorAvails element
Dublin Airport Arrivals Hall , Dublin
8/12/2019 Cartrawler OTA XML
20/92
CarTrawler OTA XML Interface
DO NOT DO BOOKINGS ON CARTRAWLER PRODUCTION SERVERWITHOUT PRIOR PERMISSION
Copyright 2013 CarTrawler. All rights reserved. Page | 20
The availability response is broken down by vendor (car supplier).
The response can contain multiple VehVendorAvail elements, one for each vendor.Each VehVendorAvail element contains 3 elements;
Vendor element Contains Cartrawler unique code for thecar vendor.
VehAvails Contains multiple VehAvail elements(which contain available cars).
Info Contains vendor specific locationaddress information.Each vendor at a single location canhave their own unique location address.
For one-way rentals the Info elementwould contain 2 LocationDetailselements. Otherwise only 1 is returned.The code attribute for the LocationDetailelement matches the Cartrawler locationcode for this location.
Pickup Types
Rentals agents can support various location types. The location type of the agent isdetailed in the CounterLocation element.
...
...
The 'Type' could be one of the following:
Type DescriptionVWF_1.VWF.X Terminal Counter And Car
VWF_2.VWF.X Shuttle To Counter And CarVWF_3.VWF.X Terminal Counter Shuttle To Car
VWF_4.VWF.X Meet And Greet
VWF_5.VWF.X Unknown
VWF_6.VWF.X Car And Driver
8/12/2019 Cartrawler OTA XML
21/92
CarTrawler OTA XML Interface
DO NOT DO BOOKINGS ON CARTRAWLER PRODUCTION SERVERWITHOUT PRIOR PERMISSION
Copyright 2013 CarTrawler. All rights reserved. Page | 21
VehAvail elementThis is the heart of the availability message.Each VehAvail element corresponds to an available car.
https://www.cartrawler.com/otaimages/chevrolet/cavalier.jpeg
Ski rack
Infant child seat
Free upgrade from Toyota Yaris to Vauxhall Astra or Similar
8/12/2019 Cartrawler OTA XML
22/92
CarTrawler OTA XML Interface
DO NOT DO BOOKINGS ON CARTRAWLER PRODUCTION SERVERWITHOUT PRIOR PERMISSION
Copyright 2013 CarTrawler. All rights reserved. Page | 22
Imp ortant Fields
Field Description
RateQualifer attribute for RateQualifierelement.
This element & attribute describe whichtype of Rate.This describes the payment type,weather this is prepaid, postpaid orpartpaid.A section below will describe this indetail.
Fee element with a Purpose attribute of22.22 isthe OTA Code for Prepayamount.
This is the estimated deposit fee that willbe taken from the customer if they bookthis vehicle.
Fee element with a Purpose attribute of
23
This is the amount the customer will pay
to the Car Vendor when collecting thevehicle.
Reference field with all attributes. The Reference field uniquely identifiesthe car along with the supplied Rate.Use this value to book the car using theOTA_VehRes message.
OrderByattribute of Configelement This is the orderby idfor the car.Each Car returned as an ordered idassigned to it.We suggest you display the cars in theorder of this number.
Durationattribute of Configelement The duration in days of the rental.This is useful if different pickup andreturn times are used.
Attribute BestPrice of Config element When this attribute is present, then thiscar is flagged as having our lowest priceat this location.This attribute is optional.
Attribute Limited of Config element When this attribute is present, then thiscar is flagged as having low availability.This attribute is optional.
Attribute CC_Infoof Config element When the CC_Infoattribute is true thena credit card will be required to book this
car. When it is false then no credit cardwill be required.
SpecialOffers element This contains a list of Special Offers inOffer elements.The Type attribute is a free textdescription of the type of Special offer.The text in the Offer element istranslated to the requested language.
Fee in TPA Extension element The Fees in the OTA defined Feessection are returned in the currencyrequested in the response.
8/12/2019 Cartrawler OTA XML
23/92
CarTrawler OTA XML Interface
DO NOT DO BOOKINGS ON CARTRAWLER PRODUCTION SERVERWITHOUT PRIOR PERMISSION
Copyright 2013 CarTrawler. All rights reserved. Page | 23
This is the deposit amount 22 in thecurrency which we will charge thecustomers credit card (not the currency
the customer requested).This is only present if we are charging ina different currency to the requestedcurrency.
Rate element of CurrencyExchangeelement.
Linked with the Fee above.This is the currency exhange ratebetween the currency we charge ourdeposit in, and the currency the customerrequested.
Explanat ion o f Fee Purpos e Codes
Purpose Code Description6 Cartrawler Booking Fee
22 Deposit Fee (Amount taken from customer s credit card whenthey confirm the booking, includes Cartrawler Booking Fee).
23 Fee to pay on arrival (Amount customer will pay supplier oncollection of car).
The EstimatedTotalAmount is equal to the RateTotalAmount plus the CartrawlerBooking Fee (Purpose Code 6).The Fees are for information purpose only.They do not need to added to the amounts.
Note: All other fees returned in the XML should be ignored.
Special Offers
Some cars can have Special Offers associated with them.Examples of Special Offers include, free upgrades, free petrol.These cars will contain a SpecialOffers element in the TPA_Extensions element forthe VehAvailCore. Offers are applied to the cars on the CarTrawler side so thiselement is only used for customer display purposes.e.g.
Free additional driver
Imp ortant Fields
Field DescriptionType Fixed string value representing offer type
Text Human readable description of offer
8/12/2019 Cartrawler OTA XML
24/92
CarTrawler OTA XML Interface
DO NOT DO BOOKINGS ON CARTRAWLER PRODUCTION SERVERWITHOUT PRIOR PERMISSION
Copyright 2013 CarTrawler. All rights reserved. Page | 24
Offer Types Description
monetary_discount Used to indicate a discounted price
free_gps
percentage_discount Used to indicate a discounted pricefree_additional_driver
free_fuel
free_days
free_winter_carkit
free_congestion_charge
free_child_seat
free_personal_ainsurance
euro_disney_pass
free_ski_pass
free_upgrade
percentage_discount_gpsfree_wifi
guaranteed_mam
generic_offer
Discounted Price Offers
e.g.
...
Monetary Discount
...
Imp ortant Fields
Field Description
Type Fixed string value representing offer typeDiscount Amount of discount applied, if offer type is percentage_discountthis value is a percentage unit type.
Amount Original Amount of vehicle before discount applied
CurrencyCode Currency value
Text Human readable description of offer
8/12/2019 Cartrawler OTA XML
25/92
CarTrawler OTA XML Interface
DO NOT DO BOOKINGS ON CARTRAWLER PRODUCTION SERVERWITHOUT PRIOR PERMISSION
Copyright 2013 CarTrawler. All rights reserved. Page | 25
Rate Qual i f ier / Rate Types
The RateQualifer element describes the type of Rate associated with the vehicle.This includes the payment type,whether or not the rate is an exclusive or inclusive product,and any promotions associated with the rate.
Example Rate Qualifer
The 'RateQualifer' contains a 'RateQualifier' attribute and a optional
'PromotionCode' attribute.
The 'RateQualifier' could be one of the following:
RateQualifier attribute Description
PREPAID-IN Fully Prepaid, Inclusive product
PREPAID-EX Fully-prepaid, Exclusive product
POSTPAID-IN Fully-postpaid, Inclusive product
POSTPAID-EX Fully-postpaid, Exclusive product
PARTPAID-IN Partpaid (deposit), Inclusive product
PARTPAID-EX Partpaid (deposit), Exclusive product
Payment Types
PREPAID means the full cost is paid up front (though some fees may be paid onarrival).POSTPAID means the full cost is paid when picking up the car (no deposit).PARTPAID means a deposit is paid up front, with the remainder being paid whenpickup up the car.
8/12/2019 Cartrawler OTA XML
26/92
CarTrawler OTA XML Interface
DO NOT DO BOOKINGS ON CARTRAWLER PRODUCTION SERVERWITHOUT PRIOR PERMISSION
Copyright 2013 CarTrawler. All rights reserved. Page | 26
Promot ionCodeThe 'PromotionCode' attribute is optional, and can be one of the follow:
GOLD
PLATINUM DIAMOND
INCLUSIVE_NO_EXCESS
INCLUSIVE_WITH_GPS
It is possible to receive several rates for the same car from the same supplier, if thisis the case they will appear as different VehAvail elements.These cars will have different costs, and have different Rental Conditions.
The list of unique rate types are:
Rate Type RateQualifierattribute PromotionCode attribute
Basic Ends with -EX NoneInclusive Ends with -IN NoneGold Ends with -IN GOLDPlatinum Ends with -IN PLATINUMDiamond Ends with -IN DIAMONDInclusive noexcess
Ends with -IN INCLUSIVE_NO_EXCESS
Inclusive with GPS Ends with -IN INCLUSIVE_WITH_GPS
Note: New Promotion codes might be added in the future.
Fuel Pol icy Inform ation
......
...
When available the fuel policy of the rental will be returned in the TPA_Extensionselement of the VehAvailCore element.
The FuelPolicy could be one of the following:
Type attribute DescriptionFULLFULL Full Return Full
EMPTYEMPTY Empty Return Empty
FULLEMPTY Full Return Empty
HALFEMPTY Half Full Return Empty
QUARTEREMPTY Quarter Full Return Empty
HALFHALF Half Full Return Half Empty
QUARTERQUARTER Quarter Full Return Quarter Full
UNKNOWN See Rental Conditions
8/12/2019 Cartrawler OTA XML
27/92
CarTrawler OTA XML Interface
DO NOT DO BOOKINGS ON CARTRAWLER PRODUCTION SERVERWITHOUT PRIOR PERMISSION
Copyright 2013 CarTrawler. All rights reserved. Page | 27
Credit Card required for booking carSome cars require a Credit Card in order to book them, and some do not.
Each car returned in the availability response has a flag which indicates if this isrequired.
The CC_Info Required attribute is true when a credit cardis required to book thecar, and is false otherwise.
When a credit card is required, the reservation message OTA_VehResRQ mustcontain valid credit card information in a RentalPaymentPref element.
If no credit card is required, the reservation message must contain noRentalPaymentPref element.
A credit card may be required in order to pay for the car (all or part payment),or it may be required to hold the reservation for certain car suppliers.
8/12/2019 Cartrawler OTA XML
28/92
8/12/2019 Cartrawler OTA XML
29/92
CarTrawler OTA XML Interface
DO NOT DO BOOKINGS ON CARTRAWLER PRODUCTION SERVERWITHOUT PRIOR PERMISSION
Copyright 2013 CarTrawler. All rights reserved. Page | 29
VehicleCharge element
The Vehicle charge element has the followings attributes:
Attribute name Mandatory/Optional
Description
Description Mandatory A text description of the Fee (in thelanguage specified in the availabilityrequest).
Amount Optional The cost of this fee.
CurrencyCode Optional The currency of the fee.
Purpose Mandatory A unique code for this Vehicle Charge.We do not document what these codesstand for.
E.g. Unlimited Mileage
...
...
E.g. Limited Mileage
...
...
If mileage information is available it will be returned in the response. When themileage is limited and the limit information is known it will be returned using theRateDistance element.
8/12/2019 Cartrawler OTA XML
30/92
CarTrawler OTA XML Interface
DO NOT DO BOOKINGS ON CARTRAWLER PRODUCTION SERVERWITHOUT PRIOR PERMISSION
Copyright 2013 CarTrawler. All rights reserved. Page | 30
RateDistance element
Attribute name Mandatory/
Optional
Description
DistUnitName Optional Unit for quantity value, supported values:- Km- Mile
Quantity Optional Distance included in limit
Unlimited Mandatory True, False value
VehiclePeriodUnitName Optional Period type unit code, supported values:- Day- Month- RentalPeriod
PricedCoverage elementThe Priced Coverage element has the following attributes:
Attribute name Mandatory/Optional
Description
ChargeDescription
Mandatory A text description of the Fee (in the languagespecified in the availability request).
Charge Amount Optional The cost of this fee.
ChargeCurrencyCode
Optional The currency of the fee.
Coverage
CoverageType
Mandatory A unique code for this Vehicle Charge.
We do not document what these codes stand for.
e.g.
8/12/2019 Cartrawler OTA XML
31/92
CarTrawler OTA XML Interface
DO NOT DO BOOKINGS ON CARTRAWLER PRODUCTION SERVERWITHOUT PRIOR PERMISSION
Copyright 2013 CarTrawler. All rights reserved. Page | 31
Collision Damage Waiver (CDW), CoverageType 6If the excess amount is known for the CDW cover it will be returned in the response.The excess information is returned in the Deductible element of the PricedCoverage.
......
Note: If no excess information is returned it does not imply that the policy has noexcess payable in the event of a claim.
Fee Breakdown Total
Fee Breakdown if available will be include in the VehAvail TPA_Extenstion elementof the OTA_VehAvailRateRS message in the Charge currency for the Vehicle. Thefee breakdown total is a sum of all of the fees that are included in the total rentalprice and those that are available to CarTrawler from the VehicleCharges andPricedCoverage elements.
e.g.
...
...
8/12/2019 Cartrawler OTA XML
32/92
CarTrawler OTA XML Interface
DO NOT DO BOOKINGS ON CARTRAWLER PRODUCTION SERVERWITHOUT PRIOR PERMISSION
Copyright 2013 CarTrawler. All rights reserved. Page | 32
Example 1: Availability for car in Europe, for a European resident.
Vehicle Charges & PricedCoverages
...
...
Fee Breakdown Display
8/12/2019 Cartrawler OTA XML
33/92
CarTrawler OTA XML Interface
DO NOT DO BOOKINGS ON CARTRAWLER PRODUCTION SERVERWITHOUT PRIOR PERMISSION
Copyright 2013 CarTrawler. All rights reserved. Page | 33
Example 2: Availability for car in USA, for a USA resident.
Vehicle Charges & PricedCoverages
Fee Breakdown Display
8/12/2019 Cartrawler OTA XML
34/92
CarTrawler OTA XML Interface
DO NOT DO BOOKINGS ON CARTRAWLER PRODUCTION SERVERWITHOUT PRIOR PERMISSION
Copyright 2013 CarTrawler. All rights reserved. Page | 34
Supported Location Search Values
The OTA_VehAvailRateRQ supports several location search values:
CarTrawler Specific Identifier
Airport IATA Code
GEO Point
Car Agent Identifier
Multiple Search (to be phased out, replaced by GEO Point)
Note: The OTA_VehAvailRate response will include the CarTrawler LocationIdentifier. You must use this identifier when making further request such asOTA_VehRes, CT_RentalConditions, etc...
8/12/2019 Cartrawler OTA XML
35/92
CarTrawler OTA XML Interface
DO NOT DO BOOKINGS ON CARTRAWLER PRODUCTION SERVERWITHOUT PRIOR PERMISSION
Copyright 2013 CarTrawler. All rights reserved. Page | 35
CarTrawler Location Identifier
Full list of supported identifiers is available in the ctlocation.EN.xml feed. This search
type supports one-way rental searching.
...
...
...
Imp ortant Fields
Field Required Description
CodeContext Y CARTRAWLER
PickUpLocation_LocationCode Y CarTrawler Location Identifier
ReturnLocation_LocationCode Y CarTrawler Location Identifier
8/12/2019 Cartrawler OTA XML
36/92
CarTrawler OTA XML Interface
DO NOT DO BOOKINGS ON CARTRAWLER PRODUCTION SERVERWITHOUT PRIOR PERMISSION
Copyright 2013 CarTrawler. All rights reserved. Page | 36
Airport IATA Code
This search type supports one-way rental searching.
...
......
Imp ortant Fields
Field Required Description
CodeContext Y IATA
PickUpLocation_LocationCode Y IATA 3 character airport code
ReturnLocation_LocationCode Y IATA 3 character airport code
8/12/2019 Cartrawler OTA XML
37/92
CarTrawler OTA XML Interface
DO NOT DO BOOKINGS ON CARTRAWLER PRODUCTION SERVERWITHOUT PRIOR PERMISSION
Copyright 2013 CarTrawler. All rights reserved. Page | 37
GEO Point
Given any GEO point this message will return availability for the nearest 10 car rental
agent locations within a 25km radius. The number of returned agents and radiusvalues are subject to change.
...51.4660000,-0.4220000
51.4660000,-0.4220000...
...
Imp ortant Fields
Field Required Description
CodeContext Y GEO
PickUpLocation Y Latitude/Longitude valueFormat: latitude,longitude
ReturnLocation N Latitude/Longitude valueFormat: latitude,longitude
Note:OTA_VehAvailRate message is the only message that supports GEO context.Other messages should use the CARTRAWLER context. The corresponding Codefor the CARTRAWLER context can be found in the LocationDetails elements of theOTA_VehAvailRate response.
OTA_VehAvailRateRS:...
...
Sample, CARTRAWLER context VehRentalCore:
8/12/2019 Cartrawler OTA XML
38/92
CarTrawler OTA XML Interface
DO NOT DO BOOKINGS ON CARTRAWLER PRODUCTION SERVERWITHOUT PRIOR PERMISSION
Copyright 2013 CarTrawler. All rights reserved. Page | 38
Car Agent Identifier
Some car agents publish lists of their location identifier values for use by partner
systems. Our system has partial support for this type of searching. We do not publishcar agent location lists. This search type supports one-way rental searching.
...
...
...
Important Fields
Field Required Description
CodeContext Y CAR_AGENTPickUpLocation_ExtendedLocationCode
Y Two-digit car agent identifier
PickUpLocation_LocationCode Y Car agent specific location code
ReturnLocation_ExtendedLocationCode
Y Two-digit car agent identifier
ReturnLocation_LocationCode Y Car agent specific location code
8/12/2019 Cartrawler OTA XML
39/92
CarTrawler OTA XML Interface
DO NOT DO BOOKINGS ON CARTRAWLER PRODUCTION SERVERWITHOUT PRIOR PERMISSION
Copyright 2013 CarTrawler. All rights reserved. Page | 39
Multiple Search(To b e phased o ut, replaced by GEO Point)
Given a comma-separated list of CarTrawler Location Identifiers this message willreturn availability first 10 successful locations. This message is limited to return amax of 2 airport locations. The number of successful locations and airport values aresubject to change. This message does not support search for one-way rentals, anyreturn location values passed are ignored.
...1,11,13,211,11,13,21
...
...
Imp ortant FieldsField Required Description
CodeContext Y CARTRAWLER_MULTI
PickUpLocation Y Comma-separated list ofCarTrawler Identifiers
ReturnLocation N Comma-separated list ofCarTrawler Identifiers
Note: This location search option must be requested from your CarTrawler AccountManager. As this message is deprecated permission will only be issued where all
other options have been exhausted.
8/12/2019 Cartrawler OTA XML
40/92
CarTrawler OTA XML Interface
DO NOT DO BOOKINGS ON CARTRAWLER PRODUCTION SERVERWITHOUT PRIOR PERMISSION
Copyright 2013 CarTrawler. All rights reserved. Page | 40
Mixing Location CodeContext Types
The previous examples detailed how to perform searches with the same search
CodeContext. CarTrawler supports mixed CodeContext requests when searching forcar rental.
For example, to perform a search for pickup at Dublin Airport to return in Dublin City(51.4660000,-0.4220000) you can set the pickup location using the IATA CodeContextand the return location to be a particular GEO point.
...51.4660000,-0.4220000
...
...
Note: Mixed CodeContexts are only supported by the OTA_VehAvailRateRQmessage. All other messages do not support mixed CodeContexts.
It is possible to mix any supported CodeContext:
IATA
CARTRAWLER
GEO
CAR_AGENT
http://www.opentravel.org/OTA/2003/05%20OTA_VehAvailRateRQ.xsdhttp://www.opentravel.org/OTA/2003/05%20OTA_VehAvailRateRQ.xsdhttp://www.opentravel.org/OTA/2003/05%20OTA_VehAvailRateRQ.xsd8/12/2019 Cartrawler OTA XML
41/92
CarTrawler OTA XML Interface
DO NOT DO BOOKINGS ON CARTRAWLER PRODUCTION SERVERWITHOUT PRIOR PERMISSION
Copyright 2013 CarTrawler. All rights reserved. Page | 41
Advanced One-way Rental Searching
A one-way rental is where the pickup and return locations for the vehicle aredifferent.
CarTrawler supports one-way rental bookings. Support for one-ways isstraightforward when dealing with 1-to-1 locations, such as Dublin Airport to CorkAirport.
Example:...
...
...
When doing Many-to-Many one-way searches, such as, get all cars for pickup inDublin City (51.4660000,-0.4220000) for return in Cork City (51.84900000,-8.47400000).
To achieve this search an additional parameter, OneWayIndicatoris added to therequest.
Example:...51.4660000,-0.422000051.84900000,-8.47400000
...
...
If this message was issued without the OneWayIndicatorset as truethen therequest would not be interpreted as a one-way and the response would contain carsfor pickup and return Dublin City.
Note: 1-to-1 one-way searches do not require the OneWayIndicator to be set.
8/12/2019 Cartrawler OTA XML
42/92
CarTrawler OTA XML Interface
DO NOT DO BOOKINGS ON CARTRAWLER PRODUCTION SERVERWITHOUT PRIOR PERMISSION
Copyright 2013 CarTrawler. All rights reserved. Page | 42
8/12/2019 Cartrawler OTA XML
43/92
CarTrawler OTA XML Interface
DO NOT DO BOOKINGS ON CARTRAWLER PRODUCTION SERVERWITHOUT PRIOR PERMISSION
Copyright 2013 CarTrawler. All rights reserved. Page | 43
OTA_VehResRQThis message is used to book a car based on a car availability response.
Mr.JoeBailey
123 Elm St., Oklahoma City, 73112,
Oklahoma
EI
Joe Bailey Jr
Cartrawler Ltd
8/12/2019 Cartrawler OTA XML
44/92
CarTrawler OTA XML Interface
DO NOT DO BOOKINGS ON CARTRAWLER PRODUCTION SERVERWITHOUT PRIOR PERMISSION
Copyright 2013 CarTrawler. All rights reserved. Page | 44
Important Fields
Field Description
Attribute Version for OTA_VehResRQ
element.
This must be 1.005
Attribute ISOCurrency for Sourceelement.
The Currency that amounts will bedisplayed in the response.
Attribute ID for RequestorID element.(ID_Context of CARTRAWLER)
The unique id code which identifies you(supplied by cartrawler.com).
Attribute ID for RequestorID element.(ID_Context of ORDERID)
This is an optional code which is yourunique identifier for this reservation.This is required for invoice purposes, butis optional.
Attribute LocationCode forPickUpLocation and ReturnLocation
elements.
The unique location code you wish extrainformation about. This is returned in the
OTA_VehLocSearshRS message.Attribute PickupDateTime for elementVehRentalCore
The Date & Time you wish to pickup theVehicle
Attribute ReturnDateTime for elementVehRentalCore
The Date & Time you wish to return theVehicle
ArrivalDetails element &OperatingCompany element
Contains Airline code and Flight numberwhen reservation is for an Airport.This is optional, but should always beincluded for airport locations.Attribute TransportationCode mustalways be 14.Attribute Number is the Flight number.
Element OperatingCompany shouldcontain 2 letter Airline code.
Attribute Code for elementCitizenCountryName
The country code of the customerscountry of residence.Must be identical to country ofresidence used in OTA_VehAvailRQmessage.
Attribute Age for DriverType element You need to supply the drivers age in thisfield.This will affect what cars are available,and the price of the cars.Must be identical to drivers age used
in OTA_VehAvailRQ message.Reference element (including allattributes)
This uniquely identifies the car and itsrate. This element is returned exactly asit was received from theOTA_VehAvailRateRs message.
CompanyName element. This is the Company Name associatedwith this Reservation.This is required for invoice purposes.This is optional.
Attribute VAT for CompanyNameelement
This can be used for the VAT number.This is required for invoice purposes.
8/12/2019 Cartrawler OTA XML
45/92
CarTrawler OTA XML Interface
DO NOT DO BOOKINGS ON CARTRAWLER PRODUCTION SERVERWITHOUT PRIOR PERMISSION
Copyright 2013 CarTrawler. All rights reserved. Page | 45
This is optional.
NOTE: The drivers Age and the Country of Residencemust be identical to the values passed in theavailability message (OTA_VehAvailRQ).If they are different, then the OTA_VehResRQmessage will fail.
Life Span for a quote
The Reference element is only valid for a period time after it is created. Once the Reference element has expired it will not be possible to use it to book a
car.If you attempt to book a car using a Reference which has expired, you will see theerror message Booking reference not found.When you see this, you will need to do a fresh availability.
Credit Card required for booking car
The RentalPaymentPref which contain Credit card information should only besupplied if the car being booked requires a Credit Card..Each car returned in the availability response has a flag which indicates Credit cardis required to make the booking.
8/12/2019 Cartrawler OTA XML
46/92
CarTrawler OTA XML Interface
DO NOT DO BOOKINGS ON CARTRAWLER PRODUCTION SERVERWITHOUT PRIOR PERMISSION
Copyright 2013 CarTrawler. All rights reserved. Page | 46
PaymentCard CardCode attribute
Field Description
VI VisaMC Mastercard
PaymentCard CardType attribute
Field Description1 Credit
2 Debit
3 Central bill
We currently support PaymentCard CardType 1, Credit.
Credit Card Expir eDate
The format of the ExpireDate attribute should be "MMYY".e.g. an expiry date of Jan 2015 would look like "0115".
Flight Inform ation at Airports
If the location is an Airport location, it is advisable to provide Flight Information suchas the airline code and the flight number.This can be provided using the ArrivalDetails element.
e.g. Customer renting car at airport arriving on flight EI 123.
EI
Attribute TransportationCode must always be 14.Attribute Number is the Flight number.Element OperatingCompany should contain a 2 letter Airline code.
If the customer is renting a car at an Airport, but is not arriving by a flight, you shouldstill provide an empty ArrivalDetails element.
e.g. Customer renting car at airport not arriving by flight.
Z9
Test Credit Cards on OTATest
These test credit cards can be used on the Cartrawler Test system to makereservations;
Type Number
Visa 4263971921001307
MasterCard 5425232820001308
You will also need to provide a 3 digit SeriesCode and a valid expiry date.
8/12/2019 Cartrawler OTA XML
47/92
CarTrawler OTA XML Interface
DO NOT DO BOOKINGS ON CARTRAWLER PRODUCTION SERVERWITHOUT PRIOR PERMISSION
Copyright 2013 CarTrawler. All rights reserved. Page | 47
OTA_VehCancelRQ
This message will cancel a Reservation.The cancel can fail, depending on the state of the reservation.If the cancel is successful, it also may issue a refund to the customer.If Cartrawler has not taken the payment, then it will not issue a refund.The refund it issues can be a partial or a full refund.In the event of it being a partial refund (the default), it will refund (amount of moneytaken from the customer)(your cancellation fee).Your cancellation fee is a configurable amount that is associated with your POS ID.
Mr.JoeBailey
8/12/2019 Cartrawler OTA XML
48/92
CarTrawler OTA XML Interface
DO NOT DO BOOKINGS ON CARTRAWLER PRODUCTION SERVERWITHOUT PRIOR PERMISSION
Copyright 2013 CarTrawler. All rights reserved. Page | 48
Important Fields
Attribute Version for
OTA_VehCancelRQ element.
This must be 1.007
Attribute ID for RequestorID element. The unique id code which identifies you(supplied by cartrawler.com).
Attribute ID for UniqueID element. This is the reservation ID returned to youin the OTA_VehResRS message.
PersonName element This contains the personal detailinformation about the customer whomade the initial Reservation.This must match the PersonNamefrom the original reservation or theCancel will fail.
RentalInfo element This contains the pickup date/time and
return date/time of your originalreservation. It also contains the pickupand dropoff location of your originalreservation.This must match the details ofVehRentalCore from the originalreservation or the Cancel will fail.
Refund element in TPA_Extensionselement.
This is an optional parameter.If it is included in the message with anattribute of type = FULL, then a fullrefund will be given to the passenger.Otherwise only a partial refund will begiven.The value of the partial refund will be theamount the customer has been charged,minus your cancel charge.
8/12/2019 Cartrawler OTA XML
49/92
CarTrawler OTA XML Interface
DO NOT DO BOOKINGS ON CARTRAWLER PRODUCTION SERVERWITHOUT PRIOR PERMISSION
Copyright 2013 CarTrawler. All rights reserved. Page | 49
Example respons es
8/12/2019 Cartrawler OTA XML
50/92
CarTrawler OTA XML Interface
DO NOT DO BOOKINGS ON CARTRAWLER PRODUCTION SERVERWITHOUT PRIOR PERMISSION
Copyright 2013 CarTrawler. All rights reserved. Page | 50
OTA_VehRetResRQ
Imp ortant Fields
Field DescriptionAttribute Version forOTA_VehRetResRQ element.
This must be 1.002
Attribute ID for RequestorID element. The unique id code which identifies you(supplied by cartrawler.com).
Attribute ID for UniqueID element This is the reservation ID returned to youin the OTA_VehResRS message.
Optional attribute ID_Context forUniqueID element. To be used only ifyou are looking up the reservation basedon the OrderId recorded at booking time.
ID_Context=ORDERID
Example ResponseJohnSmith
VendorName
Confirmed
8/12/2019 Cartrawler OTA XML
51/92
CarTrawler OTA XML Interface
DO NOT DO BOOKINGS ON CARTRAWLER PRODUCTION SERVERWITHOUT PRIOR PERMISSION
Copyright 2013 CarTrawler. All rights reserved. Page | 51
ARRIVALS HALL, DUBLINARRIVALS HALL, DUBLIN
Imp ortant Fields
Field DescriptionAttribute ID for ConfId elementID_Context=CARTRAWLER
Contains the car rental vendorconfirmation number (for a confirmedreservation)
Attribute ID for ConfId elementID_Context=RESID
Contains the CarTrawler reservation id(for a confirmed reservation)
VehRentalCore element. Contains the pickup date/time/location idand return date/time/location id.
Status attribute of VehReservationelement &TPA_Extensions/Status element.
Contains status of Reservation. Thiscould be one of the following;
Confirmed
Unconfirmed
Cancelled
LocationsDetails with attributeCodeContext of Pickup Location
Location address of the pickup location.
LocationsDetails with attributeCodeContext of Return Location
Location address of the return location.
8/12/2019 Cartrawler OTA XML
52/92
CarTrawler OTA XML Interface
DO NOT DO BOOKINGS ON CARTRAWLER PRODUCTION SERVERWITHOUT PRIOR PERMISSION
Copyright 2013 CarTrawler. All rights reserved. Page | 52
No Excess Insurance Quote
This message is used to obtain a quote for the No ExcessInsurance product.An Insurance Quote needs to be requested after every availability request, as thequotes availability can change depending on the nationality of the driver, cost of theRental & duration of the Rental.
OTA_InsuranceQuoteRQ
JohnSmith
NO
NOTE:You should only change the fields highlighted in bold red.All other fields should remain unchanged.
8/12/2019 Cartrawler OTA XML
53/92
CarTrawler OTA XML Interface
DO NOT DO BOOKINGS ON CARTRAWLER PRODUCTION SERVERWITHOUT PRIOR PERMISSION
Copyright 2013 CarTrawler. All rights reserved. Page | 53
Imp ortant Fields
Attribute ISOCurrency for Source
element.
The Currency that amounts will be
displayed in the response.Attribute ID for RequestorID element. The unique id code which identifies you
(supplied by cartrawler.com).
Elements GivenName and Surname Contains the name of the customer whichis looking for the Insurance Quote.
Attribute Code of CitizenCountryNameelement.
Contains the country code for thecustomers country of Residence.The Insurance offers are based on theCountry of Residence, and thedestination country, so this information isvery important.
Attributes Amount and CurrencyCode
for TotalTripCost element.
Contains the cost of the trip, for which
Insurance is being looked for.Attributes Start and End forCoveredTrip element.
Contains the arrival date/time and thedeparture date/time for the trip.
Element CountryName Contains the destination country codewhere the car rental will take place. TheInsurance offers are based on theCountry of Residence, and thedestination country, so this information isvery important.
8/12/2019 Cartrawler OTA XML
54/92
CarTrawler OTA XML Interface
DO NOT DO BOOKINGS ON CARTRAWLER PRODUCTION SERVERWITHOUT PRIOR PERMISSION
Copyright 2013 CarTrawler. All rights reserved. Page | 54
OTA_InsuranceQuoteRS
http://193.58.9.9/CTW/IE/EN/CTW_IE_en_TCs.pdf
Imp ortant Fields
Attribute PlanID for PlanForQuoteRSelement.
This is code for the Insurance productbeing offered.This is required in order to book theInsurance product.
Attribute Name for PlanForQuoteRSelement.
The title of the Insurance product beingoffered.
Elements QuoteDetailURL . Insurance Product URL containing theterms and conditions.
Attributes Amount and CurrencyCodeof BasePremium element.
Price of the Insurance product in thecurrency which the customer will becharged in.
Attributes Amount and CurrencyCodeof PlanCost element.
Price of the Insurance product in therequested currency.
Success element. This indicates that the Insurance Quotemessage was successful.
Data element. Used to return some interface renderingcode. See Insurance Displaysection ofdocumentation.
8/12/2019 Cartrawler OTA XML
55/92
CarTrawler OTA XML Interface
DO NOT DO BOOKINGS ON CARTRAWLER PRODUCTION SERVERWITHOUT PRIOR PERMISSION
Copyright 2013 CarTrawler. All rights reserved. Page | 55
Insurance Display
The insurance display requirements differ depending on the market where the
insurance is offered. These requirements and business logic make maintaininginsurance offerings difficult and time consuming.
Sample UK Resident Insurance Display
Sample US Resident Insurance Display
To simplify the integration of the various insurance offers we have added someelements that can be used to dynamically build an insurance display. Using thesedisplay rules will ensure that your site confirms to the insurance offer requirementsand remains up to date with best practice for insurance offerings. All of theinformation required for each display is returned via the OTA_InsuranceQuoteRQXML call.
It is important to note that any code using these display rules should be built tohandle the Elements in any sequence. It is also important that the Elements are
8/12/2019 Cartrawler OTA XML
56/92
CarTrawler OTA XML Interface
DO NOT DO BOOKINGS ON CARTRAWLER PRODUCTION SERVERWITHOUT PRIOR PERMISSION
Copyright 2013 CarTrawler. All rights reserved. Page | 56
displayed in order according to their OrderID values. Elements order and values maybe removed or added over time so any code using these rules should be flexible.
Below is a sample of the Elements that are returned.
...
regulated by De Nederlandsche Bank (DNB)]]>
Typical Rendering of Display Data
8/12/2019 Cartrawler OTA XML
57/92
CarTrawler OTA XML Interface
DO NOT DO BOOKINGS ON CARTRAWLER PRODUCTION SERVERWITHOUT PRIOR PERMISSION
Copyright 2013 CarTrawler. All rights reserved. Page | 57
Element Guide
Every UI Element will have an OrderID, this represents the order that the elementsmust be given when rendering to the screen.
Display Only Elements
Title
Image
Paragraph
List
Example:
Comp lex Elements
LinksSo that hyperlinks can be formatted correctly they have been extracted from thecontent of other elements. All UI element text values should be searched & replacedbased on the link code values. There can be multiple Link elements per response.
Example:
From the example above: Test of code ${link1}would be rendered as:
Test of code click here
Functional - OptionInsurance is an additional product that the customer must choose to purchase. Insome markets this can be an opt-in or partial opt-in product. Some markets requirethis selection to be a Radiobutton while others require a CheckBox.
Example:
8/12/2019 Cartrawler OTA XML
58/92
CarTrawler OTA XML Interface
DO NOT DO BOOKINGS ON CARTRAWLER PRODUCTION SERVERWITHOUT PRIOR PERMISSION
Copyright 2013 CarTrawler. All rights reserved. Page | 58
The Option element can have a Type of RADIO or CHECKBOX. Radioboxes shouldbe considered a toggle option. If multiple checkboxes are returned then all should bedisplayed. The Enabled attribute indicates the option default value. The user should
notbe allowed to book insurance unless they have selected the correct option. Forradiobuttons this is indicated by having a selected true option. For checkboxes this isindicated when all checkboxes are ticked.
SelectSome markets, currently AU, NZ and US require some additional information toprovide an accurate insurance offer. In these cases the information is collected usinga Select control. This allows the implementation and UI to be flexible. TheSelectContol data should be rendered using a HTML Select control. Onchange of theHTML Select control by the customer a new OTA_InsuranceQuoteRQ should be sentto ensure an accurate offering.
Example:
Example:
Book ing No Excess Insurance
No Excess Insurance is booked as part of the Car Reservation message.
For the purpose of this document, we will only document the extra elements in theOTA_VehResRQmessage required for booking Insurance
8/12/2019 Cartrawler OTA XML
59/92
CarTrawler OTA XML Interface
DO NOT DO BOOKINGS ON CARTRAWLER PRODUCTION SERVERWITHOUT PRIOR PERMISSION
Copyright 2013 CarTrawler. All rights reserved. Page | 59
OTA_VehResRQ
This message is used to book a car based on a car availability response.
Mr.JoeBailey
123 Elm St., Oklahoma City, 73112,
Oklahoma
EI
Joe Bailey Jr
8/12/2019 Cartrawler OTA XML
60/92
CarTrawler OTA XML Interface
DO NOT DO BOOKINGS ON CARTRAWLER PRODUCTION SERVERWITHOUT PRIOR PERMISSION
Copyright 2013 CarTrawler. All rights reserved. Page | 60
Imp ortant Fields
Field DescriptionAttribute Typeof
TPA_Extensions/Reference element
Must be 16
Attribute IDofTPA_Extensions/Reference element
This is the code for the Insurance productas returned from theOTA_InsuranceQuoteRS message.It is found in the attribute PlanID forPlanForQuoteRS element.
Attribute ID_ContextofTPA_Extensions/Reference element
Must be INSURANCE
Attribute AmountofTPA_Extensions/Reference element
This is the Amount attribute taken fromthe BasePremium element returned inthe OTA_InsuranceQuoteRS message.
Attribute CurrencyCodeofTPA_Extensions/Reference element This is the CurrencyCode attribute takenfrom the BasePremium elementreturned in the OTA_InsuranceQuoteRSmessage.
Attribute URLofTPA_Extensions/Reference element
This is the URL containing the terms &conditions of the insurance product,It is found in the QuoteDetailURL element of the OTA_InsuranceQuoteRSmessage..
The Insurance Quote below shows all the fields that are used to generate the
Insurance Reference for the booking message.http://193.58.223.118/CTW/IE/EN/CTW_IE_en_TCs.pdf
8/12/2019 Cartrawler OTA XML
61/92
CarTrawler OTA XML Interface
DO NOT DO BOOKINGS ON CARTRAWLER PRODUCTION SERVERWITHOUT PRIOR PERMISSION
Copyright 2013 CarTrawler. All rights reserved. Page | 61
Cancell ing No Excess Insurance
There is no message to cancel the No Excess Insurance product.
If a Reservation has No Excess Insurance associated with it (because it wasrequested at reservation time),then it will be cancelled automatically when the Reservation gets cancelled.
8/12/2019 Cartrawler OTA XML
62/92
CarTrawler OTA XML Interface
DO NOT DO BOOKINGS ON CARTRAWLER PRODUCTION SERVERWITHOUT PRIOR PERMISSION
Copyright 2013 CarTrawler. All rights reserved. Page | 62
Cartrawler Specific Messages
CT_VehCountrySearchRQThis is a non OTA standard message used by Cartrawler to retrieve all the countrycodes where we have locations.Because it is non OTA standard we can ignore the OTA restriction of the maximumnumber of records returned.
Imp ortant Fields
Field Description
Attribute Version forCT_VehLocSearchRQ element.
This must be 1.001
Attribute ID for RequestorIDelement. The unique id code which identifies you(supplied by cartrawler.com).
Example Respo nse
AlbaniaAndorraYemenZimbabwe
8/12/2019 Cartrawler OTA XML
63/92
8/12/2019 Cartrawler OTA XML
64/92
CarTrawler OTA XML Interface
DO NOT DO BOOKINGS ON CARTRAWLER PRODUCTION SERVERWITHOUT PRIOR PERMISSION
Copyright 2013 CarTrawler. All rights reserved. Page | 64
.
96 - 102 Great Victoria Street,, Belfast, BT2 7BE,
Belfast,
.
The element PopularVehMatchedLocs returns a list of the popular locations in the
country.The element VehMatchedLocs returns the complete list of locations in the country.It returns locations in a similar xml structure as defined in the OTA_VehLocSearchRSmessage.
8/12/2019 Cartrawler OTA XML
65/92
CarTrawler OTA XML Interface
DO NOT DO BOOKINGS ON CARTRAWLER PRODUCTION SERVERWITHOUT PRIOR PERMISSION
Copyright 2013 CarTrawler. All rights reserved. Page | 65
CT_VehLocSearchRQ (Pickup locations, Compact)
This is similar to the example above, except the response is more compact.
Imp ortant Fields
Field DescriptionAttribute Version forCT_VehLocSearchRQ element.
This must be 1.000
Attribute ID for RequestorID element. The unique id code which identifies you(supplied by cartrawler.com).
Attribute CompactResponse forVehLocSearchCriterion element.
When this attribute is true the responseis compact and smaller.
Attribute Code for CountryName
element.
The country code you wish search on.
Example Respo nse
]]>
8/12/2019 Cartrawler OTA XML
66/92
8/12/2019 Cartrawler OTA XML
67/92
CarTrawler OTA XML Interface
DO NOT DO BOOKINGS ON CARTRAWLER PRODUCTION SERVERWITHOUT PRIOR PERMISSION
Copyright 2013 CarTrawler. All rights reserved. Page | 67
CT_VehLocSearchRQ (Return locations, Verbose)
This is a non OTA standard message used by Cartrawler to retrieve the valid return
locations for a supplied pickup location.Because it is non OTA standard we can ignore the OTA restriction of the maximumnumber of records returned.
Imp ortant Fie lds
Field DescriptionAttribute Version forCT_VehLocSearchRQ element.
This must be 1.000
Attribute ID for RequestorID element. The unique id code which identifies you(supplied by cartrawler.com).
Attribute ID for PickupLocationelement.
The pickup location ID
Example Respon se
.
8/12/2019 Cartrawler OTA XML
68/92
CarTrawler OTA XML Interface
DO NOT DO BOOKINGS ON CARTRAWLER PRODUCTION SERVERWITHOUT PRIOR PERMISSION
Copyright 2013 CarTrawler. All rights reserved. Page | 68
CT_VehLocSearchRQ (Return locations, Compact)
This is similar to the example above, except the response is more compact.
Imp ortant Fie ldsField DescriptionAttribute Version forCT_VehLocSearchRQ element.
This must be 1.000
Attribute ID for RequestorID element. The unique id code which identifies you(supplied by cartrawler.com).
Attribute CompactResponse forVehLocSearchCriterion element.
When this attribute is true the responseis compact and smaller.
Attribute ID for PickupLocationelement.
The pickup location ID
Example Respo nse
.29536=Wexford Downtown
31892=Dublin - South Circular Road]]>
The response is much smaller than the full XML response.The Locations CDATA section contain name/value pairs, each location separated bya carriage return.Each line in the Locations CDATA section contains a location Id, and a locationname. E.g. 11=Dublin Airport11 is the location idDublin Airport is the location name.
8/12/2019 Cartrawler OTA XML
69/92
CarTrawler OTA XML Interface
DO NOT DO BOOKINGS ON CARTRAWLER PRODUCTION SERVERWITHOUT PRIOR PERMISSION
Copyright 2013 CarTrawler. All rights reserved. Page | 69
CT_RentalConditionsRQThis is similar to a OTA_VehResRQ message used to book a car.
Imp ortant Fie lds
Field DescriptionAttribute Version forOTA_VehLocSearchRQ element.
This must be 1.000
Attribute ID for RequestorID element. The unique id code which identifies you(supplied by cartrawler.com).
Attribute LocationCode forPickUpLocation and ReturnLocationelements.
The unique location code you wish extrainformation about. This is returned in theOTA_VehLocSearshRS message.
Attribute PickupDateTime for elementVehRentalCore
The Date & Time you wish to pickup theVehicle
Attribute ReturnDateTime for element
VehRentalCore
The Date & Time you wish to return the
VehicleAttribute Code for elementCitizenCountryName
The country code of the customerscountry of residence.
Reference element (including allattributes)
This uniquely identifies the car and itsrate. This element is returned exactly asit was received from theOTA_VehAvailRateRS message.
8/12/2019 Cartrawler OTA XML
70/92
CarTrawler OTA XML Interface
DO NOT DO BOOKINGS ON CARTRAWLER PRODUCTION SERVERWITHOUT PRIOR PERMISSION
Copyright 2013 CarTrawler. All rights reserved. Page | 70
Example Respo nse
No Charge Age: 25 to 65 Years
Young Drivers Age: Minimum 23 Years Charge 20 EUR
Includes 21% TaxYounger Drivers Age: Minimum 21 Years Charge 10 EUR per
Month Includes 21% TaxSenior Drivers Age: Maximum 75 Years Charge 20 EUR
Includes 21% Tax
Drivers must hold a full license for 2 years with no
endorsements.
Maximum additional drivers 5. Charge per additional driver:
10 EUR Excludes Tax; Excess Amount 123 EUR; On RequestNo additional drivers charge for One Additional
Driver.
Third party insurance: Included In Rate
Collision damage insurance: Included In Rate; Excess
Amount 1,000 EUR
Included In Rate
Pickup Full, Return Full
21%
American Express, VISA
8/12/2019 Cartrawler OTA XML
71/92
CarTrawler OTA XML Interface
DO NOT DO BOOKINGS ON CARTRAWLER PRODUCTION SERVERWITHOUT PRIOR PERMISSION
Copyright 2013 CarTrawler. All rights reserved. Page | 71
CT_FleetRQ
This message is used to return Vehicle Details about a specific car,
or all the cars in a country.
Single Car CT_FleetRQ
This form of the message is designed to return information about 1 car type in acountry, identified by a SIPP code.The SIPP code can be obtained from the OTA_VehAvailRS message.
Imp ortant Fie lds
Field DescriptionAttribute Version forOTA_VehLocSearchRQ element.
This must be 1.000
Attribute ID for RequestorID element. The unique id code which identifies you(supplied by cartrawler.com).
Attribute Code for Country element. The country Code in which the car issituated
Attribute Code for element FleetGroup The SIPP code of the car in which youare interested.This Code is returned in theOTA_VehAvailRS message, as the
Code attribute of the VehMakeModelelement.
Example SIPP cod e returned in OTA_VehAvai lRS message
8/12/2019 Cartrawler OTA XML
72/92
CarTrawler OTA XML Interface
DO NOT DO BOOKINGS ON CARTRAWLER PRODUCTION SERVERWITHOUT PRIOR PERMISSION
Copyright 2013 CarTrawler. All rights reserved. Page | 72
Example Respon se
https://www.cartrawler.com/otaimages/ford/fiesta_nologo.jpg
Renault Clio 5dr or similar
Fiat Punto 5dr or similar
Toyota Yaris 5dr or similar
Opel Corsa 5dr or similarSuzuki Alto 4dr or similar
Peugeot 206 5dr or similar
Volkswagen Polo 5dr or similar
Citroen C3 5dr or similar
With room for 5 passengers and 3 pieces of luggage, this
model is perfect for small families or groups.
8/12/2019 Cartrawler OTA XML
73/92
CarTrawler OTA XML Interface
DO NOT DO BOOKINGS ON CARTRAWLER PRODUCTION SERVERWITHOUT PRIOR PERMISSION
Copyright 2013 CarTrawler. All rights reserved. Page | 73
Country wide CT_FleetRQ
This form of the message is designed to return information about all cars available in
a country.
Imp ortant Fie lds
Field DescriptionAttribute Version forOTA_VehLocSearchRQ element.
This must be 1.000
Attribute ID for RequestorID element. The unique id code which identifies you(supplied by cartrawler.com).
Attribute Code for Country element. The country Code in which