home > support > API > Marketplace API

Marketplace API (Live XML)

These API calls are to access your live product, booking and customer data in realtime. They can be used by TourCMS Marketplace partners 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
• Client libraries and wrappers
• Error messages
• Live data examples and ideas (Some include source code)

Use of the Marketplace partner API is free, for more info view the Marketplace overview or sign up for a free partner account.

Common use cases

For integration with a travel guide use the Tour Search method to return tours/hotels (by keyword, location, comfort level, distance to a point etc). All results include an image, lat/long, summary, short description etc and tracked links for sending the customer through to the operators website for conversion. Or for a less technical solution, see our JavaScript Widgets.

For a Marketplace Partner 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 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.

More common use cases will be added here shortly, you could also check our live data examples and ideas.

Full API Method List

Housekeeping

• API Rate Limit Status

  Test connection and check rate limit

Channels

• List Channels

  List all connected channels (tour/activity/accommodation operators). This method can only be called by Marketplace Partners.

• Show Channel

  Show information on a particular channel (i.e. tour/activity/accommodation company information)

• List Channel Performance

  For Marketplace Partners 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/Hotels - General Use

• Search Tours/Hotels

  Search Tours/Hotels 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.

• Show Tour/Hotel

  Show information on a particular Tour/Hotel.

• Show Tour/Hotel Dates & Deals

  Show all some/all dates, prices and special offers for a particular Tour/Hotel.

• Update Tour/Hotel

  Update details of a particular Tour/Hotel. Currently supports updating of the Tour/Hotel "Product page URL" field only.

• Search Hotels by specific availability

  Special version of the "Search Tours/Hotels" method, tailored specifically for searching room availability of products loaded as Hotels.

We have additional Tour/Hotel methods for bulk exporting data into your own Database. Show bulk export methods

Bookings & Payments

• Creating Bookings

  Book Tours/Hotels via XML API or build your own custom booking engine. Alternatively just use the standard TourCMS Booking Engine.

• Search Bookings

  Get a list of Bookings made with all connected Channels / a specific Channel.

• Show Booking

  View details on a particular Booking.

• Update Booking

  For use by Tour Operators only (not Marketplace Partners). Update (mainly the operational) details on a particular Booking.

• Record a payment / refund

  For use by Tour Operators only (not Marketplace Partners). Log details of a payment onto the sales ledger of a booking, reducing the outstanding balance.

Customers & Enquiries

• Create Customer/Enquiry

  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 Partner and subsequent bookings on that customer record will be tracked.

• Search Enquiries

  Get a list of Enquiries sent to all connected Channels / a specific Channel.

• Show Enquiry

  View details on a particular Enquiry.

• Show Customer

  View details on a particular Customer.

• Update Customer

  For use by Tour Operators only (not Marketplace Partners). Update contact or other details on an existing customer.

• Customer Login Search

  For use by Tour Operators only (not Marketplace Partners). Check supplied customer username/password, useful for building a customer login area.

Internal Suppliers (Tour Operator use only)

• Show Supplier

  View details on an internal supplier record