
Viator API Documentation & Specification – Merchant Partners API
by viator.com
Overview
<style type='text/css'> code { white-space: nowrap; } a { font-weight: bold; } figure { width: 100%; text-align: center; font-style: italic; font-size: smaller; text-indent: 0; border: thin silver solid; margin: 0.5em; padding: 0.5em; } </style> ## Updates ### Latest update: | Date | Description | |------|-------------| | 3 Feb 2021 | Added [Special offers and on-sale pricing](#section/Key-concepts/Special-offers-and-on-sale-pricing) section | | 28 Oct 2020 | Updated FAQ section re booking questions, traveler names, and pricing | | 16 Sep 2020 | Modified FAQ section re booking currencies, supplier name display and requesting additional reviews | | 20 July 2020 | Added [Booking references](#section/Key-concepts/Booking-references) section | **Previous updates**: See [Update log](#section/Appendices/Update-log) # Overview The Viator Partner API comprises a set of endpoints that can support the operation of a fully-featured tours and experiences booking website or application; or, it can be integrated with your existing travel-booking software. The API exposes a variety of services that allow the retrieval of all product details, such as descriptions, pricing, terms and conditions, photos and reviews. This data can either be ingested periodically and managed on your local system, or calls can be made in real time to retrieve content in response to your users' activity on your systems. The API allows product availability schedules to be retrieved in bulk or queried in real-time, and it can perform pricing calculations according to the number and type of traveler for the wide variety of product option combinations typically available in the tours and activities sales workflow. The API provides booking and post-booking functionality, allowing booking requests, ticket purchase, and booking status updates. Various utility services are available to map between yours and Viator's data taxonomy. **Please note:** The API does not provide services for storing data, such as user accounts. We assume that merchant partners have their own systems for storing this data. ## Who is the API for? The Viator Partner API is designed for use by organizations and individuals partnered with Viator in one of the following capacities: ### Merchant partners A merchant partner is one who operates as the merchant of record; i.e., takes full responsibility for all monetary transactions carried out by their users, as well as providing customer support with regard to providing help, processing cancellations and refunds, and liaising between suppliers and customers when the need to communicate information arises. Merchant partners are invoiced periodically by Viator for all product sales. You will need to demonstrate that you have access to the appropriate infrastructure to effectively support the requisite business operations in order to become a merchant partner. ### Viator Branded Affiliates (VBAs) VBAs have full access to the areas of the API relating to content, but sales of Viator products must be carried out on the Viator site itself; therefore, access to the booking or transactional endpoints necessary to operate as the merchant of record (i.e., merchant partners) is restricted. When a customer wishes to book a product from a VBA partner's site, they are instead redirected to [viator.com](https://viator.com) in order to complete the purchase; whereas, merchant partners are able to process and manage bookings through the Viator API itself, allowing their customers to book products without leaving the partner's site. Viator affiliates instead generate unique URLs that redirect their users to the Viator site, resulting in a cookie being set such that all transactions will accrue a commission for that partner until the cookie expires. Purchases of products originating from the VBAs site are recorded and a commission on these sales is paid periodically. - **Note**: VBA partners should refer to a different document for technical specifications rele
Viator API Documentation & Specification – Merchant Partners is a geocoding API from viator.com. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 28 endpoints.
At a glance
- Authentication
- API key
- HTTPS
- Yes
- CORS
- Unknown
- Category
- Geocoding
- Base URL
https://viatorapi.viator.com/service- Version
- 1.0.0
- Endpoints
- 28
- OpenAPI
- Specification ↗
- Spec updated
- 2021-06-10
Make a first request
Replace the placeholders; the documentation says exactly where credentials go.
curl -X GET "https://viatorapi.viator.com/service/booking/availability/dates" \
-H "Accept: application/json" \
-H "X-API-Key: YOUR_API_KEY"const response = await fetch("https://viatorapi.viator.com/service/booking/availability/dates", {
method: "GET",
headers: {
"Accept": "application/json",
"X-API-Key": "YOUR_API_KEY",
},
});
const data = await response.json();
console.log(data);import requests
response = requests.request(
"GET",
"https://viatorapi.viator.com/service/booking/availability/dates",
headers={
"Accept": "application/json",
"X-API-Key": "YOUR_API_KEY",
},
timeout=30,
)
print(response.json())Endpoints
| Method | Path | What it does |
|---|---|---|
| POST | /available/products | /available/products |
| POST | /booking/availability | /booking/availability |
| GET | /booking/availability/dates | /booking/availability/dates |
| POST | /booking/availability/tourgrades | /booking/availability/tourgrades |
| POST | /booking/availability/tourgrades/pricingmatrix | /booking/availability/tourgrades/pricingmatrix |
| POST | /booking/book | /booking/book |
| POST | /booking/calculateprice | /booking/calculateprice |
| GET | /booking/hotels | /booking/hotels |
| GET | /booking/mybookings | /booking/mybookings |
| GET | /booking/pastbooking | /booking/pastbooking |
| POST | /booking/pricingmatrix | /booking/pricingmatrix |
| POST | /booking/status | /booking/status |
| POST | /booking/status/items | /booking/status/items |
| GET | /booking/voucher | /booking/voucher |
| GET | /bookings/cancel-reasons | /bookings/cancel-reasons |
| POST | /bookings/{booking-reference}/cancel | /bookings/{booking-reference}/cancel |
| GET | /bookings/{booking-reference}/cancel-quote | /bookings/{booking-reference}/cancel-quote |
| GET | /health/check | /health/check |
| POST | /merchant/cancellationdeprecated | /merchant/cancellation |
| GET | /product | /product |
| GET | /product/photos | /product/photos |
| GET | /product/reviews | /product/reviews |
| POST | /search/freetext | /search/freetext |
| POST | /search/products | /search/products |
| POST | /search/products/codes | /search/products/codes |
| POST | /taxonomy/attractions | /taxonomy/attractions |
| GET | /taxonomy/categories | /taxonomy/categories |
| GET | /taxonomy/destinations | /taxonomy/destinations |
Questions
Does the Viator API Documentation & Specification – Merchant Partners API need an API key?
Yes. The Viator API Documentation & Specification – Merchant Partners API uses API key authentication; the documentation explains how to get credentials.
Does the Viator API Documentation & Specification – Merchant Partners API support HTTPS?
Yes, the Viator API Documentation & Specification – Merchant Partners API is served over HTTPS.
How many endpoints does the Viator API Documentation & Specification – Merchant Partners API have?
Its OpenAPI description lists 28 endpoints in version 1.0.0. All of them are shown on this page.
What are alternatives to the Viator API Documentation & Specification – Merchant Partners API?
Other Geocoding APIs include Bing Maps, ip-api, OpenStreetMap, GeographQL, IP Address Details.
Similar geocoding APIs
Compare alternatives →Bing Maps
GeocodingCreate/customize digital maps based on Bing Maps data
ip-api
GeocodingFind location with IP address or domain
OpenStreetMap
GeocodingNavigation, geolocation and geographical data
GeographQL
GeocodingA Country, State, and City GraphQL API
IP Address Details
GeocodingFind geolocation with ip address
ipapi.co
GeocodingFind IP address location information
Listed from APIs.guru (CC0).