| total |
total number of found tours |
| item |
an item node of matched tours |
| num |
position of the item node in the item array |
| uid |
unique numerical item ID |
| com |
common ID that groups tour options together |
| provider |
unique identifier of the provider associated with this item |
| item |
item name |
| option |
option name |
| code |
custom tour code |
| time |
start time of the option |
| availability_type |
date based or open availability |
| start_date |
starting date of the option (if set) |
| end_date |
end date of the option (if set) |
| tags |
comma separated list of tags |
| starting |
starting from price for tour |
| group |
require group/passenger information {request; require; hide}
request: optional; require: required; hide: do not show
request_name: optional; require: required; hide: do not show |
| per |
minimum number of people required for booking to be allowed |
| cutoff |
minimum number of hours in advance that booking must be made (expressed in hours) e.g. 1 day = 24, 2 days = 48, etc. |
| duration |
text description of duration of the tour |
| date_selection |
how dates are selected, always, single_date, date_range |
| date |
node of prices for the day in the value attribute(in Y-m-d format) – refer to date node definition; only returned if there is availability for the given date |
|
| active |
indicates whether the date is active or not (1 or 0) |
| availability |
number of available spots for this tour on that day |
| max_availability |
maximum number of available spots for this tour on that day |
| price_adult |
cost for adult price option |
| price_child |
cost for child price option |
| price_senior |
cost for senior price option |
| price4 – price9 |
cost for (price4 – price9) price option |
|
| prices |
nodes containing pricing information for each price level available for this option. |
| price |
| id |
price level |
| type |
price level (price_adult, price_child, price_senior, price_4-9) |
| label |
price level display label (e.g. Adult) |
| required |
1 = enabled, 0 = disabled Used for determining if at least 1 of this price level must be booked. |
| retail |
retail price |
| margin |
margin (calculated based on the difference between the set cost price and the retail price. If no cost price is set, margin will always equal retail price) |
|
| adult_label |
label for price 1 option; only returned if date is specified |
| child_label |
label for price 2 option; only returned if date is specified |
| senior_label |
label for price 3 option; only returned if date is specified |
| price4_label – price9_label |
label for (price4 – price9) price option; only returned if date is specified |
| adult_required |
flag to indicate if price 1 option is required (0 or 1); only returned if date is specified |
| child_required |
flag to indicate if price 2 option is required (0 or 1); only returned if date is specified |
| senior_required |
flag to indicate if price 3 option is required (0 or 1); only returned if date is specified |
| price4_required – price9_required |
flag to indicate if (price4 – price9) price option is required (0 or 1); only returned if date is specified |
| spaces |
number of spaces currently booked |
| currency_symbol |
currency symbol used by company (eg. $ £ € ¥) |
| currency_separator |
symbol used as decimal point/indicator |
| currency_decimals |
number of trailing decimal places to display |
| currency_base |
the base currency that the company uses – this is for use in portals |
| location name |
name of the location (generally the starting point) |
| location address |
address of the location |
| city |
location of tour – city |
| state |
location of tour – state |
| country |
location of tour – country |
| lat |
geotag latitude |
| lon |
geotag longitude |
| zoom |
geotag map zoom level |
| map_type |
type of map (ROADMAP or HYBRID) |
| line_items |
node of line items associated with this option |
| line_item |
| label |
name of this line item (e.g. Sales Tax, Booking Fee) |
| amount |
amount of line item in base currency |
| percent |
percent of line item (if no amount declared) |
| multi |
flag to indicate that this line item is charged per person (0 or 1) |
| tax |
flag to indicate if line item is a tax (0 or 1) |
|
| total_adult |
the total cost sum of adult price option; only returned if date is specified |
| total_child |
the total cost sum of child price option; only returned if date is specified |
| total_senior |
the total cost sum of senior price option; only returned if date is specified |
| total_price4 – total_price9 |
the total cost of (price4 – price9) price option; only returned if date is specified |
| sub_total |
calculated sub-total |
| taxes |
calculated tax value (returned with a value when passenger info has been passed) |
| tax_calc |
calculated tax value (returned with a value when passenger info has been passed) |
| overall_total |
the total cost of the booking (only returned when passenger info has been passed); only returned if date is specified |
| deposit |
deposit amount required upon booking discrete value or percentage or amount required to be paid as deposit upon booking; only returned if date is specified |
| deposit_value |
currently not used |
| total_availability |
total number of available spots for this tour on that day; only returned if date is specified |
| group_forms |
node of forms given during booking – refer to group forms node definition; only returned if date is specified |
| form |
| id |
unique numerical form ID |
| type |
forms type of input |
| title |
title of the form |
| instructions |
the instructions associated with the field |
| require |
flag to indicate if form is required to be filled (0 or 1) |
| options |
for type select, these are the options available with this field |
| price |
price of the option (either added or subtracted for enabling this option) – only enabled for checkbox forms |
|
| primary_forms |
node of forms given during booking – refer to primary forms node definition; only returned if date is specified |
| form |
| id |
unique numerical form ID |
| type |
forms type of input |
| title |
title of the form |
| instructions |
the instructions associated with the field |
| require |
flag to indicate if form is required to be filled (0 or 1) |
| options |
for type select, these are the options available with this field |
| price |
price of the option (either added or subtracted for enabling this option) – only enabled for checkbox forms |
|
| details |
node of detailed info – refer to details node definition |
|
| overview |
text – overview (HTML-formatted) |
| highlights |
text – highlights (HTML-formatted) |
| itinerary |
text – itinerary (HTML-formatted) |
| pick_up |
text – pick-up and departure info |
| drop_off |
text – drop-off and return info |
| bring |
text – things to bring info |
| inclusions |
text – inclusion info |
| exclusions |
text – exclusion info |
| checkin |
text – checking instructions |
| cancellation |
text – cancellation info |
| description_name |
text – name of the customizable additional info field |
| description |
text – description of item (HTML-formatted) |
| specifications |
node of customized inventory layout fields – these are fields created by the account holder to share additional information about the inventory item |
| specification |
| name |
name of the custom inventory field |
| value |
value of the custom inventory field |
|
|
| waiver |
used if waiver is enabled. type=1 for per pax, type=0 for per order |
| seo |
node of seo info |
|
| title |
seo page title for inventory item (used as page title if declared) |
| introduction |
meta description for inventory item |
|
| related |
node of related inventory items |
|
| item |
node of individual related item |
|
| com |
SKU of the inventory item (not option level SKU) |
| name |
name of the inventory item |
|
|
| media |
node of images – number of results found included in the value attribute |
| image |
| path |
absolute path of the image |
| caption |
the text caption associated with the image |
|
| updated |
UNIX times stamp of the last update of this item |
| cid |
unique numerical ID to identify the company that offers this item |
| v |
version of the API being used |
| gt |
time to generate the result (used for SLA purposes) |
