Full API Endpoint List

• API Rate Limit Status

  Test connection and check rate limit.

• List Channels

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

• Show Channel

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

• List Channel Performance

  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).

• Show Markup Scheme

  Return full information about the Markup Scheme associated with a Channel. For Tour Operator Use Only.

• Search Tours

  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 Tour

  Show information on a particular Tour.

• Show Tour Dates & Deals

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

• Update Tour

  Update details of a particular Tour. Currently supports a subset of all fields.

• List Tour Locations

  List primary locations (and associated countries), could be useful for building a dropdown / autocomplete search.

• List Product Filters

  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.

• Search Hotels by specific availability

  Special version of the "Search Tours" method, tailored specifically for searching room availability of products loaded using Hotel pricing.

• Managing dates and prices externally of TourCMS

  For use by Tour Operators only (not Marketplace Agents), various API methods to enable managing of Tour dates & prices externally of TourCMS.

• List Tour Booking Restrictions

  For use by Tour Operators and Marketplace Agents. Lists the field restrictions configured in specific tours.

• Tours Search Criteria

  For use by Tour Operators and Marketplace Agents. Shows the Tours Tags selected for a tours of a channel, as well as its locations

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 Tours

  List all Tours from a particular channel (supplier).

• List Tour Images

  List image URLs for all Tours from a particular channel (supplier). Useful if you are mirroring product images to your own server.

• Show Tour Departures

  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.

• Delete tour

  Delete a tour from a particular channel (supplier).

• Upload files

  Upload files including image upload, document upload (pdf).

• Delete tour image

  Delete an image and associated description from a tour

• Delete tour document

  Delete a document and associated description from a tour

• Creating Bookings

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

• List 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 (Marketplace Agents see Add note to booking). Update (mainly the operational) details on a particular Booking.

• Update Booking Component

  Update details (quantity, price, pickup) on a component (tour, option, fee) on a booking.

• Add Booking Component

  Add a component (tour, option, fee) to a booking.

• Remove Booking Component

  Remove a component (tour, option, fee) from a booking.

• Add Note to Booking

  Add general logs, customer notes or travel agent modification requests to an existing booking.

• Send Booking Email

  Trigger a pre-configured email template.

• Cancel Booking

  Cancel a committed (i.e. non temporary) booking.

• Record a payment / refund

  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.

• Create a Spreedly payment

  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.

• Payments list

  List of payments made during a period.

• Voucher redemption

  Check and redeem a clients voucher when they arrive.

• 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 Agent 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

  Update contact or other details on an existing customer.

• Customer Login Search

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

• Update Agent Profile

  Update the information of a certain Marketplace Agent

• Show Agent Profile

  Get profile information for a certain Marketplace Agent

• Agent Search

  Search/List agents.

• Agent Update

  Update some details on an agent.

• Agent Login

  Allow Marketplace travel agents to log into your website to book

• Show Supplier

  View details on an internal supplier record.

• Staff Members List

  List of staff members connected to the channel requested.

• Create Pickup

  Create a new pickup point in the account connected to the channel requested.

• Delete Pickup

  Delete an existing pickup point in the account connected to the channel requested.

• Update Pickup

  Update an existing pickup point in the account connected to the channel requested.

• List Pickups

  List of existing pickup points in the account connected to the channel requested.

• Managing pickup points

  For use by Tour Operators only (not Marketplace Agents), various API methods to enable managing of pickup points.

• Show Tour Pickup Routes

  Show all pickup routes for a tour in the account connected to the channel requested.

• Update Tour Pickup Route

  Update a pickup route from a tour in the account connected to the channel requested.

• Add Pickup to Tour Pickup Route

  Add a pickup in a pickup route from a tour in the account connected to the channel requested.

• Update Pickup in Tour Pickup Route

  Update a pickup from a pickup route from a tour in the account connected to the channel requested.

• Delete Pickup of a Tour Pickup Route

  Delete a pickup from a pickup route from a tour in the account connected to the channel requested.

• Create a tour Geopoint

  Create an existing tour geopoint in the requested tour.

• Delete a tour Geopoint

  Delete an existing tour geopoint in the requested tour.

• Update a tour Geopoint

  Update an existing tour geopoint in the requested tour.

• Managing tour Geopoints

  For use by Tour Operators only (not Marketplace Agents), various API methods to enable managing of tour geopoints.

• List Custom Fields

  List all extra tour content fields for the account.

• Get Tour Facets

  Get the facets (search criteria) that can be used to request the tour list from the subsystem

• Get Tour List

  Get the tour list from the subsystem

• Get Import Tours Status

  Get the importing status of the tours