home > support > API > Marketplace API > API: tour/hotel information

Show Tour

PurposeReturn full information about a specific Tour/Hotel
NotesN/A
REST info Call/c/tour/show
FormatsXML
Example/c/tour/show.xml?id=92
VerbGET
Code

PHP examples use the PHP Client Library with SimpleXML

Description

object show_tour( int $tour, int $channel )

Parameters

$tour
	ID for the Tour
$channel
	ID for the Channel (Operator) - required as Tour IDs are not unique

Example

// ID for the Tour/Hotel we want the details for
$tour = 152;

// Channel (Operator) ID of the Tour/Hotel
$channel = 6;

// Query the TourCMS API
$result = $tourcms->show_tour($tour, $channel);

// Go straight to the tour node
$tour = $result->tour;

// Print out the tour name and lead in price
print $tour->tour_name.' - from only '.$tour->from_price_display;
Nile Family Adventure - from only £650

C# examples use the .Net Client Library

Overload list

XmlDocument ShowTour (int tourId, int ChannelId)

Parameters

tourId
	ID for the Tour
ChannelId
	ID for the Channel (Operator) - required as Tour IDs are not unique

Example

// ID for the Tour/Hotel we want the details for
int tourId = 152;

// Channel (Operator) ID of the Tour/Hotel
int channelId = 6;

// Query the TourCMS API
XmlDocument doc = myTourCMS.ShowTour(tourId, channeId);

// Display the tour name and lead in price
string tourName = doc.SelectSingleNode("//tour/tour_name").innerText;
string tourPrice =
			doc.SelectSingleNode("//tour/from_price_display").innerText;

Console.WriteLine(tourName + " - from only " + tourPrice);
Nile Family Adventure - from only £650

VB examples use the .Net Client Library

Overload list

XmlDocument ShowTour (int tourId, int ChannelId)

Parameters

tourId
	ID for the Tour
ChannelId
	ID for the Channel (Operator) - required as Tour IDs are not unique

Example

' ID for the Tour/Hotel we want the details for
Dim tourId As Integer = 152

' Channel (Operator) ID of the Tour/Hotel
Dim channelId As Integer = 6

' Query the TourCMS API
Dim doc As XmlDocument = myTourCMS.ShowTour(tourId, channeId)

' Display the tour name and lead in price
Dim tourName As String = doc.SelectSingleNode("//tour/tour_name").innerText
Dim tourPrice As String =
		doc.SelectSingleNode("//tour/from_price_display").innerText

Console.WriteLine(tourName & " - from only " & tourPrice)
Nile Family Adventure - from only £650

Querystring parameters

Querystring parameters
ParameterNotes
idTour ID


The Channel ID is also passed via the request header, this is required as Tour IDs are unique within a particular channel (Operator) rather than being unique system wide.

Response fields

Response fields
NodeNotes
request Confirmation of the request that you sent
error Any error message returned, if there is no error this will just contain the text OK
tour

The tour node contains the following child nodes.

NodeNotes
channel_idChannel ID
account_idAccount ID
tour_idTour/Hotel ID
tour_nameTour/Hotel name
start_timeStart time / Opening time for the Tour/Hotel.
 
May be a 24 hour time value in local time (e.g. "09:00").
 
If there are multiple start times per day or the start time varies by day then the value will be "MULTI".
 
Alternatively if start time is unknown / irrelevent then this field may be blank Β (although the start time may be explained elsewhere in the Tour/Hotel description, e.g. in the pickup points section).
end_timeEnd time / Closing time for the Tour/Hotel.
 
