Viator

Viator API Documentation & Specification – Merchant Partners

<style type='text/css'> code { white-space: nowrap; } a { font-weight: bold; } figure { width: 100%; text-align: center; font-style: italic; font-size:…

E-commerce#openapi#location#ecommerce

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

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:

DateDescription
3 Feb 2021Added Special offers and on-sale pricing section
28 Oct 2020Updated FAQ section re booking questions, traveler names, and pricing
16 Sep 2020Modified FAQ section re booking currencies, supplier name display and requesting additional reviews
20 July 2020Added Booking references section

Previous updates: See 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 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.

VBAs with booking capability

VBAs also have the option of allowing their customers to process bookings directly from their site and via the API – similar to a merchant partner – without being redirected to viator.com to complete their transaction. This partner type sends customer details, product details and credit card payment information via the API, but Viator retains control of and responsibility for processing payments and customer support.

White label partners

White label partners do not operate their own site infrastructure. Instead, Viator provides a white label site with full functionality that can be branded according to the partner’s wishes.

Uses of the Viator Partner API

The Viator Partner API is used to carry out the following tasks:

###…

Endpoints 28

General services

  • GET/health/check/health/checkHealth check Use this service to determine whether the Viator API is presently online and that your API key is valid. You should receive a response identical…

Taxonomy services

  • POST/taxonomy/attractions/taxonomy/attractionsGet attractions Retrieves a list of attractions (things like the Eiffel Tower or Empire State Building) and their associated unique numeric identifiers The…
  • GET/taxonomy/categories/taxonomy/categories?destId=684Get all product categories Retrieves a list of product categories for a destination that can be used as a means of filtering when searching for products using…
  • GET/taxonomy/destinations/taxonomy/destinationsGet details of all destinations supported by this API Retrieves all the country taxonomy/city nodes as a flat list Returns a complete list of Viator…

Product services

  • POST/available/products/available/productsFind products that are available This endpoint returns available products filtered by product code, date range or number of adult travelers Note: Availability…
  • GET/product/product?currencyCode=string&sortOrder=REVIEW_RATING_A&voucherOption=VOUCHER_PAPER_ONLY&code=5010SYDNEY&showUnavailable=false&excludeTourGradeAvailability=trueGet product information This service provides all product details required for a product display page, as well as information required for price checks and…
  • GET/product/photos/product/photos?topX=1-3&code=5010SYDNEY&showUnavailable=falseGet photos of a product submitted by users
  • GET/product/reviews/product/reviews?sortOrder=REVIEW_RATING_A&topX=1-3&code=5010SYDNEY&showUnavailable=falseGet user-submitted reviews of a product Note: The number of reviews that you can obtain via this service will depend on whether your account is limited in…
  • POST/search/freetext/search/freetextFree text search This service provides a free text search across all products and destinations The text parameter is required Note: results include a type…
  • POST/search/products/search/productsSearch for products This service is used to search for products based on various criteria; such as: * the destination (locale) in which it operates * its…
  • POST/search/products/codes/search/products/codesSearch by product code This service returns an array of products given an array of product identifiers that is useful for wishlist / shopping cart / user…

Booking services

  • POST/booking/availability/booking/availabilityGet the tour-grade with the lowest price that is available for a product on each day of the specified month This service: returns useful when displaying a…
  • GET/booking/availability/dates/booking/availability/dates?productCode=2280AAHTGet dates on which a product is available This service: retrieves all available dates for a product, excluding days it does not operate and blocked-out dates…
  • POST/booking/availability/tourgrades/booking/availability/tourgradesGet the tour grades of a product that are currently available This service reports: all tour grades for the specified product, on the specified day, that are…
  • POST/booking/availability/tourgrades/pricingmatrix/booking/availability/tourgrades/pricingmatrixGet a pricing matrix that includes availability and tour-grades for a product Given a month, this service returns days with available tour grades only (i.e.,…
  • POST/booking/book/booking/bookMake a booking For more information, see: Cancellation policy Booking concepts Booking process flow Making a booking Supplier communications
  • POST/booking/calculateprice/booking/calculatepriceConfirm the price of a tour / activity prior to booking For more information, see: Calculating prices Note: Availability and pricing data is limited to a…
  • GET/booking/hotels/booking/hotels?productCode=2280AAHT&destId=123Get hotel pick-ups Lists the hotel pickups available for either a product or a destination
  • GET/booking/mybookings/booking/mybookings?voucherKey=3299307:93c7f36a56b18ba1068787ba7fb7988da5c8ad08db77604110141ff21498603e:600033670&email=apitest@viator.com&itineraryOrItemId=700179574Get a user's bookings with travel dates in the future. This service can also be used to check the status of a booking. Provide either: A voucherKey, or... An…
  • GET/booking/pastbooking/booking/pastbooking?voucherKey=1005851866:4af44c13ecf3f1a7d3f9ef2fc00c2257e08fa42ae20f877f3039ff9b52aba24e:580669678&email=apitest@viator.com&itemId=580669678Get the details of a single specific past booking based on the voucherKey or itemId and email address sent in the request. Note: this service will only return…
  • POST/booking/pricingmatrix/booking/pricingmatrixGet the pricing matrix for tour-grades, product age bands and pax mixes For more information, see: Get the tour-grade pricing matrix
  • POST/booking/status/booking/statusGet the booking status for multiple items based on different criteria This service: is ideally be used in software for bulk updates of pending bookings…
  • POST/booking/status/items/booking/status/itemsGet brief booking statuses This service is similar to /booking/status in that it: retrieves the booking status for multiple items based on different criteria…
  • GET/booking/voucher/booking/voucher?leadLastName=Simpson&itemId=600033670&embeddedResources=false&voucherKey=3299307:93c7f36a56b18ba1068787ba7fb7988da5c8ad08db77604110141ff21498603e:600033670&fullHTML=true&mobileVoucher=trueGet voucher details Use this service to retrieve the voucher details of a booked item. The data returned is HTML-formatted and can be wrapped in a header…
  • GET/bookings/cancel-reasonshttps://api.sandbox.viator.com/partner/bookings/cancel-reasonsRetrieves a dictionary of unique identification codes (cancellationReasonCode) and their associated natural-language descriptions (cancellationReasonText).…
  • POST/bookings/{booking-reference}/cancelhttps://api.sandbox.viator.com/partner/bookings/:booking-reference/cancelSubmits a cancellation request for the specified booking For information on how to use this service, see: Cancellation API workflow Note: * This service…
  • GET/bookings/{booking-reference}/cancel-quotehttps://api.sandbox.viator.com/partner/bookings/:booking-reference/cancel-quoteRetrieves a quote for the cancellation of a booking For information on how to use this service, see: Cancellation API workflow Note: * This service…

Deprecated services

  • POST/merchant/cancellation/merchant/cancellationDeprecated. Cancel a booking Note: This service has been replaced by the cancellationReasons, bookingQuote and cancelBooking endpoints

API details

Base URL
https://viatorapi.viator.com/service
https://viatorapi.sandbox.viator.com/service
Authentication
An API key in the exp-api-key header
An API key in the apiKey query parameter
Operations
28 operations on 28 pathsPOST 15GET 13
1 marked deprecated
Main resources
Booking services 16Product services 7Taxonomy services 3Deprecated services 1General services 1
Response formats
application/json
Description format
OpenAPI 3.0.1, API version 1.0.0
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Viator API Documentation &amp; Specification – Merchant Partners in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Viator API Documentation &amp; Specification – Merchant Partners collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the exp-api-key header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “/health/check” (GET /health/check), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Viator API Documentation &amp; Specification – Merchant Partners?

<style type='text/css'> code { white-space: nowrap; } a { font-weight: bold; } figure { width: 100%; text-align: center; font-style: italic; font-size:… It is listed under E-commerce and has 28 endpoints.

Who publishes the Viator API Documentation &amp; Specification – Merchant Partners?

It is listed from Viator's public API description (an OpenAPI document), not published by Viator on Swastik Codes. Anyone who controls viator.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Viator API Documentation &amp; Specification – Merchant Partners?

Its description lists 2 base URLs: https://viatorapi.viator.com/service, https://viatorapi.sandbox.viator.com/service. The first is the usual one; the others are typically sandbox or regional servers.

How do I authenticate with the Viator API Documentation &amp; Specification – Merchant Partners?

It accepts 2 methods: an API key in the exp-api-key header; an API key in the apiKey query parameter.

How many endpoints does the Viator API Documentation &amp; Specification – Merchant Partners have?

28 operations on 28 paths (15 POST, 13 GET). The largest groups are Booking services, Product services, Taxonomy services, Deprecated services.

Is forking the Viator API Documentation &amp; Specification – Merchant Partners free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.