Travel Rankings Documentation

Definition of terms

The screenshot below illustrates the difference between the terms "rank" and "position".

Request Details

Method: HTTPS POST
The URL will be exactly what you have specified as your callback URL with no modifications.

Request Body

This represents one full search results page.

Format and example payloads

Payload Example

Parameters

Element	Description	Example	Always present?
UUID	Universal unique ID	abcdefg-hijk-123
partner_quote_id	This is an identifier that links the TR result to the API call response we received from the partner. This identifier is taken from the API response.	1232354234123-123123
session_created_on	The UNIX timestamp of the user's search.  Seconds since the epoch	1486609891
currency	3-letter currency code denoting the currency of the prices and margins that we eventually convert to. Currency chosen by the partner.	GBP
places	Information of Departure/Arrival place
places[0]	A single entry of a place
places[0].name	Name of place departing/arriving from	Palermo
places[0].place_id	Unique number that maps to route_data.search.from or route_data.search.to	15439
places[0].display_code	3-letter airport code	PMO
route_date	Information at the route date level
route_date.search	2-letter ISO code denoting the country that these prices were found in	GB
route_date.search.market	Information at the route date level
route_date.search.currency	3-letter currency code denoting which currency the prices were searched in. This is dependent on the user search that prompted the gathering of these prices	GBP
route_date.search.locale	Denotes the language preference of the user who was viewing the site at the time that these prices were generated. Usually has no relationship to the prices themselves. Occasionally we have some suppliers who will only be shown for a subset of languages. These cases are rare exceptions.	en-GB
route_date.search.from	The origin place id of the outbound leg, i.e. the departure point of the journey – the IATA code for this place can be looked up in the “places” object	LHR
route_date.search.to	The destination place id of the outbound leg, i.e. the arrival point of the journey – the IATA code for this place can be looked up in the “places” object	JFK
route_date.search.outbound_date	The date of the outbound leg, i.e. the departure date	2014-01-01
route_date.search.inbound_date	The inbound details for return searches	2014-01-01
route_date.search.cabin_class	The cabin class searched for – can be Economy, PremiumEconomy, Business or First	Economy
route_date.search.no_of_adults	The number of adult seats that was searched for	2
route_date.search.no_of_children	The number of children seats that was searched for	1
route_date.search.no_of_infants	The number of infant seats that was searched for	0
route_date.you	Details about your prices
route_date.you.cheapest_itinerary	Details of your cheapest itinerary
route_date.you.cheapest_itinerary.position	The position of your cheapest itinerary	2
route_date.you.cheapest_itinerary.rank	The rank of your cheapest itinerary	3
route_date.you.cheapest_itinerary.price	Price of your cheapest itinerary	123.45
route_date.you.cheapest_book_button	Details of your cheapest book button
route_date.you.cheapest_book_button.position	Position of your cheapest book button	3
route_date.you.cheapest_book_button.price	Price of your cheapest book button	234.56
route_date.you.cheapest_book_button.max_price	Maximum price to which you can increase your cheapest book button without losing it's position	345.67
route_date.you.cheapest_book_button.capturable_margin	Capturable margin on your cheapest book button	111.11
route_date.you.all	Information about all your itineraries
route_date.you.all.rank_histogram	Ranks of your itineraries - the first element is the %age ranked #1, the second element is the %age ranked #2, the third is the %age ranked #3 or higher	[0.2, 0.3, 0.5]
route_date.competition	Information about your competition
route_date.competition.cheapest_itinerary	Information about your competition's cheapest itinerary
route_date.competition.cheapest_itinerary.price	Price of your competitors’ cheapest itinerary	123.45
route_date.competition.cheapest_itinerary.price_diff	Difference between your cheapest price and your competitors	12.34
route_date.overall	Information about the overall results
route_date.overall.cheapest_itinerary	Information about the overall cheapest itinerary
route_date.overall.cheapest_itinerary.price	Overall cheapest itinerary price	123.45
route_date.overall.cheapest_itinerary.price_diff	Difference between your cheapest and the overall cheapest itinerary price	12.34
itineraries	All the itineraries on which you appear
itineraries[0]	The first itinerary on which you appear
itineraries[0].search	Details identifying the itinerary
itineraries[0].search.outbound_dep_time	The departure time of the outbound leg of the itinerary	2014-01-01T12:00
itineraries[0].search.outbound_arr_time	The arrival time of the outbound leg of the itinerary	2014-01-01T12:00
itineraries[0].search.inbound_dep_time	The departure time of the inbound leg of the itinerary	2014-01-01T12:00
itineraries[0].search.inbound_arr_time	The arrival time of the inbound leg of the itinerary	2014-01-01T12:00
itineraries[0].search.outbound_carriers	Flght numbers of the outbound legs	LH123,BA456
itineraries[0].search.inbound_carriers	Flght numbers of the inbound legs	LH321,BA654
itineraries[0].you	Information about your price
itineraries[0].you.cheapest_itinerary.rank	Your rank on this itinerary	2
itineraries[0].you.cheapest_itinerary.price	Your price for this itinerary	123.45
itineraries[0].competition	Information about your competitor's prices on this itinerary
itineraries[0].competition.cheapest_itinerary.price	Your competitor’s cheapest price	123.45
itineraries[0].competition.cheapest_itinerary.price_diff	Difference between your price and your competitor’s cheapest price	12.34
itineraries[0].overall	Information about the overall prices on this itinerary
itineraries[0].overall.cheapest_itinerary.price	Overall cheapest price	123.45
itineraries[0].overall.cheapest_itinerary.price_diff	Difference between your price and the overall cheapest price	12.34

Configuration:

Settings	Version 2.0	Version 3.0	Version 4.0
exclude_non_economy_flights	True	False	False
session_created_on_unix_timestamp	True	False	False
exclude_no_result_in_push_model	True	False	False
exclude_website_ids	False	True	True
include_next_itinerary_field	False	True	True
exclude_itinerary_position	True	False	False
include_currency	False	True	True
include_top_cheap_itineraries	False	False	True