Possible values as per start_time above.
has_sale1 - Future product on sale
0 - No future product on sale
has_d1 - Has a tour departure loaded
0 - No tour departure loaded
has_f1 - Has a tour freesale loaded
0 - No tour freesale loaded
has_h1 - Has a hotel product type loaded
0 - No hotel product type loaded
descriptions_last_updatedWhen the tour/hotel text descriptions were last updated, date format YYYY-MM-DD
next_bookable_dateFirst date the tour/hotel text is bookable, date format YYYY-MM-DD
has_sale_jan
has_sale_feb
has_sale_mar
has_sale_apr
has_sale_may
has_sale_jun
has_sale_jul
has_sale_aug
has_sale_sep
has_sale_oct
has_sale_nov
has_sale_dec
1 - Future product on sale (by the month)
0 - No future product on sale (by the month
quantity_rule1 - price x 1
q - price x quantity
tour_codeTour code (only returned if set)
from_priceLead in price
from_price_displayLead in price - display version (Includes HTML entity currency code and no decimals)
from_price_jan
from_price_feb
from_price_mar
from_price_apr
from_price_may
from_price_jun
from_price_jul
from_price_aug
from_price_sep
from_price_oct
from_price_nov
from_price_dec
Lead in price by the month
Use to create a nice seasonal price chart

There are also _display versions that work the same way as from_price_display
sale_currencySale currency (for the lead in price). Currency is set by channel
priorityHIGH, MEDIUM, LOW - Commercial priority
addressPostal address
geocode_startLat,Long geocode for start point
geocode_endLat,Long geocode for end point
grade 1 - All ages / Not applicable
2 - Moderate
3 - Fit
4 - Challenging
5 - Extreme
accomrating 1 - No accommodation / Not applicable
2 - Luxury
3 - Moderate
4 - Comfortable
5 - Basic
6 - Various levels
product_type 1 - Accommodation (hotel/campsite/villa/ski chalet/lodge)
2 - Transport
3 - Tour/cruise including overnight stay
4 - Day tour/trip/activity/attraction (No overnight stay)
5 - Tailor made
6 - Event
7 - Training/education
8 - Other
tourleader_type 1 - Tour guide / driver
2 - Independent / self drive
3 - Not applicable (e.g. accommodation / event)
locationPrimary location - Perhaps a city name, national park name or region
summarySummary - Includes primary activity if not clear from tour/hotel name
countryComma separated list of uppercase countries the tour takes place in
duration_descText description for duration (e.g. 1 week)
durationDuration (Days)
availableText description for when available (e.g. March to September)
shortdescShort description (NO HTML)
longdescLong description
itineraryItinerary
expRather than facts, this description should focus on the experience e.g. a wonderful hill walk with great vistas
pickPickup / Dropoff information
inc_exIncluded / Excluded
essentialEssential information - What to bring, accommodation details, single supplements, solo travellers
extrasExtras / upgrades
restRestrictions - e.g. Pets, minimum age / children permitted, whether requires a preexisting skill etc
tour_urlURL for the tour detail page
tour_url_trackedURL for the tour detail page - via agent tracking mechanism
Not returned for /c/tours/search
book_urlURL to booking engine / live availability display (can be iframed onto your site)
supplier_idIf a Tour Operator is using the API call directly then supplier_id will contain the internal reference number for the supplier on the main Tour/Hotel on the booking. Not returned when a Marketplace Partner is using the API.
images

The images node will contain between 1 and 6 image nodes.

NodeNotes
image

The first image node will contain a thumbnail attribute with the value true, this image should be used as the thumbnail if a single image is being displayed (e.g. list pages).

Each image node contains a url node and image_desc node.

NodeNotes
url URL (web address) for the image
image_desc Description / caption for image
new_booking

Information to help those building their own booking engine using the API. Includes data that might be useful if designing a booking form:

NodeNotes
people_selection

Information on the various rates (pricing tiers) offered, including min/max numbers of people

NodeNotes
rate

There will be a rate node for each individual pricing tier offered on this Tour/Hotel containing:

NodeNotes
label_1 Main customer facing descriptor for this rate, e.g. "Adults".
 
May be blank in which case display text such as "Number of people"
label_2 Secondary customer facing descriptor for this rate, e.g. "(16plus)"
minimum Minimum number of people per booking on this rate
maximum Maximum number of people per booking on this rate
rate_id Identifier for the rate
date_selection

Information on how dates & durations are calculated for this Tour/Hotel, useful for determining how to present date / duration selection.

NodeNotes
date_type - DATE
Tour type availability
 
- DATE_DAYS
Hotel type availability, duration in days
 
- DATE_NIGHTS
Hotel type availability, duration in days
duration_minimum The minimum duration that must be booked for this Tour/Hotel. Only shows if date_type is either DATE_DAYS or DATE_NIGHTS.
duration_minimum The maximum duration that must be booked for this Tour/Hotel. Only shows if date_type is either DATE_DAYS or DATE_NIGHTS.

Sample XML Response

/c/tour/show.xml?id=92

More information

© 2003-2012 Travel UCD Limited. All rights reserved. TourCMS® is a registered trademark of Travel UCD Limited, United Kingdom. View Privacy policy.