These API calls are to access your live product, booking and customer data in realtime. They can be used by TourCMS Marketplace agents to access content from multiple TourCMS accounts. These APIs can also be used by individual account owners to access their own data.
- Background information every developer needs to know
- Tips on caching API requests
- Client libraries and wrappers
- Error messages
- Live data examples and ideas (Some include source code)
Common use cases
For an agent creating a lead system you could have the customer fill in a form with their details which you can then send to the operator via the Create Enquiry method. This creates a tracked customer record so that any subsequent bookings are correctly credited.
For an agent creating a booking system use the Tour show method to return the main tour information. Then use the Creating Bookings methods to put bookings into the supplier direct TourCMS accounts. You may collect payments outside of the system (and the supplier will subsequently invoice you)
For a tour operator looking to build a post booking, pre-travel customer login: You can send the customer their login details using email templates (perhaps in their confirmation email). On your website you can validate their username/password using the Customer Login Search method and then allow them to answer some additional questions / submit more information to "Extra tour booking data" using the Show Booking and Update Booking methods or update their contact details with Update Customer.
Full API Method List
Test connection and check rate limit
List all connected channels (tour/activity/accommodation operators). This method can only be called by Marketplace Agents.
Show information on a particular channel (i.e. tour/activity/accommodation company information)
For Marketplace Agents only. List the performance (clicks, commission earnt, enquries made etc) of top 50 connected channels by clicks (or check performance for a specific channel).
Tours - General Use
Search Tours by keyword, distance, month, distance from a geographic point etc - or just list all. Use this call if you are building a page which lists products or if you are building a search page. Also can be used for searching (and listing) special offers
Show information on a particular Tour.
List primary locations (and associated countries), could be useful for building a dropdown / autocomplete search.
Product Filters are used to group related tours, this API returns a list of them and the tours they contain. For tour operator use only, not accessible by Marketplace Agents.
Show all some/all dates, prices and special offers for a particular Tour.
Update details of a particular Tour. Currently supports a subset of all fields.
Special version of the "Search Tours" method, tailored specifically for searching room availability of products loaded using Hotel pricing.
For use by Tour Operators only (not Marketplace Agents), various API methods to enable managing of Tour dates & prices externally of TourCMS.
Tours - Bulk exporting use
You are welcome to use these methods directly, however they are probably most useful if you are taking a regular export of TourCMS data to import into your own database. Combine with the "Show Tour" method above to get full product details.
List all Tours from a particular channel (supplier).
List image URLs for all Tours from a particular channel (supplier). Useful if you are mirroring product images to your own server.
Show all the dates and prices for a particular Tour that are generated by Departures. Shows a little more detail on each date than "Dates & Deals" but doesn't include freesale season or hotel priced dates.
Book Tours via XML API or build your own custom booking engine. Alternatively just use the standard TourCMS Booking Engine.
Get a list of Bookings made with all connected Channels / a specific Channel.
View details on a particular Booking.
For use by Tour Operators only (Marketplace Agents see Add note to booking). Update (mainly the operational) details on a particular Booking
Update details (quantity, price, pickup) on a component (tour, option, fee) on a booking.
Add a component (tour, option, fee) to a booking.
Remove a component (tour, option, fee) from a booking.
Add general logs, customer notes or travel agent modification requests to an existing booking
Trigger a pre-configured email template.
Cancel a committed (i.e. non temporary) booking.
For use by Tour Operators only (not Marketplace Agents). Log details of a payment onto the sales ledger of a booking, reducing the outstanding balance.
For those using Spreedly as a gateway, this special method charges a Spreedly payment method and on success commits the associated booking and stores details of the payment in TourCMS alongside
Check and redeem a clients voucher when they arrive
Customers & Enquiries
Send a new enquiry (e.g. "Contact us", General quote request, "Brochure request" etc) to a Channel. Customer record will be associated with the correct Marketplace Agent and subsequent bookings on that customer record will be tracked.
Get a list of Enquiries sent to all connected Channels / a specific Channel.
View details on a particular Enquiry.
View details on a particular Customer.
Update contact or other details on an existing customer.
For use by Tour Operators only (not Marketplace Agents). Check supplied customer username/password, useful for building a customer login area.
Agents (Tour Operator use only)
Internal Suppliers (Tour Operator use only)
View details on an internal supplier record