channel_id | Channel ID |
account_id | Account ID |
channel_name | Channel name (Company name) |
get_perm_custbook | API GET permission - Customers / Bookings |
get_perm_agsup | API GET permission - Agents / Suppliers. Permission settings |
post_perm_custbook | API POST permission - Customers / Bookings |
post_perm_agsup | API POST permission - Agents / Suppliers |
post_perm_dpa | API POST permission - Products / Dates / Prices / Availability |
home_url | URL website homepage |
home_url_tracked | URL website homepage (with agent tracking) |
logo_url | Channel logo URL |
lang | Valid TourCMS Language. eg: en, es, fr, de... |
utc_offset_mins | Local time: Offset (minutes) from UTC |
account_timezone | Default timezone for account |
default_tour_timezone | Default timezone for tours in the account |
sale_currency | Sale currency (prices returned in this currency) |
fee_active | INT 0-1 |
booking_fee |
Booking fee configuration:
XML Node | Notes |
fee | |
description | |
fee_type | |
|
base_currency | Base currency - for accounting integrations only |
connection_date | Date you connected to this channel (YYYY-MM-DD) |
short_desc | Short description |
long_desc | Long description |
very_long_desc | Very long description |
why_desc | Why us? |
bonding | Bonding / financial protection |
certification | e.g. for activity companies could be industry association memberships |
cancel_policy | Cancellation policy |
terms_and_conditions | Terms and conditions for booking |
email_customer | Sales enquiry email address that can be shown to customers IF you are an agent and sending booking notifications to the supplier, send to this address |
phone_customer | Sales enquiry telephone number that can be shown to customers |
office_hours | Office hours |
twitter | Twitter handle (excludes the @) |
tripadvisor | URL for TripAdvisor entry |
youtube | URL for Youtube channel |
facebook | URL for Facebook page |
flickr | URL for Flickr photo page |
othersm | URL for some other social media site (e.g. Ning, blog, forums etc) |
address_1 | Address line 1 |
address_2 | Address line 2 |
address_city | City |
address_state | State |
address_postcode | Postcode / Zipcode |
address_country | Country code |
latitude | FLOAT between -90 and 90 |
longitude | FLOAT between -180 and 180 |
geo_location |
Optional additional geo information related to the business address.
XML Node | Notes |
geocode |
lat,lng geocode point |
google_place_id |
A Google Place ID |
google_place_name |
The Human readable name for the Google Place ID |
search_term |
Search term used to generate Google Place ID |
google_place_refreshed |
UTC Date / time the Google Place ID was pulled from Google API. E.g. 2022-11-21 9:57:45 |
|
contact_us_link | Link to contact us page on the operators own website. |
privacy_policy_link | Link to privacy policy page on the operators own website. |
branding_colour | Branding colour. Should look good behind light text. |
commercial_email_private | Email address for partners to use to contact the channel |
commercial_contactname_private | Name of the channel contact |
commercial_pitch_private | What the standard deal for this channel is |
commercial_ppl_private | Interested in pay per lead |
commercial_dir_private | Interested in directory listings / pay to list |
commercial_ppc_private | Interested in pay per click |
commercial_aff_private | Interested in affiliate deals (consumer books with channel directly) |
commercial_ag_private | Interested in agent deals (agent takes money) |
commercial_any_private | Interested in all sorts of promotional ideas! |
commercial_avleadtime_private | Average leadtime (Days between when booking made and start date) |
commercial_avtransaction_private | Average transaction size (in sale currency) |
commercial_avpeople_private | Average number of people (pax) in a booking |
commercial_avclick2book_private | Average number of unique visitors (via tracking script) to deliver 1 booking |
commercial_avduration_private | Average duration of a booking (days) (i.e. whether day tours or longer) |
commercial_percent_online_private | % bookings received online |
commercial_percent_convert_private | % of bookings that ultimately convert to confirmed bookings |
perm_override_sale_price |
The agent permission to overwrite the sale price in the booking process.
Values:
1: Allow to overwrite sale price
0: Not allow to overwrite sale price
|
connection_permission | The permissions granted by the channel owner when the connection was made, of most interest to Marketplace Agents (Tour Operators have full - 3 - permission on their own channels) 1 Sell only (No booking access)
Able to sell products but they won't see how successful they are.
Ideal for advertisers earning a fixed fee per year (rather than on success)
2 Summary statistics (For affiliates)
Can sell your product and see a top level summary of click/booking success and some basic booking information: dates, lead customer name, sale value, commission earned etc.
This level is designed for website affiliates who need to know how they are doing but are not part of the bookings transaction
hence you don't want to over disclose personal consumer information to them
3 Full booking details (Just on own bookings)
Full access to booking and customer records for bookings they have generated.
However Marketplace Agents have no access to internal information such as profit margin nor suppliers used.
Designed for travel agents who probably have the customer information already as they gave you the booking in the first place |
company_name |
The legal company name the channel belongs to. Not intended for general marketing/public display. Instead use <channel_name> |
payment_gateway |
Information about the payment gateway used by the operator, containing:
XML Node | Notes |
gateway_id |
TourCMS unique identifier for this gateway |
name |
Staff entered name for the gateway, freetext |
take_visa
take_mastercard
take_diners
take_discover
take_amex
take_unionpay |
A field for each possible supported credit/debit card type (MasterCard, Diners Club, Discover, American Express, UnionPay). Will be "1" if card type is accepted, "0" if it isn't Useful to display an indication of which card types are accepted when booking, perhaps using icons like these. |
gateway_type |
Indicates the type of gateway used, if "SPRE" then the operator is using Spreedly which allows agents websites/apps to offer payments direct to the operator. Other values include "PAYP" for PayPal, "AUN" for Authorize.net |
If operator using Spreedly (gateway_type "SPRE") |
spreedly_environment_key | Required for taking credit card payments via Spreedly payment solution powered companies. This is open for travel agent use as well as supplier. More details |
If accessing as a tour operator (not agent) |
field_1
field_2
....
field_10 |
Configuration settings for the payment gateway, useful if building a custom booking engine, allows gateway details to be stored once - in TourCMS. 10 fields, not all are used for all gateways (so some may be blank). The data stored in each numbered field varies by gateway, see the gateway settings page in TourCMS to match up the correct fields. |
|
booking_style | Generally only useful for affiliates linking to the operator booking engine. Permits you to use text such as book now or enquire now. If you are placing bookings via API you can likely ignore this value as your connection permissions will determine whether you place confirmed bookings or not.
For affiliates or others linking to the TourCMS hosted booking engine it describes the status of bookings created that way. ENQUIRY, QUOTE, BOOKING. |