Viator API Documentation & Specification – Merchant Partners
<style type='text/css'>
COMMUNITYAPI KEY0 INSTALLS
OpenAPI Specificationv3.0
{
"openapi": "3.0.1",
"servers": [
{
"description": "Production server (uses live data)",
"url": "https://viatorapi.viator.com/service"
},
{
"description": "Sandbox server (uses test data)",
"url": "https://viatorapi.sandbox.viator.com/service"
}
],
"info": {
"contact": {
"email": "dpsupport@viator.com",
"name": "Viator Partner Support Team",
"url": "https://docs.viator.com/partner-api/merchant/#support-procedures-merchant/"
},
"description": "<style type='text/css'>\ncode { white-space: nowrap; }\na { font-weight: bold; }\n\nfigure {\n width: 100%;\n text-align: center;\n font-style: italic;\n font-size: smaller;\n text-indent: 0;\n border: thin silver solid;\n margin: 0.5em;\n padding: 0.5em;\n}\n\n</style>\n\n## Updates\n\n### Latest update: \n\n| Date | Description |\n|------|-------------|\n| 3 Feb 2021 | Added [Special offers and on-sale pricing](#section/Key-concepts/Special-offers-and-on-sale-pricing) section |\n| 28 Oct 2020 | Updated FAQ section re booking questions, traveler names, and pricing |\n| 16 Sep 2020 | Modified FAQ section re booking currencies, supplier name display and requesting additional reviews |\n| 20 July 2020 | Added [Booking references](#section/Key-concepts/Booking-references) section |\n\n**Previous updates**: See [Update log](#section/Appendices/Update-log)\n\n# Overview\n\nThe 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.\n\nThe 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.\n\nThe 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.\n\nThe API provides booking and post-booking functionality, allowing booking requests, ticket purchase, and booking status updates.\n\nVarious utility services are available to map between yours and Viator's data taxonomy.\n\n**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.\n\n## Who is the API for?\n\nThe Viator Partner API is designed for use by organizations and individuals partnered with Viator in one of the following capacities:\n\n### Merchant partners\n\nA 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.\n\nMerchant 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.\n\n### Viator Branded Affiliates (VBAs)\n\nVBAs 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. \n\nWhen 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.\n\nViator 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.\n\nPurchases of products originating from the VBAs site are recorded and a commission on these sales is paid periodically.\n\n- **Note**: VBA partners should refer to a different document for technical specifications relevant to their partner type. If you are a VBA partner, please navigate to: [https://docs.viator.com/partner-api/affiliate/technical/](https://docs.viator.com/partner-api/affiliate/technical)\n\n### VBAs with booking capability\n\nVBAs 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.\n\n### White label partners\n\nWhite 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.\n\n## Uses of the Viator Partner API\n\nThe Viator Partner API is used to carry out the following tasks:\n\n### Product search and ingestion\n\nPartners can use the product search endpoints to retrieve lists of products from Viator’s inventory relevant to their business. The available search criteria include:\n\n- The location (destination) in which the product operates\n- Whether the product is associated with a well-known tourist attraction; e.g., Empire State Building\n- The type of product (known as its category and/or subcategory)\n- The time period during which the product operates \n- Words or phrases that occur in a product's description via a free-text search\n\nPartners who prefer to download product details periodically (instead of performing all operations in real time in response to user behavior) do so by using the product search endpoints to compile a list of products that they wish to sell on their site. They then download comprehensive product details for each via the /product endpoint.\n\n#### Product search endpoints:\n\n| Endpoint | Use |\n|-|-|\n| [/search/products](#operation/searchProducts) | Allows searching for products according to: destination / location, relationship to a known tourist attraction; category and/or subcategory; date of operation |\n| [/search/products/codes](#operation/searchProductsCodes) | Retrieves product details for products that match a list of product codes (unique identifiers for the product) |\n| [/search/freetext](#operation/searchFreetext) | Retrieves product details for products that include the search terms in the product's description and details. |\n| [/available/products](#operation/availableProducts) | Retrieves products that are identified by specific product codes, operate during a specified day range and accept a certain number of adult travelers |\n\n#### Product information endpoints:\n\nAll information about a product that must be communicated to customers prior to purchase is available via [/product](#operation/product) and its auxiliary endpoints. This content is generally used to construct product display pages and for performing local searches.\n\nImportant information about a product includes:\n\n- Product and supplier names\n- Geographic location\n- Product description\n- Category and subcategory\n- Photos (from both users and the supplier)\n- User reviews and ratings\n- Product options (variants of the tour/activity, such as starting times, passenger mix options, and inclusions/add-ons, including basic pricing information for each)\n- Which age ranges can participate\n- Booking details\n- Cancellation policies\n- Basic pricing\n- Logistics\n + Inclusions (e.g., provided meals)\n + Exclusions (e.g., entrance fees to visited attractions)\n + Health restrictions and accessibility\n + Departure times\n + Passenger pick-up\n + Duration\n + Tour routes\n\n### Availability\n\nThe availability of a tour is communicated via the API's availability endpoints. The availability aspects of a product include:\n\n- On which days and at which times the product is available to be booked\n- Whether the product option (variant) supports a certain combination of passengers according to age and number\n- Pricing information\n\nSome partners choose to bulk-ingest availability information for their products in order to expedite this part of the customer workflow or to facilitate a local search functionality on their website; but, because this information changes very regularly, a final real-time call is generally recommended to ensure that when the booking request is submitted by the customer it is unlikely to fail on account of a change in availability.\n\n#### Availability endpoints\n\n| Endpoint | Use |\n|-|-|\n| [/booking/availability](#operation/bookingAvailability) | Returns the product option with the lowest price that is available on each day |\n| [/booking/availability/dates](#operation/bookingAvailabilityDates) | Returns all available dates for a product (but without regard to product option) |\n| [/booking/availability/tourgrades](#operation/bookingAvailabilityTourgrades) | Returns all product options for a product that are available on the specified day for the specified passenger mix |\n| [/booking/availability/tourgrades/pricingmatrix](#operation/bookingAvailabilityTourgradesPricingmatrix) | Returns a detailed matrix of product options, passenger mixes and the pricing applicable to each combination |\n| [/booking/calculateprice](#operation/bookingCalculateprice) | Provides a reconfirmation of a product's availability with respect to the product option and passenger mix provided and calculates a final price; used as a final availability check immediately prior to making a booking |\n\n### Booking and cancellations\n\nMerchant partners and VBAs with booking capabilities can use the Viator Partner API to purchase the product through the [/booking/book](#operation/bookingBook) endpoint.\n\nThe API also provides services to:\n\n- Enquire about the status of an existing booking\n- Retrieve tickets/vouchers for the product\n- Cancel a booking\n\n#### Booking endpoints\n\n| Endpoint | Use |\n|-|-|\n| [/booking/book](#operation/bookingBook) | Make a booking / purchase a product |\n| [/booking/status](#operation/bookingStatus) | Retrieve multiple detailed booking statuses based on a range of specified criteria |\n| [/booking/status/items](#operation/bookingStatusItems) | Similar to [/booking/status](#operation/bookingStatus), but provides slightly less detail and can be called more frequently |\n\n#### Cancellation endpoints\n\n| Endpoint | Use |\n|-|-|\n| [/bookings/{booking-reference}/cancel-quote](#operation/bookingQuote) | Returns the expected outcome of a booking cancellation request (taking into consideration the product's cancellation policy) were the cancellation request performed immediately |\n| [/bookings/{booking-reference}/cancel](#operation/cancelBooking) | Cancels the booking and assigns a refund depending on the product’s cancellation policy |\n\n### Auxiliary services\n\nTaxonomical data sets are required to interact meaningfully with the Viator Partner API; for example, mappings from destination (location of operation) to their respective identification codes. This information may occasionally change or be added to. Consequently, the API includes endpoints that return the most up-to-date versions of this information.\n\n#### Taxonomy endpoints\n\n| Endpoint | Use |\n|-|-|\n| [/taxonomy/destinations](#operation/taxonomyDestinations) | Retrieves a list of destination names, types and unique identifiers to be used when interacting with the Viator Partner API |\n| [/taxonomy/categories](#operation/taxonomyCategories) | Retrieves a list of product categories for a destination that can be used as a means of filtering when searching for products using the [/search/products](#operation/searchProducts) endpoint |\n| [/taxonomy/attractions](#operation/taxonomyAttractions) | Retrieves a list of tourist attractions (e.g., the Eiffel Tower or Empire State Building) and their associated identification codes to be used as a means of searching for available products; for example, in the [/search/products](#operation/searchProducts) service |\n| [/booking/hotels](#operation/bookingHotels) | Retrieves a list of hotels, including names and geographic locations, to be used when making booking requests |\n\n---\n\n# Authentication\n\n**Note**:\n\n- The authentication mechanism for this API has been updated recently. Now, partners can also authenticate using a [new style of API key](#section/Authentication/exp-api-key) that is included in each call as a <u>header parameter</u>. Previously, authentication was accomplished by including an API key as a query parameter.\n\n- Partners who are currently authenticating via the [API key query parameter](#section/Authentication/Legacy-API-keys) can continue to authenticate in this way; however, access to the new booking cancellation endpoints ([/bookings/cancel-reasons](#operation/cancellationReasons), [/bookings/cancel-quote](#operation/cancelBookingQuote) and [/bookings/cancel](#operation/cancelBooking)) does require the new-style of API key. All other endpoints remain compatible with both authentication methods.\n\n- If you would like to switch to the [new style of key](#section/Authentication/exp-api-key), please speak to your business development account manager.\n\n## API key\n\nAccess to the API is managed using an **API key** that is included as a **header parameter** to every call made to all API endpoints described in this document.\n\n| Header parameter name | Example value |\n|-----------------------|---------------|\n| exp-api-key | bcac8986-4c33-4fa0-ad3f-75409487026c |\n\nIf you do not know the API key for your organization, please contact your business development account manager for these details.\n\nPlease note that language localization is now controlled on a per-call basis. Previously, language localization was controlled via API-key configuration, with one language available per API key. Under the present scheme, you can access any language enabled for your organization's point of sale via a **single API key**. \n\nLanguage selection is accomplished by specifying the desired language as a header parameter (`Accept-Language`). See [Accept-Language header](#section/Appendices/Accept-Language-header) for available language codes. If you would like access to additional languages, please contact your business development account manager.\n\n## Legacy API key\n\nPreviously, authenticating to this API was accomplished by passing an API-key **as a query parameter** appended to the URI for each call; e.g.:\n\n```html\nGET https://viatorapi.sandbox.viator.com/service/taxonomy/destinations?apiKey=xxxxxxxxxxxxxxxxxx\n```\n\nThis method of authentication remains available for backwards-compatibility with existing implementations. If you would like to upgrade to the new style of API key, please contact your business development account manager. \n\n# Key concepts\n\n## Content ingestion and caching strategy\n\nMuch of the information you will need to retrieve from the Viator API – such as the taxonomy, product lists and product details – do not change frequently.\n\nTherefore, we recommend implementing a caching strategy in order to eliminate unnecessary traffic to Viator’s servers and improve the operation of your site. \n\nThis section discusses the different strategies for retrieving and caching Viator’s product catalogue.\n\nYou will need to decide on how you will retrieve and manage content from Viator’s product catalogue. The two main options are as follows:\n\n### 1. API response caching\n\n*Partners retrieve content as-needed and cache responses on a service-by-service basis*\n\nIf you do not need to store product details locally, we recommend performing caching of on a service-by-service basis; i.e., storing the entire response and applying a time-to-live (TTL) of less than 24 hours.\n\n#### Benefits of API response caching\n\n* All the benefits of caching with minimal overhead\n* Minimal risk of serving stale or invalid data cached on the partner's side\n* No need to download data about products that are not selling\n* A smaller volume of local data improves cache hit performance\n* Fewer requests made of Viator's systems\n* Avoids rate limitations\n* Closer adherence to best practices\n* Removes need to manage a complex data structure locally\n\n#### Service endpoints to cache\n\nCaching should only be applied to services that yield infrequently changing data; i.e.:\n\n* [/taxonomy/destinations](](#operation/taxonomyDestinations)\n* [/taxonomy/categories](#operation/taxonomyCategories)\n* [/taxonomy/attractions](#operation/taxonomyAttractions)\n* [/search/products](#operation/searchProducts)\n* [/search/products/codes](#operation/searchProductsCodes)\n* [/search/freetext](#operation/searchFreetext)\n* [/product](#operation/product)\n* [/product/reviews](#operation/productReviews)\n* [/product/photos](#operation/productPhotos)\n* [/available/products](#operation/availableProducts)\n\n**Note**: these services should be considered cacheable even though some are POST and none include a Cache-Control HTTP header in their response.\n\n### 2. Periodic content ingestion\n\n*Partners download either the full product catalogue or a subset of the catalogue at regular intervals based on destination, linked attraction, or product category filters.*\n\n#### Who should use periodic ingestion\nThis approach may be preferable for partners whose requirements include:\n* **System agnosticism/data centralization** – i.e., partners who are simultaneously selling products from vendors other than Viator, have existing product databases or are likely to want to maintain a central product catalogue with a unified taxonomy / data structure\n* **Enhanced search capability** – i.e., the ability to apply different categorization rules, filters, exclusions or search optimizations to the product catalogue; e.g., grouping or filtering products according to criteria other than those supported directly by the Viator API (destination, attraction-link or category)\n\n#### Frequency of content ingestion\nWe recommend that you perform an ingestion of the product catalogue once every 24 hours.\n\n#### How to retrieve product codes\n\nMake a call to one of the product search services:\n\n* [/search/products](#operation/searchProducts) – to search by `destId` (destination), `catId` (category), `subCatId` (subcategory) or `seoId` (attraction)\n* [/search/freetext](#operation/searchFreetext) – free-text search across all identifying fields \n\n#### How to retrieve all products in the catalogue\n\nTo retrieve all products from the Viator catalogue:\n\n* Retrieve all available destination identifiers (`destId`) from the [/taxonomy/destinations](#operation/taxonomyDestinations) service\n* Iterate through the complete list of `destId`s you retrieved in the previous step, and call [/search/products](#operation/searchProducts) for each `destId`\n\n**Note**: As some products operate in multiple destinations, the same product code may be returned for a range of different destinations. Therefore, make sure your list of product codes only contains one copy of each code.\n\nYou may then iterate through this list of product codes to retrieve any other product details necessary in order to properly populate your local database with the information you require.\n\n#### Retrieving a subsection of the product catalogue\n\nYou may wish to retrieve only some of the products available in the Viator catalogue; for example, if your organization is only interested in selling products that operate locally.\n\nYour top level search using [/search/products](#operation/searchProducts) is restricted to one of the three main categorization methods for products; i.e., destination, category/subcategory, or attraction-link; however, you may employ your own methods to filter the selection of products based on any attribute in the product data structure.\n\n#### Dealing with pagination using `totalCount` and `topX`\n\nDue to the large number of results that can be returned by the [/search/products](#operation/searchProducts) service, the request might exceed the 30-second time-out limitation on both sandbox and live servers. Therefore, you will need to make multiple requests to this service including pagination information in order to retrieve all products that match your search criteria.\n\nThis is accomplished by sequentially requesting successive segments of the results using the `topX` request parameter together with the `totalCount` response field; i.e.:\n\n* For your first request, specify a `topX` of `\"1-100\"`\n - **Note**: this range is *inclusive*; i.e., `\"topX\": 1-100\"` will yield the first 100 records \n* The first response will indicate the total number of records available through the value of the `totalCount` field in the response object; e.g.: `\"totalCount\": 13843`\n* For each subsequent request, specify the next logical 'chunk' of data via the `topX` parameter of the request; e.g.:\n - \"topX\": \"1-100\"\n - \"topX\": \"101-200\"\n - ...\n - \"topX\": \"13801-13843\"\n\n#### Rate limiting\n\nDue to the heavy load that pre-caching can place on Viator's servers and the downstream servers we connect to, we apply a rate limit of **150 requests per 10 second time window**.\n\nRequest rates exceeding this limit will result in a **HTTP 429 (Too Many Requests)** status code being returned.\n\n**Note**: The rate is calculated over a rolling 10-second time window\n\n* In order to avoid running-up against rate limits:\n - insert a delay of 2s if you receive a HTTP 429 status code\n - do not run this as a multi-threaded process\n\n## Categorization of content\n\nThe products available in Viator’s catalogue are mainly categorized according to:\n\n1. **Destination**: every product in the Viator catalogue is categorized according to the destination/locale in which it operates. There are three kinds of destination:\n<table>\n <thead>\n <th>Destination type</th>\n <th>Meaning</th>\n </thead>\n <tbody>\n <tr>\n <td>“COUNTRY”</td>\n <td>A country; e.g., “Australia”, “Japan”, “USA”</td>\n </tr>\n <tr>\n <td>\"REGION\"</td>\n <td>A geographical region or state; e.g., “South Australia”, “French Riviera”, “Punjab”</td>\n </tr>\n <tr>\n <td>\"CITY\"</td>\n <td>A city within a state; e.g., “Townsville”, “Osaka”, “Singapore”</td>\n </tr>\n </tbody>\n</table>\n<table>\n <thead>\n <tr>\n <th><code>destinationName</code></th>\n <th><code>destId</code></th>\n <th><code>destinationType</code></th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <td>USA</td>\n <td>77</td>\n <td>COUNTRY</td>\n </tr>\n <tr>\n <td>Wisconsin</td>\n <td>22231</td>\n <td>REGION</td>\n </tr>\n <tr>\n <td>Madison</td>\n <td>24146</td>\n <td>CITY</td>\n </tr>\n <tr>\n <td>France</td>\n <td>51</td>\n <td>COUNTRY</td>\n </tr>\n <tr>\n <td>Brittany</td>\n <td>21942</td>\n <td>REGION</td>\n </tr>\n <tr>\n <td>Rennes</td>\n <td>21943</td>\n <td>CITY</td>\n </tr>\n </tbody>\n</table>\n\n1. **Category and subcategory**: the products in the Viator catalogue are grouped according to the kind of activity they entail and may be subcategorized further to provide greater specificity; for example:\n<table>\n <thead>\n <tr>\n <th>Category</th>\n <th>Subcategories</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <td rowspan=3>Air, Helicopter & Balloon Tours</td>\n <td>Air Tours</td>\n </tr>\n <tr>\n <td>Helicopter Tours</td>\n </tr>\n <tr>\n <td>Balloon Rides</td>\n </tr>\n <tr>\n <td rowspan=2>Weddings & Honeymoons</td>\n <td>Wedding Packages</td>\n </tr>\n <tr>\n <td>Honeymoon Packages</td>\n </tr>\n </tbody>\n</table>\n1. **Attraction link** (i.e., association to a particular \"point of interest\"); e.g.:\n<table>\n <thead>\n <tr>\n <th>Attraction</th>\n <th>`seoId`</th>\n <tr>\n </thead>\n <tbody>\n <tr>\n <td>Bellagio Fountains</td>\n <td>1243</td>\n </tr>\n <tr>\n <td>Black Canyon</td>\n <td>4437</td>\n </tr>\n <tr>\n <td>Epcot Centre</td>\n <td>1141</td>\n </tr>\n </tbody>\n</table>\n\n\n## Booking concepts\n\n### Booking types - *on-request* and *freesale*\n\nBookings made with Viator can be either *freesale* (immediate confirmation) or *on-request*, which require us to confirm with our product supplier that the product has not sold out and is still available. This difference must be clearly communicated to the customer during the price check and on the *order summary* post-purchase page.\n\nFor *freesale* bookings, the voucher becomes available immediately, and the customer's credit card will be charged at the time of booking. For *on-request* bookings, confirmation will be sent to the customer within a timeframe supplied in the [/booking/calculateprice](#operation/bookingCalculateprice) and [/booking](#operation/bookingBook) service responses.\n\nThe customer's credit card will be charged once their *on-request* booking is confirmed.\n\n### bookingEngineId\n\n`bookingEngineId` is a field returned in the responses from several endpoints documented in this manual. It is a **booking type specifier** indicating whether, when the product in question is booked, the booking will be `CONFIRMED` immediately or if it will remain `PENDING` even after the booking has been made, indicating that it is an on-request product.\n\n`bookingEngineId` takes *one of* the following values:\n\n - `\"FreesaleBE\"` – the product will be confirmed immediately and the supplier will be sent a notification.\n\n - `\"UnconditionalBE\"` - the product will be confirmed immediately and the supplier will not be notified.\n\n - `\"DeferredCRMBE\"` - the product is an on-request product and the booking will not be confirmed immediately. The booking will remain with a `PENDING` status after it is made, to be confirmed by the supplier within the time specified in the `hoursConfirmed` field available in the booking response and post-booking services.\n\n - `\"FreesaleOnRequestBE\"` - The product is freesale up until a certain number of days before the travel date, after which it becomes on-request. It is then referred to as being within the *on-request period*. If a booking is made within the on-request period, the product can be considered to be an on-request product. Once the booking has been made, the `bookingEngineId` will change to either `\"FreesaleOnRequestBE:OnRequest\"` or `\"FreesaleOnRequestBE:Freesold\"` depending on the travel date and the on-request period. \n\n### Tour grades\n\nProducts can have one or more *tour grades*. Each tour grade might represent a departure time or different tour option, such as additional meals, transport and so forth. If the tour grade code is `\"DEFAULT\"`, *do not* display this to the customer, simply hide the product's tour grade information.\n\n### Language options\n\nMany tours deliver a commentary in multiple languages using multilingual tour guides or with written or prerecorded information. Where available, the customer can preselect their preferred language option.\n\n### Traveler mix (pax)\n\nSome tour grades have defined traveler mixes used to price family passes; or, they might have special mixes for limited passenger tours, such as small buggies or weddings.\n\nThese traveler mixes are provided by the [/booking/availability/tourgrades](#operation/bookingAvailabilityTourgrades) service. You may need to display these to your customers so that they are able to understand why they can or cannot select a particular tour grade if there is a traveler mix mismatch.\n\n### Pick-up location and hotel lists\n\nSome products have pick-up and return shuttle bus services. For these tours, you will need the customer to supply a pick-up hotel, or they must select *live locally* or *hotel not yet booked* options.\n\nViator maintains pick-up hotel lists for many popular destinations. These lists are available for customers to select their pick-up location for various tours. For destinations without hotel lists, customers can enter the name of their hotel. If a customer's hotel is not listed, they should be able to enter a hotel name; however, pick-up may not be possible for that hotel.\n\n### Lead traveler\n\nEach tour booking requires a lead traveler to be identified. To identify the lead traveler in your request, set the `leadTraveller` flag to `true` in the traveler class.\n\n### Booking questions\n\nSome products have a list of one or more [booking questions](#section/Appendices/Booking-questions) that need to be asked. Some are mandatory. The question, a description, etc are provided in the product details object. The answers need to be included with the booking request.\n\n### SSL/HTTPS\n\nCalls to the [/booking/book](#operation/bookingBook) service *must* use a secure channel (https) as they contain credit card information.\n\n### Promo codes\n\nViator can create promotional (promo) codes for discounts and other purposes. As it's unlikely for you to wish to support this feature, we recommend supplying `null` in the `promoCode` field and not including any customer-entered fields during the checkout process.\n\n### Partner data\n\nPartners can also supply additional information for their own internal purposes. These are attached to booking reports and other materials for use in allocating commissions to agents and so forth.\n\n## Availability services\n\nProduct availability information can be retrieved with the following services:\n\n- [/booking/availability](#operation/bookingAvailability): get the tourgrade with the lowest price available on a day\n- [/booking/availability/dates](#operation/bookingAvailabilityDates): get all available dates for a product excluding days it does not operate and blockouts\n- [/booking/availability/tourgrades](#operation/bookingAvailabilityTourgrades): list all available tour grades for a specific day\n- [/booking/availability/tourgrades/pricingmatrix](#operation/bookingAvailabilityTourgradesPricingmatrix): returns available days only (ie days which have at least one tour grade available), and the pricing matrix for that tour grade on that day\n\n### Example: multiple departures in a single day\n\nMultiple departures in a single day (each represented by a tour grade) and the language options (langServices).\n\nThis request is for 3 adults on a helicopter tour:\n- **Note:** No prices are returned if the tour grade is unavailable.\n\n**Request object** ([/booking/availability/tourgrades](#operation/bookingAvailabilityTourgrades)):\n\n```javascript\n{\n \"productCode\": \"2280AAHT\",\n \"bookingDate\": \"2013-05-11\",\n \"currencyCode\": \"EUR\",\n \"ageBands\": [{\n \"bandId\": 1,\n \"count\": 3\n }]\n}\n```\n\n**Response object** ([/booking/availability/tourgrades](#operation/bookingAvailabilityTourgrades))\n:\n\n```javascript\n{\n \"data\": [{\n \"available\": false,\n \"ageBands\": null,\n \"langServices\": null,\n \"gradeCode\": \"EARLYM\",\n \"unavailableReason\": \"BOOKING_CUTOFF_EXPIRED\",\n \"gradeTitle\": \"Early Morning Departure\",\n \"gradeDepartureTime\": \"\",\n \"gradeDescription\": \"Flight departs Las Vegas between 7am & 8am\",\n \"defaultLanguageCode\": \"en\",\n \"ageBandsRequired\": null,\n \"currencyCode\": \"ERROR\",\n \"retailPrice\": 0,\n \"bookingDate\": \"2013-05-11\",\n \"retailPriceFormatted\": \"\",\n \"merchantNetPrice\": 0,\n \"merchantNetPriceFormatted\": \"\",\n \"sortOrder\": 1\n },\n {\n \"available\": false,\n \"ageBands\": null,\n \"langServices\": null,\n \"gradeCode\": \"LATEM\",\n \"unavailableReason\": \"BOOKING_CUTOFF_EXPIRED\",\n \"gradeTitle\": \"Late Morning Departure\",\n \"gradeDepartureTime\": \"\",\n \"gradeDescription\": \"Flight departs Las Vegas between 9:45am & 10:45am\",\n \"defaultLanguageCode\": \"en\",\n \"ageBandsRequired\": null,\n \"currencyCode\": \"ERROR\",\n \"retailPrice\": 0,\n \"bookingDate\": \"2013-05-11\",\n \"retailPriceFormatted\": \"\",\n \"merchantNetPrice\": 0,\n \"merchantNetPriceFormatted\": \"\",\n \"sortOrder\": 2\n },\n {\n \"available\": false,\n \"ageBands\": null,\n \"langServices\": null,\n \"gradeCode\": \"EARLYA\",\n \"unavailableReason\": \"BOOKING_CUTOFF_EXPIRED\",\n \"gradeTitle\": \"Early Afternoon Departure\",\n \"gradeDepartureTime\": \"2:50 PM\",\n \"gradeDescription\": \"Flight departs Las Vegas between 12:30pm & 1:30pm\",\n \"defaultLanguageCode\": \"en\",\n \"ageBandsRequired\": null,\n \"currencyCode\": \"ERROR\",\n \"retailPrice\": 0,\n \"bookingDate\": \"2013-05-11\",\n \"retailPriceFormatted\": \"\",\n \"merchantNetPrice\": 0,\n \"merchantNetPriceFormatted\": \"\",\n \"sortOrder\": 3\n },\n {\n \"available\": false,\n \"ageBands\": null,\n \"langServices\": null,\n \"gradeCode\": \"LATEA\",\n \"unavailableReason\": \"BOOKING_CUTOFF_EXPIRED\",\n \"gradeTitle\": \"Late Afternoon Departure\",\n \"gradeDepartureTime\": \"\",\n \"gradeDescription\": \"Flight departs Las Vegas between 3:15pm & 4:15pm; available Ap\",\n \"defaultLanguageCode\": \"en\",\n \"ageBandsRequired\": null,\n \"currencyCode\": \"ERROR\",\n \"retailPrice\": 0,\n \"bookingDate\": \"2013-05-11\",\n \"retailPriceFormatted\": \"\",\n \"merchantNetPrice\": 0,\n \"merchantNetPriceFormatted\": \"\",\n \"sortOrder\": 4\n }],\n \"vmid\": \"221001\",\n \"errorMessage\": null,\n \"errorType\": null,\n \"dateStamp\": \"2013-06-04T17:01:34+0000\",\n \"totalCount\": 1,\n \"errorReference\": null,\n \"errorMessageText\": null,\n \"success\": true,\n \"errorName\": null\n}\n```\n\n### Example: traveler mix mismatch\n\nThe request is for five adults, but this product only support up to four adults.\n\n**Example request object** ([/booking/availability/tourgrades](#operation/bookingAvailabilityTourgrades)):\n```javascript\n{\n \"productCode\": \"2280ULTWED\",\n \"bookingDate\": \"2013-12-11\",\n \"currencyCode\": \"EUR\",\n \"ageBands\": [{\n \"bandId\": 1,\n \"count\": 5\n }]\n}\n```\n\n**Example response object**\nThe response contains `\"TRAVELLER_MISMATCH\"` and you can see the `ageBandsRequired` values for the adult (1) age band in the available tour grade.\n\n```javascript\n{\n \"data\": [{\n \"available\": false,\n \"ageBands\": null,\n \"langServices\": null,\n \"gradeCode\": \"DEFAULT\",\n \"unavailableReason\": \"TRAVELLER_MISMATCH\",\n \"gradeTitle\": \"DEFAULT\",\n \"gradeDepartureTime\": \"12:00 AM\",\n \"gradeDescription\": \"DEFAULT\",\n \"defaultLanguageCode\": \"en\",\n \"ageBandsRequired\": [\n [{\n \"bandId\": 1,\n \"minimumCountRequired\": 2,\n \"maximumCountRequired\": 2\n }],\n [{\n \"bandId\": 1,\n \"minimumCountRequired\": 3,\n \"maximumCountRequired\": 3\n }],\n [{\n \"bandId\": 1,\n \"minimumCountRequired\": 4,\n \"maximumCountRequired\": 4\n }]],\n \"currencyCode\": \"ERROR\",\n \"retailPrice\": 0,\n \"bookingDate\": \"2013-12-11\",\n \"retailPriceFormatted\": \"\",\n \"merchantNetPrice\": 0,\n \"merchantNetPriceFormatted\": \"\",\n \"sortOrder\": 1\n }],\n \"vmid\": \"221001\",\n \"errorMessage\": null,\n \"errorType\": null,\n \"dateStamp\": \"2013-06-04T17:02:35+0000\",\n \"totalCount\": 1,\n \"errorReference\": null,\n \"errorMessageText\": null,\n \"success\": true,\n \"errorName\": null\n}\n```\n\n## Understanding the pricingUnit field\n\nThis section explains the meaning and function of the `pricingUnit` field in the response object received from the [/booking/availability/tourgrades/pricingmatrix](#operation/bookingAvailabilityTourgradesPricingmatrix) service.\n\n### Request body\nThe [/booking/availability/tourgrades/pricingmatrix](#operation/bookingAvailabilityTourgradesPricingmatrix) service takes the following parameters as input in its request body:\n\n| Parameter | Type | Meaning |\n|-----------|------|---------|\n| `productCode` | string | unique alphanumeric identifier of the product to enquire about; e.g., `10040WORLD` |\n| `month` | string | **month** of the year by which to filter results |\n| `year` | string | **year** by which to filter results |\n| `currencyCode` | string | **currency code** for the currency in which to display pricing information |\n\n#### Example request body\n\nSending the following request body to the [/booking/availability/tourgrades/pricingmatrix](#operation/bookingAvailabilityTourgradesPricingmatrix) service will retrieve pricing information for \"Skip the Line: World of Discoveries Entrance Ticket in Porto\" (product code: 10040WORLD).\n\n```javascript\n{\n \"productCode\": \"10040WORLD\",\n \"currencyCode\": \"USD\",\n \"month\": \"06\",\n \"year\": \"2019\"\n}\n```\n\n### Response object\n\nWithin each object item of the `tourGrades` array – each of which gives the pricing details for a specific tour grade – is a `pricingMatrix` array. Each object in this array details the per-age-band pricing for a specific pricing unit (`pricingUnit`) associated with that product.\n\nUsing this information, you should be able to calculate the total cost of the booking – considering any booking options – with regard to the number of participants.\n\nHow to identify the fundamental unit prices for a booking, which are then summed in order to calculate a total price, is detailed below.\n\nNote that in the response object received from the service, pricing schedules are organized hierarchically as follows:\n\n```c\nbookingDate\n--tourGrade\n----ageBand\n------price\n```\n\n### Types of pricing unit\nThere are two fundamental types of pricing unit – **per-person** and **per-group**.\n\n#### Per-person pricing schedule\nIf the pricing is *per-person*, then the total price of the booking will be directly proportional to the number of participants (passengers) of each type that are booking the product; i.e., a direct multiple of the per-person price.\n\nThe only pricing unit specifier for *per-person* pricing is “per person”, given in the `pricingUnit` field; i.e.:\n\n- `\"pricingUnit\": \"per person\"`\n\n| Pricing unit | Example product | Meaning |\n|--------------|---------|---------|\n| `\"per person\"` | **10040WORLD** | **Per-person pricing** – the unit price refers to the price for an individual participant.<br />Some products have tiered pricing arrangements; i.e., a different per-person price can apply if certain numbers and combinations of participants in a particular age band are booking the product; e.g.:<br /><ul><li>**1-2 adults**: $50 per person</li><li>**3-4 adults**: $45 per person</li></ul><br />Whether a range is available to be booked depends on whether the customer’s desired passenger mix satisfies the `minimumCountRequired` and `maximumCountRequired` fields in each item of the `ageBandPrices` array. |\n\n#### Per-group pricing\nIf the pricing is per-group, then the total price of the booking will depend on the number of groups and types of group that ideally accommodate the participant mix.\n\nThe following pricing schedules follow “per-group” logic:\n\n- `\"pricingUnit\": \"per vehicle\"`\n- `\"pricingUnit\": \"per car\"`\n- `\"pricingUnit\": \"per group\"`\n- `\"pricingUnit\": \"per boat\"`\n- `\"pricingUnit\": \"per package\"`\n- `\"pricingUnit\": \"per jetski\"`\n- `\"pricingUnit\": \"per vessel\"`\n- `\"pricingUnit\": \"per helicopter\"`\n- `\"pricingUnit\": \"per room\"`\n- `\"pricingUnit\": \"per bike\"`\n- `\"pricingUnit\": \"per flight\"`\n- `\"pricingUnit\": \"per plane\"`\n- `\"pricingUnit\": \"per couple\"`\n\nEligibility for a certain individual pricing schedule; or, for inclusion in a particular group type, depends on the tour grade for the product, the type of participant (e.g., the age-band they fall into) and the date of the booking.\n\n#### Group pricing schedules\n\n| Pricing unit | Example product | Meaning |\n|---------------|-----------|---------|\n| `\"per group\"` | **10847P42** | **Per-group** pricing – the unit price is calculated according to the number of groups the specified passenger will fit into rather than the exact number of participants. `minimumCountRequired` and `maximumCountRequired` must be considered as these fields relate to the available group sizes. |\n| `\"per room\"` | **6279P26** | **Per-room** pricing relates the room price, which depends on the number of participants making the booking. |\n| `\"per package\"` | **25941P70** | **Per-package** pricing refers to products that are sold as part of a package; for example a family package stipulating a passenger mix of two adults and two children |\n| `\"per vehicle\"` | **6154SHOP** | **Per-vehicle** pricing is calculated according to the number of vehicles required for the specified passenger mix rather than the exact number of participants. `minimumCountRequired` and `maximumCountRequired` must be considered as these fields relate to the occupancy limitations for each vehicle. The minimum price will depend on the rate for a single vehicle. |\n| `\"per car\"` | **10175P10** | **Per-car** pricing – identical to \"per vehicle\", but refers specifically to vehicles that are cars. |\n| `\"per boat\"` | **11121P40** | **Per-boat** pricing – identical to \"per vehicle\", but refers specifically to vehicles that are boats. |\n| `\"per jetski\"` | **28965P127** | **Per-jetski** pricing – identical to \"per vehicle\", but refers specifically to vehicles that are jet-skis. |\n| `\"per vessel\"` | **17295P24** | **Per-vessel** pricing – identical to \"per vehicle\", but refers specifically to maritime vessels that are not strictly boats. |\n| `\"per helicopter\"` | **12189P23** | **Per-helicopter** pricing – identical to \"per vehicle\", but refers specifically to vehicles that are helicopters. |\n| `\"per bike\"` | **17448P8** | **Per-bike** pricing – identical to \"per vehicle\", but refers specifically to vehicles that are bikes. |\n| `\"per flight\"` | **28965P134** | **Per-flight** pricing – identical to \"per vehicle\", but refers specifically to the act of being aboard a flying vehicle. |\n| `\"per plane\"` | **14876P5** | **Per-plane** pricing – identical to \"per vehicle\", but refers specifically to vehicles that are aeroplanes. |\n\n### Interpreting response objects by example\n\nIn this section, we’ll have a look at snippets from the response objects received from the [/booking/availability/tourgrades/pricingmatrix](#operation/bookingAvailabilityTourgradesPricingmatrix) service and interpret the results.\n\n#### Per-person pricing\n##### Request object\n```javascript\n{\n \"productCode\": \"10040WORLD\",\n \"currencyCode\": \"USD\",\n \"month\": \"06\",\n \"year\": \"2019\"\n}\n```\n#### Response snippet\n\n**Note:** `pricingMatrix` is an array of objects that detail the available pricing schedules for the product:\n\n```javascript\n\"pricingMatrix\": [\n {\n \"sortOrder\": 1,\n \"pricingUnit\": \"per person\",\n \"bookingDate\": \"2019-06-01\",\n \"ageBandPrices\": [\n {\n \"bandId\": 1,\n \"prices\": [\n {\n \"sortOrder\": 1,\n \"currencyCode\": \"USD\",\n \"price\": 13.85,\n \"priceFormatted\": \"$13.85\",\n \"merchantNetPrice\": 11.05,\n \"merchantNetPriceFormatted\": \"$11.05\",\n \"minNoOfTravellersRequiredForPrice\": 1\n }\n ],\n \"sortOrder\": 1,\n \"minimumCountRequired\": 0,\n \"maximumCountRequired\": 15\n },\n {\n \"bandId\": 2,\n \"prices\": [\n {\n \"sortOrder\": 1,\n \"currencyCode\": \"USD\",\n \"price\": 6.92,\n \"priceFormatted\": \"$6.92\",\n \"merchantNetPrice\": 5.53,\n \"merchantNetPriceFormatted\": \"$5.53\",\n \"minNoOfTravellersRequiredForPrice\": 1\n }\n ],\n \"sortOrder\": 2,\n \"minimumCountRequired\": 0,\n \"maximumCountRequired\": 15\n },\n {\n \"bandId\": 3,\n \"prices\": [\n {\n \"sortOrder\": 1,\n \"currencyCode\": \"USD\",\n \"price\": 0,\n \"priceFormatted\": \"$0.00\",\n \"merchantNetPrice\": 0,\n \"merchantNetPriceFormatted\": \"$0.00\",\n \"minNoOfTravellersRequiredForPrice\": 1\n }\n ],\n \"sortOrder\": 3,\n \"minimumCountRequired\": 0,\n \"maximumCountRequired\": 15\n },\n {\n \"bandId\": 5,\n \"prices\": [\n {\n \"sortOrder\": 1,\n \"currencyCode\": \"USD\",\n \"price\": 10.39,\n \"priceFormatted\": \"$10.39\",\n \"merchantNetPrice\": 8.3,\n \"merchantNetPriceFormatted\": \"$8.30\",\n \"minNoOfTravellersRequiredForPrice\": 1\n }\n ],\n \"sortOrder\": 4,\n \"minimumCountRequired\": 0,\n \"maximumCountRequired\": 15\n }\n ]\n }\n]\n```\n\nIn this example, four age bands (1, 2, 3 and 5) have pricing information available. These numerically-identified age bands are the age bands allowed to book the product. Details of the age ranges that the product operator has defined are available from the **/product** service.\n\nA call to **/product** regarding `10040WORLD` yields the following information:\n\n```javascript\n\"ageBands\": [\n {\n \"sortOrder\": 1,\n \"ageFrom\": 13,\n \"ageTo\": 64,\n \"adult\": true,\n \"bandId\": 1,\n \"pluralDescription\": \"Adults\",\n \"treatAsAdult\": true,\n \"count\": 0,\n \"description\": \"Adult\"\n },\n {\n \"sortOrder\": 2,\n \"ageFrom\": 65,\n \"ageTo\": 99,\n \"adult\": false,\n \"bandId\": 5,\n \"pluralDescription\": \"Seniors\",\n \"treatAsAdult\": true,\n \"count\": 0,\n \"description\": \"Senior\"\n },\n {\n \"sortOrder\": 3,\n \"ageFrom\": 4,\n \"ageTo\": 12,\n \"adult\": false,\n \"bandId\": 2,\n \"pluralDescription\": \"Children\",\n \"treatAsAdult\": false,\n \"count\": 0,\n \"description\": \"Child\"\n },\n {\n \"sortOrder\": 4,\n \"ageFrom\": 0,\n \"ageTo\": 3,\n \"adult\": false,\n \"bandId\": 3,\n \"pluralDescription\": \"Infants\",\n \"treatAsAdult\": false,\n \"count\": 0,\n \"description\": \"Infant\"\n }\n```\n\nProduct operators choose the age bands available for their product from the following five categories and define the age ranges that pertain to each band; i.e.:\n\n| `bandId` | `description` |\n|:----------:|:-----------:|\n| **1** | Adult |\n| **2** | Child |\n| **3** | Infant |\n| **4** | Youth |\n| **5** | Senior |\n\nFor this product, the age bands have been defined as follows:\n\n| `bandId` | `description` | `ageFrom` | `ageTo` |\n|:--------:|:-----------:|:-------:|:-----:|\n| **1** | Adult | 13 | 64 |\n| **5** | Senior | 65 | 99 |\n| **2** | Child | 4 | 12 |\n| **3** | Infant | 0 | 3 |\n\nTherefore, for this product, the following pricing applies:\n\n| Passenger type | Number | Price |\n|----------------|:------:|-------|\n| **Adult** | 1-15 | $13.85 per person |\n| **Senior** | 1-15 | $10.39 per person |\n| **Child** | 1-15 | $6.92 per person |\n| **Infant** | 1-15 | free ($0) |\n\nPer-person pricing might depend on the mix of passengers booking the tour. In the following example (`5010SYDNEY`), a \"48 Hour Family Pass Ticket\" has a different price for children depending on how many are participating, which we'll see in the following snippet.\n\n##### Response snippet\n```javascript\n\"tourGrades\": [\n {\n \"sortOrder\": 1,\n \"gradeCode\": \"14HFAM\",\n \"gradeTitle\": \"48 Hour Family Pass Ticket\",\n \"pricingMatrix\": [\n {\n \"sortOrder\": 1,\n \"pricingUnit\": \"per person\",\n \"bookingDate\": \"2019-08-01\",\n \"ageBandPrices\": [\n {\n \"bandId\": 1,\n \"prices\": [\n {\n \"sortOrder\": 1,\n \"currencyCode\": \"USD\",\n \"price\": 133.47,\n \"minNoOfTravellersRequiredForPrice\": 1,\n \"priceFormatted\": \"$133.47\",\n \"merchantNetPrice\": 106.62,\n \"merchantNetPriceFormatted\": \"$106.62\"\n }\n ],\n \"sortOrder\": 1,\n \"minimumCountRequired\": 1,\n \"maximumCountRequired\": 1\n },\n {\n \"bandId\": 2,\n \"prices\": [\n {\n \"sortOrder\": 1,\n \"currencyCode\": \"USD\",\n \"price\": 0,\n \"minNoOfTravellersRequiredForPrice\": 1,\n \"priceFormatted\": \"$0.00\",\n \"merchantNetPrice\": 0,\n \"merchantNetPriceFormatted\": \"$0.00\"\n }\n ],\n \"sortOrder\": 2,\n \"minimumCountRequired\": 2,\n \"maximumCountRequired\": 2\n },\n {\n \"bandId\": 3,\n \"prices\": [\n {\n \"sortOrder\": 1,\n \"currencyCode\": \"USD\",\n \"price\": 0,\n \"minNoOfTravellersRequiredForPrice\": 1,\n \"priceFormatted\": \"$0.00\",\n \"merchantNetPrice\": 0,\n \"merchantNetPriceFormatted\": \"$0.00\"\n }\n ],\n \"sortOrder\": 3,\n \"minimumCountRequired\": 0,\n \"maximumCountRequired\": null\n }\n ]\n },\n {\n \"sortOrder\": 2,\n \"pricingUnit\": \"per person\",\n \"bookingDate\": \"2019-08-01\",\n \"ageBandPrices\": [\n {\n \"bandId\": 1,\n \"prices\": [\n {\n \"sortOrder\": 1,\n \"currencyCode\": \"USD\",\n \"price\": 133.47,\n \"minNoOfTravellersRequiredForPrice\": 1,\n \"priceFormatted\": \"$133.47\",\n \"merchantNetPrice\": 106.62,\n \"merchantNetPriceFormatted\": \"$106.62\"\n }\n ],\n \"sortOrder\": 1,\n \"minimumCountRequired\": 1,\n \"maximumCountRequired\": 1\n },\n {\n \"bandId\": 2,\n \"prices\": [\n {\n \"sortOrder\": 1,\n \"currencyCode\": \"USD\",\n \"price\": 3.71,\n \"minNoOfTravellersRequiredForPrice\": 1,\n \"priceFormatted\": \"$3.71\",\n \"merchantNetPrice\": 2.96,\n \"merchantNetPriceFormatted\": \"$2.96\"\n }\n ],\n \"sortOrder\": 2,\n \"minimumCountRequired\": 3,\n \"maximumCountRequired\": 4\n },\n {\n \"bandId\": 3,\n \"prices\": [\n {\n \"sortOrder\": 1,\n \"currencyCode\": \"USD\",\n \"price\": 0,\n \"minNoOfTravellersRequiredForPrice\": 1,\n \"priceFormatted\": \"$0.00\",\n \"merchantNetPrice\": 0,\n \"merchantNetPriceFormatted\": \"$0.00\"\n }\n ],\n \"sortOrder\": 3,\n \"minimumCountRequired\": 0,\n \"maximumCountRequired\": null\n }\n ]\n }\n ]\n },\n …\n]\n```\n\n##### Interpretation\n\nTo be eligible for a family pass ticket, the group must consist of an adult and at least two children.\n\n| Passenger mix | Adult price | Child price | Infant price |\n|---------------|:-----------:|:-----------:|:------------:|\n| 1 Adult +<br />1 Child | N/A | N/A | N/A |\n| 1 Adult +<br />2 Children +<br />Any infants | $133.47 | FREE | FREE |\n| 1 Adult +<br />3-4 Children +<br />Any infants | $133.47 | $3.71 | FREE |\n\n#### Tiered per-person pricing\n\nIn this example, we see a per-person pricing schedule with a tiered arrangement, where the per-person price decreases depending on how many people are booking the tour, but the total price is still calculated as the sum of the individual per-person prices rather than an overall 'group' price.\n\n##### Request object\n```javascript\n{\n \"productCode\": \"17972P102\",\n \"currencyCode\": \"USD\",\n \"month\": \"08\",\n \"year\": \"2019\"\n}\n```\n##### Response snippet\n\n```javascript\n\"tourGrades\": [\n {\n \"sortOrder\": 1,\n \"gradeCode\": \"TG1\",\n \"gradeTitle\": \"Arrival transfer\",\n \"pricingMatrix\": [\n {\n \"sortOrder\": 1,\n \"pricingUnit\": \"per person\",\n \"bookingDate\": \"2019-08-01\",\n \"ageBandPrices\": [\n {\n \"bandId\": 1,\n \"prices\": [\n {\n \"sortOrder\": 1,\n \"currencyCode\": \"USD\",\n \"price\": 52.45,\n \"priceFormatted\": \"$52.45\",\n \"merchantNetPrice\": 40.87,\n \"merchantNetPriceFormatted\": \"$40.87\",\n \"minNoOfTravellersRequiredForPrice\": 1\n }\n ],\n \"sortOrder\": 1,\n \"maximumCountRequired\": 1,\n \"minimumCountRequired\": 1\n }\n ]\n },\n {\n \"sortOrder\": 2,\n \"pricingUnit\": \"per person\",\n \"bookingDate\": \"2019-08-01\",\n \"ageBandPrices\": [\n {\n \"bandId\": 1,\n \"prices\": [\n {\n \"sortOrder\": 1,\n \"currencyCode\": \"USD\",\n \"price\": 26.22,\n \"priceFormatted\": \"$26.22\",\n \"merchantNetPrice\": 20.44,\n \"merchantNetPriceFormatted\": \"$20.44\",\n \"minNoOfTravellersRequiredForPrice\": 1\n }\n ],\n \"sortOrder\": 1,\n \"maximumCountRequired\": 2,\n \"minimumCountRequired\": 2\n }\n ]\n },\n {\n \"sortOrder\": 3,\n \"pricingUnit\": \"per person\",\n \"bookingDate\": \"2019-08-01\",\n \"ageBandPrices\": [\n {\n \"bandId\": 1,\n \"prices\": [\n {\n \"sortOrder\": 1,\n \"currencyCode\": \"USD\",\n \"price\": 17.91,\n \"priceFormatted\": \"$17.91\",\n \"merchantNetPrice\": 13.62,\n \"merchantNetPriceFormatted\": \"$13.62\",\n \"minNoOfTravellersRequiredForPrice\": 1\n }\n ],\n \"sortOrder\": 1,\n \"maximumCountRequired\": 3,\n \"minimumCountRequired\": 3\n }\n ]\n },\n {\n \"sortOrder\": 4,\n \"pricingUnit\": \"per person\",\n \"bookingDate\": \"2019-08-01\",\n \"ageBandPrices\": [\n {\n \"bandId\": 1,\n \"prices\": [\n {\n \"sortOrder\": 1,\n \"currencyCode\": \"USD\",\n \"price\": 19.19,\n \"priceFormatted\": \"$19.19\",\n \"merchantNetPrice\": 14.99,\n \"merchantNetPriceFormatted\": \"$14.99\",\n \"minNoOfTravellersRequiredForPrice\": 1\n }\n ],\n \"sortOrder\": 1,\n \"maximumCountRequired\": 4,\n \"minimumCountRequired\": 4\n }\n ]\n },\n {\n \"sortOrder\": 5,\n \"pricingUnit\": \"per person\",\n \"bookingDate\": \"2019-08-01\",\n \"ageBandPrices\": [\n {\n \"bandId\": 1,\n \"prices\": [\n {\n \"sortOrder\": 1,\n \"currencyCode\": \"USD\",\n \"price\": 15.35,\n \"priceFormatted\": \"$15.35\",\n \"merchantNetPrice\": 12.25,\n \"merchantNetPriceFormatted\": \"$12.25\",\n \"minNoOfTravellersRequiredForPrice\": 1\n }\n ],\n \"sortOrder\": 1,\n \"maximumCountRequired\": 5,\n \"minimumCountRequired\": 5\n }\n ]\n },\n {\n \"sortOrder\": 6,\n \"pricingUnit\": \"per person\",\n \"bookingDate\": \"2019-08-01\",\n \"ageBandPrices\": [\n {\n \"bandId\": 1,\n \"prices\": [\n {\n \"sortOrder\": 1,\n \"currencyCode\": \"USD\",\n \"price\": 12.66,\n \"priceFormatted\": \"$12.66\",\n \"merchantNetPrice\": 10.08,\n \"merchantNetPriceFormatted\": \"$10.08\",\n \"minNoOfTravellersRequiredForPrice\": 1\n }\n ],\n \"sortOrder\": 1,\n \"maximumCountRequired\": 6,\n \"minimumCountRequired\": 6\n }\n ]\n },\n {\n \"sortOrder\": 7,\n \"pricingUnit\": \"per person\",\n \"bookingDate\": \"2019-08-01\",\n \"ageBandPrices\": [\n {\n \"bandId\": 1,\n \"prices\": [\n {\n \"sortOrder\": 1,\n \"currencyCode\": \"USD\",\n \"price\": 10.94,\n \"priceFormatted\": \"$10.94\",\n \"merchantNetPrice\": 8.72,\n \"merchantNetPriceFormatted\": \"$8.72\",\n \"minNoOfTravellersRequiredForPrice\": 1\n }\n ],\n \"sortOrder\": 1,\n \"maximumCountRequired\": 7,\n \"minimumCountRequired\": 7\n }\n ]\n }\n ]\n }\n```\n\n##### Interpretation\n\n| Travelers | Per-person price | Total price |\n|:----------------:|:----------------:|:-----------:|\n| 1 | $52.45 | $52.45 |\n| 2 | $26.22 | $52.44 |\n| 3 | $17.91 | $53.73 |\n| 4 | $19.19 | $76.76 |\n| 5 | $15.35 | $76.75 |\n| 6 | $12.66 | $75.96 |\n| 7 | $10.94 | $76.58 |\n\n#### Per-group pricing\n##### Request object\n```javascript\n{\n \"productCode\": \"10847P42\",\n \"currencyCode\": \"USD\",\n \"month\": \"06\",\n \"year\": \"2019\"\n}\n```\n\n##### Response snippet\n\n```javascript\n\"pricingMatrix\": [\n {\n \"sortOrder\": 1,\n \"pricingUnit\": \"per group\",\n \"bookingDate\": \"2019-06-01\",\n \"ageBandPrices\": [\n {\n \"bandId\": 1,\n \"prices\": [\n {\n \"sortOrder\": 1,\n \"currencyCode\": \"USD\",\n \"price\": 390,\n \"minNoOfTravellersRequiredForPrice\": 1,\n \"priceFormatted\": \"$390.00\",\n \"merchantNetPrice\": 339.74,\n \"merchantNetPriceFormatted\": \"$339.74\"\n },\n {\n \"sortOrder\": 2,\n \"currencyCode\": \"USD\",\n \"price\": 390,\n \"minNoOfTravellersRequiredForPrice\": 2,\n \"priceFormatted\": \"$390.00\",\n \"merchantNetPrice\": 0,\n \"merchantNetPriceFormatted\": \"$0.00\"\n }\n ],\n \"sortOrder\": 1,\n \"minimumCountRequired\": 1,\n \"maximumCountRequired\": 10\n }\n ]\n }\n]\n```\n\n##### Interpretation\n\n- \"$390 per group of up to 10 adults\"\n\n#### Per-room pricing\n\n##### Request object\n```javascript\n{\n \"productCode\": \"100245P40\",\n \"currencyCode\": \"USD\",\n \"month\": \"08\",\n \"year\": \"2019\"\n}\n```\n##### Response snippet\n\n```javascript\n\"pricingMatrix\": [\n{\n \"sortOrder\": 1,\n \"pricingUnit\": \"per room\",\n \"bookingDate\": \"2019-08-01\",\n \"ageBandPrices\": [\n {\n \"bandId\": 1,\n \"prices\": [\n {\n \"sortOrder\": 1,\n \"currencyCode\": \"USD\",\n \"price\": 110,\n \"minNoOfTravellersRequiredForPrice\": 1,\n \"priceFormatted\": \"$110.00\",\n \"merchantNetPrice\": 95.85,\n \"merchantNetPriceFormatted\": \"$95.85\"\n },\n {\n \"sortOrder\": 2,\n \"currencyCode\": \"USD\",\n \"price\": 110,\n \"minNoOfTravellersRequiredForPrice\": 2,\n \"priceFormatted\": \"$110.00\",\n \"merchantNetPrice\": 0,\n \"merchantNetPriceFormatted\": \"$0.00\"\n }\n ],\n \"sortOrder\": 1,\n \"minimumCountRequired\": 1,\n \"maximumCountRequired\": 10\n }\n ]\n }\n]\n```\n\n##### Interpretation\n- \"$110 per group of up to 10 adults\"\n\n#### Per-package pricing\n\n##### Request object\n```javascript\n{\n \"productCode\": \"25941P70\",\n \"currencyCode\": \"USD\",\n \"month\": \"02\",\n \"year\": \"2019\"\n}\n```\n\n##### Response snippet\n```javascript\n\"pricingMatrix\": [\n {\n \"sortOrder\": 1,\n \"pricingUnit\": \"per package\",\n \"bookingDate\": \"2019-02-01\",\n \"ageBandPrices\": [\n {\n \"bandId\": 1,\n \"prices\": [\n {\n \"sortOrder\": 1,\n \"currencyCode\": \"USD\",\n \"price\": 87.7,\n \"minNoOfTravellersRequiredForPrice\": 1,\n \"priceFormatted\": \"$87.70\",\n \"merchantNetPrice\": 67.23,\n \"merchantNetPriceFormatted\": \"$67.23\"\n },\n {\n \"sortOrder\": 2,\n \"currencyCode\": \"USD\",\n \"price\": 87.7,\n \"minNoOfTravellersRequiredForPrice\": 2,\n \"priceFormatted\": \"$87.70\",\n \"merchantNetPrice\": 0,\n \"merchantNetPriceFormatted\": \"$0.00\"\n }\n ],\n \"sortOrder\": 1,\n \"minimumCountRequired\": 1,\n \"maximumCountRequired\": 10\n }\n ]\n }\n]\n```\n\n##### Interpretation\n- \"$87.70 per group of up to 10 adults\"\n\n#### Per-vehicle pricing\n\n##### Request object\n```javascript\n{\n \"productCode\": \"20190P4\",\n \"currencyCode\": \"USD\",\n \"month\": \"06\",\n \"year\": \"2019\"\n}\n```\n\n##### Response snippet\n```javascript\n\"pricingMatrix\": [\n {\n \"sortOrder\": 1,\n \"pricingUnit\": \"per vehicle\",\n \"bookingDate\": \"2019-06-01\",\n \"ageBandPrices\": [\n {\n \"bandId\": 1,\n \"prices\": [\n {\n \"sortOrder\": 1,\n \"currencyCode\": \"USD\",\n \"price\": 250,\n \"minNoOfTravellersRequiredForPrice\": 1,\n \"priceFormatted\": \"$250.00\",\n \"merchantNetPrice\": 186.38,\n \"merchantNetPriceFormatted\": \"$186.38\"\n },\n {\n \"sortOrder\": 2,\n \"currencyCode\": \"USD\",\n \"price\": 250,\n \"minNoOfTravellersRequiredForPrice\": 2,\n \"priceFormatted\": \"$250.00\",\n \"merchantNetPrice\": 0,\n \"merchantNetPriceFormatted\": \"$0.00\"\n }\n ],\n \"sortOrder\": 1,\n \"minimumCountRequired\": 1,\n \"maximumCountRequired\": 7\n }\n ]\n }\n]\n```\n\n##### Interpretation\n- \"$250 per group of up to 7 adults\"\n\n#### Per-car pricing\n##### Request object\n```javascript\n{\n \"productCode\": \"10175P10\",\n \"currencyCode\": \"USD\",\n \"month\": \"06\",\n \"year\": \"2019\"\n}\n```\n\n#### Response snippet\n\n```javascript\n\"pricingMatrix\": [\n {\n \"sortOrder\": 1,\n \"pricingUnit\": \"per car\",\n \"bookingDate\": \"2019-06-01\",\n \"ageBandPrices\": [\n {\n \"bandId\": 1,\n \"prices\": [\n {\n \"sortOrder\": 1,\n \"currencyCode\": \"USD\",\n \"price\": 98.08,\n \"priceFormatted\": \"$98.08\",\n \"merchantNetPrice\": 78.34,\n \"merchantNetPriceFormatted\": \"$78.34\",\n \"minNoOfTravellersRequiredForPrice\": 1\n },\n {\n \"sortOrder\": 2,\n \"currencyCode\": \"USD\",\n \"price\": 98.08,\n \"priceFormatted\": \"$98.08\",\n \"merchantNetPrice\": 0,\n \"merchantNetPriceFormatted\": \"$0.00\",\n \"minNoOfTravellersRequiredForPrice\": 2\n }\n ],\n \"sortOrder\": 1,\n \"minimumCountRequired\": 1,\n \"maximumCountRequired\": 3\n }\n ]\n }\n]\n```\n##### Interpretation\n- \"$98.08 per group of up to 3 adults\"\n\n#### Per-boat pricing\n##### Request object\n```javascript\n{\n \"productCode\": \"11121P40\",\n \"currencyCode\": \"USD\",\n \"month\": \"08\",\n \"year\": \"2018\"\n}\n```\n##### Response snippet\n\n```javascript\n\"pricingMatrix\": [\n {\n \"sortOrder\": 1,\n \"pricingUnit\": \"per boat\",\n \"bookingDate\": \"2018-06-01\",\n \"ageBandPrices\": [\n {\n \"bandId\": 1,\n \"prices\": [\n {\n \"sortOrder\": 1,\n \"currencyCode\": \"USD\",\n \"price\": 266.21,\n \"merchantNetPrice\": 226.81,\n \"merchantNetPriceFormatted\": \"$226.81\",\n \"priceFormatted\": \"$266.21\",\n \"minNoOfTravellersRequiredForPrice\": 1\n },\n {\n \"sortOrder\": 2,\n \"currencyCode\": \"USD\",\n \"price\": 266.21,\n \"merchantNetPrice\": 0,\n \"merchantNetPriceFormatted\": \"$0.00\",\n \"priceFormatted\": \"$266.21\",\n \"minNoOfTravellersRequiredForPrice\": 2\n }\n ],\n \"sortOrder\": 1,\n \"minimumCountRequired\": 1,\n \"maximumCountRequired\": 2\n }\n ]\n }\n]\n```\n\n##### Interpretation\n- \"$266.21 per group of up to 2 adults\"\n\n#### Per-jetski pricing\n##### Request object\n```javascript\n{\n \"productCode\": \"28965P127\",\n \"currencyCode\": \"USD\",\n \"month\": \"08\",\n \"year\": \"2018\"\n}\n```\n##### Response snippet\n```javascript\n\"tourGrades\": [\n {\n \"sortOrder\": 1,\n \"gradeCode\": \"TG1\",\n \"gradeTitle\": \"20 minutes for 1 person\",\n \"pricingMatrix\": [\n {\n \"sortOrder\": 1,\n \"pricingUnit\": \"per jetski\",\n \"bookingDate\": \"2018-06-01\",\n \"ageBandPrices\": [\n {\n \"bandId\": 1,\n \"prices\": [\n {\n \"sortOrder\": 1,\n \"currencyCode\": \"USD\",\n \"price\": 55.46,\n \"minNoOfTravellersRequiredForPrice\": 1,\n \"priceFormatted\": \"$55.46\",\n \"merchantNetPrice\": 47.25,\n \"merchantNetPriceFormatted\": \"$47.25\"\n }\n ],\n \"sortOrder\": 1,\n \"minimumCountRequired\": 1,\n \"maximumCountRequired\": 1\n }\n ]\n }\n ]\n },\n {\n \"sortOrder\": 2,\n \"gradeCode\": \"TG3\",\n \"gradeTitle\": \"20 minutes for 2 persons\",\n \"pricingMatrix\": [\n {\n \"sortOrder\": 1,\n \"pricingUnit\": \"per jetski\",\n \"bookingDate\": \"2018-06-01\",\n \"ageBandPrices\": [\n {\n \"bandId\": 1,\n \"prices\": [\n {\n \"sortOrder\": 1,\n \"currencyCode\": \"USD\",\n \"price\": 66.55,\n \"minNoOfTravellersRequiredForPrice\": 1,\n \"priceFormatted\": \"$66.55\",\n \"merchantNetPrice\": 56.7,\n \"merchantNetPriceFormatted\": \"$56.70\"\n },\n {\n \"sortOrder\": 2,\n \"currencyCode\": \"USD\",\n \"price\": 66.55,\n \"minNoOfTravellersRequiredForPrice\": 2,\n \"priceFormatted\": \"$66.55\",\n \"merchantNetPrice\": 0,\n \"merchantNetPriceFormatted\": \"$0.00\"\n }\n ],\n \"sortOrder\": 1,\n \"minimumCountRequired\": 1,\n \"maximumCountRequired\": 2\n }\n ]\n }\n ]\n }\n]\n```\n\n##### Interpretation\n\nThis example shows how group prices can differ according to the size of the group in question. In this case, two adults can ride together on a two-person jet ski, whereas a single adult requires his or her own jet ski, and therefore the unit price is slightly higher for the single adult.\n\n| Travelers | Vehicle type | Price per jet ski | Price per person |\n|:----------:|--------------|:-----------------:|:----------------:|\n| 1 | Single-person jet ski | $55.46 | $55.46 |\n| 2 | Two-person jet ski | $66.55 | $33.275 |\n\n#### Per-vessel pricing\n\n##### Request object\n\n```javascript\n{\n \"productCode\": \"17295P24\",\n \"currencyCode\": \"USD\",\n \"month\": \"06\",\n \"year\": \"2019\"\n}\n```\n\n##### Response snippet\n\n```javascript\n\"pricingMatrix\": [\n {\n \"sortOrder\": 1,\n \"pricingUnit\": \"per vessel\",\n \"bookingDate\": \"2019-06-01\",\n \"ageBandPrices\": [\n {\n \"bandId\": 1,\n \"prices\": [\n {\n \"sortOrder\": 1,\n \"currencyCode\": \"USD\",\n \"price\": 799,\n \"priceFormatted\": \"$799.00\",\n \"merchantNetPrice\": 680.75,\n \"merchantNetPriceFormatted\": \"$680.75\",\n \"minNoOfTravellersRequiredForPrice\": 1\n },\n {\n \"sortOrder\": 2,\n \"currencyCode\": \"USD\",\n \"price\": 799,\n \"priceFormatted\": \"$799.00\",\n \"merchantNetPrice\": 0,\n \"merchantNetPriceFormatted\": \"$0.00\",\n \"minNoOfTravellersRequiredForPrice\": 2\n }\n ],\n \"sortOrder\": 1,\n \"minimumCountRequired\": 1,\n \"maximumCountRequired\": 12\n }\n ]\n }\n]\n```\n\n##### Interpretation\n- \"$799.00 per group of up to 12 adults\"\n\n#### Per-helicopter pricing\n\n##### Request object\n\n```javascript\n{\n \"productCode\": \"12189P23\",\n \"currencyCode\": \"USD\",\n \"month\": \"08\",\n \"year\": \"2018\"\n}\n```\n\n##### Response snippet\n```javascript\n\"tourGrades\": [\n {\n \"sortOrder\": 1,\n \"gradeCode\": \"TG1\",\n \"gradeTitle\": \"Private Helicopter 1 to 2 Pax\",\n \"pricingMatrix\": [\n {\n \"sortOrder\": 1,\n \"pricingUnit\": \"per helicopter\",\n \"bookingDate\": \"2018-06-01\",\n \"ageBandPrices\": [\n {\n \"bandId\": 1,\n \"prices\": [\n {\n \"sortOrder\": 1,\n \"currencyCode\": \"USD\",\n \"price\": 1714.83,\n \"priceFormatted\": \"$1,714.83\",\n \"merchantNetPrice\": 1461.03,\n \"merchantNetPriceFormatted\": \"$1,461.03\",\n \"minNoOfTravellersRequiredForPrice\": 1\n },\n {\n \"sortOrder\": 2,\n \"currencyCode\": \"USD\",\n \"price\": 1714.83,\n \"priceFormatted\": \"$1,714.83\",\n \"merchantNetPrice\": 0,\n \"merchantNetPriceFormatted\": \"$0.00\",\n \"minNoOfTravellersRequiredForPrice\": 2\n }\n ],\n \"sortOrder\": 1,\n \"minimumCountRequired\": 1,\n \"maximumCountRequired\": 2\n }\n ]\n }\n ]\n },\n {\n \"sortOrder\": 2,\n \"gradeCode\": \"TG2\",\n \"gradeTitle\": \"Private Helicopter 1 to 3 Pax\",\n \"pricingMatrix\": [\n {\n \"sortOrder\": 1,\n \"pricingUnit\": \"per helicopter\",\n \"bookingDate\": \"2018-06-01\",\n \"ageBandPrices\": [\n {\n \"bandId\": 1,\n \"prices\": [\n {\n \"sortOrder\": 1,\n \"currencyCode\": \"USD\",\n \"price\": 2047.41,\n \"priceFormatted\": \"$2,047.41\",\n \"merchantNetPrice\": 1744.4,\n \"merchantNetPriceFormatted\": \"$1,744.40\",\n \"minNoOfTravellersRequiredForPrice\": 1\n },\n {\n \"sortOrder\": 2,\n \"currencyCode\": \"USD\",\n \"price\": 2047.41,\n \"priceFormatted\": \"$2,047.41\",\n \"merchantNetPrice\": 0,\n \"merchantNetPriceFormatted\": \"$0.00\",\n \"minNoOfTravellersRequiredForPrice\": 2\n }\n ],\n \"sortOrder\": 1,\n \"minimumCountRequired\": 1,\n \"maximumCountRequired\": 3\n }\n ]\n }\n ]\n }\n]\n```\n\n##### Interpretation\n| Travelers | Vehicle type | Price per helicopter | Price per person |\n|:----------:|--------------|:--------------------:|:----------------:|\n| 1 | 1-2-person helicopter | $1,714.83 | $1,714.83 |\n| 2 | 1-2-person helicopter | $1,714.83 | $857.415 |\n| 3 | 1-3-person helicopter | $2,047.41 | $682.47 |\n\n#### Per-bike pricing\n\n##### Request object\n```javascript\n{\n \"productCode\": \"17448P8\",\n \"currencyCode\": \"USD\",\n \"month\": \"08\",\n \"year\": \"2018\"\n}\n```\n\n#### Response snippet\n```javascript\n\"pricingMatrix\": [\n {\n \"sortOrder\": 1,\n \"pricingUnit\": \"per bike\",\n \"bookingDate\": \"2018-06-01\",\n \"ageBandPrices\": [\n {\n \"bandId\": 1,\n \"prices\": [\n {\n \"sortOrder\": 1,\n \"currencyCode\": \"USD\",\n \"price\": 208.53,\n \"priceFormatted\": \"$208.53\",\n \"merchantNetPrice\": 177.67,\n \"merchantNetPriceFormatted\": \"$177.67\",\n \"minNoOfTravellersRequiredForPrice\": 1\n },\n {\n \"sortOrder\": 2,\n \"currencyCode\": \"USD\",\n \"price\": 208.53,\n \"priceFormatted\": \"$208.53\",\n \"merchantNetPrice\": 0,\n \"merchantNetPriceFormatted\": \"$0.00\",\n \"minNoOfTravellersRequiredForPrice\": 2\n }\n ],\n \"sortOrder\": 1,\n \"minimumCountRequired\": 1,\n \"maximumCountRequired\": 2\n }\n ]\n }\n]\n```\n\n##### Interpretation\n\n- \"$208.53 per bike, with up to two adults per bike\"\n\n#### Per-flight pricing\n\n##### Request object\n\n```javascript\n{\n \"productCode\": \"28965P134\",\n \"currencyCode\": \"USD\",\n \"month\": \"08\",\n \"year\": \"2018\"\n}\n```\n\n##### Response snippet\n\n```javascript\n\"tourGrades\": [\n {\n \"sortOrder\": 1,\n \"gradeCode\": \"TG1\",\n \"gradeTitle\": \"Individual flight\",\n \"pricingMatrix\": [\n {\n \"sortOrder\": 1,\n \"pricingUnit\": \"per flight\",\n \"bookingDate\": \"2018-06-01\",\n \"ageBandPrices\": [\n {\n \"bandId\": 1,\n \"prices\": [\n {\n \"sortOrder\": 1,\n \"currencyCode\": \"USD\",\n \"price\": 61.01,\n \"merchantNetPrice\": 51.98,\n \"merchantNetPriceFormatted\": \"$51.98\",\n \"priceFormatted\": \"$61.01\",\n \"minNoOfTravellersRequiredForPrice\": 1\n }\n ],\n \"sortOrder\": 1,\n \"minimumCountRequired\": 1,\n \"maximumCountRequired\": 1\n }\n ]\n }\n ]\n },\n {\n \"sortOrder\": 2,\n \"gradeCode\": \"TG2\",\n \"gradeTitle\": \"Double\",\n \"pricingMatrix\": [\n {\n \"sortOrder\": 1,\n \"pricingUnit\": \"per flight\",\n \"bookingDate\": \"2018-06-01\",\n \"ageBandPrices\": [\n {\n \"bandId\": 1,\n \"prices\": [\n {\n \"sortOrder\": 1,\n \"currencyCode\": \"USD\",\n \"price\": 94.28,\n \"merchantNetPrice\": 80.33,\n \"merchantNetPriceFormatted\": \"$80.33\",\n \"priceFormatted\": \"$94.28\",\n \"minNoOfTravellersRequiredForPrice\": 1\n },\n {\n \"sortOrder\": 2,\n \"currencyCode\": \"USD\",\n \"price\": 94.28,\n \"merchantNetPrice\": 0,\n \"merchantNetPriceFormatted\": \"$0.00\",\n \"priceFormatted\": \"$94.28\",\n \"minNoOfTravellersRequiredForPrice\": 2\n }\n ],\n \"sortOrder\": 1,\n \"minimumCountRequired\": 1,\n \"maximumCountRequired\": 2\n }\n ]\n }\n ]\n }\n]\n```\n\n##### Interpretation\n\n| Travelers | `gradeTitle` | Price per flight | Price per person |\n|:----------:|-----------|:----------------:|:----------------:|\n| 1 | Individual flight | $61.01 | $61.01 |\n| 2 | Double | $94.28 | $47.14 |\n\n#### Per-plane pricing\n\n##### Request object\n\n```javascript\n{\n \"productCode\": \"14876P5\",\n \"currencyCode\": \"USD\",\n \"month\": \"06\",\n \"year\": \"2019\"\n}\n```\n\n##### Response snippet\n\n```javascript\n\"pricingMatrix\": [\n {\n \"sortOrder\": 1,\n \"pricingUnit\": \"per plane\",\n \"bookingDate\": \"2019-01-02\",\n \"ageBandPrices\": [\n {\n \"bandId\": 1,\n \"prices\": [\n {\n \"sortOrder\": 1,\n \"currencyCode\": \"USD\",\n \"price\": 433.03,\n \"priceFormatted\": \"$433.03\",\n \"merchantNetPrice\": 391.99,\n \"merchantNetPriceFormatted\": \"$391.99\",\n \"minNoOfTravellersRequiredForPrice\": 1\n },\n {\n \"sortOrder\": 2,\n \"currencyCode\": \"USD\",\n \"price\": 433.03,\n \"priceFormatted\": \"$433.03\",\n \"merchantNetPrice\": 0,\n \"merchantNetPriceFormatted\": \"$0.00\",\n \"minNoOfTravellersRequiredForPrice\": 2\n }\n ],\n \"sortOrder\": 1,\n \"minimumCountRequired\": 1,\n \"maximumCountRequired\": 3\n }\n ]\n }\n]\n```\n\n##### Interpretation\n- \"$433.03 per group of up to three people\"\n\n## Working with age bands\n\n### Age bands\n\nThe available age bands for a product, such as *adult*, *child*, *infant*, etc., are returned by the [/product](#operation/product) service. The customer can select a different number of people from each age band during the price check and checkout process.\n\n### Why have age bands?\n\nTour and experience product operators can set different prices for (and impose different rules on) those wishing to make a booking for their product according to how old they are. \n\nFor example, suppliers might choose to charge people 18 years and older ('adults') the full ticket price, while 'children' can book at a lower price. \n\nOr, the tour operator may only allow children to make a group booking for the tour so long as the group contains 'at least one adult'.\n\nViator provides five categories (age bands) that product operators can use to segregate travelers into age groups (the limits of which they also define) in order to set pricing and traveler-count participation rules for their product according to the age band categories.\n\n### Supported age band categories\n\nThe age bands supported by the Viator API are as follows:\n\n| `bandId` | Description |\n|:------:|-------|\n| **1** | Adult |\n| **2** | Child |\n| **3** | Infant |\n| **4** | Youth |\n| **5** | Senior |\n\nThe names and corresponding numeric identifiers of these categories are fixed as in the table above (i.e., `1` is always `Adult`); however, the exact age range to which each category pertains must be defined manually by the supplier.\n\nThe maximum and minimum ages that each age band describes for each product can be retrieved from the [/product](#operation/product) service.\n\n### Example of age band definitions\n\nFor example, a call to [/product](#operation/product) regarding `10040WORLD` yields the following `ageBands` array within its response object:\n\n```javascript\n\"ageBands\": [\n {\n \"sortOrder\": 1,\n \"ageFrom\": 13,\n \"ageTo\": 64,\n \"adult\": true,\n \"bandId\": 1,\n \"pluralDescription\": \"Adults\",\n \"treatAsAdult\": true,\n \"count\": 0,\n \"description\": \"Adult\"\n },\n {\n \"sortOrder\": 2,\n \"ageFrom\": 65,\n \"ageTo\": 99,\n \"adult\": false,\n \"bandId\": 5,\n \"pluralDescription\": \"Seniors\",\n \"treatAsAdult\": true,\n \"count\": 0,\n \"description\": \"Senior\"\n },\n {\n \"sortOrder\": 3,\n \"ageFrom\": 4,\n \"ageTo\": 12,\n \"adult\": false,\n \"bandId\": 2,\n \"pluralDescription\": \"Children\",\n \"treatAsAdult\": false,\n \"count\": 0,\n \"description\": \"Child\"\n },\n {\n \"sortOrder\": 4,\n \"ageFrom\": 0,\n \"ageTo\": 3,\n \"adult\": false,\n \"bandId\": 3,\n \"pluralDescription\": \"Infants\",\n \"treatAsAdult\": false,\n \"count\": 0,\n \"description\": \"Infant\"\n }\n```\n\nFor this product, the age bands have been defined as follows:\n\n| `bandId` | `description` | `ageFrom` | `ageTo` |\n|:--------:|:-----------:|:-------:|:-----:|\n| **1** | Adult | 13 | 64 |\n| **5** | Senior | 65 | 99 |\n| **2** | Child | 4 | 12 |\n| **3** | Infant | 0 | 3 |\n\nProduct operators must define at least one age band for their tour, and there are no 'default' age ranges. Therefore, if the product operator has only specified a single 'adult' age band covering ages 18-99, it must be assumed that only people aged 18-99 are eligible to book the tour, essentially excluding children and centenarians in this case.\n\n| Field | Type | Definition |\n|-------|------|------|\n| `sortOrder` | integer | the sort order for *this* age band |\n| `adult` | boolean | `true` if this age band is the 'adult' age band |\n| `treatAsAdult` | boolean | `true` if this age band can book the tour without the need for adult accompaniment |\n\n**Note**: `bandId` must be supplied in the request body of the following services:\n\n- [/booking/availability](#operation/bookingAvailability)\n- [/booking/availability/tourgrades](#operation/bookingAvailabilityTourgrades)\n- [/booking/calculateprice](#operation/bookingCalculateprice)\n- [/booking/book](#operation/bookingBook)\n\nAge bands are referenced by their `bandId` in the responses from the following services:\n\n- [/product](#operation/product)\n- [/booking/availability/tourgrades](#operation/bookingAvailabilityTourgrades)\n- [/booking/availability/tourgrades/pricingmatrix](#operation/bookingAvailabilityTourgradesPricingmatrix)\n- [/booking/book](#operation/bookingBook)\n- [/booking/pastbooking](#operation/bookingPastbooking)\n- [/booking/mybookings](#operation/bookingMybookings)\n- [/booking/calculateprice](#operation/bookingCalculateprice)\n\n## How to report a product issue\n\nOccasionally, a product schema in the Viator database will contain incorrect or invalid information. Usually, this occurs due to a mistake made by the supplier of the product when creating the product or updating its details.\n\nNonetheless, it's in all our best interests for product information to be accurate and up-to-date; therefore, if you discover a problem with a product, we would greatly appreciate it if you could report the error through our [product issue reporting form](https://www.tfaforms.com/433240).\n\n### How to use the product issue reporting form\n\n1. Navigate to the [product issue reporting page](https://www.tfaforms.com/433240)\n2. Fill in the **Reporter**, **Supplier ID**, **Product Code** and **Booking ID** fields:\n\n| Field | How to fill it in | Example |\n|-------|-------------------|---------|\n| Reporter | Enter your email address for tracking or correspondence | `you@emailserver.com` |\n| Supplier ID | Enter the value returned in the `supplierCode` field by the [/product](#operation/product) service for the product in question. | `3072` |\n| Product Code | Enter the value returned in the `code` field by the [/product](#operation/product) service for the product in question. | `3072LASALL` |\n| Booking ID | Leave this field blank | |\n\n3. In the **Reason** box below, choose **Content** by clicking on its radio selector. A list of categories will appear, with meanings as follows:\n\n| Category | Included issues | \n|----------|---------|\n| Additional Info | clauses in the `additionalInfo` array in the response from [/product](#operation/product); e.g., departure time or hotel pick-up information |\n| Availability & Blockouts | N/A |\n| Booking Details | N/A |\n| Highlights | `highlights` array items in the response from [/product](#operation/product) |\n| Inclusions / Exclusions | `inclusions` or `exclusions` array items in the response from [/product](#operation/product) |\n| Images | `productPhotos` and `userPhotos` returned by [/product](#operation/product) or [/product/photos](#operation/productPhotos) |\n| Product Title | `title` in the response from [/product](#operation/product), [/search/products](#operation/searchProducts), [/search/products/codes](#operation/searchProductsCodes) and [/search/products/freetext](#operation/searchFreetext) |\n| Product Descriptions | `description` and `shortDescription` in the response from [/product](#operation/product)|\n| SAPI | N/A |\n| Tour Options & Pricing | pricing issues; e.g. when the value of `merchantNetPrice` is `0`; or, if `merchantNetPrice` > `price` |\n| Taxonomy | <ul><li>destination issues in response from [/taxonomy/destination](#operation/taxonomyDestinations)</li><li>category / subcategory issues in response from [/taxonomy/categories](#operation/taxonomyCategories)</li></ul> |\n| Translation Incorrect | mistakes in any natural-language field in the response from any service where `translationLevel` is non-zero |\n| TVRM | N/A |\n| VUC incorrect | N/A |\n\n4. After selecting the category of issue from the options shown, fill-in the **Description / Action Required** box with a good, clear description of the problem and any specific additional actions you would like us to take\n5. Click **Submit** to send the report\n\n<figure>\n <img src=\"https://docs.viator.com/partner-api/resources/merchant/technical/img/tae-report-a-product-issue.jpg\" alt=\"Tripadvisor experiences report a product form\"/>\n <figcaption>Example Report a Product Issue form</figcaption>\n</figure>\n\nOnce your report has been submitted, a member of our Supplier Support Team will contact the supplier of the product in question to resolve any problems with their listing.\n\n## Selling on-request products\n\nThis section explains what merchant API partners need to do in order to be granted access to (and, ultimately, sell) the many on-request products available in Viator's product catalogue.\n\n### 'Freesale' vs 'on-request' products\n\nAmong the products in our inventory, a major differentiating feature is whether they are 'freesale' or 'on-request':\n\n- **Freesale** products are always available to be booked on their days of operation; therefore, when a freesale product is purchased, the booking is confirmed and the customer is charged immediately.\n- **On-request** products only operate at the discretion of the supplier, who must confirm (or reject) each booking request, which will remain 'pending' in the interim. The customer is only charged once confirmation is received.\n\n#### Access to on-request products\n\nBy default, you will only have access to the freesale product range; access to the on-request product range is restricted on account of the extra complexities involved with handling this kind of booking.\n\n### Should I elect to sell on-request products?\n\n#### Business case for including on-request products in your inventory\n\nWhile the majority of products in our inventory are 'freesale', a significant proportion remain 'on-request'. Upgrading your booking platform to support on-request products can lead to an increase in revenue of between 5% and 13%, depending on the locale(s) in which you operate.\n\n| Locale | Revenue increase % |\n|:------:|:------------------------:|\n| en | 8% |\n| es | 8% |\n| fr | 11% |\n| de | 10% |\n| pt | 5% |\n| nl | 12% |\n| it | 10% |\n| ja | 10% |\n| sv | 8% |\n| no | 8% |\n| da | 13% |\n| tw | 13% |\n| zh | 6% |\n\nHaving a wider range of products on offer can be a key differentiator with respect to your competitors. \n\nCustomers often purchase multiple products in the same session – if the product they're looking for isn't available on your platform, they are likely to seek a competitor with a more complete range of products for sale.\n\n#### Logistical considerations to enable on-request products\n\nIn order to sell on-request products, you will need to:\n\n- Modify your back-end systems to support extra logic and API requests\n- Establish and support an extra, email-based communications channel with your customers\n- Create some email templates\n- Modify your platform's front end to accommodate the extra steps required in the booking process\n- Write copy that ensures customers clearly understand that they are booking a product that will not be confirmed or charged immediately\n\nHowever, as the on-request booking confirmation process is fully automated, you will not need to:\n\n- Undertake any additional manual steps compared with booking a freesale product\n- Personally contact the product supplier or our partner support team\n\nInstead, checking the status of bookings (whether confirmed or not) can be accomplished using the [/booking/status](#operation/bookingStatus) and [/booking/status/items](#operation/bookingStatusItems) services. These services can be polled periodically to determine the confirmation status of your bookings.\n\n<u>**Note**</u>: We recommend using the [/booking/status/items](#operation/bookingStatusItems) service to poll for booking statuses, as it is both faster and can be polled more frequently than [/booking/status](#operation/bookingStatus), which can only be polled once every thirty minutes.\n\n### How to support on-request products\n\n#### Product detail page\n\nManaging customer expectations is a key factor in supporting on-request products on your booking platform. \n\nMake clear mention that this is a product for which confirmation will not be received immediately, but rather within 48 hours of making the booking.\n\nThis fact, as well as other pertinent tidbits, can be found in the `additionalInfo` array in the response from **/product**. It is mandatory that all clauses in the `additionalInfo` array are clearly displayed on your product detail page.\n\n<figure>\n <img src=\"https://docs.viator.com/partner-api/resources/merchant/technical/img/additional-info-on-request-clause.jpg\" alt=\"Additional info displayed on a product page on the Viator site\"/>\n <figcaption>Additional info displayed on a product page on the Viator site\n </figcaption>\n</figure>\n\n#### Check-out\n\nAs you will only charge the customer's credit card once the on-request booking is confirmed (i.e., after we have received confirmation of the booking from the product supplier) it's best to display a message to this effect at a prominent point of the check-out flow for all on-request products.\n\n<figure>\n <img src=\"https://docs.viator.com/partner-api/resources/merchant/technical/img/checkout-flow-confirmation-info.jpg\" alt=\"Example checkout-flow instruction on the Viator site\"/>\n <figcaption>Example checkout-flow instruction on the Viator site</figcaption>\n</figure>\n\nIn this way, customers can be reassured that they are not being charged for a booking that may never be confirmed, thereby minimizing needless calls to your customer service team.\n\n#### Combination purchases\n\nIf a single booking includes both freesale (instantly confirmed) and on-request products, only the amount for the freesale product should be charged immediately; the portion corresponding to the on-request booking should only be charged once confirmation is received. \n\nUntil that time, a pre-authorization should be held against the customer’s credit card until confirmation is received.\n\nIt is important that you clearly differentiate between products that are confirmed and those that are pending confirmation, and communicate the status of each and that the pre-authorization will only finalize once the on-request products are confirmed.\n\n#### Confirmation page\n\nChanges will need to be made to your confirmation page because it will not be possible for your customer to download a voucher after completing an on-request booking.\n\nVouchers for freesale products, however, must be made available immediately following the completion of the booking process.\n\n#### Email communications\n\nYou will need to create email templates for <u>all</u> the following scenarios:\n\n- Confirmation emails for bookings with on-request products should indicate that the item is pending confirmation from the supplier; and, that confirmation for this activity will take up to 48 hours, depending on availability.\n- If the on-request booking is confirmed by the supplier (this time including the voucher details)\n- If the on-request booking is rejected\n- If multiple on-request products have been booked:\n + If all items have been accepted/confirmed\n + If all items were rejected\n + If there is a mixture of acceptance and rejection; i.e., 'pending' + 'rejected' + 'cancelled' + 'amended' and so forth.\n- If a mixture of freesale and on-request products are booked at the same time; i.e., in the same cart or booking\n\n<u>**Note**</u>: When a booking is declined, it is useful to mention that the customer's card was not charged.\n\n##### Example email for an on-request booking pending confirmation:\n\n<figure>\n <img src=\"https://docs.viator.com/partner-api/resources/merchant/technical/img/on-request-confirmation-email-1.jpg\" alt=\"Viator website showing translation attribution\"/>\n <img src=\"https://docs.viator.com/partner-api/resources/merchant/technical/img/on-request-confirmation-email-2.jpg\" alt=\"Viator website showing translation attribution\"/>\n <img src=\"https://docs.viator.com/partner-api/resources/merchant/technical/img/on-request-confirmation-email-3.jpg\" alt=\"Viator website showing translation attribution\"/>\n</figure>\n\n### Confirmation time-outs resulting in rejection\n\nAs mentioned above, once a booking for an on-request product is made, it remains in a 'pending' state, awaiting confirmation by the supplier. The supplier has the option of 'confirming' or 'rejecting' the booking.\n\nSuch bookings will not remain 'pending' indefinitely, however. If the supplier has not confirmed the booking within 72 hours – or if they have not confirmed the booking by the time it reaches 24 hours from departure – our systems will automatically reject the booking, and this will be reflected in the response from the [/booking/status/items](#operation/bookingStatusItems) and [/booking/status](#operation/bookingStatus) services.\n\nThere will be no indication that the rejection occurred on account of the supplier being unable to perform their duties. Therefore, you should simply inform the customer that, for reasons out of your control, this on-request tour was unavailable.\n\n### Building in the sandbox environment\n\nUpgrading your booking platform to support on-request products will require you to build and test this functionality in the sandbox environment. However, as no actual booking requests are made with the supplier when using a sandbox-only API-key, you will need to contact our API tech support team at [apitechsupport@viator.com](mailto:apitechsupport@viator.com) and request that the booking be confirmed or rejected as you require.\n\nWhile necessary, this is a manual process. We'd genuinely appreciate your effort in keeping the number of these requests to a minimum.\n\n### Certification and going live\n\nOnce you have completed all tasks mentioned here and sent your Viator account manager the email copy for the different scenarios [described above](#email-communications), we will change the status of your product API-key to include on-request products.\n\n## Localization and translation\n\n### Foreign language products\n\nThe products available through the Viator API have been created in a variety of languages, often by the suppliers of those products themselves. \n\nAlthough the majority of these have been created in English, many have been created in other languages. For example, a tour that operates in Paris might have been created in French.\n\nViator provides translation services to localize product descriptions to the language of the locale in which they are being presented. In this way, products with descriptions – for example, in French – can be displayed in English on English-language websites. Conversely, products with English-language-descriptions can be displayed in French on French-language websites.\n\n * **Note**: product descriptions are translated into the language specified in the `Accept-Language` header parameter in the request to each endpoint. \n\n### Human and machine translation\n\nSome products have been translated by actual humans – 'human translated' – while others have been automatically translated using Google Translate – 'machine translated'.\n\nThe type of translation that has been applied to a product (if any) is indicated by its `translationLevel`, a numeric specifer with meanings as follows:\n\n| `translationLevel` | Meaning |\n|-----------------|---------|\n| `0` | The product was created by the supplier in the language you specifed using the `Accept-Language` header parameter in the request; i.e., the natural-language text in this response has not been translated |\n| `80` | All product information has been <u>machine translated</u> |\n| `90` or `100` | All product information has been <u>human translated</u> |\n\nTherefore, any product with a non-zero `translationLevel` has been translated either by a human or via an automatic process.\n\nThe `translationLevel` field is returned in the response objects from the following services:\n\n* [/search/products](#operation/searchProducts)\n* [/search/products/codes](#operation/searchProductsCodes)\n* [/search/freetext](#operation/searchFreetext)\n* [/product](#operation/product)\n* [/available/products](#operation/availableProducts)\n\nWhen performing a product search using any of these services, you will receive - by default - products with a `translationLevel` of:\n\n* `0` (products that are in the language you specified in `Accept-Language` and are configured for your API-keys), and\n* `90` or `100` (products that have been <u>fully human translated</u>)\n\n### Accessing machine-translated products\n\nIf your implementation can support the large number of products available that are machine translated, you can.\n\nHowever, access to the considerable volume of machine-translated products (level `80`), is <u>not granted by default</u>.\n\nTo access machine-translated products, you will need to: \n\n1. Request access to machine-translated products in sandbox from your Business Development account manager.\n2. Test your site with sandbox to ensure that you can download and display all the available content.\n3. Have your Business Development account manager review your implementation and grant access in the production environment.\n\n## Merchant pricing\n\nMany of the endpoints in the Viator API return pricing information. Due to the necessity of supporting legacy implementations, some pricing fields may not be named in an intuitive way.\n\nThis section seeks to clarify what each of the pricing fields returned by each endpoint actually refer to and how you need to use this information in your implementation.\n\n### Categories of pricing\n\n| Category | Meaning |\n|----------|---------|\n| **Suggested retail price** | The recommended retail price for the product and the price that the product is sold at on the Viator site |\n| **Merchant net rate** | The amount that Viator will invoice the merchant for this sale, **excluding the transaction fee** |\n| **Merchant total price** | The total amount that Viator will invoice the merchant for this sale, **including the transaction fee** |\n\n| Service | Suggested retail price | Merchant net rate |\n|---------|------------------------|-------------------|\n| [/search/products](#operation/searchProducts) | `price`, `priceFormatted` | `merchantNetPriceFrom`, `merchantNetPriceFromFormatted` |\n| [/product](#operation/product) | `price`, `priceFormatted`, `priceFrom`, `priceFromFormatted` | `merchantNetPriceFrom`, `merchantNetPriceFromFormatted` |\n| [/booking/availability](#operation/bookingAvailability) | `retailPrice`, `retailPriceFormatted` | `merchantNetPrice`, `merchantNetPriceFormatted` |\n| [/booking/availability/tourgrades](#operation/bookingAvailabilityTourgrades) | `retailPrice`, `retailPriceFormatted` | `merchantNetPrice`, `merchantNetPriceFormatted` |\n| [/booking/availability/tourgrades/pricingmatrix](#operation/bookingAvailabilityTourgradesPricingmatrix) | `price`, `priceFormatted` | `merchantNetPrice`, `merchantNetPriceFormatted` |\n| [/booking/book](#operation/bookingBook) | N/A | `merchantNetPrice`, `merchantNetPriceFormatted`, `lastRetailPrice`, `lastRetailPriceFormatted` |\n| [/booking/pricingmatrix](#operation/bookingPricingmatrix) | `price`, `priceFormatted` | `merchantNetPrice`, `merchantNetPriceFormatted` |\n| [/booking/calculateprice](#operation/bookingCalculateprice) | N/A | `merchantNetPrice`, `merchantNetPriceFormatted`, `lastRetailPrice`, `lastRetailPriceFormatted`, `itineraryFromPrice`, `itineraryFromPriceFormatted`, `itineraryNewPrice`, `itineraryNewPriceFormatted` |\n| [/booking/pastbooking](#operation/bookingPastbooking) | N/A | `merchantNetPrice`, `merchantNetPriceFormatted`, `lastRetailPrice`, `lastRetailPriceFormatted`, |\n| [/booking/mybookings](#operation/bookingMybookings) | N/A | `merchantNetPrice`, `merchantNetPriceFormatted`, `lastRetailPrice`, `lastRetailPriceFormatted` |\n\nThe following services return the **merchant total price** (i.e., the merchant net rate + transaction fee) in the fields shown:\n\n| Service | Merchant total price fields |\n|---------|-----------------------------|\n| [/booking/book](#operation/bookingBook) | `price`, `priceFormatted`, `totalPrice`, `totalPriceFormatted`, `priceUSD`, `totalPriceUSD` |\n| [/booking/calculateprice](#operation/bookingCalculateprice) | `price`, `priceFormatted`, `priceUSD`, `totalPrice`, `totalPriceFormatted`, `totalPriceUSD` |\n| [/booking/pastbooking](#operation/bookingPastbooking) | `price`, `priceFormatted`, `totalPrice`, `totalPriceFormatted`, `priceUSD`, `totalPriceUSD`, |\n| [/booking/mybookings](#operation/bookingMybookings) | `price`, `priceFormatted`, `priceUSD`, `totalPrice`, `totalPriceFormatted`, `totalPriceUSD` |\n\n### Using the pricing fields\n\nLet's have a look at the various pricing fields for a specific product - the Grand Canyon All-American Helicopter Tour (product code: 2280AAHT).\n\nA search for this product (at the time of writing) on the Viator.com site gives the 'from' price of the tour as **$601.11**:\n\n<figure>\n <img src=\"https://docs.viator.com/partner-api/resources/merchant/technical/img/suggested-retail-price.jpg\" alt=\"'from' price on viator.com product detail page\"/>\n <figcaption>Retail price shown on viator.com</figcaption>\n</figure>\n\nThis value comes from the `price` or `priceFormatted` fields in the response from [/product](#operation/product) for this tour; i.e.,:\n\n```javascript\n{\n ...,\n \"price\": 601.11,\n \"priceFormatted\": \"$601.11\",\n ...\n}\n```\n\nEssentially, this value is the price that the product is sold at on the viator site, and is therefore the **suggested retail price**; i.e., the price at which we recommend you advertise and sell the product for.\n\nIt is also the price of the tour grade with the lowest price; in this case, the \"Earlybird A-Star\" tour grade detailed here:\n\n```javascript\n{\n \"sortOrder\": 5,\n \"currencyCode\": \"AUD\",\n \"langServices\": {\n \"en/SERVICE_AUDIO\": \"English - Audio\"\n },\n \"gradeCode\": \"EB_ASTAR_SP\",\n \"merchantNetPriceFrom\": 555.37,\n \"priceFrom\": 601.11,\n \"priceFromFormatted\": \"$601.11\",\n \"merchantNetPriceFromFormatted\": \"$555.37\",\n \"gradeTitle\": \"Special: Earlybird A-Star\",\n \"gradeDepartureTime\": \"\",\n \"gradeDescription\": \"Special Offer: Receive a discounted seat for the Grand Canyon All American Helicopter Tour departing between 6:45am and 7am on an A-Star helicopter\",\n \"defaultLanguageCode\": \"en\"\n},\n```\n\nAs you can see, the \"suggested retail price\" is given in the `priceFrom` field.\n\n#### Low and zero-margin products\n\nWhen setting the retail price at which you sell products on your site, it’s important to remember that the “suggested sell price” is the price at which the product is currently advertised on the Viator site and reflects the current standard industry price for the product. It <u>does not</u> take into consideration the merchant net price (i.e., the price at which you as a merchant partner will be invoiced for the sale) and, in the case of discounting scenarios, may in fact be less than the merchant net price.\n\nTherefore, to ensure that you sell the product at a price which guarantees that you receive at least as much as you will be invoiced for, as well as any extra profit margin that you desire to generate, we recommend you include a check in your implementation that these requirements are satisfied by comparing the suggested retail and merchant net prices and adjusting the retail price at which you advertise the product accordingly.\n\nFor example, if the merchant net price for a product is $100, the suggested sell price is $101, and your requirement for a minimum margin is 5%, you should adjust the price at which you advertise the product to $105.\n\nWhile we recommend that you charge your customers this amount, it is ultimately up to you as to the price you set for the product, bearing in mind that Viator will then invoice you for the **merchant net rate** (`merchantNetPriceFrom`) of $555.37 <u>plus</u> a **transaction fee** calculated as a percentage of the net rate; i.e., the **merchant total price**. \n\n**The exact value of this transaction fee is detailed in your contract with Viator.**\n\n## Special offers and on-sale pricing\n\nSuppliers have the option of setting special pricing deals for their products. When a product is 'on sale'; i.e., has a temporarily lowered price, it will be reflected in the product content response, as follows:\n\n| Field name | Standard pricing | Special offer / on-sale pricing |\n|------------|----------------|-------------------------|\n| `specialOfferAvailable` | `false` | `true` |\n| `specialOffer` | `\"\"` (empty string) | e.g.: `\"Book by February 28 to save 10%\"` |\n| `rrp` | `0.0` | pre-discount price |\n| `rrpFormatted` | `\"\"` (empty string) | currency-formatted pre-discount price |\n| `price` | standard price | special offer price |\n| `priceFormatted` | currency-formatted **standard price** | currency-formatted **special-offer price** |\n| `merchantNetPriceFrom` | standard merchant net rate | special offer merchant net rate |\n| `merchantNetPriceFromFormatted` | currency formatted standard merchant net rate | currency formatted special offer merchant net rate |\n| `priceFormatted` | currency-formatted **standard price** | currency-formatted **special-offer price** |\n| `priceFrom` (in `tourgrades`) | standard price | special offer price |\n| `priceFromFormatted` (in `tourgrades`) | currency-formatted **standard price** | currency-formatted **special-offer price** |\n\nYou can use this information to highlight which products are on special and provide details to the user about the special offer.\n\n## Supplier communications\n\n### How can suppliers communicate with end customers?\n\nSuppliers occasionally need to reach out to customers for a variety of reasons, such as:\n\n* Requesting pick-up locations, flight details or passenger weight information\n* Providing weather alerts, sold-out notifications or general messaging\n\nTo allow suppliers to contact customers directly, Viator provides a **Closed Loop Communication (CLC)** system. \n\n### How to enable CLC\n\nCLC is enabled per-booking and at the time of booking by supplying the customer’s `email` and either `homePhone` or [`cellphone` + `cellPhoneCountryCode`] – or both – in the `booker` object in the request body sent to the [/booking/book](#operation/bookingBook) service when making a booking.\n\nThis will allow suppliers to send CLC messages directly to the end customer.\n\n#### Note:\n\n* You will receive a CC of each supplier message to your customer support email address in case further assistance is required, but no action from your support team will be necessary for suppliers to communicate with customers.\n\n* Merchants choosing this option should mention to their customers that they are purchasing a product from a third-party supplier, and that they may therefore receive communications regarding the purchase directly from that supplier. \n\n#### Example request body snippet to enable direct CLC\n```javascript\n{\n ...\n \"booker\": {\n \"homePhone\": \"(02)66987564\",\n \"firstname\": \"Homer Test\",\n \"surname\": \"Simpson Test\",\n \"title\": \"Mr\",\n \"cellPhoneCountryCode\": \"61\",\n \"cellPhone\": \"431532778\",\n \"email\": \"hsimpson@customeremail.com\"\n }\n ...\n}\n```\n\n### Supplier communications without CLC\n\nTo have CLCs from the supplier sent <u>only</u> to your (the merchant's) customer support team:\n\n* Leave the `cellPhone`, `cellPhoneCountryCode` and `homePhone` fields blank in the request to the [/booking/book](#operation/bookingBook) service when making a booking.\n\n**Note:** Utilizing this option requires merchants to manage the final loop of communication with the end customer to ensure that their tour/activity can be fulfilled successfully.\n\n## Cancellation policy\n\nAs well as *making* bookings, merchant partners are also able to *cancel* bookings through the Viator API using the [/bookings/cancel-reasons](#operation/cancellationReasons), [/bookings/{booking-ref}/cancel-quote](#operation/cancelBookingQuote) and [/bookings/{booking-ref}/cancel](#operation/cancelBooking) endpoints. Items cancelled via the [/bookings/{booking-ref}/cancel](#operation/cancelBooking) endpoint will be cancelled in full, and only one booking can be cancelled at a time.\n\nFor more information about the content of the new `merchantTermsAndConditions` object, see [Cancellation policy](#section/Key-concepts/Cancellation-policy).\n\n\n### Cancellation policies\n\nAll products can be cancelled by the merchant; however, the refund granted by the supplier to the customer differs depending on the cancellation policy for the product in question.\n\nThere are <u>three</u> cancellation policy categories, **standard**, **custom** and **all sales final**, represented by an integer in the `merchantTermsAndConditionsType` field in the `merchantTermsAndConditions` object returned by [/product](#operation/product): `1`, `2` or `3`, respectively.\n\n**Note:** *These policies are those provided by Viator to our merchant partners. Merchants can choose whether to extend these terms to their customers unchanged or set their own cancellation terms. For example, the merchant partner can choose to make all products non-refundable; or, they might change the full-refund cancellation window to 72 hours instead of 24 hours, and so forth.*\n\n### `1` – Standard cancellation policy\nProducts in this category are cancellable up to 24 hours before the travel date (local supplier time) for a full refund. However, a <u>100% cancellation penalty</u> applies for cancellations submitted less than 24 hours before the start time. Most products (about 85%) fall into this category.\n\n#### Example response snippet\n\n- **Source endpoint**: [/product](#operation/product)\n- **Product**: `5010SYDNEY`\n\n```javascript\n{\n \"data\": {\n \"merchantTermsAndConditions\": {\n \"termsAndConditions\": \"For a full refund, cancel at least 24 hours in advance of the start date of the experience.\",\n \"merchantTermsAndConditionsType\": 1,\n \"amountRefundable\": null,\n \"cancellationFromTourDate\": [\n {\n \"dayRangeMin\": 0,\n \"dayRangeMax\": 1,\n \"percentageRefundable\": 0,\n \"policyStartTimestamp\": null,\n \"policyEndTimestamp\": null\n },\n {\n \"dayRangeMin\": 1,\n \"dayRangeMax\": null,\n \"percentageRefundable\": 100,\n \"policyStartTimestamp\": null,\n \"policyEndTimestamp\": null\n }\n ]\n },\n \"...\": \"...\"\n }\n}\n```\n\nThis product has the *standard* cancellation policy; i.e., when a booking is cancelled:\n\n| Policy | **dayRangeMin** | **dayRangeMax** | Logic | **percentageRefundable** |\n|--------|:-----------:|:-----------:|-------|:--------------------------:|\n| *less than* <u>one</u> day (24 hours) before the start time | 0 | 1 | (product_start_time - cancellation_time) >= 0 days && (product_start_time - cancellation_time) < 1 days | 0 |\n| *more than* <u>one</u> day (24 hours) before the start time | 1 | null | (product_start_time - cancellation_time) >= 1 day | 100 |\n\n### `2` – Custom cancellation policy\nThe refund amount for products in this category varies depending on how long before its start time the product is cancelled. Many products on a custom policy are multi-day tours, which require more sophisticated planning on the supplier’s end. Only a small number of products (around 5%) fall into this category.\n\n#### Example response snippet\n\n- **Source endpoint**: [/product](#operation/product)\n- **Product**: `2264RJ410`\n\n```javascript\n\"data\": {\n \"merchantTermsAndConditions\": {\n \"termsAndConditions\": \"If you cancel at least 30 day(s) in advance of the scheduled departure, there is no cancellation fee.<br>If you cancel between 10 and 29 day(s) in advance of the scheduled departure, there is a 50 percent cancellation fee.<br>If you cancel within 9 day(s) of the scheduled departure, there is a 100 percent cancellation fee.<br>\",\n \"merchantTermsAndConditionsType\": 2,\n \"amountRefundable\": null,\n \"cancellationFromTourDate\": [\n {\n \"dayRangeMin\": 10,\n \"dayRangeMax\": 30,\n \"percentageRefundable\": 50,\n \"policyStartTimestamp\": null,\n \"policyEndTimestamp\": null\n },\n {\n \"dayRangeMin\": 30,\n \"dayRangeMax\": null,\n \"percentageRefundable\": 100,\n \"policyStartTimestamp\": null,\n \"policyEndTimestamp\": null\n },\n {\n \"dayRangeMin\": 0,\n \"dayRangeMax\": 10,\n \"percentageRefundable\": 0,\n \"policyStartTimestamp\": null,\n \"policyEndTimestamp\": null\n }\n ]\n },\n \"...\": \"...\"\n}\n```\n\nThis product has a complex cancellation policy; where cancellations processed:\n\n| Policy | **dayRangeMin** | **dayRangeMax** | Logic | **percentageRefundable** |\n|--------|:-----------:|:-----------:|-------|:--------------------------:|\n| <u>30</u> days or more before the start time | 30 | null | (product_start_time - cancellation_time) >= 30 days | 100 |\n| <u>10</u> days and *less than* <u>30</u> days (10 to 30 days) *before* the start time or more | 10 | 30 | (product_start_time - cancellation_time) >= 10 days && (product_start_time - cancellation_time) < 30 days | 50 |\n| *less than* <u>10</u> days *before* the start time | 0 | 10 | (product_start_time - cancellation_time) < 10 days | 0 |\n\n**Note:** `null` in the `dateRangeMax` field means *negative infinity*; i.e., *infinitely far in the past with respect to* `dateRangeMin`.\n\nAdditional clauses will be included in the `termsAndConditions` field in natural language. This field is for human consumption and is not classically machine-interpretable.\n\n### `3` – All sales final (100% cancellation penalty / no refund offered)\n\nProducts in this category cannot be cancelled or amended without incurring a 100% penalty; i.e., the refund amount will be zero. Around 10% of products fall into this category.\n\n#### Example response snippet\n\n- **Source endpoint**: [/product](#operation/product)\n- **Product**: `5985P7`\n\n```javascript\n{\n \"data\": {\n \"merchantTermsAndConditions\": {\n \"termsAndConditions\": \"All sales are final and incur 100% cancellation penalties.<br>\",\n \"merchantTermsAndConditionsType\": 3,\n \"amountRefundable\": null,\n \"cancellationFromTourDate\": [\n {\n \"dayRangeMin\": 0,\n \"dayRangeMax\": null,\n \"percentageRefundable\": 0,\n \"policyStartTimestamp\": null,\n \"policyEndTimestamp\": null\n }\n ]\n },\n \"...\": \"...\"\n }\n}\n```\nProducts in this category can be cancelled, but no refund will be granted (in most cases...)\n\n### Canceling items with a 'pending' booking status\n\nAs alluded, there is an exception to this rule. Products with an 'on-request' [booking type](#section/Key-concepts/Booking) can still be cancelled when their booking status is `\"pending\"` – i.e., before the supplier has confirmed the booking – and a full refund will be granted.\n\nIt is impossible to predict how long an 'on-request' booking will remain 'pending'. However, it is possible to check by enquiring about the booking using one of the post-booking services; i.e.:\n\n* [/booking/status](#operation/bookingStatus)\n* [/booking/status/items](#operation/bookingStatusItems)\n* [/booking/pastbooking](#operation/bookingPastbooking)\n* [/booking/mybookings](#operation/bookingMybookings)\n\nAn 'all sales final' product in a 'pending' state that can be cancelled and a refund granted will have the following characteristics:\n\n1. The `bookingStatus` object returned from one of the services above will have a `type` of `\"PENDING\"`, and `pending` will be `true`.\n2. The `amountRefundable` field of the `merchantTermsAndConditions` object will be non-zero and non-null. Rather, it will contain a currency-formatted string showing the amount that would be refunded if the cancellation were performed immediately; e.g., \"USD 55.33\".\n\n\n### Policy start and end times\n\nWithin the `merchantTermsAndConditions` object returned in the response from [/booking/book](#operation/bookingBook), [/booking/pastbooking](#operation/bookingPastbooking) and [/booking/mybookings](#operation/bookingMybookings), the `amountRefundable` field shows the amount of money in the selected currency that will be refunded if the cancellation is processed now, while the `policyStartTimestamp` and `policyEndTimestamp` fields indicate the exact times between which the different cancellation refund rates apply.\n\n#### Example response snippet (`merchantTermsAndConditions`) from [/booking/book](#operation/bookingBook)\n\n- **Product**: `5010SYDNEY`\n- **Note**: observe that `amountRefundable`, `policyStartTimestamp` and `policyEndTimestamp` are populated here.\n\n```javascript\n\"data\": {\n \"merchantTermsAndConditions\": {\n \"termsAndConditions\": \"For a full refund, cancel at least 24 hours in advance of the start date of the experience.\",\n \"amountRefundable\": \"USD 55.33\",\n \"cancellationFromTourDate\": [\n {\n \"dayRangeMin\": 1,\n \"dayRangeMax\": null,\n \"percentageRefundable\": 100,\n \"policyStartTimestamp\": null,\n \"policyEndTimestamp\": 1551513600000\n },\n {\n \"dayRangeMin\": 0,\n \"dayRangeMax\": 1,\n \"percentageRefundable\": 0,\n \"policyStartTimestamp\": 1551340800000,\n \"policyEndTimestamp\": 1551427200000\n }\n ]\n },\n \"...\": \"...\"\n}\n```\n\n### Post-travel cancellations\n\nOccasionally, customers seek a refund for a product **after** completing their travels.\n\nThe reason for this might be because they were unable to attend the tour due to the supplier having cancelled the tour due to bad weather or some other reason out of the customer's control; or, the customer might have been extremely dissatisfied with the tour itself, felt that it was misrepresented in its advertising, or some other serious complaint.\n\nWhen this occurs, you will need to [send a refund request by email to dpsupport](mailto:dpsupport@viator.com) and include both \"CANCEL\" and the booking reference number in the subject line.\n\nFor **all** post-travel cancellation requests, you will need to include a detailed description of the issue. \n\nExcept in cases of known service interruptions (e.g., due to extreme weather events), we will first verify the issue and seek authorization from the product supplier. \n\nOnce a decision regarding the refund has been made, we will notify your Customer Services Department with this information. You will then need to advise your customer directly and process the refund if granted.\n\n### Interpreting `policyStartTimestamp` and `policyEndTimestamp`\n\nThe integers that populate the `policyStartTimestamp` and `policyEndTimestamp` fields represent points in time that mark the boundaries of the policy time period in the [Unix time format](https://en.wikipedia.org/wiki/Unix_time); i.e., the number of seconds that have elapsed since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.\n\nUnix timestamps can be easily read and interpreted using the 'time' (or similar) library of your favorite programming language. For human purposes, an [online conversion tool](https://www.epochconverter.com/) can be used.\n\nAs per the example above, canceling this booking between the following times yields zero refund (because it is within the 24 hour window):\n\n| **Field name** | `policyStartTimestamp` | `policyEndTimestamp` |\n|----------------|------------------------|----------------------|\n| **Unix time** | 1551340800000 | 1551427200000 |\n| **Human readable time** | GMT: Thursday, February 28, 2019 8:00:00 AM | GMT: Friday, March 1, 2019 8:00:00 AM |\n\n* **Note**: Please use `policyStartTimestamp` and `policyEndTimestamp`, rather than `dayRangeMin` and `dayRangeMax`, to determine which cancellation policy is in effect.\n\n### Partial refunds\n\nWhile we recommend that you, as a merchant partner, support the processing of partial refunds for your customers, it is up to your whether you implement this functionality. \n\nIf you would prefer to only grant the full (100%) refund that is offered on most products so long as the cancellation is processed more than 24 hours prior to the product's start time, we recommend that you implement logic that checks whether a 100% refund is available for the product at the time the customer wishes to cancel their booking.\n\n| **Type 1: Standard policy** (`merchantTermsAndConditionsType` is `1`) |\n|-------------------------------------------------------------|\n| The 100% refund is available so long as the cancellation is performed more than 24 hours prior to the product start time |\n\n| **Type 2: Custom policy** (`merchantTermsAndConditionsType` is `2`) |\n|-----------------------------------------------------------|\n| You will need to check whether any of the object-items in the `cancellationFromTourDate` array have: <ul><li>a `percentageRefundable` value of `100`, and</li><li>`dayRangeMin` and `dayRangeMax` **or** `policyStartTimestamp` and `policyEndTimestamp` values that include the present time</li></ul> |\n\n| **Type 3: All sales final** (`merchantTermsAndConditionsType` is `3`) |\n|-------------------------------------------------------------|\n| No refunds are available; therefore, granting a refund to your customer for this kind of product will be solely at *your* expense (i.e., you will still be invoiced for the cost of the tour by Viator). Therefore, we recommend that you do not allow refunds for products with this policy. |\n\n## Booking references \n\nWhen a booking is made successfully via the [/booking/book](#operation/bookingBook) endpoint, Viator assigns it a numeric identifier, now known as the **booking reference**.\n\nThis booking reference is returned in the service's response in the `itemId` field; however, this `itemId` is found in different locations depending on the endpoint used:\n\n| Endpoint | itemId element location |\n|----------|-------------------|\n| [/booking/book](#operation/bookingBook) | `data.itemSummaries[].itemId` |\n| [/booking/status](#operation/bookingStatus) | `data.itemSummaries[].itemId` |\n| [/booking/status/items](#operation/bookingStatusItems) | `data[].itemId` |\n| [/booking/pastbooking](#operation/bookingPastbooking) | `data.itemSummaries[].itemId` |\n| [/booking/mybookings](#operation/bookingMybookings) | `data[].itemSummaries[].itemId` |\n\nThe booking reference can used in the **request** in the following endpoints as the value in the `itemId` field or in the `itemIds` array:\n\n- [/booking/status](#operation/bookingStatus)\n- [/booking/status/items](#operation/bookingStatusItems)\n- [/booking/pastbooking](#operation/bookingPastbooking)\n- [/booking/mybookings](#operation/bookingMybookings)\n- [/booking/voucher](#operation/bookingVoucher)\n\n### New booking references\n\nThe new booking cancellation endpoints; i.e.: \n\n- [/bookings/{booking-reference}/cancel-quote](#operation/cancelBookingQuote)\n- [/bookings/{booking-reference}/cancel](#operation/cancelBooking)\n\n...use this booking reference value as an in-URL request parameter, but its format is slightly different. \n\nEssentially, it is the booking's numeric identifier (`itemId`), but prepended with `BR-`. For example, if the `itemId` is `580254558`, the `bookingId` value in the cancellation request should be `BR-580254558`. \n\nThe booking cancellation endpoints confirm the booking reference in the response in the `bookingId` field; e.g.:\n\n```json\n{\n \"bookingId\": \"BR-580669678\",\n \"refundDetails\": {\n \"itemPrice\": 412.04,\n \"refundAmount\": 412.04,\n \"refundPercentage\": 100,\n \"currencyCode\": \"USD\"\n },\n \"status\": \"CANCELLABLE\"\n}\n```\n\n# Common workflows and data validation\n\nUsers of the API usually implement a booking process workflow. The common workflows are:\n- [add to cart](#section/Common-workflows-and-data-validation/Add-to-cart)\n- [checkout](#section/Common-workflows-and-data-validation/Checkout)\n- [view voucher or confirmation status](#section/Common-workflows-and-data-validation/View-voucher-or-confirmation-status)\n- [make a booking](#section/Common-workflows-and-data-validation/Booking-process-flow)\n\n## Add to cart\n\n### Summary\n\nBecause the Viator API is both stateless and does not include services for managing a customer's shopping cart, this functionality must be fully managed on the merchant's side.\n\nViator's servers can generate a price quote for one or several items, but this collection will not be saved by the server.\n\nWe recommend the following process:\n\n1. **View product** - allow the customer to browse products and product details\n2. **Select date and passengers** - allow the customer to check available dates and select the type and number of passengers\n3. **Select tourgrade** - display the available tour grades\n4. **View cart** -> **price quote** - display a total price (including multiple items)\n\n### View product\nFrom your *view product details* section, a button should be presented to **check availability** or **book now** or something similar. Use the [/product](#operation/product) service to retrieve product details and schedules.\n\n### Select date and passengers\nHere, the customer is presented with the dates that remain available for the product. Available dates can be obtained via a request to [/booking/availability/dates](#operation/bookingAvailabilityDates). The list of [age bands](#section/Key-concepts/Working-with-age-bands) (i.e.: 'adult', 'child'; and, each band's maximum and minimum age) is available from the [/product](#operation/product) service.\n\n**Validation** – ensure that:\n1. The total number of travelers being booked does not exceed the limit returned in the `maxTravellerCount` field of the [/product](#operation/product) service\n2. *At least one* adult (or adult equivalent) passenger has been selected\n3. The selected dates are available (use [/booking/availability/dates](#operation/bookingAvailabilityDates))\n\n### Select tour grade\n\nOnce the date and traveler mix have been selected, the customer may need to select a tour grade. Products that do not have this information recorded in the Viator database are assigned a tour grade of `\"DEFAULT\"`. For these products, it is unnecessary to select a tour grade.\n\nTour grade options must be displayed to the customer when the product has multiple tour grades, due to:\n- different departure times\n- traveler mix price deals, like family passes\n- different inclusions and prices - e.g., limo pickup, different language delivery options), or...\n- non-default tour grades – these tour grades *must* be presented to the customer.\n\nThe tour grades for a product are retrieved with the [/booking/availability/tourgrades](#operation/bookingAvailabilityTourgrades) service. If a tour grade is available (check the `available` flag), an 'add to cart' button can be displayed. For unavailable tour grades (`available` is `false`), a reason (`unavailableReason`) is provided, which will be one of:\n\n- `\"TRAVELLER_MISMATCH\"`\n- `\"BLOCKED_OUT\"`, or\n- `\"UNAVAILABLE\"`\n\nYou may choose to hide the blocked-out tour grades (if all tour grades are unavailable on a particular day, a day's tour grades are all `\"BLOCKED_OUT\"`, or the product is not operating that day, the [/booking/availability/dates](#operation/bookingAvailabilityDates) service will not return that date).\n\nYou may also find that a product has no bookable tour grades on a day if the traveler mix does not meet that tour grade's traveler mix restrictions. For example, a honeymoon might require two adults as the only possible traveler mix.\n\nYou can choose to hide the `\"BLOCKED_OUT\"` tour grades, but you will probably want to display the `\"TRAVELLER_MISMATCH\"` grades with the traveler mix requirements listed so that the customer can elect to alter their traveler mix to suit (e.g., for family passes, etc.) You cannot allow the passenger to book with an incompatible traveler mix.\n\nThe return object includes information about tour grade restrictions:\n\n`ageBandsRequired`:\n- `minimumCountRequired`: minimum number of travelers for an [age band](#section/Key-concepts/Working-with-age-bands)\n- `maximumCountRequired`: maximum number of travelers for an [age band](#section/Key-concepts/Working-with-age-bands). If this field is `null`, any number of travelers may be booked.\n\nYou will need to present the `ageBandsRequired` information as in the following examples:\n\n| In 'Adult' age band | Meaning |\n|---------------------|---------|\n| `minimumCountRequired` = 1<br>`maximumCountRequired` = 3 | From 1 to 3 adults |\n| `minimumCountRequired` = 0<br>`maximumCountRequired` = 3 | up to three adults |\n| `minimumCountRequired` = 3<br>`MaximumCountRequired` = | 3 or more adults |\n| `minimumCountRequired` = 2<br>`MaximumCountRequired` = 2 | 2 adults |\n\n\n**Note:** There is a singular and plural version for each age band definition. We recommend automatically generating language that ensures the samples above are grammatically correct using this information.\n\nThe user can click **back** and change their traveler mix; or, they can try selecting another day.\n\n### View cart / price quote\n\nOnce the item has been added to the cart, you will need to preserve this information as part of the session data in your back-end, or as a browser cookie. In particular, you will need to store the *product code* and *age band to quantity traveler mix*.\n\n#### Sample PHP shopping cart item class\n**Note:** this is only an example and is implementation dependent. Alternatively, you could use the item class (as used in the API calls), but much of the information it contains does not need to be stored:\n\n```javascript\nclass shoppingCartItem {\n var $productCode;\n var $tourGrade;\n var $date;\n var $ageBandIdToQty; // assoc array\n}\n```\n\nTo obtain a price quote, you must call the [/booking/calculateprice](#operation/bookingCalculateprice) service. This service requires a currency code and an array of items to be specified. Each item contains the date, product code, tour grade code and an associative array of `ageBandIds` -> `quantity`.\n\n**Validation** – the data must contain [valid age bands](#section/Key-concepts/Working-with-age-bands), tour codes, dates, etc. acquired in previous requests to the API.\n\n**Note:** A product's availability can change in the time between API calls as tour grades or products may be blocked out, or the booking window may close for upcoming dates.\n\n## Checkout\n\n### Summary\n\nThe checkout process can be accomplished using the [/booking/book](#operation/bookingBook) service, but you may need to make requests to other services to calculate prices, display product information (age-band names, etc.) and list available pick-up hotels for user selection.\n\nThe Viator mobile website breaks the workflow down into three steps. For multiple items, some steps will need to be repeated, such as capturing the traveler names for each tour. In your implementation, you can reorganize/reorder the data collection to better suit your needs.\n\n**Example workflow:**\n\n1. **Collect traveler details** - collect the names of the lead traveler and all other travelers\n2. **Collect travel details** - ask any additional questions, including those about any special requirements, and select pick-up options.\n - **Note:** the aforementioned steps will need to be repeated for each item)\n3. **Collect booking details**\n - **Note:** billing and payment details *should not* be sent to Viator.\n\nThe classes for the booking request are defined here in Booking Data Classes. You will need implement these in your chosen programming language and verify that the correct JSON objects are generated during serialization.\n\n### Traveler details\n\nThe traveler details are used to populate the `booking->items[]->travellers[]` objects.\n\nOne passenger must be identified as the \"lead traveler\". A boolean field in the traveler object represents this flag. The lead traveler must be an adult or have the age band `treatAsAdult` flag set to `true`.\n\nAll other travelers must be included.\n\n**Validation** \n\nEnsure that:\n\n - `bandId` is a [valid age band ID](#section/Key-concepts/Working-with-age-bands) for the product\n - `firstname` is less than 16 chars\n - `surname` is less than 36 chars\n - `title` is not included unnecessarily (it is optional)\n - `leadTraveller` is set to `true` for one of the travelers who is in an [age band](#section/Key-concepts/Working-with-age-bands) that has the `treatAsAdult` flag set to `true`\n\n### Other details\n\n#### Booking questions\n\nThe travel details include the [booking questions](#section/Appendices/Booking-questions) that are supplied in the [/product](#operation/product) service.\n\n**Sample question**\n\n**Note:** There may be more than one.\n\n```javascript\nbookingQuestions: [{\n \"message\": \"For safety reasons you must enter the weight of <b>all</b> passengers\",\n \"required\": true,\n \"questionId\": 23,\n \"title\": \"Passenger Weights\",\n \"subTitle\": \"(e.g. 127 pounds, 145 kilos, etc)\",\n \"sortOrder\": 1\n}]\n```\nThe questions should be displayed with the title, message, subtitle and whether it is mandatory (required) or not.\n\n**Validation** – if the question is mandatory, the user must enter at least one character.\n\n#### Special requirements\n\n'Special requirements' should be presented as a text input field so that customers can record whether they require wheelchair assistance, for example. It is not mandatory for the customer to enter any text.\n\n#### Pick-up information\n\nThe last thing that must be collected for each item being booked is the pick-up information. If the product includes pick-up, the `hotelPickup` flag will be set to `true` (in the product object).\n\nIf pick-up is included, you will need to make a request to [/booking/hotels](#operation/bookingHotels) to determine if a hotel list exists. If it does, the list must be displayed so that the customer can make their selection. If not, a text input field should be displayed for hotel name collection.\n\nPlease note that the *first three results* in the list are *not* hotels; rather, these three are alternative selections, comprising:\n\n- 'Hotel not listed'\n- 'Live locally or staying with family/friends'\n- 'Hotel not yet booked'\n\nIf the customer selects 'hotel not listed', you *must* provide a hotel selection text input field. For the other two options, no hotel name is required. In all cases, the hotel ID must be updated with either a hotel ID or the IDs of the three items listed.\n\nIf no hotel list is available, you must provide a text input field for collecting the customer's hotel name. Please include instructions to enter 'live locally' or 'hotel not yet booked' if they cannot provide a hotel name.\n\n**Validation** – if hotel list is available, the `hotelId` must be supplied. If the `hotelId` is `notListed` the, `pickupPoint` field *must* have at least one character.\n\nIf a hotel list is not available, then `pickupPoint` must contain a value.\n\n#### Language services\n\nIf the response from the [/product](#operation/product) service contains information in the `languageServices` field, e.g.:\n\n```javascript\n\"langServices\": {\n \"en/SERVICE_AUDIO\": \"English - Audio\"\n}\n```\n\n...you must specify which language option you wish to book for this tour in the `languageOptionCode` field (see request body schema of the [/booking/book service](#operation/bookingBook)).\n\n## View voucher or confirmation status\n\nThe object returned by the [/booking/book](#operation/bookingBook) service contains booking details that can be used to display an order summary to the customer.\n\nConfirmed bookings of freesale products will return a `voucherKey` and `voucherURL`. The `voucherURL` is accessible by the customer to view their voucher.\n\nPending bookings of on-request products will return `null` in the `voucherKey`/`voucherURL` fields. These fields will only contain values once the booking is confirmed.\n\nA `bookingStatus` object is included in the response that contains the status of the booking.\n\n```javascript\n\"bookingStatus\": {\n \"status\": 1,\n \"text\": \"Paid &amp; Confirmed\",\n \"type\": \"CONFIRMED\",\n \"level\": \"ITEM\",\n \"failed\": false,\n \"confirmed\": true,\n \"amended\": false,\n \"pending\": false,\n \"cancelled\": false\n}\n```\n\nThe status field corresponds to a number described in [bookingStatus field values and meanings](#section/Appendices/bookingStatus-field-values-and-meanings).\n\nBoolean flags that you can inspect to determine the booking status of the item:\n- `failed`\n- `cancelled`\n- `confirmed`\n- `amended`\n- `pending`\n\n### Pending bookings\nA booking is considered *pending* if the booking process is 'in progress'. For example, an on-request booking would be *pending* until it is confirmed/rejected by the supplier.\n\nIf a customer has made an amendment to an on-request booking that is yet to be accepted by the supplier, the booking would then have a status of *amended* when the supplier or customer service accepts the amendment.\n\n**Example response object:**\n\n```javascript\n{\n \"errorReference\": null,\n \"data\": {\n \"sortOrder\": 0,\n \"rulesApplied\": [],\n \"bookingStatus\": {\n \"status\": 3,\n \"text\": \"Confirmed\",\n \"type\": \"CONFIRMED\",\n \"level\": \"ITINERARY\",\n \"confirmed\": true,\n \"pending\": false,\n \"amended\": false,\n \"cancelled\": false,\n \"failed\": false\n },\n \"itemSummaries\": [{\n \"sortOrder\": 0,\n \"rulesApplied\": [],\n \"bookingStatus\": {\n \"status\": 1,\n \"text\": \"Paid &amp; Confirmed\",\n \"type\": \"CONFIRMED\",\n \"level\": \"ITEM\",\n \"pending\": false,\n \"failed\": false,\n \"confirmed\": true,\n \"amended\": false,\n \"cancelled\": false\n },\n \"travellerAgeBands\": [{\n \"sortOrder\": 0,\n \"count\": 1,\n \"pluralDescription\": \"Adults\",\n \"description\": \"Adult\",\n \"ageBandId\": 1\n }],\n \"voucherKey\": \"1005851866:4af44c13ecf3f1a7d3f9ef2fc00c2257e08fa42ae20f877f3039ff9b52aba24e:580669678\",\n \"voucherURL\": \"https://viatorapi.live.rc.viator.com/service/merchant/voucher.jspa?code=1005851866:4af44c13ecf3f1a7d3f9ef2fc00c2257e08fa42ae20f877f3039ff9b52aba24e:580669678&embedResources=false\",\n \"voucherRequirements\": \"You must present a paper voucher for this to\",\n \"productPulledDown\": false,\n \"merchantCancellable\": true,\n \"productWidgetList\": null,\n \"savingAmount\": 0,\n \"passbooks\": null,\n \"termsAndConditions\": null,\n \"itineraryId\": 1000024753,\n \"tourGradeCode\": \"1DAYBOAT\",\n \"productCode\": \"2065CPT\",\n \"leadTravellerSurname\": \"Test\",\n \"distributorItemRef\": \"distroItemRefJDP1803151135\",\n \"languageServicesLanguageCode\": \"en\",\n \"travelDate\": \"2016-02-01\",\n \"price\": 3.72,\n \"bookingEngineId\": \"UF\",\n \"merchantNetPrice\": 3.51,\n \"merchantNetPriceFormatted\": \"$3.51\",\n \"leadTravellerTitle\": \"Mr\",\n \"leadTravellerFirstname\": \"Homer\",\n \"lastRetailPrice\": 3.51,\n \"destId\": 318,\n \"voucherOption\": \"VOUCHER_PAPER_ONLY\",\n \"productTitle\": \"Cape Town City Hop-on Hop-off Tour\",\n \"itemId\": 700025496,\n \"barcodeOption\": \"perperson\",\n \"barcodeType\": \"code128\",\n \"obfsId\": 3696,\n \"priceFormatted\": \"$3.72\",\n \"savingAmountFormated\": \"\",\n \"priceUSD\": 3.72,\n \"lastRetailPriceFormatted\": \"$3.51\",\n \"departsFrom\": \"Cape Town, South Africa\",\n \"hoursConfirmed\": 0,\n \"currencyCode\": \"USD\"\n }],\n \"voucherKey\": \"1005851866:4af44c13ecf3f1a7d3f9ef2fc00c2257e08fa42ae20f877f3039ff9b52aba24e:580669678\",\n \"voucherURL\": \"https://viatorapi.live.rc.viator.com/service/merchant/voucher.jspa?code=1005851866:4af44c13ecf3f1a7d3f9ef2fc00c2257e08fa42ae20f877f3039ff9b52aba24e:580669678&embedResources=false\",\n \"bookerEmail\": \"apitest@viator.com\",\n \"userId\": null,\n \"itineraryId\": 1000024753,\n \"exchangeRate\": 1,\n \"totalPriceFormatted\": \"$3.51\",\n \"totalPriceUSD\": 3.51,\n \"bookingDate\": \"2015-03-17\",\n \"distributorRef\": \"distroRefJDP1803151135\",\n \"totalPrice\": 3.51,\n \"hasVoucher\": true,\n \"currencyCode\": \"USD\"\n },\n \"dateStamp\": \"2015-03-17T17:36:32+0000\",\n \"errorType\": null,\n \"errorMessage\": null,\n \"errorName\": null,\n \"success\": true,\n \"totalCount\": 1,\n \"vmid\": \"321003\",\n \"errorMessageText\": null\n}\n```\n\n### Checking the status of bookings\n\n#### Checking the status of a single booking:\n\n- [/booking/mybookings](#operation/bookingMybookings) can be used to check the status of a booking after it has been purchased. This is useful for checking the status of a pending booking, particularly if there are multiple items within the booking.\n\n It is recommended that you poll the service no more than once per hour.\n\n#### Checking the status of multiple bookings:\n\n- [/booking/status](#operation/bookingStatus) will return the status of all bookings, based on the following:\n - booking date range\n - travel date range\n - specific distributor/distributor item references\n - lead traveler date/first name\n\nThis is useful for checking the status of recently-made, but still *pending* bookings, or those that will commence soon.\n\n**Note:** You can only poll this service (successful calls) once every 30 minutes.\n\n### Confirming the booking via email\n\nUpon receiving a successful response from [/booking/book](#operation/bookingBook), merchant partners should confirm the booking with the customer via email. This email must be sent by the merchant partner (not Viator).\n\n#### Sample confirmation email\n\n<pre>\nDear Traveller,\n\nThank you for booking with [PARTNER NAME] on [www.domain.com]. Your booking is confirmed. This is your booking notification and receipt. Please retain this email for your records.\n\nPlease note:\n\nWe offer three types of vouchers. Be sure to check below for what type of voucher your tour / activity requires. Voucher requirements vary by tour, so if you've booked more than one tour, be sure to check each one. See below for instructions.\n\nHOTEL/FLIGHT ITINERARY\n-----------------------------------------------------------------------\n[Your standard reply here]\n\nTOURS\n-----------------------------------------------------------------------\n\n1. Name: Whale Watching Cruise\n e-Voucher or Paper Voucher Accepted\n You can present either a paper or an electronic voucher for this activity.\n Voucher: [VOUCHERURL]\n Please click on the above link, follow the directions, and print your voucher to present as per instructions on the voucher under 'Important Information'.\n2. Name: Boston City Pass\n Paper Voucher Required\n You must present a paper voucher for this tour. Voucher: [VOUCHERURL]\n Please click on the above link, follow the directions, and print your voucher to present as per instructions on the voucher under 'Important Information'.\n3. Name: SuperShuttle Airport Transfer\n Voucher Not Required\n You must present a paper voucher for this tour. Voucher: [VOUCHERURL]\n You can present a paper or electronic voucher for this activity, or you can simply present the Lead Traveller’s Photo ID. Our supplier has your reservation on file and only requires proof of identity on the day of travel.\n\nIMPORTANT INFORMATION\n-----------------------------------------------------------------------\n[Your standard reply here]\n\nTERMS AND CONDITIONS\n-----------------------------------------------------------------------\n[Your standard reply here]\n</pre>\n\n## Booking process flow\n\nIn this section, we show a sample booking process flow using Viator API services.\n\n### Search for a product\n\n1. Determine the `destinationId` for the desired destination using the [/taxonomy/destinations](#operation/taxonomyDestinations) service.\n2. Search for products in the destination with the [/search/products](#operation/searchProducts) service using the `destinationId`, along with optional parameters like the date range (`startDate` and `endDate`), attraction link (`seoId`), category (`catId`) and subcategory (`subCatId`).\n\n#### Example [/search/products](#operation/searchProducts) POST request body:\n\n```javascript\n{\n \"startDate\": \"2018-12-25\",\n \"endDate\": \"2018-12-28\",\n \"topX\": \"1-15\", \n \"destId\": 684, \n \"currencyCode\": \"USD\",\n \"sortOrder\": \"TOP_SELLERS\"\n}\n```\n**Note**: the `startDate` and `endDate` must be in the future.\n\n3. Get the product details with the [/product](#operation/product) service.\n\n#### Example parameters for a [/product](#operation/product) GET request:\n\n```html\ncode=5010SYDNEY&currencyCode=USD\n```\n\n### Determine the product's available dates\n\nUse the [/booking/availability/dates](#operation/bookingAvailabilityDates) service to retrieve a list of dates on which the product is operating. This list can be used to populate a calendar display of available dates.\n\n#### Example parameters for an availability check using the [/booking/availability/dates](#operation/bookingAvailabilityDates) service:\n\n```html\nproductCode=5010SYDNEY\n```\n\n### Determine the available age bands for the product\n\nBecause the product option (tour grade) availability check requires the desired passenger mix, the user will first need to select the number of travelers and the age band into which each can be classified.\n\nNote: The exact ages to which each age band refers to differs between products. See [Working with age bands](#section/Key-concepts/Working-with-age-bands) for more information.\n\n1. Determine the number of passengers/travelers (and their respective agebands) by having the user input the passenger mix for which they wish to make a booking.\n2. Check for available tour grades for the date chosen using the [/booking/availability/tourgrades](#operation/bookingAvailabilityTourgrades) service; or, check for available tour grades by month using the [/booking/availability/tourgrades/pricingmatrix](#operation/bookingAvailabilityTourgradesPricingmatrix) service\n\n#### [/booking/availability/tourgrades](#operation/bookingAvailabilityTourgrades) POST request:\n```javascript\n{\n \"productCode\": \"5010SYDNEY\",\n \"bookingDate\": \"2018-12-05\",\n \"currencyCode\": \"USD\",\n \"ageBands\": [\n { \n \"bandId\": 1,\n \"count\": 2 \n } \n ]\n}\n```\n\n#### [/booking/availability/tourgrades/pricingmatrix](#operation/bookingAvailabilityTourgrades) POST request:\n```javascript\n{\n \"productCode\": \"5010SYDNEY\",\n \"month\": \"12\",\n \"year\": \"2018\",\n \"currencyCode\": \"USD\"\n}\n```\n3. Finalize pricing using the [/booking/availability/tourgrades/pricingmatrix](#operation/bookingAvailabilityTourgradesPricingmatrix) service. \n - **Note**: we strongly recommend using the [/booking/calculateprice](#operation/bookingCalculateprice) service prior to making the booking, as it reconfirms the product availability for the specified dates and passenger mix.\n\n4. Make the booking\n - Note that the [/booking/book](#operation/bookingBook) service supports multi-item bookings. The response from the [/product](#operation/product) service indicates mandatory information that must be sent when making the booking, such as required [booking questions](#section/Appendices/Booking-questions) and hotel pick-up options.\n - For hotel pick-up:\n - Send a hotel ID to the [/booking/book](#operation/bookingBook) service if `hotelPickup` is `true` for the product.\n - [/booking/hotels](#operation/bookingHotels) can be used to return a list of hotels available for the product.\n - The `hotelId` is the `id` field in the response from the [/booking/hotels](#operation/bookingHotels) service. This can be:\n - a number (represented as a string) – e.g., `'4119'`\n - `'local'` – if the customer resides near the location in which the product operates \n - `'notBooked'` – if the customer's hotel is not yet booked\n - `'notListed'` – if the customer's hotel is not listed in the response from [/booking/hotels](#operation/bookingHotels). If this is the case, capture the customer’s hotel details in a text box and pass this information in the `pickupPoint` field in the request body of the [/booking/book](#operation/bookingBook) service.\n\n#### [/booking/book](#operation/bookingBook) POST request example:\n\n```javascript\n{\n \"demo\": true,\n \"currencyCode\": \"USD\",\n \"partnerDetail\": {\n \"distributorRef\": \"distributorRef1550616101308\"\n },\n \"booker\": {\n \"firstname\": \"Homer Test\",\n \"surname\": \"Simpson Test\",\n \"title\": \"Mr\",\n \"email\": \"apitest@viator.com\",\n \"homePhone\": \"(02)66987564\"\n },\n \"items\": [\n {\n \"partnerItemDetail\": {\n \"distributorItemRef\": \"distributorItemRef1550616101308\"\n },\n \"hotelId\": null,\n \"pickupPoint\": null,\n \"travelDate\": \"2019-03-19\",\n \"productCode\": \"5010SYDNEY\",\n \"tourGradeCode\": \"24HOUR\",\n \"languageOptionCode\": \"en/SERVICE_GUIDE\",\n \"bookingQuestionAnswers\": [\n {\n \"questionId\": 100,\n \"answer\": \"120 kgs\"\n }\n ],\n \"specialRequirements\": \"\",\n \"travellers\": [\n {\n \"bandId\":1,\n \"firstname\": \"Homer\",\n \"surname\": \"Simpson Test\",\n \"title\": \"Mr\",\n \"leadTraveller\": true\n }, {\n \"bandId\": 1,\n \"firstname\": \"Marge\",\n \"surname\": \"Merchant Viator Test\",\n \"title\": \"Mrs\"\n }\n ]\n }\n ]\n}\n```\n\n#### [/booking/hotels](#operation/bookingHotels) GET example parameters:\n\n```html\nproductCode=5010SYDNEY\n```\nor\n```html\ndestId=684\n```\n\n5. You will receive different booking statuses depending on the product's booking engine. \n - For products that are free-sale (`'FreesaleBE'`), unconditional free-sale (`'UnconditionalBE'`) and free-sale / on-request (`'FreesaleOnRequestBE'`) - i.e., during the free-sale period, confirmation should occur instantly. \n - The `'FreesaleOnRequestBE'` status means that the product will only remain free-sale up until a certain number of days before the travel date, after which it becomes on-request. \n - Normally, if the product is on-request, its booking status will be `'Pending'`.\n\n### Post-booking\n\n#### Displaying vouchers\n\nTo display the voucher to your customer, direct them to the URL returned in the `voucherURL` field in the response from the [/booking/book](#operation/bookingBook) service.\n\n**Note**: the voucher will not be available until the booking is confirmed – the value of the `hoursConfirmed` field in the response from the [/booking/book](#operation/bookingBook) service can be shown to the customer to indicate the time frame within which they are likely to be notified as to their booking confirmation.\n\n#### Viewing bookings\n\n- To view a **single** booking, use the [/booking/pastbooking](#operation/bookingPastbooking) service, which returns one booking at a time. \n- To retrieve **all** bookings for a customer, use the [/booking/mybookings](#operation/bookingMybookings) service.\n\n#### Viewing booking statuses\n\nTo view the booking statuses for multiple items based on various criteria, use the [/booking/status](#operation/bookingStatus) service.\n\nNote that this service can only be polled once every five minutes. Ideally, this service should be used by your software implementation to perform bulk updates of pending itineraries. The maximum number of itinerary results returned is 1,000.\n\n#### `merchantNetPrice` and `price` in the [/search/products](#operation/searchProducts) service\n\nThe difference between these fields is as follows:\n\n- `merchantNetPrice` is the amount you, as the merchant partner will be invoiced for, excluding any fees.\n- `price` is the price at which Viator sells the product\n\n**Note**: these prices are also returned (per age band) by the following services:\n\n- [/booking/availability/tourgrades/pricingmatrix](#operation/bookingAvailabilityTourgradesPricingmatrix)\n- [/booking/pricingmatrix](#operation/bookingPricingmatrix)\n- [/booking/book](#operation/bookingBook)\n\n### Currency considerations for bookings\n\nIf the booking shows prices converted to and formatted according to a different currency to that in which it was made, it is because each API partner has a particular 'base currency', and all bookings will be made in that currency.\n\n### Booking and transaction fees\n\nThe total price may be different to the `merchantNetPrice` due to the fact that a booking fee – i.e., a transaction fee or commission – is added to all bookings.\n\nThis fee is a fixed percentage with a capped maximum. The exact percentage depends on your merchant partner agreement with Viator and can be found in your contract with Viator.\n\n### Making demo bookings\n\nTo make a demo booking, simply set the `demo` field to `true` in the [/booking/book](#operation/bookingBook) service.\n\nWhile demo bookings are allowed on the live production environment, we recommend not doing so as it is possible that a notification could be sent to the supplier. Performing a cancellation of the demo booking is therefore recommended.\n\nTo cancel the booking, partners should use the [/bookings/{id}/cancel](#operation/cancelBooking) service. For details on canceling a booking, see: [Cancellation API workflow](#section/Common-workflows-and-data-validation/Cancellation-API-workflow)\n\n## Cancellation UX\n\nOn the Viator.com website, once the customer has made a booking, they are able to access the details of all their upcoming, past and cancelled bookings by navigating to the **bookings** section of the website.\n\nYou must communicate to the user the terms and conditions that pertain to canceling their booking; i.e., what to expect in terms of the refund they will receive if they were to cancel their booking now.\n\nOn the Viator website, this information is communicated in the cancellation button text. In the following example, the user has booked the \"San Francisco City Tour with Alcatraz\", and is viewing their **bookings** page.\n\nIn this way, the user is told that they can \"cancel for free by Oct 22\" – i.e., they will be issued a full refund if they cancel the product prior to October 22:\n\n\n\nThis text is programmatically generated by inspecting the product's cancellation policy, which is contained within the `merchantTermsAndConditions` object, which is included in the response object from the following endpoints:\n\n- [/booking/book](/partner-api/merchant/technical/#operation/bookingBook)\n- [/booking/pastbooking](/partner-api/merchant/technical/#operation/bookingPastbooking)\n- [/booking/mybookings](/partner-api/merchant/technical/#operation/bookingMybookings)\n\nFor details on how to interpret the `merchantTermsAndConditions` object, see: [Cancellation policy](#section/Key-concepts/Cancellation-policy)\n\nOnce the user clicks the button labelled: **Cancel for free by Oct 22**, they are brought to the cancellation confirmation page, where they are provided a more formal cancellation quote prior to confirming their intention to cancel the product.\n\n### Cancellation refund display\n\nAs the merchant of record, the amount your customer was charged for the product was your decision; therefore, the amount that you elect to grant the customer as a refund is also up to you, so you will need to retrieve the amount the customer has paid for the product from your own records/databases.\n\nThe amount that Viator would have invoiced you for the booking – equivalent to the merchant net price at the time of booking plus the transaction fee – can be retrieved using the [/bookings/{booking-ref}/cancel-quote](#operation/cancelBookingQuote) endpoint. For more information see: [Get a cancellation quote](#get-a-cancellation-quote)\n\nHere, the customer is shown that they will receive a full refund if they cancel the product now:\n\n\n\n### Displaying and choosing cancellation reasons\n\nAt this point in the workflow, the user must select a reason for their cancellation. Viator's systems require that a reason for the cancellation be given in order to carry out the cancellation process.\n\nAs the set of acceptable reasons for canceling a booking are formally specified by the Viator Partner API and are not necessarily immutable (new reasons may be added at any time) you should retrieve the presently available cancellation reasons from the [/bookings/cancel-reasons](#operation/cancellationReasons) endpoint. We require you to present these to the customer for them to select.\n\nUse the `cancellationReasonText` fields in the response to populate the list from which the customer can select the most-appropriate match for why they are canceling, as on the Viator website:\n\n\n\nFor more information about getting cancellation reasons, see: [Getting cancellation reasons](#getting-cancellation-reasons)\n\n**Note**: As it is necessary for the user to provide a cancellation reason, it is required that the **Cancel Booking** button remain disabled until a reason has been selected by the customer.\n\n### Completing the cancellation\n\nOnce the user has selected a reason, the **Cancel Booking** button can be activated:\n\n\n\nClicking the **Cancel Booking** button is the final action required of the customer to complete the cancellation.\n\nAt this point, you will want to cancel the booking using the [/bookings/{booking-ref}/cancel](#operation/cancelBooking) API endpoint. For more information on using this service, see: [Cancel the booking](#cancel-the-booking)\n\n### Obtaining confirmation for the cancellation\n\nOn the Viator.com site, the following confirmation message is displayed on the page that loads after the **Cancel Booking** button is clicked:\n\n\n\n### Cancellation confirmation email\n\nOnce the cancellation is accepted, a short, succinct email informing the customer that their booking has been successfully canceled is sent immediately:\n\n\n\n### Viewing canceled bookings\n\nClicking on the **View reservation details** button in the cancellation confirmation email returns the customer to their bookings page, where the fact of the booking being canceled is communicated clearly:\n\n\n\n## Cancellation API workflow\n\n### Note:\n\n- All booking cancellations (except for those requested after the date of travel) must now be performed via the API. Viator no longer offers ordinary cancellation services via our customer support function.\n- To cancel a booking after the tour or activity has occurred, please contact [Viator Partner Support](mailto:dpsupport@viator.com)\n- **Legacy API keys:** Bookings made via the [v1 /booking/book](#operation/bookingBook) endpoint using a [v1 legacy API key](#section/Authentication/Legacy-API-keys) can be canceled using the [v2 cancellation endpoint](#operation/cancelBooking) and a [v2 API key](#section/Authentication/API-key) so long as the [legacy (v1) API key](#section/Authentication/Legacy-API-keys) used to make the booking is linked to the partner's [v2 API key](#section/Authentication/API-key).\n\n\n### Getting cancellation reasons\n<a id=\"getting-cancellation-reasons\"></a>\n\nWhen canceling a booking, you are required to submit a valid 'reason for the cancellation' to assist with Viator's internal processes. This is accomplished via the inclusion of a valid reason code in the body of the request. The reason codes can be retrieved from the [/bookings/cancel-reasons](#operation/cancellationReasons) endpoint.\n\nAs the acceptable reasons for cancellation may be extended at any point (existing reasons will not change or be removed), we recommend retrieving an up-to-date list from this endpoint at least weekly.\n\nThe output from the [/bookings/cancel-reasons](#operation/cancellationReasons) endpoint at the time of writing is as follows:\n\n```javascript\n{\n \"reasons\": [\n {\n \"cancellationReasonCode\": \"Customer_Service.I_canceled_my_entire_trip\",\n \"cancellationReasonText\": \"I canceled my entire trip\"\n },\n {\n \"cancellationReasonCode\": \"Customer_Service.Booked_wrong_tour_date\",\n \"cancellationReasonText\": \"Booked wrong tour/date\"\n },\n {\n \"cancellationReasonCode\": \"Customer_Service.Duplicate_Booking\",\n \"cancellationReasonText\": \"Duplicate Booking\"\n },\n {\n \"cancellationReasonCode\": \"Customer_Service.Chose_a_different_cheaper_tour\",\n \"cancellationReasonText\": \"Chose a different/cheaper tour\"\n },\n {\n \"cancellationReasonCode\": \"Customer_Service.Weather\",\n \"cancellationReasonText\": \"Weather\"\n },\n {\n \"cancellationReasonCode\": \"Customer_Service.Unexpected_medical_circumstances\",\n \"cancellationReasonText\": \"Unexpected/medical circumstances\"\n },\n {\n \"cancellationReasonCode\": \"Customer_Service.Tour operator asked me to cancel\",\n \"cancellationReasonText\": \"Tour operator asked me to cancel\"\n }\n ]\n}\n```\n\n### Canceling a booking\n\n#### Getting a cancellation quote\n<a id=\"get-a-booking-cancellation-quote\"></a>\n\nBefore canceling the booking, call the [/bookings/{booking-reference}/cancel-quote](#operation/cancelBookingQuote) endpoint to get information about whether the booking can be canceled using this endpoint and what the refund will be, for example:\n\n```html\nGET https://api.viator.com/partner/bookings/BR-580254558/cancel-quote\n```\n\n**Note**: For information about the **{booking-reference}** in URL parameter, see [Key concepts: Booking references](#section/Key-concepts/Booking-references)\n\nYou will receive a cancellation quote object, e.g.:\n\n```javascript\n{\n \"bookingId\": \"BR-580254558\",\n \"status\": \"CANCELLABLE\",\n \"refundDetails\": {\n \"itemPrice\": 109.77,\n \"refundAmount\": 109.77,\n \"currencyCode\": \"USD\",\n \"refundPercentage\": 100.00\n }\n}\n```\n\n **Note**: Bookings that have not been confirmed by the supplier and have a status of `\"PENDING\"` will report an `itemPrice`, `refundAmount` and `refundPercentage` of `0`, as no fees are charged until the booking's status is `\"CONFIRMED\"`.\n\nThe data elements in this object have meanings as follows:\n\n| Element | Meaning | Example |\n|---------|---------|---------|\n| `bookingId` | the booking reference number prepended with `BR-` | `BR-580254556` |\n| `status` | One of the following: <ul><li>`CANCELLABLE`: the booking is eligible to be cancelled</li><li>`CANCELLED`: the booking has already been cancelled</li><li>`NOT_CANCELLABLE`: the booking is for a product that operated in the past, and therefore cannot be cancelled using this endpoint (you will need to [send an email to dpsupport](mailto:dpsupport@viator.com) including both \"CANCEL\" and the booking reference number in the subject line in order to request a refund for such a booking)</li></ul> | `CANCELLABLE` |\n| `refundDetails` | object containing information about the refund | |\n| `itemPrice` | the **merchant net price** + **transaction fee** for this product at the time of booking in the currency specified by `currencyCode` | `109.77` |\n| `refundAmount` | the amount that will be deducted from your invoice if the booking is cancelled now | `109.77` |\n| `currencyCode` | the currency code for the currency in which pricing information is displayed | `USD` |\n| `refundPercentage` | the refund amount expressed as a percentage of the `itemPrice` | `100.00` |\n\n#### Canceling the booking\n<a id=\"cancel-the-booking\"></a>\n\nIf the `status` field has a value of `CANCELLABLE` and you are happy with the `refundAmount`, call the [/bookings/{booking-ref}/cancel](#operation/cancelBooking) endpoint to cancel the booking, e.g.:\n\n```html\nPOST https://api.viator.com/partner/bookings/BR-580254558/cancel\n```\n\nA reason code corresponding to the reason for cancellation must be included in the request body; e.g.:\n\n```javascript\n{\n \"reasonCode\":\"Customer_Service.Chose_a_different_cheaper_tour\"\n}\n```\n\nYou should receive a response indicating that the cancellation was successful, e.g.:\n\n```javascript\n{\n \"bookingId\": \"BR-580254558\",\n \"status\": \"ACCEPTED\"\n}\n```\n\nA `status` of `ACCEPTED` indicates that the booking was successfully canceled.\n\n## Calculating prices\n\nThe [/booking/calculateprice](#operation/bookingCalculateprice) service is used to calculate a total price for one or more products, with the ability to specify the date and passenger mix for each product individually. \n\nIt also reconfirms the availability and pricing of the products for the requested dates and passenger mixes. We strongly recommended that you call this service prior to [making a booking](#section/Common-workflows-and-data-validation/Making-a-booking) to establish that the booking will succeed once submitted.\n\nThis endpoint is useful when implementing a shopping cart, as multiple product bookings can be enquired about in a single call to this service.\n\n#### Example request body (JSON)\n\n```javascript\n{\n \"currencyCode\": \"USD\",\n \"items\": [{\n \"travelDate\": \"2015-03-01\",\n \"productCode\": \"2916ROME\",\n \"tourGradeCode\":\"24HR\",\n \"travellers\": [\n {\n \"bandId\": 1\n },\n {\n \"bandId\": 1\n }\n ]\n }]\n}\n```\nThe quirky `travellers` array is used to specify the number of travellers in each age band. Each member object of this array corresponds to a single traveller. The example above signifies \"two adults from bandId: 1\".\n\nAnother example might be \"three travelers from bandId:1 and two travelers from bandId:2\". That would be as follows:\n\n```javascript\n\"travellers\": [\n {\n \"bandId\": 1\n },\n {\n \"bandId\": 1\n },\n {\n \"bandId\": 1\n },\n {\n \"bandId\": 2\n },\n {\n \"bandId\": 2\n }\n]\n```\n\n- **Note**: See [Working with age bands](#section/Key-concepts/Working-with-age-bands) for more information.\n\n#### Price information\n\nThe **total price** (i.e., including the transaction fee) that you will be invoiced for the products to be booked is given in the following fields in the response from this service:\n\n- `data.itemSummaries[].price` (numeric total price of item)\n- `data.itemSummaries[].priceFormatted` (currency formatted total price of item) \n- `data.itinerary.totalPrice` (numeric total price of item)\n- `data.itinerary.totalPriceFormatted` (currency-formatted total price of item)\n\nFor more information about pricing fields and their meaning throughout this API, see: [Merchant pricing](#section/Key-concepts/Merchant-pricing).\n\n#### Determining whether the product is 'freesale' or 'on request'\n\nYou can determine whether the booking is *freesale* or *on-request* by examining the response from this endpoint. 'Freesale' bookings are those that are confirmed immediately (with a status of `\"CONFIRMED\"`) when booked, while *on-request* bookings are instead confirmed by the supplier at a later time. \n\nThe approximate time window for confirmation is provided in the `hoursConfirmed` (integer) field. This can be presented to the customer. \n\n- An `hoursConfirmed` of `0` means that the booking is *freesale*. \n- An `hoursConfirmed` greater than `0` indicates that the booking is *on-request*.\n\n## Finding hotel pick-up points\n\n### Hotel pickup example:\n\n#### Example response body ([/booking/hotels](#operation/bookingHotels))\n```javascript\n{\n \"vmid\":\"221002\",\n \"errorMessage\": null,\n \"errorType\": null,\n \"dateStamp\": \"2012-04-12T13:48:27+0000\",\n \"success\": true,\n \"errorReference\": null,\n \"errorMessageText\": null,\n \"totalCount\": 1,\n \"errorName\": null\n \"data\": [\n {\n \"address\": null,\n \"name\": \"I live locally / I'm staying with friends, relatives\",\n \"id\": \"local\",\n \"phone\": null,\n \"productCodes\": null,\n \"destinationId\": 0,\n \"city\": null,\n \"notes\": null,\n \"latitude\": null,\n \"longitude\": null,\n \"postcode\": null,\n \"brand\": null,\n \"hotelString\": \"I live locally / I'm staying with friends, relatives\",\n \"sortOrder\": 1\n },\n {\n \"address\": null,\n \"name\": \"My hotel is not yet booked\",\n \"id\": \"notBooked\",\n \"phone\": null,\n \"productCodes\": null,\n \"destinationId\": 0,\n \"city\": null,\n \"notes\": null,\n \"latitude\": null,\n \"longitude\": null,\n \"postcode\": null,\n \"brand\": null,\n \"hotelString\": \"My hotel is not yet booked\",\n \"sortOrder\": 2\n },\n {\n \"address\": null,\n \"name\": \"My hotel is not listed\",\n \"id\": \"notListed\",\n \"phone\": null,\n \"productCodes\": null,\n \"destinationId\": 0,\n \"city\": null,\n \"notes\": null,\n \"latitude\": null,\n \"longitude\": null,\n \"postcode\": null,\n \"brand\": null,\n \"hotelString\": \"My hotel is not listed\",\n \"sortOrder\": 3\n },\n {\n \"address\": \"375 East Harmon Avenue\",\n \"name\": \"Alexis Park Resort Hotel\",\n \"id\": \"684_2\",\n \"phone\": \"\",\n \"productCodes\": null,\n \"destinationId\": 684,\n \"city\": \"Las Vegas\",\n \"notes\": null,\n \"latitude\": 36.106258,\n \"longitude\": -115.156146,\n \"postcode\": \"89169\",\n \"brand\": \"\",\n \"hotelString\": null,\n \"sortOrder\": 4\n },\n {\n \"address\": \"167 East Tropicana Avenue\",\n \"name\": \"Americas Best Value Inn\",\n \"id\": \"684_3\",\n \"phone\": \"\",\n \"productCodes\": null,\n \"destinationId\": 684,\n \"city\": \"Las Vegas\",\n \"notes\": null,\n \"latitude\": 36.100778,\n \"longitude\": -115.165522,\n \"postcode\": \"89109\",\n \"brand\": \"\",\n \"hotelString\": null,\n \"sortOrder\": 5\n },\n {\n \"address\": \"3131 Las Vegas Boulevard South\",\n \"name\": \"Wynn Resort\",\n \"id\": \"684_126\",\n \"phone\": \"\",\n \"productCodes\": null,\n \"destinationId\": 684,\n \"city\": \"Las Vegas\",\n \"notes\": null,\n \"latitude\": 36.127563,\n \"longitude\": -115.167704,\n \"postcode\": \"89109\",\n \"brand\": \"\",\n \"hotelString\": null,\n \"sortOrder\": 119\n }\n ]\n}\n```\n## Making a booking\n\nTo make a booking, use the [/booking/book](#operation/bookingBook) service.\n\nTo make a *real* booking, ensure `demo` is set to `false` in the booking request.\n\nDemo bookings will enter our system as a test booking and will not charge the merchant. To enable demo bookings, set `demo` to `true` in the booking request and pass `\"test\"` as the traveler's first or last name.\n\n**Note:** Avoid testing on **Live**, as the booking may be sent to the supplier (depending on the product). Any test bookings on live must be cancelled via the [/bookings/{id}/cancel](#operation/cancelBooking) service; or, contact dpsupport@viator.com if you experience any other issues.\n\n### distrbutorRef and distributorItemRef\n\nThe `distributorRef` and `distrbutorItemRef` fields are the merchant partner's own reference for the booking. All merchant partners must pass a `distributorRef` and a `distributorItemRef` in all bookings.\n\nIt can be any alphanumeric string, and in for the `distrbutorRef`, it must be unique to bookings made by the merchant.\n\nIf an existing `distributorRef` is passed, the booking with the matching `distributorRef` will be returned in the response, and a new booking will not be made.\n\nPlease see the description for these fields in the table below for more information.\n\n**Example request**\n\n```javascript\n{\n \"demo\": true,\n \"currencyCode\": \"USD\",\n \"partnerDetail\": {\n \"distributorRef\": \"distroRef0412141435\"\n },\n \"booker\": {\n \"email\": \"apitest@viator.com\",\n \"firstname\": \"Homer Test\",\n \"surname\": \"Simpson Test\",\n \"title\": \"Mr\"\n },\n \"items\": [{\n \"partnerItemDetail\": {\n \"distributorItemRef\": \"distroItemRef0412141435_1\"\n },\n \"hotelId\": null,\n \"pickupPoint\": null,\n \"travelDate\": \"2015-03-31\",\n \"productCode\": \"2916ROME\",\n \"tourGradeCode\": \"24HR\",\n \"languageOptionCode\": \"en/SERVICE_GUIDE\",\n \"bookingQuestionAnswers\": [{\n \"questionId\": 100,\n \"answer\": \"120 kgs\"\n }],\n \"specialRequirements\": \"\",\n \"travellers\": [{\n \"bandId\": 1,\n \"firstname\": \"Homer\",\n \"surname\": \"Simpson Test\",\n \"title\": \"Mr\",\n \"leadTraveller\": true\n }]\n }]\n}\n```\n\n**Description of JSON request parameters**\n\n| Object name | Element name | Type | Comments | Mandatory |\n|-------------|--------------|:----:|----------|:---------:|\n| | `demo` | boolean | If this is set to True, then it is a demo booking only. Full demos do not send any notifications, are automatically confirmed and OnRequest products become freesale products. Default value is true. Production must have `demo` set to `false`. | ❌ |\n| | `currencyCode` | string | The currency the booking will be submitted in. You will be billed in this currency. | ❌ |\n| `partnerDetail` | | object | Applicable only for extra partner detail for either partner or merchant partner for sending partner specific information | ❌ |\n| | `distributorRef` | string | Merchant API partners must pass a `distributorRef` at itinerary level in the `partnerDetails` object. The `distributorRef` passed must be alphanumeric and unique to bookings made by the merchant. Passing an existing `distributorRef`: If an existing distributorRef is passed, the booking with the matching `distributorRef` will be returned in the response and a new booking will not be made. The fields in the response are identical to the response for a new booking.| ✅ |\n| `partnerItemDetail` | | object | For extra partner detail at an item level, for either partner or merchant partner. | ❌ |\n| | `distributorItemRef` | string | Merchant API partners must pass a `distributorItemRef` into the `partnerItemDetails` object for each item in the items object. The `distributorItemRef` passed must be alphanumeric and unique to the itinerary. | ✅ |\n| `booker` | | object | The information of the primary contact. This contact does not have to be a traveler. | ✅ |\n| | `email` | string | Email address of the primary contact | ❌ |\n| | `homePhone` | string | Home phone number of the primary contact | ❌ |\n| | `firstname` | string | First name of the primary contact | ✅ |\n| | `surname` | string | Surname of the primary contact | ✅ |\n| | `title` | string | Title of the primary contact | ❌ |\n| `items` | | | Array of items in itinerary to be booked | ✅ |\n| | `productCode` | string | product code of the itinerary to be booked | ✅ |\n| | `tourGradeCode` | string | `tourGradeCode` of the item to be booked. If tour grades are supplied in [/product](#operation/product), you must allow the customer to select a tour grade code. If no tour grades are available for the product, pass `\"DEFAULT\"`. | ✅ |\n| | `languageOptionCode` | string | The language service provided for this product that has been chosen for this booking. Usually in the format langcode/Service eg `\"en/SERVICE_GUIDE\"`. If the product details service [/product](#operation/product) for the product returns a langService, this must be provided. | ✅<br />(if `languageServices` are provided in [/product](#operation/product)) |\n| | `travelDate` | date | date of travel for the item (format is YYYY-MM-DD; e.g. 2013-12-25) | ✅ |\n| | `hotelId` | string | If [/product](#operation/product) returns `hotelPickup`: `true` and a list of hotels is available for this product in [/booking/hotels](#operation/bookingHotels), a `hotelId` must be captured. The hotel id as per the hotel service (id field) or use one of these alternative hotel ids:<br />`local`: customer lives locally<br />`notBooked`: Customer has not booked their hotel yet<br />`notListed`: Hotel not listed | ✅<br />(if [/product](#operation/product) returns `hotelPickup`: `true` for `productCode` and hotels available) |\n| | `pickupPoint` | string | Pickup point information related to hotel pickup. Details of the hotel or pickup point must be provided if the `hotelId` selected by the user is `\"notListed\"` or if no hotels are returned for the product in [/booking/hotels](#operation/bookingHotels) where `hotelPickup`: `true` | ✅<br />(if `hotelId` = `\"notListed\"` or no hotels returned) |\n| | `specialRequirements` | string | Capture any additional requirements for the booking, such as dietary requirements or if a wheelchair is required. Suggested workflow is if there are no `bookingQuestionAnswers` for the product, to collect `specialRequirements`. | ❌ |\n| `travellers` | | | Array of traveller names with a required lead traveller selected per item. | ✅ |\n| | `bandId` | integer | [Age band id](#section/Key-concepts/Working-with-age-bands). Available age band details for the product is listed in [/product](#operation/product). | ✅ |\n| | `firstname` | string | First name of the traveller | ✅ |\n| | `surname` | string | Surname of the traveller | ✅ |\n| | `title` | string | Title of the traveller. Suggested options: Mr, Mrs, Ms, Miss, Mstr, Dr | ✅ |\n| | `leadTraveller` | boolean | Each item must have one traveller assigned as the lead traveller for the tour. The lead traveller will have a value of true, all other travellers will have a value of false. The lead traveller can have a mobile phone number added to the booking. | ✅ |\n| | `cellPhoneCountryCode` | string | Ideally only collect the phone number country code for the lead traveller. Alternatively, collect the phone number of the booker instead. | ❌ |\n| | `cellPhone` | string | Ideally only collect the phone number country code for the lead traveller. Alternatively, collect the phone number of the booker instead. | ❌ |\n| `bookingQuestionAnswers` | | object | Answers to [booking questions](#section/Appendices/Booking-questions) for the particular item. If a booking question is available in the `bookingQuestions` array in [/product](#operation/product) for the product, the matching `bookingQuestionAnswers` must be passed. If a product does not have any `bookingQuestion` items, you can omit the `bookingQuestionAnswers` field completely. Any invalid or unnecessary `bookingQuestionAnswers` that are passed to [/booking/book](#operation/bookingBook) will be ignored (no exceptions will be raised) | ✅<br />(if [/product](#operation/product) returns `bookingQuestions`) |\n| | `questionId` | integer | `questionId` (provided in [/product](#operation/product)) | ✅ |\n| | `answer` | string | Answer to the question at the `questionId` listed. Recommended length for the answer is 500 characters. | ✅ |\n\n**JSON Response**\n\nThe prices returned in the booking response represent the net rate, which is the amount merchant API partners will be invoiced for. See [merchant pricing](#section/Key-concepts/Merchant-pricing) for more information.\n\n### Booking errors\n\nA number of errors may be returned in the response to the [/booking/book](#operation/bookingBook) service. If any errors are reported, NO items will be booked, NO items/data will be returned in the response, and NO billing will occur.\n\nThere are two error types:\n- `\"VALIDATION\"` - occurs if a required field is missing or a field is not formatted properly\n- `\"EXCEPTION\"` - occurs when there are issues with the booking date, product / tour grade code or the payment.\n\nExample of an error message:\n\n```javascript\n{\n \"data\": null,\n \"vmid\": \"221001\",\n \"errorMessage\": [ \"Missing distributor reference\" ],\n \"errorType\": \"EXCEPTION\",\n \"dateStamp\": \"2013-04-24T15:50:05+0000\",\n \"errorReference\": \"~3713624959841553334512668\",\n \"errorMessageText\": [\"Missing distributor reference\" ],\n \"success\": false,\n \"totalCount\": 1,\n \"errorName\": \"Exception\"\n}\n```\n\nPlease see \"Standard JSON fields\" in the Appendix for an explanation of the fields.\n\n| Scenario | `errorType` | Example error message text |\n|----------|-----------|----------------------------|\n| Lead traveller is not specified | `VALIDATION` | A traveler needs to be selected as lead traveler. Lead Traveler's name must match credit card name. |\n| Traveller names are not provided | `VALIDATION` | First name of traveler 1 is required, Last name of traveler 1 is required |\n| No travellers provided | `VALIDATION` | A traveler needs to be selected as lead traveler. Lead Traveler's name must match credit card name. |\n| Product code does not exist | `EXCEPTION` | We're sorry, we cannot find the tour, activity or attraction you are looking for\n| Product code exists, but tour grade code does not exist | `EXCEPTION` | SICInvalidTourGrade |\n| Booking date is in the past | `EXCEPTION` | We're sorry, the following tour you are trying to book is sold out and no longer available: Grand Canyon All American Helicopter Tour (2280AAHT) |\n| `languageOptionCode` is in the wrong format | `EXCEPTION` | languageOptionCode should be LangCode/LangServices |\n| Missing required answers for item | `EXCEPTION` | Additional questions missing |\n| Unsupported currency | `EXCEPTION` | Could not lookup SGD:java.lang.RuntimeException: Could not lookup SGDf:au.com.fim.v3.etravel.PiusRecordNotFoundException: No currency found: select * from CurrencyFormat where currencyID = 'SGD' |\n| `distributorRef` not provided in `partnerDetail` object | `EXCEPTION` | Missing distributor reference |\n| `distributorItemRef` not provided in `partnerItemDetail` object | `EXCEPTION` | Missing distributor item reference |\n| `partnerItemDetail` object not provided for the item | `EXCEPTION` | Missing partner item details! |\n\n## Get the booking status for multiple items\n\nThe [/booking/status](#operation/bookingStatus) service retrieves the booking status for multiple items based on different criteria.\n\nThis service can only be polled every 30 minutes. This would ideally be used in software for bulk updates of pending itineraries.\n\nThe maximum number of results returned is 1,000 itineraries. Narrow your search if you expect results greater than this.\n\n**NOTE:** This will return both live and test bookings.\n\n**Example request body**\n\n```javascript\n{\n \"bookingDateFrom\": \"2013-03-22\",\n \"bookingDateTo\": \"2013-03-25\",\n \"itineraryIds\": null,\n \"itemIds\": null,\n \"distributorRefs\": [\"Ref20132603_1\",\"Ref20132603_5\"],\n \"distributorItemRefs\": null,\n \"leadFirstName\": null,\n \"leadSurname\": null,\n \"test\": true\n}\n```\n\nAll fields are optional and can be omitted, however at least one needs to be provided.\n\n| Field | Meaning |\n|-------|---------|\n| `bookingDateFrom` | The booking date is greater than or equal this date |\n| `bookingDateTo` | The booking date is less than or equal this date |\n| `itemIds` | Array of item ids (AKA Viator Item Reference) to check for; e.g., `[1234657,2345267,3245154]` |\n| `distributorRefs` | Array of partner-defined distributor references; e.g., `[\"ref1\",\"ref2\",\"ref3\"]` |\n| `distributorItemRefs` | Array of partner-defined distributor item references; e.g., `[\"refItem1\",\"refItem2\",\"refItem3\"]` |\n| `leadFirstName` | The lead traveller's first name |\n| `leadSurname` | The lead traveller's surname |\n| `test` | Setting `test` to `true` will bypass the poll limit on the sandbox environment only. The default value for `test` is `false`. |\n\n**Example response object** ([/booking/status](#operation/bookingStatus))\n\n```javascript\n{\n \"data\": [\n {\n \"itineraryId\": 3332064,\n \"bookingStatus\": {\n \"type\": \"CONFIRMED\",\n \"level\": \"ITINERARY\",\n \"failed\": false,\n \"text\": \"Confirmed\",\n \"cancelled\": false,\n \"status\": 3,\n \"confirmed\": true,\n \"amended\": false,\n \"pending\": false\n },\n \"bookingDate\": \"2013-03-25\",\n \"distributorRef\": \"Ref20132603_1\",\n \"itemSummaries\": [{\n \"itineraryId\": 3332064,\n \"itemId\": 600088886,\n \"bookingStatus\": {\n \"type\": \"CONFIRMED\",\n \"level\": \"ITEM\",\n \"failed\": false,\n \"text\": \"Paid &amp; Confirmed\",\n \"cancelled\": false,\n \"status\": 1,\n \"confirmed\": true,\n \"amended\": false,\n \"pending\": false\n },\n \"travelDate\": \"2013-12-03\",\n \"distributorItemRef\": \"ItemRefA\",\n \"sortOrder\": 0\n }],\n \"sortOrder\": 1\n },\n {\n \"itineraryId\": 3332076,\n \"bookingStatus\": {\n \"type\": \"CONFIRMED\",\n \"level\": \"ITINERARY\",\n \"failed\": false,\n \"text\": \"Confirmed\",\n \"cancelled\": false,\n \"status\": 3,\n \"confirmed\": true,\n \"amended\": false,\n \"pending\": false\n },\n \"bookingDate\": \"2013-03-26\",\n \"distributorRef\": \"Ref20132603_5\",\n \"itemSummaries\": [{\n \"itineraryId\": 3332076,\n \"itemId\": 600088907,\n \"bookingStatus\": {\n \"type\": \"CONFIRMED\",\n \"level\": \"ITEM\",\n \"failed\": false,\n \"text\": \"Paid &amp; Confirmed\",\n \"cancelled\": false,\n \"status\": 1,\n \"confirmed\": true,\n \"amended\": false,\n \"pending\": false\n },\n \"travelDate\": \"2013-12-03\",\n \"distributorItemRef\": \"ItemRefA\",\n \"sortOrder\": 0\n }],\n \"sortOrder\": 2\n }],\n \"vmid\": \"221002\",\n \"errorMessage\": null,\n \"errorType\": null,\n \"dateStamp\": \"2013-03-26T10:25:57+0000\",\n \"errorReference\": null,\n \"errorMessageText\": null,\n \"success\": true,\n \"totalCount\": 2,\n \"errorName\": null\n}\n```\n\n### Exceeding the poll limit\n\nYou will receive the following error if you exceed the number of calls allowed to the service within the timeframe:\n\n```javascript\n{\n \"data\": null,\n \"vmid\": \"221002\",\n \"errorMessage\": [\n \"Access allowed every 30 minutes\"\n ],\n \"errorType\": \"EXCEPTION\",\n \"dateStamp\": \"2013-03-26T10:28:51+0000\",\n \"errorReference\": \"~55315512721712161381352771\",\n \"errorMessageText\": [\n \"Access allowed every 30 minutes\"\n ],\n \"success\": false,\n \"totalCount\": 1,\n \"errorName\": \"PollingDeniedException\"\n}\n```\n\n## Get the tour grade pricing matrix\n\nThe [/booking/pricingmatrix](#operation/bookingPricingmatrix) service retrieves the pricing matrix for tour grades, product age bands and pax (passenger) mixes.\n\n**Example request object** ([/booking/pricingmatrix](#operation/bookingPricingmatrix))\n\n```javascript\n \"productCode\": \"5261HTLAP\",\n \"tourGradeCode\": \"Zone 1\",\n \"bookingDate\": \"2013-12-01\",\n \"currencyCode\": \"USD\",\n \"specialReservation\": false\n```\n\n`bookingDate`: The date to check for pricing data. This is an optional parameter for a normal product.\n\nIf the date is not provided then the nearest available date is determined (i.e. not blocked out or unavailable for any reason)\n\n**Example response object** ([/booking/pricingmatrix](#operation/bookingPricingmatrix))\n\n```javascript\n{\n \"data\": [{\n \"pricingUnit\": \"per person\",\n \"bookingDate\": \"2013-12-01\",\n \"sortOrder\": 1,\n \"ageBandPrices\": [{\n \"bandId\": 1,\n \"prices\": [{\n \"sortOrder\": 1,\n \"currencyCode\": \"USD\",\n \"price\": 81.94,\n \"priceFormatted\": \"$81.94\",\n \"merchantNetPrice\": 65.44,\n \"merchantNetPriceFormatted\": \"$65.44\",\n \"minNoOfTravellersRequiredForPrice\": 1\n }],\n \"sortOrder\": 1,\n \"minimumCountRequired\": 1,\n \"maximumCountRequired\": 1\n }]\n },\n {\n \"pricingUnit\": \"per person\",\n \"bookingDate\": \"2013-12-01\",\n \"sortOrder\": 2,\n \"ageBandPrices\": [{\n \"bandId\": 1,\n \"prices\": [{\n \"sortOrder\": 1,\n \"currencyCode\": \"USD\",\n \"price\": 40.97,\n \"priceFormatted\": \"$40.97\",\n \"merchantNetPrice\": 32.73,\n \"merchantNetPriceFormatted\": \"$32.73\",\n \"minNoOfTravellersRequiredForPrice\": 1\n }],\n \"sortOrder\": 1,\n \"minimumCountRequired\": 2,\n \"maximumCountRequired\": 2\n }]\n },\n {\n \"pricingUnit\": \"per person\",\n \"bookingDate\": \"2013-12-01\",\n \"sortOrder\": 3,\n \"ageBandPrices\": [{\n \"bandId\": 1,\n \"prices\": [{\n \"sortOrder\": 1,\n \"currencyCode\": \"USD\",\n \"price\": 27.32,\n \"priceFormatted\": \"$27.32\",\n \"merchantNetPrice\": 21.81,\n \"merchantNetPriceFormatted\": \"$65.44\",\n \"minNoOfTravellersRequiredForPrice\": 1\n }],\n \"sortOrder\": 1,\n \"minimumCountRequired\": 3,\n \"maximumCountRequired\": 3\n }]\n }],\n \"errorReference\": null,\n \"dateStamp\": \"2017-11-24T21:30:47+0000\",\n \"errorType\": null,\n \"errorCodes\": null,\n \"errorMessage\": null,\n \"errorName\": null,\n \"success\": true,\n \"totalCount\": 3,\n \"errorMessageText\": null,\n \"vmid\": \"321050\"\n}\n```\n\n**Description of elements in JSON response object**\n\n| Object | Element | Type | Comments | To be viewed by customer | Required field |\n|--------|---------|------|----------|:------------------------:|:--------------:|\n| `data` | | object | main response object | ❌ | ✅ |\n| | `sortOrder` | integer | order in which to show the pricing | ✅ | ✅ |\n| | `bookingDate` | date | booking date criteria | ✅ | ✅ |\n| | `pricingUnit` | string | unit for pricing: currently, only \"per person\" is supported | ✅ | ✅ |\n| `ageBandPrices` | | object | available age bands and their pricing | ❌ | ✅ |\n| | `sortOrder` | integer | sort order for age band display | ✅ | ✅ |\n| | `bandId` | integer | **Note**: the numeric `bandId` is associated with an age band description (e.g., `\"Adult\"`, `\"Infant\"` etc.) and a corresponding age range (e.g., from 12 to 99) - these details are available from the [/product](#operation/product) service. See [Working with age bands](#section/Key-concepts/Working-with-age-bands) | ❌ | ✅ |\n| | `minimumCountRequired` | integer | minimum number of pricing units that apply to these prices | | ✅ |\n| | `maximumCountRequired` | integer | maximum number of pricing units that apply to these prices | | ✅ |\n| `prices` | | object | pricing available for the age band (based on the min and max count requirements) | ✅ | ✅ |\n| | `currencyCode` | string | currency of the pricing | ✅ | ✅ |\n| | `sortOrder` | integer | order the pricing is to be shown within the `bandId` | ✅ | ✅ |\n| | `price` | number | price in decimal format (for merchant API partners, this is the 'suggested sell price') | ❌ | ✅ |\n| | `priceFormatted` | string | suggested sell price formatted according to the currency selected (with two decimal places where applicable) | ✅ | ✅ |\n| | `merchantNetPrice` | number | merchant net price in decimal format | ❌ | ✅ |\n| | `merchantNetPriceFormatted` | string | merchant net price formatted according to the selected currency | ❌ | ✅ |\n| | `minNoOfTravellersRequiredForPrice` | integer | number of units that the pricing applies to (e.g., a `minNoOfTravellersRequiredForPrice` of `3` means that the price is for three people) | ✅ | ✅ |\n\n\n\n## Dealing with vouchers\n\nThe [/booking/voucher](#operation/bookingVoucher) service retrieves details for a complete itinerary or a single itinerary item. The data is returned as HTML that can be wrapped in a header/footer.\n\n### Sample URL parameters\n\n`leadLastName=DP&itemId=600033670`\n\nor\n\n`voucherKey=3299307:93c7f36a56b18ba1068787ba7fb7988da5c8ad08db77604110141ff21498603e:600033670`\n\n### Key concepts\n\n#### `voucherKey`\n- Use either the `voucherKey` or the three separate parameters.\n- If `voucherKey` is provided as well as other parameters, then the `voucherKey` overrides the other parameters.\n- The `voucherKey` is obtained from [/booking/mybookings](#operation/bookingMybookings) or in the [/booking/book](#operation/bookingBook) response object when a booking is made.\n\n#### `fullHTML`\nThis is an optional parameter: \n- If `true`, the full HTML (including `<!DOCTYPE>`, `<html>` and `<head>` tags) will be returned.\n- If `false`, an HTML `<div>` element will be returned.\n- The default for this parameter is `false`\n\n#### `mobileVoucher`\n- Optional parameter. Defaults to `true`. If `true`, the mobile (cut down) voucher HTML is returned; otherwise, the full voucher HTML is returned and `fullHTML` is ignored\n- This field should only be enabled for products that have a `voucherOption` of `\"VOUCHER_E\"` (electronic voucher). Do not enable `mobileVouchers` for paper vouchers (`voucherOption` of `\"VOUCHER_PAPER_ONLY\"`) as no barcode is returned.\n- The voucher information is available in the responses for:\n - [/product](#operation/product)\n - [/booking/book](#operation/bookingBook)\n - [/booking/pastbooking](#operation/bookingPastbooking)\n - [/booking/mybookings](#operation/bookingMybookings)\n- Voucher information is also displayed under the **Redemption Info** heading in the response from this service.\n\n**Example response object** ([/booking/voucher](#operation/bookingVoucher))\n\n```javascript\n{\n \"data\": \"<div style=\\'line-height: 1.5;font-family:\\'Arial\\',\\'Helvetica\\',\\'Verdana\\',sans-serif; font-size: 12px; padding: 0 10px; border-bottom: 1pxsolid #CAE2EA;\\'><h2 style=\\'font-size:16px;font-weight:bold;margin:0.5em 0;padding:0;\\'>San FranciscoBay Sunset Catamaran Cruise &reg;</h2><h2 style=\\'font-size:16px;font-weight:bold;margin:0.5em0;padding:0;\\'>SAMPLE ONLY</h2><ul style=\\'margin:0 0 1em 1em; padding:0;\\'> <li><strong>Date:</strong>Friday April 13, 2012 </li><li><strong>Time:</strong><strong>2011:</strong><br><ul><li><strong>Nov. 6 to Nov. 27</strong>: 4:00pm (Fri., Sat. &amp; Sun)</li></ul><p><strong>2012:</strong></p><ul><li><strong>March 2 to March 10:</strong>&nbsp; 5:00 pm (Fri., Sat. &amp; Sun)</li><li><strong>March 11 to April 15:</strong> 6:00pm Daily</li><li><strong>April 16 to May 20:</strong> 6:30 pm Daily</li><li><strong>May 21 to July 22:</strong> 7:00 pm Daily</li><li><strong>July 23 to Aug 26: </strong>6:30 pm Daily</li><li><strong>Aug 27 to Sept 23:</strong>6:00 pm Daily</li><li><strong>Sept. 24 to Nov. 3:</strong> 5:30 pm Daily</li><li><strong>Nov 4 to Dec 2:</strong> 4:00pm (Friday, Sat., &amp; Sun.)</li></ul><p>Please arrive 30 minutes prior to cruise departure.</li></ul> <ul style=\\'margin:0 0 1em 1em; padding:0;\\'> <li><strong>Lead Traveler: </strong> jos dp</li><li><strong>Number of Travelers: </strong> 1 Adult</li> <li><strong>Booking Reference: </strong>VIATOR600033672</li><li><strong>Product Code: </strong>2316SUN</li><li><strong>Confirmation Details:</strong>SUN </li> <li><strong>Location </strong><div><p>Pier 39</p></div><div></div><div>When you get to Pier 39, stand on the sidewalk &amp; look towards the water, do NOT go down the center wherethe shops are, but take the left OUTSIDE walkway. Go towards the sea lions &amp; look for a gate with the letter J on it</div></li></ul><h3 style=\\'font-size:14px;font-weight:bold;margin:0.5em 0;padding:0;\\'> Redemption Info</h3><ul style=\\'margin:0 0 1em 1em; padding:0;\\'> <li>You can present either a paper or an electronic voucherfor this activity. </li> </ul> <h3 style=\\'font-size:14px;font-weight:bold;margin:0.5em 0;padding:0;\\'>Important</h3> <ul><li>Your local contact is Adventure Cat Sailing Charters on +1 800 498 4228.</li><li>Please note: You mustreconfirm directly with Adventure Cat Sailing Charters at <ul> <li>Locally on 415 777 1630</li></ul> at least 24 Hour(s)prior to your tour/activity date. If you are not arriving within the specified timeframe, please contact Adventure CatSailing Charters prior to your travels, or immediately upon arrival at your destination.</li></ul><ul><li>Duringthe months of March, April and November, the weather in San Francisco can be unpredictable and sailings are subject tocancellation or rescheduling. Please ensure that you call the operator 1 day prior to sailing to confirm your tour</li></ul><h3 style=\\'font-size:14px;font-weight:bold;margin:0.5em 0;padding:0;\\'>Inclusions</h3><ul><li>1.5-hour Sunset Cruise</li><li>Light hors d\\'oeuvres</li><li>Two complimentary drinks</li></ul><h3 style=\\'font-size:14px;font-weight:bold;margin:0.5em 0;padding:0;\\'>Terms and Conditions </h3> Read our completeTerms & Conditions for information on cancellations, date changes and other modifications to this confirmed reservation. </div><!-- end of voucher_item --></div>\",\n \"vmid\": \"221001\",\n \"errorMessage\": null,\n \"errorType\": null,\n \"dateStamp\": \"2012-04-13T10:40:47+0000\",\n \"success\": true,\n \"errorReference\": null,\n \"errorMessageText\": null,\n \"totalCount\": 1,\n \"errorName\": null\n}\n```\n\n## Reviewing bookings\n\nThe [/booking/pastbooking](#operation/bookingPastbooking) service gets the details of a single specific past booking based on the `voucherKey` or `itemId` passed into it.\n\n### Sample query Parameters\n\n`\"email=john.doe@viator.com&itemId=600033670\"`\n\nor\n\n`\"voucherKey=3299307:93c7f36a56b18ba1068787ba7fb7988da5c8ad08db77604110141ff21498603e:600033670\"`\n\n### Key concepts\n#### Email\n\nThe email address passed must match the email address associated to the itinerary\n\n#### Departure Details\n\nDeparture details, such as the `departurePoint`, `departurePointAddress` and `departurePointDirections`, will be included in the response. These fields may contain HTML escape characters, such as `&amp;` and special characters that are escaped by a backslash. Ensure that these fields are parsed after receiving the response, or it may cause your JSON to be invalid.\n\n\n**Example response object** ([/booking/pastbooking](#operation/bookingPastbooking)):\n\n```javascript\n{\n \"errorReference\": null,\n \"data\": {\n \"sortOrder\": 0,\n \"rulesApplied\": null,\n \"bookingStatus\": {\n \"status\": 3,\n \"text\": \"Confirmed\",\n \"type\": \"CONFIRMED\",\n \"level\": \"ITINERARY\",\n \"confirmed\": true,\n \"pending\": false,\n \"amended\": false,\n \"cancelled\": false,\n \"failed\": false\n },\n \"itemSummaries\": [{\n \"sortOrder\": 0,\n \"rulesApplied\": null,\n \"bookingStatus\": {\n \"status\": 1,\n \"text\": \"Paid &amp; Confirmed\", \"type\": \"CONFIRMED\",\n \"level\": \"ITEM\",\n \"failed\": false,\n \"confirmed\": true,\n \"amended\": false,\n \"pending\": false,\n \"cancelled\": false\n },\n \"travellerAgeBands\": [{\n \"sortOrder\": 0,\n \"count\": 2,\n \"pluralDescription\": \"Adults\",\n \"description\": \"Adult\",\n \"ageBandId\": 1\n }],\n \"voucherKey\": \"1000308214:899757cf8b419ed11f39045636b0b30af986d19126d04547097f4b9c05fb4b69:700179574\",\n \"voucherURL\": \"https://viatorapi.sandbox.viator.com/service/merchant/voucher.jspa?code=1000308214:899757cf8b419ed11f39045636b0b30af986d19126d04547097f4b9c05fb4b69:700179574&embedResources=false\",\n \"voucherRequirements\": \"You must present a paper voucher for this tour. We will email a link to access and print your voucher at the Lead Travelers email address.\",\n \"productPulledDown\": false,\n \"merchantCancellable\": true,\n \"productWidgetList\": null,\n \"savingAmount\": 0,\n \"vouchers\": null,\n \"passbooks\": null,\n \"termsAndConditions\": null,\n \"itineraryId\": 1000308214,\n \"productCode\": \"2065CPT\",\n \"tourGradeCode\": \"1DAY\",\n \"distributorItemRef\": \"distroItemRefJDP1006151732\",\n \"languageServicesLanguageCode\": \"en\",\n \"travelDate\": \"2015-09-03\",\n \"price\": 26.28,\n \"leadTravellerSurname\": \"Test\",\n \"barcodeOption\": \"tour\",\n \"barcodeType\": \"code128\",\n \"destId\": 318,\n \"voucherOption\": \"VOUCHER_PAPER_ONLY\",\n \"productTitle\": \"City Sightseeing Cape Town Hop-On Hop-Off Tour\",\n \"itemId\": 700179574,\n \"obfsId\": 27643,\n \"departurePoint\": \"Tour starts at V&amp;A Waterfront, outside the Two Oceans Aquarium, however you may board the bus at any one of the stops throughout the city (see the Itinerary section below for a list of stops)\",\n \"departurePointAddress\": \"\",\n \"departurePointDirections\": \"\",\n \"leadTravellerTitle\": \"Mr\",\n \"leadTravellerFirstname\": \"Homer\",\n \"lastRetailPrice\": 26.28,\n \"bookingEngineId\": \"UF\",\n \"priceFormatted\": \"$26.28\",\n \"savingAmountFormated\": \"\",\n \"merchantNetPrice\": 26.28,\n \"merchantNetPriceFormatted\": \"$26.28\",\n \"currencyCode\": \"USD\",\n \"lastRetailPriceFormatted\": \"$26.28\",\n \"departsFrom\": \"Cape Town, South Africa\",\n \"tourGradeDescription\": \"1-Day Bus Tour (1DAY)\",\n \"hoursConfirmed\": 0,\n \"priceUSD\": 26.28\n }],\n \"voucherURL\": \"https://viatorapi.sandbox.viator.com/service/merchant/voucher.jspa?code=1000308214:899757cf8b419ed11f39045636b0b30af986d19126d04547097f4b9c05fb4b69&embedResources=false\",\n \"voucherKey\": \"1000308214:899757cf8b419ed11f39045636b0b30af986d19126d04547097f4b9c05fb4b69\",\n \"bookerEmail\": \"jocelyn@viator.com\",\n \"itineraryId\": 1000308214,\n \"exchangeRate\": 1,\n \"distributorRef\": \"distroRefJDP1006151732\",\n \"totalPrice\": 26.28,\n \"bookingDate\": \"2015-06-10\",\n \"totalPriceFormatted\": \"$26.28\",\n \"totalPriceUSD\": 26.28,\n \"hasVoucher\": true,\n \"userId\": null,\n \"currencyCode\": \"USD\"\n }\n}\n\n```\n\n\n## Checking bookings\n\nThe [/booking/mybookings](#operation/bookingMybookings) service gets a user's future bookings; i.e., those with travel dates in the future. This service can also be used to check the status of a booking.\n\n### Key concepts\n#### Sample URL parameters\n\n- `\"sessionId=xxx\"`, or\n- `\"voucherKey=xxx\"`, or\n- `\"email=terry.smith@viator.com&lastCCFourDigits=4242\"`, or\n- `\"email=terry.smith@viator.com&itineraryOrItemId=3299307\"`\n\nProvide *one* of:\n- a `sessionId` for all bookings related to a user account, or\n- a `voucherKey`, or\n- an email address (`email`) and the last four digits of the credit card number (`lastCCFourDigits`) used to make the booking to get all associated bookings, or\n- an email address (`email`) and `itemId`\n\n...in that order\n\nFor `\"Failed\"` items, display a message that communicates the following information to your customers:\n\n<pre>\"The booking has failed either because this tour or activity was not available or there was a technical issue. Please contact Customer Service if you need more information.\"</pre>\n\n**See also**: [Booking and item status list](#section/Appendix/bookingStatus-field-values-and-meanings)\n\n#### Departure details\n\nDeparture details, such as the `departurePoint`, `departurePointAddress` and `departurePointDirections` will be included in the response. These fields may contain HTML escape characters, such as `&amp;` and special characters that are escaped using a backslash. Ensure that these fields are parsed after receiving the response or it may cause your JSON to be invalid.\n\n**Example response object** ([/booking/mybookings](#operation/bookingMybookings)):\n\n```javascript\n{\n \"errorReference\": null,\n \"data\": {\n \"sortOrder\": 0,\n \"rulesApplied\": null,\n \"bookingStatus\": {\n \"status\": 3,\n \"text\": \"Confirmed\",\n \"type\": \"CONFIRMED\",\n \"level\": \"ITINERARY\",\n \"confirmed\": true,\n \"pending\": false,\n \"amended\": false,\n \"cancelled\": false,\n \"failed\": false\n },\n \"itemSummaries\": [{\n \"sortOrder\": 0,\n \"rulesApplied\": null,\n \"bookingStatus\": {\n \"status\": 1,\n \"text\": \"Paid &amp; Confirmed\",\n \"type\": \"CONFIRMED\",\n \"level\": \"ITEM\",\n \"failed\": false,\n \"confirmed\": true,\n \"amended\": false,\n \"pending\": false,\n \"cancelled\": false\n },\n \"travellerAgeBands\": [{\n \"sortOrder\": 0,\n \"count\": 2,\n \"pluralDescription\": \"Adults\",\n \"description\": \"Adult\",\n \"ageBandId\": 1\n }],\n \"voucherKey\": \"1000308214:899757cf8b419ed11f39045636b0b30af986d19126d04547097f4b9c05fb4b69:700179574\",\n \"voucherURL\": \"https://viatorapi.sandbox.viator.com/service/merchant/voucher.jspa?code=1000308214:899757cf8b419ed11f39045636b0b30af986d19126d04547097f4b9c05fb4b69:700179574&embedResources=false\",\n \"voucherRequirements\": \"You must present a paper voucher for this tour. We will email a link to access and print your voucher at the Lead Travelers email address.\",\n \"productPulledDown\": false,\n \"merchantCancellable\": true,\n \"productWidgetList\": null,\n \"savingAmount\": 0,\n \"vouchers\": null,\n \"passbooks\": null,\n \"termsAndConditions\": null,\n \"itineraryId\": 1000308214,\n \"productCode\": \"2065CPT\",\n \"tourGradeCode\": \"1DAY\",\n \"distributorItemRef\": \"distroItemRefJDP1006151732\",\n \"languageServicesLanguageCode\": \"en\",\n \"travelDate\": \"2015-09-03\",\n \"price\": 26.28,\n \"leadTravellerSurname\": \"Test\",\n \"barcodeOption\": \"tour\",\n \"barcodeType\": \"code128\",\n \"destId\": 318,\n \"voucherOption\": \"VOUCHER_PAPER_ONLY\",\n \"productTitle\": \"City Sightseeing Cape Town Hop-On Hop-Off Tour\",\n \"itemId\": 700179574,\n \"obfsId\": 27643,\n \"departurePoint\": \"Tour starts at V&amp;A Waterfront, outside the Two Oceans Aquarium, however you may board the bus at any one of the stops throughout the city (see the Itinerary section below for a list of stops)\",\n \"departurePointAddress\": \"\",\n \"departurePointDirections\": \"\",\n \"leadTravellerTitle\": \"Mr\",\n \"leadTravellerFirstname\": \"Homer\",\n \"lastRetailPrice\": 26.28,\n \"bookingEngineId\": \"UF\",\n \"priceFormatted\": \"$26.28\",\n \"savingAmountFormatted\": \"\",\n \"merchantNetPrice\": 26.28,\n \"merchantNetPriceFormatted\": \"$26.28\",\n \"currencyCode\": \"USD\",\n \"lastRetailPriceFormatted\": \"$26.28\",\n \"departsFrom\": \"Cape Town, South Africa\",\n \"tourGradeDescription\": \"1-Day Bus Tour (1DAY)\",\n \"hoursConfirmed\": 0,\n \"priceUSD\": 26.28\n }],\n \"voucherURL\": \"https://viatorapi.sandbox.viator.com/service/merchant/voucher.jspa?code=1000308214:899757cf8b419ed11f39045636b0b30af986d19126d04547097f4b9c05fb4b69&embedResources=false\",\n \"voucherKey\": \"1000308214:899757cf8b419ed11f39045636b0b30af986d19126d04547097f4b9c05fb4b69\",\n \"bookerEmail\": \"jocelyn@viator.com\",\n \"itineraryId\": 1000308214,\n \"exchangeRate\": 1,\n \"distributorRef\": \"distroRefJDP1006151732\",\n \"totalPrice\": 26.28,\n \"bookingDate\": \"2015-06-10\",\n \"totalPriceFormatted\": \"$26.28\",\n \"totalPriceUSD\": 26.28,\n \"hasVoucher\": true,\n \"userId\": null,\n \"currencyCode\": \"USD\"\n },\n \"dateStamp\": \"2015-06-10T00:33:24+0000\", \"errorType\": null,\n \"errorMessage\": null,\n \"errorName\": null,\n \"success\": true,\n \"totalCount\": 1,\n \"vmid\": \"321004\",\n \"errorMessageText\": null\n}\n```\n\n# Testing\n\n## Postman collection for testing\n\nTo facilitate your testing of the APIs functionality in the sandbox environment, please use the following file, which can be loaded into the [Postman](https://www.getpostman.com/) API development environment via its **import** function:\n\n - [Merchant partner API Postman collection](https://docs.viator.com/partner-api/resources/merchant/technical/postman/Viator-API-merchant-Postman.json)\n\n### Setting up API-key authentication in Postman\n\nBefore you start using the linked Postman collection for testing, you will need to set up the authorization method you wish to use. This can be either the new method (the `exp-api-key` <u>header</u> parameter) or, the legacy method (the `apiKey` <u>query</u> parameter).\n\nWhile both methods remain available, we strongly recommend that you use the new method, as it:\n\n1. Provides access to all languages available for your organization with a single API-key as opposed to one API-key per language\n2. Allows access to the new [booking cancellation endpoints](#section/Common-workflows-and-data-validation/Cancellation-API-workflow), as well as all newly-created endpoints in future\n \nPlease speak to your account manager if you are still using the legacy apiKey and would like to switch to our new authentication mechanism.\n\n#### How to set up the new exp-api-key header parameter\n\n1. Select **Edit** from the collection menu:\n\n\n\n2. Set the following values:\n\n* **Key**: `exp-api-key`\n* **Value**: Your organization's single exp-api-key, which will have an identical format to that shown in the image below\n* **Add to**: Header\n\n\n\n3. Click **Update**\n\n#### How to set up the legacy apiKey query parameter\n\n1. Select **Edit** from the collection menu:\n\n\n\n2. Set the following values:\n\n* **Key**: `apiKey`\n* **Value**: One of your organization's legacy apiKeys, which will have an identical format to that shown in the image below\n* **Add to**: Query Params\n\n\n\n3. Click **Update**\n\n# FAQs\n\n**Is a confirmation email sent to the customer or supplier when a booking is made in the sandbox environment?**\n\n* No.\n\n**How do I make a demo booking?**\n\n* To make a demo booking, make sure you set `demo` to `true` in your request to the [/booking/book](#operation/bookingBook) service.\n\n**What should I do if I successfully create a test booking in the Live environment?**\n\n* Firstly, please don't make test bookings in the Live environment, as doing so may cause a confirmation email to be sent to the product supplier. Nonetheless, if you have made a test booking, cancel it using the [/bookings/{id}/cancel](#operation/cancelBooking) service; or, send an email to dpsupport@viator.com and include both \"CANCEL\" and the booking reference number in the subject line.\n\n**Which currencies can I use when making a booking?**\n\n* You can make a booking using the [/booking/book](#operation/bookingBook) endpoint using any of the [supported currencies](#section/Appendices/Supported-currency-codes).\n* If you attempt to use a non-supported currency, you will receive an error message similar to the following:\n\n```json\n{\n \"errorReference\": \"3D45567E:2D4A_0A5D033A:01BB_5F616D10_1FBBC9:7035\",\n \"data\": null,\n \"dateStamp\": \"2020-09-15T18:41:00+0000\",\n \"errorType\": \"EXCEPTION\",\n \"errorCodes\": [\n \"UNKNOWN_ERROR\"\n ],\n \"errorMessage\": [\n \"Merchant API does not allow the specified currency\"\n ],\n \"errorName\": \"RuntimeException\",\n \"extraInfo\": {},\n \"extraObject\": null,\n \"success\": false,\n \"totalCount\": 1,\n \"errorMessageText\": [\n \"Merchant API does not allow the specified currency\"\n ],\n \"vmid\": \"331001\"\n}\n```\n\n**Why am I having an SSL handshake issue?**\n\n* It may be that your SSL certificates have expired. Check this. Also, if you are using Java, make sure that it's [updated to the latest version](https://www.java.com/en/download/).\n\n**What is the difference between `merchantNetPrice` and `price` in the response from the [/search/products](#operation/searchProducts) service?**\n\n* `merchantNetPrice` is the amount you, as the merchant partner, will be invoiced for, excluding any fees.\n* `price` is the price at which Viator sells the product\n\n**Why is a different price displayed in [/booking/availability/tourgrades](#operation/bookingAvailabilityTourgrades) and [/product](#operation/product)**\n\n* [/product](#operation/product) displays the lowest possible price per traveller; whereas, [/booking/availability/tourgrades](#operation/bookingAvailabilityTourgrades) shows the per-traveller price based on the age-band and number of travellers within that age-band.\n\n**A destination is missing its latitude, longitude or time zone**\n\n* Some destinations in the **sandbox** environment may be missing geolocation or time zone data. However, if you encounter a destination in the **Live** environment with missing information, this can be regarded as an unintended omission – please contact us so that we can update our destination information.\n\n**How do I make a test booking?**\n\nTo make a test booking, make sure you:\n\n- set `firstname` and/or `surname` in the `booker` object to `'test'`.\n- set `demo` to `true`\n\nExample:\n\n```javascript\n{\n \"demo\": true,\n \"currencyCode\": \"USD\",\n \"partnerDetail\": {\n \"distributorRef\": \"distroRef0412141435\"\n },\n \"booker\": {\n \"email\": \"apitest@viator.com\",\n \"firstname\": \"Test\",\n \"surname\": \"Test\",\n \"title\": \"Mr\"\n },\n \"items\": [{\n \"partnerItemDetail\": {\n \"distributorItemRef\": \"distroItemRef0412141435_1\"\n },\n \"hotelId\": null,\n \"pickupPoint\": null,\n \"travelDate\": \"2015-03-31\",\n \"productCode\": \"2916ROME\",\n \"tourGradeCode\": \"24HR\",\n \"languageOptionCode\": \"en/SERVICE_GUIDE\",\n \"bookingQuestionAnswers\": [{\n \"questionId\": 100,\n \"answer\": \"120 kgs\"\n }],\n \"specialRequirements\": \"\",\n \"travellers\": [{\n \"bandId\": 1,\n \"firstname\": \"Homer\",\n \"surname\": \"Simpson Test\",\n \"title\": \"Mr\",\n \"leadTraveller\": true\n }]\n }]\n}\n```\n\n**Is it possible to use a custom value for `distributorRef` and `distributorItemRef`**\n\n* Yes! In fact, this is what you're supposed to do. You can pass anything you like in these fields; however, if you use a `distributorRef` that has already been used, the API will return the previous booking made with that `distributorRef` rather than creating a new booking.\n* **Note**: `distributorRef` must be fewer than 40 characters\n\n**What are some common reasons for bookings to fail in the Viator API?**\n\n- `homePhone` or any phone field in the booking request contains spaces. The only acceptable non-numeric characters are: “-“, “+” , “(“, and “)”\n\n- `distributorRef` has been re-used. When making a booking request, a `distributorRef` and `distributorItemRef` must be provided. This is the partner’s ID for the booking, and it must be unique. If a `distributorRef` has been re-used, a booking will not be made and instead, the existing booking will be returned in the response.\n\n- `distributorRef` exceeds 40 characters\n\n- No traveller or an incorrect traveller has been set as the lead traveller in the booking request;\n + `leadTraveller`:`true` must be set for one traveller\n + the `leadTraveller` must be from an `ageBand` that has `treatAsAdult` set to `true`. The data is available in the `ageBands` object in the product details service.\n\n- `languageOptionCode` is invalid\n + To find the valid language option codes for a particular product, have a look at the `langServices` object in the response from the [/product](#operation/product) service; e.g.,\n\n```javascript\n\"langServices\": {\n \"en/SERVICE_AUDIO\": \"English - Audio\"\n}\n```\n + You must then ensure that the `languageOptionCode` in the request to the [/booking/book](#operation/bookingBook) service is populated in the same way; i.e.,\n\n```javascript\n\"languageOptionCode\": \"en/SERVICE_AUDIO\"\n```\n\n**What does it mean if I receive a \"Section level access denied\" error message?**\n\n- This means that your API-key does not have the correct permissions to access the particular service you were attempting to access when you received this error message. If you feel you would like to use this service nonetheless in your implementation, please contact your account manager to discuss having access granted.\n\n**What does it mean if I receive a \"503 Service Unavailable\" response?**\n\n- This means that there was a temporary service outage on our end at that time. We recommend that you re-try the operation until you no longer receive this error.\n\n**Does API rate limiting apply to all services?**\n\n- Yes, it does. Regardless of the service you are making requests to, the fundamental rate limits apply equally.\n\n**Can I cancel multiple bookings or items at the same time using the Viator API?**\n\n- No, you may only cancel one booking at a time.\n\n**How many concurrent requests can be made of the API from the same IP address?**\n\n- Three.\n\n**Will my API-key expire?**\n\n- If any API-key is not used for a period of six months, that key is automatically deactivated as a security measure. If this has happened to you, contact your account manager to have the key reactivated or a new key issued to you.\n\n**Why am I getting an empty response when checking booking details?**\n\n- If you are attempting to check a booking using the [/booking/status](#operation/bookingStatus) or [/booking/status/items](#operation/bookingStatusItems) endpoints and receive an empty response, it may be that the booking was made with the demo parameter set to `true`, as the booking status endpoints will ignore demo bookings. Please try making the booking again, ensuring the demo parameter is set to `false`. If this also fails, please email dpsupport@viator.com and include a copy of the request and response JSON objects.\n\n**Must I always provide details for all travelers when booking a product where `allTravellerNamesRequired`=`true`?**\n\n- Approximately 45% of the products in our catalog require all traveller details to be supplied at the time of booking, and this requirement is enforced by the API. While it is technically possible to bypass this requirement – for example, by setting the lead traveler's name, but using dummy values for the the remaining travelers' details ('traveler 2', etc.) – we strongly advise against this, as it can cause problems for suppliers for whom this is a strict requirement. Examples include: Alcatraz tickets, theme park tickets that require a QR code, bookings for flights needing to meet TSA requirements; or, vehicle, Segway or jet-ski rentals. If you are unable to implement the collection of all traveler details on your site, we recommend filtering-out products where this is a strict requirement. You may also request that we filter-out these products for you so that they do not appear in product search results.\n\n**Must I always provide answers to the required booking questions when making a booking?**\n\n- Yes. You must provide answers to all necessary booking questions when making a booking. Approximately 40% of the products in our catalog have booking questions, some of which may be necessary to fulfil the suplier's legal requirements. In the case that the customer cannot provide specific details at the time of booking – e.g., a departure flight number – they may enter 'unknown' and the supplier will manually send a follow-up message to ask for this information.\n\n**Why is there such a big difference in price between that given in the product endpoints and the actual price at the time of booking?**\n\n- The price returned in the product endpoints is the 'From Price', which is the <u>lowest possible price</u> for an adult passenger when taking into account all available tour grades, group bookings and so forth. The exact price can only be determined when you check the availability for a specific date and passenger/traveler mix. We recommend using the [/booking/availability/tourgrades](#operation/bookingAvailabilityTourgrades) endpoint for this purpose.\n\n**Why doesn't the [/taxonomy/destinations](#operation/taxonomyDestinations) endpoint return continent-level information?**\n\n- Products are categorized according to their 'destination', which includes cities, regions and countries. The next logical grouping would be 'by continent'; however, this would be too broad a grouping, resulting in too many search results and lengthy response times if the product catalogue were to be searched by continent. For more information, see: [Categorization of content](#section/Key-concepts/Categorization-of-content)\n\n**Will there ever be a discrepancy between the amount charged for a tour and the amount refunded due to currency exchange-rate fluctuations?**\n\n- In short: no. Firstly, the cost of the booking and the refund amount are always calculated in the product supplier's native currency – no exchange rate calculations are applied. I.e., if the cost of the booking was USD 100 and the refund percentage is 100% (full refund, as per the response from [/bookings/{booking-reference}/cancel-quote](#operation/cancelBookingQuote)), Viator will simply not invoice you for that USD 100 that we would have if the booking was not canceled. Furthermore, we do not invoice you for the cost of a booking prior to its departure date. \n\n# Appendices\n\n## Update log\n\n| Date | Description |\n|------|-------------|\n| 20 July 2020 | Added [Booking references](#section/Key-concepts/Booking-references) section |\n| 14 July 2020 | Updated [Calculating prices](#section/Common-workflows-and-data-validation/Calculating-prices) section |\n| 2 June 2020 | Updated Postman collections and [Testing](#section/Testing) section |\n| 18 May 2020 | Added note regarding cancel codes to [Legacy merchant cancellation](#section/Appendices/Legacy-merchant-cancellation) section |\n| 7 May 2020 | Upgraded search feature; enabled 'Try it Out' console |\n| 10 Mar 2020 | Created new [Overview](#section/Overview) section; removed 'Availability services' section, moving section contents into [Key Concepts](#section/Key-concepts) section |\n\n## Accept-Language header\n\nThe `Accept-Language` header parameter controls which language the natural language fields in the response from each endpoint will be translated into.\n\nNote that you can only specify languages that have been configured for your API-key. Therefore, if you wish to access additional languages, you will need to contact your business development account manager.\n\n| Language | Accept-Language parameter value |\n|----------|-------|\n| English | `en`, `en-US` |\n| Danish | `da`, `da-DK` |\n| Dutch | `nl`, `nl-NL` |\n| Norwegian | `no`, `no-NO` |\n| Spanish | `es`, `es-ES` |\n| Swedish | `sv`, `sv-SE` |\n| French | `fr`, `fr-FR` |\n| Italian | `it`, `it-IT` |\n| German | `de`, `de-DE` |\n| Portuguese | `pt`, `pt-PT` |\n| Japanese | `ja`, `ja-JP` |\n| Chinese (simplified) | `zh-CN` |\n| Chinese (traditional) | `zh-TW` |\n| Korean | `ko`, `ko-KR` |\n\n## Standard JSON fields\n\nEvery service returns a standard set of JSON fields at the end of the JSON response, which indicates if it was processed successfully by the API.\n\nIn addition to the `success` flag, you will also need to check the `errorMessage` values for the status of the response. \n\nAn error-free response will have:\n\n- `\"success\"`:`true`\n- `\"errorType\"`:`null`\n- `\"errorMessage\"`:`null`\n\n### Example JSON - successful:\n\n```javascript\n{\n \"data\": [],\n \"vmid\": \"321001\",\n \"errorMessage\": null,\n \"errorType\": null,\n \"dateStamp\": \"2013-03-06T19:45:10+0000\",\n \"errorReference\": null,\n \"errorMessageText\": null,\n \"success\": true,\n \"totalCount\": 114,\n \"errorName\": null\n}\n```\n\n### Example JSON - unsuccessful:\n\n```javascript\n{\n \"errorReference\": \"~5793740141815885188840666\",\n \"data\": null,\n \"dateStamp\": \"2013-09-09T11:29:48+0000\",\n \"errorType\": \"EXCEPTION\",\n \"errorMessage\": [\"* Additional questions missing\\n\"],\n \"errorName\": \"ValidationException\",\n \"success\": false,\n \"totalCount\": 1,\n \"vmid\": \"221001\",\n \"errorMessageText\": [\"* Additional questions missing\" ]\n}\n```\n\n| Element | Type | Comments | To be viewed by customer | Required |\n|---------|------|----------|:------------------------:|:--------:|\n| `vmid` | string | The server id that processed the service | ❌ | ✅ |\n| `errorMessage` | string | The error message in HTML | ❌ | ✅ |\n| `errorType` | string | Type of error: EXCEPTION | ❌ | ✅ |\n| `dateStamp` | string | timestamp of the response | ❌ | ✅ |\n| `errorReference` | string | The error reference is logged for future reference | ❌ | ✅ |\n| `errorMessageText` | string | The textual version of the error message | ✅<br /> (if an error has occurred) | ✅ |\n| `success` | boolean | <ul><li>`true` if the API request was successful with no errors</li><li>`false` if an error was encountered</li></ul> | ❌ | ✅ |\n| `totalCount` | integer | The number of results returned (minimum = `1`) | ✅<br /> (if displaying the number of results found in a search etc.) | ✅ |\n| `errorName` | string | The name of the error type | ❌ | ✅ |\n\n## Country codes\n| Country code | Country |\n|--------------|---------|\n| AF | Afghanistan |\n| AL | Albania |\n| DZ | Algeria |\n| AS | American Samoa |\n| AD | Andorra |\n| AO | Angola |\n| AI | Anguilla |\n| AQ | Antarctica |\n| AG | Antigua and Barbuda |\n| AR | Argentina |\n| AM | Armenia |\n| AW | Aruba |\n| AU | Australia |\n| AT | Austria |\n| AZ | Azerbaijan |\n| BS | Bahamas |\n| BH | Bahrain |\n| BD | Bangladesh |\n| BB | Barbados |\n| BY | Belarus |\n| BE | Belgium |\n| BZ | Belize |\n| BJ | Benin |\n| BM | Bermuda |\n| BT | Bhutan |\n| BO | Bolivia |\n| BA | Bosnia Herzegovina |\n| BW | Botswana |\n| BR | Brazil |\n| BN | Brunei |\n| BG | Bulgaria |\n| BF | Burkina Faso |\n| BI | Burundi |\n| KH | Cambodia |\n| CM | Cameroon |\n| CA | Canada |\n| CV | Cape Verde |\n| KY | Cayman Islands |\n| CF | Central Africa |\n| TD | Chad |\n| CL | Chile |\n| CN | China |\n| CX | Christmas Island |\n| CC | Cocos (Keeling) Islands |\n| CO | Colombia |\n| KM | Comoros |\n| CK | Cook Islands |\n| CR | Costa Rica |\n| CI | Cote D'Ivoire |\n| HR | Croatia |\n| CY | Cyprus |\n| CZ | Czech Republic |\n| DK | Denmark |\n| DJ | Djibouti |\n| DM | Dominica |\n| DO | Dominican Republic |\n| EC | Ecuador |\n| EG | Egypt |\n| SV | El Salvador |\n| GQ | Equatorial Guinea |\n| ER | Eritrea |\n| EE | Estonia |\n| ET | Ethiopia |\n| FK | Falkland Island |\n| FO | Faroe Islands |\n| FJ | Fiji |\n| FI | Finland |\n| FR | France |\n| GF | French Guiana |\n| PF | French Polynesia |\n| GA | Gabon |\n| GM | Gambia |\n| GE | Georgia |\n| DE | Germany |\n| GH | Ghana |\n| GI | Gibraltar |\n| GR | Greece |\n| GL | Greenland |\n| GD | Grenada |\n| GP | Guadeloupe |\n| GU | Guam |\n| GT | Guatemala |\n| GN | Guinea |\n| GW | Guinea Bissau |\n| GY | Guyana |\n| HT | Haiti |\n| HN | Honduras |\n| HK | Hong Kong |\n| HU | Hungary |\n| IS | Iceland |\n| IN | India |\n| ID | Indonesia |\n| IQ | Iraq |\n| IE | Ireland |\n| IL | Israel |\n| IT | Italy |\n| JM | Jamaica |\n| JP | Japan |\n| JO | Jordan |\n| KZ | Kazakhstan |\n| KE | Kenya |\n| KI | Kiribati |\n| KW | Kuwait |\n| KG | Kyrgyzstan |\n| LA | Lao People's Democratic Republic |\n| LV | Latvia |\n| LB | Lebanon |\n| LS | Lesotho |\n| LR | Liberia |\n| LY | Libyan Arab Jamahiriya |\n| LI | Liechtenstein |\n| LT | Lithuania |\n| LU | Luxembourg |\n| MO | Macau |\n| MK | Macedonia |\n| MG | Madagascar |\n| MW | Malawi |\n| MY | Malaysia |\n| MV | Maldives |\n| ML | Mali |\n| MT | Malta |\n| MQ | Martinique |\n| MR | Mauritania |\n| MU | Mauritius |\n| YT | Mayotte |\n| MX | Mexico |\n| FM | Micronesia |\n| MD | Moldova |\n| MC | Monaco |\n| MN | Mongolia |\n| MS | Monserrat |\n| MA | Morocco |\n| MZ | Mozambique |\n| NA | Namibia |\n| NR | Nauru |\n| NP | Nepal |\n| NL | Netherlands |\n| AN | Netherlands Antilles |\n| KN | Nevis- St Kitts |\n| NC | New Caledonia |\n| NZ | New Zealand |\n| NI | Nicaragua |\n| NE | Niger |\n| NG | Nigeria |\n| NU | Niue |\n| NF | Norfolk Island |\n| KP | North Korea |\n| MP | Northern Mariana Islands |\n| NO | Norway |\n| OM | Oman |\n| PK | Pakistan |\n| PW | Palau |\n| PS | Palestinian Territory, Occupied |\n| PA | Panama |\n| PG | Papua New Guinea |\n| PY | Paraguay |\n| PE | Peru |\n| PH | Philippines |\n| PN | Pitcairn |\n| PL | Poland |\n| PT | Portugal |\n| PR | Puerto Rico |\n| QA | Qatar |\n| RE | Reunion |\n| RO | Romania |\n| RU | Russian Federation |\n| RW | Rwanda |\n| SH | Saint Helena |\n| LC | Saint Lucia |\n| SM | San Marino |\n| ST | Sao Tome and Principe |\n| SA | Saudi Arabia |\n| SN | Senegal |\n| YU | Serbia and Montenegro |\n| SC | Seychelles |\n| SL | Sierra Leone |\n| SG | Singapore |\n| SK | Slovakia |\n| SI | Slovenia |\n| SB | Solomon Islands |\n| SO | Somalia |\n| ZA | South Africa |\n| KR | South Korea |\n| ES | Spain |\n| LK | Sri Lanka |\n| PM | St Pierre Miquelon |\n| VC | St Vincent and Grenadines |\n| SR | Suriname |\n| SZ | Swaziland |\n| SE | Sweden |\n| CH | Switzerland |\n| SY | Syria |\n| TW | Taiwan |\n| TJ | Tajikistan |\n| TZ | Tanzania |\n| TH | Thailand |\n| TL | Timor-Leste |\n| TG | Togo |\n| TK | Tokelau |\n| TO | Tonga |\n| TT | Trinidad and Tobago |\n| TN | Tunisia |\n| TR | Turkey |\n| TM | Turkmenistan |\n| TC | Turks and Caicos Islands |\n| TV | Tuvalu |\n| UG | Uganda |\n| UA | Ukraine |\n| AE | United Arab Emirates |\n| GB | United Kingdom |\n| UY | Uruguay |\n| UM | US Minor Outlying Islands |\n| US | United States of America |\n| UZ | Uzbekistan |\n| VU | Vanuatu |\n| VE | Venezuela |\n| VN | Vietnam |\n| VG | Virgin Islands-British |\n| VI | Virgin Islands-US |\n| WF | Wallis and Futuna Islands |\n| WS | Western Samoa |\n| YE | Yemen Republic |\n| ZM | Zambia |\n| ZW | Zimbabwe |\n\n## US state codes\n| State code | State |\n|------------|-------|\n| AL | Alabama |\n| AK | Alaska |\n| AZ | Arizona |\n| AR | Arkansas |\n| CA | California |\n| CO | Colorado |\n| CT | Connecticut |\n| DE | Delaware |\n| DC | District of Columbia |\n| FL | Florida |\n| GA | Georgia |\n| HI | Hawaii |\n| ID | Idaho |\n| IL | Illinois |\n| IN | Indiana |\n| IA | Iowa |\n| KS | Kansas |\n| KY | Kentucky |\n| LA | Louisiana |\n| ME | Maine |\n| MD | Maryland |\n| MA | Massachusetts |\n| MI | Michigan |\n| MN | Minnesota |\n| MS | Mississippi |\n| MO | Missouri |\n| MT | Montana |\n| NE | Nebraska |\n| NV | Nevada |\n| NH | New Hampshire |\n| NJ | New Jersey |\n| NM | New Mexico |\n| NY | New York |\n| NC | North Carolina |\n| ND | North Dakota |\n| OH | Ohio |\n| OK | Oklahoma |\n| OR | Oregon |\n| PA | Pennsylvania |\n| RI | Rhode Island |\n| SC | South Carolina |\n| SD | South Dakota |\n| TN | Tennessee |\n| TX | Texas |\n| UT | Utah |\n| VT | Vermont |\n| VA | Virginia |\n| WA | Washington |\n| WV | West Virginia |\n| WI | Wisconsin |\n| WY | Wyoming |\n\n## Canadian provinces\n\n| Code | Province |\n|------|----------|\n| Alberta | Alberta |\n| British Columbia | British Columbia |\n| Manitoba | Manitoba |\n| New Brunswick | New Brunswick |\n| Newfoundland and Labrador | Newfoundland |\n| Northwest Territories | Northwest Territories |\n| Nova Scotia | Nova Scotia |\n| Nunavut | Nunavut |\n| Ontario | Ontario |\n| Prince Edward Island | Prince Edward Island |\n| Quebec | Quebec |\n| Saskatchewan | Saskatchewan |\n| Yukon | Yukon Territory |\n\n## Australian states\n\n| Code | State |\n|------|-------|\n| ACT | Australian Capital Territory |\n| NSW | New South Wales |\n| NT | Northern Territory |\n| QLD | Queensland |\n| SA | South Australia |\n| TAS | Tasmania |\n| VIC | Victoria |\n| WA | Western Australia |\n\n## bookingStatus field values and meanings\n\n| Field: `type` | Field: `status` | Meaning |\n|-------|:-----:|---------|\n| `\"WAITING\"` | `0` | This item has not been booked. Part of an unfinished itinerary. |\n| `\"CONFIRMED\"` | `1` | This item has been successfully booked |\n| `\"UNAVAILABLE\"` | `2` | This item has been had an availability check, that came back false. |\n| `\"PENDING\"` | `3` | This item has begun booking, but has paused in a deferred booking engine |\n| `\"FAILED\"` | `4` | A merchant partner with a freesale-only API-key has attempted to book an on-request product |\n| `\"CANCELLED\"` | `5` | This item has successfully been cancelled. |\n| `\"EXPIRED\"` | `6` | This item is now expired. |\n| `\"AMENDED\"` | `7` | This item has been amended after booking. |\n| `\"PENDING_AMEND\"` | `8` | This item has a pending amendment which can be cancelled. |\n| `\"REJECTED\"` | `12` | Viator only |\n| `\"ON_HOLD\"` | `13` | Viator only |\n\n## Supported currency codes\n\nSupported currency codes for merchant partners:\n\n| Currency code | Currency |\n|---------------|----------|\n| USD | US dollar |\n| GBP | British pound |\n| EUR | Euro |\n| AUD | Australian dollar |\n\n**Note:** Partners will be billed in the currency of the booking.\n\n## Viator API error codes\n\n| Error code | Services | Error message | Description |\n|------------|----------|---------------|-------------|\n| ADDRESS_REQUIRED | [/booking/book](#operation/bookingBook) | \"You have not entered an address. Please enter your address information.\" | `ccAddress1` was empty |\n| ADDRESS_SIZE_EXCEEDED | [/booking/book](#operation/bookingBook) | \"Billing address is restricted to 50 characters long.\" | `address` field was longer than 51 characters |\n| ATTRIBUTE_NOT_FOUND | [/product](#operation/product) | | |\n| AGE_BAND_INVALID | [/booking/book](#operation/bookingBook) | | a `bandId` has been submitted that does not correspond to any `bandId` available for the tour grade in question |\n| BOOKING_QUESTIONS_MISSING | [/booking/book](#operation/bookingBook) | \"Additional questions missing\" | one or more required [booking questions](#section/Appendices/Booking-questions) are missing in the booking request |\n| CARD_EXPIRED | [/booking/book](#operation/bookingBook) | | submitted credit card details corresponding to an expired card |\n| CITY_REQUIRED | [/booking/book](#operation/bookingBook) | \"You have not entered a city in the address section. Please enter your city.\" | address is required in the credit card section |\n| CITY_SIZE_EXCEEDED | [/booking/book](#operation/bookingBook) | \"City is restricted to 40 characters long.\" | city name submitted was more than 40 characters long |\n| COUNTRY_REQUIRED | [/booking/book](#operation/bookingBook) | \"You have not entered a country. Please enter your country.\" | no country was submitted in the booking request |\n| CREDIT_CARD_DECLINED | [/booking/book](#operation/bookingBook) | | credit card used for booking was declined by the payment processor |\n| CREDIT_CARD_EXPIRY_DATE_INVALID | [/booking/book](#operation/bookingBook) | \"The expiration date for your credit card is not formatted properly. Please verify and re-enter the expiration date.\" | incorrectly-formatted credit card expiration date was submitted |\n| CREDIT_CARD_HOLDER_NAME_INVALID | [/booking/book](#operation/bookingBook) | | credit card holder's name was invalid, perhaps due to the inclusion of invalid characters |\n| CREDIT_CARD_NUMBER_INVALID | [/booking/book](#operation/bookingBook) | \"Please verify and re-enter the credit card details, or use a different credit card\" | invalid characters in credit card number |\n| CREDIT_CARD_NUMBER_REQUIRED | [/booking/book](#operation/bookingBook) | \"Credit card number is required\" | credit card number was omitted |\n| CREDIT_CARD_SECURITY_NUMBER_INVALID | [/booking/book](#operation/bookingBook) | \"The card security number you entered for your credit card is invalid. It must contain 3 digits (or 4 with American Express cards). Please re-enter the card security number.\" | incorrect CCV code submitted |\n| CREDIT_CARD_SECURITY_NUMBER_REQUIRED | [/booking/book](#operation/bookingBook) | \"Credit card security number is required\" | CCV was not provided |\n| DEMO_BOOKING_WITH_REAL_CARD | [/booking/pricingmatrix](#operation/bookingPricingmatrix) | | `demo` is `true`, but credit card details are real |\n| DISTRIBUTOR_REFERENCE_MISMATCH | [/booking/pastbooking](#operation/bookingPastbooking); [/booking/mybookings](#operation/bookingMybookings) | \"The distributor reference associated with this itinerary does not match the one provided.\" | attempt to retrieve a booking with an `itineraryId` or `itemId` and `distributorRef`, but the reference doesn't match the one saved in the itinerary |\n| EMAIL_ADDRESS_INVALID | [/booking/book](#operation/bookingBook) | \"Your email address format is invalid\" | email address is formatted incorrectly |\n| EMAIL_REQUIRED | [/booking/book](#operation/bookingBook) | \"Email is required\" | email address is missing in the booking request |\n| FIRST_NAME_INVALID | [/booking/book](#operation/bookingBook) | \"You have entered a name for the credit-card holder that is not valid. Please verify and re-enter the name of the credit card holder.\" | first name is formatted incorrectly or contains invalid characters in the booking request - string length must be > 1 and must not contain the following characters: <>%;\"(),|\n| FIRST_NAME_REQUIRED | [/booking/book](#operation/bookingBook) | \"First name of credit card details is required\" | no first name specified |\n| FIRST_NAME_SIZE_EXCEEDED | [/booking/book](#operation/bookingBook) | \"First name of credit card details is restricted to 30 characters long\" | first name exceeds 30 characters |\n| INTERNAL_ERROR | *any* | *any* | the API itself has experienced an unexpected error |\n| LAST_NAME_INVALID | [/booking/book](#operation/bookingBook) | \"You have entered a name for the credit-card holder that is not valid. Please verify and re-enter the name of the credit card holder.\" | last name is formatted incorrectly in the booking request - string length must be > 1 and must not contain the following characters: <>%;\"(), |\n| LAST_NAME_REQUIRED | [/booking/book](#operation/bookingBook) | \"Last name of credit card details is required\" | no last name supplied in the `ccname` field of the `ccPayDetail` object |\n| LAST_NAME_SIZE_EXCEEDED | [/booking/book](#operation/bookingBook) | \"Last name of credit card details is restricted to 35 characters long\" | the surname in the `ccname` field of the `ccPayDetail` object must not exceed 35 characters in length |\n| LEAD_TRAVELLER_REQUIRED | [/booking/book](#operation/bookingBook) | \"A traveler needs to be selected as lead traveler.\" | one traveller object within the `travellers` array in the booking request needs to have `leadTraveller` set to `true` |\n| PAYMENT_AMOUNTS_CHANGED | [/booking/book](#operation/bookingBook) | e.g. \"PAYMENT_AMOUNTS_CHANGED: HKD 2213.20 (was HKD 2210.26)\" | This error indicates that the exchange rate was updated while the booking was being made. Refresh the product's pricing information and retry the booking. |\n| PAYMENT_CURRENCY_MISMATCH | [/booking/book](#operation/bookingBook) | | |\n| PAYMENT_ENCRYPTION_ERROR | [/booking/book](#operation/bookingBook) | | Viator-only internal error - retry booking request |\n| PAYMENT_INTERNAL_ERROR | [/booking/book](#operation/bookingBook) | | Viator-only internal error - retry booking request |\n| PAYMENT_LIMIT_REACHED | [/booking/book](#operation/bookingBook) | | Viator-only internal error - retry booking request |\n| PAYMENT_REJECTED | [/booking/book](#operation/bookingBook) | | triggered when expiry: `\"01/2018\"` and card number: `\"4539791001730106\"` were submitted |\n| POSTCODE_REQUIRED | [/booking/book](#operation/bookingBook) | \"You have not entered a zip code / post code. Please enter your zip code / post code.\", | `ccaddressZip` was empty |\n| POSTCODE_SIZE_EXCEEDED | [/booking/book](#operation/bookingBook) | \"Zip code / post code is restricted to 10 characters long.\" | `ccaddressZip` was more than 10 characters in length |\n| PRICING_DATA_MISSING | | | Viator-only internal error - retry booking request |\n| PRODUCT_TOUR_GRADE_UNKNOWN | [/booking/pricingmatrix](#operation/bookingPricingmatrix) | Unknown tour grade: <TOUR_GRADE> for product | an invalid tour grade code was submitted |\n| PRODUCT_UNAVAILABLE | [/booking/book](#operation/bookingBook) | | Viator-only internal error - retry booking request |\n| REFUND_REJECTED | | | Viator-only internal error - retry booking request |\n| STATE_REQUIRED | [/booking/book](#operation/bookingBook) | | `ccaddressState` is required for this billing request |\n| STATE_SIZE_EXCEEDED | [/booking/book](#operation/bookingBook) | | `ccaddressState` must be fewer than 35 characters long |\n| TOUR_NOT_AVAILABLE | [/booking/book](#operation/bookingBook) | \"We're sorry, the following tour you are trying to book is sold out and no longer available\" | the tour is not available on the requested date |\n| TOUR_GONE | [/product](#operation/product) | \"We're sorry, we cannot find the tour, activity or attraction you are looking for\" | no product corresponding to the supplied details was found |\n| TOUR_NOT_AVAILABLE_BETWEEN_DATES | | | |\n| TOUR_NOT_FOUND | [/product](#operation/product) | \"We're sorry, we cannot find the tour, activity or attraction you are looking for\" | no product corresponding to the supplied details was found |\n| TRAVELLER_COUNT_EXCEEDED_MAX_LIMIT | | | number of travellers in the booking request was greater than the limit for the product being booked |\n| TRAVELLER_FIRST_NAME_INVALID | [/booking/book](#operation/bookingBook) | \"First name of traveler 1 must only contain alphabetical characters\" | non-alphabetical characters were used in the traveller's first name |\n| TRAVELLER_FIRST_NAME_REQUIRED | [/booking/book](#operation/bookingBook) | \"First name of traveler 1 is required\" | `firstname` in the `booker` object was omitted |\n| TRAVELLER_LAST_NAME_INVALID | [/booking/book](#operation/bookingBook) | \"Last name of traveler 1 should contain alphabet only\" | `surname` in the `booker` object contained non-alphabetical characters |\n| TRAVELLER_LAST_NAME_REQUIRED | [/booking/book](#operation/bookingBook) | \"Last name of traveler 1 is required\" | `surname` in the `booker` object was omitted |\n| TRAVELLER_MISMATCH | [/booking/availability/tourgrades](#operation/bookingAvailabilityTourgrades) | | the `bandId` is not available for the selected tour grade; or, the product does not support the number of travelers requested |\n| UNKNOWN_ERROR | *any* | *any* | the API reports this error when the exception from the underlying system (e.g. booking server) is not recognized |\n| UNKNOWN_PAYMENT_METHOD | | | |\n| UNSUPPORTED_CARD | | | `cctype` is not one of `\"Visa\"`, `\"Mastercard\"` or `\"Amex\"` |\n\n## Booking questions\n\nExample product codes were valid at the time of writing. If you find that any of these product codes are invalid or do not include the relevant booking question, please [inform us about it via email](apitechsupport@viator.com).\n\n| Id | stringQuestionId | title | subtitle | message | example product |\n|:----------:|-------------|-------|----------|----------|-----|\n| 1 | `dateOfBirth_dob` | Date of Birth | (e.g. 20 October 1970) | Enter your date of birth. | 100009P2 |\n| 2 | `heights_passengerHeights` | Passenger Heights | (eg. 5'2, 158cm etc) | For safety reasons you must enter the height of all passengers. Please indicate inches or centimetres. | 100009P1 |\n| 3 | `passport_expiry` | Passport Expiry Date | (e.g. 15 September 2015. If multiple passengers, separate each entry e.g. 01 July 2012, 31 May 2014) | Enter passport expiry date for all passengers | 100014P10 |\n| 4 | `passport_nationality` | Passport Nationality | (e.g. United States of America. If multiple passengers, separate each entry e.g. Australia, China) | Enter country of issue of passport for all passengers | 100014P10 |\n| 5 | `passport_passportNo` | Passport Number | (e.g. 0123456789. If multiple passengers, separate each entry e.g. 0123456789, 9876543210) | Enter passport number for all passengers | 100014P10 |\n| 6 | N/A | N/A | N/A | N/A | N/A |\n| 7 | `transfer_air_arrival_airline` | Arrival Airline | (e.g. United, British Airways, Qantas, etc) | Enter the name of your airline. | 100006P15 |\n| 8 | `transfer_air_arrival_flightNo` | Arrival Flight No | (e.g. UA 864, BA 923, QA 233, etc) | Enter your flight number. | 100006P15 |\n| 9 | `transfer_air_departure_airline` | Departure Airline | (e.g. United, British Airways, Qantas, etc) | Enter the name of your airline. | 100006P17 |\n| 10 | `transfer_air_departure_flightNo` | Departure Flight No | (e.g. UA 864, BA 923, QA 233, etc) | Enter your flight number. | 100006P17 |\n| 11 | `transfer_arrival_dropOff` | Drop Off Location | (e.g. 1234 Cedar Way, Brooklyn, NY 00123) | Enter the address for drop off. | 100006P15 |\n| 12 | `transfer_arrival_time` | Arrival Time | (eg. 8pm, 20:30 etc) | Enter your arrival time. Please indicate AM/PM or use the 24-hour clock. | 100006P15 |\n| 13 | `transfer_departure_date` | Departure date | (e.g. 15 September 2015) | Enter your departure date. | 100006P15 |\n| 14 | `transfer_departure_pickUp` | Pick up Location | (e.g. 1234 Cedar Way, Brooklyn, NY 00123) | Enter the address for pick up. | 100006P17 |\n| 15 | `transfer_departure_time` | Departure Time | (eg. 8pm, 20:30 etc) | Enter your departure time. Please indicate AM/PM or use the 24-hour clock. | 100006P17 |\n| 16 | `transfer_port_arrival_time` | Disembarkation Time | (eg. 8pm, 20:30 etc) | Enter your disembarkation time. Please indicate AM/PM or use the 24-hour clock. | 100014P14 |\n| 17 | `transfer_port_cruiseShip` | Cruise Ship | (e.g. Brilliance of the Seas, etc) | Enter your cruise ship. | 100014P14 |\n| 18 | `transfer_port_departure_time` | Boarding Time | (eg. 8pm, 20:30 etc) | Enter your boarding time. Please indicate AM/PM or use the 24-hour clock. | 100014P4 |\n| 19 | `transfer_rail_arrival_line` | Arrival Rail Line | (e.g. Amtrak, etc) | Enter the name of the rail provider. | 100006P15 |\n| 20 | `transfer_rail_arrival_station` | Arrival Rail Station | (e.g. Central Station, etc) | Enter name of arrival and/or departure station. | 100006P15 |\n| 21 | `transfer_rail_departure_line` | Departure Rail Line | (e.g. Amtrak, etc) | Enter the name of the rail provider. | 100014P10 |\n| 22 | `transfer_rail_departure_station` | Departure Rail Station | (e.g. Central Station, etc) | Enter name of arrival and/or departure station. | 100014P10 |\n| 23 | `weights_passengerWeights` | Passenger Weights | (e.g. 127 pounds, 145 kilos, etc) | For safety reasons you must enter the weight of <b>all</b> passengers. Please indicate pounds or kilos. | 100111P12 |\n\n## Legacy merchant cancellation\n\n**Note:** This functionality has been replaced by the [cancellationReasons](#operation/cancellationReasons), [bookingQuote](#operation/bookingQuote) and [cancelBooking](#operation/cancelBooking) endpoints.\n\n### Requirements for cancellations\n\n- To successfully cancel a booking via the [/merchant/cancellation](#operation/merchantCancellation) service, you must include the itinerary item to cancel (`itemId`). \n\n- `itineraryItemId` and `itineraryId` need to match the `distributorRef` and `distributorItemRef`, so these four values must also be included in the request body. \n\n- You must also include a `cancelCode` - a number corresponding to the reason for cancellation. You can use the <a href=\"#suggested-cancellation-codes\">suggested cancel codes</a> shown in the table below.\n\n\n<mark>**Note**: Post-travel cancellations **will not be processed** unless a cancel code of `62` or `66` is passed in the `cancelCode` parameter.</mark>\n### The [/merchant/cancellation](#operation/merchantCancellation) service:\n\n#### Description of JSON request parameters for the [/merchant/cancellation](#operation/merchantCancellation) service:\n\n| Parameter | Type | Comments | Required |\n|-----------|------|----------|:--------:|\n| `itineraryId` | integer | Viator itinerary reference number | ✅ |\n| `distributorRef` | string | Merchant partner's itinerary reference for booking | ✅ |\n| `cancelItems` | array | Array of item to cancel in itinerary | ✅ |\n| `itemId` | integer | Viator `itemId` of item to cancel in itinerary | ✅ |\n| `distributorItemRef` | string | Merchant partner's itinerary item (booking) reference | ✅ |\n| `cancelCode` | string | A number indicating the reason for cancelling the booking. A list of <a href=\"#suggested-cancellation-codes\">suggested cancel codes</a> is shown in the table below. | ✅ |\n| `cancelDescription` | string | Natural-language reason for cancellation. A reason **must** be provided if a `cancelCode` of `'62'` or `'66'` is passed. | ✅ for `cancelCode` `'62'` or `'66'`; otherwise ❌ |\n\n#### Example [/merchant/cancellation](#operation/merchantCancellation) request:\n\nIn this request, we wish to cancel the booking identified by the following:\n\n| Parameter | Value |\n|-----------|-------|\n| `itneraryId` | `12345655` |\n| `distributorRef` | `\"Jdp122\"` |\n| `itemId` | `330056` |\n| `distributorItemRef` | `\"JdpItin001\"` |\n| `cancelCode` | `\"82\"` (Honest mistake - incorrect purchase) |\n\nThis is accomplished as follows:\n\n**API Service**\n\n```html\nPOST /merchant/cancellation\n```\n\n**Request body**\n\n```javascript\n{\n \"itineraryId\": 1234655,\n \"distributorRef\": \"Jdp122\",\n \"cancelItems\": [\n {\n \"itemId\": 330056,\n \"distributorItemRef\": \"JdpItin001\",\n \"cancelCode\": \"82\"\n }]\n}\n```\n\n#### Example response\n```javascript\n{\n \"data\": {\n \"itineraryId\": 1234655,\n \"cancelItems\": [\n {\n \"cancellationResponseStatusCode\": \"Confirmed\",\n \"cancellationResponseDescription\": \"No further action required\",\n \"itemId\": 330056,\n \"distributorItemRef\": \"JdpItin001\"\n }],\n \"distributorRef\": \"Jdp122\"\n },\n \"vmid\": \"221002\",\n \"errorMessage\": null,\n \"errorType\": null,\n \"dateStamp\": \"2013-03-21T14:28:08+0000\",\n \"errorReference\": null,\n \"errorMessageText\": null,\n \"success\": true,\n \"totalCount\": 1,\n \"errorName\": null\n}\n```\n\n### <a name=\"suggested-cancellation-codes\"></a>Suggested cancellation codes:\n\n| cancelcode | meaning |\n|:-:|:-|\n| `'00'` | Testing (use for test cancellations) |\n| `'51'` | Flight cancellation affecting customer |\n| `'52'` | Flight schedule change unacceptable to customer |\n| `'53'` | Death of the customer or a member of their immediate family |\n| `'54'` | Jury duty/court summons affecting customer |\n| `'56'` | Medical emergency/hospitalization involving the customer or their immediate family |\n| `'57'` | Customer is required for military service |\n| `'58'` | National disaster (insurrection, terrorism, war) affecting the customer |\n| `'59'` | Natural disaster (earthquake, fire, flood) affecting the customer |\n| `'62'` | **Post-travel cancellation**: the product was cancelled by the supplier and the traveller was not given sufficient notice |\n| `'63'` | Transport strike/labor dispute affecting customer |\n| `'66'` | **Post-travel cancellation**: the product was not cancelled, but the customer was dissatisfied with the product |\n| `'71'` | Credit card fraud |\n| `'72'` | Car segment cancellation affecting customer |\n| `'73'` | Package segment cancellation affecting customer |\n| `'74'` | Hotel segment cancellation affecting customer |\n| `'77'` | Re-book |\n| `'78'` | Duplicate purchase |\n| `'82'` | Honest mistake (incorrect purchase) |\n| `'87'` | Non-refundable cancellation more than 24 hours prior to travel |\n| `'88'` | Non-refundable cancellation less than 24 hours prior to travel |\n| `'98'` | Customer service/technical support response outside time limit |\n| `'99'` | Duplicate processing |\n\n### Cancellation errors\n\nIf the cancellation was **not** successful, you will receive an error response.\n\n#### Example error response\n\n```javascript\n{\n \"data\": {\n \"itineraryId\": \"3331605\", \n \"cancelItems\": [{\n \"cancellationResponseStatusCode\": \"Error.ItineraryUnknown\", \n \"cancellationResponseDescription\": \"Please double check the details or contact...\"\n \"itemId\": \"600088255\",\n \"distributorItemRef\": \"ItinItemRef012\"\n }],\n \"distributorRef\": null \n },\n \"vmid\": \"221002\",\n \"errorMessage\": null,\n \"errorType\": null,\n \"dateStamp\": \"2013-03-21T14:43:38+0000\", \n \"errorReference\": null, \n \"errorMessageText\": null,\n \"success\": true, \n \"totalCount\": 1, \n \"errorName\": null\n}\n```\n\n### <a name=\"cancellation-response-status-codes-and-their-meanings\"></a>Cancellation response status codes and their meanings\n\n| `cancellationResponseStatusCode` | Meaning | Action |\n|----------------------------------|----------|--------|\n| `\"Confirmed\"` | The request to cancel and refund the item has been accepted and processed | No further action is required. |\n| `\"Pending\"` | Confirmation of the request to cancel and refund the item is pending. This only applies when a `cancelCode` is `'62'` or `'66'` was sent and the booking was in a 'pending' state. | No action required. Partner will be contacted when a decision to confirm/reject has been made by the supplier. |\n| `\"Rejected\"` | The cancellation request was denied | No action required. The item cannot be cancelled. |\n| `\"Error.ItemUnknown\"` | Item not found | Double-check `itemId`. Contact Viator Customer Service for more information if required. |\n| `\"Error.ItineraryUnknown\"` | Itinerary not found | Double-check `itineraryId`. Contact Viator Customer Service for more information if required. |\n| `\"Error.MultipleRequests\"` | Cancellation request contains multiple requests | Submit **only one** item per cancellation request. |\n| `\"Error.NoCancellationCodeOrDescription\"` | Invalid `cancelCode` | `cancelCode` is invalid – ensure it is **two** digits long |\n| `\"Error.Unknown\"` | An undefined error has occurred | Double-check the `distributorRef` and `distributorItemRef`. If the error is still occurring, [contact the Viator partner support team](mailto:dpsupport@viator.com). |\n\n### Resubmitting a cancellation request\n\nIf the same cancellation request is sent more than once, Viator will respond with the last known response.",
"license": {
"name": "CC BY 4.0",
"url": "https://creativecommons.org/licenses/by/4.0/au"
},
"title": "Viator API Documentation & Specification – Merchant Partners",
"version": "1.0.0",
"x-apisguru-categories": [
"location",
"ecommerce"
],
"x-logo": {
"url": "https://api.apis.guru/v2/cache/logo/https_pbs.twimg.com_profile_images_1399749485719396353_AdiW3Ds1.jpg"
},
"x-origin": [
{
"format": "openapi",
"url": "blob:https://docs.viator.com/blobId",
"version": "3.0"
}
],
"x-providerName": "viator.com",
"x-tags": [
"lgbt"
]
},
"security": [
{
"API-key": []
},
{
"Legacy-API-key": []
}
],
"tags": [
{
"description": "General services",
"name": "General services"
},
{
"description": "Taxonomy services",
"name": "Taxonomy services"
},
{
"description": "Product services",
"name": "Product services"
},
{
"description": "Booking services",
"name": "Booking services"
},
{
"description": "Deprecated services",
"name": "Deprecated services"
}
],
"paths": {
"/available/products": {
"post": {
"description": "Find products that are available\n\n This endpoint returns available products filtered by product code, date range or number of adult travelers\n\n\n - **Note**: Availability data is limited to a period of **12 months** into the future from the present time on the production server and **6 months** on the sandbox server. \n \n",
"operationId": "availableProducts",
"parameters": [
{
"$ref": "#/components/parameters/acceptLanguage"
}
],
"requestBody": {
"content": {
"application/json": {
"example": {
"currencyCode": "USD",
"endDate": "2020-12-31",
"numAdults": 1,
"productCodes": [
"5010SYDNEY",
"2280SUN",
"9169P50"
],
"startDate": "2020-12-21"
},
"schema": {
"properties": {
"currencyCode": {
"description": "**currency** in which to display product pricing\n- default: `'USD'`\n",
"type": "string"
},
"endDate": {
"description": "**end date** of the date range to search within (must be in the future)",
"type": "string"
},
"numAdults": {
"description": "**number of adult travelers** who wish to participate\n- default: `1`\n",
"type": "integer"
},
"productCodes": {
"description": "**array of unique alphanumeric product identifiers** specifying which products to find the availability of\n- maximum: `50`\n",
"example": [
"5010SYDNEY",
"2280SUN",
"9169P50"
],
"items": {
"type": "string"
},
"type": "array"
},
"startDate": {
"description": "**start date** of the date range to search within (must be in the future)",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"1": {
"$ref": "#/components/examples/available-products-example"
}
},
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/basicErrorModel"
},
{
"properties": {
"data": {
"description": "**array** of product objects",
"items": {
"properties": {
"admission": {
"description": "ignore (Viator only)",
"type": "string"
},
"available": {
"description": "ignore (Viator only)",
"type": "boolean"
},
"bookingEngineId": {
"$ref": "#/components/schemas/bookingEngineId"
},
"catIds": {
"description": "**list** of unique numeric category identifiers that this product falls under\n- `categoryId` is available from the [/taxonomy/categories](#operation/taxonomyCategories) service\n",
"items": {
"type": "integer"
},
"type": "array"
},
"code": {
"description": "**unique alphanumeric identifier** of *this* product",
"type": "string"
},
"currencyCode": {
"$ref": "#/components/schemas/currencyCode"
},
"duration": {
"description": "**natural-language description** of *this* product's duration",
"type": "string"
},
"essential": {
"description": "ignore (Viator only)",
"type": "string"
},
"merchantCancellable": {
"description": "ignore (Viator only)\n\n \nFor cancellation information regarding the booking, please refer to the `merchantTermsAndConditions` object\n",
"type": "boolean"
},
"merchantNetPriceFrom": {
"$ref": "#/components/schemas/merchantNetPriceFrom"
},
"merchantNetPriceFromFormatted": {
"$ref": "#/components/schemas/merchantNetPriceFromFormatted"
},
"onRequestPeriod": {
"$ref": "#/components/schemas/onRequestPeriod"
},
"onSale": {
"$ref": "#/components/schemas/onSale"
},
"panoramaCount": {
"description": "**number** of panoramic images available for *this* product",
"type": "integer"
},
"pas": {
"description": "**object** detailing product availability\n- `pas` stands for Product Availability Schema\n",
"properties": {
"incompleteQuote": {
"description": "ignore (Viator only)",
"type": "boolean"
},
"productCode": {
"description": "**unique alphanumeric identifier** of *this* product",
"type": "string"
},
"removedChildAges": {
"description": "ignore (Viator only)",
"items": {
"type": "string"
},
"type": "array"
},
"tourGrades": {
"additionalProperties": {
"properties": {
"availDates": {
"description": "**array of objects** with availability and pricing information for *this* tour grade",
"items": {
"properties": {
"dateList": {
"description": "**list of dates** on which *this* tour grade is available formatted according to the example",
"type": "string"
},
"priceFrom": {
"description": "**lowest sale price** for *this* tour grade formatted according to the example",
"type": "string"
},
"priceQuote": {
"description": "**pricing object** for *this* tour grade",
"properties": {
"generalRetailPrice": {
"description": "**general retail price** of *this* tour grade formatted according to the example",
"type": "string"
},
"merchantNetPrice": {
"description": "ignore (Viator only)",
"type": "string"
},
"retailPrice": {
"description": "**retail price** of *this* tour grade formatted according to the example",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
},
"bookingEngine": {
"description": "**booking modality specifier** for *this* tour grade",
"type": "string"
},
"description": {
"description": "**natural-language description** of *this* tour grade",
"type": "string"
},
"languageServices": {
"additionalProperties": {
"items": {},
"type": "array"
},
"description": "**dictionary** of language codes to array of textual language service descriptors available for *this* tour grade",
"type": "object"
},
"sapi": {
"description": "ignore (Viator only)",
"type": "boolean"
},
"title": {
"description": "**natural-language title** of *this* tour grade",
"type": "string"
},
"tourGradeCode": {
"description": "**alphanumeric identifier** for *this* tour grade",
"type": "string"
}
},
"type": "object"
},
"description": "**dictionary** of tour grade alphanumeric codes to tour grade objects",
"type": "object"
},
"travellerMix": {
"description": "**alphanumeric code** indicating the combination of adults and children being enquired about",
"type": "string"
}
},
"type": "object"
},
"photoCount": {
"description": "**number** of user photos published for *this* product",
"type": "integer"
},
"price": {
"$ref": "#/components/schemas/price"
},
"priceFormatted": {
"$ref": "#/components/schemas/priceFormatted"
},
"primaryDestinationId": {
"description": "**unique numeric identifier** of *this* product's primary destination",
"type": "integer"
},
"primaryDestinationName": {
"description": "**natural-language name** of *this* product's primary destination",
"type": "string"
},
"primaryDestinationUrlName": {
"description": "**URL-formatted name** of *this* product's primary destination",
"type": "string"
},
"primaryGroupId": {
"description": "ignore (Viator only)",
"type": "string"
},
"productUrlName": {
"description": "**URL-formatted name** of *this* product",
"type": "string"
},
"rating": {
"$ref": "#/components/schemas/rating"
},
"reviewCount": {
"$ref": "#/components/schemas/reviewCount"
},
"rrp": {
"$ref": "#/components/schemas/rrp"
},
"rrpFormatted": {
"$ref": "#/components/schemas/rrpFormatted"
},
"savingAmount": {
"$ref": "#/components/schemas/savingAmount"
},
"savingAmountFormated": {
"$ref": "#/components/schemas/savingAmountFormated"
},
"shortDescription": {
"description": "**natural-language description** (short) of *this* product",
"type": "string"
},
"shortTitle": {
"description": "**natural-language title (shortened)** of *this* product",
"type": "string"
},
"sortOrder": {
"description": "**sort order** of this result object",
"type": "integer"
},
"specialOfferAvailable": {
"$ref": "#/components/schemas/specialOfferAvailable"
},
"specialReservation": {
"description": "ignore (Viator only)",
"type": "boolean"
},
"specialReservationDetails": {
"description": "ignore (Viator only)",
"type": "string"
},
"sslSupported": {
"description": "ignore (Viator only)",
"type": "boolean"
},
"subCatIds": {
"description": "**list** of unique numeric subcategory identifiers that this product falls under\n- `subcategoryId` is available from the [/taxonomy/categories](#operation/taxonomyCategories) service\n",
"items": {
"type": "integer"
},
"type": "array"
},
"supplierCode": {
"description": "**unique identifier** of *this* product's supplier",
"type": "string"
},
"supplierName": {
"description": "**natural-language name** of *this* product's supplier",
"type": "string"
},
"thumbnailHiResURL": {
"description": "**URL** of *this* product's high resolution thumbnail image",
"type": "string"
},
"thumbnailURL": {
"description": "**URL** of *this* product's thumbnail image",
"type": "string"
},
"title": {
"description": "**natural-language title** of *this* product",
"type": "string"
},
"translationLevel": {
"$ref": "#/components/schemas/translationLevel"
},
"uniqueShortDescription": {
"description": "**natural-language description** of *this* product",
"type": "string"
},
"videoCount": {
"description": "ignore (Viator only) – videos are not available to partners\n",
"type": "integer"
},
"webURL": {
"$ref": "#/components/schemas/webURL"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
]
}
}
},
"description": "Success"
}
},
"summary": "/available/products",
"tags": [
"Product services"
]
}
},
"/booking/availability": {
"post": {
"description": "Get the tour-grade with the lowest price that is available for a product on each day of the specified month\n\nThis service:\n- returns \n- useful when displaying a calendar of available tours\n- For more information, see: [Availability services](#section/Key-concepts/Availability-services)\n- **Notes:** \n - [/booking/availability/dates](#operation/bookingAvailabilityDates) provides all availability in one call and is more suitable for calendars, etc.\n\n - Availability data is limited to a period of **12 months** into the future from the present time on the production server and **6 months** on the sandbox server. \n",
"operationId": "bookingAvailability",
"parameters": [
{
"$ref": "#/components/parameters/acceptLanguage"
}
],
"requestBody": {
"content": {
"application/json": {
"example": {
"ageBands": [
{
"bandId": 1,
"count": 1
}
],
"currencyCode": "AUD",
"month": "12",
"productCode": "5010SYDNEY",
"year": "2020"
},
"schema": {
"properties": {
"ageBands": {
"description": "**array of objects** specifying the age bands by which to to filter search results",
"items": {
"properties": {
"bandId": {
"$ref": "#/components/schemas/ageBandId"
},
"count": {
"description": "**number of people** in *this* age band",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
},
"currencyCode": {
"description": "**currency code** for the currency in which to display tour grade pricing information",
"type": "string"
},
"month": {
"description": "**month component** (text format) of the start of the date range for which to retrieve tour grade availability information (must be in the future)",
"type": "string"
},
"productCode": {
"description": "**unique alphanumeric identifier** of the product for which you wish to retrieve tour grade availability information",
"type": "string"
},
"year": {
"description": "**year component** (text format) of the start of the date range for which to retrieve tour grade availability information (must be in the future)",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"1": {
"$ref": "#/components/examples/booking-availability-example"
}
},
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/basicErrorModel"
},
{
"properties": {
"data": {
"description": "**object** detailing available tourgrades for the specified age bands and date range for this product",
"properties": {
"availability": {
"description": "**array** of tour grade availability objects",
"items": {
"properties": {
"available": {
"description": "**indicator** - `true` if *this* tour grade is available to book",
"type": "boolean"
},
"bookingDate": {
"description": "**date** on which *this* tour grade is available to be booked",
"type": "string"
},
"currencyCode": {
"description": "**currency code** of the currency in which product pricing is displayed",
"type": "string"
},
"gradeCode": {
"description": "**alphanumeric identifier** for *this* tour grade",
"type": "string"
},
"merchantNetPrice": {
"description": "**numeric merchant net rate** for *this* tour grade\n- For more information, see: [Merchant pricing](#section/Merchant-APIs/Merchant-pricing)\n",
"type": "number"
},
"merchantNetPriceFormatted": {
"description": "**currency-formatted merchant net rate** for *this* tour grade\n- For more information, see: [Merchant pricing](#section/Merchant-APIs/Merchant-pricing)\n",
"type": "string"
},
"retailPrice": {
"description": "**numeric suggested retail price** for *this* tour grade\n- For more information, see: [Merchant pricing](#section/Merchant-APIs/Merchant-pricing)\n",
"type": "number"
},
"retailPriceFormatted": {
"description": "**currency-formatted suggested retail price** for *this* tour grade\n- For more information, see: [Merchant pricing](#section/Merchant-APIs/Merchant-pricing)\n",
"type": "string"
},
"sortOrder": {
"description": "**sort order** of this tour grade availability object",
"type": "integer"
},
"unavailableReason": {
"description": "**natural-language explanation** as to why *this* tour grade is not available to be booked",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"firstAvailableDate": {
"description": "**first available date** (in plain text format) for the tour grade",
"type": "string"
},
"lastAvailableDate": {
"description": "**last available date** for the tour grade",
"type": "string"
},
"productCode": {
"description": "**unique alphanumeric identifer** of the product that was specified in the request",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
]
}
}
},
"description": "Success"
}
},
"summary": "/booking/availability",
"tags": [
"Booking services"
]
}
},
"/booking/availability/dates": {
"get": {
"description": "Get dates on which a product is available\n\nThis service:\n- retrieves all available dates for a product, excluding days it does not operate and blocked-out dates\n- returns a multi-dimensional array of year-month -> days that have any availabile tour grade or traveler mix\n- useful to present the user with a list of dates for selection on which *this* product is available for booking\n- **Notes**: \n\n - The user's desired traveler mix may not be eligible for booking; these details can be displayed when you retrieve its list of tour grades\n - Availability data is limited to a period of **12 months** into the future from the present time on the production server and **6 months** on the sandbox server. \n",
"operationId": "bookingAvailabilityDates",
"parameters": [
{
"$ref": "#/components/parameters/acceptLanguage"
},
{
"$ref": "#/components/parameters/productCode"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"1": {
"$ref": "#/components/examples/booking-availability-dates-example"
}
},
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/basicErrorModel"
},
{
"properties": {
"data": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"description": "**dictionary** of month identifiers (e.g., `'2018-12'`) to an array of days-of-the-month (text) specifying which days of the specified month *this* product is available to be booked\"\n- **Note**: see response sample for object structure\n",
"type": "object"
}
},
"type": "object"
}
]
}
}
},
"description": "Success"
}
},
"summary": "/booking/availability/dates",
"tags": [
"Booking services"
]
}
},
"/booking/availability/tourgrades": {
"post": {
"description": "Get the tour grades of a product that are currently available\n\nThis service reports:\n- all tour grades for the specified product, on the specified day, that are available for the specified age bands\n- the pricing breakdown and the total depending on the travel date and traveler mix\n\n**Note**: Availability data is limited to a period of **12 months** into the future from the present time on the production server and **6 months** on the sandbox server. \n",
"operationId": "bookingAvailabilityTourgrades",
"parameters": [
{
"$ref": "#/components/parameters/acceptLanguage"
}
],
"requestBody": {
"content": {
"application/json": {
"example": {
"ageBands": [
{
"bandId": 1,
"count": 1
}
],
"bookingDate": "2020-12-28",
"currencyCode": "AUD",
"productCode": "5010SYDNEY"
},
"schema": {
"properties": {
"ageBands": {
"description": "**array** of ageBand objects",
"items": {
"properties": {
"bandId": {
"$ref": "#/components/schemas/bandId"
},
"count": {
"description": "**numeric count** of number of travelers in *this* age band",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
},
"bookingDate": {
"description": "**date** to enquire about available tour grades for *this* product (must be in the future)",
"type": "string"
},
"currencyCode": {
"description": "**currency code** for the currency in which to display pricing information",
"type": "string"
},
"productCode": {
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"1": {
"$ref": "#/components/examples/booking-availability-tourgrades-example"
}
},
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/basicErrorModel"
},
{
"properties": {
"data": {
"items": {
"properties": {
"ageBands": {
"description": "**array** of age band objects describing the age bands and respective passenger counts allowed to book *this* tour grade; `null` if `ageBandsRequired` is filled and `available` is `false`",
"items": {},
"type": "array"
},
"ageBandsRequired": {
"description": "**array of arrays** of age band objects describing the traveler mixes eligible to book *this* tour grade; `null` if `ageBands` is filled and `available` is `true`\n- **note**: multiple objects; structure will depend on available tour grades – see response sample for an example, but the exact result you receive will differ\n",
"items": {
"items": {
"properties": {
"bandId": {
"$ref": "#/components/schemas/bandId"
},
"maximumCountRequired": {
"description": "**maximum number** of passengers from *this* age band allowable for *this* tour grade",
"type": "integer"
},
"minimumCountRequired": {
"description": "**minimum number** of passengers from *this* age band required for *this* tour grade",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
},
"type": "array"
},
"available": {
"description": "**indicator** - `true` if this tour grade is available to be booked according to the traveler mix specified",
"type": "boolean"
},
"bookingDate": {
"description": "**date** on which *this* tour grade operates",
"type": "string"
},
"currencyCode": {
"description": "**currency code for the specified currency** (will be `'ERROR'` if `available` is `false`)",
"type": "string"
},
"defaultLanguageCode": {
"description": "**language code for standard langauge** for *this* product",
"type": "string"
},
"gradeCode": {
"description": "**alphanumeric identifier** of *this* tour grade",
"type": "string"
},
"gradeDepartureTime": {
"description": "**time** of *this* product",
"type": "string"
},
"gradeDescription": {
"description": "**natural-language description** of the tour grade",
"type": "string"
},
"gradeTitle": {
"description": "**natural-language title** of the tour grade",
"type": "string"
},
"langServices": {
"description": "**object** detailing language services available for *this* product** (will be `null` if `available` is `false`)",
"type": "object"
},
"merchantNetPrice": {
"description": "**numeric merchant net rate** for *this* tour grade\n**Note**: will be `0` if `available` is `false`\n- For more information, see: [Merchant pricing](#section/Merchant-APIs/Merchant-pricing)\n",
"type": "number"
},
"merchantNetPriceFormatted": {
"description": "**currency-formatted merchant net rate** for *this* tour grade\n**Note**: will be empty if `available` is `false`\n- For more information, see: [Merchant pricing](#section/Merchant-APIs/Merchant-pricing)\n",
"type": "string"
},
"retailPrice": {
"description": "**numeric suggested retail price** for *this* tour grade\n**Note**: will be `0` if `available` is `false`\n- For more information, see: [Merchant pricing](#section/Merchant-APIs/Merchant-pricing)\n",
"type": "number"
},
"retailPriceFormatted": {
"description": "**currency-formatted suggested retail price** for *this* tour grade\n**Note**: (will be '' if `available` is `false`)\n- For more information, see: [Merchant pricing](#section/Merchant-APIs/Merchant-pricing)\n",
"type": "string"
},
"sortOrder": {
"description": "**sort order** for *this* tour grade availability object",
"type": "integer"
},
"unavailableReason": {
"description": "**enum specifier of reason for product unavailability** (will be `null` if `available` is `true`)",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
]
}
}
},
"description": "Success"
}
},
"summary": "/booking/availability/tourgrades",
"tags": [
"Booking services"
]
}
},
"/booking/availability/tourgrades/pricingmatrix": {
"post": {
"description": "Get a pricing matrix that includes availability and tour-grades for a product\n\nGiven a month, this service returns days with available tour grades only (i.e., days which have at least one tourgrade available), and the pricing matrix for that tour grade for that day.\n\n- **Note**: Availability data is limited to a period of **12 months** into the future from the present time on the production server and **6 months** on the sandbox server. \n",
"operationId": "bookingAvailabilityTourgradesPricingmatrix",
"parameters": [
{
"$ref": "#/components/parameters/acceptLanguage"
}
],
"requestBody": {
"content": {
"application/json": {
"example": {
"currenctCode": "USD",
"month": "12",
"productCode": "2280AAHT",
"year": "2020"
},
"schema": {
"properties": {
"currencyCode": {
"description": "**currency code** for the currency in which to display pricing details",
"type": "string"
},
"month": {
"description": "**month of year** (as text) by which to filter results (must be in the future)",
"type": "string"
},
"productCode": {
"description": "**alphanumeric identifier** of product about which to retrieve tour grade and pricing information",
"type": "string"
},
"year": {
"description": "**year** (as text) by which to filter results (must be in the future)",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"1": {
"$ref": "#/components/examples/booking-availablility-tourgrades-pricingmatrix-example"
}
},
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/basicErrorModel"
},
{
"properties": {
"data": {
"properties": {
"bookingMonth": {
"description": "**month of year** (as text) by which to filter results",
"type": "string"
},
"dates": {
"description": "**array of tour grade pricing objects** each detailing availability on a single day",
"items": {
"properties": {
"bookingDate": {
"description": "**date** on which *this* product operates",
"type": "string"
},
"callForLastMinAvailability": {
"description": "ignore (Viator only)",
"type": "boolean"
},
"sortOrder": {
"description": "**sort order** for *this* tour grade pricing object",
"type": "integer"
},
"tourGrades": {
"description": "**array** of tour grade pricing information objects",
"items": {
"properties": {
"gradeCode": {
"description": "**alphanumeric identifier** of the tour grade",
"type": "string"
},
"gradeTitle": {
"description": "**title of tour grade**",
"type": "string"
},
"pricingMatrix": {
"description": "**array of pricing objects** for *this* tour grade",
"items": {
"properties": {
"ageBandPrices": {
"description": "**array** of pricing objects by age band",
"items": {
"properties": {
"bandId": {
"$ref": "#/components/schemas/bandId"
},
"maximumCountRequired": {
"description": "**maximum number** of participants allowed for *this* tour grade",
"type": "integer"
},
"minimumCountRequired": {
"description": "**minimum number** of participants required for *this* tour grade",
"type": "integer"
},
"prices": {
"description": "**array** of pricing detail objects",
"items": {
"properties": {
"currencyCode": {
"description": "**currency code** of the currency in which pricing details are displayed",
"type": "string"
},
"merchantNetPrice": {
"description": "**numeric merchant net rate** for *this* age band\n- For more information, see: [Merchant pricing](#section/Merchant-APIs/Merchant-pricing)\n",
"type": "number"
},
"merchantNetPriceFormatted": {
"description": "**currency-formatted merchant net rate** for *this* age band\n- For more information, see: [Merchant pricing](#section/Merchant-APIs/Merchant-pricing)\n",
"type": "string"
},
"minNoOfTravellersRequiredForPrice": {
"type": "integer"
},
"price": {
"description": "**numeric suggested retail price** for *this* age band\n- For more information, see: [Merchant pricing](#section/Merchant-APIs/Merchant-pricing)\n",
"type": "number"
},
"priceFormatted": {
"description": "**currency-formatted suggested retail price** for *this* age band\n- For more information, see: [Merchant pricing](#section/Merchant-APIs/Merchant-pricing)\n",
"example": "799",
"type": "string"
},
"sortOrder": {
"description": "**sort order** *this* pricing detail object",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
},
"sortOrder": {
"description": "**sort order** for *this* tour grade",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
},
"bookingDate": {
"description": "**date** on which *this* product operates",
"type": "string"
},
"pricingUnit": {
"description": "**natural-language description** of the pricing mode\n- see [Understanding the pricingUnit field](#section/Using-the-API/Understanding-the-pricingUnit-field) for more information\n",
"type": "string"
},
"sortOrder": {
"description": "**sort order** for *this* pricing object",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
},
"sortOrder": {
"description": "**sort order** for *this* tour grade pricing object",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"type": "array"
},
"pricingUnit": {
"description": "**natural-language label** for the pricing terms of this tour grade\n- see [Understanding the pricingUnit field](#section/Using-the-API/Understanding-the-pricingUnit-field) for more information\n",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
]
}
}
},
"description": "Success"
}
},
"summary": "/booking/availability/tourgrades/pricingmatrix",
"tags": [
"Booking services"
]
}
},
"/booking/book": {
"post": {
"description": "Make a booking\n\nFor more information, see: \n\n - [Cancellation policy](#section/Key-concepts/Cancellation-policy)\n - [Booking concepts](#section/Key-concepts/Booking-concepts)\n - [Booking process flow](#section/Common-workflows-and-data-validation/Booking-process-flow)\n - [Making a booking](#section/Common-workflows-and-data-validation/Making-a-booking)\n - [Supplier communications](#section/Key-concepts/Supplier-communications)\n",
"operationId": "bookingBook",
"parameters": [
{
"$ref": "#/components/parameters/acceptLanguage"
}
],
"requestBody": {
"content": {
"application/json": {
"examples": {
"per_person_booking_questions": {
"value": {
"booker": {
"email": "apitest@viator.com",
"firstname": "Homer Test",
"surname": "Simpson Test",
"title": "Mr"
},
"currencyCode": "USD",
"demo": true,
"items": [
{
"bookingQuestionAnswers": [
{
"answer": "0123456789, 9876543210",
"questionId": 5
},
{
"answer": "Australia, Fiji",
"questionId": 4
},
{
"answer": "01 July 2022, 31 May 2022",
"questionId": 3
}
],
"hotelId": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"languageOptionCode": "en/SERVICE_GUIDE",
"partnerItemDetail": {
"distributorItemRef": "distroItemRef8348234535_1"
},
"pickupPoint": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"productCode": "100022P1",
"specialRequirements": "",
"tourGradeCode": "TG1",
"travelDate": "2020-12-30",
"travellers": [
{
"bandId": 1,
"firstname": "Homer1",
"leadTraveller": true,
"surname": "Simpson Test",
"title": "Mr"
},
{
"bandId": 1,
"firstname": "Homer2",
"leadTraveller": true,
"surname": "Simpson Test",
"title": "Mr"
}
]
}
],
"partnerDetail": {
"distributorRef": "distroRef34398534535"
}
}
},
"single_traveler": {
"value": {
"booker": {
"cellPhone": "0411041041",
"cellPhoneCountryCode": "61",
"email": "apitest@viator.com",
"firstname": "Homer test",
"homePhone": "83798517",
"surname": "Simpson test",
"title": "Mr"
},
"currencyCode": "USD",
"demo": true,
"items": [
{
"bookingQuestionAnswers": [
{
"answer": "70 kgs",
"questionId": 23
}
],
"hotelId": "1091770",
"languageOptionCode": "en/SERVICE_GUIDE",
"partnerItemDetail": {
"distributorItemRef": "itemRef1000000"
},
"pickupPoint": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"productCode": "2280AAHT",
"specialRequirements": "",
"tourGradeCode": "TG1~08:00",
"travelDate": "2020-12-31",
"travellers": [
{
"bandId": 1,
"firstname": "Homer test",
"leadTraveller": true,
"surname": "Simpson test",
"title": "Mr"
}
]
}
],
"partnerDetail": {
"distributorRef": "distributorRef100000"
}
}
}
},
"schema": {
"properties": {
"booker": {
"description": "**object** containing details about the primary contact (**note**: this contact needn't be a traveller)",
"properties": {
"cellPhone": {
"description": "**telephone number** of the lead traveler\n\n**Note**:\n\n * Must be included to enable CLC communications\n * See [Supplier communications](#section/Merchant-APIs/Supplier-communications) for more information\n",
"type": "string"
},
"cellPhoneCountryCode": {
"description": "**country code** for the telephone number of the lead traveler\n\n**Note**: \n\n * Must be included to enable CLC communications. \n * See [Supplier communications](#section/Merchant-APIs/Supplier-communications) for more information\n",
"type": "string"
},
"email": {
"description": "**email address** of the primary contact",
"type": "string"
},
"firstname": {
"description": "**first name** of the primary contact\n",
"format": "(.)*[\\\\<\\\\>%;\\\"\\\\(\\\\)+]+(.)*",
"type": "string"
},
"homePhone": {
"description": "**phone number** (home) of the primary contact",
"type": "string"
},
"surname": {
"description": "**surname** of the primary contact",
"format": "(.)*[\\\\<\\\\>%;\\\"\\\\(\\\\)+]+(.)*",
"type": "string"
},
"title": {
"description": "**title** of the primary contact",
"type": "string"
}
},
"required": [
"firstname",
"surname"
],
"type": "object"
},
"currencyCode": {
"description": "**currency code** for the currency the booking will be submitted in (you will be billed in this currency)",
"type": "string"
},
"demo": {
"description": "**specifier**: `true` if this is a *demo* booking only (demos do not send any notifications, are automatically confirmed and OnRequest products become freesale products. Default value is true. Production must have `demo` set to `false`.",
"type": "boolean"
},
"items": {
"description": "**array** of items to be booked",
"items": {
"properties": {
"bookingQuestionAnswers": {
"description": "**array** of objects containing booking questions and the answers provided for them for *this* product\n- If a booking question is available in the `bookingQuestions` array in the response from [/product](#operation/product) for *this* product, the matching `bookingQuestionAnswers` must be passed to *this* service. \n- If a product does not have any booking questions, you can omit the `bookingQuestionAnswers` array in your request. \n- Any invalid or unrequired booking-question answers that are passed to *this* service will be ignored (and, no exceptions will be raised) \n- You will need to include this array if [/product](#operation/product) returns any questions in the `bookingQuestions` array.\n",
"items": {
"properties": {
"answer": {
"description": "**answer** to the question for the `questionId` listed (recommended length for the answer is 500 characters)\n\n**Note**: To specify answers for each traveler, separate the values with a comma as in the per_person_booking_questions request example\n",
"type": "string"
},
"questionId": {
"description": "**numeric identifier** for the question (**note**: `questionId` can be retrieved from the [/product](#operation/product) service)",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
},
"hotelId": {
"description": "**specifer** of the hotel\nIf [/product](#operation/product) returns `hotelPickup`: `true` and a list of hotels is available for *this* product in [/booking/hotels](#operation/bookingHotels), a `hotelId` must be captured (as per the hotel service id field); or, use an alternative `hotelId`, such as:\n \n - `\"notBooked\"`: the customer has not yet booked their hotel\n - `\"notListed\"`: the customer's hotel is not listed\n\n If the customer chooses one of these options, the product supplier may need to correspond with the user to find out their pick-up location. The best way to do this is by enabling [Closed-Loop-Communication (CLC)](#section/Merchant-APIs/Supplier-communications).\n",
"type": "string"
},
"languageOptionCode": {
"description": "**specifier** of language service provided for this product that has been chosen for this booking (usually in the format langcode/Service eg en/SERVICE_GUIDE. If the product details service [/product](#operation/product) for the product returns a langService, this must be provided.)",
"type": "string"
},
"partnerItemDetail": {
"description": "**object** containing partner details at a per-item level",
"properties": {
"distributorItemRef": {
"description": "**unique alphanumeric code** for the order ('itinerary') (merchant API partners must pass a `distributorItemRef` into the `partnerItemDetails` object for each item in *this* object\n- this code can be any alphanumeric string and is defined by the distributor\n",
"type": "string"
}
},
"type": "object"
},
"pickupPoint": {
"description": "**details** about the hotel pick-up point (must be provided if the `hotelId` selected by the user is `'notListed'` or if no hotels are returned for *this* product in [/booking/hotels](#operation/bookingHotels) where `hotelPickup` is `true`.",
"type": "string"
},
"productCode": {
"description": "**unique alphanumeric identifier** of the product to be booked",
"type": "string"
},
"specialRequirements": {
"description": "**text field** to capture any additional requirements for the booking, such as dietary requirements or if a wheelchair is required",
"type": "string"
},
"tourGradeCode": {
"description": "**specifier** of the tour grade to be booked (if tour grades are supplied in [/product](#operation/product), you must allow the customer to select a tour grade code. If no tour grades are available for *this* product, set this to `'DEFAULT'`.)",
"type": "string"
},
"travelDate": {
"description": "**date** of travel for the item in format yyyy-mm-dd",
"type": "string"
},
"travellers": {
"description": "**array** of traveler names, details and whether they are the lead traveller",
"items": {
"properties": {
"bandId": {
"$ref": "#/components/schemas/bandId"
},
"firstname": {
"description": "**first name** of *this* traveller",
"type": "string"
},
"leadTraveller": {
"description": "**indicator**: `true` if this traveler is the lead traveler",
"type": "boolean"
},
"surname": {
"description": "**surname** of *this* traveler",
"type": "string"
},
"title": {
"description": "**title** of the traveler (e.g `'Mr'`, `'Mrs'`, `'Ms'`, `'Miss'`, `'Mstr'`, `'Dr'`)",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"type": "array"
},
"partnerDetail": {
"description": "Applicable only for extra partner detail for either partner or merchant partner for sending partner specific information\n",
"properties": {
"distributorRef": {
"description": "**unique alphanumeric reference code** for the distributor\n- Merchant API partners must pass a `distributorRef` at the order (A.K.A. 'itinerary') level in the `partnerDetail` object. The `distributorRef` passed must be alphanumeric and unique to bookings made by the merchant.\n- Passing an existing `distributorRef`: If an existing `distributorRef` is passed, the booking with the matching `distributorRef` will be returned in the response and a new booking will not be made. The fields in the response are identical to the response for a new booking.\n",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"1": {
"$ref": "#/components/examples/booking-book-example"
}
},
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/basicErrorModel"
},
{
"properties": {
"data": {
"properties": {
"bookerEmail": {
"description": "**email address** of the entity that made *this* booking",
"type": "string"
},
"bookingDate": {
"description": "**date** of *this* booking",
"type": "string"
},
"bookingStatus": {
"$ref": "#/components/schemas/bookingStatus_itinerary"
},
"currencyCode": {
"description": "**currency code** of the currency in which *this* booking was made",
"type": "string"
},
"distributorRef": {
"description": "ignore (Viator only)",
"type": "string"
},
"exchangeRate": {
"description": "ignore (Viator only)",
"type": "integer"
},
"hasVoucher": {
"description": "ignore (Viator only)",
"type": "boolean"
},
"itemSummaries": {
"description": "**array** of item summaries",
"items": {
"properties": {
"applePassSupported": {
"description": "",
"type": "boolean"
},
"barcodeOption": {
"description": "Indicates whether a voucher is required for each passenger; or, whether the requirement is one voucher per group booking.",
"type": "string"
},
"barcodeType": {
"description": "**alphanumeric code** specifying the type of barcode",
"type": "string"
},
"bookingEngineId": {
"$ref": "#/components/schemas/bookingEngineId-response"
},
"bookingStatus": {
"$ref": "#/components/schemas/bookingStatus_item"
},
"currencyCode": {
"description": "**currency code** for the currency in which pricing is displayed for *this* item",
"type": "string"
},
"departsFrom": {
"description": "**natural-language description** of *this* item's departure location",
"type": "string"
},
"departurePoint": {
"description": "**natural-language description** of *this* item's departure point",
"type": "string"
},
"departurePointAddress": {
"description": "**HTML-formatted address** of *this* item's departure point",
"type": "string"
},
"departurePointDirections": {
"description": "**natural-language description** of directions regarding *this* item's departure point",
"type": "string"
},
"destId": {
"description": "**unique numeric identifer** of the destination of *this* item",
"type": "integer"
},
"distributorItemRef": {
"description": "ignore (Viator only)",
"type": "string"
},
"hoursConfirmed": {
"description": "The `hoursConfirmed` field also indicates if the product is freesale or on request. The `hoursConfirmed` value is the approximate window for confirmation in hours, which can be presented to the customer. A value of `0` means that the product is **freesale**, and a value greater than `0` means that the product is **on-request**.\n",
"type": "string"
},
"itemId": {
"description": "**numeric identifer** of *this* item",
"type": "integer"
},
"itineraryId": {
"description": "Ignore (Viator only)",
"type": "integer"
},
"languageServicesCode": {
"description": "**code** for the language that this product operates in",
"type": "string"
},
"lastRetailPrice": {
"description": "**numeric merchant net rate** of *this* item",
"type": "number"
},
"lastRetailPriceFormatted": {
"description": "**currency-formatted merchant net rate** of *this* item",
"type": "string"
},
"leadTravellerFirstname": {
"description": "**first name** of the lead traveler",
"type": "string"
},
"leadTravellerSurname": {
"description": "**surname** of the lead traveler",
"type": "string"
},
"leadTravellerTitle": {
"description": "**title** of the lead traveler's name",
"type": "string"
},
"merchantCancellable": {
"description": "ignore (Viator only)\n\nFor cancellation information regarding the booking, please refer to the `merchantTermsAndConditions` object\n",
"type": "boolean"
},
"merchantNetPrice": {
"description": "**numeric merchant net rate** for *this* item\"\n- For more information, see: [Merchant pricing](#section/Merchant-APIs/Merchant-pricing)\n",
"type": "number"
},
"merchantNetPriceFormatted": {
"description": "**currency-formatted merchant net rate** for *this* item\n- For more information, see: [Merchant pricing](#section/Merchant-APIs/Merchant-pricing)\n",
"type": "string"
},
"merchantTermsAndConditions": {
"properties": {
"amountRefundable": {
"description": "**currency-formatted** amount that will be refunded if the cancellation is processed now.",
"type": "string"
},
"cancellationFromTourDate": {
"description": "**array** of cancellation policy objects",
"items": {
"properties": {
"dayRangeMax": {
"description": "**number** of days prior to the tour start date that *this* policy window begins. `null` signifies open-endedness",
"type": "integer"
},
"dayRangeMin": {
"description": "**number** of days prior to the tour start date that *this* policy window ends",
"type": "integer"
},
"percentageRefundable": {
"description": "**percentage** of total price refundable if cancelled within *this* time window",
"type": "integer"
},
"policyEndTimestamp": {
"description": "**Unix timestamp** giving the exact time the policy ends",
"type": "integer"
},
"policyStartTimestamp": {
"description": "**Unix timestamp** giving the exact time the policy commences",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
},
"termsAndConditions": {
"description": "**natural-language description** of the terms and conditions for *this* product",
"type": "string"
}
},
"type": "object"
},
"obfsId": {
"description": "ignore (Viator only)",
"type": "integer"
},
"passbooks": {
"description": "ignore (Viator only)",
"type": "string"
},
"pickupHotelId": {
"description": "**identifer** for the pick-up hotel",
"type": "string"
},
"pickupHotelName": {
"description": "**natural-language name** of the pick-up hotel",
"type": "string"
},
"price": {
"description": "**numeric merchant total price** for *this* item\n- For more information, see: [Merchant pricing](#section/Merchant-APIs/Merchant-pricing)\n",
"type": "number"
},
"priceFormatted": {
"description": "**currency-formatted merchant total price** for *this* item\n- For more information, see: [Merchant pricing](#section/Merchant-APIs/Merchant-pricing)\n",
"type": "string"
},
"priceUSD": {
"description": "**numeric merchant total price** in USD",
"type": "number"
},
"productCode": {
"description": "**unique alphanumeric identifier** of *this* product",
"type": "string"
},
"productPulledDown": {
"description": "ignore (Viator only)",
"type": "boolean"
},
"productTitle": {
"description": "**natural-language title** of *this* product",
"type": "string"
},
"productWidgetList": {
"description": "ignore (Viator only)",
"type": "string"
},
"rulesApplied": {
"description": "ignore (Viator only)",
"type": "string"
},
"savingAmount": {
"$ref": "#/components/schemas/savingAmount"
},
"savingAmountFormated": {
"$ref": "#/components/schemas/savingAmountFormated"
},
"sortOrder": {
"description": "**sort order** of *this* item summary",
"type": "integer"
},
"startingTime": {
"description": "**starting time** of this product",
"type": "string"
},
"supplierName": {
"description": "**natural-language name** of *this* product's supplier",
"type": "string"
},
"supplierPhoneNumber": {
"description": "**telephone number** of *this* product's supplier",
"type": "string"
},
"termsAndConditions": {
"description": "ignore (Viator only)",
"type": "object"
},
"tourGradeCode": {
"description": "**identifer** of *this* tour grade",
"type": "string"
},
"tourGradeDescription": {
"description": "**natural-language description** of *this* tour grade",
"type": "string"
},
"travelDate": {
"description": "**date** of travel",
"type": "string"
},
"travellerAgeBands": {
"description": "**array** of objects detailing the traveler age bands",
"items": {
"properties": {
"ageBandId": {
"$ref": "#/components/schemas/ageBandId"
},
"count": {
"description": "**numeric** number of travelers in *this* age band",
"type": "integer"
},
"description": {
"description": "**natural-language description** (singular) of *this* age band",
"type": "string"
},
"pluralDescription": {
"description": "**natural-language description** (plural) of *this* age band",
"type": "string"
},
"sortOrder": {
"description": "**sort order** for *this* age band",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
},
"voucherKey": {
"description": "Unique reference for the voucher for this booking that can be used as a request parameter to search for existing bookings using the [/booking/mybookings](#operation/bookingMybookings) and [/booking/pastbooking](#operation/bookingPastbooking) endpoints",
"type": "string"
},
"voucherOption": {
"description": "ignore (Viator only)",
"type": "string"
},
"voucherRequirements": {
"description": "**natural-language description** of the requirements pertaining to this voucher",
"type": "string"
},
"voucherURL": {
"description": "**URL of the voucher** for *this* product (if available). The customer can access this URL to retrieve their voucher.",
"type": "string"
},
"vouchers": {
"description": "ignore (Viator only)",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"itineraryId": {
"description": "ignore (Viator only)",
"type": "integer"
},
"omniPreRuleList": {
"description": "ignore (Viator only)",
"type": "string"
},
"paypalRedirectURL": {
"description": "ignore (Viator only)",
"type": "string"
},
"rulesApplied": {
"description": "ignore (Viator only)",
"type": "string"
},
"securityToken": {
"description": "ignore (Viator only)",
"type": "string"
},
"sortOrder": {
"description": "**sort order** for *this* object",
"type": "integer"
},
"totalPrice": {
"description": "**numeric merchant total price** for *this* booking\n- For more information, see: [Merchant pricing](#section/Merchant-APIs/Merchant-pricing)\n",
"type": "number"
},
"totalPriceFormatted": {
"description": "**currency-formatted merchant total price** for *this* booking\n- For more information, see: [Merchant pricing](#section/Merchant-APIs/Merchant-pricing)\n",
"type": "string"
},
"totalPriceUSD": {
"description": "**numeric merchant total price** of *this* booking in USD",
"type": "number"
},
"userId": {
"description": "ignore (Viator only)",
"type": "string"
},
"voucherKey": {
"description": "Unique reference for the voucher for this booking that can be used as a request parameter to search for existing bookings using the [/booking/mybookings](#operation/bookingMybookings) and [/booking/pastbooking](#operation/bookingPastbooking) endpoints",
"type": "string"
},
"voucherURL": {
"description": "**URL of the voucher** for *this* product (if available). The customer can access this URL to retrieve their voucher.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
]
}
}
},
"description": "Success"
}
},
"summary": "/booking/book",
"tags": [
"Booking services"
]
}
},
"/booking/calculateprice": {
"post": {
"description": "Confirm the price of a tour / activity prior to booking\n\nFor more information, see: [Calculating prices](#section/Common-workflows-and-data-validation/Calculating-prices) \n\n- **Note**: Availability and pricing data is limited to a period of **six months** into the future from the present time\n",
"operationId": "bookingCalculateprice",
"parameters": [
{
"$ref": "#/components/parameters/acceptLanguage"
}
],
"requestBody": {
"content": {
"application/json": {
"example": {
"currencyCode": "USD",
"items": [
{
"productCode": "5010SYDNEY",
"tourGradeCode": "24HOUR",
"travelDate": "2020-12-12",
"travellers": [
{
"bandId": 1
}
]
}
]
},
"schema": {
"properties": {
"currencyCode": {
"description": "**currency code** for the currency in which to display pricing details",
"type": "string"
},
"items": {
"description": "**array** of travel detail objects",
"items": {
"properties": {
"productCode": {
"description": "**unique alphanumeric identifier** of the product the total price for which you which to calculate",
"type": "string"
},
"tourGradeCode": {
"description": "**alphanumeric identifier** for the tour grade for which to calculate the total price",
"type": "string"
},
"travelDate": {
"description": "**date** for which to calculate the total price (must be in the future)",
"type": "string"
},
"travellers": {
"description": "**array of objects** detailing the age bands for which to calculate the total price",
"items": {
"properties": {
"bandId": {
"$ref": "#/components/schemas/bandId"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"1": {
"$ref": "#/components/examples/booking-calculateprice-example"
}
},
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/basicErrorModel"
},
{
"properties": {
"data": {
"properties": {
"currencyCode": {
"description": "**specifier of the currency** in which pricing details are displayed",
"type": "string"
},
"hasPromoCode": {
"description": "ignore (Viator only)",
"type": "boolean"
},
"itinerary": {
"description": "**summary results** for all itinerary items",
"properties": {
"bookerEmail": {
"description": "ignore (Viator only)",
"type": "string"
},
"bookingDate": {
"description": "**date** of *this* booking",
"type": "string"
},
"bookingStatus": {
"$ref": "#/components/schemas/bookingStatus_itinerary"
},
"currencyCode": {
"description": "**specifier** of the currency in which pricing details are displayed",
"type": "string"
},
"distributorRef": {
"description": "ignore (Viator only)",
"type": "string"
},
"exchangeRate": {
"description": "ignore (Viator only)",
"type": "integer"
},
"hasVoucher": {
"description": "ignore (Viator only)",
"type": "boolean"
},
"itemSummaries": {
"description": "**array** of item summaries",
"items": {
"properties": {
"applePassSupported": {
"description": "ignore (Viator only)",
"type": "boolean"
},
"barcodeOption": {
"description": "Indicates whether a voucher is required for each passenger; or, whether the requirement is one voucher per group booking.",
"type": "string"
},
"barcodeType": {
"description": "**alphanumeric specifier** of the barcode type",
"type": "string"
},
"bookingEngineId": {
"$ref": "#/components/schemas/bookingEngineId-response"
},
"bookingStatus": {
"$ref": "#/components/schemas/bookingStatus_item"
},
"currencyCode": {
"description": "**currency code** for the currency in which pricing details are displayed",
"type": "string"
},
"departsFrom": {
"description": "**natural-language description** of *this* item's general departure location",
"type": "string"
},
"departurePoint": {
"description": "**HTML-formatted description** of *this* product's departure location(s)",
"type": "string"
},
"departurePointAddress": {
"description": "**HTML-formatted description** of *this* product's departure address",
"type": "string"
},
"departurePointDirections": {
"description": "**HTML-formatted descriptive notes** about *this* product's departure location",
"type": "string"
},
"destId": {
"description": "**unique numeric id** of the destination associated with *this* product",
"type": "integer"
},
"distributorItemRef": {
"description": "ignore (Viator only)",
"type": "string"
},
"hoursConfirmed": {
"description": "The `hoursConfirmed` field also indicates if the product is freesale or on request. The `hoursConfirmed` value is the approximate window for confirmation in hours, which can be presented to the customer. A value of `0` means that the product is **freesale**, and a value greater than `0` means that the product is **on-request**.\n",
"type": "integer"
},
"itemId": {
"description": "ignore (Viator only)",
"type": "integer"
},
"itineraryId": {
"description": "ignore (Viator only)",
"type": "integer"
},
"languageServicesLanguageCode": {
"description": "ignore (Viator only)",
"type": "string"
},
"lastRetailPrice": {
"description": "ignore (Viator only)",
"type": "number"
},
"lastRetailPriceFormatted": {
"description": "**currency-formatted most recent retail price** for *this* item",
"type": "string"
},
"leadTravellerFirstname": {
"description": "ignore (Viator only)",
"type": "string"
},
"leadTravellerSurname": {
"description": "ignore (Viator only)",
"type": "string"
},
"leadTravellerTitle": {
"description": "**title** of the lead traveler's name",
"type": "string"
},
"merchantCancellable": {
"description": "ignore (Viator only)\n\nFor cancellation information regarding the booking, please refer to the `merchantTermsAndConditions` object\n",
"type": "boolean"
},
"merchantNetPrice": {
"description": "**numeric merchant net rate** for *this* product\n- For more information, see: [Merchant pricing](#section/Merchant-APIs/Merchant-pricing)\n",
"type": "number"
},
"merchantNetPriceFormatted": {
"description": "**currency-formatted merchant net rate** for *this* product\n- For more information, see: [Merchant pricing](#section/Merchant-APIs/Merchant-pricing)\n",
"type": "string"
},
"obfsId": {
"description": "ignore (Viator only)",
"type": "integer"
},
"passbooks": {
"description": "ignore (Viator only)",
"type": "string"
},
"pickupHotelId": {
"description": "ignore (Viator only)",
"type": "integer"
},
"pickupHotelName": {
"description": "ignore (Viator only)",
"type": "string"
},
"price": {
"description": "**numeric suggested retail price** for *this* product\n- For more information, see: [Merchant pricing](#section/Key-concepts/Merchant-pricing)\n",
"type": "number"
},
"priceFormatted": {
"description": "**currency-formatted suggested retail price** for *this* product\n- For more information, see: [Merchant pricing](#section/Merchant-APIs/Merchant-pricing)\n",
"type": "string"
},
"priceUSD": {
"description": "**numeric price of *this* product** in USD",
"type": "number"
},
"productCode": {
"description": "**unique alphanumeric identifier** of *this* product",
"type": "string"
},
"productPulledDown": {
"description": "ignore (Viator only)",
"type": "boolean"
},
"productTitle": {
"description": "**natural-language title** of *this* product",
"type": "string"
},
"productWidgetList": {
"description": "ignore (Viator only)",
"type": "string"
},
"rulesApplied": {
"description": "**array** of rules applied to *this* item",
"items": {
"type": "string"
},
"type": "array"
},
"savingAmount": {
"$ref": "#/components/schemas/savingAmount"
},
"savingAmountFormated": {
"$ref": "#/components/schemas/savingAmountFormated"
},
"sortOrder": {
"description": "**sort-order** of *this* item summary",
"type": "integer"
},
"startingTime": {
"description": "**starting time** of the tour in the supplier's local time zone",
"type": "string"
},
"supplierName": {
"description": "**natural-language name** of *this* product's supplier",
"type": "string"
},
"supplierPhoneNumber": {
"description": "**telephone number** of the supplier",
"type": "string"
},
"termsAndConditions": {
"description": "ignore (Viator only)",
"type": "string"
},
"tourGradeCode": {
"description": "**alphanumeric specifier** of the tour grade",
"type": "string"
},
"tourGradeDescription": {
"description": "**natural-language description** of *this* item's tour grade",
"type": "string"
},
"travelDate": {
"description": "**date** on which *this* product will operate (in the supplier's local time zone)",
"type": "string"
},
"travellerAgeBands": {
"description": "**array** of age-band objects",
"items": {
"properties": {
"ageBandId": {
"$ref": "#/components/schemas/ageBandId"
},
"count": {
"description": "**number of travelers in *this* age band",
"type": "integer"
},
"description": {
"description": "**natural-language** description (singular) of *this* age band",
"type": "string"
},
"pluralDescription": {
"description": "**natural-language** description (plural) of *this* age band",
"type": "string"
},
"sortOrder": {
"description": "**sort order** for *this* age band",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
},
"voucherKey": {
"description": "Unique reference for the voucher for this booking that can be used as a request parameter to search for existing bookings using the [/booking/mybookings](#operation/bookingMybookings) and [/booking/pastbooking](#operation/bookingPastbooking) endpoints",
"type": "string"
},
"voucherOption": {
"description": "**alphanumeric specifier** of the relevant voucher option",
"type": "string"
},
"voucherRequirements": {
"description": "**natural-language description** of the voucher requirements for this tour (**note:** Should agree with value in `voucherOption` field)",
"type": "string"
},
"voucherURL": {
"description": "**URL of the voucher** for *this* product (if available). The customer can access this URL to retrieve their voucher.",
"type": "string"
},
"vouchers": {
"description": "ignore (Viator only)",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"itineraryId": {
"description": "**numeric identifier** for *this* order",
"type": "integer"
},
"omniPreRuleList": {
"description": "ignore (Viator only)",
"type": "integer"
},
"paypalRedirectURL": {
"description": "ignore (Viator only)",
"type": "string"
},
"rulesApplied": {
"description": "ignore (Viator only)",
"items": {
"type": "string"
},
"type": "array"
},
"securityToken": {
"description": "ignore (Viator only)",
"type": "string"
},
"sortOrder": {
"description": "**sort order** for *this* itinerary",
"type": "integer"
},
"totalPrice": {
"description": "**numeric total price (total)** for *this* order\n- For more information, see: [Merchant pricing](#section/Key-concepts/Merchant-pricing)\n",
"type": "number"
},
"totalPriceFormatted": {
"description": "**currency-formatted total price (including transaction fee)** for *this* order\n- For more information, see: [Merchant pricing](#section/Key-concepts/Merchant-pricing)\n",
"type": "string"
},
"totalPriceUSD": {
"description": "**numeric total price** of *this* order in USD",
"type": "number"
},
"userId": {
"description": "ignore (Viator only)",
"type": "integer"
},
"voucherKey": {
"description": "Unique reference for the voucher for this booking that can be used as a request parameter to search for existing bookings using the [/booking/mybookings](#operation/bookingMybookings) and [/booking/pastbooking](#operation/bookingPastbooking) endpoints",
"type": "string"
},
"voucherURL": {
"description": "**URL of the voucher** for *this* product (if available). The customer can access this URL to retrieve their voucher.",
"type": "string"
}
},
"type": "object"
},
"itineraryFromPrice": {
"description": "ignore (Viator only)",
"type": "number"
},
"itineraryFromPriceFormatted": {
"description": "ignore (Viator only)",
"type": "string"
},
"itineraryNewPrice": {
"description": "ignore (Viator only)",
"type": "number"
},
"itineraryNewPriceFormatted": {
"description": "ignore (Viator only)",
"type": "string"
},
"itinerarySaving": {
"description": "ignore (Viator only)",
"type": "integer"
},
"itinerarySavingFormatted": {
"description": "ignore (Viator only)",
"type": "string"
},
"paymentGatewayInfo": {
"description": "ignore (Viator only)",
"type": "string"
},
"promoCode": {
"description": "ignore (Viator only)",
"type": "string"
},
"promoCodeExpired": {
"description": "ignore (Viator only)",
"type": "boolean"
},
"promoCodeValid": {
"description": "ignore (Viator only)",
"type": "boolean"
},
"rulesApplied": {
"description": "ignore (Viator only)",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
},
"type": "object"
}
]
}
}
},
"description": "Success"
}
},
"summary": "/booking/calculateprice",
"tags": [
"Booking services"
]
}
},
"/booking/hotels": {
"get": {
"description": "Get hotel pick-ups\nLists the hotel pickups available for either a product or a destination\n",
"operationId": "bookingHotels",
"parameters": [
{
"$ref": "#/components/parameters/acceptLanguage"
},
{
"$ref": "#/components/parameters/productCode"
},
{
"$ref": "#/components/parameters/destId"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"1": {
"$ref": "#/components/examples/booking-hotels-example-1"
},
"2": {
"$ref": "#/components/examples/booking-hotels-example-2"
}
},
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/basicErrorModel"
},
{
"properties": {
"data": {
"description": "**array** of hotel pick-up objects",
"items": {
"properties": {
"address": {
"description": "**natural-language address** of hotel pick-up point",
"type": "string"
},
"brand": {
"description": "ignore (Viator only)",
"type": "string"
},
"city": {
"description": "**natural-language name** of the destination that *this* hotel pick-up point pertains to",
"type": "string"
},
"destinationId": {
"description": "**unique numeric identifer** of the destination that *this* hotel pick-up point pertains to",
"type": "integer"
},
"hotelString": {
"description": "ignore (Viator only)",
"type": "string"
},
"id": {
"description": "**identifier** of *this* hotel pick-up point`",
"type": "string"
},
"latitude": {
"description": "**numeric latitude component** of *this* hotel pick-up point's geolocation",
"type": "number"
},
"longitude": {
"description": "**numeric longitude component** of *this* hotel pick-up point's geolocation",
"type": "number"
},
"name": {
"description": "**natural-language name** of hotel pick-up point",
"type": "string"
},
"notes": {
"description": "**natural-language notes** about *this* hotel pick-up point",
"type": "string"
},
"phone": {
"description": "**phone number** of *this* hotel pick-up point",
"type": "string"
},
"postcode": {
"description": "**post code** of *this* hotel pick-up point",
"type": "string"
},
"productCodes": {
"description": "**array** of product codes pertaining to *this* hotel pick-up point",
"items": {
"type": "string"
},
"type": "array"
},
"sortOrder": {
"description": "**sort-order** of *this* hotel pick-up point",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
]
}
}
},
"description": "Success"
}
},
"summary": "/booking/hotels",
"tags": [
"Booking services"
]
}
},
"/booking/mybookings": {
"get": {
"description": "Get a user's bookings with travel dates in the future. \n\nThis service can also be used to check the status of a booking. \n\n**Provide either:** \n- A `voucherKey`, **or...** \n- An email address (`email`) and a booking reference (`itineraryOrItemId`) ([Booking Reference](#section/Key-concepts/Booking-references))\n",
"operationId": "bookingMybookings",
"parameters": [
{
"$ref": "#/components/parameters/acceptLanguage"
},
{
"description": "**voucher key** for the booking",
"example": "3299307:93c7f36a56b18ba1068787ba7fb7988da5c8ad08db77604110141ff21498603e:600033670",
"in": "query",
"name": "voucherKey",
"schema": {
"type": "string"
}
},
{
"description": "**email address** of the booker for the booking",
"example": "apitest@viator.com",
"in": "query",
"name": "email",
"schema": {
"type": "string"
}
},
{
"description": "The booking reference number of the item\n- **Note**: For more information, see [Booking references](#section/Key-concepts/Booking-references)\n",
"example": "700179574",
"in": "query",
"name": "itineraryOrItemId",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"1": {
"$ref": "#/components/examples/booking-mybookings-example"
}
},
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/basicErrorModel"
},
{
"properties": {
"data": {
"properties": {
"bookerEmail": {
"description": "**email address** of the entity that booked the tour",
"type": "string"
},
"bookingDate": {
"description": "**date** on which the booking was made",
"type": "string"
},
"bookingStatus": {
"$ref": "#/components/schemas/bookingStatus_itinerary"
},
"currencyCode": {
"description": "**currency code** for the currency in which pricing is displayed",
"type": "string"
},
"distributorRef": {
"description": "**reference code** for the distributor",
"type": "string"
},
"exchangeRate": {
"description": "**exchange rate** applied to the pricing",
"type": "integer"
},
"hasVoucher": {
"description": "**indicator**: `true` if a voucher exists",
"type": "boolean"
},
"itemSummaries": {
"description": "**array** of item summary objects",
"items": {
"properties": {
"barcodeOption": {
"description": "Indicates whether a voucher is required for each passenger; or, whether the requirement is one voucher per group booking.",
"type": "string"
},
"barcodeType": {
"description": "**alphanumeric code** specifying the type of barcode",
"type": "string"
},
"bookingEngineId": {
"$ref": "#/components/schemas/bookingEngineId-response"
},
"bookingStatus": {
"$ref": "#/components/schemas/bookingStatus_item"
},
"currencyCode": {
"description": "**currency code** for the currency in which pricing is displayed",
"type": "string"
},
"departsFrom": {
"description": "**natural-language description** of *this* item's departure location",
"type": "string"
},
"departurePoint": {
"description": "**natural-language description** of the product's departure point",
"type": "string"
},
"departurePointAddress": {
"description": "**natural-language address** of the departure point for the product",
"type": "string"
},
"departurePointDirections": {
"description": "**natural-language description** of how to access the departure point for the product",
"type": "string"
},
"destId": {
"description": "**unique numeric identifier** of the destination in which the product operates",
"type": "integer"
},
"distributorItemRef": {
"description": "**alphanumeric reference code** of the distributor item",
"type": "string"
},
"hoursConfirmed": {
"description": "The `hoursConfirmed` field also indicates if the product is freesale or on request. The `hoursConfirmed` value is the approximate window for confirmation in hours, which can be presented to the customer. A value of `0` means that the product is **freesale**, and a value greater than `0` means that the product is **on-request**.\n",
"type": "integer"
},
"itemId": {
"description": "Booking-reference number generated by Viator\n- **Note**: For more information, see: [Booking references](#section/Key-concepts/Booking-references)\n",
"type": "string"
},
"itineraryId": {
"description": "ignore (Viator only)",
"type": "integer"
},
"languageServicesLanguageCode": {
"description": "**language code** for the language that the product operates in",
"type": "string"
},
"lastRetailPrice": {
"description": "**currency-formatted merchant net rate** of *this* item",
"type": "number"
},
"lastRetailPriceFormatted": {
"description": "**currency-formatted retail price** of *this* item",
"type": "string"
},
"leadTravellerFirstname": {
"description": "**first name** of the lead traveler",
"type": "string"
},
"leadTravellerSurname": {
"description": "**surname** of the lead traveler",
"type": "string"
},
"leadTravellerTitle": {
"description": "**title** of the lead traveler's name",
"type": "string"
},
"merchantCancellable": {
"description": "ignore (Viator only)\n\nFor cancellation information regarding the booking, please refer to the `merchantTermsAndConditions` object\n",
"type": "boolean"
},
"merchantNetPrice": {
"description": "**currency-formatted merchant net rate** of *this* item\n- For more information, see: [Merchant pricing](#section/Merchant-APIs/Merchant-pricing)\n",
"type": "number"
},
"merchantNetPriceFormatted": {
"description": "**currency-formatted merchant net rate** of *this* item\n- For more information, see: [Merchant pricing](#section/Merchant-APIs/Merchant-pricing)\n",
"type": "string"
},
"merchantTermsAndConditions": {
"properties": {
"amountRefundable": {
"description": "**currency-formatted** amount that will be refunded if the cancellation is processed now.",
"type": "string"
},
"cancellationFromTourDate": {
"description": "**array** of cancellation policy objects",
"items": {
"properties": {
"dayRangeMax": {
"description": "**number** of days prior to the tour start date that *this* policy window begins. `null` signifies open-endedness",
"type": "integer"
},
"dayRangeMin": {
"description": "**number** of days prior to the tour start date that *this* policy window ends",
"type": "integer"
},
"percentageRefundable": {
"description": "**percentage** of total price refundable if cancelled within *this* time window",
"type": "integer"
},
"policyEndTimestamp": {
"description": "**Unix timestamp** giving the exact time the policy ends",
"type": "integer"
},
"policyStartTimestamp": {
"description": "**Unix timestamp** giving the exact time the policy commences",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
},
"termsAndConditions": {
"description": "**natural-language description** of the terms and conditions for *this* product",
"type": "string"
}
},
"type": "object"
},
"obfsId": {
"description": "ignore (Viator only)",
"type": "string"
},
"passbooks": {
"description": "ignore (Viator only)",
"type": "string"
},
"price": {
"description": "**numeric merchant total price** of the product that was booked\n- For more information, see: [Merchant pricing](#section/Merchant-APIs/Merchant-pricing)\n",
"type": "number"
},
"priceFormatted": {
"description": "**currency-formatted merchant total price** for *this* booking\n- For more information, see: [Merchant pricing](#section/Merchant-APIs/Merchant-pricing)\n",
"type": "string"
},
"priceUSD": {
"type": "number"
},
"productCode": {
"description": "**unique alphanumeric identifier** of the product that was booked",
"type": "string"
},
"productPulledDown": {
"type": "boolean"
},
"productTitle": {
"description": "**natural-language description** of the product that was booked",
"type": "string"
},
"productWidgetList": {
"description": "ignore (Viator only)",
"type": "string"
},
"rulesApplied": {
"description": "ignore (Viator only)",
"type": "string"
},
"savingAmount": {
"$ref": "#/components/schemas/savingAmount"
},
"savingAmountFormated": {
"$ref": "#/components/schemas/savingAmountFormated"
},
"sortOrder": {
"description": "**sort order** of *this* item summary",
"type": "integer"
},
"termsAndConditions": {
"description": "ignore (Viator only)",
"type": "string"
},
"tourGradeCode": {
"description": "**alphanumeric identifier** of the tour grade of the product that was booked",
"type": "string"
},
"tourGradeDescription": {
"description": "**natural-language description** of *this* tour grade",
"type": "string"
},
"travelDate": {
"description": "**date** of travel for the product that was booked",
"type": "string"
},
"travellerAgeBands": {
"description": "**array** of age band objects",
"items": {
"properties": {
"ageBandId": {
"$ref": "#/components/schemas/ageBandId"
},
"count": {
"description": "**number** of travelers in *this* age band",
"type": "integer"
},
"description": {
"description": "**natural-language description** (singular) of *this* age band",
"type": "string"
},
"pluralDescription": {
"description": "**natural-language description** (plural) of *this* age band",
"type": "string"
},
"sortOrder": {
"description": "**sort order** for *this* age band",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
},
"voucherKey": {
"description": "Unique reference for the voucher for this booking that can be used as a request parameter to search for existing bookings using the [/booking/mybookings](#operation/bookingMybookings) and [/booking/pastbooking](#operation/bookingPastbooking) endpoints",
"type": "string"
},
"voucherOption": {
"description": "**specifier** of the rules pertaining to the use of the voucher",
"type": "string"
},
"voucherRequirements": {
"description": "**natural-language description** of the requirements for using the voucher",
"type": "string"
},
"voucherURL": {
"description": "**URL of the voucher** for *this* product (if available). The customer can access this URL to retrieve their voucher.",
"type": "string"
},
"vouchers": {
"description": "ignore (Viator only)",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"itineraryId": {
"description": "ignore (Viator only)",
"type": "integer"
},
"rulesApplied": {
"description": "ignore (Viator only)",
"type": "string"
},
"sortOrder": {
"description": "**sort order** for the booking object",
"type": "integer"
},
"totalPrice": {
"description": "**numeric merchant total price** for *this* booking\nFor more information, see: [Merchant pricing](#section/Merchant-APIs/Merchant-pricing)\n",
"type": "number"
},
"totalPriceFormatted": {
"description": "**currency-formatted merchant total price** of *this* booking\n- For more information, see: [Merchant pricing](#section/Merchant-APIs/Merchant-pricing)\n",
"type": "string"
},
"totalPriceUSD": {
"description": "**numeric merchant total price** of this booking in USD",
"type": "number"
},
"userId": {
"description": "ignore (Viator only)",
"type": "string"
},
"voucherKey": {
"description": "Unique reference for the voucher for this booking that can be used as a request parameter to search for existing bookings using the [/booking/mybookings](#operation/bookingMybookings) and [/booking/pastbooking](#operation/bookingPastbooking) endpoints",
"type": "string"
},
"voucherURL": {
"description": "**URL of the voucher** for *this* product (if available). The customer can access this URL to retrieve their voucher.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
]
}
}
},
"description": "Success"
}
},
"summary": "/booking/mybookings",
"tags": [
"Booking services"
]
}
},
"/booking/pastbooking": {
"get": {
"description": "Get the details of a single specific past booking based on the `voucherKey` or `itemId` and email address sent in the request.\n\n**Note**: this service will only return past bookings that were made with the same API key that was used to make the booking\n\n**Sample query parameters**:\n- email=apitest@viator.com&itemId=580669678\n\n**or**\n- voucherKey=1005851866:4af44c13ecf3f1a7d3f9ef2fc00c2257e08fa42ae20f877f3039ff9b52aba24e:580669678\n\n**email**\n- The email address passed must match the email address associated with the booking\n\n**Departure details**\n\n- Departure details such as the `departurePoint`, `departurePointAddress` and `departurePointDirections` is included in the response. \n- These fields may contain HTML escape characters such as &amp; and special characters that are escaped by a backslash. Ensure that these fields are parsed after receiving the response as it will cause your JSON to be invalid.\n\nFor more information, see: [Reviewing bookings](#section/Common-workflows-and-data-validation/Reviewing-bookings)\n",
"operationId": "bookingPastbooking",
"parameters": [
{
"$ref": "#/components/parameters/acceptLanguage"
},
{
"description": "**specifier** of past booking type (use *one* of: `itemId` (booking reference) *and* `'voucherKey'` *or* `'email'`)",
"example": "1005851866:4af44c13ecf3f1a7d3f9ef2fc00c2257e08fa42ae20f877f3039ff9b52aba24e:580669678",
"in": "query",
"name": "voucherKey",
"schema": {
"type": "string"
}
},
{
"description": "**email address** by which to search for past bookings",
"example": "apitest@viator.com",
"in": "query",
"name": "email",
"schema": {
"type": "string"
}
},
{
"description": "Search for a booking with this **unique booking-reference number**. See [Booking references](#section/Key-concepts/Booking-references) for more information.\n",
"example": "580669678",
"in": "query",
"name": "itemId",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"1": {
"$ref": "#/components/examples/booking-pastbooking-example"
}
},
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/basicErrorModel"
},
{
"properties": {
"data": {
"description": "**object** containing pricing matrix information",
"properties": {
"bookerEmail": {
"description": "**email address** of the entity that booked the tour",
"type": "string"
},
"bookingDate": {
"description": "**date** on which the booking was made",
"type": "string"
},
"bookingStatus": {
"$ref": "#/components/schemas/bookingStatus_itinerary"
},
"currencyCode": {
"description": "**currency code** for the currency in which pricing is displayed",
"type": "string"
},
"distributorRef": {
"description": "**reference code** for the distributor",
"type": "string"
},
"exchangeRate": {
"description": "ignore (Viator only)",
"type": "integer"
},
"hasVoucher": {
"description": "**indicator**: `true` if a voucher exists",
"type": "boolean"
},
"itemSummaries": {
"description": "**array** of item summary objects",
"items": {
"properties": {
"barcodeOption": {
"description": "Indicates whether a voucher is required for each passenger; or, whether the requirement is one voucher per group booking.",
"type": "string"
},
"barcodeType": {
"description": "**alphanumeric code** specifying the type of barcode",
"type": "string"
},
"bookingEngineId": {
"$ref": "#/components/schemas/bookingEngineId-response"
},
"bookingStatus": {
"$ref": "#/components/schemas/bookingStatus_item"
},
"currencyCode": {
"description": "**currency code** for the currency in which pricing is displayed",
"type": "string"
},
"departsFrom": {
"description": "**natural-language description** of *this* item's departure location",
"type": "string"
},
"departurePoint": {
"description": "**natural-language description** of the product departure point",
"type": "string"
},
"departurePointAddress": {
"description": "**natural-language address** of the departure point for the product",
"type": "string"
},
"departurePointDirections": {
"description": "**natural-language description** of how to access the departure point for the product",
"type": "string"
},
"destId": {
"description": "**unique numeric identifier** of the destination in which the product operates",
"type": "integer"
},
"distributorItemRef": {
"description": "**alphanumeric reference code** of the distributor item",
"type": "string"
},
"hoursConfirmed": {
"description": "The `hoursConfirmed` field also indicates if the product is freesale or on request. The `hoursConfirmed` value is the approximate window for confirmation in hours, which can be presented to the customer. A value of `0` means that the product is **freesale**, and a value greater than `0` means that the product is **on-request**.\n",
"type": "integer"
},
"itemId": {
"description": "Booking-reference number generated by Viator\n- **Note**: For more information, see: [Booking references](#section/Key-concepts/Booking-references)\n",
"type": "string"
},
"itineraryId": {
"description": "ignore (Viator only)",
"type": "integer"
},
"languageServicesLanguageCode": {
"description": "**language code** for the language that the product operates in",
"type": "string"
},
"lastRetailPrice": {
"description": "**numeric last retail price** of *this* item",
"type": "number"
},
"lastRetailPriceFormatted": {
"description": "**currency-formatted retail price** of *this* item",
"type": "string"
},
"leadTravellerFirstname": {
"description": "**first name** of the lead traveler",
"type": "string"
},
"leadTravellerSurname": {
"description": "**surname** of the lead traveler",
"type": "string"
},
"leadTravellerTitle": {
"description": "**title** of the lead traveler's name",
"type": "string"
},
"merchantCancellable": {
"description": "ignore (Viator only)\n\nFor cancellation information regarding the booking, please refer to the `merchantTermsAndConditions` object\n",
"type": "boolean"
},
"merchantNetPrice": {
"description": "**numeric merchant net rate** for *this* item\n- For more information, see: [Merchant pricing](#section/Merchant-APIs/Merchant-pricing)\n",
"type": "number"
},
"merchantNetPriceFormatted": {
"description": "**currency-formatted merchant net rate** for *this* item\n- For more information, see: [Merchant pricing](#section/Merchant-APIs/Merchant-pricing)\n",
"type": "string"
},
"merchantTermsAndConditions": {
"properties": {
"amountRefundable": {
"description": "**currency-formatted** amount that will be refunded if the cancellation is processed now.",
"type": "string"
},
"cancellationFromTourDate": {
"description": "**array** of cancellation policy objects",
"items": {
"properties": {
"dayRangeMax": {
"description": "**number** of days prior to the tour start date that *this* policy window begins. `null` signifies open-endedness",
"type": "integer"
},
"dayRangeMin": {
"description": "**number** of days prior to the tour start date that *this* policy window ends",
"type": "integer"
},
"percentageRefundable": {
"description": "**percentage** of total price refundable if cancelled within *this* time window",
"type": "integer"
},
"policyEndTimestamp": {
"description": "**Unix timestamp** giving the exact time the policy ends",
"type": "integer"
},
"policyStartTimestamp": {
"description": "**Unix timestamp** giving the exact time the policy commences",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
},
"termsAndConditions": {
"description": "**natural-language description** of the terms and conditions for *this* product",
"type": "string"
}
},
"type": "object"
},
"obfsId": {
"description": "ignore (Viator only)",
"type": "string"
},
"passbooks": {
"description": "ignore (Viator only)",
"type": "string"
},
"price": {
"description": "**numeric merchant total price** for the booked product\n- For more information, see: [Merchant pricing](#section/Merchant-APIs/Merchant-pricing)\n",
"type": "number"
},
"priceFormatted": {
"description": "**currency-formatted merchant total price** for *this* item\n- For more information, see: [Merchant pricing](#section/Merchant-APIs/Merchant-pricing)\n",
"type": "string"
},
"priceUSD": {
"description": "**numeric merchant total price** of the item in USD",
"type": "number"
},
"productCode": {
"description": "**unique alphanumeric identifier** of the product that was booked",
"type": "string"
},
"productPulledDown": {
"description": "ignore (Viator only)",
"type": "boolean"
},
"productTitle": {
"description": "**natural-language description** of the product that was booked",
"type": "string"
},
"productWidgetList": {
"description": "ignore (Viator only)",
"type": "string"
},
"rulesApplied": {
"description": "ignore (Viator only)",
"type": "string"
},
"savingAmount": {
"$ref": "#/components/schemas/savingAmount"
},
"savingAmountFormated": {
"$ref": "#/components/schemas/savingAmountFormated"
},
"sortOrder": {
"type": "integer"
},
"termsAndConditions": {
"description": "ignore (Viator only)",
"type": "string"
},
"tourGradeCode": {
"description": "**alphanumeric identifier** of the tour grade of the product that was booked",
"type": "string"
},
"tourGradeDescription": {
"description": "**natural-language description** of *this* tour grade",
"type": "string"
},
"travelDate": {
"description": "**date** of travel for the product that was booked",
"type": "string"
},
"travellerAgeBands": {
"description": "**array** of age band objects",
"items": {
"properties": {
"ageBandId": {
"$ref": "#/components/schemas/ageBandId"
},
"count": {
"description": "**number** of travelers in *this* age band",
"type": "integer"
},
"description": {
"description": "**natural-language description** (singular) of *this* age band",
"type": "string"
},
"pluralDescription": {
"description": "**natural-language description** (plural) of *this* age band",
"type": "string"
},
"sortOrder": {
"description": "**sort order** for *this* age band",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
},
"voucherKey": {
"description": "Unique reference for the voucher for this booking that can be used as a request parameter to search for existing bookings using the [/booking/mybookings](#operation/bookingMybookings) and [/booking/pastbooking](#operation/bookingPastbooking) endpoints",
"type": "string"
},
"voucherOption": {
"description": "**specifier** of the rules pertaining to the use of the voucher",
"type": "string"
},
"voucherRequirements": {
"description": "**natural-language description** of the requirements for using the voucher",
"type": "string"
},
"voucherURL": {
"description": "**URL of the voucher** for *this* product (if available). The customer can access this URL to retrieve their voucher.",
"type": "string"
},
"vouchers": {
"description": "ignore (Viator only)",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"itineraryId": {
"description": "ignore (Viator only)",
"type": "integer"
},
"rulesApplied": {
"description": "ignore (Viator only)",
"type": "string"
},
"sortOrder": {
"description": "**sort order** for *this* result",
"type": "integer"
},
"totalPrice": {
"description": "**numeric merchant total price** for *this* booking\n- For more information, see: [Merchant pricing](#section/Merchant-APIs/Merchant-pricing)\n",
"type": "number"
},
"totalPriceFormatted": {
"description": "**currency-formatted merchant total price** for *this* booking\n- For more information, see: [Merchant pricing](#section/Merchant-APIs/Merchant-pricing)\n",
"type": "string"
},
"totalPriceUSD": {
"description": "**numeric merchant total price** of this booking in USD",
"type": "number"
},
"userId": {
"description": "ignore (Viator only)",
"type": "string"
},
"voucherKey": {
"description": "Unique reference for the voucher for this booking that can be used as a request parameter to search for existing bookings using the [/booking/mybookings](#operation/bookingMybookings) and [/booking/pastbooking](#operation/bookingPastbooking) endpoints",
"type": "string"
},
"voucherURL": {
"description": "**URL of the voucher** for *this* product (if available). The customer can access this URL to retrieve their voucher.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
]
}
}
},
"description": "Success"
}
},
"summary": "/booking/pastbooking",
"tags": [
"Booking services"
]
}
},
"/booking/pricingmatrix": {
"post": {
"description": "Get the pricing matrix for tour-grades, product age bands and pax mixes\n\nFor more information, see: [Get the tour-grade pricing matrix](#section/Common-workflows-and-data-validation/Get-the-tour-grade-pricing-matrix)\n",
"operationId": "bookingPricingmatrix",
"parameters": [
{
"$ref": "#/components/parameters/acceptLanguage"
}
],
"requestBody": {
"content": {
"application/json": {
"example": {
"bookingDate": "2020-12-12",
"currencyCode": "EUR",
"productCode": "5010SYDNEY",
"tourGradeCode": "24HOUR"
},
"schema": {
"properties": {
"bookingDate": {
"description": "**date** for which to retrieve pricing data (must be in the future) (**note**: this is an optional parameter for normal products; if the date is *not* provided then the nearest available date is determined)",
"type": "string"
},
"currencyCode": {
"description": "**currency code** of the currency in which to display pricing information",
"type": "string"
},
"productCode": {
"description": "**unique alphanumeric identifier** of the product for which to retrieve the pricing matrix",
"type": "string"
},
"tourGradeCode": {
"description": "**alphanumeric identifier** of the product tour grade for which to retrieve the pricing matrix",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"1": {
"$ref": "#/components/examples/booking-pricingmatrix-example"
}
},
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/basicErrorModel"
},
{
"properties": {
"data": {
"items": {
"properties": {
"ageBandPrices": {
"description": "**array** of age band pricing objects",
"items": {
"properties": {
"bandId": {
"$ref": "#/components/schemas/bandId"
},
"maximumCountRequired": {
"description": "**maximum number of travelers** that this pricing schedule can be applied to\n- use this field to specify the largest group size you are interested in making a booking for\n",
"type": "integer"
},
"minimumCountRequired": {
"description": "**minimum number of travelers** that this pricing schedule can be applied to\n- use this field to specify the smallest group size you are interested in making a booking for\n",
"type": "integer"
},
"prices": {
"description": "**array** of prices available for *this* age band (based on the min and max count required)",
"items": {
"properties": {
"currencyCode": {
"description": "**currency code** for the currency in which pricing is displayed",
"type": "string"
},
"merchantNetPrice": {
"description": "**numeric merchant net rate** for *this* age band\n- For more information, see: [Merchant pricing](#section/Merchant-APIs/Merchant-pricing)\n",
"type": "number"
},
"merchantNetPriceFormatted": {
"description": "**currency-formatted merchant net rate** for *this* age band\n- For more information, see: [Merchant pricing](#section/Merchant-APIs/Merchant-pricing)\n",
"type": "string"
},
"minNoOfTravellersRequiredForPrice": {
"description": "**minimum number of travelers** that this pricing schedule can be applied to; e.g., '3' means that the price is for a group of three people or more",
"type": "integer"
},
"price": {
"description": "**numeric suggested retail price** for *this* age band\n- For more information, see: [Merchant pricing](#section/Merchant-APIs/Merchant-pricing)\n",
"type": "number"
},
"priceFormatted": {
"description": "**currency-formatted suggested retail price** for *this* age band and the suggested sell price\n- For more information, see: [Merchant pricing](#section/Merchant-APIs/Merchant-pricing)\n",
"type": "string"
},
"sortOrder": {
"description": "**sort order** for *this* pricing object",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"sortOrder": {
"description": "**sort order** for *this* age band",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
},
"bookingDate": {
"description": "**date** for which to retrieve pricing information",
"type": "string"
},
"pricingUnit": {
"description": "**unit** in which pricing is calculated (currently, only 'per person' is supported)\n- see [Understanding the pricingUnit field](#section/Using-the-API/Understanding-the-pricingUnit-field) for more information\n",
"type": "string"
},
"sortOrder": {
"description": "**sort order** for *this* response object",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
]
}
}
},
"description": "Success"
}
},
"summary": "/booking/pricingmatrix",
"tags": [
"Booking services"
]
}
},
"/booking/status": {
"post": {
"description": "Get the booking status for multiple items based on different criteria\n\nThis service: \n- is ideally be used in software for bulk updates of pending bookings\n- returns a maximum of 1000 bookings (narrow your search if you expect a greater number of results)\n- will return <u>both</u> live <u>and</u> test bookings\n- rate limited to <u>one request every 30 minutes</u>\n- For more information, see: [Get the bookiing status for multiple items](#section/Common-workflows-and-data-validation/Get-the-booking-status-for-multiple-items)\n\n**Exceeding the rate limit**\n- You will receive the following error message if you exceed the rate limit allowed for this service. Set `test` to `true` to bypass this limit:\n```javascript\n{\n \"data\": null\n \"vmid\": 221002\n \"errorMessage\": [\"Access allowed every 30 minutes\"]\n \"errorType\": \"EXCEPTION\"\n \"dateStamp\": \"2013-03-26T10:28:51+0000\"\n \"errorReference\": 55315512721712161381352771\n \"errorMessageText\": [\"Access allowed every 30 minutes\"]\n \"success\": false\n \"totalCount\": 1\n \"errorName\": \"PollingDeniedException\" \n}\n```\n",
"operationId": "bookingStatus",
"parameters": [
{
"$ref": "#/components/parameters/acceptLanguage"
}
],
"requestBody": {
"content": {
"application/json": {
"examples": {
"all": {
"value": {
"bookingDateFrom": "2020-12-21",
"bookingDateTo": "2020-12-31",
"distributorItemRefs": [
"itemRef1000000"
],
"itemIds": [
580669678
],
"leadFirstName": "Homer test",
"leadSurname": "Simpson test",
"test": true
}
},
"booking_date": {
"value": {
"bookingDateFrom": "2020-12-21",
"bookingDateTo": "2020-12-31",
"test": true
}
},
"distributorItemRefs": {
"value": {
"distributorItemRefs": [
"itemRef1000000"
],
"test": true
}
},
"itemIds": {
"value": {
"itemIds": [
580669678
],
"test": true
}
},
"lead_name": {
"value": {
"leadFirstName": "Homer test",
"leadSurname": "Simpson test",
"test": true
}
}
},
"schema": {
"description": "**note**: all items are optional, but at least one needs to be included",
"properties": {
"bookingDateFrom": {
"description": "**earliest date** for *this* booking (must be in the future)",
"type": "string"
},
"bookingDateTo": {
"description": "**latest date** for *this* booking (must be in the future)",
"type": "string"
},
"distributorItemRefs": {
"description": "**array** of partner-defined distributor item reference identifiers e.g. `['refItem1','refItem2','refItem3']`",
"items": {
"type": "string"
},
"type": "array"
},
"distributorRefs": {
"description": "**array** of partner-defined distributor reference identifiers",
"items": {
"type": "string"
},
"type": "array"
},
"itemIds": {
"description": "**array** of item identifiers to check",
"items": {
"description": "**numeric item identifier**",
"type": "integer"
},
"type": "array"
},
"leadFirstName": {
"description": "**first name** of the lead traveler",
"type": "string"
},
"leadSurname": {
"description": "**surname** of the lead traveler",
"type": "string"
},
"test": {
"description": "**specifier**:\n- `true`: bypass the poll limit in the prelive environment only (recommended for testing)\n- `false`: (default)\n",
"type": "boolean"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"1": {
"$ref": "#/components/examples/booking-status-example"
}
},
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/basicErrorModel"
},
{
"properties": {
"data": {
"description": "**object** containing booking status and details",
"properties": {
"bookingDate": {
"description": "**date**: of *this* booking",
"type": "string"
},
"bookingStatus": {
"$ref": "#/components/schemas/bookingStatus_itinerary"
},
"distributorRef": {
"description": "**alphanumeric identifer** of the distributor for *this* booking",
"type": "string"
},
"itemSummaries": {
"description": "**array** of item summary objects",
"items": {
"properties": {
"bookingStatus": {
"$ref": "#/components/schemas/bookingStatus_item"
},
"distributorItemRef": {
"description": "**partner-defined distributor item reference identifier**",
"type": "string"
},
"itemId": {
"description": "Booking-reference number generated by Viator\n- **Note**: For more information, see: [Booking references](#section/Key-concepts/Booking-references)\n",
"type": "integer"
},
"itineraryId": {
"description": "ignore (Viator only)",
"type": "integer"
},
"sortOrder": {
"description": "**sort order** for *this* item",
"type": "integer"
},
"travelDate": {
"description": "**date** of the booking",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"itineraryId": {
"description": "ignore (Viator only)",
"type": "integer"
},
"sortOrder": {
"description": "**sort order** for *this* response",
"example": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
}
]
}
}
},
"description": "Success"
}
},
"summary": "/booking/status",
"tags": [
"Booking services"
]
}
},
"/booking/status/items": {
"post": {
"description": "Get brief booking statuses\n\nThis service is similar to [/booking/status](#operation/bookingStatus) in that it:\n- retrieves the booking status for multiple items based on different criteria\n- has the same request parameters as [/booking/status](#operation/bookingStatus)\n\nHowever, it differs in that it returns a multi-item array of booking items with less detail than what would be received from [/booking/status](#operation/bookingStatus).\n",
"operationId": "bookingStatusItems",
"parameters": [
{
"$ref": "#/components/parameters/acceptLanguage"
}
],
"requestBody": {
"content": {
"application/json": {
"examples": {
"all": {
"value": {
"bookingDateFrom": "2020-12-21",
"bookingDateTo": "2020-12-31",
"distributorItemRefs": [
"itemRef1000000"
],
"itemIds": [
580669678
],
"leadFirstName": "Homer test",
"leadSurname": "Simpson test",
"test": true
}
},
"booking_date": {
"value": {
"bookingDateFrom": "2020-12-21",
"bookingDateTo": "2020-12-31",
"test": true
}
},
"distributorItemRefs": {
"value": {
"distributorItemRefs": [
"itemRef1000000"
],
"test": true
}
},
"itemIds": {
"value": {
"itemIds": [
580669678
],
"test": true
}
},
"lead_name": {
"value": {
"leadFirstName": "Homer test",
"leadSurname": "Simpson test",
"test": true
}
}
},
"schema": {
"description": "**note**: all items are optional, but at least one needs to be included",
"properties": {
"bookingDateFrom": {
"description": "**earliest date** for when the booking(s) in question were made (must be in the future)",
"type": "string"
},
"bookingDateTo": {
"description": "**latest date** for when the booking(s) in question were made (must be in the future)",
"type": "string"
},
"distributorItemRefs": {
"description": "**array** of partner-defined distributor item reference identifiers e.g. `['refItem1','refItem2','refItem3']`",
"items": {
"type": "string"
},
"type": "array"
},
"distributorRefs": {
"description": "**array** of partner-defined distributor reference identifiers",
"items": {
"type": "string"
},
"type": "array"
},
"itemIds": {
"description": "**array** of booking-reference numbers to check\n\n `itemId` (booking-reference provided by Viator). For more information, see [Booking references](#section/Key-concepts/Booking-references)\n",
"items": {
"description": "**numeric item identifier**",
"type": "integer"
},
"type": "array"
},
"leadFirstName": {
"description": "**first name** of the lead traveler",
"type": "string"
},
"leadSurname": {
"description": "**surname** of the lead traveler",
"type": "string"
},
"test": {
"description": "**specifier**:\n- `true`: bypass the poll limit in the prelive environment only\n- `false`: (default) make a *real* booking, not a test\n",
"type": "boolean"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"1": {
"$ref": "#/components/examples/booking-status-items-example"
}
},
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/basicErrorModel"
},
{
"properties": {
"data": {
"description": "**array** containing item ids and their associated booking status object",
"items": {
"properties": {
"bookingStatus": {
"$ref": "#/components/schemas/bookingStatus_item"
},
"distributorItemRef": {
"description": "**partner-defined distributor item reference identifier**",
"type": "string"
},
"itemId": {
"description": "Booking-reference number generated by Viator\n- **Note**: For more information, see: [Booking references](#section/Key-concepts/Booking-references)\n",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
]
}
}
},
"description": "Success"
}
},
"summary": "/booking/status/items",
"tags": [
"Booking services"
]
}
},
"/booking/voucher": {
"get": {
"description": "Get voucher details\n- Use this service to retrieve the voucher details of a booked item.\n- The data returned is HTML-formatted and can be wrapped in a header and/or footer.\n\n**Sample query parameters**\n- leadLastName=Simpson test&itemId=580669678\n\n**or** \n- voucherKey=1005851866:4af44c13ecf3f1a7d3f9ef2fc00c2257e08fa42ae20f877f3039ff9b52aba24e:580669678&fullHTML=true&mobileVoucher=true\n",
"operationId": "bookingVoucher",
"parameters": [
{
"$ref": "#/components/parameters/acceptLanguage"
},
{
"description": "**surname** of *this* lead traveler",
"example": "Simpson",
"in": "query",
"name": "leadLastName",
"schema": {
"type": "string"
}
},
{
"description": "Booking-reference number generated by Viator\n\n - **Note**: For more information, see: [Booking references](#section/Key-concepts/Booking-references)\n",
"example": "600033670",
"in": "query",
"name": "itemId",
"schema": {
"type": "integer"
}
},
{
"description": "ignore (Viator only)",
"in": "query",
"name": "embeddedResources",
"schema": {
"example": false,
"type": "boolean"
}
},
{
"description": "**identifier** for the voucher\n- **note**: use <u>either</u> `voucherKey` <u>or</u> the three separate parameters\n- if `voucherKey` is provided as well as the other parameters, then `voucherKey` overrides the other paramaters\n- `voucherKey` is obtained from [/booking/mybookings](#operation/bookingMybookings) or in the response from [/booking/book](#operation/bookingBook) when you make a booking\n",
"in": "query",
"name": "voucherKey",
"schema": {
"example": "3299307:93c7f36a56b18ba1068787ba7fb7988da5c8ad08db77604110141ff21498603e:600033670",
"type": "string"
}
},
{
"description": "**specifier**:\n- set to `true` if you wish to retrieve the full HTML-formatted voucher\n- set to `false` if you want the div fragment (optional)\n",
"example": true,
"in": "query",
"name": "fullHTML",
"schema": {
"type": "boolean"
}
},
{
"description": "**specifier**: \n- if set to `true`, the service returns the mobile (cut down) HTML-formatted voucher\n- if `false` the full voucher HTML is returned (ignoring `fullHTML`)\n- default: `true` \n- this field should only be enabled for products that have a `voucherOption` of `'VOUCHER_E'`\n- do not enable `mobileVouchers` for paper vouchers (`voucherOption` of `'VOUCHER_PAPER_ONLY'`) as no barcode is returned\n- the voucher information is available in the response from [/product](#operation/product), [/booking/book](#operation/bookingBook), [/booking/pastbooking](#operation/bookingPastbooking), [/booking/mybookings](#operation/bookingMybookings) (it is also displayed under the 'Redemption Info' heading in this service)\n",
"example": true,
"in": "query",
"name": "mobileVoucher",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"1": {
"$ref": "#/components/examples/booking-voucher-example"
}
},
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/basicErrorModel"
},
{
"properties": {
"data": {
"description": "**HTML-formatted** voucher content",
"type": "string"
}
},
"type": "object"
}
]
}
}
},
"description": "Success"
}
},
"summary": "/booking/voucher",
"tags": [
"Booking services"
]
}
},
"/bookings/cancel-reasons": {
"get": {
"description": "Retrieves a dictionary of unique identification codes (`cancellationReasonCode`) and their associated natural-language descriptions (`cancellationReasonText`).\n\nFor information on how to use this service, see: [Cancellation API workflow](#section/Common-workflows-and-data-validation/Cancellation-API-workflow)\n\n**Note**: \n\n * This service <u>requires</u> [exp-api-key](#section/Authentication/exp-api-key) to be included as a header parameter. Please speak to your account manager if you have not yet been issued an exp-api-key.\n * The base URL for the server for this endpoint is different from the older endpoints described in this document. Use `https://api.sandbox.viator.com/partner/cancel-reasons`\n",
"operationId": "cancellationReasons",
"parameters": [
{
"$ref": "#/components/parameters/acceptLanguage"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"1": {
"$ref": "#/components/examples/cancel-reasons-example"
}
},
"schema": {
"items": {
"$ref": "#/components/schemas/CancellationReasonsResponse"
},
"type": "array"
}
}
},
"description": "Success"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401_UNAUTHORIZED"
}
}
},
"description": "Unauthorized"
},
"406": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/406_NOT_ACCEPTABLE"
}
}
},
"description": "Not Acceptable"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500_INTERNAL_SERVER_ERROR"
}
}
},
"description": "Internal Server Error"
},
"503": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/503_SERVICE_UNAVAILABLE"
}
}
},
"description": "Service Unavailable"
}
},
"servers": [
{
"description": "Sandbox server (uses test data)",
"url": "https://api.sandbox.viator.com/partner"
}
],
"summary": "/bookings/cancel-reasons",
"tags": [
"Booking services"
]
}
},
"/bookings/{booking-reference}/cancel": {
"post": {
"description": "Submits a cancellation request for the specified booking\n\nFor information on how to use this service, see: [Cancellation API workflow](#section/Common-workflows-and-data-validation/Cancellation-API-workflow)\n\n**Note**: \n\n * This service <u>requires</u> [exp-api-key](#section/Authentication/exp-api-key) to be included as a header parameter. Please speak to your account manager if you have not yet been issued an exp-api-key.\n * The base URL for the server for this endpoint is different from the older endpoints described in this document. Use `https://api.sandbox.viator.com/partner/bookings/{booking-reference}/cancel`\n",
"operationId": "cancelBooking",
"parameters": [
{
"description": "The ID of the booking",
"in": "path",
"name": "booking-reference",
"required": true,
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/acceptLanguage"
}
],
"requestBody": {
"content": {
"application/json": {
"example": {
"reasonCode": "Customer_Service.I_canceled_my_entire_trip"
},
"schema": {
"$ref": "#/components/schemas/CancellationRequest"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"1": {
"summary": "canceled",
"value": {
"bookingId": "BR-580669678",
"status": "ACCEPTED"
}
},
"2": {
"summary": "already canceled",
"value": {
"bookingId": "BR-580669678",
"reason": "ALREADY_CANCELLED",
"status": "DECLINED"
}
}
},
"schema": {
"$ref": "#/components/schemas/CancelBookingResponse"
}
}
},
"description": "Success"
},
"400": {
"content": {
"application/json": {
"schema": {
"properties": {
"code": {
"enum": [
"BAD_REQUEST"
],
"example": "BAD_REQUEST",
"type": "string"
},
"message": {
"enum": [
"Missing cancellation reason"
],
"example": "Missing cancellation reason",
"type": "string"
},
"timestamp": {
"description": "Timestamp of the request",
"example": "2019-09-17T03:20:45.737043Z",
"type": "string"
},
"trackingId": {
"description": "Tracking identifier for this error response (useful when seeking support)",
"example": "XXXX",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "Bad request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401_UNAUTHORIZED"
}
}
},
"description": "Unauthorized"
},
"404": {
"content": {
"application/json": {
"schema": {
"properties": {
"code": {
"enum": [
"NOT_FOUND"
],
"example": "NOT_FOUND",
"type": "string"
},
"message": {
"description": "The specified booking was not found; or, it was not created with this API key",
"enum": [
"Booking not found"
],
"example": "Booking not found",
"type": "string"
},
"timestamp": {
"description": "Timestamp of the request",
"example": "2019-09-17T03:20:45.737043Z",
"type": "string"
},
"trackingId": {
"description": "Tracking identifier for this error response (useful when seeking support)",
"example": "XXXX",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "Not found"
},
"406": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/406_NOT_ACCEPTABLE"
}
}
},
"description": "Not Acceptable"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500_INTERNAL_SERVER_ERROR"
}
}
},
"description": "Internal Server Error"
},
"503": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/503_SERVICE_UNAVAILABLE"
}
}
},
"description": "Service Unavailable"
}
},
"servers": [
{
"description": "Sandbox server (uses test data)",
"url": "https://api.sandbox.viator.com/partner"
}
],
"summary": "/bookings/{booking-reference}/cancel",
"tags": [
"Booking services"
]
}
},
"/bookings/{booking-reference}/cancel-quote": {
"get": {
"description": "Retrieves a quote for the cancellation of a booking\n\nFor information on how to use this service, see: [Cancellation API workflow](#section/Common-workflows-and-data-validation/Cancellation-API-workflow)\n\n**Note**: \n\n * This service <u>requires</u> [exp-api-key](#section/Authentication/exp-api-key) to be included as a header parameter. Please speak to your account manager if you have not yet been issued an exp-api-key.\n * The base URL for the server for this endpoint is different from the older endpoints described in this document. Use `https://api.sandbox.viator.com/partner/bookings/{booking-reference}/cancel-quote`\n",
"operationId": "cancelBookingQuote",
"parameters": [
{
"description": "Unique numeric identifier of the booking for which to retrieve a cancellation quote",
"in": "path",
"name": "booking-reference",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"1": {
"$ref": "#/components/examples/bookings-id-cancel-quote-example"
}
},
"schema": {
"$ref": "#/components/schemas/CancelBookingQuoteResponse"
}
}
},
"description": "Success"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401_UNAUTHORIZED"
}
}
},
"description": "Unauthorized"
},
"406": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/406_NOT_ACCEPTABLE"
}
}
},
"description": "Not Acceptable"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500_INTERNAL_SERVER_ERROR"
}
}
},
"description": "Internal Server Error"
},
"503": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/503_SERVICE_UNAVAILABLE"
}
}
},
"description": "Service Unavailable"
}
},
"servers": [
{
"description": "Sandbox server (uses test data)",
"url": "https://api.sandbox.viator.com/partner"
}
],
"summary": "/bookings/{booking-reference}/cancel-quote",
"tags": [
"Booking services"
]
}
},
"/health/check": {
"get": {
"description": "Health check\nUse this service to determine whether the Viator API is presently online and that your API key is valid. You should receive a response identical to the example shown. If you have not yet received an API key, please request one from your business development partner. If you have not yet signed up as a Viator merchant partner and would like to, please visit our [distribution partner website](https://www.viator.com/distribution-partners?mcid=58463#api-solutions).\"\n",
"operationId": "healthCheck",
"parameters": [
{
"$ref": "#/components/parameters/acceptLanguage"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"1": {
"$ref": "#/components/examples/health-check-example"
}
},
"schema": {
"properties": {
"allGood": {
"description": "**indicator**: `true` signifies health",
"nullable": true,
"type": "boolean"
},
"capiOk": {
"description": "**indicator**: `true` signifies health",
"nullable": true,
"type": "boolean"
},
"dbOk": {
"description": "**indicator**: `true` signifies health",
"nullable": true,
"type": "boolean"
},
"memcachedOk": {
"description": "**indicator**: `true` signifies health",
"nullable": true,
"type": "boolean"
},
"message": {
"description": "**natural-language description** of any issues regarding the health of the API",
"nullable": true,
"type": "string"
}
},
"type": "object"
}
}
},
"description": "Success"
}
},
"summary": "/health/check",
"tags": [
"General services"
]
}
},
"/merchant/cancellation": {
"post": {
"deprecated": true,
"description": "Cancel a booking\n**Note**: This service has been replaced by the [cancellationReasons](#operation/cancellationReasons), [bookingQuote](#operation/bookingQuote) and [cancelBooking](#operation/cancelBooking) endpoints\n",
"operationId": "merchantCancellation",
"parameters": [
{
"$ref": "#/components/parameters/acceptLanguage"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"cancelItems": {
"description": "**array** of objects detailing itinerary items to cancel",
"items": {
"properties": {
"cancelCode": {
"description": "**cancellation code** that describes the reason for the cancellation\n- see: [Suggested cancellation codes](#suggested-cancellation-codes)\n",
"example": "82",
"type": "string"
},
"cancelDescription": {
"description": "**natural-language description** of the reason for cancellation (a reason must be provided if `cancelCode` is `62` or `66`)",
"example": "",
"type": "string"
},
"distributorItemRef": {
"description": "**alphanumeric reference code** of the distributor item",
"example": "JdpItin001",
"type": "string"
},
"itemId": {
"description": "**numeric identifier** of item to cancel in itinerary",
"example": 330056,
"type": "integer"
}
},
"type": "object"
},
"type": "array"
},
"distributorRef": {
"description": "**itinerary reference identifier** (partner defined) for the booking to cancel",
"example": "Jdp122",
"type": "string"
},
"itineraryId": {
"description": "**numeric identifier** for the itinerary",
"example": 1234655,
"type": "integer"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/basicErrorModel"
},
{
"properties": {
"data": {
"properties": {
"cancelItems": {
"description": "**array** of items to be cancelled",
"items": {
"properties": {
"cancellationResponseDescription": {
"description": "See Response codes table",
"example": "No further action required",
"type": "string"
},
"cancellationResponseStatusCode": {
"description": "See [cancellation response codes table](#cancellation-response-status-codes-and-their-meanings)",
"example": "Confirmed",
"type": "string"
},
"distributorItemRef": {
"description": "**alphanumeric reference code** of the distributor item",
"example": "ItinItemRef012",
"type": "string"
},
"itemId": {
"description": "**numeric identifier** of the item to cancel",
"example": "600088255",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"distributorRef": {
"description": "**reference code** for the distributor",
"example": "ItinRef012",
"type": "string"
},
"itineraryId": {
"description": "**numeric** identifier for the itinerary",
"example": 3331605,
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
}
]
}
}
},
"description": "Success"
},
"400": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/basicErrorModel"
},
{
"properties": {
"data": {
"properties": {
"cancellationResponseDescription": {
"description": "**natural-language description** for this response (see response codes table)",
"example": "Please double check the details or contact Viator Customer Service",
"type": "string"
},
"cancellationResponseStatusCode": {
"description": "**status code** for this response (see response codes table)",
"example": "Error.ItineraryUnknown",
"type": "string"
},
"distributorItemRef": {
"description": "**alphanumeric reference code** of the distributor item",
"example": "ItinItemRef012",
"type": "string"
},
"itemId": {
"description": "**identifier** for the item to cancel",
"example": "600088255",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
]
}
}
},
"description": "Error"
}
},
"summary": "/merchant/cancellation",
"tags": [
"Deprecated services"
]
}
},
"/product": {
"get": {
"description": "Get product information\nThis service provides all product details required for a product display page, as well as information required for price checks and booking, such as: \n- age bands\n- tour grades\n- language options \n- booking questions\n- hotel pickup flags\n\n**currencyCode (in query):** \n- use this parameter to specify the currency in which product pricing should be displayed\n- the default currency is the currency of your account; or, if you have multi-currency enabled, US dollars\n- \"multi-currency\" allows pricing and booking in various currencies - please speak to the business development team if you'd like this enabled\n- **Note**: you will be billed in the currency in which the booking was made\n\n**Product photos**\n\n<mark>**<u>Update 13 Feb 2020</u>**: All supplier-provided photos for the selected product are now available in the `productPhotos` array in this endpoint's response. Previously, only two supplier-provided photos were available – one in the `productPhotos` array and one in `thumbnailHiResURL`. </mark>\n\n**Videos**\n\n- Videos are no longer provided via this API\n",
"operationId": "product",
"parameters": [
{
"$ref": "#/components/parameters/acceptLanguage"
},
{
"$ref": "#/components/parameters/currencyCode"
},
{
"$ref": "#/components/parameters/sortOrder_REVIEW"
},
{
"description": "- `\"VOUCHER_PAPER_ONLY\"`: Paper Vouchers only accepted\n- `\"VOUCHER_E\"`: EVouchers + Paper Vouchers accepted\n",
"in": "query",
"name": "voucherOption",
"schema": {
"enum": [
"VOUCHER_PAPER_ONLY",
"VOUCHER_E"
],
"type": "string"
}
},
{
"$ref": "#/components/parameters/code"
},
{
"$ref": "#/components/parameters/showUnavailable"
},
{
"description": "**specifier:** \n- `true`: return **all** tour grades, including those that are not available\n- `false`: only display tour grades that *are* available\n",
"in": "query",
"name": "excludeTourGradeAvailability",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"1": {
"$ref": "#/components/examples/product-example-1"
},
"2": {
"$ref": "#/components/examples/product-example-2"
}
},
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/basicErrorModel"
},
{
"properties": {
"data": {
"description": "**object** containing product details",
"properties": {
"additionalInfo": {
"description": "**array** of HTML-formatted clauses providing additional information about *this* product, such as:\n- when the confirmation will be received (i.e. at time of booking, or within 48 hours of booking etc)\n- accessibility options; such as whether wheelchair access is available\n- particulars about the pick-up location and process\n- **Note**: may contain basic HTML mark-up tags – e.g., br, li, b, u, p, i, ul and ol\n",
"items": {
"type": "string"
},
"type": "array"
},
"admission": {
"description": "ignore (Viator only)",
"nullable": true,
"type": "string"
},
"ageBands": {
"description": "**array** of age band objects detailing the age bands available for *this* product\n \n- **note**: only the age bands listed here can book this product using the [/booking/book](#operation/bookingBook) service\n",
"items": {
"properties": {
"adult": {
"description": "**indicator**: `true` if *this* age band describes adults (not children)",
"type": "boolean"
},
"ageFrom": {
"description": "**numeric lower age limit** of the age range defined by *this* age band",
"type": "integer"
},
"ageTo": {
"description": "**numeric upper age limit** of the age range included in *this* age band",
"type": "integer"
},
"bandId": {
"$ref": "#/components/schemas/bandId"
},
"count": {
"description": "**number** of participants in *this* age band required to book the product",
"type": "integer"
},
"description": {
"description": "**natural-language description** (singular) of *this* age band",
"type": "string"
},
"pluralDescription": {
"description": "**natural-language description** (plural) of *this* age band",
"type": "string"
},
"sortOrder": {
"description": "**sort order** for *this* age band object",
"type": "integer"
},
"treatAsAdult": {
"description": "**indicator**: `true` if members of this age band are considered to be adults",
"type": "boolean"
}
},
"type": "object"
},
"type": "array"
},
"allTravellerNamesRequired": {
"description": "**indicator**: `true` if all traveler names are required.<br />**Note**: if set to `true`, then all passenger names must be included in the booking request, and all must be unique. Placeholder names cannot be used.",
"type": "boolean"
},
"applePassSupported": {
"description": "**indicator**: `true` if Apple Wallet is supported",
"type": "boolean"
},
"available": {
"description": "ignore (Viator only)",
"type": "boolean"
},
"bookingEngineId": {
"$ref": "#/components/schemas/bookingEngineId"
},
"bookingQuestions": {
"items": {
"properties": {
"message": {
"description": "**natural-language instructions** for *this* booking question\n- **note**: see [Booking questions](#section/Appendices/Booking-questions) for more information\n",
"type": "string"
},
"questionId": {
"description": "**unique numeric identifier** for *this* booking question\n- **note**: see [Booking questions](#section/Appendices/Booking-questions) for more information\n",
"type": "integer"
},
"required": {
"description": "**boolean indicator**:\n- `true` if the answer to *this* booking question <u>must</u> be included in the request object to the b service when booking *this* product\n- **note**: see [Booking questions](#section/Appendices/Booking-questions) for more information\n",
"type": "boolean"
},
"sortOrder": {
"description": "**sort order** for *this* booking question",
"type": "integer"
},
"stringQuestionId": {
"description": "**unique alphanumeric identifier** for the booking question\n- **note**: see [Booking questions](#section/Appendices/Booking-questions) for more information\n",
"type": "string"
},
"subTitle": {
"description": "**natural-language subtitle** for *this* booking question\n- **note**: see [Booking questions](#section/Appendices/Booking-questions) for more information\n",
"type": "string"
},
"title": {
"description": "**natural-language title** for *this* booking question\n- **note**: see [Booking questions](#section/Appendices/Booking-questions) for more information\n",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"catIds": {
"description": "**list** of unique numeric category identifiers that *this* product falls under\n- `categoryId` is available from the [/taxonomy/categories](#operation/taxonomyCategories) service\n",
"items": {
"type": "integer"
},
"type": "array"
},
"city": {
"description": "**name** of city or destination that *this* product operates in",
"type": "string"
},
"code": {
"description": "**unique alphanumeric identifier** of *this* product",
"type": "string"
},
"country": {
"description": "**natural-language name** of the country in which *this* product operates",
"type": "string"
},
"currencyCode": {
"description": "**currency** in which to display *this* product's pricing details",
"type": "string"
},
"departurePoint": {
"description": "**HTML-formatted natural-language description** of *this* product's departure location",
"type": "string"
},
"departureTime": {
"description": "**HTML-formatted natural-language description** of *this* product's departure times\n- may contain basic HTML mark-up tags; e.g., br, li, b, u, p, i, ul and ol\n",
"type": "string"
},
"departureTimeComments": {
"description": "**HTML-formatted natural-language description** of extra information pertaining to product departure times",
"type": "string"
},
"description": {
"description": "**HTML-formatted natural-language description** of *this* product (extended)",
"type": "string"
},
"destinationId": {
"description": "**unique numeric identifier** of the destination in which *this* product is located\n- `destinationId` is available from the [/taxonomy/destinations](#operation/taxonomyDestinations) service\n",
"type": "integer"
},
"duration": {
"description": "**natural-language description** of *this* product's duration",
"type": "string"
},
"essential": {
"description": "ignore (Viator only)",
"nullable": true,
"type": "string"
},
"exclusions": {
"description": "**array** of HTML-formatted natural-language exclusions for *this* product\n- may contain basic HTML mark-up - e.g., br, li, b, u, p, i, ul and ol\n",
"items": {
"type": "string"
},
"type": "array"
},
"highlights": {
"description": "ignore (Viator only)",
"nullable": true,
"type": "integer"
},
"hotelPickup": {
"description": "**indicator**: `true` if *this* product offers hotel pick-up; if so, you will need to collect the user's hotel details",
"type": "boolean"
},
"inclusions": {
"description": "**array** of HTML-formatted features included in *this* product\n- may contain basic HTML mark-up tags; e.g., br, li, b, u, p, i, ul and ol\n",
"items": {
"type": "string"
},
"type": "array"
},
"itinerary": {
"description": "**HTML-formatted description** of the itinerary of *this* tour if available\n- may contain basic HTML tags; e.g., br, li, b, u, p, i, ul and ol\n",
"type": "string"
},
"location": {
"description": "**natural-language description** of *this* product's location\n- can be a combination of the country and city, or a custom location\n",
"type": "string"
},
"mapURL": {
"description": "**URL** of this product's map (usually an image)",
"nullable": true,
"type": "string"
},
"maxTravellerCount": {
"description": "**maximum number of travelers** allowed per-booking for *this* product",
"type": "integer"
},
"merchantCancellable": {
"description": "ignore (Viator only)\n\n \nFor cancellation information regarding the booking, please refer to the `merchantTermsAndConditions` object\n",
"type": "boolean"
},
"merchantNetPriceFrom": {
"$ref": "#/components/schemas/merchantNetPriceFrom"
},
"merchantNetPriceFromFormatted": {
"$ref": "#/components/schemas/merchantNetPriceFromFormatted"
},
"merchantTermsAndConditions": {
"nullable": true,
"properties": {
"amountRefundable": {
"description": "Usually shows the total amount refundable if the cancellation is processed now. `null` in /product as no booking has been made.",
"nullable": true,
"type": "integer"
},
"cancellationFromTourDate": {
"items": {
"properties": {
"dayRangeMax": {
"description": "**number** of days prior to the tour start date that *this* policy window begins",
"nullable": true,
"type": "integer"
},
"dayRangeMin": {
"description": "**number** of days prior to the tour start date that *this* policy window ends",
"type": "integer"
},
"percentageRefundable": {
"description": "**percentage** of total price refundable if cancelled within *this* time window",
"type": "integer"
},
"policyEndTimestamp": {
"description": "Usually shows the Unix timestamp giving the exact time the policy ends. `null` in /product as no booking has yet been made.",
"nullable": true,
"type": "integer"
},
"policyStartTimestamp": {
"description": "Usually shows the Unix timestamp giving the exact time the policy commences. `null` in /product as no booking has yet been made.",
"nullable": true,
"type": "integer"
}
},
"type": "object"
},
"type": "array"
},
"merchantTermsAndConditionsType": {
"description": "**numeric identifier** for the merchant terms and conditions type for *this* product",
"type": "integer"
},
"termsAndConditions": {
"description": "**natural-language description** of the terms and conditions for *this* product",
"type": "string"
}
},
"type": "object"
},
"onRequestPeriod": {
"$ref": "#/components/schemas/onRequestPeriod"
},
"onSale": {
"$ref": "#/components/schemas/onSale"
},
"operates": {
"description": "**HTML-formatted natural-language description** of *this* product's operation frequency",
"type": "string"
},
"panoramaCount": {
"description": "**number** of panoramic images available for *this* product",
"type": "integer"
},
"pas": {
"description": "ignore (Viator only)",
"type": "object"
},
"passengerAttributes": {
"description": "ignore (Viator only)",
"items": {
"properties": {
"customAttribute_kgs": {
"description": "ignore (Viator only)",
"type": "string"
},
"customAttribute_lbs": {
"description": "ignore (Viator only)",
"type": "string"
},
"errorMissingMessage": {
"description": "ignore (Viator only)",
"type": "string"
},
"errorValidationMessage": {
"description": "ignore (Viator only)",
"type": "string"
},
"questionId": {
"description": "ignore (Viator only)",
"type": "string"
},
"required": {
"description": "ignore (Viator only)",
"type": "boolean"
},
"title": {
"description": "ignore (Viator only)",
"type": "string"
},
"validateType": {
"description": "ignore (Viator only)",
"type": "string"
}
},
"type": "object"
},
"nullable": true,
"type": "array"
},
"photoCount": {
"description": "**number** of user photos available for *this* product",
"type": "integer"
},
"price": {
"$ref": "#/components/schemas/price"
},
"priceFormatted": {
"$ref": "#/components/schemas/priceFormatted"
},
"primaryDestinationId": {
"description": "**unique numeric identifier** of *this* product's primary destination",
"type": "integer"
},
"primaryDestinationName": {
"description": "**natural-language name** of *this* product's primary destination",
"type": "string"
},
"primaryDestinationUrlName": {
"description": "**URL-formatted name** of the destination in which *this* product is located",
"type": "string"
},
"primaryGroupId": {
"description": "ignore (Viator only)",
"nullable": true,
"type": "string"
},
"productPhotos": {
"description": "**array** of image objects detailing images available for *this* product",
"items": {
"properties": {
"caption": {
"description": "**natural-language caption** for *this* photo",
"type": "string"
},
"photoURL": {
"description": "**URL** of *this* photo",
"type": "string"
},
"supplier": {
"description": "**natural-language name** of the supplier of *this* photo",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"productUrlName": {
"description": "**URL-formatted name** of *this* product",
"type": "string"
},
"rating": {
"$ref": "#/components/schemas/rating"
},
"ratingCounts": {
"$ref": "#/components/schemas/ratingCounts"
},
"region": {
"description": "**natural-language name** of the region in which *this* product operates",
"type": "string"
},
"returnDetails": {
"description": "**HTML-formatted natural-language description** of *this* product's drop-off details (if available)",
"type": "string"
},
"reviewCount": {
"$ref": "#/components/schemas/reviewCount"
},
"reviews": {
"$ref": "#/components/schemas/reviews"
},
"rrp": {
"$ref": "#/components/schemas/rrp"
},
"rrpFormatted": {
"$ref": "#/components/schemas/rrpFormatted"
},
"salesPoints": {
"description": "ignore (Viator only)\n\n**Note**: The information that was previously returned in this field is available in the `additionalInfo`, `inclusions` and `description` fields\n",
"items": {
"type": "string"
},
"type": "array"
},
"savingAmount": {
"$ref": "#/components/schemas/savingAmount"
},
"savingAmountFormated": {
"$ref": "#/components/schemas/savingAmountFormated"
},
"shortDescription": {
"description": "**natural-language description** (shortened) of *this* product",
"type": "string"
},
"shortTitle": {
"description": "**natural-language title** (shortened) of *this* product",
"type": "string"
},
"specialOffer": {
"$ref": "#/components/schemas/specialOffer"
},
"specialOfferAvailable": {
"$ref": "#/components/schemas/specialOfferAvailable"
},
"specialReservation": {
"description": "ignore (Viator only)",
"type": "boolean"
},
"specialReservationDetails": {
"description": "ignore (Viator only)",
"nullable": true,
"type": "string"
},
"sslSupported": {
"description": "ignore (Viator only)",
"type": "boolean"
},
"subCatIds": {
"description": "**list** of unique numeric subcategory identifiers that *this* product falls under\n- `subcategoryId` is available from the [/taxonomy/categories](#operation/taxonomyCategories) service\n",
"items": {
"type": "integer"
},
"type": "array"
},
"supplierCode": {
"description": "**unique identification code** of *this* product's supplier",
"type": "string"
},
"supplierName": {
"description": "**name** of *this* product's supplier",
"type": "string"
},
"thumbnailHiResURL": {
"description": "**URL** of *this* product's high-resolution thumbnail image",
"type": "string"
},
"thumbnailURL": {
"description": "**URL** for *this* product's thumbnail image",
"type": "string"
},
"title": {
"description": "**natural-language title** of *this* product",
"type": "string"
},
"tourGrades": {
"description": "**array** of tour grade objects available for *this* product",
"items": {
"properties": {
"currencyCode": {
"description": "**currency code** of the currency *this* product's tour grades prices are shown in",
"type": "string"
},
"defaultLanguageCode": {
"description": "**language code** of the standard language for *this* tour grade",
"type": "string"
},
"gradeCode": {
"description": "**unique alphanumeric identifier** of *this* tour grade",
"type": "string"
},
"gradeDepartureTime": {
"description": "**departure time** for *this* tour grade if available",
"type": "string"
},
"gradeDescription": {
"description": "**natural-language description** of *this* tour grade",
"type": "string"
},
"gradeTitle": {
"description": "**natural-language description** of *this* tour grade",
"type": "string"
},
"langServices": {
"additionalProperties": {
"type": "string"
},
"description": "**dictionary** of language service codes and their natural-language descriptors",
"type": "object"
},
"merchantNetPriceFrom": {
"$ref": "#/components/schemas/merchantNetPriceFrom"
},
"merchantNetPriceFromFormatted": {
"$ref": "#/components/schemas/merchantNetPriceFromFormatted"
},
"priceFrom": {
"description": "**numeric suggested retail price** for *this* tour grade\n- For more information, see: [Merchant pricing](#section/Merchant-APIs/Merchant-pricing)\n",
"type": "number"
},
"priceFromFormatted": {
"description": "**currency-formatted suggested retail price** for *this* tour grade\n- For more information, see: [Merchant pricing](#section/Merchant-APIs/Merchant-pricing)\n",
"type": "string"
},
"sortOrder": {
"description": "**sort order** of *this* tour grade",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
},
"tourGradesAvailable": {
"description": "**indicator**: \n- `true`: tour grades are available for this product, meaning you will need to display these tour grades to the user and include a tour grade when booking *this* product\n- `false`: only a default tour grade is available for *this* product\n",
"type": "boolean"
},
"translationLevel": {
"$ref": "#/components/schemas/translationLevel"
},
"userPhotos": {
"description": "**array** of user photo objects",
"items": {
"$ref": "#/components/schemas/photoObject"
},
"type": "array"
},
"videoCount": {
"description": "ignore (Viator only) – videos are not available to partners",
"type": "integer"
},
"videos": {
"description": "ignore (Viator only) – videos are not available to partners",
"nullable": true,
"type": "string"
},
"voucherOption": {
"description": "**specifier** of the type(s) of vouchers that can be used:\n\n - `VOUCHER_PAPER_ONLY` - *only* printed paper vouchers accepted\n - `VOUCHER_E` - e-vouchers + printed paper vouchers accepted\n",
"type": "string"
},
"voucherRequirements": {
"description": "**natural-language description** of any requirements pertaining to the use of the voucher"
},
"webURL": {
"$ref": "#/components/schemas/webURL"
}
},
"type": "object"
}
},
"type": "object"
}
]
}
}
},
"description": "Success"
}
},
"summary": "/product",
"tags": [
"Product services"
]
}
},
"/product/photos": {
"get": {
"description": "Get photos of a product submitted by users",
"operationId": "productPhotos",
"parameters": [
{
"$ref": "#/components/parameters/acceptLanguage"
},
{
"$ref": "#/components/parameters/topX"
},
{
"$ref": "#/components/parameters/code"
},
{
"$ref": "#/components/parameters/showUnavailable"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"1": {
"$ref": "#/components/examples/product-photos-example"
}
},
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/basicErrorModel"
},
{
"properties": {
"data": {
"description": "**array** of photo objects",
"items": {
"$ref": "#/components/schemas/photoObject"
},
"type": "array"
}
},
"type": "object"
}
]
}
}
},
"description": "Success"
}
},
"summary": "/product/photos",
"tags": [
"Product services"
]
}
},
"/product/reviews": {
"get": {
"description": "Get user-submitted reviews of a product\n\n**Note**: \n- The number of reviews that you can obtain via this service will depend on whether your account is limited in terms of the number of reviews you are entitled to receive. \n- The number of reviews available through this service is given in the `reviewCount` element in the response from [/product](#operation/product)\n- Please speak to your account manager if you wish to receive more reviews. If your account is not limited, you will be able to receive all available reviews for this product.\n- Only reviews in the language specified in the Accept-Language request header will be returned\n\n**Example:** \"Get the first three reviews for product `5010SYDNEY` sorted by rating in ascending order\":\n\n```javascript\nhttps://viatorapi.sandbox.viator.com/service/product/reviews?sortOrder=REVIEW_RATING_A&topX=1-3&code=5010SYDNEY&showUnavailable=false\n```\n",
"operationId": "productReviews",
"parameters": [
{
"$ref": "#/components/parameters/acceptLanguage"
},
{
"$ref": "#/components/parameters/sortOrder_REVIEW"
},
{
"$ref": "#/components/parameters/topX"
},
{
"$ref": "#/components/parameters/code"
},
{
"$ref": "#/components/parameters/showUnavailable"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"1": {
"$ref": "#/components/examples/product-reviews-example"
}
},
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/basicErrorModel"
},
{
"properties": {
"data": {
"description": "**array** of review objects",
"items": {
"$ref": "#/components/schemas/reviewObject"
},
"type": "array"
}
},
"type": "object"
}
]
}
}
},
"description": "Success"
}
},
"summary": "/product/reviews",
"tags": [
"Product services"
]
}
},
"/search/freetext": {
"post": {
"description": "Free text search\n- This service provides a **free text search across all products and destinations**\n- The `text` parameter is required\n- **Note:** results include a type indicator (`type`) that you can use to display each result appropriately based on its content\n",
"operationId": "searchFreetext",
"parameters": [
{
"$ref": "#/components/parameters/acceptLanguage"
}
],
"requestBody": {
"content": {
"application/json": {
"examples": {
"1": {
"summary": "by product or destination",
"value": {
"currencyCode": "EUR",
"destId": 684,
"searchTypes": [
"ATTRACTION",
"RECOMMENDATION"
],
"text": "grand",
"topX": "1-3"
}
},
"2": {
"summary": "by attraction or recommendation",
"value": {
"currencyCode": "USD",
"destId": 684,
"searchTypes": [
"PRODUCT",
"DESTINATION"
],
"text": "grand",
"topX": "1-3"
}
}
},
"schema": {
"properties": {
"currencyCode": {
"description": "**currency code** for the currency in which to display product pricing information",
"type": "string"
},
"destId": {
"description": "**unique numeric identifier** of the destination to search within \n- `destinationId` can be retrieved from the [/taxonomy/destinations](#operation/taxonomyDestinations) service\n",
"type": "integer"
},
"searchTypes": {
"description": "**array** of search domain specifiers where each item is *one of*:\n - `\"PRODUCT\"`: a tour / activity\n - `\"DESTINATION\"`: continent, country, city, region\n - `\"ATTRACTION\"`: an attraction within a destination (only available to partners with SEO access)\n - `\"RECOMMENDATION\"`: an attraction within a destination (only available to partners with SEO access)\n",
"items": {
"enum": [
"PRODUCT",
"DESTINATION",
"ATTRACTION",
"RECOMMENDATION"
],
"type": "string"
},
"type": "array"
},
"sortOrder": {
"$ref": "#/components/schemas/sortOrder"
},
"text": {
"description": "**text** to search for",
"type": "string"
},
"topX": {
"$ref": "#/components/schemas/topX"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"1": {
"$ref": "#/components/examples/search-freetext-example-1"
},
"2": {
"$ref": "#/components/examples/search-freetext-example-2"
}
},
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/basicErrorModel"
},
{
"properties": {
"data": {
"description": "**array** of search results",
"items": {
"$ref": "#/components/schemas/SearchFreetextResponse"
},
"type": "array"
}
},
"type": "object"
}
]
}
}
},
"description": "Success"
}
},
"summary": "/search/freetext",
"tags": [
"Product services"
]
}
},
"/search/products": {
"post": {
"description": "Search for products\nThis service is used to search for products based on various criteria; such as:\n* the destination (locale) in which it operates\n* its association with a tourist attraction\n* its category and/or subcategory\n* the time period during which it operates\nThe fields you include in the request body for this service determine the kind of search that will be performed.\n\n**<u>Note</u>**: \n\n* You can search **EITHER** by destination (`destId`) **OR** by attraction-link (`seoId`), but not both.\n* The destination identifier (`destId`) can be retrieved from the [/taxonomy/destinations](#operation/taxonomyDestinations) service.\n* The category (`catId`) and subcategory (`subCatId`) identifiers can be retrieved from the [/taxonomy/categories](#operation/taxonomyCategories) service.\n* The attraction identifier (`seoId`) can be retrieved from the [/taxonomy/attractions](#operation/taxonomyAttractions) service.\n\n**<u>Examples</u>**:\n\n**Search by destination**:\n\n* E.g., \"Top ten highest-rated yoga classes operating in Las Vegas:\n```javascript\n{\n \"destId\": 684,\n \"subCatId\": 26052,\n \"sortOrder\": \"REVIEW_AVG_RATING_D\",\n \"topX\": \"1-3\"\n}\n```\n\n**Search by attraction-link**:\n\n* E.g., \"Products related to Everglades National Park operating 21-26 May 2019 in order of descending price\":\n```javascript\n{\n \"seoId\": 1115,\n \"sortOrder\": \"PRICE_FROM_D\",\n \"topX\": \"1-3\"\n}\n```\n\n**<u>'Freesale-only' merchants</u>**:\n- Merchants with a \"freesale only\" key *must* pass `startDate` and `endDate` to this service to retrieve a list of all available 'freesale' products (and 'freesale/on-request' products that are currently 'freesale') in the destination. \n- E.g., the following request body will result in 'freesale/on-request' products within their on-request period not appearing in the results from this service. \n```javascript\n{\n \"destId\": 684,\n \"startDate\": \"2020-02-21\",\n \"endDate\": \"2020-03-21\",\n \"sortOrder\": \"PRICE_FROM_D\",\n \"topX\": \"1-3\"\n}\n```\n\n- If `startDate` and `endDate` are omitted, 'freesale/on-request' products that are presently within their on-request period may appear to be available to customers, but won't be available at the time of booking.\n",
"operationId": "searchProducts",
"parameters": [
{
"$ref": "#/components/parameters/acceptLanguage"
}
],
"requestBody": {
"content": {
"application/json": {
"examples": {
"1": {
"summary": "by destination",
"value": {
"destId": 684,
"sortOrder": "REVIEW_AVG_RATING_D",
"subCatId": 26052,
"topX": "1-3"
}
},
"2": {
"summary": "by attraction link",
"value": {
"seoId": 1115,
"sortOrder": "PRICE_FROM_D",
"topX": "1-3"
}
},
"3": {
"summary": "freesale only",
"value": {
"destId": 684,
"endDate": "2020-12-31",
"sortOrder": "PRICE_FROM_D",
"startDate": "2020-12-21",
"topX": "1-3"
}
}
},
"schema": {
"properties": {
"catId": {
"description": "**unique numeric identifier** of *this* product category to search within\n- `categoryId` can be retrieved from the [/taxonomy/categories](#operation/taxonomyCategories) service\n- at present, it is not possible to use `catId` in conjunction with `seoId`\n",
"type": "integer"
},
"currencyCode": {
"description": "**currency** in which to display product prices",
"type": "string"
},
"destId": {
"description": "**unique numeric identifier** of the destination in which to search for products\n- `destinationId` is available from the [/taxonomy/destinations](#operation/taxonomyDestinations) service\n- use **EITHER** `destId` **OR** `seoId`, but not both\n",
"type": "integer"
},
"endDate": {
"description": "**end date delimiter** for the search (must be in the future)\n- e.g., `'2019-10-21'`\n",
"type": "string"
},
"seoId": {
"description": "**search restriction specifier** for products associated with an attraction uniquely identified by `seoId`\n- use **EITHER** `destId` **OR** `seoId`, but not both\n",
"type": "string"
},
"sortOrder": {
"description": "**sort order** in which to return the results that is *one of*:\n\n - `\"TOP_SELLERS\"`: the top sellers\n - `\"REVIEW_AVG_RATING_A\"`: ascending by average traveler rating (low -> high)\n - `\"REVIEW_AVG_RATING_D\"`: descending by average traveler rating (high -> low)\n - `\"PRICE_FROM_A\"`: ascending by price (low -> high)\n - `\"PRICE_FROM_D\"`: descending by price (high -> low) \n",
"enum": [
"TOP_SELLERS",
"REVIEW_AVG_RATING_A",
"REVIEW_AVG_RATING_D",
"PRICE_FROM_A",
"PRICE_FROM_D"
],
"type": "string"
},
"startDate": {
"description": "**start date delimiter** for the search (must be in the future)\n- e.g., `'2018-10-21'`\n",
"type": "string"
},
"subCatId": {
"description": "**unique numeric identifier** of *this* product subcategory to search within\n- `subcategoryId` can be retrieved from the [/taxonomy/categories](#operation/taxonomyCategories) service\n- at present, it is not possible to use `subCatId` in conjunction with `seoId`\n",
"type": "integer"
},
"topX": {
"$ref": "#/components/schemas/topX"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"1": {
"$ref": "#/components/examples/search-products-example-1"
},
"2": {
"$ref": "#/components/examples/search-products-example-2"
},
"3": {
"$ref": "#/components/examples/search-products-example-3"
}
},
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/basicErrorModel"
},
{
"properties": {
"data": {
"description": "**array** of product objects",
"items": {
"properties": {
"admission": {
"description": "ignore (Viator only)",
"nullable": true,
"type": "string"
},
"available": {
"description": "ignore (Viator only)",
"type": "boolean"
},
"bookingEngineId": {
"$ref": "#/components/schemas/bookingEngineId"
},
"catIds": {
"description": "**list** of unique numeric category identifiers for *this* product\n- the `categoryId` for the destination is available from the [/taxonomy/categories](#operation/taxonomyCategories) service\n",
"items": {
"type": "integer"
},
"type": "array"
},
"code": {
"description": "**unique alphanumeric identifier** of *this* product",
"type": "string"
},
"currencyCode": {
"description": "**indicator** of the currency in which *this* product's prices are displayed",
"example": "EUR",
"type": "string"
},
"duration": {
"description": "**natural-language description** of the duration of *this* product",
"type": "string"
},
"essential": {
"description": "ignore (Viator only)",
"nullable": true,
"type": "string"
},
"merchantCancellable": {
"description": "ignore (Viator only)\n\n \nFor cancellation information regarding the booking, please refer to the `merchantTermsAndConditions` object\n",
"type": "boolean"
},
"merchantNetPriceFrom": {
"$ref": "#/components/schemas/merchantNetPriceFrom"
},
"merchantNetPriceFromFormatted": {
"$ref": "#/components/schemas/merchantNetPriceFromFormatted"
},
"onRequestPeriod": {
"$ref": "#/components/schemas/onRequestPeriod"
},
"onSale": {
"$ref": "#/components/schemas/onSale"
},
"panoramaCount": {
"description": "**number** of panoramic images available for *this* product",
"type": "integer"
},
"pas": {
"description": "**object** detailing product availability\n- `pas` stands for Product Availability Schema\n",
"nullable": true,
"type": "object"
},
"photoCount": {
"description": "**number** of user photos published for *this* product",
"type": "integer"
},
"price": {
"$ref": "#/components/schemas/price"
},
"priceFormatted": {
"$ref": "#/components/schemas/priceFormatted"
},
"primaryDestinationId": {
"description": "**unique numeric identifier** of *this* product's primary destination",
"type": "integer"
},
"primaryDestinationName": {
"description": "**natural-language name** of *this* product's primary destination",
"type": "string"
},
"primaryDestinationUrlName": {
"description": "**URL-formatted name** of *this* product's primary destination",
"type": "string"
},
"primaryGroupId": {
"description": "ignore (Viator only)",
"type": "integer"
},
"productUrlName": {
"description": "**URL-formatted name** of *this* product",
"type": "string"
},
"rating": {
"$ref": "#/components/schemas/rating"
},
"reviewCount": {
"$ref": "#/components/schemas/reviewCount"
},
"rrp": {
"$ref": "#/components/schemas/rrp"
},
"rrpformatted": {
"$ref": "#/components/schemas/rrpFormatted"
},
"savingAmount": {
"$ref": "#/components/schemas/savingAmount"
},
"savingAmountFormated": {
"$ref": "#/components/schemas/savingAmountFormated"
},
"shortDescription": {
"description": "**HTML-formatted natural-language description** of *this* product",
"type": "string"
},
"shortTitle": {
"description": "**short natural-language title** of *this* product (for use when there is a need to conserve space)",
"type": "string"
},
"sortOrder": {
"description": "**sort order** for *this* product",
"type": "integer"
},
"specialOfferAvailable": {
"description": "ignore (Viator only)",
"type": "boolean"
},
"specialReservation": {
"description": "ignore (Viator only)",
"type": "boolean"
},
"specialReservationDetails": {
"description": "ignore (Viator only)",
"nullable": true,
"type": "string"
},
"sslSupported": {
"description": "ignore (Viator only)"
},
"subCatIds": {
"description": "**list** of unique numeric subcategory identifiers for *this* product\n- the `subcategoryId` for the destination is available from the [/taxonomy/categories](#operation/taxonomyCategories) service\n",
"items": {
"type": "integer"
},
"type": "array"
},
"supplierCode": {
"description": "**unique identifier** of *this* product's supplier in text string format",
"type": "string"
},
"supplierName": {
"description": "**natural-language name** of *this* product's supplier",
"example": "V Theater Group, LLC",
"type": "string"
},
"thumbnailHiResURL": {
"description": "**URL** for the high resolution thumbnail for *this* product",
"type": "string"
},
"thumbnailURL": {
"description": "**URL** for *this* product's thumbnail image",
"type": "string"
},
"title": {
"description": "**natural-language title** of *this* product",
"type": "string"
},
"translationLevel": {
"$ref": "#/components/schemas/translationLevel"
},
"uniqueShortDescription": {
"description": "ignore (Viator only)",
"nullable": true,
"type": "string"
},
"videoCount": {
"description": "ignore (Viator only) – videos are not available to partners",
"type": "integer"
},
"webURL": {
"$ref": "#/components/schemas/webURL"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
]
}
}
},
"description": "Success"
}
},
"summary": "/search/products",
"tags": [
"Product services"
]
}
},
"/search/products/codes": {
"post": {
"description": "Search by product code\n- This service returns an array of products given an array of product identifiers that is useful for wishlist / shopping cart / user account display \n- **Note**: requesting an inactive or non-existent product code will return `0`, `null` and blank values (as per the 'invalid_product' example).\n",
"operationId": "searchProductsCodes",
"parameters": [
{
"$ref": "#/components/parameters/acceptLanguage"
}
],
"requestBody": {
"content": {
"application/json": {
"examples": {
"invalid_product": {
"value": {
"currencyCode": "USD",
"productCodes": [
"123457890"
]
}
},
"two_valid_products": {
"value": {
"currencyCode": "EUR",
"productCodes": [
"2280SUN",
"229016",
"5010SYDNEY"
]
}
}
},
"schema": {
"properties": {
"currencyCode": {
"description": "**currency code** for the currency in which to display product pricing",
"type": "string"
},
"productCodes": {
"description": "**array** of product codes to search for",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"1": {
"$ref": "#/components/examples/search-products-codes-example-1"
},
"2": {
"$ref": "#/components/examples/search-products-codes-example-2"
}
},
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/basicErrorModel"
},
{
"properties": {
"data": {
"description": "**array** of product objects",
"items": {
"properties": {
"admission": {
"description": "ignore (Viator only)",
"nullable": true,
"type": "string"
},
"bookingEngineId": {
"$ref": "#/components/schemas/bookingEngineId"
},
"catIds": {
"description": "**list** of category identifiers *this* product falls under\n- `categoryId` is available from the [/taxonomy/categories](#operation/taxonomyCategories) service\n",
"items": {
"type": "integer"
},
"type": "array"
},
"code": {
"description": "**unique alphanumeric identifier** of *this* product",
"type": "string"
},
"currencyCode": {
"description": "**currency** in which *this* product's pricing is displayed",
"type": "string"
},
"duration": {
"description": "**natural-language description** of *this* product's duration",
"type": "string"
},
"essential": {
"description": "ignore (Viator only)",
"nullable": true,
"type": "string"
},
"merchantCancellable": {
"description": "ignore (Viator only)\n\n \nFor cancellation information regarding the booking, please refer to the `merchantTermsAndConditions` object\n",
"type": "boolean"
},
"merchantNetPriceFrom": {
"$ref": "#/components/schemas/merchantNetPriceFrom"
},
"merchantNetPriceFromFormatted": {
"$ref": "#/components/schemas/merchantNetPriceFromFormatted"
},
"onRequestPeriod": {
"$ref": "#/components/schemas/onRequestPeriod"
},
"onSale": {
"$ref": "#/components/schemas/onSale"
},
"panoramaCount": {
"description": "**number** of panoramic images available for *this* product",
"type": "integer"
},
"pas": {
"description": "ignore (Viator only)",
"nullable": true,
"type": "object"
},
"photoCount": {
"description": "**number** of user photos published for *this* product",
"type": "integer"
},
"price": {
"$ref": "#/components/schemas/price"
},
"priceFormatted": {
"description": "**currency-formatted suggested sell 'from' price** of *this* product",
"type": "string"
},
"primaryDestinationId": {
"description": "**unique numeric identifier** of *this* product's primary destination",
"type": "integer"
},
"primaryDestinationName": {
"description": "**natural-language name** of *this* product's primary destination",
"type": "string"
},
"primaryGroupId": {
"description": "ignore (Viator only)",
"nullable": true,
"type": "string"
},
"rating": {
"$ref": "#/components/schemas/rating"
},
"reviewCount": {
"$ref": "#/components/schemas/reviewCount"
},
"rrp": {
"$ref": "#/components/schemas/rrp"
},
"rrpformatted": {
"$ref": "#/components/schemas/rrpFormatted"
},
"savingAmount": {
"$ref": "#/components/schemas/savingAmount"
},
"savingAmountFormated": {
"$ref": "#/components/schemas/savingAmountFormated"
},
"shortDescription": {
"description": "**natural-language description** of *this* product (short)",
"example": "Enjoy a fun filled day out, the whole family can enjoy Manly SEA LIFE Sanctuary! You'll see a vast array of marine life and meet some of Australia's most deadly animals. Learn all about these animals during the daily live shows and guided tours. The expert staff will share stories, interesting facts and answer all of your questions about these often misunderstood creatures.",
"type": "string"
},
"shortTitle": {
"description": "**natural-language title** (shortened) of *this* product",
"type": "string"
},
"sortOrder": {
"description": "**sort order** for *this* search result",
"type": "integer"
},
"specialOfferAvailable": {
"description": "**indicator**: `true` if a special offer is available for *this* product. If `true`, this means that the `specialOffer` field in the response from the [/product] service will contain a text string providing details of the special offer which you may wish to display in your product search results. E.g. 'Book by May 27 to save 34% off our previously offered price!'",
"type": "boolean"
},
"specialReservation": {
"description": "ignore (Viator only)",
"type": "boolean"
},
"specialReservationDetails": {
"description": "ignore (Viator only)",
"nullable": true,
"type": "string"
},
"subCatIds": {
"description": "**list** of subcategory identifiers that *this* product falls under \n- `subcategoryId` is available from the [/taxonomy/categories](#operation/taxonomyCategories) service\n",
"items": {
"type": "integer"
},
"type": "array"
},
"supplierCode": {
"description": "**unique identifier** of *this* product's supplier",
"type": "string"
},
"supplierName": {
"description": "**natural-language name** of *this* product's supplier",
"type": "string"
},
"thumbnailHiResURL": {
"description": "**URL** for *this* product's high-resolution thumbnail image",
"type": "string"
},
"thumbnailURL": {
"description": "**URL** for *this* product's thumbnail image",
"type": "string"
},
"title": {
"description": "**natural-language title** of *this* product",
"type": "string"
},
"translationLevel": {
"$ref": "#/components/schemas/translationLevel"
},
"uniqueShortDescription": {
"description": "ignore (Viator only)",
"nullable": true,
"type": "string"
},
"videoCount": {
"description": "ignore (Viator only) – videos are not available to partners",
"type": "integer"
},
"webURL": {
"$ref": "#/components/schemas/webURL"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
]
}
}
},
"description": "Success"
}
},
"summary": "/search/products/codes",
"tags": [
"Product services"
]
}
},
"/taxonomy/attractions": {
"post": {
"description": "Get attractions\n- Retrieves a list of attractions (things like the Eiffel Tower or Empire State Building) and their associated unique numeric identifiers\n- The attraction's identifier (`seoId`) can be used as a means of searching for available products; for example, in the [/search/products](#operation/searchProducts) service.\n",
"operationId": "taxonomyAttractions",
"parameters": [
{
"$ref": "#/components/parameters/acceptLanguage"
}
],
"requestBody": {
"content": {
"application/json": {
"example": {
"destId": 684,
"sortOrder": "SEO_PUBLISHED_DATE_D",
"topX": "1-3"
},
"schema": {
"properties": {
"destId": {
"description": "**unique numeric identifier** of the destination in which to search for attractions",
"type": "integer"
},
"sortOrder": {
"description": "**sort order** in which to return the results that is *one of*:\n * `\"SEO_PUBLISHED_DATE_D\"`: publish date (descending)\n * `\"SEO_PUBLISHED_DATE_A\"`: publish date (ascending)\n * `\"SEO_REVIEW_AVG_RATING_D\"`: traveler rating (high→low)\n * `\"SEO_REVIEW_AVG_RATING_A\"`: traveler rating (low→high)\n * `\"SEO_ALPHABETICAL\"`: alphabetical (A→Z)\n",
"enum": [
"SEO_PUBLISHED_DATE_D",
"SEO_PUBLISHED_DATE_A",
"SEO_REVIEW_AVG_RATING_D",
"SEO_REVIEW_AVG_RATING_A",
"SEO_ALPHABETICAL"
],
"type": "string"
},
"topX": {
"$ref": "#/components/schemas/topX"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"1": {
"$ref": "#/components/examples/taxonomy-attractions-example"
}
},
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/basicErrorModel"
},
{
"properties": {
"data": {
"description": "**array** of attraction objects",
"items": {
"properties": {
"attractionCity": {
"description": "**name** of the city in which the attraction is located",
"type": "string"
},
"attractionLatitude": {
"description": "**latitude component** of the attraction's location",
"type": "number"
},
"attractionLongitude": {
"description": "**longitude component** of the attraction's location",
"type": "number"
},
"attractionState": {
"description": "**name** of the state in which the attraction is located",
"type": "string"
},
"attractionStreetAddress": {
"description": "**street address** of the attraction",
"type": "string"
},
"destinationId": {
"description": "**unique numeric identifier** of the the destination associated with the attraction",
"type": "integer"
},
"pageUrlName": {
"description": "**URL-formatted title** of the attraction page",
"type": "string"
},
"photoCount": {
"description": "**number** of user photos published for the attraction",
"type": "integer"
},
"primaryDestinationId": {
"description": "**unique numeric identifier** of the attraction's primary destination",
"type": "integer"
},
"primaryDestinationName": {
"description": "**natural-language name** of the attraction's primary destination",
"type": "string"
},
"primaryDestinationUrlName": {
"description": "**URL-formatted name** of the destination associated with *this* attraction",
"type": "string"
},
"productCount": {
"description": "**number** of products associated with the attraction",
"type": "integer"
},
"publishedDate": {
"description": "**conventionally-formatted date** on which the attraction was listed",
"type": "string"
},
"rating": {
"description": "**average user rating** of the attraction",
"type": "number"
},
"seoId": {
"description": "**unique numeric identifier** of the attraction\n- use as an input for [/search/products](#operation/searchProducts)\n",
"type": "integer"
},
"sortOrder": {
"description": "**sort order** of *this* listing",
"type": "integer"
},
"thumbnailHiResURL": {
"description": "**URL** for the attraction's high-resolution thumbnail image",
"type": "string"
},
"thumbnailURL": {
"description": "**URL** the attraction's thumbnail image",
"type": "string"
},
"title": {
"description": "**natural-language title** of the attraction",
"type": "string"
},
"webURL": {
"$ref": "#/components/schemas/webURL"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
]
}
}
},
"description": "Success"
}
},
"summary": "/taxonomy/attractions",
"tags": [
"Taxonomy services"
]
}
},
"/taxonomy/categories": {
"get": {
"description": "Get all product categories\n- Retrieves a list of product categories for a destination that can be used as a means of filtering when searching for products using the [/search/products](/#operation/searchProducts) service\n- This service can be used to get a list of all categories and subcategories for a destination by including its `destId`, or you can omit the `destId` to get a list of all categories and subcategories\n- **Note:** If no `destId` is passed, `productCount` and `thumbnailURL` will be `null` as they are destination-specific fields\n",
"operationId": "taxonomyCategories",
"parameters": [
{
"$ref": "#/components/parameters/acceptLanguage"
},
{
"description": "**unique numeric identifier** of the destination to enquire about (optional)\n- `destinationId` is returned by [/taxonomy/destinations](#operation/taxonomyDestinations)\n",
"example": 684,
"in": "query",
"name": "destId",
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"1": {
"$ref": "#/components/examples/taxonomy-categories-example"
}
},
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/basicErrorModel"
},
{
"properties": {
"data": {
"description": "**array** of category data objects",
"items": {
"properties": {
"groupName": {
"description": "**natural-language name** of *this* product category",
"example": "Air, Helicopter and Balloon Tours",
"type": "string"
},
"groupUrlName": {
"description": "**URL-formatted name** of *this* product category",
"type": "string"
},
"id": {
"description": "**unique numeric identifier** for the category",
"example": 1,
"type": "integer"
},
"productCount": {
"description": "**number** of products in this category in the destination specified by `destId`\n- **note**: will be `null` if no `destId` is included in the query\n",
"example": 47,
"type": "integer"
},
"subcategories": {
"description": "**array** of subcategory objects",
"items": {
"properties": {
"categoryId": {
"description": "**unique numeric identifier** of *this* product category",
"example": 1,
"type": "integer"
},
"sortorder": {
"description": "**sort order** (suggested) of the subcategory within the category",
"example": 1,
"type": "integer"
},
"subCategoryUrlName": {
"description": "**URL-formatted name** of *this* product subcategory",
"type": "string"
},
"subcategoryId": {
"description": "**unique numeric identifier** of *this* product subcategory",
"example": 1,
"type": "integer"
},
"subcategoryName": {
"description": "**natural-language name** of *this* product subcategory",
"example": "Air Tours",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"thumbnailURL": {
"description": "**URL** for this category's thumbnail image, selected from the most popular product within the category\n- **note:** will be `null` if no `destId` is included in the query\n",
"example": "http://cache.graphicslib.viator.com/graphicslib-prelive/thumbs154x109/2280/SITours/grand-canyon-all-american-helicopter-tour-in-las-vegas-115053.jpg",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
]
}
}
},
"description": "Success"
}
},
"summary": "/taxonomy/categories",
"tags": [
"Taxonomy services"
]
}
},
"/taxonomy/destinations": {
"get": {
"description": "Get details of all destinations supported by this API\n- Retrieves all the country taxonomy/city nodes as a flat list\n- Returns a complete list of Viator destinations, including destination names and parent identifiers\n- Used to provide navigation through drill down lists or combo boxes\n",
"operationId": "taxonomyDestinations",
"parameters": [
{
"$ref": "#/components/parameters/acceptLanguage"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"1": {
"$ref": "#/components/examples/taxonomy-destinations-example"
}
},
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/basicErrorModel"
},
{
"properties": {
"data": {
"description": "**array** of destination objects",
"items": {
"properties": {
"defaultCurrencyCode": {
"description": "**currency code** for the currency in which pricing is displayed",
"type": "string"
},
"destinationId": {
"description": "**unique numeric identifier** of the destination\n- use this value as the `destId` input field for other Viator API services\n",
"type": "integer"
},
"destinationName": {
"description": "**natural-language name** of the destination",
"type": "string"
},
"destinationType": {
"$ref": "#/components/schemas/destinationType"
},
"destinationUrlName": {
"description": "ignore - (Viator only)",
"type": "string"
},
"iataCode": {
"$ref": "#/components/schemas/iataCode"
},
"latitude": {
"description": "**latitude component** of the destination's geolocation",
"type": "number"
},
"longitude": {
"description": "**longitude component** of the destination's geolocation",
"type": "number"
},
"lookupId": {
"description": "**hierarchy location specifier** for the destination that is a concatenation of all `parentId` and `destinationId` codes\n- e.g. `'8.77.673'` for Chicago\n- format: [top level `parentId`].[any additional `parentId`].[`destinationId`]\n",
"type": "string"
},
"parentId": {
"description": "**unique numeric identifier** of the destination's parent destination",
"type": "integer"
},
"selectable": {
"description": "ignore - (Viator only)",
"type": "boolean"
},
"sortOrder": {
"description": "**sort order** for this response",
"type": "integer"
},
"timeZone": {
"description": "**time zone** of the destination",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
]
}
}
},
"description": "Success"
}
},
"summary": "/taxonomy/destinations",
"tags": [
"Taxonomy services"
]
}
}
},
"components": {
"examples": {
"available-products-example": {
"summary": "available products example",
"value": {
"data": [
{
"admission": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"available": true,
"bookingEngineId": "UnconditionalBE",
"catIds": [
6,
12
],
"code": "5010SYDNEY",
"currencyCode": "USD",
"duration": "2 hours",
"essential": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"merchantCancellable": true,
"merchantNetPriceFrom": 29.52,
"merchantNetPriceFromFormatted": "$29.52",
"onRequestPeriod": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"onSale": false,
"panoramaCount": 0,
"pas": {
"incompleteQuote": false,
"productCode": "5010SYDNEY",
"removedChildAges": [],
"tourGrades": {
"24HOUR": {
"availDates": [
{
"dateList": "20200321 20200322 20200323 20200324 20200325 20200326 20200327 20200328 20200329 20200330 20200331 20200401 20200402 20200403 20200404 20200405 20200406 20200407 20200408 20200409 20200410 20200411 20200412 20200413 20200414 20200415 20200416 20200417 20200418 20200419 20200420 20200421 ",
"priceFrom": "USD 36.97",
"priceQuote": {
"generalRetailPrice": "USD 36.97",
"merchantNetPrice": "USD 29.52",
"priceSource": "MANUAL",
"retailPrice": "USD 36.97"
}
}
],
"bookingEngine": "UNCONDITIONAL_FREESALE",
"description": "Unlimited use on Big Bus Sydney & Bondi Hop-on Hop-off Tour for 24 hours from time of first use",
"languageServices": {
"de": [
"AUDIO"
],
"en": [
"AUDIO"
],
"es": [
"AUDIO"
],
"fr": [
"AUDIO"
],
"ja": [
"AUDIO"
],
"ko": [
"AUDIO"
],
"zh": [
"AUDIO"
]
},
"sapi": false,
"title": "24 Hour Classic Ticket ",
"tourGradeCode": "24HOUR"
},
"48HOUR": {
"availDates": [
{
"dateList": "20200321 20200322 20200323 20200324 20200325 20200326 20200327 20200328 20200329 20200330 20200331 20200401 20200402 20200403 20200404 20200405 20200406 20200407 20200408 20200409 20200410 20200411 20200412 20200413 20200414 20200415 20200416 20200417 20200418 20200419 20200420 20200421 ",
"priceFrom": "USD 49.50",
"priceQuote": {
"generalRetailPrice": "USD 49.50",
"merchantNetPrice": "USD 39.53",
"priceSource": "MANUAL",
"retailPrice": "USD 49.50"
}
}
],
"bookingEngine": "UNCONDITIONAL_FREESALE",
"description": "48 Hour Premium Ticket: Unlimited use on Big Bus Sydney & Bondi Tour for 48 hours from time of first use PLUS a guided walking tour of The Rocks, Syd",
"languageServices": {
"de": [
"AUDIO"
],
"en": [
"AUDIO"
],
"es": [
"AUDIO"
],
"fr": [
"AUDIO"
],
"ja": [
"AUDIO"
],
"ko": [
"AUDIO"
],
"zh": [
"AUDIO"
]
},
"sapi": false,
"title": "48 Hour Premium Ticket ",
"tourGradeCode": "48HOUR"
},
"DELUXE": {
"availDates": [
{
"dateList": "20200321 20200322 20200323 20200324 20200325 20200326 20200327 20200328 20200329 20200330 20200331 20200401 20200402 20200403 20200404 20200405 20200406 20200407 20200408 20200409 20200410 20200411 20200412 20200413 20200414 20200415 20200416 20200417 20200418 20200419 20200420 20200421 ",
"priceFrom": "USD 68.93",
"priceQuote": {
"generalRetailPrice": "USD 68.93",
"merchantNetPrice": "USD 55.05",
"priceSource": "MANUAL",
"retailPrice": "USD 68.93"
}
}
],
"bookingEngine": "UNCONDITIONAL_FREESALE",
"description": "Big Bus and Habour Cruise: Combine two great Sydney experiences into one with a hop-on hop off Big Bus Tours and a hop-on hop-off Sydney Harbour cruise <br/>Duration: 2 days: SPECIAL OFFER: EXTRA FREE DAY when you purchase a Deluxe ticket - have 3 days to explore Sydney not 2. Limited time only.\n<br/>Complimentary Walking Tour: Complimentary English-speaking 90-minute guided walking tour of “The Rocks” historic and harbourside precinct.",
"languageServices": {
"de": [
"AUDIO"
],
"en": [
"AUDIO"
],
"es": [
"AUDIO"
],
"fr": [
"AUDIO"
],
"ja": [
"AUDIO"
],
"ko": [
"AUDIO"
],
"zh": [
"AUDIO"
]
},
"sapi": false,
"title": "48 Hour Deluxe Bus and Cruise",
"tourGradeCode": "DELUXE"
},
"TG1": {
"availDates": [
{
"dateList": "20200321 20200322 20200323 20200324 20200325 20200326 20200327 20200328 20200329 20200330 20200331 20200401 20200402 20200403 20200404 20200405 20200406 20200407 20200408 20200409 20200410 20200411 20200412 20200413 20200414 20200415 20200416 20200417 20200418 20200419 20200420 20200421 ",
"priceFrom": "USD 89.81",
"priceQuote": {
"generalRetailPrice": "USD 89.81",
"merchantNetPrice": "USD 71.74",
"priceSource": "MANUAL",
"retailPrice": "USD 89.81"
}
}
],
"bookingEngine": "UNCONDITIONAL_FREESALE",
"description": "Hop-on Hop-Off and Attractions: 48hr Big Bus Tours, 1-day Hop-On Hop-Off Harbour Cruise, 4 Attractions: Tower Eye, Madame Tussauds, Wildlife Zoo, Aquarium<br/>Duration: 2 days: SPECIAL OFFER: EXTRA FREE DAY when you purchase a Deluxe ticket - have 3 days to explore Sydney not 2. Limited time only.\n<br/>Complimentary Walking Tours: Complimentary English-speaking guided walking tour of “The Rocks” historic and harbourside precinct.",
"languageServices": {
"de": [
"AUDIO"
],
"en": [
"AUDIO"
],
"es": [
"AUDIO"
],
"fr": [
"AUDIO"
],
"ja": [
"AUDIO"
],
"ko": [
"AUDIO"
],
"zh": [
"AUDIO"
]
},
"sapi": false,
"title": "48Hour Deluxe PLUS Attractions",
"tourGradeCode": "TG1"
}
},
"travellerMix": "1A"
},
"photoCount": 124,
"price": 36.97,
"priceFormatted": "$36.97",
"primaryDestinationId": 357,
"primaryDestinationName": "Sydney",
"primaryDestinationUrlName": "Sydney",
"primaryGroupId": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"productUrlName": "Sydney-and-Bondi-Hop-on-Hop-off-Tour",
"rating": 4.5,
"reviewCount": 1605,
"rrp": 0,
"rrpformatted": "",
"savingAmount": 0,
"savingAmountFormated": "",
"shortDescription": "Explore Sydney and Bondi Beach on this hop-on hop-off sightseeing tour, which takes you by double-decker bus to 34 stops around the city including Sydney Opera House, Sydney Harbour Bridge, Darling Harbour, Bondi Beach and more. Enjoy unobstructed views and recorded commentary on board. Simply hop off to walk around and sightsee in depth. Your ticket is valid for 24 or 48 hours, so you can experience Sydney and Bondi's most noteworthy attractions, sights, and shopping and dining areas at your own pace.",
"shortTitle": "Big Bus Sydney and Bondi Hop-on Hop-off Tour",
"sortOrder": 1,
"specialOfferAvailable": false,
"specialReservation": false,
"specialReservationDetails": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"sslSupported": false,
"subCatIds": [
97,
98,
5330,
26963,
32024,
45
],
"supplierCode": "5010",
"supplierName": "Big Bus Tours",
"thumbnailHiResURL": "https://hare-media-cdn.tripadvisor.com/media/attractions-splice-spp-674x446/07/94/40/f3.jpg",
"thumbnailURL": "https://hare-media-cdn.tripadvisor.com/media/attractions-splice-spp-154x109/07/94/40/f3.jpg",
"title": "Big Bus Sydney and Bondi Hop-on Hop-off Tour",
"translationLevel": 0,
"uniqueShortDescription": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"videoCount": 1,
"webURL": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
}
},
{
"admission": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"available": true,
"bookingEngineId": "FreesaleOnRequestBE",
"catIds": [
1,
25,
12
],
"code": "2280SUN",
"currencyCode": "USD",
"duration": "3 hours 30 minutes",
"essential": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"merchantCancellable": true,
"merchantNetPriceFrom": 420.68,
"merchantNetPriceFromFormatted": "$420.68",
"onRequestPeriod": 336,
"onSale": false,
"panoramaCount": 0,
"pas": {
"incompleteQuote": false,
"productCode": "2280SUN",
"removedChildAges": [],
"tourGrades": {
"SUNSET_ASTAR": {
"availDates": [
{
"dateList": "20200321 20200322 20200323 20200324 20200325 20200326 20200327 20200328 20200329 20200330 20200331 20200401 20200402 20200403 20200404 20200405 20200406 20200407 20200408 20200409 20200410 20200411 20200412 20200413 20200414 20200415 20200416 20200417 20200418 20200419 20200420 20200421 ",
"priceFrom": "USD 490.00",
"priceQuote": {
"generalRetailPrice": "USD 490.00",
"merchantNetPrice": "USD 420.68",
"priceSource": "MANUAL",
"retailPrice": "USD 490.00"
}
}
],
"bookingEngine": "FREESALE_ON_REQUEST",
"description": "Grand Canyon West Rim Deluxe Sunset Tour by A-Star Helicopter",
"languageServices": {
"de": [
"AUDIO"
],
"en": [
"AUDIO"
],
"es": [
"AUDIO"
],
"fr": [
"AUDIO"
],
"it": [
"AUDIO"
],
"ja": [
"AUDIO"
],
"ko": [
"AUDIO"
],
"pt": [
"AUDIO"
],
"ru": [
"AUDIO"
],
"tw": [
"AUDIO"
]
},
"sapi": false,
"title": "A-Star Helicopter ",
"tourGradeCode": "SUNSET_ASTAR"
},
"SUNSET_EC130": {
"availDates": [
{
"dateList": "20200321 20200322 20200323 20200324 20200325 20200326 20200327 20200328 20200329 20200330 20200331 20200401 20200402 20200403 20200404 20200405 20200406 20200407 20200408 20200409 20200410 20200411 20200412 20200413 20200414 20200415 20200416 20200417 20200418 20200419 20200420 20200421 ",
"priceFrom": "USD 515.00",
"priceQuote": {
"generalRetailPrice": "USD 515.00",
"merchantNetPrice": "USD 441.98",
"priceSource": "MANUAL",
"retailPrice": "USD 515.00"
}
}
],
"bookingEngine": "FREESALE_ON_REQUEST",
"description": "Grand Canyon West Rim Deluxe Sunset Tour by EC-130 Helicopter ",
"languageServices": {
"de": [
"AUDIO"
],
"en": [
"AUDIO"
],
"es": [
"AUDIO"
],
"fr": [
"AUDIO"
],
"it": [
"AUDIO"
],
"ja": [
"AUDIO"
],
"ko": [
"AUDIO"
],
"pt": [
"AUDIO"
],
"ru": [
"AUDIO"
],
"tw": [
"AUDIO"
]
},
"sapi": false,
"title": "EC-130 Helicopter Upgrade",
"tourGradeCode": "SUNSET_EC130"
}
},
"travellerMix": "1A"
},
"photoCount": 7,
"price": 490,
"priceFormatted": "$490.00",
"primaryDestinationId": 684,
"primaryDestinationName": "Las Vegas",
"primaryDestinationUrlName": "Las-Vegas",
"primaryGroupId": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"productUrlName": "Grand-Canyon-West-Rim-Deluxe-Sunset-Helicopter-Tour",
"rating": 5,
"reviewCount": 399,
"rrp": 0,
"rrpformatted": "",
"savingAmount": 0,
"savingAmountFormated": "",
"shortDescription": "Take off from Las Vegas on a magical sunset helicopter tour to the Grand Canyon. You'll enjoy a 45-minute helicopter flight each way, land at the Grand Canyon for a glass of Champagne and snacks while you watch the sun start it's descent behind the walls of the canyon, then fly low over the famous neon-lit Las Vegas Strip on your return.",
"shortTitle": "Grand Canyon from Las Vegas West Rim Sunset Helicopter Tour",
"sortOrder": 2,
"specialOfferAvailable": false,
"specialReservation": false,
"specialReservationDetails": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"sslSupported": false,
"subCatIds": [
113,
2,
98,
26963,
45,
95
],
"supplierCode": "2280",
"supplierName": "Sundance Helicopters",
"thumbnailHiResURL": "https://hare-media-cdn.tripadvisor.com/media/attractions-splice-spp-674x446/07/7a/ec/1c.jpg",
"thumbnailURL": "https://hare-media-cdn.tripadvisor.com/media/attractions-splice-spp-154x109/07/7a/ec/1c.jpg",
"title": "Grand Canyon West Rim Deluxe Sunset Helicopter Tour",
"translationLevel": 0,
"uniqueShortDescription": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"videoCount": 1,
"webURL": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
}
}
],
"dateStamp": "2020-02-10T15:41:53+0000",
"errorCodes": [],
"errorMessage": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorMessageText": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorName": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorReference": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorType": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"extraInfo": {},
"extraObject": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"success": true,
"totalCount": 1,
"vmid": "331005"
}
},
"booking-availability-dates-example": {
"summary": "booking availability dates example",
"value": {
"data": {
"2020-02": [
"11",
"12",
"13",
"14",
"15",
"16",
"17",
"18",
"19",
"20",
"21",
"22",
"23",
"24",
"25",
"26",
"27",
"28",
"29"
],
"2020-03": [
"01",
"02",
"03",
"04",
"05",
"06",
"07",
"08",
"09",
"10",
"11",
"12",
"13",
"14",
"15",
"16",
"17",
"18",
"19",
"20",
"21",
"22",
"23",
"24",
"25",
"26",
"27",
"28",
"29",
"30",
"31"
],
"2020-04": [
"01",
"02",
"03",
"04",
"05",
"06",
"07",
"08",
"09",
"10",
"11",
"12",
"13",
"14",
"15",
"16",
"17",
"18",
"19",
"20",
"21",
"22",
"23",
"24",
"25",
"26",
"27",
"28",
"29",
"30"
],
"2020-05": [
"01",
"02",
"03",
"04",
"05",
"06",
"07",
"08",
"09",
"10",
"11",
"12",
"13",
"14",
"15",
"16",
"17",
"18",
"19",
"20",
"21",
"22",
"23",
"24",
"25",
"26",
"27",
"28",
"29",
"30",
"31"
],
"2020-06": [
"01",
"02",
"03",
"04",
"05",
"06",
"07",
"08",
"09",
"10",
"11",
"12",
"13",
"14",
"15",
"16",
"17",
"18",
"19",
"20",
"21",
"22",
"23",
"24",
"25",
"26",
"27",
"28",
"29",
"30"
],
"2020-07": [
"01",
"02",
"03",
"04",
"05",
"06",
"07",
"08",
"09",
"10",
"11",
"12",
"13",
"14",
"15",
"16",
"17",
"18",
"19",
"20",
"21",
"22",
"23",
"24",
"25",
"26",
"27",
"28",
"29",
"30",
"31"
],
"2020-08": [
"01",
"02",
"03",
"04",
"05",
"06",
"07",
"08",
"09",
"10",
"11",
"12",
"13",
"14",
"15",
"16",
"17",
"18",
"19",
"20",
"21",
"22",
"23",
"24",
"25",
"26",
"27",
"28",
"29",
"30",
"31"
],
"2020-09": [
"01",
"02",
"03",
"04",
"05",
"06",
"07",
"08",
"09",
"10",
"11",
"12",
"13",
"14",
"15",
"16",
"17",
"18",
"19",
"20",
"21",
"22",
"23",
"24",
"25",
"26",
"27",
"28",
"29",
"30"
],
"2020-10": [
"01",
"02",
"03",
"04",
"05",
"06",
"07",
"08",
"09",
"10",
"11",
"12",
"13",
"14",
"15",
"16",
"17",
"18",
"19",
"20",
"21",
"22",
"23",
"24",
"25",
"26",
"27",
"28",
"29",
"30",
"31"
],
"2020-11": [
"01",
"02",
"03",
"04",
"05",
"06",
"07",
"08",
"09",
"10",
"11",
"12",
"13",
"14",
"15",
"16",
"17",
"18",
"19",
"20",
"21",
"22",
"23",
"24",
"25",
"26",
"27",
"28",
"29",
"30"
],
"2020-12": [
"01",
"02",
"03",
"04",
"05",
"06",
"07",
"08",
"09",
"10",
"11",
"12",
"13",
"14",
"15",
"16",
"17",
"18",
"19",
"20",
"21",
"22",
"23",
"24",
"25",
"26",
"27",
"28",
"29",
"30",
"31"
],
"2021-01": [
"01",
"02",
"03",
"04",
"05",
"06",
"07",
"08",
"09",
"10",
"11",
"12",
"13",
"14",
"15",
"16",
"17",
"18",
"19",
"20",
"21",
"22",
"23",
"24",
"25",
"26",
"27",
"28",
"29",
"30",
"31"
],
"2021-02": [
"01",
"02",
"03",
"04",
"05",
"06",
"07",
"08"
]
},
"dateStamp": "2020-02-10T16:51:10+0000",
"errorCodes": [],
"errorMessage": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorMessageText": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorName": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorReference": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorType": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"extraInfo": {},
"extraObject": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"success": true,
"totalCount": 1,
"vmid": "331004"
}
},
"booking-availability-example": {
"summary": "booking availability example",
"value": {
"data": {
"availability": [
{
"available": true,
"bookingDate": "2020-06-01",
"currencyCode": "AUD",
"gradeCode": "24HOUR",
"merchantNetPrice": 42.41,
"merchantNetPriceFormatted": "$42.41",
"retailPrice": 53.1,
"retailPriceFormatted": "$53.10",
"sortOrder": 1,
"unavailableReason": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
}
},
{
"available": true,
"bookingDate": "2020-06-02",
"currencyCode": "AUD",
"gradeCode": "24HOUR",
"merchantNetPrice": 42.41,
"merchantNetPriceFormatted": "$42.41",
"retailPrice": 53.1,
"retailPriceFormatted": "$53.10",
"sortOrder": 2,
"unavailableReason": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
}
},
{
"available": true,
"bookingDate": "2020-06-03",
"currencyCode": "AUD",
"gradeCode": "24HOUR",
"merchantNetPrice": 42.41,
"merchantNetPriceFormatted": "$42.41",
"retailPrice": 53.1,
"retailPriceFormatted": "$53.10",
"sortOrder": 3,
"unavailableReason": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
}
},
{
"available": true,
"bookingDate": "2020-06-04",
"currencyCode": "AUD",
"gradeCode": "24HOUR",
"merchantNetPrice": 42.41,
"merchantNetPriceFormatted": "$42.41",
"retailPrice": 53.1,
"retailPriceFormatted": "$53.10",
"sortOrder": 4,
"unavailableReason": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
}
},
{
"available": true,
"bookingDate": "2020-06-05",
"currencyCode": "AUD",
"gradeCode": "24HOUR",
"merchantNetPrice": 42.41,
"merchantNetPriceFormatted": "$42.41",
"retailPrice": 53.1,
"retailPriceFormatted": "$53.10",
"sortOrder": 5,
"unavailableReason": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
}
},
{
"available": true,
"bookingDate": "2020-06-06",
"currencyCode": "AUD",
"gradeCode": "24HOUR",
"merchantNetPrice": 42.41,
"merchantNetPriceFormatted": "$42.41",
"retailPrice": 53.1,
"retailPriceFormatted": "$53.10",
"sortOrder": 6,
"unavailableReason": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
}
},
{
"available": true,
"bookingDate": "2020-06-07",
"currencyCode": "AUD",
"gradeCode": "24HOUR",
"merchantNetPrice": 42.41,
"merchantNetPriceFormatted": "$42.41",
"retailPrice": 53.1,
"retailPriceFormatted": "$53.10",
"sortOrder": 7,
"unavailableReason": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
}
},
{
"available": true,
"bookingDate": "2020-06-08",
"currencyCode": "AUD",
"gradeCode": "24HOUR",
"merchantNetPrice": 42.41,
"merchantNetPriceFormatted": "$42.41",
"retailPrice": 53.1,
"retailPriceFormatted": "$53.10",
"sortOrder": 8,
"unavailableReason": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
}
},
{
"available": true,
"bookingDate": "2020-06-09",
"currencyCode": "AUD",
"gradeCode": "24HOUR",
"merchantNetPrice": 42.41,
"merchantNetPriceFormatted": "$42.41",
"retailPrice": 53.1,
"retailPriceFormatted": "$53.10",
"sortOrder": 9,
"unavailableReason": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
}
},
{
"available": true,
"bookingDate": "2020-06-10",
"currencyCode": "AUD",
"gradeCode": "24HOUR",
"merchantNetPrice": 42.41,
"merchantNetPriceFormatted": "$42.41",
"retailPrice": 53.1,
"retailPriceFormatted": "$53.10",
"sortOrder": 10,
"unavailableReason": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
}
},
{
"available": true,
"bookingDate": "2020-06-11",
"currencyCode": "AUD",
"gradeCode": "24HOUR",
"merchantNetPrice": 42.41,
"merchantNetPriceFormatted": "$42.41",
"retailPrice": 53.1,
"retailPriceFormatted": "$53.10",
"sortOrder": 11,
"unavailableReason": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
}
},
{
"available": true,
"bookingDate": "2020-06-12",
"currencyCode": "AUD",
"gradeCode": "24HOUR",
"merchantNetPrice": 42.41,
"merchantNetPriceFormatted": "$42.41",
"retailPrice": 53.1,
"retailPriceFormatted": "$53.10",
"sortOrder": 12,
"unavailableReason": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
}
},
{
"available": true,
"bookingDate": "2020-06-13",
"currencyCode": "AUD",
"gradeCode": "24HOUR",
"merchantNetPrice": 42.41,
"merchantNetPriceFormatted": "$42.41",
"retailPrice": 53.1,
"retailPriceFormatted": "$53.10",
"sortOrder": 13,
"unavailableReason": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
}
},
{
"available": true,
"bookingDate": "2020-06-14",
"currencyCode": "AUD",
"gradeCode": "24HOUR",
"merchantNetPrice": 42.41,
"merchantNetPriceFormatted": "$42.41",
"retailPrice": 53.1,
"retailPriceFormatted": "$53.10",
"sortOrder": 14,
"unavailableReason": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
}
},
{
"available": true,
"bookingDate": "2020-06-15",
"currencyCode": "AUD",
"gradeCode": "24HOUR",
"merchantNetPrice": 42.41,
"merchantNetPriceFormatted": "$42.41",
"retailPrice": 53.1,
"retailPriceFormatted": "$53.10",
"sortOrder": 15,
"unavailableReason": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
}
},
{
"available": true,
"bookingDate": "2020-06-16",
"currencyCode": "AUD",
"gradeCode": "24HOUR",
"merchantNetPrice": 42.41,
"merchantNetPriceFormatted": "$42.41",
"retailPrice": 53.1,
"retailPriceFormatted": "$53.10",
"sortOrder": 16,
"unavailableReason": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
}
},
{
"available": true,
"bookingDate": "2020-06-17",
"currencyCode": "AUD",
"gradeCode": "24HOUR",
"merchantNetPrice": 42.41,
"merchantNetPriceFormatted": "$42.41",
"retailPrice": 53.1,
"retailPriceFormatted": "$53.10",
"sortOrder": 17,
"unavailableReason": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
}
},
{
"available": true,
"bookingDate": "2020-06-18",
"currencyCode": "AUD",
"gradeCode": "24HOUR",
"merchantNetPrice": 42.41,
"merchantNetPriceFormatted": "$42.41",
"retailPrice": 53.1,
"retailPriceFormatted": "$53.10",
"sortOrder": 18,
"unavailableReason": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
}
},
{
"available": true,
"bookingDate": "2020-06-19",
"currencyCode": "AUD",
"gradeCode": "24HOUR",
"merchantNetPrice": 42.41,
"merchantNetPriceFormatted": "$42.41",
"retailPrice": 53.1,
"retailPriceFormatted": "$53.10",
"sortOrder": 19,
"unavailableReason": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
}
},
{
"available": true,
"bookingDate": "2020-06-20",
"currencyCode": "AUD",
"gradeCode": "24HOUR",
"merchantNetPrice": 42.41,
"merchantNetPriceFormatted": "$42.41",
"retailPrice": 53.1,
"retailPriceFormatted": "$53.10",
"sortOrder": 20,
"unavailableReason": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
}
},
{
"available": true,
"bookingDate": "2020-06-21",
"currencyCode": "AUD",
"gradeCode": "24HOUR",
"merchantNetPrice": 42.41,
"merchantNetPriceFormatted": "$42.41",
"retailPrice": 53.1,
"retailPriceFormatted": "$53.10",
"sortOrder": 21,
"unavailableReason": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
}
},
{
"available": true,
"bookingDate": "2020-06-22",
"currencyCode": "AUD",
"gradeCode": "24HOUR",
"merchantNetPrice": 42.41,
"merchantNetPriceFormatted": "$42.41",
"retailPrice": 53.1,
"retailPriceFormatted": "$53.10",
"sortOrder": 22,
"unavailableReason": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
}
},
{
"available": true,
"bookingDate": "2020-06-23",
"currencyCode": "AUD",
"gradeCode": "24HOUR",
"merchantNetPrice": 42.41,
"merchantNetPriceFormatted": "$42.41",
"retailPrice": 53.1,
"retailPriceFormatted": "$53.10",
"sortOrder": 23,
"unavailableReason": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
}
},
{
"available": true,
"bookingDate": "2020-06-24",
"currencyCode": "AUD",
"gradeCode": "24HOUR",
"merchantNetPrice": 42.41,
"merchantNetPriceFormatted": "$42.41",
"retailPrice": 53.1,
"retailPriceFormatted": "$53.10",
"sortOrder": 24,
"unavailableReason": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
}
},
{
"available": true,
"bookingDate": "2020-06-25",
"currencyCode": "AUD",
"gradeCode": "24HOUR",
"merchantNetPrice": 42.41,
"merchantNetPriceFormatted": "$42.41",
"retailPrice": 53.1,
"retailPriceFormatted": "$53.10",
"sortOrder": 25,
"unavailableReason": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
}
},
{
"available": true,
"bookingDate": "2020-06-26",
"currencyCode": "AUD",
"gradeCode": "24HOUR",
"merchantNetPrice": 42.41,
"merchantNetPriceFormatted": "$42.41",
"retailPrice": 53.1,
"retailPriceFormatted": "$53.10",
"sortOrder": 26,
"unavailableReason": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
}
},
{
"available": true,
"bookingDate": "2020-06-27",
"currencyCode": "AUD",
"gradeCode": "24HOUR",
"merchantNetPrice": 42.41,
"merchantNetPriceFormatted": "$42.41",
"retailPrice": 53.1,
"retailPriceFormatted": "$53.10",
"sortOrder": 27,
"unavailableReason": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
}
},
{
"available": true,
"bookingDate": "2020-06-28",
"currencyCode": "AUD",
"gradeCode": "24HOUR",
"merchantNetPrice": 42.41,
"merchantNetPriceFormatted": "$42.41",
"retailPrice": 53.1,
"retailPriceFormatted": "$53.10",
"sortOrder": 28,
"unavailableReason": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
}
},
{
"available": true,
"bookingDate": "2020-06-29",
"currencyCode": "AUD",
"gradeCode": "24HOUR",
"merchantNetPrice": 42.41,
"merchantNetPriceFormatted": "$42.41",
"retailPrice": 53.1,
"retailPriceFormatted": "$53.10",
"sortOrder": 29,
"unavailableReason": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
}
},
{
"available": true,
"bookingDate": "2020-06-30",
"currencyCode": "AUD",
"gradeCode": "24HOUR",
"merchantNetPrice": 42.41,
"merchantNetPriceFormatted": "$42.41",
"retailPrice": 53.1,
"retailPriceFormatted": "$53.10",
"sortOrder": 30,
"unavailableReason": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
}
}
],
"firstAvailableDate": "2020-06-01",
"lastAvailableDate": "2021-02-10",
"productCode": "5010SYDNEY"
},
"dateStamp": "2020-02-10T16:43:02+0000",
"errorCodes": [],
"errorMessage": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorMessageText": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorName": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorReference": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorType": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"extraInfo": {},
"extraObject": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"success": true,
"totalCount": 1,
"vmid": "331004"
}
},
"booking-availability-tourgrades-example": {
"summary": "booking availability tourgrades example",
"value": {
"data": [
{
"ageBands": [
{
"bandId": 1,
"bandTotal": 42.41,
"bandTotalFormatted": "$42.41",
"count": 1,
"currencyCode": "AUD",
"pricePerTraveler": 42.41,
"pricePerTravelerFormatted": "$42.41"
}
],
"ageBandsRequired": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"available": true,
"bookingDate": "2020-02-28",
"currencyCode": "AUD",
"defaultLanguageCode": "en",
"gradeCode": "24HOUR",
"gradeDepartureTime": "",
"gradeDescription": "Unlimited use on Big Bus Sydney & Bondi Hop-on Hop-off Tour for 24 hours from time of first use",
"gradeTitle": "24 Hour Classic Ticket ",
"langServices": {
"de/SERVICE_AUDIO": "German - Audio",
"en/SERVICE_AUDIO": "English - Audio",
"es/SERVICE_AUDIO": "Spanish - Audio",
"fr/SERVICE_AUDIO": "French - Audio",
"ja/SERVICE_AUDIO": "Japanese - Audio",
"ko/SERVICE_AUDIO": "Korean - Audio",
"zh/SERVICE_AUDIO": "Chinese - Audio"
},
"merchantNetPrice": 42.41,
"merchantNetPriceFormatted": "$42.41",
"retailPrice": 53.1,
"retailPriceFormatted": "$53.10",
"sortOrder": 1,
"unavailableReason": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
}
},
{
"ageBands": [
{
"bandId": 1,
"bandTotal": 56.79,
"bandTotalFormatted": "$56.79",
"count": 1,
"currencyCode": "AUD",
"pricePerTraveler": 56.79,
"pricePerTravelerFormatted": "$56.79"
}
],
"ageBandsRequired": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"available": true,
"bookingDate": "2020-02-28",
"currencyCode": "AUD",
"defaultLanguageCode": "en",
"gradeCode": "48HOUR",
"gradeDepartureTime": "",
"gradeDescription": "48 Hour Premium Ticket: Unlimited use on Big Bus Sydney & Bondi Tour for 48 hours from time of first use PLUS a guided walking tour of The Rocks, Syd",
"gradeTitle": "48 Hour Premium Ticket ",
"langServices": {
"de/SERVICE_AUDIO": "German - Audio",
"en/SERVICE_AUDIO": "English - Audio",
"es/SERVICE_AUDIO": "Spanish - Audio",
"fr/SERVICE_AUDIO": "French - Audio",
"ja/SERVICE_AUDIO": "Japanese - Audio",
"ko/SERVICE_AUDIO": "Korean - Audio",
"zh/SERVICE_AUDIO": "Chinese - Audio"
},
"merchantNetPrice": 56.79,
"merchantNetPriceFormatted": "$56.79",
"retailPrice": 71.1,
"retailPriceFormatted": "$71.10",
"sortOrder": 2,
"unavailableReason": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
}
},
{
"ageBands": [
{
"bandId": 1,
"bandTotal": 79.08,
"bandTotalFormatted": "$79.08",
"count": 1,
"currencyCode": "AUD",
"pricePerTraveler": 79.08,
"pricePerTravelerFormatted": "$79.08"
}
],
"ageBandsRequired": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"available": true,
"bookingDate": "2020-02-28",
"currencyCode": "AUD",
"defaultLanguageCode": "en",
"gradeCode": "DELUXE",
"gradeDepartureTime": "",
"gradeDescription": "Big Bus and Habour Cruise: Combine two great Sydney experiences into one with a hop-on hop off Big Bus Tours and a hop-on hop-off Sydney Harbour cruise <br/>Duration: 2 days: SPECIAL OFFER: EXTRA FREE DAY when you purchase a Deluxe ticket - have 3 days to explore Sydney not 2. Limited time only.\n<br/>Complimentary Walking Tour: Complimentary English-speaking 90-minute guided walking tour of “The Rocks” historic and harbourside precinct.",
"gradeTitle": "48 Hour Deluxe Bus and Cruise",
"langServices": {
"de/SERVICE_AUDIO": "German - Audio",
"en/SERVICE_AUDIO": "English - Audio",
"es/SERVICE_AUDIO": "Spanish - Audio",
"fr/SERVICE_AUDIO": "French - Audio",
"ja/SERVICE_AUDIO": "Japanese - Audio",
"ko/SERVICE_AUDIO": "Korean - Audio",
"zh/SERVICE_AUDIO": "Chinese - Audio"
},
"merchantNetPrice": 79.08,
"merchantNetPriceFormatted": "$79.08",
"retailPrice": 99,
"retailPriceFormatted": "$99.00",
"sortOrder": 3,
"unavailableReason": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
}
},
{
"ageBands": [
{
"bandId": 1,
"bandTotal": 103.04,
"bandTotalFormatted": "$103.04",
"count": 1,
"currencyCode": "AUD",
"pricePerTraveler": 103.04,
"pricePerTravelerFormatted": "$103.04"
}
],
"ageBandsRequired": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"available": true,
"bookingDate": "2020-02-28",
"currencyCode": "AUD",
"defaultLanguageCode": "en",
"gradeCode": "TG1",
"gradeDepartureTime": "",
"gradeDescription": "Hop-on Hop-Off and Attractions: 48hr Big Bus Tours, 1-day Hop-On Hop-Off Harbour Cruise, 4 Attractions: Tower Eye, Madame Tussauds, Wildlife Zoo, Aquarium<br/>Duration: 2 days: SPECIAL OFFER: EXTRA FREE DAY when you purchase a Deluxe ticket - have 3 days to explore Sydney not 2. Limited time only.\n<br/>Complimentary Walking Tours: Complimentary English-speaking guided walking tour of “The Rocks” historic and harbourside precinct.",
"gradeTitle": "48Hour Deluxe PLUS Attractions",
"langServices": {
"de/SERVICE_AUDIO": "German - Audio",
"en/SERVICE_AUDIO": "English - Audio",
"es/SERVICE_AUDIO": "Spanish - Audio",
"fr/SERVICE_AUDIO": "French - Audio",
"ja/SERVICE_AUDIO": "Japanese - Audio",
"ko/SERVICE_AUDIO": "Korean - Audio",
"zh/SERVICE_AUDIO": "Chinese - Audio"
},
"merchantNetPrice": 103.04,
"merchantNetPriceFormatted": "$103.04",
"retailPrice": 129,
"retailPriceFormatted": "$129.00",
"sortOrder": 4,
"unavailableReason": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
}
}
],
"dateStamp": "2020-02-10T16:57:56+0000",
"errorCodes": [],
"errorMessage": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorMessageText": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorName": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorReference": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorType": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"extraInfo": {},
"extraObject": {
"CDE_BRAINTREE": {
"APPAY": "sandbox_rtg2qcnx_yx8ptb2tqsjnzdnj",
"GPAY": "sandbox_rtg2qcnx_yx8ptb2tqsjnzdnj",
"PP": "sandbox_rtg2qcnx_yx8ptb2tqsjnzdnj"
}
},
"success": true,
"totalCount": 1,
"vmid": "331003"
}
},
"booking-availablility-tourgrades-pricingmatrix-example": {
"summary": "booking availability tourgrades example",
"value": {
"data": {
"bookingMonth": "2020-03",
"dates": [
{
"bookingDate": "2020-03-01",
"callForLastMinAvailability": false,
"sortOrder": 1,
"tourGrades": [
{
"gradeCode": "EB_ASTAR_SP~07:00",
"gradeTitle": "Special: Earlybird A-Star 07:00",
"pricingMatrix": [
{
"ageBandPrices": [
{
"bandId": 1,
"maximumCountRequired": 9,
"minimumCountRequired": 1,
"prices": [
{
"currencyCode": "USD",
"merchantNetPrice": 383.4,
"merchantNetPriceFormatted": "$383.40",
"minNoOfTravellersRequiredForPrice": 1,
"price": 409.99,
"priceFormatted": "$409.99",
"sortOrder": 1
}
],
"sortOrder": 1
},
{
"bandId": 3,
"maximumCountRequired": 9,
"minimumCountRequired": 0,
"prices": [
{
"currencyCode": "USD",
"merchantNetPrice": 0,
"merchantNetPriceFormatted": "$0.00",
"minNoOfTravellersRequiredForPrice": 1,
"price": 0,
"priceFormatted": "$0.00",
"sortOrder": 1
}
],
"sortOrder": 2
}
],
"bookingDate": "2020-03-01",
"pricingUnit": "per person",
"sortOrder": 1
}
],
"sortOrder": 1
},
{
"gradeCode": "EB_EC130_SP~07:00",
"gradeTitle": "Special: Earlybird EC-130 07:00",
"pricingMatrix": [
{
"ageBandPrices": [
{
"bandId": 1,
"maximumCountRequired": 9,
"minimumCountRequired": 1,
"prices": [
{
"currencyCode": "USD",
"merchantNetPrice": 404.7,
"merchantNetPriceFormatted": "$404.70",
"minNoOfTravellersRequiredForPrice": 1,
"price": 434.99,
"priceFormatted": "$434.99",
"sortOrder": 1
}
],
"sortOrder": 1
},
{
"bandId": 3,
"maximumCountRequired": 9,
"minimumCountRequired": 0,
"prices": [
{
"currencyCode": "USD",
"merchantNetPrice": 0,
"merchantNetPriceFormatted": "$0.00",
"minNoOfTravellersRequiredForPrice": 1,
"price": 0,
"priceFormatted": "$0.00",
"sortOrder": 1
}
],
"sortOrder": 2
}
],
"bookingDate": "2020-03-01",
"pricingUnit": "per person",
"sortOrder": 1
}
],
"sortOrder": 2
},
{
"gradeCode": "TG1~08:00",
"gradeTitle": "Morning Departure; A-Star 08:00",
"pricingMatrix": [
{
"ageBandPrices": [
{
"bandId": 1,
"maximumCountRequired": 9,
"minimumCountRequired": 1,
"prices": [
{
"currencyCode": "USD",
"merchantNetPrice": 388.72,
"merchantNetPriceFormatted": "$388.72",
"minNoOfTravellersRequiredForPrice": 1,
"price": 459.99,
"priceFormatted": "$459.99",
"sortOrder": 1
}
],
"sortOrder": 1
},
{
"bandId": 3,
"maximumCountRequired": 9,
"minimumCountRequired": 0,
"prices": [
{
"currencyCode": "USD",
"merchantNetPrice": 0,
"merchantNetPriceFormatted": "$0.00",
"minNoOfTravellersRequiredForPrice": 1,
"price": 0,
"priceFormatted": "$0.00",
"sortOrder": 1
}
],
"sortOrder": 2
}
],
"bookingDate": "2020-03-01",
"pricingUnit": "per person",
"sortOrder": 1
}
],
"sortOrder": 3
},
{
"gradeCode": "TG1~09:45",
"gradeTitle": "Morning Departure; A-Star 09:45",
"pricingMatrix": [
{
"ageBandPrices": [
{
"bandId": 1,
"maximumCountRequired": 9,
"minimumCountRequired": 1,
"prices": [
{
"currencyCode": "USD",
"merchantNetPrice": 388.72,
"merchantNetPriceFormatted": "$388.72",
"minNoOfTravellersRequiredForPrice": 1,
"price": 459.99,
"priceFormatted": "$459.99",
"sortOrder": 1
}
],
"sortOrder": 1
},
{
"bandId": 3,
"maximumCountRequired": 9,
"minimumCountRequired": 0,
"prices": [
{
"currencyCode": "USD",
"merchantNetPrice": 0,
"merchantNetPriceFormatted": "$0.00",
"minNoOfTravellersRequiredForPrice": 1,
"price": 0,
"priceFormatted": "$0.00",
"sortOrder": 1
}
],
"sortOrder": 2
}
],
"bookingDate": "2020-03-01",
"pricingUnit": "per person",
"sortOrder": 1
}
],
"sortOrder": 4
},
{
"gradeCode": "TG1~10:45",
"gradeTitle": "Morning Departure; A-Star 10:45",
"pricingMatrix": [
{
"ageBandPrices": [
{
"bandId": 1,
"maximumCountRequired": 9,
"minimumCountRequired": 1,
"prices": [
{
"currencyCode": "USD",
"merchantNetPrice": 388.72,
"merchantNetPriceFormatted": "$388.72",
"minNoOfTravellersRequiredForPrice": 1,
"price": 459.99,
"priceFormatted": "$459.99",
"sortOrder": 1
}
],
"sortOrder": 1
},
{
"bandId": 3,
"maximumCountRequired": 9,
"minimumCountRequired": 0,
"prices": [
{
"currencyCode": "USD",
"merchantNetPrice": 0,
"merchantNetPriceFormatted": "$0.00",
"minNoOfTravellersRequiredForPrice": 1,
"price": 0,
"priceFormatted": "$0.00",
"sortOrder": 1
}
],
"sortOrder": 2
}
],
"bookingDate": "2020-03-01",
"pricingUnit": "per person",
"sortOrder": 1
}
],
"sortOrder": 5
},
{
"gradeCode": "TG2~08:00",
"gradeTitle": "Morning Departure; EC-130 08:00",
"pricingMatrix": [
{
"ageBandPrices": [
{
"bandId": 1,
"maximumCountRequired": 9,
"minimumCountRequired": 1,
"prices": [
{
"currencyCode": "USD",
"merchantNetPrice": 410.02,
"merchantNetPriceFormatted": "$410.02",
"minNoOfTravellersRequiredForPrice": 1,
"price": 484.99,
"priceFormatted": "$484.99",
"sortOrder": 1
}
],
"sortOrder": 1
},
{
"bandId": 3,
"maximumCountRequired": 9,
"minimumCountRequired": 0,
"prices": [
{
"currencyCode": "USD",
"merchantNetPrice": 0,
"merchantNetPriceFormatted": "$0.00",
"minNoOfTravellersRequiredForPrice": 1,
"price": 0,
"priceFormatted": "$0.00",
"sortOrder": 1
}
],
"sortOrder": 2
}
],
"bookingDate": "2020-03-01",
"pricingUnit": "per person",
"sortOrder": 1
}
],
"sortOrder": 6
},
{
"gradeCode": "TG2~09:45",
"gradeTitle": "Morning Departure; EC-130 09:45",
"pricingMatrix": [
{
"ageBandPrices": [
{
"bandId": 1,
"maximumCountRequired": 9,
"minimumCountRequired": 1,
"prices": [
{
"currencyCode": "USD",
"merchantNetPrice": 410.02,
"merchantNetPriceFormatted": "$410.02",
"minNoOfTravellersRequiredForPrice": 1,
"price": 484.99,
"priceFormatted": "$484.99",
"sortOrder": 1
}
],
"sortOrder": 1
},
{
"bandId": 3,
"maximumCountRequired": 9,
"minimumCountRequired": 0,
"prices": [
{
"currencyCode": "USD",
"merchantNetPrice": 0,
"merchantNetPriceFormatted": "$0.00",
"minNoOfTravellersRequiredForPrice": 1,
"price": 0,
"priceFormatted": "$0.00",
"sortOrder": 1
}
],
"sortOrder": 2
}
],
"bookingDate": "2020-03-01",
"pricingUnit": "per person",
"sortOrder": 1
}
],
"sortOrder": 7
},
{
"gradeCode": "TG2~10:45",
"gradeTitle": "Morning Departure; EC-130 10:45",
"pricingMatrix": [
{
"ageBandPrices": [
{
"bandId": 1,
"maximumCountRequired": 9,
"minimumCountRequired": 1,
"prices": [
{
"currencyCode": "USD",
"merchantNetPrice": 410.02,
"merchantNetPriceFormatted": "$410.02",
"minNoOfTravellersRequiredForPrice": 1,
"price": 484.99,
"priceFormatted": "$484.99",
"sortOrder": 1
}
],
"sortOrder": 1
},
{
"bandId": 3,
"maximumCountRequired": 9,
"minimumCountRequired": 0,
"prices": [
{
"currencyCode": "USD",
"merchantNetPrice": 0,
"merchantNetPriceFormatted": "$0.00",
"minNoOfTravellersRequiredForPrice": 1,
"price": 0,
"priceFormatted": "$0.00",
"sortOrder": 1
}
],
"sortOrder": 2
}
],
"bookingDate": "2020-03-01",
"pricingUnit": "per person",
"sortOrder": 1
}
],
"sortOrder": 8
},
{
"gradeCode": "TG3~12:30",
"gradeTitle": "Afternoon Departure; A-Star 12:30",
"pricingMatrix": [
{
"ageBandPrices": [
{
"bandId": 1,
"maximumCountRequired": 9,
"minimumCountRequired": 1,
"prices": [
{
"currencyCode": "USD",
"merchantNetPrice": 383.4,
"merchantNetPriceFormatted": "$383.40",
"minNoOfTravellersRequiredForPrice": 1,
"price": 449.99,
"priceFormatted": "$449.99",
"sortOrder": 1
}
],
"sortOrder": 1
},
{
"bandId": 3,
"maximumCountRequired": 9,
"minimumCountRequired": 0,
"prices": [
{
"currencyCode": "USD",
"merchantNetPrice": 0,
"merchantNetPriceFormatted": "$0.00",
"minNoOfTravellersRequiredForPrice": 1,
"price": 0,
"priceFormatted": "$0.00",
"sortOrder": 1
}
],
"sortOrder": 2
}
],
"bookingDate": "2020-03-01",
"pricingUnit": "per person",
"sortOrder": 1
}
],
"sortOrder": 9
},
{
"gradeCode": "TG3~13:30",
"gradeTitle": "Afternoon Departure; A-Star 13:30",
"pricingMatrix": [
{
"ageBandPrices": [
{
"bandId": 1,
"maximumCountRequired": 9,
"minimumCountRequired": 1,
"prices": [
{
"currencyCode": "USD",
"merchantNetPrice": 383.4,
"merchantNetPriceFormatted": "$383.40",
"minNoOfTravellersRequiredForPrice": 1,
"price": 449.99,
"priceFormatted": "$449.99",
"sortOrder": 1
}
],
"sortOrder": 1
},
{
"bandId": 3,
"maximumCountRequired": 9,
"minimumCountRequired": 0,
"prices": [
{
"currencyCode": "USD",
"merchantNetPrice": 0,
"merchantNetPriceFormatted": "$0.00",
"minNoOfTravellersRequiredForPrice": 1,
"price": 0,
"priceFormatted": "$0.00",
"sortOrder": 1
}
],
"sortOrder": 2
}
],
"bookingDate": "2020-03-01",
"pricingUnit": "per person",
"sortOrder": 1
}
],
"sortOrder": 10
},
{
"gradeCode": "TG4~12:30",
"gradeTitle": "Afternoon Departure; EC-130 12:30",
"pricingMatrix": [
{
"ageBandPrices": [
{
"bandId": 1,
"maximumCountRequired": 9,
"minimumCountRequired": 1,
"prices": [
{
"currencyCode": "USD",
"merchantNetPrice": 404.7,
"merchantNetPriceFormatted": "$404.70",
"minNoOfTravellersRequiredForPrice": 1,
"price": 474.99,
"priceFormatted": "$474.99",
"sortOrder": 1
}
],
"sortOrder": 1
},
{
"bandId": 3,
"maximumCountRequired": 9,
"minimumCountRequired": 0,
"prices": [
{
"currencyCode": "USD",
"merchantNetPrice": 0,
"merchantNetPriceFormatted": "$0.00",
"minNoOfTravellersRequiredForPrice": 1,
"price": 0,
"priceFormatted": "$0.00",
"sortOrder": 1
}
],
"sortOrder": 2
}
],
"bookingDate": "2020-03-01",
"pricingUnit": "per person",
"sortOrder": 1
}
],
"sortOrder": 11
},
{
"gradeCode": "TG4~13:30",
"gradeTitle": "Afternoon Departure; EC-130 13:30",
"pricingMatrix": [
{
"ageBandPrices": [
{
"bandId": 1,
"maximumCountRequired": 9,
"minimumCountRequired": 1,
"prices": [
{
"currencyCode": "USD",
"merchantNetPrice": 404.7,
"merchantNetPriceFormatted": "$404.70",
"minNoOfTravellersRequiredForPrice": 1,
"price": 474.99,
"priceFormatted": "$474.99",
"sortOrder": 1
}
],
"sortOrder": 1
},
{
"bandId": 3,
"maximumCountRequired": 9,
"minimumCountRequired": 0,
"prices": [
{
"currencyCode": "USD",
"merchantNetPrice": 0,
"merchantNetPriceFormatted": "$0.00",
"minNoOfTravellersRequiredForPrice": 1,
"price": 0,
"priceFormatted": "$0.00",
"sortOrder": 1
}
],
"sortOrder": 2
}
],
"bookingDate": "2020-03-01",
"pricingUnit": "per person",
"sortOrder": 1
}
],
"sortOrder": 12
}
]
},
{
"bookingDate": "2020-03-02",
"callForLastMinAvailability": false,
"sortOrder": 2,
"tourGrades": [
{
"gradeCode": "EB_ASTAR_SP~07:00",
"gradeTitle": "Special: Earlybird A-Star 07:00",
"pricingMatrix": [
{
"ageBandPrices": [
{
"bandId": 1,
"maximumCountRequired": 9,
"minimumCountRequired": 1,
"prices": [
{
"currencyCode": "USD",
"merchantNetPrice": 383.4,
"merchantNetPriceFormatted": "$383.40",
"minNoOfTravellersRequiredForPrice": 1,
"price": 409.99,
"priceFormatted": "$409.99",
"sortOrder": 1
}
],
"sortOrder": 1
},
{
"bandId": 3,
"maximumCountRequired": 9,
"minimumCountRequired": 0,
"prices": [
{
"currencyCode": "USD",
"merchantNetPrice": 0,
"merchantNetPriceFormatted": "$0.00",
"minNoOfTravellersRequiredForPrice": 1,
"price": 0,
"priceFormatted": "$0.00",
"sortOrder": 1
}
],
"sortOrder": 2
}
],
"bookingDate": "2020-03-02",
"pricingUnit": "per person",
"sortOrder": 1
}
],
"sortOrder": 1
},
{
"gradeCode": "EB_EC130_SP~07:00",
"gradeTitle": "Special: Earlybird EC-130 07:00",
"pricingMatrix": [
{
"ageBandPrices": [
{
"bandId": 1,
"maximumCountRequired": 9,
"minimumCountRequired": 1,
"prices": [
{
"currencyCode": "USD",
"merchantNetPrice": 404.7,
"merchantNetPriceFormatted": "$404.70",
"minNoOfTravellersRequiredForPrice": 1,
"price": 434.99,
"priceFormatted": "$434.99",
"sortOrder": 1
}
],
"sortOrder": 1
},
{
"bandId": 3,
"maximumCountRequired": 9,
"minimumCountRequired": 0,
"prices": [
{
"currencyCode": "USD",
"merchantNetPrice": 0,
"merchantNetPriceFormatted": "$0.00",
"minNoOfTravellersRequiredForPrice": 1,
"price": 0,
"priceFormatted": "$0.00",
"sortOrder": 1
}
],
"sortOrder": 2
}
],
"bookingDate": "2020-03-02",
"pricingUnit": "per person",
"sortOrder": 1
}
],
"sortOrder": 2
},
{
"gradeCode": "TG1~08:00",
"gradeTitle": "Morning Departure; A-Star 08:00",
"pricingMatrix": [
{
"ageBandPrices": [
{
"bandId": 1,
"maximumCountRequired": 9,
"minimumCountRequired": 1,
"prices": [
{
"currencyCode": "USD",
"merchantNetPrice": 388.72,
"merchantNetPriceFormatted": "$388.72",
"minNoOfTravellersRequiredForPrice": 1,
"price": 459.99,
"priceFormatted": "$459.99",
"sortOrder": 1
}
],
"sortOrder": 1
},
{
"bandId": 3,
"maximumCountRequired": 9,
"minimumCountRequired": 0,
"prices": [
{
"currencyCode": "USD",
"merchantNetPrice": 0,
"merchantNetPriceFormatted": "$0.00",
"minNoOfTravellersRequiredForPrice": 1,
"price": 0,
"priceFormatted": "$0.00",
"sortOrder": 1
}
],
"sortOrder": 2
}
],
"bookingDate": "2020-03-02",
"pricingUnit": "per person",
"sortOrder": 1
}
],
"sortOrder": 3
},
{
"gradeCode": "TG1~09:45",
"gradeTitle": "Morning Departure; A-Star 09:45",
"pricingMatrix": [
{
"ageBandPrices": [
{
"bandId": 1,
"maximumCountRequired": 9,
"minimumCountRequired": 1,
"prices": [
{
"currencyCode": "USD",
"merchantNetPrice": 388.72,
"merchantNetPriceFormatted": "$388.72",
"minNoOfTravellersRequiredForPrice": 1,
"price": 459.99,
"priceFormatted": "$459.99",
"sortOrder": 1
}
],
"sortOrder": 1
},
{
"bandId": 3,
"maximumCountRequired": 9,
"minimumCountRequired": 0,
"prices": [
{
"currencyCode": "USD",
"merchantNetPrice": 0,
"merchantNetPriceFormatted": "$0.00",
"minNoOfTravellersRequiredForPrice": 1,
"price": 0,
"priceFormatted": "$0.00",
"sortOrder": 1
}
],
"sortOrder": 2
}
],
"bookingDate": "2020-03-02",
"pricingUnit": "per person",
"sortOrder": 1
}
],
"sortOrder": 4
},
{
"gradeCode": "TG1~10:45",
"gradeTitle": "Morning Departure; A-Star 10:45",
"pricingMatrix": [
{
"ageBandPrices": [
{
"bandId": 1,
"maximumCountRequired": 9,
"minimumCountRequired": 1,
"prices": [
{
"currencyCode": "USD",
"merchantNetPrice": 388.72,
"merchantNetPriceFormatted": "$388.72",
"minNoOfTravellersRequiredForPrice": 1,
"price": 459.99,
"priceFormatted": "$459.99",
"sortOrder": 1
}
],
"sortOrder": 1
},
{
"bandId": 3,
"maximumCountRequired": 9,
"minimumCountRequired": 0,
"prices": [
{
"currencyCode": "USD",
"merchantNetPrice": 0,
"merchantNetPriceFormatted": "$0.00",
"minNoOfTravellersRequiredForPrice": 1,
"price": 0,
"priceFormatted": "$0.00",
"sortOrder": 1
}
],
"sortOrder": 2
}
],
"bookingDate": "2020-03-02",
"pricingUnit": "per person",
"sortOrder": 1
}
],
"sortOrder": 5
},
{
"gradeCode": "TG2~08:00",
"gradeTitle": "Morning Departure; EC-130 08:00",
"pricingMatrix": [
{
"ageBandPrices": [
{
"bandId": 1,
"maximumCountRequired": 9,
"minimumCountRequired": 1,
"prices": [
{
"currencyCode": "USD",
"merchantNetPrice": 410.02,
"merchantNetPriceFormatted": "$410.02",
"minNoOfTravellersRequiredForPrice": 1,
"price": 484.99,
"priceFormatted": "$484.99",
"sortOrder": 1
}
],
"sortOrder": 1
},
{
"bandId": 3,
"maximumCountRequired": 9,
"minimumCountRequired": 0,
"prices": [
{
"currencyCode": "USD",
"merchantNetPrice": 0,
"merchantNetPriceFormatted": "$0.00",
"minNoOfTravellersRequiredForPrice": 1,
"price": 0,
"priceFormatted": "$0.00",
"sortOrder": 1
}
],
"sortOrder": 2
}
],
"bookingDate": "2020-03-02",
"pricingUnit": "per person",
"sortOrder": 1
}
],
"sortOrder": 6
},
{
"gradeCode": "TG2~09:45",
"gradeTitle": "Morning Departure; EC-130 09:45",
"pricingMatrix": [
{
"ageBandPrices": [
{
"bandId": 1,
"maximumCountRequired": 9,
"minimumCountRequired": 1,
"prices": [
{
"currencyCode": "USD",
"merchantNetPrice": 410.02,
"merchantNetPriceFormatted": "$410.02",
"minNoOfTravellersRequiredForPrice": 1,
"price": 484.99,
"priceFormatted": "$484.99",
"sortOrder": 1
}
],
"sortOrder": 1
},
{
"bandId": 3,
"maximumCountRequired": 9,
"minimumCountRequired": 0,
"prices": [
{
"currencyCode": "USD",
"merchantNetPrice": 0,
"merchantNetPriceFormatted": "$0.00",
"minNoOfTravellersRequiredForPrice": 1,
"price": 0,
"priceFormatted": "$0.00",
"sortOrder": 1
}
],
"sortOrder": 2
}
],
"bookingDate": "2020-03-02",
"pricingUnit": "per person",
"sortOrder": 1
}
],
"sortOrder": 7
},
{
"gradeCode": "TG2~10:45",
"gradeTitle": "Morning Departure; EC-130 10:45",
"pricingMatrix": [
{
"ageBandPrices": [
{
"bandId": 1,
"maximumCountRequired": 9,
"minimumCountRequired": 1,
"prices": [
{
"currencyCode": "USD",
"merchantNetPrice": 410.02,
"merchantNetPriceFormatted": "$410.02",
"minNoOfTravellersRequiredForPrice": 1,
"price": 484.99,
"priceFormatted": "$484.99",
"sortOrder": 1
}
],
"sortOrder": 1
},
{
"bandId": 3,
"maximumCountRequired": 9,
"minimumCountRequired": 0,
"prices": [
{
"currencyCode": "USD",
"merchantNetPrice": 0,
"merchantNetPriceFormatted": "$0.00",
"minNoOfTravellersRequiredForPrice": 1,
"price": 0,
"priceFormatted": "$0.00",
"sortOrder": 1
}
],
"sortOrder": 2
}
],
"bookingDate": "2020-03-02",
"pricingUnit": "per person",
"sortOrder": 1
}
],
"sortOrder": 8
},
{
"gradeCode": "TG3~12:30",
"gradeTitle": "Afternoon Departure; A-Star 12:30",
"pricingMatrix": [
{
"ageBandPrices": [
{
"bandId": 1,
"maximumCountRequired": 9,
"minimumCountRequired": 1,
"prices": [
{
"currencyCode": "USD",
"merchantNetPrice": 383.4,
"merchantNetPriceFormatted": "$383.40",
"minNoOfTravellersRequiredForPrice": 1,
"price": 449.99,
"priceFormatted": "$449.99",
"sortOrder": 1
}
],
"sortOrder": 1
},
{
"bandId": 3,
"maximumCountRequired": 9,
"minimumCountRequired": 0,
"prices": [
{
"currencyCode": "USD",
"merchantNetPrice": 0,
"merchantNetPriceFormatted": "$0.00",
"minNoOfTravellersRequiredForPrice": 1,
"price": 0,
"priceFormatted": "$0.00",
"sortOrder": 1
}
],
"sortOrder": 2
}
],
"bookingDate": "2020-03-02",
"pricingUnit": "per person",
"sortOrder": 1
}
],
"sortOrder": 9
},
{
"gradeCode": "TG3~13:30",
"gradeTitle": "Afternoon Departure; A-Star 13:30",
"pricingMatrix": [
{
"ageBandPrices": [
{
"bandId": 1,
"maximumCountRequired": 9,
"minimumCountRequired": 1,
"prices": [
{
"currencyCode": "USD",
"merchantNetPrice": 383.4,
"merchantNetPriceFormatted": "$383.40",
"minNoOfTravellersRequiredForPrice": 1,
"price": 449.99,
"priceFormatted": "$449.99",
"sortOrder": 1
}
],
"sortOrder": 1
},
{
"bandId": 3,
"maximumCountRequired": 9,
"minimumCountRequired": 0,
"prices": [
{
"currencyCode": "USD",
"merchantNetPrice": 0,
"merchantNetPriceFormatted": "$0.00",
"minNoOfTravellersRequiredForPrice": 1,
"price": 0,
"priceFormatted": "$0.00",
"sortOrder": 1
}
],
"sortOrder": 2
}
],
"bookingDate": "2020-03-02",
"pricingUnit": "per person",
"sortOrder": 1
}
],
"sortOrder": 10
},
{
"gradeCode": "TG4~12:30",
"gradeTitle": "Afternoon Departure; EC-130 12:30",
"pricingMatrix": [
{
"ageBandPrices": [
{
"bandId": 1,
"maximumCountRequired": 9,
"minimumCountRequired": 1,
"prices": [
{
"currencyCode": "USD",
"merchantNetPrice": 404.7,
"merchantNetPriceFormatted": "$404.70",
"minNoOfTravellersRequiredForPrice": 1,
"price": 474.99,
"priceFormatted": "$474.99",
"sortOrder": 1
}
],
"sortOrder": 1
},
{
"bandId": 3,
"maximumCountRequired": 9,
"minimumCountRequired": 0,
"prices": [
{
"currencyCode": "USD",
"merchantNetPrice": 0,
"merchantNetPriceFormatted": "$0.00",
"minNoOfTravellersRequiredForPrice": 1,
"price": 0,
"priceFormatted": "$0.00",
"sortOrder": 1
}
],
"sortOrder": 2
}
],
"bookingDate": "2020-03-02",
"pricingUnit": "per person",
"sortOrder": 1
}
],
"sortOrder": 11
},
{
"gradeCode": "TG4~13:30",
"gradeTitle": "Afternoon Departure; EC-130 13:30",
"pricingMatrix": [
{
"ageBandPrices": [
{
"bandId": 1,
"maximumCountRequired": 9,
"minimumCountRequired": 1,
"prices": [
{
"currencyCode": "USD",
"merchantNetPrice": 404.7,
"merchantNetPriceFormatted": "$404.70",
"minNoOfTravellersRequiredForPrice": 1,
"price": 474.99,
"priceFormatted": "$474.99",
"sortOrder": 1
}
],
"sortOrder": 1
},
{
"bandId": 3,
"maximumCountRequired": 9,
"minimumCountRequired": 0,
"prices": [
{
"currencyCode": "USD",
"merchantNetPrice": 0,
"merchantNetPriceFormatted": "$0.00",
"minNoOfTravellersRequiredForPrice": 1,
"price": 0,
"priceFormatted": "$0.00",
"sortOrder": 1
}
],
"sortOrder": 2
}
],
"bookingDate": "2020-03-02",
"pricingUnit": "per person",
"sortOrder": 1
}
],
"sortOrder": 12
}
]
},
{
"bookingDate": "2020-03-03",
"callForLastMinAvailability": false,
"sortOrder": 3,
"tourGrades": [
{
"gradeCode": "EB_ASTAR_SP~07:00",
"gradeTitle": "Special: Earlybird A-Star 07:00",
"pricingMatrix": [
{
"ageBandPrices": [
{
"bandId": 1,
"maximumCountRequired": 9,
"minimumCountRequired": 1,
"prices": [
{
"currencyCode": "USD",
"merchantNetPrice": 383.4,
"merchantNetPriceFormatted": "$383.40",
"minNoOfTravellersRequiredForPrice": 1,
"price": 409.99,
"priceFormatted": "$409.99",
"sortOrder": 1
}
],
"sortOrder": 1
},
{
"bandId": 3,
"maximumCountRequired": 9,
"minimumCountRequired": 0,
"prices": [
{
"currencyCode": "USD",
"merchantNetPrice": 0,
"merchantNetPriceFormatted": "$0.00",
"minNoOfTravellersRequiredForPrice": 1,
"price": 0,
"priceFormatted": "$0.00",
"sortOrder": 1
}
],
"sortOrder": 2
}
],
"bookingDate": "2020-03-03",
"pricingUnit": "per person",
"sortOrder": 1
}
],
"sortOrder": 1
},
{
"gradeCode": "EB_EC130_SP~07:00",
"gradeTitle": "Special: Earlybird EC-130 07:00",
"pricingMatrix": [
{
"ageBandPrices": [
{
"bandId": 1,
"maximumCountRequired": 9,
"minimumCountRequired": 1,
"prices": [
{
"currencyCode": "USD",
"merchantNetPrice": 404.7,
"merchantNetPriceFormatted": "$404.70",
"minNoOfTravellersRequiredForPrice": 1,
"price": 434.99,
"priceFormatted": "$434.99",
"sortOrder": 1
}
],
"sortOrder": 1
},
{
"bandId": 3,
"maximumCountRequired": 9,
"minimumCountRequired": 0,
"prices": [
{
"currencyCode": "USD",
"merchantNetPrice": 0,
"merchantNetPriceFormatted": "$0.00",
"minNoOfTravellersRequiredForPrice": 1,
"price": 0,
"priceFormatted": "$0.00",
"sortOrder": 1
}
],
"sortOrder": 2
}
],
"bookingDate": "2020-03-03",
"pricingUnit": "per person",
"sortOrder": 1
}
],
"sortOrder": 2
},
{
"gradeCode": "TG1~08:00",
"gradeTitle": "Morning Departure; A-Star 08:00",
"pricingMatrix": [
{
"ageBandPrices": [
{
"bandId": 1,
"maximumCountRequired": 9,
"minimumCountRequired": 1,
"prices": [
{
"currencyCode": "USD",
"merchantNetPrice": 388.72,
"merchantNetPriceFormatted": "$388.72",
"minNoOfTravellersRequiredForPrice": 1,
"price": 459.99,
"priceFormatted": "$459.99",
"sortOrder": 1
}
],
"sortOrder": 1
},
{
"bandId": 3,
"maximumCountRequired": 9,
"minimumCountRequired": 0,
"prices": [
{
"currencyCode": "USD",
"merchantNetPrice": 0,
"merchantNetPriceFormatted": "$0.00",
"minNoOfTravellersRequiredForPrice": 1,
"price": 0,
"priceFormatted": "$0.00",
"sortOrder": 1
}
],
"sortOrder": 2
}
],
"bookingDate": "2020-03-03",
"pricingUnit": "per person",
"sortOrder": 1
}
],
"sortOrder": 3
},
{
"gradeCode": "TG1~09:45",
"gradeTitle": "Morning Departure; A-Star 09:45",
"pricingMatrix": [
{
"ageBandPrices": [
{
"bandId": 1,
"maximumCountRequired": 9,
"minimumCountRequired": 1,
"prices": [
{
"currencyCode": "USD",
"merchantNetPrice": 388.72,
"merchantNetPriceFormatted": "$388.72",
"minNoOfTravellersRequiredForPrice": 1,
"price": 459.99,
"priceFormatted": "$459.99",
"sortOrder": 1
}
],
"sortOrder": 1
},
{
"bandId": 3,
"maximumCountRequired": 9,
"minimumCountRequired": 0,
"prices": [
{
"currencyCode": "USD",
"merchantNetPrice": 0,
"merchantNetPriceFormatted": "$0.00",
"minNoOfTravellersRequiredForPrice": 1,
"price": 0,
"priceFormatted": "$0.00",
"sortOrder": 1
}
],
"sortOrder": 2
}
],
"bookingDate": "2020-03-03",
"pricingUnit": "per person",
"sortOrder": 1
}
],
"sortOrder": 4
},
{
"gradeCode": "TG1~10:45",
"gradeTitle": "Morning Departure; A-Star 10:45",
"pricingMatrix": [
{
"ageBandPrices": [
{
"bandId": 1,
"maximumCountRequired": 9,
"minimumCountRequired": 1,
"prices": [
{
"currencyCode": "USD",
"merchantNetPrice": 388.72,
"merchantNetPriceFormatted": "$388.72",
"minNoOfTravellersRequiredForPrice": 1,
"price": 459.99,
"priceFormatted": "$459.99",
"sortOrder": 1
}
],
"sortOrder": 1
},
{
"bandId": 3,
"maximumCountRequired": 9,
"minimumCountRequired": 0,
"prices": [
{
"currencyCode": "USD",
"merchantNetPrice": 0,
"merchantNetPriceFormatted": "$0.00",
"minNoOfTravellersRequiredForPrice": 1,
"price": 0,
"priceFormatted": "$0.00",
"sortOrder": 1
}
],
"sortOrder": 2
}
],
"bookingDate": "2020-03-03",
"pricingUnit": "per person",
"sortOrder": 1
}
],
"sortOrder": 5
},
{
"gradeCode": "TG2~08:00",
"gradeTitle": "Morning Departure; EC-130 08:00",
"pricingMatrix": [
{
"ageBandPrices": [
{
"bandId": 1,
"maximumCountRequired": 9,
"minimumCountRequired": 1,
"prices": [
{
"currencyCode": "USD",
"merchantNetPrice": 410.02,
"merchantNetPriceFormatted": "$410.02",
"minNoOfTravellersRequiredForPrice": 1,
"price": 484.99,
"priceFormatted": "$484.99",
"sortOrder": 1
}
],
"sortOrder": 1
},
{
"bandId": 3,
"maximumCountRequired": 9,
"minimumCountRequired": 0,
"prices": [
{
"currencyCode": "USD",
"merchantNetPrice": 0,
"merchantNetPriceFormatted": "$0.00",
"minNoOfTravellersRequiredForPrice": 1,
"price": 0,
"priceFormatted": "$0.00",
"sortOrder": 1
}
],
"sortOrder": 2
}
],
"bookingDate": "2020-03-03",
"pricingUnit": "per person",
"sortOrder": 1
}
],
"sortOrder": 6
},
{
"gradeCode": "TG2~09:45",
"gradeTitle": "Morning Departure; EC-130 09:45",
"pricingMatrix": [
{
"ageBandPrices": [
{
"bandId": 1,
"maximumCountRequired": 9,
"minimumCountRequired": 1,
"prices": [
{
"currencyCode": "USD",
"merchantNetPrice": 410.02,
"merchantNetPriceFormatted": "$410.02",
"minNoOfTravellersRequiredForPrice": 1,
"price": 484.99,
"priceFormatted": "$484.99",
"sortOrder": 1
}
],
"sortOrder": 1
},
{
"bandId": 3,
"maximumCountRequired": 9,
"minimumCountRequired": 0,
"prices": [
{
"currencyCode": "USD",
"merchantNetPrice": 0,
"merchantNetPriceFormatted": "$0.00",
"minNoOfTravellersRequiredForPrice": 1,
"price": 0,
"priceFormatted": "$0.00",
"sortOrder": 1
}
],
"sortOrder": 2
}
],
"bookingDate": "2020-03-03",
"pricingUnit": "per person",
"sortOrder": 1
}
],
"sortOrder": 7
},
{
"gradeCode": "TG2~10:45",
"gradeTitle": "Morning Departure; EC-130 10:45",
"pricingMatrix": [
{
"ageBandPrices": [
{
"bandId": 1,
"maximumCountRequired": 9,
"minimumCountRequired": 1,
"prices": [
{
"currencyCode": "USD",
"merchantNetPrice": 410.02,
"merchantNetPriceFormatted": "$410.02",
"minNoOfTravellersRequiredForPrice": 1,
"price": 484.99,
"priceFormatted": "$484.99",
"sortOrder": 1
}
],
"sortOrder": 1
},
{
"bandId": 3,
"maximumCountRequired": 9,
"minimumCountRequired": 0,
"prices": [
{
"currencyCode": "USD",
"merchantNetPrice": 0,
"merchantNetPriceFormatted": "$0.00",
"minNoOfTravellersRequiredForPrice": 1,
"price": 0,
"priceFormatted": "$0.00",
"sortOrder": 1
}
],
"sortOrder": 2
}
],
"bookingDate": "2020-03-03",
"pricingUnit": "per person",
"sortOrder": 1
}
],
"sortOrder": 8
},
{
"gradeCode": "TG3~12:30",
"gradeTitle": "Afternoon Departure; A-Star 12:30",
"pricingMatrix": [
{
"ageBandPrices": [
{
"bandId": 1,
"maximumCountRequired": 9,
"minimumCountRequired": 1,
"prices": [
{
"currencyCode": "USD",
"merchantNetPrice": 383.4,
"merchantNetPriceFormatted": "$383.40",
"minNoOfTravellersRequiredForPrice": 1,
"price": 449.99,
"priceFormatted": "$449.99",
"sortOrder": 1
}
],
"sortOrder": 1
},
{
"bandId": 3,
"maximumCountRequired": 9,
"minimumCountRequired": 0,
"prices": [
{
"currencyCode": "USD",
"merchantNetPrice": 0,
"merchantNetPriceFormatted": "$0.00",
"minNoOfTravellersRequiredForPrice": 1,
"price": 0,
"priceFormatted": "$0.00",
"sortOrder": 1
}
],
"sortOrder": 2
}
],
"bookingDate": "2020-03-03",
"pricingUnit": "per person",
"sortOrder": 1
}
],
"sortOrder": 9
},
{
"gradeCode": "TG3~13:30",
"gradeTitle": "Afternoon Departure; A-Star 13:30",
"pricingMatrix": [
{
"ageBandPrices": [
{
"bandId": 1,
"maximumCountRequired": 9,
"minimumCountRequired": 1,
"prices": [
{
"currencyCode": "USD",
"merchantNetPrice": 383.4,
"merchantNetPriceFormatted": "$383.40",
"minNoOfTravellersRequiredForPrice": 1,
"price": 449.99,
"priceFormatted": "$449.99",
"sortOrder": 1
}
],
"sortOrder": 1
},
{
"bandId": 3,
"maximumCountRequired": 9,
"minimumCountRequired": 0,
"prices": [
{
"currencyCode": "USD",
"merchantNetPrice": 0,
"merchantNetPriceFormatted": "$0.00",
"minNoOfTravellersRequiredForPrice": 1,
"price": 0,
"priceFormatted": "$0.00",
"sortOrder": 1
}
],
"sortOrder": 2
}
],
"bookingDate": "2020-03-03",
"pricingUnit": "per person",
"sortOrder": 1
}
],
"sortOrder": 10
},
{
"gradeCode": "TG4~12:30",
"gradeTitle": "Afternoon Departure; EC-130 12:30",
"pricingMatrix": [
{
"ageBandPrices": [
{
"bandId": 1,
"maximumCountRequired": 9,
"minimumCountRequired": 1,
"prices": [
{
"currencyCode": "USD",
"merchantNetPrice": 404.7,
"merchantNetPriceFormatted": "$404.70",
"minNoOfTravellersRequiredForPrice": 1,
"price": 474.99,
"priceFormatted": "$474.99",
"sortOrder": 1
}
],
"sortOrder": 1
},
{
"bandId": 3,
"maximumCountRequired": 9,
"minimumCountRequired": 0,
"prices": [
{
"currencyCode": "USD",
"merchantNetPrice": 0,
"merchantNetPriceFormatted": "$0.00",
"minNoOfTravellersRequiredForPrice": 1,
"price": 0,
"priceFormatted": "$0.00",
"sortOrder": 1
}
],
"sortOrder": 2
}
],
"bookingDate": "2020-03-03",
"pricingUnit": "per person",
"sortOrder": 1
}
],
"sortOrder": 11
},
{
"gradeCode": "TG4~13:30",
"gradeTitle": "Afternoon Departure; EC-130 13:30",
"pricingMatrix": [
{
"ageBandPrices": [
{
"bandId": 1,
"maximumCountRequired": 9,
"minimumCountRequired": 1,
"prices": [
{
"currencyCode": "USD",
"merchantNetPrice": 404.7,
"merchantNetPriceFormatted": "$404.70",
"minNoOfTravellersRequiredForPrice": 1,
"price": 474.99,
"priceFormatted": "$474.99",
"sortOrder": 1
}
],
"sortOrder": 1
},
{
"bandId": 3,
"maximumCountRequired": 9,
"minimumCountRequired": 0,
"prices": [
{
"currencyCode": "USD",
"merchantNetPrice": 0,
"merchantNetPriceFormatted": "$0.00",
"minNoOfTravellersRequiredForPrice": 1,
"price": 0,
"priceFormatted": "$0.00",
"sortOrder": 1
}
],
"sortOrder": 2
}
],
"bookingDate": "2020-03-03",
"pricingUnit": "per person",
"sortOrder": 1
}
],
"sortOrder": 12
}
]
}
],
"pricingUnit": "per person"
},
"dateStamp": "2020-02-10T18:17:58+0000",
"errorCodes": [],
"errorMessage": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorMessageText": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorName": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorReference": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorType": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"extraInfo": {},
"extraObject": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"success": true,
"totalCount": 1,
"vmid": "331003"
}
},
"booking-book-example": {
"summary": "booking book example",
"value": {
"data": {
"bookerEmail": "apitest@viator.com",
"bookingDate": "2020-02-11",
"bookingStatus": {
"amended": false,
"cancelled": false,
"confirmed": true,
"failed": false,
"level": "ITINERARY",
"pending": false,
"status": 3,
"text": "Confirmed",
"type": "CONFIRMED"
},
"currencyCode": "USD",
"distributorRef": "distributorRef100000",
"exchangeRate": 1,
"hasVoucher": true,
"itemSummaries": [
{
"applePassSupported": false,
"appleWalletURL": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"barcodeOption": "tour",
"barcodeType": "code128",
"bookingEngineId": "FO",
"bookingStatus": {
"amended": false,
"cancelled": false,
"confirmed": true,
"failed": false,
"level": "ITEM",
"pending": false,
"status": 1,
"text": "Paid &amp; Confirmed",
"type": "CONFIRMED"
},
"currencyCode": "USD",
"departsFrom": "Las Vegas, United States",
"departurePoint": "Traveler pickup is offered<br><br>",
"departurePointAddress": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"departurePointDirections": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"destId": 684,
"distributorItemRef": "itemRef1000000",
"hoursConfirmed": 0,
"itemId": 580669678,
"itineraryId": 1005851866,
"languageServicesLanguageCode": "en",
"lastRetailPrice": 388.72,
"lastRetailPriceFormatted": "$388.72",
"leadTravellerFirstname": "Homer test",
"leadTravellerSurname": "Simpson test",
"leadTravellerTitle": "Mr",
"merchantCancellable": true,
"merchantNetPrice": 388.72,
"merchantNetPriceFormatted": "$388.72",
"merchantTermsAndConditions": {
"amountRefundable": "USD 412.04",
"cancellationFromTourDate": [
{
"dayRangeMax": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"dayRangeMin": 1,
"percentageRefundable": 100,
"policyEndTimestamp": 1585580400,
"policyStartTimestamp": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
}
},
{
"dayRangeMax": 1,
"dayRangeMin": 0,
"percentageRefundable": 0,
"policyEndTimestamp": 1585666800,
"policyStartTimestamp": 1585580400
}
],
"merchantTermsAndConditionsType": 1,
"termsAndConditions": "For a full refund, cancel at least 24 hours in advance of the start date of the experience."
},
"obfsId": 362208,
"passbooks": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"pickupHotelId": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"pickupHotelName": "null",
"price": 412.04,
"priceFormatted": "$412.04",
"priceUSD": 412.04,
"productCode": "2280AAHT",
"productPulledDown": false,
"productTitle": "Grand Canyon All-American Helicopter Tour",
"productWidgetList": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"rnplInfo": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"rulesApplied": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"savingAmount": 0,
"savingAmountFormated": "$0.00",
"sortOrder": 0,
"startingTime": "8:00 AM",
"supplierName": "Sundance Helicopters",
"supplierPhoneNumber": "+1 123 456 7890",
"termsAndConditions": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"tourGradeCode": "TG1~08:00",
"tourGradeDescription": "Morning Departure; A-Star 08:00 (TG1~08:00)",
"travelDate": "2020-03-31",
"travellerAgeBands": [
{
"ageBandId": 1,
"count": 1,
"description": "Adult",
"pluralDescription": "Adults",
"sortOrder": 0
}
],
"voucherKey": "1005851866:4af44c13ecf3f1a7d3f9ef2fc00c2257e08fa42ae20f877f3039ff9b52aba24e:580669678",
"voucherOption": "VOUCHER_E",
"voucherRequirements": "You can present either a paper or an electronic voucher for this activity.",
"voucherURL": "https://viatorapi.live.rc.viator.com/service/merchant/voucher.jspa?code=1005851866:4af44c13ecf3f1a7d3f9ef2fc00c2257e08fa42ae20f877f3039ff9b52aba24e:580669678&embedResources=false",
"vouchers": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
}
}
],
"itineraryId": 1005851866,
"omniPreRuleList": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"paypalRedirectURL": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"rulesApplied": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"securityToken": "4af44c13ecf3f1a7d3f9ef2fc00c2257e08fa42ae20f877f3039ff9b52aba24e",
"sortOrder": 0,
"totalPrice": 412.04,
"totalPriceFormatted": "$412.04",
"totalPriceUSD": 412.04,
"userId": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"voucherKey": "1005851866:4af44c13ecf3f1a7d3f9ef2fc00c2257e08fa42ae20f877f3039ff9b52aba24e",
"voucherURL": "https://viatorapi.live.rc.viator.com/service/merchant/voucher.jspa?code=1005851866:4af44c13ecf3f1a7d3f9ef2fc00c2257e08fa42ae20f877f3039ff9b52aba24e&embedResources=false"
},
"dateStamp": "2020-02-11T16:55:47+0000",
"errorCodes": [],
"errorMessage": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorMessageText": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorName": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorReference": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorType": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"extraInfo": {},
"extraObject": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"success": true,
"totalCount": 1,
"vmid": "331003"
}
},
"booking-calculateprice-example": {
"summary": "booking calculateprice example",
"value": {
"data": {
"currencyCode": "USD",
"hasPromoCode": false,
"itinerary": {
"bookerEmail": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"bookingDate": "2020-02-10",
"bookingStatus": {
"amended": false,
"cancelled": false,
"confirmed": false,
"failed": false,
"level": "ITINERARY",
"pending": false,
"status": 0,
"text": "Waiting to be Booked",
"type": "WAITING"
},
"currencyCode": "USD",
"distributorRef": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"exchangeRate": 1,
"hasVoucher": false,
"itemSummaries": [
{
"applePassSupported": false,
"appleWalletURL": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"barcodeOption": "perperson",
"barcodeType": "qrcode",
"bookingEngineId": "UF",
"bookingStatus": {
"amended": false,
"cancelled": false,
"confirmed": false,
"failed": false,
"level": "ITEM",
"pending": false,
"status": 0,
"text": "Waiting to be Booked",
"type": "WAITING"
},
"currencyCode": "USD",
"departsFrom": "The Rocks, Australia",
"departurePoint": "You may start this tour at any of the stops listed.",
"departurePointAddress": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"departurePointDirections": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"destId": 357,
"distributorItemRef": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"hoursConfirmed": 0,
"itemId": 580659274,
"itineraryId": 1005847086,
"languageServicesLanguageCode": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"lastRetailPrice": 29.53,
"lastRetailPriceFormatted": "$29.53",
"leadTravellerFirstname": "",
"leadTravellerSurname": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"leadTravellerTitle": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"merchantCancellable": true,
"merchantNetPrice": 29.53,
"merchantNetPriceFormatted": "$29.53",
"obfsId": 31185,
"passbooks": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"pickupHotelId": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"pickupHotelName": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"price": 31.3,
"priceFormatted": "$31.30",
"priceUSD": 31.3,
"productCode": "5010SYDNEY",
"productPulledDown": false,
"productTitle": "Big Bus Sydney and Bondi Hop-on Hop-off Tour",
"productWidgetList": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"rnplInfo": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"rulesApplied": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"savingAmount": 0,
"savingAmountFormated": "$0.00",
"sortOrder": 0,
"startingTime": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"supplierName": "Big Bus Tours",
"supplierPhoneNumber": "+1 123 456 7890",
"termsAndConditions": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"tourGradeCode": "24HOUR",
"tourGradeDescription": "24 Hour Classic Ticket (24HOUR)",
"travelDate": "2020-03-03",
"travellerAgeBands": [
{
"ageBandId": 1,
"count": 1,
"description": "Adult",
"pluralDescription": "Adults",
"sortOrder": 0
}
],
"voucherKey": "",
"voucherOption": "VOUCHER_E",
"voucherRequirements": "You can present either a paper or an electronic voucher for this activity.",
"voucherURL": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"vouchers": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
}
}
],
"itineraryId": 1005847086,
"omniPreRuleList": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"paypalRedirectURL": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"rulesApplied": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"securityToken": "595798ee27965d5178ab6a800f9b796ed7efac8fd303086e4113e1e99848932c",
"sortOrder": 0,
"totalPrice": 31.3,
"totalPriceFormatted": "$31.30",
"totalPriceUSD": 31.3,
"userId": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"voucherKey": "",
"voucherURL": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
}
},
"itineraryFromPrice": 29.53,
"itineraryFromPriceFormatted": "$29.53",
"itineraryNewPrice": 29.53,
"itineraryNewPriceFormatted": "$29.53",
"itinerarySaving": 0,
"itinerarySavingFormatted": "$0.00",
"paymentGatewayInfo": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"promoCode": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"promoCodeExpired": false,
"promoCodeValid": false,
"rulesApplied": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
}
},
"dateStamp": "2020-02-10T18:26:49+0000",
"errorCodes": [],
"errorMessage": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorMessageText": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorName": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorReference": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorType": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"extraInfo": {},
"extraObject": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"success": true,
"totalCount": 1,
"vmid": "331003"
}
},
"booking-hotels-example-1": {
"summary": "destId",
"value": {
"data": [
{
"address": "35 Main St",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Hahndorf",
"destinationId": 123,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "1001419406",
"latitude": -35.031216,
"longitude": 138.81102,
"name": "The Hahndorf Inn",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "5245",
"productCodes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"sortOrder": 1
},
{
"address": "Lot 112 Neagles Rock Road",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Clare",
"destinationId": 123,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "10984108",
"latitude": -33.863453,
"longitude": 138.61,
"name": "Neagles Retreat Villas",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "5453",
"productCodes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"sortOrder": 2
},
{
"address": "310 Main North Rd",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Clare",
"destinationId": 123,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "11205163",
"latitude": -33.831417,
"longitude": 138.60942,
"name": "The Mill Apartments",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "5453",
"productCodes": [
"56243P2",
"56243P3",
"56243P6"
],
"sortOrder": 3
},
{
"address": "14 Bridge St, Old Reynella",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Reynella",
"destinationId": 123,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "1255430",
"latitude": -35.08964,
"longitude": 138.53828,
"name": "St. Francis Winery",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "5161",
"productCodes": [
"200245P1",
"200245P4",
"200245P5",
"200245P7",
"201625P1",
"215244P1",
"233580P1",
"233580P2",
"233580P4",
"238603P1"
],
"sortOrder": 4
},
{
"address": "Motel 574 Main North Rd",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Enfield",
"destinationId": 123,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "1255431",
"latitude": -34.845764,
"longitude": 138.60115,
"name": "Adelaide Manor",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "5094",
"productCodes": [
"119946P4",
"119946P5",
"119946P6",
"119946P8",
"120684P2",
"142696P2",
"142696P5",
"200245P1",
"200245P4",
"200245P5",
"200245P7",
"201625P1",
"215244P1",
"233580P1",
"233580P2",
"233580P4",
"238603P1",
"40887P5"
],
"sortOrder": 5
},
{
"address": "471 Main North Rd, ",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Enfield",
"destinationId": 123,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "1255432",
"latitude": -34.85016,
"longitude": 138.60077,
"name": "Comfort Inn Manhattan",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "5085",
"productCodes": [
"119946P4",
"119946P5",
"119946P6",
"119946P8",
"120684P2",
"142696P2",
"142696P5",
"200245P1",
"200245P4",
"200245P5",
"200245P7",
"201625P1",
"215244P1",
"233580P1",
"233580P2",
"233580P4",
"238603P1",
"40887P5"
],
"sortOrder": 6
},
{
"address": "Morphettville Motor Inn 444 - 446 Anzac Hwy",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Camden Park",
"destinationId": 123,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "1257946",
"latitude": -34.97334,
"longitude": 138.54086,
"name": "Morphettville Motor Inn",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "5038",
"productCodes": [
"119946P4",
"119946P5",
"119946P6",
"119946P8",
"119946P9",
"120684P2",
"142696P2",
"142696P5",
"200245P1",
"200245P4",
"200245P5",
"200245P7",
"201625P1",
"215244P1",
"233580P1",
"233580P2",
"233580P4",
"238603P1",
"40887P5"
],
"sortOrder": 7
},
{
"address": "1 Nottage Tce, ",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Medindie",
"destinationId": 123,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "1257951",
"latitude": -34.89378,
"longitude": 138.60353,
"name": "Comfort Inn Scottys",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "5081",
"productCodes": [
"119946P4",
"119946P5",
"119946P6",
"119946P8",
"119946P9",
"120684P2",
"120684P5",
"142696P2",
"142696P5",
"200245P1",
"200245P4",
"200245P5",
"200245P7",
"201625P1",
"215244P1",
"233580P1",
"233580P2",
"233580P4",
"238603P1",
"40887P5"
],
"sortOrder": 8
},
{
"address": "White Hut Road, ",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Clare",
"destinationId": 123,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "1262285",
"latitude": -33.820854,
"longitude": 138.61382,
"name": "Clare Country Club",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "5453",
"productCodes": [
"56243P2",
"56243P3",
"56243P6"
],
"sortOrder": 9
},
{
"address": "74a Main North Rd, ",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Clare",
"destinationId": 123,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "1262636",
"latitude": -33.848263,
"longitude": 138.6178,
"name": "Clare Valley Motel",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "5453",
"productCodes": [
"56243P2",
"56243P3",
"56243P6"
],
"sortOrder": 10
},
{
"address": "Quarry Rd, Sevenhill via Clare Valley",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Clare",
"destinationId": 123,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "1289197",
"latitude": -33.87362,
"longitude": 138.6354,
"name": "Thorn Park by the Vines",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "5453",
"productCodes": [
"56243P2",
"56243P3",
"56243P6"
],
"sortOrder": 11
},
{
"address": "141 Brebner Dr",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "West Lakes",
"destinationId": 123,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "1301167",
"latitude": -34.88005,
"longitude": 138.48842,
"name": "Lakes Hotel",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "5021",
"productCodes": [
"142696P5",
"200245P1",
"200245P4",
"200245P5",
"200245P7",
"201625P1",
"215244P1",
"233580P1",
"233580P2",
"233580P4",
"238603P1",
"40887P5"
],
"sortOrder": 12
},
{
"address": "198 Esplanade",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Largs Bay",
"destinationId": 123,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "1301173",
"latitude": -34.825584,
"longitude": 138.4865,
"name": "Largs Pier Hotel - Motel",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "5016",
"productCodes": [
"200245P1",
"200245P4",
"200245P5",
"200245P7",
"201625P1",
"215244P1",
"233580P1",
"233580P2",
"233580P4",
"238603P1"
],
"sortOrder": 13
},
{
"address": "24 Dequetteville Tce",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Kent Town",
"destinationId": 123,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "1301183",
"latitude": -34.924698,
"longitude": 138.6194,
"name": "Adelaide Royal Coach",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "5067",
"productCodes": [
"119946P4",
"119946P5",
"119946P6",
"119946P8",
"119946P9",
"120684P2",
"120684P5",
"142696P2",
"142696P5",
"196440P1",
"19852P6",
"200245P1",
"200245P4",
"200245P5",
"200245P7",
"201625P1",
"21300P2",
"215244P1",
"233580P1",
"233580P2",
"233580P4",
"238603P1",
"40887P5",
"40887P6",
"65854P1",
"65854P2",
"65854P3",
"65854P6",
"6763ULTIMATE",
"67705P1",
"67705P2"
],
"sortOrder": 14
},
{
"address": "540 Marion Rd",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Marion",
"destinationId": 123,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "1320631",
"latitude": -34.97743,
"longitude": 138.55557,
"name": "Marion Motel and Apartments",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "5038",
"productCodes": [
"119946P4",
"119946P5",
"119946P6",
"119946P8",
"119946P9",
"120684P2",
"142696P2",
"142696P5",
"200245P1",
"200245P4",
"200245P5",
"200245P7",
"201625P1",
"215244P1",
"233580P1",
"233580P2",
"233580P4",
"238603P1",
"40887P5"
],
"sortOrder": 15
},
{
"address": "17 Colley Tce, ",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Glenelg",
"destinationId": 123,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "1579776",
"latitude": -34.97872,
"longitude": 138.51253,
"name": "Glenelg Beachside Apartments",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "5045",
"productCodes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"sortOrder": 16
},
{
"address": "373 Glen Osmond Rd, ",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Glen Osmond",
"destinationId": 123,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "1584919",
"latitude": -34.9604,
"longitude": 138.64185,
"name": "Jacksons Motor Inn",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "5064",
"productCodes": [
"119946P4",
"119946P5",
"119946P6",
"119946P8",
"119946P9",
"120684P2",
"142696P2",
"142696P5",
"200245P1",
"200245P4",
"200245P5",
"200245P7",
"201625P1",
"215244P1",
"233580P1",
"233580P2",
"233580P4",
"238603P1",
"40887P5"
],
"sortOrder": 17
},
{
"address": "288-292 Main North Rd",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Prospect",
"destinationId": 123,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "1589097",
"latitude": -34.87285,
"longitude": 138.60158,
"name": "Comfort Inn & Suites Sombrero",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "5082",
"productCodes": [
"119946P4",
"119946P5",
"119946P6",
"119946P8",
"120684P2",
"142696P2",
"142696P5",
"200245P1",
"200245P4",
"200245P5",
"200245P7",
"201625P1",
"215244P1",
"233580P1",
"233580P2",
"233580P4",
"238603P1",
"40887P5"
],
"sortOrder": 18
},
{
"address": "Warenda Road, ",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Clare",
"destinationId": 123,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "1626470",
"latitude": -33.854675,
"longitude": 138.62292,
"name": "Brice Hill Country Lodge",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "5453",
"productCodes": [
"56243P2",
"56243P3",
"56243P6"
],
"sortOrder": 19
},
{
"address": "Clare Valley, ",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Clare",
"destinationId": 123,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "1630042",
"latitude": -33.84362,
"longitude": 138.63342,
"name": "Springfarm Cottage",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "",
"productCodes": [
"56243P2",
"56243P3",
"56243P6"
],
"sortOrder": 20
},
{
"address": "647 North East Rd, ",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Gilles Plains",
"destinationId": 123,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "1633907",
"latitude": -34.852222,
"longitude": 138.665,
"name": "Highlander Hotel Bar Kitchen Rooftop",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "5086",
"productCodes": [
"142696P5",
"200245P1",
"200245P4",
"200245P5",
"200245P7",
"201625P1",
"215244P1",
"233580P1",
"233580P2",
"233580P4",
"238603P1",
"40887P5"
],
"sortOrder": 21
},
{
"address": "277 Glen Osmond Road, ",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Frewville",
"destinationId": 123,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "1661623",
"latitude": -34.95136,
"longitude": 138.63423,
"name": "Welcome Inn 277",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "5063",
"productCodes": [
"119946P4",
"119946P5",
"119946P6",
"119946P8",
"119946P9",
"120684P2",
"120684P5",
"142696P2",
"142696P5",
"200245P1",
"200245P4",
"200245P5",
"200245P7",
"201625P1",
"215244P1",
"233580P1",
"233580P2",
"233580P4",
"238603P1",
"40887P5"
],
"sortOrder": 22
},
{
"address": "325 Main North Rd, ",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Clare",
"destinationId": 123,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "1729496",
"latitude": -33.829445,
"longitude": 138.60802,
"name": "Comfort Inn Clare Central",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "5453",
"productCodes": [
"56243P2",
"56243P3",
"56243P6"
],
"sortOrder": 23
},
{
"address": "73 St Andrews Bvd, ",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Normanville",
"destinationId": 123,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "1803904",
"latitude": -35.46194,
"longitude": 138.31508,
"name": "Links Lady Bay Resort",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "5204",
"productCodes": [
"200245P4"
],
"sortOrder": 24
},
{
"address": "406 Sir Donald Bradman Dr, ",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Brooklyn Park",
"destinationId": 123,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "2076447",
"latitude": -34.93242,
"longitude": 138.5395,
"name": "Adelaide Airport Motel",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "5032",
"productCodes": [
"119946P4",
"119946P5",
"119946P6",
"119946P8",
"119946P9",
"120684P2",
"142696P2",
"142696P5",
"200245P1",
"200245P4",
"200245P5",
"200245P7",
"201625P1",
"21300P1",
"21300P7",
"21300P9",
"215244P1",
"233580P1",
"233580P2",
"233580P4",
"238603P1",
"40887P5"
],
"sortOrder": 25
},
{
"address": "10 Main St",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Mawson Lakes",
"destinationId": 123,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "2122469",
"latitude": -34.80973,
"longitude": 138.61734,
"name": "Mawson Lakes Hotel",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "5095",
"productCodes": [
"142696P5",
"200245P1",
"200245P4",
"200245P5",
"200245P7",
"201625P1",
"215244P1",
"233580P1",
"233580P2",
"233580P4",
"238603P1"
],
"sortOrder": 26
},
{
"address": "647 North East Rd, ",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Gilles Plains",
"destinationId": 123,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "2218971",
"latitude": -34.85213,
"longitude": 138.6651,
"name": "Comfort Inn Riverfront Berriedale",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "5086",
"productCodes": [
"142696P5",
"200245P1",
"200245P4",
"200245P5",
"200245P7",
"201625P1",
"215244P1",
"233580P1",
"233580P2",
"233580P4",
"238603P1",
"40887P5"
],
"sortOrder": 27
},
{
"address": "72 Warenda Rd",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Clare",
"destinationId": 123,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "2453318",
"latitude": -33.856297,
"longitude": 138.62358,
"name": "St Helens Country Cottages",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "5453",
"productCodes": [
"56243P2",
"56243P3",
"56243P6"
],
"sortOrder": 28
},
{
"address": "190 Gover St, ",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"destinationId": 123,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "2479967",
"latitude": -34.904903,
"longitude": 138.5927,
"name": "North Adelaide Boutique Stays Accommodation",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "5006",
"productCodes": [
"21300P1",
"21300P11",
"21300P14",
"21300P6",
"21300P7",
"21300P9"
],
"sortOrder": 29
},
{
"address": "199 Glen Osmond Rd, ",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Frewville",
"destinationId": 123,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "2482535",
"latitude": -34.94779,
"longitude": 138.62839,
"name": "Frewville Motor Inn",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "5063",
"productCodes": [
"119946P4",
"119946P5",
"119946P6",
"119946P8",
"119946P9",
"120684P2",
"120684P5",
"142696P2",
"142696P5",
"200245P1",
"200245P4",
"200245P5",
"200245P7",
"201625P1",
"215244P1",
"233580P1",
"233580P2",
"233580P4",
"238603P1",
"40887P5",
"6763ULTIMATE"
],
"sortOrder": 30
},
{
"address": "493 Portrush Rd",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Glenunga",
"destinationId": 123,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "2501758",
"latitude": -34.94681,
"longitude": 138.6427,
"name": "Best Western Adelaide Granada Motor Inn",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "5064",
"productCodes": [
"119946P4",
"119946P5",
"119946P6",
"119946P8",
"119946P9",
"120684P2",
"120684P5",
"142696P2",
"142696P5",
"200245P1",
"200245P4",
"200245P5",
"200245P7",
"201625P1",
"215244P1",
"233580P1",
"233580P2",
"233580P4",
"238603P1",
"40887P5"
],
"sortOrder": 31
},
{
"address": "33 - 37 Main St",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Mawson Lakes",
"destinationId": 123,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "2575802",
"latitude": -34.806805,
"longitude": 138.61667,
"name": "Quest Mawson Lakes",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "5095",
"productCodes": [
"142696P5",
"200245P1",
"200245P4",
"200245P5",
"200245P7",
"201625P1",
"21300P10",
"215244P1",
"233580P1",
"233580P2",
"233580P4",
"238603P1"
],
"sortOrder": 32
},
{
"address": "859 Main North Rd, ",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Pooraka",
"destinationId": 123,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "2628301",
"latitude": -34.82837,
"longitude": 138.61504,
"name": "Pavlos Motel",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "5095",
"productCodes": [
"142696P5",
"200245P1",
"200245P4",
"200245P5",
"200245P7",
"201625P1",
"215244P1",
"233580P1",
"233580P2",
"233580P4",
"238603P1",
"40887P5"
],
"sortOrder": 33
},
{
"address": "23-25 Church St, ",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Penola",
"destinationId": 123,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "2640160",
"latitude": -37.381992,
"longitude": 140.83783,
"name": "Alexander Cameron Suites",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "5277",
"productCodes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"sortOrder": 34
},
{
"address": "151 St Georges Tce",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Clare",
"destinationId": 123,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "2773041",
"latitude": -33.82023,
"longitude": 138.58174,
"name": "Patly Hill Farm",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "5453",
"productCodes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"sortOrder": 35
},
{
"address": "corner of South & West Terrace, ",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Stansbury",
"destinationId": 123,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "2774580",
"latitude": -34.91078,
"longitude": 137.79254,
"name": "Oyster Court Motel & Holiday Units",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "5582",
"productCodes": [
"200245P4"
],
"sortOrder": 36
},
{
"address": "1274 South Rd, Adelaide",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Tonsley",
"destinationId": 123,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "2786536",
"latitude": -35.00457,
"longitude": 138.5747,
"name": "Tonsley Hotel Motel",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "5042",
"productCodes": [
"119946P4",
"119946P5",
"119946P6",
"119946P8",
"119946P9",
"120684P2",
"142696P2",
"142696P5",
"200245P1",
"200245P4",
"200245P5",
"200245P7",
"201625P1",
"215244P1",
"233580P1",
"233580P2",
"233580P4",
"238603P1",
"40887P5"
],
"sortOrder": 37
},
{
"address": "445 Torrens Rd, ",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Woodville Park",
"destinationId": 123,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "2853212",
"latitude": -34.87638,
"longitude": 138.54959,
"name": "Lindy Lodge Motel",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "5011",
"productCodes": [
"119946P4",
"119946P5",
"119946P6",
"119946P8",
"120684P2",
"142696P2",
"142696P5",
"200245P1",
"200245P4",
"200245P5",
"200245P7",
"201625P1",
"215244P1",
"233580P1",
"233580P2",
"233580P4",
"238603P1",
"40887P5"
],
"sortOrder": 38
},
{
"address": "516 Glynburn Rd",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Burnside",
"destinationId": 123,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "3002527",
"latitude": -34.93765,
"longitude": 138.66063,
"name": "The Feathers Hotel",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "5066",
"productCodes": [
"119946P4",
"119946P5",
"119946P6",
"119946P8",
"120684P2",
"142696P2",
"142696P5",
"200245P1",
"200245P4",
"200245P5",
"200245P7",
"201625P1",
"215244P1",
"233580P1",
"233580P2",
"233580P4",
"238603P1",
"40887P5"
],
"sortOrder": 39
},
{
"address": "20 Mount Barker Rd, (Corner Gill Terrace)",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Glen Osmond",
"destinationId": 123,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "3235180",
"latitude": -34.9643,
"longitude": 138.6466,
"name": "Tollgate Motel",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "5064",
"productCodes": [
"119946P4",
"119946P5",
"119946P6",
"119946P8",
"119946P9",
"120684P2",
"142696P2",
"142696P5",
"200245P1",
"200245P4",
"200245P5",
"200245P7",
"201625P1",
"215244P1",
"233580P1",
"233580P2",
"233580P4",
"238603P1",
"40887P5"
],
"sortOrder": 40
},
{
"address": "9 Warenda Rd, ",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Clare",
"destinationId": 123,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "3240942",
"latitude": -33.846573,
"longitude": 138.62152,
"name": "Riesling Trail and Clare Valley Cottages",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "5453",
"productCodes": [
"56243P2",
"56243P3",
"56243P6"
],
"sortOrder": 41
},
{
"address": "Sevenhill, ",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Clare",
"destinationId": 123,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "3281019",
"latitude": -33.90826,
"longitude": 138.6238,
"name": "Skillogalee Cottages",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "5453",
"productCodes": [
"56243P2",
"56243P3",
"56243P6"
],
"sortOrder": 42
},
{
"address": "191 Main North Rd, ",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Clare",
"destinationId": 123,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "3516966",
"latitude": -33.835503,
"longitude": 138.61389,
"name": "Bentleys Hotel Motel",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "5453",
"productCodes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"sortOrder": 43
},
{
"address": "220 Spring Gully Rd, ",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Clare",
"destinationId": 123,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "3668974",
"latitude": -33.866726,
"longitude": 138.59903,
"name": "Clare View Accommodation",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "5453",
"productCodes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"sortOrder": 44
},
{
"address": "Motel 393 Main North Rd",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Enfield",
"destinationId": 123,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "4257826",
"latitude": -34.86265,
"longitude": 138.60156,
"name": "Enfield Motel",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "5085",
"productCodes": [
"119946P4",
"119946P5",
"119946P6",
"119946P8",
"120684P2",
"142696P2",
"142696P5",
"200245P1",
"200245P4",
"200245P5",
"200245P7",
"201625P1",
"215244P1",
"233580P1",
"233580P2",
"233580P4",
"238603P1",
"40887P5"
],
"sortOrder": 45
},
{
"address": "Lot 136 Main North Road",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Clare",
"destinationId": 123,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "4345469",
"latitude": -33.864716,
"longitude": 138.62134,
"name": "Discovery Parks - Clare",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "5453",
"productCodes": [
"56243P2",
"56243P3",
"56243P6"
],
"sortOrder": 46
},
{
"address": "16-28 Adelaide Rd",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Stansbury",
"destinationId": 123,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "4856431",
"latitude": -34.903656,
"longitude": 137.79562,
"name": "Stansbury Holiday Motel",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "5582",
"productCodes": [
"200245P4"
],
"sortOrder": 47
},
{
"address": "135 Esplanade, cnr Jetty Rd",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Brighton",
"destinationId": 123,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "4861044",
"latitude": -35.01719,
"longitude": 138.51463,
"name": "Esplanade Hotel Adelaide",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "5048",
"productCodes": [
"181322P2"
],
"sortOrder": 48
},
{
"address": "off Gaelic Cemetery Road, Stanley Flat",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Clare",
"destinationId": 123,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "4971218",
"latitude": -33.78769,
"longitude": 138.60567,
"name": "Wuthering Heights",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "5034",
"productCodes": [
"56243P2",
"56243P3",
"56243P6"
],
"sortOrder": 49
},
{
"address": "431 Bungaree Road, (Off Highway B82)",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Clare",
"destinationId": 123,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "5004100",
"latitude": -33.7714,
"longitude": 138.5837,
"name": "Bungaree Station",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "5453",
"productCodes": [
"56243P2",
"56243P3",
"56243P6"
],
"sortOrder": 50
},
{
"address": "18 Victoria Rd",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Clare",
"destinationId": 123,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "6029450",
"latitude": -33.83657,
"longitude": 138.61197,
"name": "Clare Valley Heritage Retreat",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "5453",
"productCodes": [
"56243P2",
"56243P3",
"56243P6"
],
"sortOrder": 51
},
{
"address": "29 Hope St",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Clare",
"destinationId": 123,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "6461957",
"latitude": -33.83995,
"longitude": 138.61311,
"name": "The Reserve Apartment",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "5453",
"productCodes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"sortOrder": 52
},
{
"address": "The Watson 33 Warwick St",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Walkerville",
"destinationId": 123,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "7755816",
"latitude": -34.896725,
"longitude": 138.61743,
"name": "The Watson Adelaide - Art Series",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "5081",
"productCodes": [
"119946P4",
"119946P5",
"119946P6",
"119946P8",
"119946P9",
"120684P2",
"120684P5",
"142696P2",
"142696P5",
"200245P1",
"200245P4",
"200245P5",
"200245P7",
"201625P1",
"215244P1",
"233580P1",
"233580P2",
"233580P4",
"238603P1",
"40887P5"
],
"sortOrder": 53
},
{
"address": "Moana Tourist Park 44 Nashwauk Cres",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Moana",
"destinationId": 123,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "7870501",
"latitude": -35.19921,
"longitude": 138.47296,
"name": "Moana Beach Tourist Park",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "5169",
"productCodes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"sortOrder": 54
}
],
"dateStamp": "2020-02-10T18:33:02+0000",
"errorCodes": [],
"errorMessage": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorMessageText": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorName": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorReference": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorType": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"extraInfo": {},
"extraObject": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"success": true,
"totalCount": 1,
"vmid": "331004"
}
},
"booking-hotels-example-2": {
"summary": "productCode",
"value": {
"data": [
{
"address": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"destinationId": 0,
"hotelString": "I live locally / I'm staying with friends, relatives",
"id": "local",
"latitude": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"longitude": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"name": "I live locally / I'm staying with friends, relatives",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"postcode": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"productCodes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"sortOrder": 1
},
{
"address": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"destinationId": 0,
"hotelString": "My hotel is not yet booked",
"id": "notBooked",
"latitude": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"longitude": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"name": "My hotel is not yet booked",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"postcode": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"productCodes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"sortOrder": 2
},
{
"address": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"destinationId": 0,
"hotelString": "My hotel is not listed",
"id": "notListed",
"latitude": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"longitude": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"name": "My hotel is not listed",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"postcode": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"productCodes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"sortOrder": 3
},
{
"address": "3730 Las Vegas Boulevard South, ",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Las Vegas",
"destinationId": 684,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "1091925",
"latitude": 36.107323,
"longitude": -115.17628,
"name": "ARIA Resort & Casino",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "89158-4300",
"productCodes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"sortOrder": 4
},
{
"address": "3645 Las Vegas Blvd S, ",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Las Vegas",
"destinationId": 684,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "1121312",
"latitude": 36.113705,
"longitude": -115.16985,
"name": "Bally's Las Vegas Hotel & Casino",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "89109-4321",
"productCodes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"sortOrder": 5
},
{
"address": "3600 Las Vegas Blvd S",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Las Vegas",
"destinationId": 684,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "1091703",
"latitude": 36.112026,
"longitude": -115.175285,
"name": "Bellagio Las Vegas",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "89109-4303",
"productCodes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"sortOrder": 6
},
{
"address": "3570 Las Vegas Blvd South, ",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Las Vegas",
"destinationId": 684,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "1091762",
"latitude": 36.115753,
"longitude": -115.174446,
"name": "Caesars Palace",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "89109-8933",
"productCodes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"sortOrder": 7
},
{
"address": "2880 Las Vegas Blvd S, ",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Las Vegas",
"destinationId": 684,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "1091770",
"latitude": 36.13704,
"longitude": -115.16351,
"name": "Circus Circus Hotel & Casino Las Vegas",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "89109-1138",
"productCodes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"sortOrder": 8
},
{
"address": "3940 S Las Vegas Blvd",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Las Vegas",
"destinationId": 684,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "1496876",
"latitude": 36.093147,
"longitude": -115.17744,
"name": "Delano Las Vegas",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "89119-1002",
"productCodes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"sortOrder": 9
},
{
"address": "206 N. 3rd Street",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Las Vegas",
"destinationId": 684,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "5790631",
"latitude": 36.17198,
"longitude": -115.14171,
"name": "Downtown Grand",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "89101-2931",
"productCodes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"sortOrder": 10
},
{
"address": "600 East Fremont Street, ",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Las Vegas",
"destinationId": 684,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "1111692",
"latitude": 36.169106,
"longitude": -115.139015,
"name": "El Cortez Hotel & Casino",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "89101-5614",
"productCodes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"sortOrder": 11
},
{
"address": "80 East Harmon Avenue, ",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Las Vegas",
"destinationId": 684,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "2639337",
"latitude": 36.108875,
"longitude": -115.16867,
"name": "Elara By Hilton Grand Vacations - Center Strip",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "89109-4539",
"productCodes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"sortOrder": 12
},
{
"address": "3131 Las Vegas Boulevard S, ",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Las Vegas",
"destinationId": 684,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "2123368",
"latitude": 36.128822,
"longitude": -115.1649,
"name": "Encore At Wynn Las Vegas",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "89109-1967",
"productCodes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"sortOrder": 13
},
{
"address": "3850 S Las Vegas Blvd, ",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Las Vegas",
"destinationId": 684,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "1097786",
"latitude": 36.098976,
"longitude": -115.17598,
"name": "Excalibur Hotel & Casino",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "89109-4300",
"productCodes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"sortOrder": 14
},
{
"address": "3555 Las Vegas Blvd S, ",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Las Vegas",
"destinationId": 684,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "1091844",
"latitude": 36.116383,
"longitude": -115.172195,
"name": "Flamingo Las Vegas Hotel & Casino",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "89109-8901",
"productCodes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"sortOrder": 15
},
{
"address": "200 Fremont St",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Las Vegas",
"destinationId": 684,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "1111699",
"latitude": 36.170788,
"longitude": -115.14377,
"name": "Fremont Hotel & Casino",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "89101-5622",
"productCodes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"sortOrder": 16
},
{
"address": "4000 W Flamingo Rd, ",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Las Vegas",
"destinationId": 684,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "1091823",
"latitude": 36.11706,
"longitude": -115.19205,
"name": "Gold Coast Hotel & Casino",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "89103-4088",
"productCodes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"sortOrder": 17
},
{
"address": "129 Fremont St, ",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Las Vegas",
"destinationId": 684,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "1091828",
"latitude": 36.17005,
"longitude": -115.145645,
"name": "Golden Nugget Hotel & Casino",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "89101-5603",
"productCodes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"sortOrder": 18
},
{
"address": "3475 Las Vegas Boulevard South, ",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Las Vegas",
"destinationId": 684,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "1114889",
"latitude": 36.119415,
"longitude": -115.17206,
"name": "Harrah's Las Vegas Hotel & Casino",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "89109-8922",
"productCodes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"sortOrder": 19
},
{
"address": "3575 Las Vegas Blvd S, ",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Las Vegas",
"destinationId": 684,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "1217597",
"latitude": 36.116592,
"longitude": -115.1696,
"name": "Hilton Grand Vacations at the Flamingo",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "89109-8919",
"productCodes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"sortOrder": 20
},
{
"address": "3950 Koval Ln, ",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Las Vegas",
"destinationId": 684,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "2164660",
"latitude": 36.11815,
"longitude": -115.16341,
"name": "Holiday Inn Club Vacations at Desert Club Resort",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "89109-4702",
"productCodes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"sortOrder": 21
},
{
"address": "3900 S Las Vegas Blvd, ",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Las Vegas",
"destinationId": 684,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "1111709",
"latitude": 36.09734,
"longitude": -115.17634,
"name": "Luxor Hotel & Casino",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "89119-1004",
"productCodes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"sortOrder": 22
},
{
"address": "3950 Las Vegas Boulevard South, ",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Las Vegas",
"destinationId": 684,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "1091886",
"latitude": 36.0959,
"longitude": -115.174095,
"name": "Mandalay Bay Resort & Casino",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "89119-1006",
"productCodes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"sortOrder": 23
},
{
"address": "75 East Harmon Avenue, ",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Las Vegas",
"destinationId": 684,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "1567617",
"latitude": 36.10761,
"longitude": -115.16966,
"name": "Marriott's Grand Chateau",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "89109",
"productCodes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"sortOrder": 24
},
{
"address": "3799 S Las Vegas Blvd",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Las Vegas",
"destinationId": 684,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "1091891",
"latitude": 36.102436,
"longitude": -115.16935,
"name": "MGM Grand Las Vegas",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "89109-4319",
"productCodes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"sortOrder": 25
},
{
"address": "3790 Las Vegas Boulevard South, ",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Las Vegas",
"destinationId": 684,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "1091904",
"latitude": 36.102093,
"longitude": -115.17433,
"name": "New York - New York Hotel and Casino",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "89109-4338",
"productCodes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"sortOrder": 26
},
{
"address": "115 E Tropicana Avenue, ",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Las Vegas",
"destinationId": 684,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "1600446",
"latitude": 36.10006,
"longitude": -115.167595,
"name": "OYO Las Vegas Hotel and Casino",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "89109-7304",
"productCodes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"sortOrder": 27
},
{
"address": "4321 West Flamingo Road, ",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Las Vegas",
"destinationId": 684,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "1208820",
"latitude": 36.114502,
"longitude": -115.19429,
"name": "Palms Casino Resort",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "89103-3903",
"productCodes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"sortOrder": 28
},
{
"address": "3655 Las Vegas Boulevard South, ",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Las Vegas",
"destinationId": 684,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "1143336",
"latitude": 36.11242,
"longitude": -115.17175,
"name": "Paris Las Vegas",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "89109-4345",
"productCodes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"sortOrder": 29
},
{
"address": "3770 S Las Vegas Blvd, South Part of the Strip, Next to NY Hotel",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Las Vegas",
"destinationId": 684,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "1097712",
"latitude": 36.132004,
"longitude": -115.16145,
"name": "Park MGM Las Vegas",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "89109-4337",
"productCodes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"sortOrder": 30
},
{
"address": "3667 Las Vegas Boulevard South, ",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Las Vegas",
"destinationId": 684,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "1091687",
"latitude": 36.110043,
"longitude": -115.17096,
"name": "Planet Hollywood Resort & Casino",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "89109-4331",
"productCodes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"sortOrder": 31
},
{
"address": "3745 Las Vegas Boulevard South, ",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Las Vegas",
"destinationId": 684,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "1091916",
"latitude": 36.106483,
"longitude": -115.17092,
"name": "Polo Towers Suites",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "89109-4308",
"productCodes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"sortOrder": 32
},
{
"address": "3700 W Flamingo, ",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Las Vegas",
"destinationId": 684,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "1091673",
"latitude": 36.1161,
"longitude": -115.18675,
"name": "Rio All-Suite Hotel & Casino",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "89103-4043",
"productCodes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"sortOrder": 33
},
{
"address": "145 East Harmon Avenue",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Las Vegas",
"destinationId": 684,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "1601419",
"latitude": 36.106987,
"longitude": -115.166756,
"name": "Signature at MGM Grand",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "89109-4504",
"productCodes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"sortOrder": 34
},
{
"address": "3708 Las Vegas Boulevard South, ",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Las Vegas",
"destinationId": 684,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "2829539",
"latitude": 36.109745,
"longitude": -115.17384,
"name": "The Cosmopolitan of Las Vegas, Autograph Collection",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "89109-4309",
"productCodes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"sortOrder": 35
},
{
"address": "3595 Las Vegas Boulevard South",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Las Vegas",
"destinationId": 684,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "7537691",
"latitude": 36.114937,
"longitude": -115.172455,
"name": "The Cromwell Hotel Las Vegas",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "89109-8918",
"productCodes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"sortOrder": 36
},
{
"address": "301 Fremont Street, ",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Las Vegas",
"destinationId": 684,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "1091679",
"latitude": 36.169464,
"longitude": -115.142784,
"name": "The D Casino Hotel Las Vegas",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "89101-5600",
"productCodes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"sortOrder": 37
},
{
"address": "3535 Las Vegas Blvd S, ",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Las Vegas",
"destinationId": 684,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "1186114",
"latitude": 36.118,
"longitude": -115.17194,
"name": "The LINQ Hotel & Casino",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "89109-8921",
"productCodes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"sortOrder": 38
},
{
"address": "3400 Las Vegas Blvd. S., ",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Las Vegas",
"destinationId": 684,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "1097737",
"latitude": 36.121216,
"longitude": -115.17343,
"name": "The Mirage Hotel & Casino",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "89109-8923",
"productCodes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"sortOrder": 39
},
{
"address": "3325 Las Vegas Blvd South, ",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Las Vegas",
"destinationId": 684,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "1675000",
"latitude": 36.12396,
"longitude": -115.16791,
"name": "The Palazzo at The Venetian",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "89109-1414",
"productCodes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"sortOrder": 40
},
{
"address": "2000 Las Vegas Boulevard South, ",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Las Vegas",
"destinationId": 684,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "1114898",
"latitude": 36.147305,
"longitude": -115.155594,
"name": "The STRAT Hotel, Casino & SkyPod",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "89104-2507",
"productCodes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"sortOrder": 41
},
{
"address": "3355 Las Vegas Blvd S, ",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Las Vegas",
"destinationId": 684,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "1097704",
"latitude": 36.121475,
"longitude": -115.16994,
"name": "The Venetian Resort",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "89109-8941",
"productCodes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"sortOrder": 42
},
{
"address": "3300 Las Vegas Blvd S, ",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Las Vegas",
"destinationId": 684,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "1091967",
"latitude": 36.123917,
"longitude": -115.17123,
"name": "Treasure Island Hotel & Casino",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "89109-8916",
"productCodes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"sortOrder": 43
},
{
"address": "3801 Las Vegas Blvd South, ",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Las Vegas",
"destinationId": 684,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "1097730",
"latitude": 36.09878,
"longitude": -115.17033,
"name": "Tropicana Las Vegas - A DoubleTree by Hilton Hotel",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "89109-4325",
"productCodes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"sortOrder": 44
},
{
"address": "2000 Fashion Show Drive, ",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Las Vegas",
"destinationId": 684,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "2022061",
"latitude": 36.12944,
"longitude": -115.17272,
"name": "Trump International Hotel Las Vegas",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "89109-1936",
"productCodes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"sortOrder": 45
},
{
"address": "255 East Flamingo Road, ",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Las Vegas",
"destinationId": 684,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "1224853",
"latitude": 36.113308,
"longitude": -115.160835,
"name": "Tuscany Suites & Casino",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "89169-4708",
"productCodes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"sortOrder": 46
},
{
"address": "2600 W. Harmon Avenue, ",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Las Vegas",
"destinationId": 684,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "2474086",
"latitude": 36.109516,
"longitude": -115.17793,
"name": "Vdara Hotel & Spa at ARIA Las Vegas",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "89158-4538",
"productCodes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"sortOrder": 47
},
{
"address": "3752 S Las Vegas Blvd S\n\n, ",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Las Vegas",
"destinationId": 684,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "2456410",
"latitude": 36.106415,
"longitude": -115.17404,
"name": "Waldorf Astoria Las Vegas",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "89158-4382",
"productCodes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"sortOrder": 48
},
{
"address": "3131 Las Vegas Boulevard South, ",
"brand": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"city": "Las Vegas",
"destinationId": 684,
"hotelString": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"id": "1503598",
"latitude": 36.126553,
"longitude": -115.16552,
"name": "Wynn Las Vegas",
"notes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"phone": "+1 123 456 7890",
"postcode": "89109-1967",
"productCodes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"sortOrder": 49
}
],
"dateStamp": "2020-02-10T18:29:35+0000",
"errorCodes": [],
"errorMessage": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorMessageText": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorName": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorReference": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorType": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"extraInfo": {},
"extraObject": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"success": true,
"totalCount": 1,
"vmid": "331005"
}
},
"booking-mybookings-example": {
"summary": "booking mybookings example",
"value": {
"data": [
{
"bookerEmail": "apitest@viator.com",
"bookingDate": "2020-02-11",
"bookingStatus": {
"amended": false,
"cancelled": false,
"confirmed": true,
"failed": false,
"level": "ITINERARY",
"pending": false,
"status": 3,
"text": "Confirmed",
"type": "CONFIRMED"
},
"currencyCode": "USD",
"distributorRef": "distributorRef100000",
"exchangeRate": 1,
"hasVoucher": true,
"itemSummaries": [
{
"applePassSupported": false,
"appleWalletURL": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"barcodeOption": "tour",
"barcodeType": "code128",
"bookingEngineId": "FO",
"bookingStatus": {
"amended": false,
"cancelled": false,
"confirmed": true,
"failed": false,
"level": "ITEM",
"pending": false,
"status": 1,
"text": "Paid &amp; Confirmed",
"type": "CONFIRMED"
},
"currencyCode": "USD",
"departsFrom": "Las Vegas, United States",
"departurePoint": "Traveler pickup is offered<br><br>",
"departurePointAddress": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"departurePointDirections": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"destId": 684,
"distributorItemRef": "itemRef1000000",
"hoursConfirmed": 0,
"itemId": 580669678,
"itineraryId": 1005851866,
"languageServicesLanguageCode": "en",
"lastRetailPrice": 388.72,
"lastRetailPriceFormatted": "$388.72",
"leadTravellerFirstname": "Homer test",
"leadTravellerSurname": "Simpson test",
"leadTravellerTitle": "Mr",
"merchantCancellable": true,
"merchantNetPrice": 388.72,
"merchantNetPriceFormatted": "$388.72",
"merchantTermsAndConditions": {
"amountRefundable": "USD 412.04",
"cancellationFromTourDate": [
{
"dayRangeMax": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"dayRangeMin": 1,
"percentageRefundable": 100,
"policyEndTimestamp": 1585580400,
"policyStartTimestamp": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
}
},
{
"dayRangeMax": 1,
"dayRangeMin": 0,
"percentageRefundable": 0,
"policyEndTimestamp": 1585666800,
"policyStartTimestamp": 1585580400
}
],
"merchantTermsAndConditionsType": 1,
"termsAndConditions": "For a full refund, cancel at least 24 hours in advance of the start date of the experience."
},
"obfsId": 362208,
"passbooks": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"pickupHotelId": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"pickupHotelName": "null",
"price": 412.04,
"priceFormatted": "$412.04",
"priceUSD": 412.04,
"productCode": "2280AAHT",
"productPulledDown": false,
"productTitle": "Grand Canyon All-American Helicopter Tour",
"productWidgetList": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"rnplInfo": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"rulesApplied": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"savingAmount": 0,
"savingAmountFormated": "$0.00",
"sortOrder": 0,
"startingTime": "8:00 AM",
"supplierName": "Sundance Helicopters",
"supplierPhoneNumber": "+1 123 456 7890",
"termsAndConditions": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"tourGradeCode": "TG1~08:00",
"tourGradeDescription": "Morning Departure; A-Star 08:00 (TG1~08:00)",
"travelDate": "2020-03-31",
"travellerAgeBands": [
{
"ageBandId": 1,
"count": 1,
"description": "Adult",
"pluralDescription": "Adults",
"sortOrder": 0
}
],
"voucherKey": "1005851866:4af44c13ecf3f1a7d3f9ef2fc00c2257e08fa42ae20f877f3039ff9b52aba24e:580669678",
"voucherOption": "VOUCHER_E",
"voucherRequirements": "You can present either a paper or an electronic voucher for this activity.",
"voucherURL": "https://viatorapi.live.rc.viator.com/service/merchant/voucher.jspa?code=1005851866:4af44c13ecf3f1a7d3f9ef2fc00c2257e08fa42ae20f877f3039ff9b52aba24e:580669678&embedResources=false",
"vouchers": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
}
}
],
"itineraryId": 1005851866,
"omniPreRuleList": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"paypalRedirectURL": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"rulesApplied": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"securityToken": "4af44c13ecf3f1a7d3f9ef2fc00c2257e08fa42ae20f877f3039ff9b52aba24e",
"sortOrder": 1,
"totalPrice": 412.04,
"totalPriceFormatted": "$412.04",
"totalPriceUSD": 412.04,
"userId": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"voucherKey": "1005851866:4af44c13ecf3f1a7d3f9ef2fc00c2257e08fa42ae20f877f3039ff9b52aba24e",
"voucherURL": "https://viatorapi.live.rc.viator.com/service/merchant/voucher.jspa?code=1005851866:4af44c13ecf3f1a7d3f9ef2fc00c2257e08fa42ae20f877f3039ff9b52aba24e&embedResources=false"
}
],
"dateStamp": "2020-02-11T20:27:20+0000",
"errorCodes": [],
"errorMessage": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorMessageText": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorName": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorReference": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorType": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"extraInfo": {},
"extraObject": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"success": true,
"totalCount": 1,
"vmid": "331004"
}
},
"booking-pastbooking-example": {
"summary": "booking pastbooking example",
"value": {
"data": {
"bookerEmail": "apitest@viator.com",
"bookingDate": "2020-02-11",
"bookingStatus": {
"amended": false,
"cancelled": false,
"confirmed": true,
"failed": false,
"level": "ITINERARY",
"pending": false,
"status": 3,
"text": "Confirmed",
"type": "CONFIRMED"
},
"currencyCode": "USD",
"distributorRef": "distributorRef100000",
"exchangeRate": 1,
"hasVoucher": true,
"itemSummaries": [
{
"applePassSupported": false,
"appleWalletURL": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"barcodeOption": "tour",
"barcodeType": "code128",
"bookingEngineId": "FO",
"bookingStatus": {
"amended": false,
"cancelled": false,
"confirmed": true,
"failed": false,
"level": "ITEM",
"pending": false,
"status": 1,
"text": "Paid &amp; Confirmed",
"type": "CONFIRMED"
},
"currencyCode": "USD",
"departsFrom": "Las Vegas, United States",
"departurePoint": "Traveler pickup is offered<br><br>",
"departurePointAddress": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"departurePointDirections": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"destId": 684,
"distributorItemRef": "itemRef1000000",
"hoursConfirmed": 0,
"itemId": 580669678,
"itineraryId": 1005851866,
"languageServicesLanguageCode": "en",
"lastRetailPrice": 388.72,
"lastRetailPriceFormatted": "$388.72",
"leadTravellerFirstname": "Homer test",
"leadTravellerSurname": "Simpson test",
"leadTravellerTitle": "Mr",
"merchantCancellable": true,
"merchantNetPrice": 388.72,
"merchantNetPriceFormatted": "$388.72",
"merchantTermsAndConditions": {
"amountRefundable": "USD 412.04",
"cancellationFromTourDate": [
{
"dayRangeMax": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"dayRangeMin": 1,
"percentageRefundable": 100,
"policyEndTimestamp": 1585580400,
"policyStartTimestamp": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
}
},
{
"dayRangeMax": 1,
"dayRangeMin": 0,
"percentageRefundable": 0,
"policyEndTimestamp": 1585666800,
"policyStartTimestamp": 1585580400
}
],
"merchantTermsAndConditionsType": 1,
"termsAndConditions": "For a full refund, cancel at least 24 hours in advance of the start date of the experience."
},
"obfsId": 362208,
"passbooks": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"pickupHotelId": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"pickupHotelName": "null",
"price": 412.04,
"priceFormatted": "$412.04",
"priceUSD": 412.04,
"productCode": "2280AAHT",
"productPulledDown": false,
"productTitle": "Grand Canyon All-American Helicopter Tour",
"productWidgetList": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"rnplInfo": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"rulesApplied": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"savingAmount": 0,
"savingAmountFormated": "$0.00",
"sortOrder": 0,
"startingTime": "8:00 AM",
"supplierName": "Sundance Helicopters",
"supplierPhoneNumber": "+1 123 456 7890",
"termsAndConditions": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"tourGradeCode": "TG1~08:00",
"tourGradeDescription": "Morning Departure; A-Star 08:00 (TG1~08:00)",
"travelDate": "2020-03-31",
"travellerAgeBands": [
{
"ageBandId": 1,
"count": 1,
"description": "Adult",
"pluralDescription": "Adults",
"sortOrder": 0
}
],
"voucherKey": "1005851866:4af44c13ecf3f1a7d3f9ef2fc00c2257e08fa42ae20f877f3039ff9b52aba24e:580669678",
"voucherOption": "VOUCHER_E",
"voucherRequirements": "You can present either a paper or an electronic voucher for this activity.",
"voucherURL": "https://viatorapi.live.rc.viator.com/service/merchant/voucher.jspa?code=1005851866:4af44c13ecf3f1a7d3f9ef2fc00c2257e08fa42ae20f877f3039ff9b52aba24e:580669678&embedResources=false",
"vouchers": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
}
}
],
"itineraryId": 1005851866,
"omniPreRuleList": [],
"paypalRedirectURL": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"rulesApplied": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"securityToken": "4af44c13ecf3f1a7d3f9ef2fc00c2257e08fa42ae20f877f3039ff9b52aba24e",
"sortOrder": 0,
"totalPrice": 412.04,
"totalPriceFormatted": "$412.04",
"totalPriceUSD": 412.04,
"userId": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"voucherKey": "1005851866:4af44c13ecf3f1a7d3f9ef2fc00c2257e08fa42ae20f877f3039ff9b52aba24e",
"voucherURL": "https://viatorapi.live.rc.viator.com/service/merchant/voucher.jspa?code=1005851866:4af44c13ecf3f1a7d3f9ef2fc00c2257e08fa42ae20f877f3039ff9b52aba24e&embedResources=false"
},
"dateStamp": "2020-02-11T20:06:43+0000",
"errorCodes": [],
"errorMessage": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorMessageText": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorName": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorReference": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorType": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"extraInfo": {},
"extraObject": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"success": true,
"totalCount": 1,
"vmid": "331003"
}
},
"booking-pricingmatrix-example": {
"summary": "booking pricing matrix example",
"value": {
"data": [
{
"ageBandPrices": [
{
"bandId": 1,
"maximumCountRequired": 9,
"minimumCountRequired": 0,
"prices": [
{
"currencyCode": "EUR",
"merchantNetPrice": 26.64,
"merchantNetPriceFormatted": "€26,64",
"minNoOfTravellersRequiredForPrice": 1,
"price": 33.35,
"priceFormatted": "€33,35",
"sortOrder": 1
}
],
"sortOrder": 1
},
{
"bandId": 2,
"maximumCountRequired": 9,
"minimumCountRequired": 0,
"prices": [
{
"currencyCode": "EUR",
"merchantNetPrice": 18.06,
"merchantNetPriceFormatted": "€18,06",
"minNoOfTravellersRequiredForPrice": 1,
"price": 22.61,
"priceFormatted": "€22,61",
"sortOrder": 1
}
],
"sortOrder": 2
}
],
"bookingDate": "2020-03-11",
"pricingUnit": "per person",
"sortOrder": 1
}
],
"dateStamp": "2020-02-11T16:21:23+0000",
"errorCodes": [],
"errorMessage": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorMessageText": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorName": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorReference": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorType": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"extraInfo": {},
"extraObject": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"success": true,
"totalCount": 1,
"vmid": "331003"
}
},
"booking-status-example": {
"summary": "booking status example",
"value": {
"data": [
{
"bookingDate": "2020-02-11",
"bookingStatus": {
"amended": false,
"cancelled": false,
"confirmed": true,
"failed": false,
"level": "ITINERARY",
"pending": false,
"status": 3,
"text": "Confirmed",
"type": "CONFIRMED"
},
"distributorRef": "distributorRef100000",
"itemSummaries": [
{
"bookingStatus": {
"amended": false,
"cancelled": false,
"confirmed": true,
"failed": false,
"level": "ITEM",
"pending": false,
"status": 1,
"text": "Paid &amp; Confirmed",
"type": "CONFIRMED"
},
"distributorItemRef": "itemRef1000000",
"itemId": 580669678,
"itineraryId": 1005851866,
"sortOrder": 0,
"travelDate": "2020-03-31"
}
],
"itineraryId": 1005851866,
"sortOrder": 1
}
],
"dateStamp": "2020-02-11T18:38:25+0000",
"errorCodes": [],
"errorMessage": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorMessageText": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorName": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorReference": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorType": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"extraInfo": {},
"extraObject": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"success": true,
"totalCount": 1,
"vmid": "331004"
}
},
"booking-status-items-example": {
"summary": "booking status items example",
"value": {
"data": [
{
"bookingStatus": {
"amended": false,
"cancelled": false,
"confirmed": true,
"failed": false,
"level": "ITEM",
"pending": false,
"status": 1,
"text": "Paid &amp; Confirmed",
"type": "CONFIRMED"
},
"distributorItemRef": "itemRef1000000",
"itemId": 580669678
}
],
"dateStamp": "2020-02-11T19:03:06+0000",
"errorCodes": [],
"errorMessage": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorMessageText": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorName": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorReference": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorType": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"extraInfo": {},
"extraObject": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"success": true,
"totalCount": 1,
"vmid": "331001"
}
},
"booking-voucher-example": {
"summary": "booking voucher example",
"value": {
"data": "\n<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Transitional//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd\">\n<html xmlns=\"http://www.w3.org/1999/xhtml\">\n <head>\n <meta http-equiv=\"Content-Type\" content=\"text/html; charset=UTF-8\" />\n <meta name=\"viewport\" content=\"width=device-width\" />\n <title>Viator</title>\n </head>\n <body>\n <div id=\"content\" class=\"voucher_box\">\n <div id=\"voucher_1\">\n\n <div class=\"section\">\n <div class=\"voucher_title\">\n Voucher 1\n of 1: Homer test Simpson test\n </div>\n </div>\n\n <div class=\"section bline\">\n <div class=\"btn_box\">\n </div>\n </div>\n\n <div style=\"line-height: 1.5;font-family:'Arial','Helvetica','Verdana',sans-serif; font-size: 12px; padding: 0 10px; border-bottom: 1px solid #CAE2EA;\">\n\n <h2 style=\"font-size:16px;font-weight:bold;margin:0.5em 0;padding:0;\">\n Grand Canyon All-American Helicopter Tour\n <span style=\"display: block;font-size:12px;\">\n Morning Departure; A-Star 08:00\n </span>\n </h2>\n\n <div class=\"barcode\">\n <img src=\"/voucher/resource?type=barcode&itineraryItemId=580669678&voucherToken=4af44c13ecf3f1a7d3f9ef2fc00c2257e08fa42ae20f877f3039ff9b52aba24e\" alt=\"\"/>\n </div>\n\n <h2 style=\"font-size:16px;font-weight:bold;margin:0.5em 0;padding:0;\">SAMPLE ONLY</h2>\n\n <ul style=\"margin:0 0 1em 1em; padding:0;\">\n <li>\n <strong>Date:</strong>\n Tuesday March 31, 2020\n </li>\n </ul>\n\n <ul style=\"margin:0 0 1em 1em; padding:0;\">\n <li>\n <strong>Lead traveler\n :\n </strong>Homer test Simpson test\n </li>\n <li>\n <strong>Number of Travelers\n :\n </strong>1 Adult</li>\n\n <li>\n <strong>Booking Reference:\n </strong>BR-580669678</li>\n\n <li>\n <strong>Product Code:\n </strong>2280AAHT</li>\n\n <li>\n <strong>Option Code:\n </strong>TG1~08:00</li>\n\n <li>\n <strong>Supplier\n : </strong>Sundance Helicopters</li>\n\n\n\n\n\n <li>\n <strong>Location\n :</strong>\n <p>Traveler pickup is offered<br><br></p>\n </li>\n\n <li>\n <strong>Tour Option Description\n :</strong>\n Morning departure between 8am and 11:45am on an A-Star Helicopter for the All American Helicopter Tour\n \n </li>\n </ul>\n\n <h3 style=\"font-size:14px;font-weight:bold;margin:0.5em 0;padding:0;\">\n Voucher Information\n </h3>\n\n <ul style=\"margin:0 0 1em 1em; padding:0;\">\n You can present either a paper or an electronic voucher for this activity.\n <span style=\"color:#888888;\"> / You can present either a paper or an electronic voucher for this activity.</span>\n </ul>\n\n <h3 style=\"font-size:14px;font-weight:bold;margin:0.5em 0;padding:0;\">\n Important Information\n </h3>\n <ul>\n<li>Your local contact is Sundance Helicopters on +17027360606.</li></ul>\n• Important: due to comfort, weight and balance of the aircraft, the maximum weight per passenger to ride in an A-Star helicopter is 275lbs (125kg / 19.6st). If passengers weigh in between 275lbs and 300lbs (136kg/21.4st), you will be required to upgrade to the EC-130.<br> • Any passenger over 300lbs will be required to purchase an additional seat. This is payable directly to the tour operator on the day of the tour.<br> • Due to the nature of this tour and the safety of all guests, the tour operator reserves the right to refuse service to passengers who are intoxicated or show signs of intoxication. If, as a result, your tour is canceled, you will not be entitled to a refund.<br> • Infant children must be under the age of two and have proof of age, such as a passport and are considered lap children.<br> • Per FAA regulations, all passenger must present photo ID at check in.<br> • If you would like a vegetarian meal as your lunch option, please contact the local operator as soon as possible.<br> • Please Note: Please look for your Limo driver who will get out and will be looking for the lead traveler’s last name of whom the reservation is under. There is also a sign in the front windshield of the Limo that will say Sundance Helicopters.<br><br>Hotel pickups commence prior to this time, you must contact the local service provider to verify your exact pickup time.<br><br>All flight times are approximate and subject to change due to weather conditions and weight restrictions.<br>\n\n <h3 style=\"font-size:14px;font-weight:bold;margin:0.5em 0;padding:0;\">\n Inclusions\n </h3>\n <ul>\n<li>45-minute (approx.) flight each way (helicopter based on option selected)</li><li>Hotel pickup and drop-off by limousine</li><li>Snacks</li><li>Glass of Champagne</li><li>All taxes and fees</li></ul>\n\n\n <h3 style=\"font-size:14px;font-weight:bold;margin:0.5em 0;padding:0;\">\n Exclusions\n </h3>\n <ul>\n<li>Gratuities</li></ul>\n\n\n\n </div>\n\n </div>\n <br/>\n\n </div>\n\n </body>\n</html>\n",
"dateStamp": "2020-02-11T19:50:39+0000",
"errorCodes": [],
"errorMessage": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorMessageText": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorName": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorReference": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorType": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"extraInfo": {},
"extraObject": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"success": true,
"totalCount": 1,
"vmid": "331003"
}
},
"bookings-id-cancel-quote-example": {
"summary": "bookings cancel quote example",
"value": {
"bookingId": "BR-580669678",
"refundDetails": {
"currencyCode": "USD",
"itemPrice": 412.04,
"refundAmount": 412.04,
"refundPercentage": 100
},
"status": "CANCELLABLE"
}
},
"cancel-reasons-example": {
"summary": "cancel reasons example",
"value": {
"reasons": [
{
"cancellationReasonCode": "Customer_Service.Unexpected_medical_circumstances",
"cancellationReasonText": "Unexpected/medical circumstances"
},
{
"cancellationReasonCode": "Customer_Service.Duplicate_Booking",
"cancellationReasonText": "Duplicate Booking"
},
{
"cancellationReasonCode": "Customer_Service.Tour operator asked me to cancel",
"cancellationReasonText": "Tour operator asked me to cancel"
},
{
"cancellationReasonCode": "Customer_Service.Chose_a_different_cheaper_tour",
"cancellationReasonText": "Chose a different/cheaper tour"
},
{
"cancellationReasonCode": "Customer_Service.Weather",
"cancellationReasonText": "Weather"
},
{
"cancellationReasonCode": "Customer_Service.Booked_wrong_tour_date",
"cancellationReasonText": "Booked wrong tour/date"
},
{
"cancellationReasonCode": "Customer_Service.I_canceled_my_entire_trip",
"cancellationReasonText": "I canceled my entire trip"
}
]
}
},
"health-check-example": {
"summary": "health check example",
"value": {
"allGood": true,
"capiOk": true,
"dbOk": true,
"memcachedOk": true,
"message": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
}
}
},
"product-example-1": {
"summary": "5010SYDNEY",
"value": {
"data": {
"additionalInfo": [
"Confirmation will be received at time of booking",
"Wheelchair accessible",
"When booking the 24 or 48 hour Family Pass, only the lead passenger name is required for a booking of up to 2 Adults and 2 children 16 years and under. At time of booking you only need to enter 1 adult to complete your booking",
"Infants aged 0 to 4 years travel free of charge"
],
"admission": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"ageBands": [
{
"adult": true,
"ageFrom": 16,
"ageTo": 99,
"bandId": 1,
"count": 0,
"description": "Adult",
"pluralDescription": "Adults",
"sortOrder": 1,
"treatAsAdult": true
},
{
"adult": false,
"ageFrom": 5,
"ageTo": 15,
"bandId": 2,
"count": 0,
"description": "Child",
"pluralDescription": "Children",
"sortOrder": 2,
"treatAsAdult": true
},
{
"adult": false,
"ageFrom": 0,
"ageTo": 4,
"bandId": 3,
"count": 0,
"description": "Infant",
"pluralDescription": "Infants",
"sortOrder": 3,
"treatAsAdult": false
}
],
"allTravellerNamesRequired": true,
"applePassSupported": true,
"available": true,
"bookingEngineId": "UnconditionalBE",
"bookingQuestions": [],
"catIds": [
6,
12
],
"city": "Sydney",
"code": "5010SYDNEY",
"country": "Australia",
"currencyCode": "USD",
"departurePoint": "You may start this tour at any of the stops listed.",
"departureTime": "See itinerary",
"departureTimeComments": "",
"description": "<b>Itinerary</b><br><br><p><strong>Red Route - Sydney Icons</strong></p><p>Route Duration: 2 hours</p><div>Stops on the Red Route - Sydney Icons:</div><ul><li>T Galleria x Petal met Sugar - Circular Quay, George St, cnr Alfred St. (opp DFS Galleria)</li>\n<li>Martin Place Station, Elizabeth St, Stand E - Sydney Tower/ Westfield</li>\n<li>1 William St - Australian Museum</li>\n<li>William St at Palmer St - William St, Kings Cross</li>\n<li>121 Darlinghurst Rd - Kings Cross Train Station on Darlinghurst Rd.</li>\n<li>123-125 MacLeay St - El Alamein Fountain</li>\n<li>2 Bourke St - Cowper Wharf Rd, outside the Woollomooloo Hotel</li>\n<li>2A Macquarie St - Sydney Opera House</li>\n<li>Macquarie Street - Botanical Garden, Scenic Walk to Mrs Macquarie Chair</li>\n<li>State Library of New South Wales - State Library</li>\n<li>Prince Albert Rd opp College St - Hyde Park</li>\n<li>Greyhound Australia - Central Station, Pitt Street, Bus Bay 18</li>\n<li>Powerhouse Museum, Harris St - Powerhouse Museum</li>\n<li>Fish Market - Harris St, cnr Pyrmont Bridge Rd</li>\n<li>Marquee Sydney - The Star Casino</li>\n<li>Maritime Museum</li>\n<li>ICC Sydney</li>\n<li>Chinese Garden of Friendship</li>\n<li>SEA LIFE Sydney Aquarium</li>\n<li>ibis Sydney King Street Wharf - Kings Street Wharf</li>\n<li>Hickson Road</li>\n<li>Dawes Point - Sydney Harbour Bridge</li>\n<li>The Rocks</li></ul><div>Attractions on the Red Route - Sydney Icons:</div><p>Hyde Park Barracks / Australian Museum / Sea Life Sydney Aquarium / Darling Harbour / The Rocks / Bondi Beach / Sydney Harbour Bridge / Royal Botanic Garden Sydney / Sydney Town Hall / Hyde Park / Circular Quay / City Sightseeing Sydney / Madame Tussauds Sydney / Big Bus Sydney</p><p><i>Operates:</i> 1st bus departs from Stop 1 Circular Quay at 8.30am.\nFrequency every 20 minutes\nLast bus departs from stop 1 at 6.30pm</p><p><strong>Blue Route - Bondi Lifestyle</strong></p><p>Route Duration: 2 hours</p><div>Stops on the Blue Route - Bondi Lifestyle:</div><ul><li>492 Pitt St - Central Station, Pitt Street, Bus Bay 18</li>\n<li>1 William St - Australian Museum </li>\n<li>Paddington Town Hall, Oxford St</li>\n<li>Oxford St opp Moncur St</li>\n<li>Bondi Beach</li>\n<li>North Bondi Beach, Campbell Pde</li>\n<li>Rose Bay</li>\n<li>Double Bay</li></ul><div>Attractions on the Blue Route - Bondi Lifestyle:</div><p>Paddington Markets / Centennial Park / Bondi Beach / Rose Bay / Double Bay</p><p><i>Operates:</i> 1st bus departs from Stop 1 Circular Quay at 9.30am.\nFrequency every 30 minutes\nLast bus departs from stop 1 at 6.30pm</p>",
"destinationId": 357,
"duration": "2 hours",
"essential": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"exclusions": [
"Food and drinks",
"Admission"
],
"highlights": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"hotelPickup": false,
"inclusions": [
"Choice of 24 hour or 48 hour pass",
"Pre-recorded commentary in English, French, Spanish, German, Italian, Mandarin, Japanese, Korean",
"Free wifi onboard"
],
"itinerary": "",
"location": "The Rocks, Australia",
"mapURL": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"maxTravellerCount": 9,
"merchantCancellable": true,
"merchantNetPriceFrom": 29.52,
"merchantNetPriceFromFormatted": "$29.52",
"merchantTermsAndConditions": {
"amountRefundable": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"cancellationFromTourDate": [
{
"dayRangeMax": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"dayRangeMin": 1,
"percentageRefundable": 100,
"policyEndTimestamp": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"policyStartTimestamp": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
}
},
{
"dayRangeMax": 1,
"dayRangeMin": 0,
"percentageRefundable": 0,
"policyEndTimestamp": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"policyStartTimestamp": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
}
}
],
"merchantTermsAndConditionsType": 1,
"termsAndConditions": "For a full refund, cancel at least 24 hours in advance of the start date of the experience."
},
"onRequestPeriod": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"onSale": false,
"operates": "<p>Daily</p>",
"panoramaCount": 0,
"pas": null,
"passengerAttributes": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"photoCount": 124,
"price": 36.97,
"priceFormatted": "$36.97",
"primaryDestinationId": 357,
"primaryDestinationName": "Sydney",
"primaryDestinationUrlName": "Sydney",
"primaryGroupId": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"productPhotos": [
{
"caption": "Selfies at Bondi Beach",
"path": "attractions-splice-spp-674x446/09/c5/d3/87.jpg",
"photoURL": "https://hare-media-cdn.tripadvisor.com/media/attractions-splice-spp-674x446/09/c5/d3/87.jpg",
"supplier": "SUPPLIER"
},
{
"caption": "",
"path": "attractions-splice-spp-674x446/09/c5/d2/d1.jpg",
"photoURL": "https://hare-media-cdn.tripadvisor.com/media/attractions-splice-spp-674x446/09/c5/d2/d1.jpg",
"supplier": "SUPPLIER"
},
{
"caption": "",
"path": "attractions-splice-spp-674x446/07/94/40/f3.jpg",
"photoURL": "https://hare-media-cdn.tripadvisor.com/media/attractions-splice-spp-674x446/07/94/40/f3.jpg",
"supplier": "SUPPLIER"
},
{
"caption": "Sydney and Bondi Hop-On Hop-Off Tour",
"path": "attractions-splice-spp-674x446/09/c5/d2/d4.jpg",
"photoURL": "https://hare-media-cdn.tripadvisor.com/media/attractions-splice-spp-674x446/09/c5/d2/d4.jpg",
"supplier": "SUPPLIER"
},
{
"caption": "Bondi Beach",
"path": "attractions-splice-spp-674x446/09/c5/d2/c7.jpg",
"photoURL": "https://hare-media-cdn.tripadvisor.com/media/attractions-splice-spp-674x446/09/c5/d2/c7.jpg",
"supplier": "SUPPLIER"
},
{
"caption": "Visit icons",
"path": "attractions-splice-spp-674x446/07/90/5a/68.jpg",
"photoURL": "https://hare-media-cdn.tripadvisor.com/media/attractions-splice-spp-674x446/07/90/5a/68.jpg",
"supplier": "SUPPLIER"
},
{
"caption": "Big Bus App provides live tracking",
"path": "attractions-splice-spp-674x446/07/90/5a/6a.jpg",
"photoURL": "https://hare-media-cdn.tripadvisor.com/media/attractions-splice-spp-674x446/07/90/5a/6a.jpg",
"supplier": "SUPPLIER"
},
{
"caption": "The Rocks",
"path": "attractions-splice-spp-674x446/07/90/5a/7d.jpg",
"photoURL": "https://hare-media-cdn.tripadvisor.com/media/attractions-splice-spp-674x446/07/90/5a/7d.jpg",
"supplier": "SUPPLIER"
}
],
"productUrlName": "Sydney-and-Bondi-Hop-on-Hop-off-Tour",
"rating": 4.5,
"ratingCounts": {
"1": 38,
"2": 99,
"3": 198,
"4": 500,
"5": 770
},
"region": "New South Wales",
"returnDetails": "You may disembark at any of the available stops.",
"reviewCount": 1605,
"reviews": [
{
"ownerAvatarURL": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"ownerCountry": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"ownerId": 32351278,
"ownerName": "esperanza h",
"productCode": "5010SYDNEY",
"productTitle": "Big Bus Sydney and Bondi Hop-on Hop-off Tour",
"productUrlName": "Sydney-and-Bondi-Hop-on-Hop-off-Tour",
"publishedDate": "2020-01-16",
"rating": 5,
"review": "<p>Excellent way of visiting the city! It’s the only way to see atttactions in Sydney as I only have three days to stay . The next day I went back to Bondi beach to spend half of my day for the birthday of my son. Went to Iceberg Club overlooking the beach with surfers. It’s the best view you can get while having lunch! Walked along the coast to enjoy the magnificent view. I plan to go back again to this beautiful city. Spent sometime at the opera house area where there’s plenty of nice cafes to eat while admiring the view!</p>",
"reviewId": 67907371,
"sortOrder": 1,
"sslSupported": false,
"submissionDate": "2020-01-16",
"viatorFeedback": "",
"viatorNotes": ""
},
{
"ownerAvatarURL": "http://cache-graphicslib.viator.com/graphicslib/media/f5/tomzak21-account_47925237-45sq.jpg",
"ownerCountry": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"ownerId": 47925237,
"ownerName": "tomzak21",
"productCode": "5010SYDNEY",
"productTitle": "Big Bus Sydney and Bondi Hop-on Hop-off Tour",
"productUrlName": "Sydney-and-Bondi-Hop-on-Hop-off-Tour",
"publishedDate": "2020-01-09",
"rating": 5,
"review": "<p>Love The Big Bus, Hop On / Hop Off Tour Company! This is the way to see just about all the key areas and tourist attractions. You don't have to rent a car and they are actually comfortable. We also did a Hop On, Hop Off in Budapest, Hungary and that was great also, saw all the major attractions!</p>\n\n<p> They provide you with earbuds and there are 6+ languages that you can choose. Being in Sydney, there was Chinese, Korean, Japanese, along with French, Spanish, English and I believe German.</p>\n\n<p> There is also a \"package deal\" in which you can purchase a pass to other attractions along the route.. like Wildlife Sydney Zoo, Madame Tussaud's, Sydney Eye. You can buy a 2, 3 or 4 attraction pass in which The Big Bus is one of the attractions.</p>\n\n<p> Love The Big Bus! If you want a quick tour or spend a couples days of exploring, this is the way to go!</p>\n\n<p> Only complaint... the drop off and pick up spots could be better labeled. They should put there logo on a sign and make it noticeable. Some stops had some kind of sign, but there were a few stops that we weren't sure we were in the right spot. It wound up that we were in the correct spot. Addresses are listed in the provided in the pamphlet / flyer provided.</p>",
"reviewId": 67480203,
"sortOrder": 2,
"sslSupported": false,
"submissionDate": "2020-01-09",
"viatorFeedback": "",
"viatorNotes": ""
}
],
"rrp": 0,
"rrpformatted": "",
"salesPoints": [],
"savingAmount": 0,
"savingAmountFormated": "",
"shortDescription": "Explore Sydney and Bondi Beach on this hop-on hop-off sightseeing tour, which takes you by double-decker bus to 34 stops around the city including Sydney Opera House, Sydney Harbour Bridge, Darling Harbour, Bondi Beach and more. Enjoy unobstructed views and recorded commentary on board. Simply hop off to walk around and sightsee in depth. Your ticket is valid for 24 or 48 hours, so you can experience Sydney and Bondi's most noteworthy attractions, sights, and shopping and dining areas at your own pace.",
"shortTitle": "Big Bus Sydney and Bondi Hop-on Hop-off Tour",
"specialOffer": "",
"specialOfferAvailable": false,
"specialReservation": false,
"specialReservationDetails": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"sslSupported": false,
"subCatIds": [
97,
98,
5330,
26963,
32024,
45
],
"supplierCode": "5010",
"supplierName": "Big Bus Tours",
"termsAndConditions": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"thumbnailHiResURL": "https://hare-media-cdn.tripadvisor.com/media/attractions-splice-spp-674x446/07/94/40/f3.jpg",
"thumbnailURL": "https://hare-media-cdn.tripadvisor.com/media/attractions-splice-spp-154x109/07/94/40/f3.jpg",
"title": "Big Bus Sydney and Bondi Hop-on Hop-off Tour",
"tourGrades": [
{
"currencyCode": "USD",
"defaultLanguageCode": "en",
"gradeCode": "24HOUR",
"gradeDepartureTime": "",
"gradeDescription": "Unlimited use on Big Bus Sydney & Bondi Hop-on Hop-off Tour for 24 hours from time of first use",
"gradeTitle": "24 Hour Classic Ticket ",
"langServices": {
"de/SERVICE_AUDIO": "German - Audio",
"en/SERVICE_AUDIO": "English - Audio",
"es/SERVICE_AUDIO": "Spanish - Audio",
"fr/SERVICE_AUDIO": "French - Audio",
"ja/SERVICE_AUDIO": "Japanese - Audio",
"ko/SERVICE_AUDIO": "Korean - Audio",
"zh/SERVICE_AUDIO": "Chinese - Audio"
},
"merchantNetPriceFrom": 29.52,
"merchantNetPriceFromFormatted": "$29.52",
"priceFrom": 36.97,
"priceFromFormatted": "$36.97",
"sortOrder": 1
},
{
"currencyCode": "USD",
"defaultLanguageCode": "en",
"gradeCode": "48HOUR",
"gradeDepartureTime": "",
"gradeDescription": "48 Hour Premium Ticket: Unlimited use on Big Bus Sydney & Bondi Tour for 48 hours from time of first use PLUS a guided walking tour of The Rocks, Syd",
"gradeTitle": "48 Hour Premium Ticket ",
"langServices": {
"de/SERVICE_AUDIO": "German - Audio",
"en/SERVICE_AUDIO": "English - Audio",
"es/SERVICE_AUDIO": "Spanish - Audio",
"fr/SERVICE_AUDIO": "French - Audio",
"ja/SERVICE_AUDIO": "Japanese - Audio",
"ko/SERVICE_AUDIO": "Korean - Audio",
"zh/SERVICE_AUDIO": "Chinese - Audio"
},
"merchantNetPriceFrom": 39.53,
"merchantNetPriceFromFormatted": "$39.53",
"priceFrom": 49.5,
"priceFromFormatted": "$49.50",
"sortOrder": 2
},
{
"currencyCode": "USD",
"defaultLanguageCode": "en",
"gradeCode": "DELUXE",
"gradeDepartureTime": "",
"gradeDescription": "Big Bus and Habour Cruise: Combine two great Sydney experiences into one with a hop-on hop off Big Bus Tours and a hop-on hop-off Sydney Harbour cruise <br/>Duration: 2 days: SPECIAL OFFER: EXTRA FREE DAY when you purchase a Deluxe ticket - have 3 days to explore Sydney not 2. Limited time only.\n<br/>Complimentary Walking Tour: Complimentary English-speaking 90-minute guided walking tour of “The Rocks” historic and harbourside precinct.",
"gradeTitle": "48 Hour Deluxe Bus and Cruise",
"langServices": {
"de/SERVICE_AUDIO": "German - Audio",
"en/SERVICE_AUDIO": "English - Audio",
"es/SERVICE_AUDIO": "Spanish - Audio",
"fr/SERVICE_AUDIO": "French - Audio",
"ja/SERVICE_AUDIO": "Japanese - Audio",
"ko/SERVICE_AUDIO": "Korean - Audio",
"zh/SERVICE_AUDIO": "Chinese - Audio"
},
"merchantNetPriceFrom": 55.05,
"merchantNetPriceFromFormatted": "$55.05",
"priceFrom": 68.93,
"priceFromFormatted": "$68.93",
"sortOrder": 3
},
{
"currencyCode": "USD",
"defaultLanguageCode": "en",
"gradeCode": "TG1",
"gradeDepartureTime": "",
"gradeDescription": "Hop-on Hop-Off and Attractions: 48hr Big Bus Tours, 1-day Hop-On Hop-Off Harbour Cruise, 4 Attractions: Tower Eye, Madame Tussauds, Wildlife Zoo, Aquarium<br/>Duration: 2 days: SPECIAL OFFER: EXTRA FREE DAY when you purchase a Deluxe ticket - have 3 days to explore Sydney not 2. Limited time only.\n<br/>Complimentary Walking Tours: Complimentary English-speaking guided walking tour of “The Rocks” historic and harbourside precinct.",
"gradeTitle": "48Hour Deluxe PLUS Attractions",
"langServices": {
"de/SERVICE_AUDIO": "German - Audio",
"en/SERVICE_AUDIO": "English - Audio",
"es/SERVICE_AUDIO": "Spanish - Audio",
"fr/SERVICE_AUDIO": "French - Audio",
"ja/SERVICE_AUDIO": "Japanese - Audio",
"ko/SERVICE_AUDIO": "Korean - Audio",
"zh/SERVICE_AUDIO": "Chinese - Audio"
},
"merchantNetPriceFrom": 71.74,
"merchantNetPriceFromFormatted": "$71.74",
"priceFrom": 89.81,
"priceFromFormatted": "$89.81",
"sortOrder": 4
}
],
"tourGradesAvailable": true,
"translationLevel": 0,
"userPhotos": [
{
"caption": "<p>Carl and Karen meeting a new friend at the Wildlife park.</p>",
"editorsPick": true,
"ownerAvatarURL": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"ownerCountry": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"ownerId": 1755909,
"ownerName": "Husker1k",
"photoHiResURL": "http://cache-graphicslib.viator.com/graphicslib/media/e4/dsc00471-photo_1909732-1536tall.jpg",
"photoId": 1909732,
"photoMediumResURL": "http://cache-graphicslib.viator.com/graphicslib/media/e4/dsc00471-photo_1909732-260tall.jpg",
"photoURL": "http://cache-graphicslib.viator.com/graphicslib/media/e4/dsc00471-photo_1909732-770tall.jpg",
"productCode": "5010SYDNEY",
"productTitle": "Big Bus Sydney and Bondi Hop-on Hop-off Tour",
"productUrlName": "Sydney-and-Bondi-Hop-on-Hop-off-Tour",
"sortOrder": 1,
"sslSupported": false,
"thumbnailURL": "http://cache-graphicslib.viator.com/graphicslib/media/e4/dsc00471-photo_1909732-133sq.jpg",
"timeUploaded": "2012-02-07",
"title": "DSC00471"
},
{
"caption": "Sydney Opera House",
"editorsPick": true,
"ownerAvatarURL": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"ownerCountry": "Australia",
"ownerId": 288013,
"ownerName": "Kylie G",
"photoHiResURL": "http://cache-graphicslib.viator.com/graphicslib/media/f2/sydney-opera-house-photo_997106-1536tall.jpg",
"photoId": 997106,
"photoMediumResURL": "http://cache-graphicslib.viator.com/graphicslib/media/f2/sydney-opera-house-photo_997106-260tall.jpg",
"photoURL": "http://cache-graphicslib.viator.com/graphicslib/media/f2/sydney-opera-house-photo_997106-770tall.jpg",
"productCode": "5010SYDNEY",
"productTitle": "Big Bus Sydney and Bondi Hop-on Hop-off Tour",
"productUrlName": "Sydney-and-Bondi-Hop-on-Hop-off-Tour",
"sortOrder": 2,
"sslSupported": false,
"thumbnailURL": "http://cache-graphicslib.viator.com/graphicslib/media/f2/sydney-opera-house-photo_997106-133sq.jpg",
"timeUploaded": "2009-07-22",
"title": "Sydney Opera House"
}
],
"videoCount": 1,
"videos": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"voucherOption": "VOUCHER_E",
"voucherRequirements": "You can present either a paper or an electronic voucher for this activity.",
"webURL": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
}
},
"dateStamp": "2020-02-06T18:15:04+0000",
"errorCodes": [],
"errorMessage": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorMessageText": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorName": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorReference": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorType": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"extraInfo": {},
"extraObject": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"success": true,
"totalCount": 1,
"vmid": "331001"
}
},
"product-example-2": {
"summary": "2280AAHT",
"value": {
"data": {
"additionalInfo": [
"Confirmation will be received at time of booking, unless booked within 30 days of travel. In this case confirmation will be received within 48 hours, subject to availability",
"Tours require a minimum number of passengers to operate",
"Due to comfort, weight and balance of the aircraft, the maximum weight per passenger to ride in an A-Star helicopter is 275lbs (125kg / 19.6st). If passengers weigh in between 275lbs and 300lbs (136kg/21.4st), you will be required to upgrade to the EC-130.",
"Any passenger over 300lbs will be required to purchase an additional seat. This is payable directly to the tour operator on the day of the tour.",
"Individual passenger weights, including infants, MUST be advised at time of booking",
"Collapsible wheelchairs with removable wheels may be accommodated provided the passenger is accompanied by someone who can assist them with boarding and disembarking the aircraft",
"Infant children are considered a lap child if they are under the age of two and have proof of age, such as a passport or a copy of their birth certificate",
"Veggie options are available. Please note this request in the special requirement field at check out.",
"Please note: Seats are determined by passengers weights and front seats cannot be guaranteed at any time.",
"Wheelchair accessible",
"Service animals allowed",
"Infants must sit on laps",
"Infant seats available",
"Transportation is wheelchair accessible",
"Most travelers can participate",
"This experience requires good weather. If it’s canceled due to poor weather, you’ll be offered a different date or a full refund",
"This experience requires a minimum number of travelers. If it’s canceled because the minimum isn’t met, you’ll be offered a different date/experience or a full refund"
],
"admission": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"ageBands": [
{
"adult": true,
"ageFrom": 2,
"ageTo": 99,
"bandId": 1,
"count": 0,
"description": "Adult",
"pluralDescription": "Adults",
"sortOrder": 1,
"treatAsAdult": true
},
{
"adult": false,
"ageFrom": 0,
"ageTo": 1,
"bandId": 3,
"count": 0,
"description": "Infant",
"pluralDescription": "Infants",
"sortOrder": 2,
"treatAsAdult": false
}
],
"allTravellerNamesRequired": true,
"applePassSupported": true,
"available": true,
"bookingEngineId": "FreesaleOnRequestBE",
"bookingQuestions": [
{
"message": "For safety reasons you must enter the weight of all passengers. Please indicate pounds or kilos.",
"questionId": 23,
"required": true,
"sortOrder": 1,
"stringQuestionId": "weights_passengerWeights",
"subTitle": "(e.g. 127 pounds, 145 kilos, etc)",
"title": "Passenger Weights"
}
],
"catIds": [
1,
25,
12
],
"city": "Las Vegas",
"code": "2280AAHT",
"country": "United States",
"currencyCode": "EUR",
"departurePoint": "Traveler pickup is offered<br><br>",
"departureTime": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"departureTimeComments": "",
"description": "<b>Itinerary</b><br>This is a typical itinerary for this product<br><br><b>Pass By:</b> Lake Mead National Recreation Area, 10 Lakeshore Rd, NV 89005<br><br>This tour is likely to sell-out! The Grand Canyon All-American Helicopter Tour regularly sells out weeks in advance, so book ahead to avoid disappointment!<br><br>During the flight, you can listen to a recorded commentary about the Grand Canyon and its surrounds via audio headphones. You'll discover the natural beauty of the Grand Canyon as your air-conditioned helicopter flies to the West Rim, passing over Lake Las Vegas, Lake Mead and the Hoover Dam en route. <br><br><b>Pass By:</b> Hoover Dam Access Road, Boulder City, NV 89109<br><br>Hoover Dam is a spectacular sight from the air, curved between the rock canyon walls. <br><br><b>Pass By:</b> Colorado River, Grand Canyon National Park, AZ<br><br>As you enter the Grand Canyon, you'll soar over the mighty Colorado River. <br><br><b>Stop At:</b> Grand Canyon West, AZ 86434, USA<br><br>You'll land for an unforgettable experience, 3,200 feet (960 meters) below the rim. While you share a bottle of champagne under an authentic Native American Ramada shelter and a basket of snacks, your pilot/guide will be happy to answer any questions you may have about the canyon or your helicopter flight.<br><br>Duration: 45 minutes<br><br><b>Pass By:</b> The Strip, S Las Vegas Blvd, Las Vegas, NV 89109<br><br>Your Grand Canyon helicopter scenic flight ends with a low-level pass over the west side of the famous Las Vegas Strip. On landing, your limousine is waiting to whisk you back to your hotel.<br><br>",
"destinationId": 684,
"duration": "3 hours 30 minutes",
"essential": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"exclusions": [
"Gratuities"
],
"highlights": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"hotelPickup": true,
"inclusions": [
"45-minute (approx.) flight each way (helicopter based on option selected)",
"Hotel pickup and drop-off by limousine",
"Snacks",
"Glass of Champagne",
"All taxes and fees"
],
"itinerary": "",
"location": "Las Vegas, United States",
"mapURL": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"maxTravellerCount": 9,
"merchantCancellable": true,
"merchantNetPriceFrom": 351.9,
"merchantNetPriceFromFormatted": "€351,90",
"merchantTermsAndConditions": {
"amountRefundable": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"cancellationFromTourDate": [
{
"dayRangeMax": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"dayRangeMin": 1,
"percentageRefundable": 100,
"policyEndTimestamp": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"policyStartTimestamp": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
}
},
{
"dayRangeMax": 1,
"dayRangeMin": 0,
"percentageRefundable": 0,
"policyEndTimestamp": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"policyStartTimestamp": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
}
}
],
"merchantTermsAndConditionsType": 1,
"termsAndConditions": "For a full refund, cancel at least 24 hours in advance of the start date of the experience."
},
"onRequestPeriod": 720,
"onSale": false,
"operates": "Daily",
"panoramaCount": 0,
"pas": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"passengerAttributes": [
{
"customAttribute_kg": "kgs",
"customAttribute_lb": "lbs",
"errorMissingMessage": "The weight entered is not valid. Please provide weight as a number (i.e. 95)",
"errorValidationMessage": "The weight entered is not valid. Please provide weight as a number (i.e. 95)",
"questionId": "weights_passengerWeights",
"required": true,
"title": "Weight",
"validateType": "positiveInteger"
}
],
"photoCount": 5,
"price": 376.3,
"priceFormatted": "€376,30",
"primaryDestinationId": 684,
"primaryDestinationName": "Las Vegas",
"primaryDestinationUrlName": "Las-Vegas",
"primaryGroupId": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"productPhotos": [
{
"caption": "Grand Canyon All-American Helicopter Tour",
"path": "attractions-splice-spp-674x446/07/38/cd/90.jpg",
"photoURL": "https://media.tacdn.com/media/attractions-splice-spp-674x446/07/38/cd/90.jpg",
"supplier": "SUPPLIER"
},
{
"caption": "",
"path": "attractions-splice-spp-674x446/07/90/58/3c.jpg",
"photoURL": "https://media.tacdn.com/media/attractions-splice-spp-674x446/07/90/58/3c.jpg",
"supplier": "SUPPLIER"
},
{
"caption": "",
"path": "attractions-splice-spp-674x446/07/90/58/3d.jpg",
"photoURL": "https://media.tacdn.com/media/attractions-splice-spp-674x446/07/90/58/3d.jpg",
"supplier": "SUPPLIER"
},
{
"caption": "",
"path": "attractions-splice-spp-674x446/07/1b/3e/94.jpg",
"photoURL": "https://media.tacdn.com/media/attractions-splice-spp-674x446/07/1b/3e/94.jpg",
"supplier": "SUPPLIER"
},
{
"caption": "",
"path": "attractions-splice-spp-674x446/07/90/58/21.jpg",
"photoURL": "https://media.tacdn.com/media/attractions-splice-spp-674x446/07/90/58/21.jpg",
"supplier": "SUPPLIER"
},
{
"caption": "Grand Canyon All-American Helicopter Tour",
"path": "attractions-splice-spp-674x446/07/75/b2/fb.jpg",
"photoURL": "https://media.tacdn.com/media/attractions-splice-spp-674x446/07/75/b2/fb.jpg",
"supplier": "SUPPLIER"
}
],
"productUrlName": "Grand-Canyon-All-American-Helicopter-Tour",
"rating": 5,
"ratingCounts": {
"1": 41,
"2": 78,
"3": 131,
"4": 883,
"5": 5913
},
"region": "Nevada",
"returnDetails": "",
"reviewCount": 7046,
"reviews": [
{
"ownerAvatarURL": "http://cache-graphicslib.viator.com/graphicslib/media/8e/meri-s-account_6638734-45sq.jpg",
"ownerCountry": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"ownerId": 6638734,
"ownerName": "Meri S",
"productCode": "2280AAHT",
"productTitle": "Grand Canyon All-American Helicopter Tour",
"productUrlName": "Grand-Canyon-All-American-Helicopter-Tour",
"publishedDate": "2020-01-22",
"rating": 5,
"review": "<p>Wonderful trip! The limo picked us up at the MGM and took us directly to the helipad. We were a group of 6, and we had our own helicopter. Our pilot was amazing, and the flight was breathtaking. We had a great time! Definitely worth the money!</p>",
"reviewId": 68309931,
"sortOrder": 1,
"sslSupported": false,
"submissionDate": "2020-01-22",
"viatorFeedback": "",
"viatorNotes": ""
},
{
"ownerAvatarURL": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"ownerCountry": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"ownerId": 65594303,
"ownerName": "June Ling C",
"productCode": "2280AAHT",
"productTitle": "Grand Canyon All-American Helicopter Tour",
"productUrlName": "Grand-Canyon-All-American-Helicopter-Tour",
"publishedDate": "2020-01-20",
"rating": 5,
"review": "<p>Best tour ever! our pilot Ryan explained as we fly across each location. We managed to took good view of Grand Canyon picture and the tour is worth to go .Never regret of booking this tour . I would recommend everyone to go if you have time in Vegas</p>",
"reviewId": 68183211,
"sortOrder": 2,
"sslSupported": false,
"submissionDate": "2020-01-20",
"viatorFeedback": "",
"viatorNotes": ""
}
],
"rrp": 0,
"rrpformatted": "",
"salesPoints": [],
"savingAmount": 0,
"savingAmountFormated": "",
"shortDescription": "Take off from McCarran Airport on an exhilarating helicopter flight to the Grand Canyon. You'll enjoy a 45-minute helicopter flight each way, land deep in the canyon for a glass of champagne and a basket of snacks then fly low over the famous Las Vegas Strip on your return. The Grand Canyon All American Helicopter Tour is a half-day tour, leaving you with time in the day free to explore Las Vegas and Nevada at your leisure.",
"shortTitle": "Las Vegas to Grand Canyon Helicopter Tour with Champagne",
"specialOffer": "",
"specialOfferAvailable": false,
"specialReservation": false,
"specialReservationDetails": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"sslSupported": false,
"subCatIds": [
113,
2,
98,
26963,
45,
94,
95
],
"supplierCode": "2280",
"supplierName": "Sundance Helicopters",
"termsAndConditions": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"thumbnailHiResURL": "https://hare-media-cdn.tripadvisor.com/media/attractions-splice-spp-674x446/07/38/cd/90.jpg",
"thumbnailURL": "https://hare-media-cdn.tripadvisor.com/media/attractions-splice-spp-154x109/07/38/cd/90.jpg",
"title": "Grand Canyon All-American Helicopter Tour",
"tourGrades": [
{
"currencyCode": "EUR",
"defaultLanguageCode": "en",
"gradeCode": "EB_ASTAR_SP~06:45",
"gradeDepartureTime": "6:45 AM",
"gradeDescription": "Special Offer: Receive a discounted seat for the Grand Canyon All American Helicopter Tour departing between 6:45am and 7am on an A-Star helicopter",
"gradeTitle": "Special: Earlybird A-Star 06:45",
"langServices": {
"de/SERVICE_AUDIO": "German - Audio",
"en/SERVICE_AUDIO": "English - Audio",
"es/SERVICE_AUDIO": "Spanish - Audio",
"fr/SERVICE_AUDIO": "French - Audio",
"it/SERVICE_AUDIO": "Italian - Audio",
"ja/SERVICE_AUDIO": "Japanese - Audio",
"ko/SERVICE_AUDIO": "Korean - Audio",
"pt/SERVICE_AUDIO": "Portuguese - Audio",
"ru/SERVICE_AUDIO": "Russian - Audio",
"tw/SERVICE_AUDIO": "Chinese (Traditional) - Audio"
},
"merchantNetPriceFrom": 351.9,
"merchantNetPriceFromFormatted": "€351,90",
"priceFrom": 376.3,
"priceFromFormatted": "€376,30",
"sortOrder": 1
},
{
"currencyCode": "EUR",
"defaultLanguageCode": "en",
"gradeCode": "EB_ASTAR_SP~07:00",
"gradeDepartureTime": "7:00 AM",
"gradeDescription": "Special Offer: Receive a discounted seat for the Grand Canyon All American Helicopter Tour departing between 6:45am and 7am on an A-Star helicopter",
"gradeTitle": "Special: Earlybird A-Star 07:00",
"langServices": {
"de/SERVICE_AUDIO": "German - Audio",
"en/SERVICE_AUDIO": "English - Audio",
"es/SERVICE_AUDIO": "Spanish - Audio",
"fr/SERVICE_AUDIO": "French - Audio",
"it/SERVICE_AUDIO": "Italian - Audio",
"ja/SERVICE_AUDIO": "Japanese - Audio",
"ko/SERVICE_AUDIO": "Korean - Audio",
"pt/SERVICE_AUDIO": "Portuguese - Audio",
"ru/SERVICE_AUDIO": "Russian - Audio",
"tw/SERVICE_AUDIO": "Chinese (Traditional) - Audio"
},
"merchantNetPriceFrom": 351.9,
"merchantNetPriceFromFormatted": "€351,90",
"priceFrom": 376.3,
"priceFromFormatted": "€376,30",
"sortOrder": 2
},
{
"currencyCode": "EUR",
"defaultLanguageCode": "en",
"gradeCode": "EB_EC130_SP~06:45",
"gradeDepartureTime": "6:45 AM",
"gradeDescription": "Special Offer: Receive a discounted seat for the Grand Canyon All American Helicopter Tour departing between 6:45am and 7am on an EC-130",
"gradeTitle": "Special: Earlybird EC-130 06:45",
"langServices": {
"de/SERVICE_AUDIO": "German - Audio",
"en/SERVICE_AUDIO": "English - Audio",
"es/SERVICE_AUDIO": "Spanish - Audio",
"fr/SERVICE_AUDIO": "French - Audio",
"it/SERVICE_AUDIO": "Italian - Audio",
"ja/SERVICE_AUDIO": "Japanese - Audio",
"ko/SERVICE_AUDIO": "Korean - Audio",
"pt/SERVICE_AUDIO": "Portuguese - Audio",
"ru/SERVICE_AUDIO": "Russian - Audio",
"tw/SERVICE_AUDIO": "Chinese (Traditional) - Audio"
},
"merchantNetPriceFrom": 371.45,
"merchantNetPriceFromFormatted": "€371,45",
"priceFrom": 399.25,
"priceFromFormatted": "€399,25",
"sortOrder": 3
},
{
"currencyCode": "EUR",
"defaultLanguageCode": "en",
"gradeCode": "EB_EC130_SP~07:00",
"gradeDepartureTime": "7:00 AM",
"gradeDescription": "Special Offer: Receive a discounted seat for the Grand Canyon All American Helicopter Tour departing between 6:45am and 7am on an EC-130",
"gradeTitle": "Special: Earlybird EC-130 07:00",
"langServices": {
"de/SERVICE_AUDIO": "German - Audio",
"en/SERVICE_AUDIO": "English - Audio",
"es/SERVICE_AUDIO": "Spanish - Audio",
"fr/SERVICE_AUDIO": "French - Audio",
"it/SERVICE_AUDIO": "Italian - Audio",
"ja/SERVICE_AUDIO": "Japanese - Audio",
"ko/SERVICE_AUDIO": "Korean - Audio",
"pt/SERVICE_AUDIO": "Portuguese - Audio",
"ru/SERVICE_AUDIO": "Russian - Audio",
"tw/SERVICE_AUDIO": "Chinese (Traditional) - Audio"
},
"merchantNetPriceFrom": 371.45,
"merchantNetPriceFromFormatted": "€371,45",
"priceFrom": 399.25,
"priceFromFormatted": "€399,25",
"sortOrder": 4
},
{
"currencyCode": "EUR",
"defaultLanguageCode": "en",
"gradeCode": "TG1~08:00",
"gradeDepartureTime": "8:00 AM",
"gradeDescription": "Morning departure between 8am and 11:45am on an A-Star Helicopter for the All American Helicopter Tour",
"gradeTitle": "Morning Departure; A-Star 08:00",
"langServices": {
"de/SERVICE_AUDIO": "German - Audio",
"en/SERVICE_AUDIO": "English - Audio",
"es/SERVICE_AUDIO": "Spanish - Audio",
"fr/SERVICE_AUDIO": "French - Audio",
"it/SERVICE_AUDIO": "Italian - Audio",
"ja/SERVICE_AUDIO": "Japanese - Audio",
"ko/SERVICE_AUDIO": "Korean - Audio",
"pt/SERVICE_AUDIO": "Portuguese - Audio",
"ru/SERVICE_AUDIO": "Russian - Audio",
"tw/SERVICE_AUDIO": "Chinese (Traditional) - Audio"
},
"merchantNetPriceFrom": 356.79,
"merchantNetPriceFromFormatted": "€356,79",
"priceFrom": 422.19,
"priceFromFormatted": "€422,19",
"sortOrder": 5
},
{
"currencyCode": "EUR",
"defaultLanguageCode": "en",
"gradeCode": "TG1~09:30",
"gradeDepartureTime": "9:30 AM",
"gradeDescription": "Morning departure between 8am and 11:45am on an A-Star Helicopter for the All American Helicopter Tour",
"gradeTitle": "Morning Departure; A-Star 09:30",
"langServices": {
"de/SERVICE_AUDIO": "German - Audio",
"en/SERVICE_AUDIO": "English - Audio",
"es/SERVICE_AUDIO": "Spanish - Audio",
"fr/SERVICE_AUDIO": "French - Audio",
"it/SERVICE_AUDIO": "Italian - Audio",
"ja/SERVICE_AUDIO": "Japanese - Audio",
"ko/SERVICE_AUDIO": "Korean - Audio",
"pt/SERVICE_AUDIO": "Portuguese - Audio",
"ru/SERVICE_AUDIO": "Russian - Audio",
"tw/SERVICE_AUDIO": "Chinese (Traditional) - Audio"
},
"merchantNetPriceFrom": 356.79,
"merchantNetPriceFromFormatted": "€356,79",
"priceFrom": 422.19,
"priceFromFormatted": "€422,19",
"sortOrder": 6
},
{
"currencyCode": "EUR",
"defaultLanguageCode": "en",
"gradeCode": "TG1~09:45",
"gradeDepartureTime": "9:45 AM",
"gradeDescription": "Morning departure between 8am and 11:45am on an A-Star Helicopter for the All American Helicopter Tour",
"gradeTitle": "Morning Departure; A-Star 09:45",
"langServices": {
"de/SERVICE_AUDIO": "German - Audio",
"en/SERVICE_AUDIO": "English - Audio",
"es/SERVICE_AUDIO": "Spanish - Audio",
"fr/SERVICE_AUDIO": "French - Audio",
"it/SERVICE_AUDIO": "Italian - Audio",
"ja/SERVICE_AUDIO": "Japanese - Audio",
"ko/SERVICE_AUDIO": "Korean - Audio",
"pt/SERVICE_AUDIO": "Portuguese - Audio",
"ru/SERVICE_AUDIO": "Russian - Audio",
"tw/SERVICE_AUDIO": "Chinese (Traditional) - Audio"
},
"merchantNetPriceFrom": 356.79,
"merchantNetPriceFromFormatted": "€356,79",
"priceFrom": 422.19,
"priceFromFormatted": "€422,19",
"sortOrder": 7
},
{
"currencyCode": "EUR",
"defaultLanguageCode": "en",
"gradeCode": "TG1~10:45",
"gradeDepartureTime": "10:45 AM",
"gradeDescription": "Morning departure between 8am and 11:45am on an A-Star Helicopter for the All American Helicopter Tour",
"gradeTitle": "Morning Departure; A-Star 10:45",
"langServices": {
"de/SERVICE_AUDIO": "German - Audio",
"en/SERVICE_AUDIO": "English - Audio",
"es/SERVICE_AUDIO": "Spanish - Audio",
"fr/SERVICE_AUDIO": "French - Audio",
"it/SERVICE_AUDIO": "Italian - Audio",
"ja/SERVICE_AUDIO": "Japanese - Audio",
"ko/SERVICE_AUDIO": "Korean - Audio",
"pt/SERVICE_AUDIO": "Portuguese - Audio",
"ru/SERVICE_AUDIO": "Russian - Audio",
"tw/SERVICE_AUDIO": "Chinese (Traditional) - Audio"
},
"merchantNetPriceFrom": 356.79,
"merchantNetPriceFromFormatted": "€356,79",
"priceFrom": 422.19,
"priceFromFormatted": "€422,19",
"sortOrder": 8
},
{
"currencyCode": "EUR",
"defaultLanguageCode": "en",
"gradeCode": "TG2~08:00",
"gradeDepartureTime": "8:00 AM",
"gradeDescription": "Morning departure between 8am and 11:45am on an EC-130 Helicopter for the All American Helicopter Tour",
"gradeTitle": "Morning Departure; EC-130 08:00",
"langServices": {
"de/SERVICE_AUDIO": "German - Audio",
"en/SERVICE_AUDIO": "English - Audio",
"es/SERVICE_AUDIO": "Spanish - Audio",
"fr/SERVICE_AUDIO": "French - Audio",
"it/SERVICE_AUDIO": "Italian - Audio",
"ja/SERVICE_AUDIO": "Japanese - Audio",
"ko/SERVICE_AUDIO": "Korean - Audio",
"pt/SERVICE_AUDIO": "Portuguese - Audio",
"ru/SERVICE_AUDIO": "Russian - Audio",
"tw/SERVICE_AUDIO": "Chinese (Traditional) - Audio"
},
"merchantNetPriceFrom": 376.34,
"merchantNetPriceFromFormatted": "€376,34",
"priceFrom": 445.14,
"priceFromFormatted": "€445,14",
"sortOrder": 9
},
{
"currencyCode": "EUR",
"defaultLanguageCode": "en",
"gradeCode": "TG2~09:30",
"gradeDepartureTime": "9:30 AM",
"gradeDescription": "Morning departure between 8am and 11:45am on an EC-130 Helicopter for the All American Helicopter Tour",
"gradeTitle": "Morning Departure; EC-130 09:30",
"langServices": {
"de/SERVICE_AUDIO": "German - Audio",
"en/SERVICE_AUDIO": "English - Audio",
"es/SERVICE_AUDIO": "Spanish - Audio",
"fr/SERVICE_AUDIO": "French - Audio",
"it/SERVICE_AUDIO": "Italian - Audio",
"ja/SERVICE_AUDIO": "Japanese - Audio",
"ko/SERVICE_AUDIO": "Korean - Audio",
"pt/SERVICE_AUDIO": "Portuguese - Audio",
"ru/SERVICE_AUDIO": "Russian - Audio",
"tw/SERVICE_AUDIO": "Chinese (Traditional) - Audio"
},
"merchantNetPriceFrom": 376.34,
"merchantNetPriceFromFormatted": "€376,34",
"priceFrom": 445.14,
"priceFromFormatted": "€445,14",
"sortOrder": 10
},
{
"currencyCode": "EUR",
"defaultLanguageCode": "en",
"gradeCode": "TG2~09:45",
"gradeDepartureTime": "9:45 AM",
"gradeDescription": "Morning departure between 8am and 11:45am on an EC-130 Helicopter for the All American Helicopter Tour",
"gradeTitle": "Morning Departure; EC-130 09:45",
"langServices": {
"de/SERVICE_AUDIO": "German - Audio",
"en/SERVICE_AUDIO": "English - Audio",
"es/SERVICE_AUDIO": "Spanish - Audio",
"fr/SERVICE_AUDIO": "French - Audio",
"it/SERVICE_AUDIO": "Italian - Audio",
"ja/SERVICE_AUDIO": "Japanese - Audio",
"ko/SERVICE_AUDIO": "Korean - Audio",
"pt/SERVICE_AUDIO": "Portuguese - Audio",
"ru/SERVICE_AUDIO": "Russian - Audio",
"tw/SERVICE_AUDIO": "Chinese (Traditional) - Audio"
},
"merchantNetPriceFrom": 376.34,
"merchantNetPriceFromFormatted": "€376,34",
"priceFrom": 445.14,
"priceFromFormatted": "€445,14",
"sortOrder": 11
},
{
"currencyCode": "EUR",
"defaultLanguageCode": "en",
"gradeCode": "TG2~10:45",
"gradeDepartureTime": "10:45 AM",
"gradeDescription": "Morning departure between 8am and 11:45am on an EC-130 Helicopter for the All American Helicopter Tour",
"gradeTitle": "Morning Departure; EC-130 10:45",
"langServices": {
"de/SERVICE_AUDIO": "German - Audio",
"en/SERVICE_AUDIO": "English - Audio",
"es/SERVICE_AUDIO": "Spanish - Audio",
"fr/SERVICE_AUDIO": "French - Audio",
"it/SERVICE_AUDIO": "Italian - Audio",
"ja/SERVICE_AUDIO": "Japanese - Audio",
"ko/SERVICE_AUDIO": "Korean - Audio",
"pt/SERVICE_AUDIO": "Portuguese - Audio",
"ru/SERVICE_AUDIO": "Russian - Audio",
"tw/SERVICE_AUDIO": "Chinese (Traditional) - Audio"
},
"merchantNetPriceFrom": 376.34,
"merchantNetPriceFromFormatted": "€376,34",
"priceFrom": 445.14,
"priceFromFormatted": "€445,14",
"sortOrder": 12
},
{
"currencyCode": "EUR",
"defaultLanguageCode": "en",
"gradeCode": "TG3~12:15",
"gradeDepartureTime": "12:15 PM",
"gradeDescription": "Afternoon departure between 12pm and 4:15pm on an A-Star Helicopter for the All American Helicopter Tour",
"gradeTitle": "Afternoon Departure; A-Star 12:15",
"langServices": {
"de/SERVICE_AUDIO": "German - Audio",
"en/SERVICE_AUDIO": "English - Audio",
"es/SERVICE_AUDIO": "Spanish - Audio",
"fr/SERVICE_AUDIO": "French - Audio",
"it/SERVICE_AUDIO": "Italian - Audio",
"ja/SERVICE_AUDIO": "Japanese - Audio",
"ko/SERVICE_AUDIO": "Korean - Audio",
"pt/SERVICE_AUDIO": "Portuguese - Audio",
"ru/SERVICE_AUDIO": "Russian - Audio",
"tw/SERVICE_AUDIO": "Chinese (Traditional) - Audio"
},
"merchantNetPriceFrom": 351.9,
"merchantNetPriceFromFormatted": "€351,90",
"priceFrom": 413.02,
"priceFromFormatted": "€413,02",
"sortOrder": 13
},
{
"currencyCode": "EUR",
"defaultLanguageCode": "en",
"gradeCode": "TG3~12:30",
"gradeDepartureTime": "12:30 PM",
"gradeDescription": "Afternoon departure between 12pm and 4:15pm on an A-Star Helicopter for the All American Helicopter Tour",
"gradeTitle": "Afternoon Departure; A-Star 12:30",
"langServices": {
"de/SERVICE_AUDIO": "German - Audio",
"en/SERVICE_AUDIO": "English - Audio",
"es/SERVICE_AUDIO": "Spanish - Audio",
"fr/SERVICE_AUDIO": "French - Audio",
"it/SERVICE_AUDIO": "Italian - Audio",
"ja/SERVICE_AUDIO": "Japanese - Audio",
"ko/SERVICE_AUDIO": "Korean - Audio",
"pt/SERVICE_AUDIO": "Portuguese - Audio",
"ru/SERVICE_AUDIO": "Russian - Audio",
"tw/SERVICE_AUDIO": "Chinese (Traditional) - Audio"
},
"merchantNetPriceFrom": 351.9,
"merchantNetPriceFromFormatted": "€351,90",
"priceFrom": 413.02,
"priceFromFormatted": "€413,02",
"sortOrder": 14
},
{
"currencyCode": "EUR",
"defaultLanguageCode": "en",
"gradeCode": "TG3~13:30",
"gradeDepartureTime": "1:30 PM",
"gradeDescription": "Afternoon departure between 12pm and 4:15pm on an A-Star Helicopter for the All American Helicopter Tour",
"gradeTitle": "Afternoon Departure; A-Star 13:30",
"langServices": {
"de/SERVICE_AUDIO": "German - Audio",
"en/SERVICE_AUDIO": "English - Audio",
"es/SERVICE_AUDIO": "Spanish - Audio",
"fr/SERVICE_AUDIO": "French - Audio",
"it/SERVICE_AUDIO": "Italian - Audio",
"ja/SERVICE_AUDIO": "Japanese - Audio",
"ko/SERVICE_AUDIO": "Korean - Audio",
"pt/SERVICE_AUDIO": "Portuguese - Audio",
"ru/SERVICE_AUDIO": "Russian - Audio",
"tw/SERVICE_AUDIO": "Chinese (Traditional) - Audio"
},
"merchantNetPriceFrom": 351.9,
"merchantNetPriceFromFormatted": "€351,90",
"priceFrom": 413.02,
"priceFromFormatted": "€413,02",
"sortOrder": 15
},
{
"currencyCode": "EUR",
"defaultLanguageCode": "en",
"gradeCode": "TG3~15:00",
"gradeDepartureTime": "3:00 PM",
"gradeDescription": "Afternoon departure between 12pm and 4:15pm on an A-Star Helicopter for the All American Helicopter Tour",
"gradeTitle": "Afternoon Departure; A-Star 15:00",
"langServices": {
"de/SERVICE_AUDIO": "German - Audio",
"en/SERVICE_AUDIO": "English - Audio",
"es/SERVICE_AUDIO": "Spanish - Audio",
"fr/SERVICE_AUDIO": "French - Audio",
"it/SERVICE_AUDIO": "Italian - Audio",
"ja/SERVICE_AUDIO": "Japanese - Audio",
"ko/SERVICE_AUDIO": "Korean - Audio",
"pt/SERVICE_AUDIO": "Portuguese - Audio",
"ru/SERVICE_AUDIO": "Russian - Audio",
"tw/SERVICE_AUDIO": "Chinese (Traditional) - Audio"
},
"merchantNetPriceFrom": 351.9,
"merchantNetPriceFromFormatted": "€351,90",
"priceFrom": 413.02,
"priceFromFormatted": "€413,02",
"sortOrder": 16
},
{
"currencyCode": "EUR",
"defaultLanguageCode": "en",
"gradeCode": "TG3~15:15",
"gradeDepartureTime": "3:15 PM",
"gradeDescription": "Afternoon departure between 12pm and 4:15pm on an A-Star Helicopter for the All American Helicopter Tour",
"gradeTitle": "Afternoon Departure; A-Star 15:15",
"langServices": {
"de/SERVICE_AUDIO": "German - Audio",
"en/SERVICE_AUDIO": "English - Audio",
"es/SERVICE_AUDIO": "Spanish - Audio",
"fr/SERVICE_AUDIO": "French - Audio",
"it/SERVICE_AUDIO": "Italian - Audio",
"ja/SERVICE_AUDIO": "Japanese - Audio",
"ko/SERVICE_AUDIO": "Korean - Audio",
"pt/SERVICE_AUDIO": "Portuguese - Audio",
"ru/SERVICE_AUDIO": "Russian - Audio",
"tw/SERVICE_AUDIO": "Chinese (Traditional) - Audio"
},
"merchantNetPriceFrom": 351.9,
"merchantNetPriceFromFormatted": "€351,90",
"priceFrom": 413.02,
"priceFromFormatted": "€413,02",
"sortOrder": 17
},
{
"currencyCode": "EUR",
"defaultLanguageCode": "en",
"gradeCode": "TG3~16:15",
"gradeDepartureTime": "4:15 PM",
"gradeDescription": "Afternoon departure between 12pm and 4:15pm on an A-Star Helicopter for the All American Helicopter Tour",
"gradeTitle": "Afternoon Departure; A-Star 16:15",
"langServices": {
"de/SERVICE_AUDIO": "German - Audio",
"en/SERVICE_AUDIO": "English - Audio",
"es/SERVICE_AUDIO": "Spanish - Audio",
"fr/SERVICE_AUDIO": "French - Audio",
"it/SERVICE_AUDIO": "Italian - Audio",
"ja/SERVICE_AUDIO": "Japanese - Audio",
"ko/SERVICE_AUDIO": "Korean - Audio",
"pt/SERVICE_AUDIO": "Portuguese - Audio",
"ru/SERVICE_AUDIO": "Russian - Audio",
"tw/SERVICE_AUDIO": "Chinese (Traditional) - Audio"
},
"merchantNetPriceFrom": 351.9,
"merchantNetPriceFromFormatted": "€351,90",
"priceFrom": 413.02,
"priceFromFormatted": "€413,02",
"sortOrder": 18
},
{
"currencyCode": "EUR",
"defaultLanguageCode": "en",
"gradeCode": "TG4~12:15",
"gradeDepartureTime": "12:15 PM",
"gradeDescription": "Afternoon departure between 12pm and 4:15pm on an EC-130 Helicopter for the All American Helicopter Tour",
"gradeTitle": "Afternoon Departure; EC-130 12:15",
"langServices": {
"de/SERVICE_AUDIO": "German - Audio",
"en/SERVICE_AUDIO": "English - Audio",
"es/SERVICE_AUDIO": "Spanish - Audio",
"fr/SERVICE_AUDIO": "French - Audio",
"it/SERVICE_AUDIO": "Italian - Audio",
"ja/SERVICE_AUDIO": "Japanese - Audio",
"ko/SERVICE_AUDIO": "Korean - Audio",
"pt/SERVICE_AUDIO": "Portuguese - Audio",
"ru/SERVICE_AUDIO": "Russian - Audio",
"tw/SERVICE_AUDIO": "Chinese (Traditional) - Audio"
},
"merchantNetPriceFrom": 371.45,
"merchantNetPriceFromFormatted": "€371,45",
"priceFrom": 435.96,
"priceFromFormatted": "€435,96",
"sortOrder": 19
},
{
"currencyCode": "EUR",
"defaultLanguageCode": "en",
"gradeCode": "TG4~12:30",
"gradeDepartureTime": "12:30 PM",
"gradeDescription": "Afternoon departure between 12pm and 4:15pm on an EC-130 Helicopter for the All American Helicopter Tour",
"gradeTitle": "Afternoon Departure; EC-130 12:30",
"langServices": {
"de/SERVICE_AUDIO": "German - Audio",
"en/SERVICE_AUDIO": "English - Audio",
"es/SERVICE_AUDIO": "Spanish - Audio",
"fr/SERVICE_AUDIO": "French - Audio",
"it/SERVICE_AUDIO": "Italian - Audio",
"ja/SERVICE_AUDIO": "Japanese - Audio",
"ko/SERVICE_AUDIO": "Korean - Audio",
"pt/SERVICE_AUDIO": "Portuguese - Audio",
"ru/SERVICE_AUDIO": "Russian - Audio",
"tw/SERVICE_AUDIO": "Chinese (Traditional) - Audio"
},
"merchantNetPriceFrom": 371.45,
"merchantNetPriceFromFormatted": "€371,45",
"priceFrom": 435.96,
"priceFromFormatted": "€435,96",
"sortOrder": 20
},
{
"currencyCode": "EUR",
"defaultLanguageCode": "en",
"gradeCode": "TG4~13:30",
"gradeDepartureTime": "1:30 PM",
"gradeDescription": "Afternoon departure between 12pm and 4:15pm on an EC-130 Helicopter for the All American Helicopter Tour",
"gradeTitle": "Afternoon Departure; EC-130 13:30",
"langServices": {
"de/SERVICE_AUDIO": "German - Audio",
"en/SERVICE_AUDIO": "English - Audio",
"es/SERVICE_AUDIO": "Spanish - Audio",
"fr/SERVICE_AUDIO": "French - Audio",
"it/SERVICE_AUDIO": "Italian - Audio",
"ja/SERVICE_AUDIO": "Japanese - Audio",
"ko/SERVICE_AUDIO": "Korean - Audio",
"pt/SERVICE_AUDIO": "Portuguese - Audio",
"ru/SERVICE_AUDIO": "Russian - Audio",
"tw/SERVICE_AUDIO": "Chinese (Traditional) - Audio"
},
"merchantNetPriceFrom": 371.45,
"merchantNetPriceFromFormatted": "€371,45",
"priceFrom": 435.96,
"priceFromFormatted": "€435,96",
"sortOrder": 21
},
{
"currencyCode": "EUR",
"defaultLanguageCode": "en",
"gradeCode": "TG4~15:00",
"gradeDepartureTime": "3:00 PM",
"gradeDescription": "Afternoon departure between 12pm and 4:15pm on an EC-130 Helicopter for the All American Helicopter Tour",
"gradeTitle": "Afternoon Departure; EC-130 15:00",
"langServices": {
"de/SERVICE_AUDIO": "German - Audio",
"en/SERVICE_AUDIO": "English - Audio",
"es/SERVICE_AUDIO": "Spanish - Audio",
"fr/SERVICE_AUDIO": "French - Audio",
"it/SERVICE_AUDIO": "Italian - Audio",
"ja/SERVICE_AUDIO": "Japanese - Audio",
"ko/SERVICE_AUDIO": "Korean - Audio",
"pt/SERVICE_AUDIO": "Portuguese - Audio",
"ru/SERVICE_AUDIO": "Russian - Audio",
"tw/SERVICE_AUDIO": "Chinese (Traditional) - Audio"
},
"merchantNetPriceFrom": 371.45,
"merchantNetPriceFromFormatted": "€371,45",
"priceFrom": 435.96,
"priceFromFormatted": "€435,96",
"sortOrder": 22
},
{
"currencyCode": "EUR",
"defaultLanguageCode": "en",
"gradeCode": "TG4~15:15",
"gradeDepartureTime": "3:15 PM",
"gradeDescription": "Afternoon departure between 12pm and 4:15pm on an EC-130 Helicopter for the All American Helicopter Tour",
"gradeTitle": "Afternoon Departure; EC-130 15:15",
"langServices": {
"de/SERVICE_AUDIO": "German - Audio",
"en/SERVICE_AUDIO": "English - Audio",
"es/SERVICE_AUDIO": "Spanish - Audio",
"fr/SERVICE_AUDIO": "French - Audio",
"it/SERVICE_AUDIO": "Italian - Audio",
"ja/SERVICE_AUDIO": "Japanese - Audio",
"ko/SERVICE_AUDIO": "Korean - Audio",
"pt/SERVICE_AUDIO": "Portuguese - Audio",
"ru/SERVICE_AUDIO": "Russian - Audio",
"tw/SERVICE_AUDIO": "Chinese (Traditional) - Audio"
},
"merchantNetPriceFrom": 371.45,
"merchantNetPriceFromFormatted": "€371,45",
"priceFrom": 435.96,
"priceFromFormatted": "€435,96",
"sortOrder": 23
},
{
"currencyCode": "EUR",
"defaultLanguageCode": "en",
"gradeCode": "TG4~16:15",
"gradeDepartureTime": "4:15 PM",
"gradeDescription": "Afternoon departure between 12pm and 4:15pm on an EC-130 Helicopter for the All American Helicopter Tour",
"gradeTitle": "Afternoon Departure; EC-130 16:15",
"langServices": {
"de/SERVICE_AUDIO": "German - Audio",
"en/SERVICE_AUDIO": "English - Audio",
"es/SERVICE_AUDIO": "Spanish - Audio",
"fr/SERVICE_AUDIO": "French - Audio",
"it/SERVICE_AUDIO": "Italian - Audio",
"ja/SERVICE_AUDIO": "Japanese - Audio",
"ko/SERVICE_AUDIO": "Korean - Audio",
"pt/SERVICE_AUDIO": "Portuguese - Audio",
"ru/SERVICE_AUDIO": "Russian - Audio",
"tw/SERVICE_AUDIO": "Chinese (Traditional) - Audio"
},
"merchantNetPriceFrom": 371.45,
"merchantNetPriceFromFormatted": "€371,45",
"priceFrom": 435.96,
"priceFromFormatted": "€435,96",
"sortOrder": 24
}
],
"tourGradesAvailable": true,
"translationLevel": 0,
"userPhotos": [
{
"caption": "Grand Canyon All-American Helicopter Tour",
"editorsPick": false,
"ownerAvatarURL": "http://cache-graphicslib.viator.com/graphicslib/media/09/viator-insider-account_9179657-45sq.jpg",
"ownerCountry": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"ownerId": 9179657,
"ownerName": "Viator Insider",
"photoHiResURL": "http://cache-graphicslib.viator.com/graphicslib/media/01/img_4048-jpg-photo_30186497-1536tall.jpg",
"photoId": 30186497,
"photoMediumResURL": "http://cache-graphicslib.viator.com/graphicslib/media/01/img_4048-jpg-photo_30186497-260tall.jpg",
"photoURL": "http://cache-graphicslib.viator.com/graphicslib/media/01/img_4048-jpg-photo_30186497-770tall.jpg",
"productCode": "2280AAHT",
"productTitle": "Grand Canyon All-American Helicopter Tour",
"productUrlName": "Grand-Canyon-All-American-Helicopter-Tour",
"sortOrder": 1,
"sslSupported": false,
"thumbnailURL": "http://cache-graphicslib.viator.com/graphicslib/media/01/img_4048-jpg-photo_30186497-133sq.jpg",
"timeUploaded": "2018-01-26",
"title": "IMG_4048.jpg"
},
{
"caption": "Grand Canyon All-American Helicopter Tour",
"editorsPick": false,
"ownerAvatarURL": "http://cache-graphicslib.viator.com/graphicslib/media/09/viator-insider-account_9179657-45sq.jpg",
"ownerCountry": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"ownerId": 9179657,
"ownerName": "Viator Insider",
"photoHiResURL": "http://cache-graphicslib.viator.com/graphicslib/media/f5/img_4102-jpg-photo_30186485-1536tall.jpg",
"photoId": 30186485,
"photoMediumResURL": "http://cache-graphicslib.viator.com/graphicslib/media/f5/img_4102-jpg-photo_30186485-260tall.jpg",
"photoURL": "http://cache-graphicslib.viator.com/graphicslib/media/f5/img_4102-jpg-photo_30186485-770tall.jpg",
"productCode": "2280AAHT",
"productTitle": "Grand Canyon All-American Helicopter Tour",
"productUrlName": "Grand-Canyon-All-American-Helicopter-Tour",
"sortOrder": 2,
"sslSupported": false,
"thumbnailURL": "http://cache-graphicslib.viator.com/graphicslib/media/f5/img_4102-jpg-photo_30186485-133sq.jpg",
"timeUploaded": "2018-01-26",
"title": "IMG_4102.jpg"
}
],
"videoCount": 1,
"videos": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"voucherOption": "VOUCHER_E",
"voucherRequirements": "You can present either a paper or an electronic voucher for this activity.",
"webURL": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
}
},
"dateStamp": "2020-02-06T18:19:27+0000",
"errorCodes": [],
"errorMessage": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorMessageText": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorName": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorReference": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorType": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"extraInfo": {},
"extraObject": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"success": true,
"totalCount": 1,
"vmid": "331003"
}
},
"product-photos-example": {
"summary": "product photos example",
"value": {
"data": [
{
"caption": "<p>Carl and Karen meeting a new friend at the Wildlife park.</p>",
"editorsPick": true,
"ownerAvatarURL": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"ownerCountry": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"ownerId": 1755909,
"ownerName": "Husker1k",
"photoHiResURL": "http://cache-graphicslib.viator.com/graphicslib/media/e4/dsc00471-photo_1909732-1536tall.jpg",
"photoId": 1909732,
"photoMediumResURL": "http://cache-graphicslib.viator.com/graphicslib/media/e4/dsc00471-photo_1909732-260tall.jpg",
"photoURL": "http://cache-graphicslib.viator.com/graphicslib/media/e4/dsc00471-photo_1909732-770tall.jpg",
"productCode": "5010SYDNEY",
"productTitle": "Big Bus Sydney and Bondi Hop-on Hop-off Tour",
"productUrlName": "Sydney-and-Bondi-Hop-on-Hop-off-Tour",
"sortOrder": 1,
"sslSupported": false,
"thumbnailURL": "http://cache-graphicslib.viator.com/graphicslib/media/e4/dsc00471-photo_1909732-133sq.jpg",
"timeUploaded": "2012-02-07",
"title": "DSC00471"
},
{
"caption": "Sydney Opera House",
"editorsPick": true,
"ownerAvatarURL": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"ownerCountry": "Australia",
"ownerId": 288013,
"ownerName": "Kylie G",
"photoHiResURL": "http://cache-graphicslib.viator.com/graphicslib/media/f2/sydney-opera-house-photo_997106-1536tall.jpg",
"photoId": 997106,
"photoMediumResURL": "http://cache-graphicslib.viator.com/graphicslib/media/f2/sydney-opera-house-photo_997106-260tall.jpg",
"photoURL": "http://cache-graphicslib.viator.com/graphicslib/media/f2/sydney-opera-house-photo_997106-770tall.jpg",
"productCode": "5010SYDNEY",
"productTitle": "Big Bus Sydney and Bondi Hop-on Hop-off Tour",
"productUrlName": "Sydney-and-Bondi-Hop-on-Hop-off-Tour",
"sortOrder": 2,
"sslSupported": false,
"thumbnailURL": "http://cache-graphicslib.viator.com/graphicslib/media/f2/sydney-opera-house-photo_997106-133sq.jpg",
"timeUploaded": "2009-07-22",
"title": "Sydney Opera House"
},
{
"caption": "<p>This was taken from a water taxi</p>",
"editorsPick": false,
"ownerAvatarURL": "http://cache-graphicslib.viator.com/graphicslib/media/d7/sheila-t-account_1327319-45sq.jpg",
"ownerCountry": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"ownerId": 1327319,
"ownerName": "Sheila T",
"photoHiResURL": "http://cache-graphicslib.viator.com/graphicslib/media/8a/-photo_31376266-1536tall.jpg",
"photoId": 31376266,
"photoMediumResURL": "http://cache-graphicslib.viator.com/graphicslib/media/8a/-photo_31376266-260tall.jpg",
"photoURL": "http://cache-graphicslib.viator.com/graphicslib/media/8a/-photo_31376266-770tall.jpg",
"productCode": "5010SYDNEY",
"productTitle": "Big Bus Sydney and Bondi Hop-on Hop-off Tour",
"productUrlName": "Sydney-and-Bondi-Hop-on-Hop-off-Tour",
"sortOrder": 3,
"sslSupported": false,
"thumbnailURL": "http://cache-graphicslib.viator.com/graphicslib/media/8a/-photo_31376266-133sq.jpg",
"timeUploaded": "2018-03-28",
"title": ""
}
],
"dateStamp": "2020-02-10T15:32:59+0000",
"errorCodes": [],
"errorMessage": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorMessageText": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorName": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorReference": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorType": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"extraInfo": {},
"extraObject": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"success": true,
"totalCount": 118,
"vmid": "331001"
}
},
"product-reviews-example": {
"summary": "product reviews example",
"value": {
"data": [
{
"ownerAvatarURL": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"ownerCountry": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"ownerId": 29510203,
"ownerName": "Lauren",
"productCode": "5010SYDNEY",
"productTitle": "Big Bus Sydney and Bondi Hop-on Hop-off Tour",
"productUrlName": "Sydney-and-Bondi-Hop-on-Hop-off-Tour",
"publishedDate": "2019-12-31",
"rating": 1,
"review": "<p>We did the hop on hop off bus for the second half of our day. The buses were supposed to stop running at 7:30 pm. At 6:58 our bus driver kicked everyone off the bus before the end time. We were almost 3 miles from our hotel. We all asked if we could get off at an actual stop which was 2 miles closer to our hotel and the driver said no. I want my money back because it was awful!!! I would give 0 stars if I could!</p>",
"reviewId": 63679157,
"sortOrder": 1,
"sslSupported": false,
"submissionDate": "2019-11-04",
"viatorFeedback": "",
"viatorNotes": ""
},
{
"ownerAvatarURL": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"ownerCountry": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"ownerId": 30185188,
"ownerName": "Robin R",
"productCode": "5010SYDNEY",
"productTitle": "Big Bus Sydney and Bondi Hop-on Hop-off Tour",
"productUrlName": "Sydney-and-Bondi-Hop-on-Hop-off-Tour",
"publishedDate": "2018-05-09",
"rating": 1,
"review": "<p>The bus was so crowded people were standing in the aisle which made it very difficult to see the sights. I got the last available seat which was facing backwards, so what little I could see, was of no value. The audio system was unusable because the sound quality was terrible. </p>\n\n<p>When we finally got to Bondi Beach which was lovely, we opted to uber back to our hotel which was much more convenient, efficient and had unobstructed views.</p>",
"reviewId": 32425348,
"sortOrder": 2,
"sslSupported": false,
"submissionDate": "2018-05-09",
"viatorFeedback": "",
"viatorNotes": ""
},
{
"ownerAvatarURL": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"ownerCountry": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"ownerId": 29062502,
"ownerName": "Nancy S",
"productCode": "5010SYDNEY",
"productTitle": "Big Bus Sydney and Bondi Hop-on Hop-off Tour",
"productUrlName": "Sydney-and-Bondi-Hop-on-Hop-off-Tour",
"publishedDate": "2018-03-26",
"rating": 1,
"review": "<p>There were not buses. At one stop we waited almost 30 minutes and then the bus was so crowded we had to stand. We had bought our tickets in advance to be sure to have a place on the bus but when we got on they were still selling tickets. Never again.</p>",
"reviewId": 31322881,
"sortOrder": 3,
"sslSupported": false,
"submissionDate": "2018-03-26",
"viatorFeedback": "",
"viatorNotes": ""
}
],
"dateStamp": "2020-02-09T19:05:03+0000",
"errorCodes": [],
"errorMessage": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorMessageText": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorName": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorReference": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorType": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"extraInfo": {},
"extraObject": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"success": true,
"totalCount": 1561,
"vmid": "331004"
}
},
"search-freetext-example-1": {
"summary": "by attraction or recommendation",
"value": {
"data": [
{
"data": {
"attractionCity": "Peach Springs",
"attractionLatitude": 36.011871,
"attractionLongitude": -113.81094,
"attractionState": "Arizona",
"attractionStreetAddress": "Eagle Point Road",
"descriptionIntro": "Grand Canyon Skywalk",
"descriptionText": "The Grand Canyon Skywalk is a glass, 70-foot long, open-air bridge suspended 4,000 feet above the canyon floor, providing 720-degree views. The Skywalk is operated by the Hualapai Tribe, which owns and protects more than one million acres of land throughout the Grand Canyon’s western rim. Even with its remote location some 120 miles from Las Vegas, you can easily experience the Grand Canyon Skywalk on a day trip or overnight excursion to the West Rim.",
"destinationId": 684,
"editorsPick": false,
"keywordCount": 0,
"keywords": [],
"overviewSummary": "<div style=\"\">There’s no doubt that 4,000 feet (1,220 meters) is a long way down, especially when standing on a bridge made of glass—and you’re looking down toward the Grand Canyon floor. That’s the experience visitors find at the Grand Canyon Skywalk, a horseshoe-shaped, glass-bottomed bridge that juts out 70 feet (20 meters) above one of America’s most scenic sites. Travelers who step out onto the bridge are rewarded with panoramic West Rim and Colorado River views that extend 720 degrees, wrapping around, below, and behind.&nbsp;</div><div style=\"\"><br></div><div style=\"\"><b>The Basics</b></div><div style=\"\">Most tours to the Grand Canyon Skywalk begin in Las Vegas, where travelers head east to the Arizona desert by road, plane, or helicopter. A Skywalk ticket can be combined with a Hoover Dam trip or a scenic helicopter tour over the canyon, while other options include visits with Hualapai tribe members or a boat ride up the Colorado River. Those short on time can opt for a skip-the-line experience.</div><div style=\"\"><br></div><div style=\"\"><b>Things to Know Before You Go</b></div><div style=\"\"><ul><li>The Skywalk is a must-visit for thrill-seekers.<br></li><li>Cameras aren’t permitted on the Skywalk, but it is possible to purchase photos from Grand Canyon West’s professional photographers.<br></li><li>Outside food and drink are not permitted within Grand Canyon West or on the Skywalk.<br></li><li>Tours to the Skywalk can last upwards of nine hours depending on the option chosen.<br></li></ul></div><div style=\"\"><br></div><div style=\"\"><b>How to Get There</b></div><div style=\"\">McCarran International Airport in Las Vegas is the nearest commercial airport to the Skywalk bridge, about two hours away by road. Because the Grand Canyon Skywalk is a part of Grand Canyon West—a remote and rugged section of canyon managed by the Hualapai—entry to the bridge can only be purchased as part of a package excursion. While many visitors come on a guided tour, it’s also possible to drive yourself to Grand Canyon West, then take the hop-on, hop-off shuttle to the Skywalk and other attractions.</div><div style=\"\"><br></div><div style=\"\"><b>When to Get There</b></div><div style=\"\">Daytime temperatures at the Grand Canyon hover at or above 85°F (30°C) in summer, making fall and spring much more appealing times to visit. The glass bridge tends to be busiest around midday, so plan to arrive in the morning or later in the afternoon to ensure you have more elbow room.</div><div style=\"\"><b><br></b></div><div style=\"\"><b>Other Activities at Grand Canyon West</b></div><div style=\"\">The Grand Canyon West complex lies outside the national park and is operated by the Hualapai tribe. In addition to the Skywalk, visitors can explore an American Indian village at Eagle Point, cruise along the Colorado River, hike to the ruins of an old guano mine, or even rent a rustic cabin at Hualapai Ranch.</div>",
"pagePrimaryLanguage": "en",
"pageTitle": "Grand Canyon Skywalk",
"pageUrlName": "Grand-Canyon-Skywalk",
"panoramaCount": 0,
"photoCount": 110,
"primaryDestinationId": 684,
"primaryDestinationName": "Las Vegas",
"primaryDestinationUrlName": "Las-Vegas",
"productCount": 10,
"publishedDate": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"rating": 4.5,
"reviewCount": 1695,
"seoId": 10,
"seoType": "ATTRACTION",
"showPhotos": false,
"showReviews": false,
"sortOrder": 1,
"tabTitle": "Grand Canyon Skywalk",
"thumbnailHiResURL": "http://cache-graphicslib.viator.com/graphicslib/page-images/742x525/100565_Las%20Vegas_Grand%20Canyon%20Skywalk_d684-224.jpg",
"thumbnailURL": "http://cache-graphicslib.viator.com/graphicslib/page-images/100565_Las%20Vegas_Grand%20Canyon%20Skywalk_d684-224.jpg",
"title": "Grand Canyon Skywalk",
"userName": "",
"webURL": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
}
},
"searchType": "ATTRACTION",
"sortOrder": 1
},
{
"data": {
"attractionCity": "Grand Canyon National Park",
"attractionLatitude": 36.059053,
"attractionLongitude": -112.12825,
"attractionState": "Arizona",
"attractionStreetAddress": "",
"descriptionIntro": "Grand Canyon South Rim\n",
"descriptionText": "<p>Of the two major rims of the Grand Canyon, many visitors choose the South Rim, which boasts easy access, the bulk of services, and the panoramic vistas for which the park is famous. Every summer, visitors throng the park's most popular rim, mainly to ogle its easily accessible dramatic, sweeping canyon views.</p><p>\n\nBut the Grand Canyon South Rim is more then those spectacular canyon views. The first stop for many is Grand Canyon Village, which is filled with many historic buildings. Other historic highlights in the South Rim is Desert View Watchtower, which has one of the few views of the bottom of the Canyon and the Colorado River; Grand Canyon Railway Depot, built in 1909; and Bright Angel Lodge, a rustic lodge built of logs and stones.</p><p>\n\nFor hikers, the Grand Canyon South Rim is where you'll find Bright Angel Trail, Rim Trail, and South Kaibab Trail - all of which offer the most dazzling views of the Grand Canyon.</p>",
"destinationId": 684,
"editorsPick": true,
"keywordCount": 0,
"keywords": [],
"overviewSummary": "The South Rim is the most popular area of Grand Canyon National Park, boasting easy access to the canyon, the bulk of available amenities and services, and the panoramic vistas for which the natural wonder is famous. One of the most famous attractions in the American Southwest, the area offers breathtaking views over the Colorado River and the chance to immerse yourself in Native American culture.<div><br><b>The Basics<br></b>The South Rim of the Grand Canyon averages 7,000 feet (2,134 meters) above sea level, with natural wonders including Navajo Point, Hermit Road, and the Abyss. Grand Canyon Village is home to a variety of historic buildings, while other popular stops include the Grand Canyon Railway Depot, the Bright Angel Lodge, Kolb Studio, and the Desert View Watchtower, which features work by Hopi artists and incorporates Native American art and design.</div><div><br></div><div>Choosing a group bus tour, helicopter tour, air tour, or a self-drive tour makes the South Rim conveniently accessible from Las Vegas. Tours also leave from Sedona and Phoenix, and some combine the trip with a visit to the West Rim, the North Rim, or the Hoover Dam. A Grand Canyon helicopter tour is undoubtedly the fastest and most dramatic way to visit the canyon from Vegas.</div><div><br></div><div><b>Things to Know Before You Go</b><br><ul><li>The Canyon View Visitor Center, near the south entrance, stocks maps, books, and videos, while the Cameron Trading Post, outside the east entrance to the park, boasts a selection of souvenirs and supplies.<br></li><li>Stop by the Hopi House Gift Store and Art Gallery to see art and crafts from the local tribes.<br></li><li>If driving, be sure you have plenty of gas in your car before setting out for the canyon; there are few service stations in this remote part of Arizona.<br></li></ul><div><br></div><b>How to Get There<br></b>Located in the Arizona national park, the South Rim is a three-hour drive from Las Vegas or a short plane ride via Grand Canyon Airport. Driving from Flagstaff, take US 180 directly to the South Rim or US 89 to Arizona 64 and the east entrance to the park.</div><div><br><b>When to Get There<br></b>The South Rim gets quite crowded with visitors in the summertime. Consider visiting in the shoulder season, or booking a South Rim bus or jeep tour so you don't have to struggle with traffic and parking.</div><div><br><b>Hiking the Grand Canyon South Rim</b></div><div>The Grand Canyon South Rim is home to the Bright Angel Trail, Rim Trail, and South Kaibab Trail—all of which offer the most dazzling views of the canyon. Keep your eyes open for the regal California condors, which have recently returned to the area.</div>",
"pagePrimaryLanguage": "en",
"pageTitle": "Grand Canyon South Rim",
"pageUrlName": "Grand-Canyon-South-Rim",
"panoramaCount": 0,
"photoCount": 54,
"primaryDestinationId": 684,
"primaryDestinationName": "Las Vegas",
"primaryDestinationUrlName": "Las-Vegas",
"productCount": 11,
"publishedDate": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"rating": 4,
"reviewCount": 32,
"seoId": 1249,
"seoType": "ATTRACTION",
"showPhotos": false,
"showReviews": false,
"sortOrder": 2,
"tabTitle": "Grand Canyon South",
"thumbnailHiResURL": "http://cache-graphicslib.viator.com/graphicslib/page-images/742x525/811289_grand-canyon-south-rim.jpg",
"thumbnailURL": "http://cache-graphicslib.viator.com/graphicslib/page-images/811289_grand-canyon-south-rim.jpg",
"title": "Grand Canyon South Rim",
"userName": "",
"webURL": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
}
},
"searchType": "ATTRACTION",
"sortOrder": 2
},
{
"data": {
"attractionCity": "",
"attractionLatitude": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"attractionLongitude": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"attractionState": "",
"attractionStreetAddress": "",
"descriptionIntro": "",
"descriptionText": "",
"destinationId": 684,
"editorsPick": false,
"keywordCount": 0,
"keywords": [],
"overviewSummary": "<div>The Grand Canyon is an inspiring sight from any angle, but seeing it from the air is an unforgettable experience. With a helicopter tour from Las Vegas, you'll travel in style and enjoy incredible aerial views of the canyon. Here are your options.</div><div><br></div><div><b>Highlights</b></div><div><ul><li>Skip the tour bus and reach the Grand Canyon in just 45 minutes on a helicopter ride from Las Vegas.</li><li>Catch views of the famous Las Vegas Strip from above on your way in and out of the city.</li><li>Take in the natural beauty of the Grand Canyon and the Colorado River through expansive helicopter windows.</li><li>Enjoy easy access to the sights of your choices, from scenic overlooks to the Grand Canyon Skywalk.<br></li><li>Most tours also fly low over the Hoover Dam, affording more scenic views.</li></ul></div><div><br></div><div><b>VIP & Exclusive Tours</b></div><div>From pickup in a luxury vehicle to a multi-course gourmet meal in the canyon, VIP tours kick things up a notch. Choose a tour that pairs your helicopter ride with a below-the-rim landing, a seated meal, or a sunset champagne toast and picnic set at the canyon with table linens and fine china.</div><div><br></div><div><b>Combo Tours</b></div><div>If you have extra time, add to your Grand Canyon helicopter experience with a boat trip on the Colorado River, a stroll out on the Grand Canyon Skywalk, or some free time for hiking and exploring the national park's West Rim.</div>",
"pagePrimaryLanguage": "en",
"pageTitle": "Grand Canyon Helicopter Tours from Las Vegas",
"pageUrlName": "Grand-Canyon-Helicopter-Tours-from-Las-Vegas",
"panoramaCount": 0,
"photoCount": 229,
"primaryDestinationId": 684,
"primaryDestinationName": "Las Vegas",
"primaryDestinationUrlName": "Las-Vegas",
"productCount": 6,
"publishedDate": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"rating": 4.5,
"reviewCount": 2652,
"seoId": 26043,
"seoType": "RECOMMENDATION",
"showPhotos": false,
"showReviews": false,
"sortOrder": 3,
"tabTitle": "",
"thumbnailHiResURL": "http://cache-graphicslib.viator.com/graphicslib/page-images/742x525/668530_Viator_Photographer_392432.jpg",
"thumbnailURL": "http://cache-graphicslib.viator.com/graphicslib/page-images/668530_Viator_Photographer_392432.jpg",
"title": "Grand Canyon Helicopter Tours from Las Vegas",
"userName": "",
"webURL": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
}
},
"searchType": "RECOMMENDATION",
"sortOrder": 3
}
],
"dateStamp": "2021-02-01T18:35:40+0000",
"errorCodes": [],
"errorMessage": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorMessageText": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorName": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorReference": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorType": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"extraInfo": {},
"extraObject": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"success": true,
"totalCount": 54,
"vmid": "331004"
}
},
"search-freetext-example-2": {
"summary": "by product or destination",
"value": {
"data": [
{
"data": {
"admission": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"available": true,
"bookingEngineId": "FreesaleBE",
"catIds": [
18
],
"code": "2596GCWED",
"currencyCode": "EUR",
"duration": "3 hours 30 minutes",
"essential": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"merchantCancellable": true,
"merchantNetPriceFrom": 1518.53,
"merchantNetPriceFromFormatted": "€1.518,53",
"onRequestPeriod": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"onSale": false,
"panoramaCount": 0,
"pas": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"photoCount": 5,
"price": 1828.02,
"priceFormatted": "€1.828,02",
"primaryDestinationId": 684,
"primaryDestinationName": "Las Vegas",
"primaryDestinationUrlName": "Las-Vegas",
"primaryGroupId": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"productUrlName": "Grand-Canyon-Helicopter-Wedding",
"rating": 5,
"reviewCount": 10,
"rrp": 0,
"rrpformatted": "",
"savingAmount": 0,
"savingAmountFormated": "",
"shortDescription": "Make your special day even more memorable! Say \"I do\" in the Grand Canyon and fly from Las Vegas in a six-seater helicopter. All the arrangements are made for you, and you can even have an Elvis or Johnny Cash impersonator perform the ceremony (additional cost).",
"shortTitle": "Grand Canyon Helicopter Wedding",
"sortOrder": 1,
"specialOfferAvailable": false,
"specialReservation": false,
"specialReservationDetails": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"sslSupported": false,
"subCatIds": [
61,
62
],
"supplierCode": "2596",
"supplierName": "A Special Memory Wedding Chapel",
"thumbnailHiResURL": "https://hare-media-cdn.tripadvisor.com/media/attractions-splice-spp-674x446/07/a4/cf/24.jpg",
"thumbnailURL": "https://hare-media-cdn.tripadvisor.com/media/attractions-splice-spp-154x109/07/a4/cf/24.jpg",
"title": "Grand Canyon Helicopter Wedding",
"translationLevel": 0,
"uniqueShortDescription": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"videoCount": 0,
"webURL": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
}
},
"searchType": "PRODUCT",
"sortOrder": 1
},
{
"data": {
"admission": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"available": true,
"bookingEngineId": "FreesaleBE",
"catIds": [
16,
5,
9,
25,
12
],
"code": "43493P1",
"currencyCode": "EUR",
"duration": "15 hours",
"essential": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"merchantCancellable": true,
"merchantNetPriceFrom": 59.32,
"merchantNetPriceFromFormatted": "€59,32",
"onRequestPeriod": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"onSale": false,
"panoramaCount": 0,
"pas": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"photoCount": 0,
"price": 82.66,
"priceFormatted": "€82,66",
"primaryDestinationId": 684,
"primaryDestinationName": "Las Vegas",
"primaryDestinationUrlName": "Las-Vegas",
"primaryGroupId": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"productUrlName": "Grand-Canyon-South-Rim-Day-Tour-from-Las-Vegas",
"rating": 4.2,
"reviewCount": 32,
"rrp": 0,
"rrpformatted": "",
"savingAmount": 0,
"savingAmountFormated": "",
"shortDescription": "Journey to one of the Seven Wonders of the World on this day tour from Las Vegas. After hotel pick-up from most hotels on the Strip, you'll head out to the beautiful South Rim for 3 hours. Your guide will provide you with some suggested itineraries to help maximize your time here.AT THIS TIME, THE GRAND CANYON NATIONAL PARK HAS PLACED RESTRICTIONS ON GROUP TOURS TO THE SOUTH RIM DUE TO COVID19. THEY HAVE NOT SET A SPECIFIC DATE ON WHEN RESTRICTIONS WILL BE LIFTED; HOWEVER, WE ARE ACCEPTING RESERVATIONS GIVEN THE RESTRICTIONS CAN BE REMOVED AT ANY TIME. AS THE DAY OF YOUR TOUR ARRIVES, WE WILL CONTACT YOU TO INFORM YOU IF THE TOUR WILL BE OPERATING OR NOT. IF IT DOES NOT, WE CAN ISSUE YOU A FULL REFUND OR WE CAN OFFER YOU TO MOVE TO THE GRAND CANYON WEST RIM TOUR. THE WEST RIM IS CURRENTLY OPEN AND WE ARE OPERATING TOURS THERE ON A REGULAR BASIS.<br>",
"shortTitle": "Grand Canyon South Rim Bus Tour",
"sortOrder": 2,
"specialOfferAvailable": false,
"specialReservation": false,
"specialReservationDetails": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"sslSupported": false,
"subCatIds": [
113,
98,
36,
56,
94,
15
],
"supplierCode": "43493",
"supplierName": "Sweetours",
"thumbnailHiResURL": "https://hare-media-cdn.tripadvisor.com/media/attractions-splice-spp-674x446/0b/30/7e/e9.jpg",
"thumbnailURL": "https://hare-media-cdn.tripadvisor.com/media/attractions-splice-spp-154x109/0b/30/7e/e9.jpg",
"title": "Grand Canyon South Rim Bus Tour",
"translationLevel": 0,
"uniqueShortDescription": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"videoCount": 0,
"webURL": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
}
},
"searchType": "PRODUCT",
"sortOrder": 2
},
{
"data": {
"defaultCurrencyCode": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"destinationId": 23971,
"destinationName": "Grand Baie",
"destinationType": "CITY",
"destinationUrlName": "Grand-Baie",
"iataCode": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"latitude": -20.007281,
"longitude": 57.586106,
"lookupId": "1.4463.23971",
"parentId": 4463,
"selectable": true,
"sortOrder": 3,
"timeZone": "Indian/Mauritius"
},
"searchType": "DESTINATION",
"sortOrder": 3
}
],
"dateStamp": "2021-02-01T18:35:40+0000",
"errorCodes": [],
"errorMessage": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorMessageText": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorName": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorReference": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorType": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"extraInfo": {},
"extraObject": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"success": true,
"totalCount": 54,
"vmid": "331004"
}
},
"search-products-codes-example-1": {
"summary": "two valid products",
"value": {
"data": [
{
"admission": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"available": true,
"bookingEngineId": "UnconditionalBE",
"catIds": [
6,
12
],
"code": "5010SYDNEY",
"currencyCode": "EUR",
"duration": "2 hours",
"essential": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"merchantCancellable": true,
"merchantNetPriceFrom": 26.64,
"merchantNetPriceFromFormatted": "€26,64",
"onRequestPeriod": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"onSale": false,
"panoramaCount": 0,
"pas": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"photoCount": 124,
"price": 33.35,
"priceFormatted": "€33,35",
"primaryDestinationId": 357,
"primaryDestinationName": "Sydney",
"primaryDestinationUrlName": "Sydney",
"primaryGroupId": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"productUrlName": "Sydney-and-Bondi-Hop-on-Hop-off-Tour",
"rating": 4.5,
"reviewCount": 1605,
"rrp": 0,
"rrpformatted": "",
"savingAmount": 0,
"savingAmountFormated": "",
"shortDescription": "Explore Sydney and Bondi Beach on this hop-on hop-off sightseeing tour, which takes you by double-decker bus to 34 stops around the city including Sydney Opera House, Sydney Harbour Bridge, Darling Harbour, Bondi Beach and more. Enjoy unobstructed views and recorded commentary on board. Simply hop off to walk around and sightsee in depth. Your ticket is valid for 24 or 48 hours, so you can experience Sydney and Bondi's most noteworthy attractions, sights, and shopping and dining areas at your own pace.",
"shortTitle": "Big Bus Sydney and Bondi Hop-on Hop-off Tour",
"sortOrder": 1,
"specialOfferAvailable": false,
"specialReservation": false,
"specialReservationDetails": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"sslSupported": false,
"subCatIds": [
97,
98,
5330,
26963,
32024,
45
],
"supplierCode": "5010",
"supplierName": "Big Bus Tours",
"thumbnailHiResURL": "https://hare-media-cdn.tripadvisor.com/media/attractions-splice-spp-674x446/07/94/40/f3.jpg",
"thumbnailURL": "https://hare-media-cdn.tripadvisor.com/media/attractions-splice-spp-154x109/07/94/40/f3.jpg",
"title": "Big Bus Sydney and Bondi Hop-on Hop-off Tour",
"translationLevel": 0,
"uniqueShortDescription": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"videoCount": 1,
"webURL": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
}
},
{
"admission": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"available": true,
"bookingEngineId": "FreesaleOnRequestBE",
"catIds": [
1,
25,
12
],
"code": "2280SUN",
"currencyCode": "EUR",
"duration": "3 hours 30 minutes",
"essential": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"merchantCancellable": true,
"merchantNetPriceFrom": 386.11,
"merchantNetPriceFromFormatted": "€386,11",
"onRequestPeriod": 336,
"onSale": false,
"panoramaCount": 0,
"pas": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"photoCount": 7,
"price": 449.74,
"priceFormatted": "€449,74",
"primaryDestinationId": 684,
"primaryDestinationName": "Las Vegas",
"primaryDestinationUrlName": "Las-Vegas",
"primaryGroupId": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"productUrlName": "Grand-Canyon-West-Rim-Deluxe-Sunset-Helicopter-Tour",
"rating": 5,
"reviewCount": 399,
"rrp": 0,
"rrpformatted": "",
"savingAmount": 0,
"savingAmountFormated": "",
"shortDescription": "Take off from Las Vegas on a magical sunset helicopter tour to the Grand Canyon. You'll enjoy a 45-minute helicopter flight each way, land at the Grand Canyon for a glass of Champagne and snacks while you watch the sun start it's descent behind the walls of the canyon, then fly low over the famous neon-lit Las Vegas Strip on your return.",
"shortTitle": "Grand Canyon from Las Vegas West Rim Sunset Helicopter Tour",
"sortOrder": 2,
"specialOfferAvailable": false,
"specialReservation": false,
"specialReservationDetails": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"sslSupported": false,
"subCatIds": [
113,
2,
98,
26963,
45,
95
],
"supplierCode": "2280",
"supplierName": "Sundance Helicopters",
"thumbnailHiResURL": "https://hare-media-cdn.tripadvisor.com/media/attractions-splice-spp-674x446/07/7a/ec/1c.jpg",
"thumbnailURL": "https://hare-media-cdn.tripadvisor.com/media/attractions-splice-spp-154x109/07/7a/ec/1c.jpg",
"title": "Grand Canyon West Rim Deluxe Sunset Helicopter Tour",
"translationLevel": 0,
"uniqueShortDescription": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"videoCount": 1,
"webURL": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
}
}
],
"dateStamp": "2020-02-09T16:07:17+0000",
"errorCodes": [],
"errorMessage": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorMessageText": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorName": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorReference": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorType": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"extraInfo": {},
"extraObject": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"success": true,
"totalCount": 2,
"vmid": "331003"
}
},
"search-products-codes-example-2": {
"summary": "search products example invalid product",
"value": {
"data": [],
"dateStamp": "2020-02-09T16:11:27+0000",
"errorCodes": [],
"errorMessage": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorMessageText": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorName": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorReference": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorType": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"extraInfo": {},
"extraObject": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"success": true,
"totalCount": 0,
"vmid": "331005"
}
},
"search-products-example-1": {
"summary": "search products example by destination",
"value": {
"data": [
{
"admission": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"available": true,
"bookingEngineId": "FreesaleBE",
"catIds": [
26051,
6,
50127
],
"code": "73492P4",
"currencyCode": "USD",
"duration": "1 hour",
"essential": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"merchantCancellable": false,
"merchantNetPriceFrom": 55.38,
"merchantNetPriceFromFormatted": "$55.38",
"onRequestPeriod": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"onSale": false,
"panoramaCount": 0,
"pas": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"photoCount": 0,
"price": 65,
"priceFormatted": "$65.00",
"primaryDestinationId": 684,
"primaryDestinationName": "Las Vegas",
"primaryDestinationUrlName": "Las-Vegas",
"primaryGroupId": 26051,
"productUrlName": "Viva-Las-Vinos-Wine-Yoga",
"rating": 0,
"reviewCount": 0,
"rrp": 0,
"rrpformatted": "",
"savingAmount": 0,
"savingAmountFormated": "",
"shortDescription": "Sip your wine and unwind with wine yoga! This gentle yoga class combines sipping your wine and practicing fun yoga basics in a rad environment. A tad unconventional, this class is filled with laughter, fun, and cheers-ing your neighbor.<br><br>Private parties are available upon request.<br><br>Ticket includes one glass of wine, a souvenir adult sippy (to help prevent the spillage of the wine!), and a gentle quirky yoga class.<br><br>",
"shortTitle": "Yoga Uncorked at The Gramercy",
"sortOrder": 1,
"specialOfferAvailable": false,
"specialReservation": false,
"specialReservationDetails": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"sslSupported": false,
"subCatIds": [
50128,
19,
26052,
21,
40293
],
"supplierCode": "73492",
"supplierName": "MintnHoney",
"thumbnailHiResURL": "https://hare-media-cdn.tripadvisor.com/media/attractions-splice-spp-674x446/09/27/7e/88.jpg",
"thumbnailURL": "https://hare-media-cdn.tripadvisor.com/media/attractions-splice-spp-154x109/09/27/7e/88.jpg",
"title": "Yoga Uncorked at The Gramercy",
"translationLevel": 0,
"uniqueShortDescription": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"videoCount": 0,
"webURL": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
}
},
{
"admission": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"available": true,
"bookingEngineId": "FreesaleBE",
"catIds": [
26051,
6
],
"code": "73492P17",
"currencyCode": "USD",
"duration": "1 hour",
"essential": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"merchantCancellable": true,
"merchantNetPriceFrom": 46.86,
"merchantNetPriceFromFormatted": "$46.86",
"onRequestPeriod": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"onSale": false,
"panoramaCount": 0,
"pas": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"photoCount": 0,
"price": 55,
"priceFormatted": "$55.00",
"primaryDestinationId": 684,
"primaryDestinationName": "Las Vegas",
"primaryDestinationUrlName": "Las-Vegas",
"primaryGroupId": 6,
"productUrlName": "Yoga-Uncorked-Artisan-Hotel",
"rating": 0,
"reviewCount": 0,
"rrp": 0,
"rrpformatted": "",
"savingAmount": 0,
"savingAmountFormated": "",
"shortDescription": "Sip your wine and unwind with wine yoga! This gentle yoga class combines sipping your wine and practicing fun yoga basics in a rad environment. A tad unconventional, this class is filled with laughter, fun, and cheers-ing your neighbor.<br><br>Private parties are available upon request.<br><br>Ticket includes one glass of wine, a souvenir adult sippy (to help prevent the spillage of the wine!), and a gentle quirky yoga class.<br><br>",
"shortTitle": "Yoga Uncorked-Artisan Hotel",
"sortOrder": 2,
"specialOfferAvailable": false,
"specialReservation": false,
"specialReservationDetails": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"sslSupported": false,
"subCatIds": [
19,
26052,
21,
40293
],
"supplierCode": "73492",
"supplierName": "MintnHoney",
"thumbnailHiResURL": "https://hare-media-cdn.tripadvisor.com/media/attractions-splice-spp-674x446/09/ac/2b/2d.jpg",
"thumbnailURL": "https://hare-media-cdn.tripadvisor.com/media/attractions-splice-spp-154x109/09/ac/2b/2d.jpg",
"title": "Yoga Uncorked-Artisan Hotel",
"translationLevel": 0,
"uniqueShortDescription": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"videoCount": 0,
"webURL": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
}
},
{
"admission": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"available": true,
"bookingEngineId": "DeferredCRMBE",
"catIds": [
26051,
50127
],
"code": "73458P1",
"currencyCode": "USD",
"duration": "1 to 2 hours",
"essential": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"merchantCancellable": true,
"merchantNetPriceFrom": 213,
"merchantNetPriceFromFormatted": "$213.00",
"onRequestPeriod": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"onSale": false,
"panoramaCount": 0,
"pas": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"photoCount": 0,
"price": 250,
"priceFormatted": "$250.00",
"primaryDestinationId": 22171,
"primaryDestinationName": "Nevada",
"primaryDestinationUrlName": "Nevada",
"primaryGroupId": 26051,
"productUrlName": "Sunset-Yoga-in-Las-Vegas",
"rating": 0,
"reviewCount": 0,
"rrp": 0,
"rrpformatted": "",
"savingAmount": 0,
"savingAmountFormated": "",
"shortDescription": "Enjoy a quiet, beautiful short walk to a secluded and breathtaking scene in Las Vegas. Travelers can choose to visit Calico Basin, Mt. Charleston, Wetlands, Seven Magic Mountains, or Lake Las Vegas for a private or group yoga session. Each session will provide the freedom from day-to-day distractions and allow you to immerse yourself in a unique and awe-inspiring locale. Each yoga session will be tailored to the individual and/or group in order to ensure the proper tone and intention is set. This is an all-inclusive experience. Guided walking tour, customized yoga session, yoga mats and water will be provided.",
"shortTitle": "Explore the Beauty of Las Vegas with Private and Group Yoga Classes",
"sortOrder": 3,
"specialOfferAvailable": false,
"specialReservation": false,
"specialReservationDetails": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"sslSupported": false,
"subCatIds": [
50128,
26052,
40293
],
"supplierCode": "73458",
"supplierName": "Jennifer Pierotti Yoga ",
"thumbnailHiResURL": "https://hare-media-cdn.tripadvisor.com/media/attractions-splice-spp-674x446/07/3b/bc/78.jpg",
"thumbnailURL": "https://hare-media-cdn.tripadvisor.com/media/attractions-splice-spp-154x109/07/3b/bc/78.jpg",
"title": "Explore the Beauty of Las Vegas with Private and Group Yoga Classes",
"translationLevel": 0,
"uniqueShortDescription": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"videoCount": 0,
"webURL": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
}
}
],
"dateStamp": "2020-02-09T14:34:51+0000",
"errorCodes": [],
"errorMessage": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorMessageText": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorName": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorReference": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorType": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"extraInfo": {},
"extraObject": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"success": true,
"totalCount": 3,
"vmid": "331005"
}
},
"search-products-example-2": {
"summary": "search products example (by attraction link)",
"value": {
"data": [
{
"admission": "3",
"available": true,
"bookingEngineId": "FreesaleBE",
"catIds": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"code": "5408P24",
"currencyCode": "USD",
"duration": "5 hours",
"essential": "2",
"merchantCancellable": true,
"merchantNetPriceFrom": 21.12,
"merchantNetPriceFromFormatted": "$21.12",
"onRequestPeriod": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"onSale": false,
"panoramaCount": 0,
"pas": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"photoCount": 9,
"price": 27.55,
"priceFormatted": "$27.55",
"primaryDestinationId": 662,
"primaryDestinationName": "Miami",
"primaryDestinationUrlName": "Miami",
"primaryGroupId": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"productUrlName": "Everglades-Airboat-Safari",
"rating": 4,
"reviewCount": 12,
"rrp": 29,
"rrpformatted": "$29.00",
"savingAmount": 0,
"savingAmountFormated": "",
"shortDescription": "Explore the Everglades National Park and Florida's natural eco-system on an airboat! See and experience the wild alligators in their natural habitat. Have the chance to see alligators up close in their natural habitat, as well as the many exhibits scattered throughout the park. Transportation is available from your hotel when option is selected.",
"shortTitle": "Everglades Airboat Safari",
"sortOrder": 2,
"specialOfferAvailable": true,
"specialReservation": false,
"specialReservationDetails": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"sslSupported": false,
"subCatIds": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"supplierCode": "5408",
"supplierName": "Miami Double Decker",
"thumbnailHiResURL": "https://hare-media-cdn.tripadvisor.com/media/attractions-splice-spp-674x446/06/6e/f3/ca.jpg",
"thumbnailURL": "https://hare-media-cdn.tripadvisor.com/media/attractions-splice-spp-154x109/06/6e/f3/ca.jpg",
"title": "Everglades Airboat Safari",
"translationLevel": 0,
"uniqueShortDescription": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"videoCount": 0,
"webURL": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
}
},
{
"admission": "3",
"available": true,
"bookingEngineId": "FreesaleBE",
"catIds": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"code": "6331EVERAIRTRANS",
"currencyCode": "USD",
"duration": "5 hours",
"essential": "2",
"merchantCancellable": true,
"merchantNetPriceFrom": 40.97,
"merchantNetPriceFromFormatted": "$40.97",
"onRequestPeriod": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"onSale": false,
"panoramaCount": 0,
"pas": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"photoCount": 0,
"price": 51.3,
"priceFormatted": "$51.30",
"primaryDestinationId": 662,
"primaryDestinationName": "Miami",
"primaryDestinationUrlName": "Miami",
"primaryGroupId": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"productUrlName": "Everglades-Airboat-Tour-with-Transport-from-Miami",
"rating": 3.5,
"reviewCount": 22,
"rrp": 54,
"rrpformatted": "$54.00",
"savingAmount": 0,
"savingAmountFormated": "",
"shortDescription": "Choose between daily morning or afternoon departure from Miami Beach or Downtown Miami and experience everything the Everglades have to offer during this ca. 4-5 hour Everglades tour (depending on traffic). English, Spanish or German guides are available on your bus. After your pick-up you will drive to the Everglades where you will first board an Airboat guided by your park ranger which takes you on an exciting high speed ride through the river of grass and allows you to discover the beauty of this unique eco-system. Observe a variety of animals including birds, turtles and alligators in their natural habitat and watch the gators up close during the alligator presentation following the airboat ride",
"shortTitle": "Everglades Airboat Ride Ranger-Guided Eco-Tour from Miami",
"sortOrder": 4,
"specialOfferAvailable": true,
"specialReservation": false,
"specialReservationDetails": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"sslSupported": false,
"subCatIds": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"supplierCode": "6331",
"supplierName": "US2U",
"thumbnailHiResURL": "https://hare-media-cdn.tripadvisor.com/media/attractions-splice-spp-674x446/06/e9/60/52.jpg",
"thumbnailURL": "https://hare-media-cdn.tripadvisor.com/media/attractions-splice-spp-154x109/06/e9/60/52.jpg",
"title": "Everglades Airboat & Gators AM or PM pick-up - English,Spanish,German or French",
"translationLevel": 0,
"uniqueShortDescription": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"videoCount": 0,
"webURL": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
}
},
{
"admission": "3",
"available": true,
"bookingEngineId": "FreesaleBE",
"catIds": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"code": "6331P14",
"currencyCode": "USD",
"duration": "5 hours",
"essential": "2",
"merchantCancellable": true,
"merchantNetPriceFrom": 61.5,
"merchantNetPriceFromFormatted": "$61.50",
"onRequestPeriod": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"onSale": false,
"panoramaCount": 0,
"pas": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"photoCount": 0,
"price": 65.45,
"priceFormatted": "$65.45",
"primaryDestinationId": 662,
"primaryDestinationName": "Miami",
"primaryDestinationUrlName": "Miami",
"primaryGroupId": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"productUrlName": "Everglades-Tour-auf-Deutsch",
"rating": 3,
"reviewCount": 1,
"rrp": 77,
"rrpformatted": "$77.00",
"savingAmount": 0,
"savingAmountFormated": "",
"shortDescription": "Discover the Everglades on this popular tour. Enjoy a one hour Airboat tour and a wildlife show displaying a variety of animals.",
"shortTitle": "Everglades Airboat 1 hour with AM or PM pick-up",
"sortOrder": 6,
"specialOfferAvailable": true,
"specialReservation": false,
"specialReservationDetails": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"sslSupported": false,
"subCatIds": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"supplierCode": "6331",
"supplierName": "US2U",
"thumbnailHiResURL": "https://hare-media-cdn.tripadvisor.com/media/attractions-splice-spp-674x446/09/a5/43/8f.jpg",
"thumbnailURL": "https://hare-media-cdn.tripadvisor.com/media/attractions-splice-spp-154x109/09/a5/43/8f.jpg",
"title": "Everglades Airboat 1 hour with AM or PM pick-up",
"translationLevel": 0,
"uniqueShortDescription": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"videoCount": 0,
"webURL": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
}
}
],
"dateStamp": "2020-02-09T14:37:22+0000",
"errorCodes": [],
"errorMessage": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorMessageText": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorName": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorReference": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorType": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"extraInfo": {},
"extraObject": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"success": true,
"totalCount": 24,
"vmid": "331001"
}
},
"search-products-example-3": {
"summary": "search products example (freesale only)",
"value": {
"data": [
{
"admission": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"available": true,
"bookingEngineId": "FreesaleBE",
"catIds": [
4,
20,
9,
25,
26,
12
],
"code": "50420P54",
"currencyCode": "USD",
"duration": "15 days",
"essential": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"merchantCancellable": false,
"merchantNetPriceFrom": 4792.5,
"merchantNetPriceFromFormatted": "$4,792.50",
"onRequestPeriod": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"onSale": false,
"panoramaCount": 0,
"pas": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"photoCount": 0,
"price": 6000,
"priceFormatted": "$6,000.00",
"primaryDestinationId": 684,
"primaryDestinationName": "Las Vegas",
"primaryDestinationUrlName": "Las-Vegas",
"primaryGroupId": 4,
"productUrlName": "The-Old-Southwest-Grand-Circle-Leisure-Tour",
"rating": 0,
"reviewCount": 0,
"rrp": 0,
"rrpformatted": "",
"savingAmount": 0,
"savingAmountFormated": "",
"shortDescription": "Do you want to see as many National Parks as you can? Then book our Southwest National Parks Grand Circle Tour, which includes 7 National Parks and an old train ride. Explore amazing, famous National Parks like Arches, Canyonlands, Capitol Reef, Bryce Canyon, Zion, Mesa Verde and more. This includes Utah's Mighty Five and many more. Shoot down white water rapids with an experienced guide or take a lazy, scenic river float. These are just some of the items packed into our extensive Grand Circle Tour.<br><br>Spend 14 magical days exploring petrified dunes, vibrant pine forests, and deserts with oil-painting perfect sunsets. This is a small group setting. Usually, there are no more than ten guests. Each small group has a private guide to tell stories of the old days and give insight into what you are experiencing. With its walking, scenic views, local restaurants, hidden gems, and other fantastic experiences, the Southwest National Parks Grand Circle Tour awaits you!",
"shortTitle": "The Old Southwest Grand Circle--Leisure Tour",
"sortOrder": 1,
"specialOfferAvailable": false,
"specialReservation": false,
"specialReservationDetails": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"sslSupported": false,
"subCatIds": [
113,
98,
36,
116,
85,
11
],
"supplierCode": "50420",
"supplierName": "New Way Horizon Travel LLC",
"thumbnailHiResURL": "https://hare-media-cdn.tripadvisor.com/media/attractions-splice-spp-674x446/09/19/57/60.jpg",
"thumbnailURL": "https://hare-media-cdn.tripadvisor.com/media/attractions-splice-spp-154x109/09/19/57/60.jpg",
"title": "The Old Southwest Grand Circle--Leisure Tour",
"translationLevel": 0,
"uniqueShortDescription": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"videoCount": 0,
"webURL": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
}
},
{
"admission": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"available": true,
"bookingEngineId": "DeferredCRMBE",
"catIds": [
1,
18,
26,
12
],
"code": "9424P24",
"currencyCode": "USD",
"duration": "3 hours",
"essential": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"merchantCancellable": true,
"merchantNetPriceFrom": 3236.75,
"merchantNetPriceFromFormatted": "$3,236.75",
"onRequestPeriod": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"onSale": false,
"panoramaCount": 0,
"pas": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"photoCount": 0,
"price": 3799.99,
"priceFormatted": "$3,799.99",
"primaryDestinationId": 684,
"primaryDestinationName": "Las Vegas",
"primaryDestinationUrlName": "Las-Vegas",
"primaryGroupId": 18,
"productUrlName": "Helicopter-Wedding-The-Grand-Canon",
"rating": 0,
"reviewCount": 0,
"rrp": 0,
"rrpformatted": "",
"savingAmount": 0,
"savingAmountFormated": "",
"shortDescription": "If getting married in a natural wonder of the world is on your bucket list, look no farther. You and your guests will enjoy a scenic flight the Grand Canyon West Rim for a private ceremony in the basin of the canyon. Photos, cake, a Champagne toast and limousine transfers are included.",
"shortTitle": "Grand Canyon Helicopter Wedding Ceremony",
"sortOrder": 2,
"specialOfferAvailable": false,
"specialReservation": false,
"specialReservationDetails": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"sslSupported": false,
"subCatIds": [
2,
26963,
116,
61,
45,
62,
95
],
"supplierCode": "9424",
"supplierName": "Destination Las Vegas Group",
"thumbnailHiResURL": "https://hare-media-cdn.tripadvisor.com/media/attractions-splice-spp-674x446/06/75/b7/96.jpg",
"thumbnailURL": "https://hare-media-cdn.tripadvisor.com/media/attractions-splice-spp-154x109/06/75/b7/96.jpg",
"title": "Helicopter Wedding Ceremony: The Grand Canyon",
"translationLevel": 0,
"uniqueShortDescription": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"videoCount": 0,
"webURL": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
}
},
{
"admission": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"available": true,
"bookingEngineId": "DeferredCRMBE",
"catIds": [
20,
9,
26,
12
],
"code": "240839P1",
"currencyCode": "USD",
"duration": "3 days",
"essential": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"merchantCancellable": false,
"merchantNetPriceFrom": 1996.08,
"merchantNetPriceFromFormatted": "$1,996.08",
"onRequestPeriod": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"onSale": false,
"panoramaCount": 0,
"pas": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"photoCount": 0,
"price": 2499,
"priceFormatted": "$2,499.00",
"primaryDestinationId": 684,
"primaryDestinationName": "Las Vegas",
"primaryDestinationUrlName": "Las-Vegas",
"primaryGroupId": 9,
"productUrlName": "3-Day-Zion-Adventure-Tour",
"rating": 0,
"reviewCount": 0,
"rrp": 0,
"rrpformatted": "",
"savingAmount": 0,
"savingAmountFormated": "",
"shortDescription": "The hosts and guides are locals, so we know the sweet spots away from the crowds. Our multi-lingual abilities are sure to keep the group happy and entertained as we traverse through some unique and gorgeous locations. We’ve simplified logistics, landed some amazing accommodations, and planned in high quality adventure and American meals. We’re happy to customize the tour to groups and families wanting a little more say in the adventure. Just email us!",
"shortTitle": "3 Day Zion Adventure Tour",
"sortOrder": 3,
"specialOfferAvailable": false,
"specialReservation": false,
"specialReservationDetails": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"sslSupported": false,
"subCatIds": [
32,
98,
116,
85
],
"supplierCode": "240839",
"supplierName": "Red Tread Tours LLC",
"thumbnailHiResURL": "https://hare-media-cdn.tripadvisor.com/media/attractions-splice-spp-674x446/0a/3d/3f/ff.jpg",
"thumbnailURL": "https://hare-media-cdn.tripadvisor.com/media/attractions-splice-spp-154x109/0a/3d/3f/ff.jpg",
"title": "3 Day Zion Adventure Tour",
"translationLevel": 0,
"uniqueShortDescription": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"videoCount": 0,
"webURL": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
}
}
],
"dateStamp": "2020-02-09T15:18:03+0000",
"errorCodes": [],
"errorMessage": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorMessageText": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorName": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorReference": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorType": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"extraInfo": {},
"extraObject": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"success": true,
"totalCount": 910,
"vmid": "331005"
}
},
"taxonomy-attractions-example": {
"summary": "taxonomy attractions example",
"value": {
"data": [
{
"attractionCity": "",
"attractionLatitude": 35.8808,
"attractionLongitude": -113.97048,
"attractionState": "",
"attractionStreetAddress": "",
"destinationId": 684,
"pageUrlName": "Grand-Canyon-West-Rim",
"photoCount": 157,
"primaryDestinationId": 684,
"primaryDestinationName": "Las Vegas",
"primaryDestinationUrlName": "Las-Vegas",
"productCount": 16,
"publishedDate": "2020-01-15",
"rating": 4.5,
"seoId": 1594,
"sortOrder": 1,
"thumbnailHiResURL": "http://cache-graphicslib.viator.com/graphicslib/page-images/742x525/44811_GrandCanyon_WestRim_d815-24.jpg",
"thumbnailURL": "http://cache-graphicslib.viator.com/graphicslib/page-images/44811_GrandCanyon_WestRim_d815-24.jpg",
"title": "Grand Canyon West Rim",
"webURL": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
}
},
{
"attractionCity": "Las Vegas",
"attractionLatitude": 36.162683,
"attractionLongitude": -115.144685,
"attractionState": "",
"attractionStreetAddress": "619 Las Vegas Boulevard South",
"destinationId": 684,
"pageUrlName": "Graceland-Wedding-Chapel",
"photoCount": 10,
"primaryDestinationId": 684,
"primaryDestinationName": "Las Vegas",
"primaryDestinationUrlName": "Las-Vegas",
"productCount": 2,
"publishedDate": "2019-08-22",
"rating": 4.5,
"seoId": 1246,
"sortOrder": 2,
"thumbnailHiResURL": "http://cache-graphicslib.viator.com/graphicslib/page-images/742x525/785937_Viator_Photographer_395090.jpg",
"thumbnailURL": "http://cache-graphicslib.viator.com/graphicslib/page-images/785937_Viator_Photographer_395090.jpg",
"title": "Graceland Wedding Chapel",
"webURL": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
}
},
{
"attractionCity": "Las Vegas",
"attractionLatitude": 36.126374,
"attractionLongitude": -115.166749,
"attractionState": "",
"attractionStreetAddress": "3131 Las Vegas Blvd South",
"destinationId": 684,
"pageUrlName": "Wynn-Las-Vegas",
"photoCount": 5,
"primaryDestinationId": 684,
"primaryDestinationName": "Las Vegas",
"primaryDestinationUrlName": "Las-Vegas",
"productCount": 2,
"publishedDate": "2019-07-30",
"rating": 0,
"seoId": 1266,
"sortOrder": 3,
"thumbnailHiResURL": "http://cache-graphicslib.viator.com/graphicslib/page-images/742x525/100516_Las%20Vegas_Wynn%20Hotel%20&%20Casino_d684-508.jpg",
"thumbnailURL": "http://cache-graphicslib.viator.com/graphicslib/page-images/100516_Las%20Vegas_Wynn%20Hotel%20&%20Casino_d684-508.jpg",
"title": "Wynn Las Vegas",
"webURL": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
}
}
],
"dateStamp": "2020-02-06T19:55:25+0000",
"errorCodes": [],
"errorMessage": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorMessageText": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorName": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorReference": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorType": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"extraInfo": {},
"extraObject": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"success": true,
"totalCount": 72,
"vmid": "331004"
}
},
"taxonomy-categories-example": {
"summary": "taxonomy categories example",
"value": {
"data": [
{
"groupName": "Air, Helicopter & Balloon Tours",
"groupUrlName": "Air-Helicopter-and-Balloon-Tours",
"id": 1,
"productCount": 77,
"sortOrder": 1,
"subcategories": [
{
"categoryId": 1,
"sortOrder": 1,
"subcategoryId": 2,
"subcategoryName": "Helicopter Tours",
"subcategoryUrlName": "Helicopter-Tours"
},
{
"categoryId": 1,
"sortOrder": 2,
"subcategoryId": 1,
"subcategoryName": "Air Tours",
"subcategoryUrlName": "Air-Tours"
},
{
"categoryId": 1,
"sortOrder": 3,
"subcategoryId": 3,
"subcategoryName": "Balloon Rides",
"subcategoryUrlName": "Balloon-Rides"
}
],
"thumbnailHiResURL": "https://hare-media-cdn.tripadvisor.com/media/attractions-splice-spp-674x446/07/71/7c/7d.jpg",
"thumbnailURL": "https://hare-media-cdn.tripadvisor.com/media/attractions-splice-spp-154x109/07/71/7c/7d.jpg"
},
{
"groupName": "Classes & Workshops",
"groupUrlName": "Classes-and-Workshops",
"id": 26051,
"productCount": 12,
"sortOrder": 2,
"subcategories": [
{
"categoryId": 26051,
"sortOrder": 1,
"subcategoryId": 40290,
"subcategoryName": "Language Classes",
"subcategoryUrlName": "Language-Classes"
},
{
"categoryId": 26051,
"sortOrder": 2,
"subcategoryId": 40293,
"subcategoryName": "Sports Lessons",
"subcategoryUrlName": "Sports-Lessons"
},
{
"categoryId": 26051,
"sortOrder": 3,
"subcategoryId": 33939,
"subcategoryName": "Craft Classes",
"subcategoryUrlName": "Craft-Classes"
},
{
"categoryId": 26051,
"sortOrder": 4,
"subcategoryId": 26052,
"subcategoryName": "Yoga Classes",
"subcategoryUrlName": "Yoga-Classes"
},
{
"categoryId": 26051,
"sortOrder": 5,
"subcategoryId": 40286,
"subcategoryName": "Art Classes",
"subcategoryUrlName": "Art-Classes"
}
],
"thumbnailHiResURL": "https://hare-media-cdn.tripadvisor.com/media/attractions-splice-spp-674x446/0a/03/9e/ca.jpg",
"thumbnailURL": "https://hare-media-cdn.tripadvisor.com/media/attractions-splice-spp-154x109/0a/03/9e/ca.jpg"
},
{
"groupName": "Cruises, Sailing & Water Tours",
"groupUrlName": "Cruises-Sailing-and-Water-Tours",
"id": 3,
"productCount": 21,
"sortOrder": 3,
"subcategories": [
{
"categoryId": 3,
"sortOrder": 1,
"subcategoryId": 5640,
"subcategoryName": "Dinner Cruises",
"subcategoryUrlName": "Dinner-Cruises"
},
{
"categoryId": 3,
"sortOrder": 2,
"subcategoryId": 7,
"subcategoryName": "Day Cruises",
"subcategoryUrlName": "Day-Cruises"
},
{
"categoryId": 3,
"sortOrder": 3,
"subcategoryId": 40295,
"subcategoryName": "Water Tours",
"subcategoryUrlName": "Water-Tours"
}
],
"thumbnailHiResURL": "https://hare-media-cdn.tripadvisor.com/media/attractions-splice-spp-674x446/06/e5/a3/54.jpg",
"thumbnailURL": "https://hare-media-cdn.tripadvisor.com/media/attractions-splice-spp-154x109/06/e5/a3/54.jpg"
},
{
"groupName": "Cultural & Theme Tours",
"groupUrlName": "Cultural-and-Theme-Tours",
"id": 4,
"productCount": 94,
"sortOrder": 4,
"subcategories": [
{
"categoryId": 4,
"sortOrder": 1,
"subcategoryId": 14,
"subcategoryName": "Literary, Art & Music Tours",
"subcategoryUrlName": "Literary-Art-and-Music-Tours"
},
{
"categoryId": 4,
"sortOrder": 2,
"subcategoryId": 118,
"subcategoryName": "Ghost & Vampire Tours",
"subcategoryUrlName": "Ghost-and-Vampire-Tours"
},
{
"categoryId": 4,
"sortOrder": 3,
"subcategoryId": 12,
"subcategoryName": "Historical & Heritage Tours",
"subcategoryUrlName": "Historical-and-Heritage-Tours"
},
{
"categoryId": 4,
"sortOrder": 4,
"subcategoryId": 11,
"subcategoryName": "Cultural Tours",
"subcategoryUrlName": "Cultural-Tours"
},
{
"categoryId": 4,
"sortOrder": 5,
"subcategoryId": 26967,
"subcategoryName": "Architecture Tours",
"subcategoryUrlName": "Architecture-Tours"
},
{
"categoryId": 4,
"sortOrder": 6,
"subcategoryId": 13,
"subcategoryName": "Movie & TV Tours",
"subcategoryUrlName": "Movie-and-TV-Tours"
},
{
"categoryId": 4,
"sortOrder": 7,
"subcategoryId": 40338,
"subcategoryName": "LGBT Friendly Tours",
"subcategoryUrlName": "LGBT-Friendly-Tours"
},
{
"categoryId": 4,
"sortOrder": 8,
"subcategoryId": 5332,
"subcategoryName": "Archaeology Tours",
"subcategoryUrlName": "Archaeology-Tours"
}
],
"thumbnailHiResURL": "https://hare-media-cdn.tripadvisor.com/media/attractions-splice-spp-674x446/06/73/48/34.jpg",
"thumbnailURL": "https://hare-media-cdn.tripadvisor.com/media/attractions-splice-spp-154x109/06/73/48/34.jpg"
}
],
"dateStamp": "2020-02-06T19:47:58+0000",
"errorCodes": [],
"errorMessage": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorMessageText": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorName": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorReference": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorType": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"extraInfo": {},
"extraObject": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"success": true,
"totalCount": 1,
"vmid": "331001"
}
},
"taxonomy-destinations-example": {
"summary": "taxonomy destinations example",
"value": {
"data": [
{
"defaultCurrencyCode": "USD",
"destinationId": 77,
"destinationName": "USA",
"destinationType": "COUNTRY",
"destinationUrlName": "USA",
"iataCode": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"latitude": 37.09024,
"longitude": -95.712891,
"lookupId": "8.77",
"parentId": 8,
"selectable": false,
"sortOrder": 1,
"timeZone": "America/New_York"
},
{
"defaultCurrencyCode": "USD",
"destinationId": 22212,
"destinationName": "Alabama",
"destinationType": "REGION",
"destinationUrlName": "Alabama",
"iataCode": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"latitude": 32.34,
"longitude": -86.26,
"lookupId": "8.77.22212",
"parentId": 77,
"selectable": true,
"sortOrder": 1,
"timeZone": ""
},
{
"defaultCurrencyCode": "USD",
"destinationId": 270,
"destinationName": "Alaska",
"destinationType": "REGION",
"destinationUrlName": "Alaska",
"iataCode": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"latitude": 63.588753,
"longitude": -154.4930619,
"lookupId": "8.77.270",
"parentId": 77,
"selectable": true,
"sortOrder": 2,
"timeZone": "America/Anchorage"
},
{
"defaultCurrencyCode": "USD",
"destinationId": 271,
"destinationName": "Arizona",
"destinationType": "REGION",
"destinationUrlName": "Arizona",
"iataCode": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"latitude": 34.0489281,
"longitude": -111.0937311,
"lookupId": "8.77.271",
"parentId": 77,
"selectable": true,
"sortOrder": 3,
"timeZone": "America/Phoenix"
}
],
"dateStamp": "2020-02-06T19:43:09+0000",
"errorCodes": [],
"errorMessage": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorMessageText": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorName": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorReference": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"errorType": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"extraInfo": {},
"extraObject": {
"$ref": "#/components/examples/product-example-1/value/data/pas"
},
"success": true,
"totalCount": 1,
"vmid": "331001"
}
}
},
"parameters": {
"acceptLanguage": {
"description": "Specifies the language into which the natural-language fields in the response from this service will be translated (see [Accept-Language header](#section/Appendices/Accept-Language-header) for available langage codes)\n",
"in": "header",
"name": "Accept-Language",
"required": true,
"schema": {
"example": "en-US",
"type": "string"
}
},
"code": {
"description": "**unique alphanumeric identifier** of the product",
"example": "5010SYDNEY",
"in": "query",
"name": "code",
"schema": {
"type": "string"
}
},
"currencyCode": {
"description": "**currency code** for the currency in which pricing is displayed\n- default=`'USD'`\n",
"in": "query",
"name": "currencyCode",
"schema": {
"type": "string"
}
},
"destId": {
"description": "**unique numeric identifier** of the destination",
"example": 123,
"in": "query",
"name": "destId",
"schema": {
"type": "integer"
}
},
"productCode": {
"description": "**unique alphanumeric identifier** of the product",
"example": "2280AAHT",
"in": "query",
"name": "productCode",
"schema": {
"type": "string"
}
},
"showUnavailable": {
"description": "**specifier** as to whether or not to show 'unavailable' products:\n\n - `true`: return *both* available and unavailable products\n - `false`: return *only* available products (default)\n",
"example": false,
"in": "query",
"name": "showUnavailable",
"schema": {
"type": "boolean"
}
},
"sortOrder_REVIEW": {
"description": "**specifier** of the order in which to return reviews\n\nSort order options:\n\n - `\"REVIEW_RATING_A\"`: Traveler Rating (low→high) Average\n - `\"REVIEW_RATING_D\"`: Traveler Rating (high→low) Average\n - `\"REVIEW_RATING_SUBMISSION_DATE_D\"`: Most recent review\n",
"in": "query",
"name": "sortOrder",
"schema": {
"enum": [
"REVIEW_RATING_A",
"REVIEW_RATING_D",
"REVIEW_RATING_SUBMISSION_DATE_D"
],
"type": "string"
}
},
"topX": {
"description": "**start and end rows** to return in the format {start}-{end}\n- e.g. `'1-10'`, `'11-20'`\n\n**Note**: \n- the maximum number of rows per request is 100; therefore, `'100-400'` will return the same as `'100-200'`\n- if `topX` is not specified, the default is `'1-100'`\n",
"example": "1-3",
"in": "query",
"name": "topX",
"schema": {
"type": "string"
}
}
},
"schemas": {
"401_UNAUTHORIZED": {
"properties": {
"code": {
"enum": [
"UNAUTHORIZED"
],
"type": "string"
},
"message": {
"enum": [
"Invalid API key"
],
"type": "string"
},
"timestamp": {
"description": "Timestamp of the request\n\n * e.g.: `2019-09-17T03:20:45.737043Z`\n",
"type": "string"
},
"trackingId": {
"description": "Tracking identifier for this error response",
"type": "string"
}
},
"type": "object"
},
"406_NOT_ACCEPTABLE": {
"properties": {
"code": {
"enum": [
"INVALID_HEADER_VALUE"
],
"type": "string"
},
"message": {
"description": "Describes which in-header parameter was not acceptable to this system; e.g., 'Invalid value for header: exp-api-key'",
"type": "string"
},
"timestamp": {
"description": "Timestamp of the request\n\n * e.g.: `2019-09-17T03:20:45.737043Z`\n",
"type": "string"
},
"trackingId": {
"description": "Tracking identifier for this error response",
"type": "string"
}
},
"type": "object"
},
"500_INTERNAL_SERVER_ERROR": {
"properties": {
"code": {
"enum": [
"INTERNAL_SERVER_ERROR"
],
"type": "string"
},
"message": {
"enum": [
"Internal server error"
],
"type": "string"
},
"timestamp": {
"description": "Timestamp of the request\n\n * e.g.: `2019-09-17T03:20:45.737043Z`\n",
"type": "string"
},
"trackingId": {
"description": "Tracking identifier for this error response",
"type": "string"
}
},
"type": "object"
},
"503_SERVICE_UNAVAILABLE": {
"properties": {
"code": {
"enum": [
"SERVICE_UNAVAILABLE"
],
"type": "string"
},
"message": {
"enum": [
"Internal server error"
],
"type": "string"
},
"timestamp": {
"description": "Timestamp of the request\ne.g.: `2019-09-17T03:20:45.737043Z`\n",
"type": "string"
},
"trackingId": {
"description": "Tracking identifier for this error response",
"type": "string"
}
},
"type": "object"
},
"CancelBookingQuoteResponse": {
"properties": {
"bookingId": {
"description": "The booking reference number, prepended with `BR-`",
"type": "string"
},
"refundDetails": {
"$ref": "#/components/schemas/RefundDetails"
},
"status": {
"description": "String indicating the cancellation status of this itinerary item:\n\n * `CANCELLABLE` - this booking is available to be cancelled\n * `CANCELLED` - this booking has already been cancelled\n * `NOT_CANCELLABLE` - this booking cannot be cancelled (because the product's operation date is now in the past)\n",
"enum": [
"CANCELLABLE",
"CANCELLED",
"NOT_CANCELLABLE"
],
"type": "string"
}
},
"type": "object"
},
"CancelBookingResponse": {
"properties": {
"bookingId": {
"description": "Booking reference number for this booking, prepended with `BR-`",
"example": "BR-580254558",
"type": "string"
},
"reason": {
"enum": [
"ALREADY_CANCELLED",
"NOT_CANCELLABLE"
],
"type": "string"
},
"status": {
"description": "String indicating the outcome of the booking cancellation request.\n\n * `ACCEPTED`: The cancellation was successful\n * `DECLINED`: The cancellation failed\n",
"enum": [
"ACCEPTED",
"DECLINED"
],
"example": "DECLINED",
"type": "string"
}
},
"type": "object"
},
"CancellationReason": {
"properties": {
"cancellationReasonCode": {
"description": "Machine-interpretable identification code for this cancellation",
"example": "Customer_Service.Weather",
"type": "string"
},
"cancellationReasonText": {
"description": "Natural-language description of this cancellation reason",
"example": "The weather conditions were unsuitable",
"type": "string"
}
},
"type": "object"
},
"CancellationReasonsResponse": {
"properties": {
"reasons": {
"description": "Array of cancellation reason codes and their asssociated texts for display to the user",
"items": {
"$ref": "#/components/schemas/CancellationReason"
},
"type": "array"
}
},
"type": "object"
},
"CancellationRequest": {
"properties": {
"reasonCode": {
"description": "Machine-interpretable identification code for this cancellation reason, retrieved from [cancellationReasons](#operation/cancellationReasons)",
"example": "Customer_Service.I_canceled_my_entire_trip",
"type": "string"
}
},
"type": "object"
},
"RefundDetails": {
"description": "Details of the refund\n\n**Note**: Bookings that have not been confirmed by the supplier and have a status of `\"PENDING\"` will report an `itemPrice`, `refundAmount` and `refundPercentage` of `0`, as no fees are charged until the booking has been accepted by the supplier and its status is `\"CONFIRMED\"`.\n",
"properties": {
"currencyCode": {
"description": "Three-letter code indicating the currency in which `itemPrice` and `refundAmount` are displayed",
"type": "string"
},
"itemPrice": {
"description": "The merchant net price at the time this product was booked",
"type": "number"
},
"refundAmount": {
"description": "Numeric currency amount that will be refunded if this booking is cancelled now",
"type": "number"
},
"refundPercentage": {
"description": "Percentage of the item price that will be refunded if this booking is cancelled now",
"type": "number"
}
},
"type": "object"
},
"SearchFreetextResponse": {
"discriminator": {
"mapping": {
"ATTRACTION": "#/components/schemas/SearchFreetextResponseAttraction",
"DESTINATION": "#/components/schemas/SearchFreetextResponseDestination",
"PRODUCT": "#/components/schemas/SearchFreetextResponseProduct",
"RECOMMENDATION": "#/components/schemas/SearchFreetextResponseRecommendation"
},
"propertyName": "searchType"
},
"properties": {
"searchType": {
"description": "**indicator** of the entity type for *this* result that is *one of*:\n - `\"PRODUCT\"`: a tour / activity\n - `\"DESTINATION\"`: continent, country, city, region\n - `\"ATTRACTION\"`: an attraction within a destination (only available to partners with SEO access)\n - `\"RECOMMENDATION\"`: an attraction within a destination (only available to partners with SEO access)\n",
"enum": [
"PRODUCT",
"DESTINATION",
"ATTRACTION",
"RECOMMENDATION"
],
"type": "string"
},
"sortOrder": {
"description": "**sort order** for *this* data object",
"type": "integer"
}
},
"type": "object"
},
"SearchFreetextResponseAttraction": {
"allOf": [
{
"$ref": "#/components/schemas/SearchFreetextResponse"
},
{
"properties": {
"data": {
"description": "**object** detailing **an attraction** that matches the search criteria",
"properties": {
"attractionCity": {
"description": "City in which this attraction is located",
"type": "number"
},
"attractionLatitude": {
"description": "Latitude of this attraction's location",
"type": "number"
},
"attractionLongitude": {
"description": "Longitude of this attraction's location",
"type": "number"
},
"attractionState": {
"description": "State in which this attraction is located",
"type": "number"
},
"attractionStreetAddress": {
"description": "Street address of this attraction",
"type": "number"
},
"descriptionIntro": {
"description": "Description introduction text",
"type": "string"
},
"descriptionText": {
"description": "Description of this attraction",
"type": "string"
},
"destinationId": {
"description": "Destination ID for the destination in which this attraction is located",
"type": "integer"
},
"editorsPick": {
"description": "ignore (Viator only)",
"type": "boolean"
},
"keywordCount": {
"description": "ignore (Viator only)",
"type": "integer"
},
"keywords": {
"description": "ignore (Viator only)",
"items": {
"description": "ignore (Viator only)",
"type": "string"
},
"type": "array"
},
"overviewSummary": {
"description": "HTML-formatted summary overview of this attraction",
"type": "string"
},
"pagePrimaryLanguage": {
"description": "Language of the natural-language elements in this response",
"type": "string"
},
"pageTitle": {
"description": "Title of page",
"type": "string"
},
"pageUrlName": {
"description": "URL path fragment for attraction",
"type": "string"
},
"panoramaCount": {
"description": "ignore (Viator only)",
"type": "integer"
},
"photoCount": {
"description": "Number of photos available for this attraction",
"type": "integer"
},
"primaryDestinationId": {
"description": "Primary destination ID for the destination in which this attraction is located",
"type": "integer"
},
"primaryDestinationName": {
"description": "Primary destination ID for the destination in which this attraction is located",
"type": "string"
},
"primaryDestinationUrlName": {
"description": "Name of primary destination for this attraction",
"type": "string"
},
"productCount": {
"description": "ignore (Viator only)",
"type": "integer"
},
"publishedDate": {
"description": "ignore (Viator only)",
"nullable": true,
"type": "string"
},
"rating": {
"description": "Numeric rating for this attraction",
"type": "number"
},
"reviewCount": {
"description": "Number of reviews for this attraction",
"type": "integer"
},
"seoId": {
"description": "ignore (Viator only)",
"type": "integer"
},
"seoType": {
"description": "Type of result; i.e. `\"ATTRACTION\"`",
"type": "string"
},
"showPhotos": {
"description": "ignore (Viator only)",
"type": "boolean"
},
"showReviews": {
"description": "ignore (Viator only)",
"type": "boolean"
},
"sortOrder": {
"description": "ignore (Viator only)",
"type": "integer"
},
"tabTitle": {
"description": "Tab title for this attraction",
"type": "string"
},
"thumbnailHiResURL": {
"description": "URL for high-resolution image for this attraction",
"type": "string"
},
"thumbnailURL": {
"description": "URL for medium-resolution image for this attraction",
"type": "string"
},
"title": {
"description": "Title of this attraction",
"type": "string"
},
"userName": {
"description": "ignore (Viator only)",
"type": "string"
},
"webURL": {
"$ref": "#/components/schemas/webURL"
}
},
"type": "object"
}
},
"type": "object"
}
]
},
"SearchFreetextResponseDestination": {
"allOf": [
{
"$ref": "#/components/schemas/SearchFreetextResponse"
},
{
"properties": {
"data": {
"description": "**object** detailing **a destination** that matches the search criteria",
"properties": {
"defaultCurrencyCode": {
"description": "**currency code** for the currency in which pricing is displayed",
"type": "string"
},
"destinationId": {
"description": "**unique numeric identifier** of the destination\n- use this value as the `destId` input field for other Viator API services\n",
"type": "integer"
},
"destinationName": {
"description": "**natural-language name** of the destination",
"type": "string"
},
"destinationType": {
"$ref": "#/components/schemas/destinationType"
},
"destinationUrlName": {
"description": "ignore - (Viator only)",
"type": "string"
},
"iataCode": {
"$ref": "#/components/schemas/iataCode"
},
"latitude": {
"description": "**latitude component** of the destination's geolocation",
"type": "number"
},
"longitude": {
"description": "**longitude component** of the destination's geolocation",
"type": "number"
},
"lookupId": {
"description": "**hierarchy location specifier** for the destination that is a concatenation of all `parentId` and `destinationId` codes\n- e.g. `'8.77.673'` for Chicago\n- format: [top level `parentId`].[any additional `parentId`].[`destinationId`]\n",
"type": "string"
},
"parentId": {
"description": "**unique numeric identifier** of the destination's parent destination",
"type": "integer"
},
"selectable": {
"description": "ignore - (Viator only)",
"type": "boolean"
},
"sortOrder": {
"description": "**sort order** for this response",
"type": "integer"
},
"timeZone": {
"description": "**time zone** of the destination",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
]
},
"SearchFreetextResponseProduct": {
"allOf": [
{
"$ref": "#/components/schemas/SearchFreetextResponse"
},
{
"properties": {
"data": {
"description": "**object** detailing a **product** that matches the search criteria",
"properties": {
"admission": {
"description": "ignore (Viator only)",
"type": "string"
},
"attractionLatitude": {
"description": "ignore (Viator only)",
"nullable": true,
"type": "string"
},
"attractionLongitude": {
"description": "ignore (Viator only)",
"nullable": true,
"type": "string"
},
"available": {
"description": "ignore (Viator only)",
"type": "boolean"
},
"bookingEngineId": {
"$ref": "#/components/schemas/bookingEngineId"
},
"catIds": {
"description": "**list** of unique numeric product category identifiers \n- `categoryId` is available for the destination from the [/taxonomy/categories](#operation/taxonomyCategories) service\n",
"items": {
"type": "integer"
},
"type": "array"
},
"code": {
"description": "**unique alphanumeric identifier** of *this* product",
"type": "string"
},
"currencyCode": {
"description": "**currency** in which *this* product's pricing is displayed",
"type": "string"
},
"duration": {
"description": "**natural-language duration** of *this* product",
"type": "string"
},
"essential": {
"description": "ignore (Viator only)",
"type": "string"
},
"merchantCancellable": {
"description": "ignore (Viator only)\n\nFor cancellation information regarding the booking, please refer to the `merchantTermsAndConditions` object\n",
"type": "boolean"
},
"merchantNetPriceFrom": {
"$ref": "#/components/schemas/merchantNetPriceFrom"
},
"merchantNetPriceFromFormatted": {
"$ref": "#/components/schemas/merchantNetPriceFromFormatted"
},
"onRequestPeriod": {
"$ref": "#/components/schemas/onRequestPeriod"
},
"onSale": {
"$ref": "#/components/schemas/onSale"
},
"panoramaCount": {
"description": "**number** of panoramic images available for *this* product",
"type": "integer"
},
"pas": {
"description": "**object** detailing product availability\n- `pas` stands for Product Availability Schema\n",
"type": "object"
},
"photoCount": {
"description": "**number** of user photos published for *this* product",
"type": "integer"
},
"price": {
"$ref": "#/components/schemas/price"
},
"priceFormatted": {
"$ref": "#/components/schemas/priceFormatted"
},
"primaryDestinationId": {
"description": "**unique numeric identifier** of *this* product's primary destination",
"type": "integer"
},
"primaryDestinationName": {
"description": "**natural-language name** of *this* product's primary destination",
"type": "string"
},
"primaryDestinationUrlName": {
"description": "**URL-formatted name** of *this* product's primary destination",
"type": "string"
},
"primaryGroupId": {
"description": "ignore (Viator only)",
"type": "string"
},
"productURLName": {
"description": "**URL-formatted name** of *this* product",
"type": "string"
},
"publishedDate": {
"description": "ignore (Viator only)",
"nullable": true,
"type": "string"
},
"rating": {
"$ref": "#/components/schemas/rating"
},
"reviewCount": {
"$ref": "#/components/schemas/reviewCount"
},
"rrp": {
"$ref": "#/components/schemas/rrp"
},
"rrpformatted": {
"$ref": "#/components/schemas/rrpFormatted"
},
"savingAmount": {
"$ref": "#/components/schemas/savingAmount"
},
"savingAmountFormated": {
"$ref": "#/components/schemas/savingAmountFormated"
},
"shortDescription": {
"description": "**natural-language description** (shortened) of *this* product",
"type": "string"
},
"shortTitle": {
"description": "**natural-language title** (shortened) of *this* product",
"type": "string"
},
"sortOrder": {
"description": "ignore (Viator only)",
"type": "integer"
},
"specialOfferAvailable": {
"$ref": "#/components/schemas/specialOfferAvailable"
},
"specialReservation": {
"description": "ignore (Viator only)",
"type": "boolean"
},
"specialReservationDetails": {
"description": "ignore (Viator only)",
"type": "string"
},
"sslSupported": {
"description": "ignore (Viator only)",
"type": "boolean"
},
"subCatIds": {
"description": "**list** of unique numeric subcategory identifiers that *this* product falls under\n- `subcategoryId` is available from [/taxonomy/categories](#operation/taxonomyCategories) service\"\n",
"items": {
"type": "integer"
},
"type": "array"
},
"supplierCode": {
"description": "**unique identifier** of *this* product's supplier",
"type": "string"
},
"supplierName": {
"description": "**natural-language name** of *this* product's supplier",
"type": "string"
},
"thumbnailHiResURL": {
"description": "**high-resolution thumbnail image URL** for *this* product",
"type": "string"
},
"thumbnailURL": {
"description": "**URL** of *this* product's thumbnail image",
"type": "string"
},
"title": {
"description": "**natural-language title** of *this* product",
"type": "string"
},
"translationLevel": {
"$ref": "#/components/schemas/translationLevel"
},
"uniqueShortDescription": {
"description": "ignore (Viator only)",
"type": "string"
},
"videoCount": {
"description": "ignore (Viator only) – videos are not available to partners",
"type": "integer"
},
"webURL": {
"$ref": "#/components/schemas/webURL"
}
},
"type": "object"
}
},
"type": "object"
}
]
},
"SearchFreetextResponseRecommendation": {
"allOf": [
{
"$ref": "#/components/schemas/SearchFreetextResponse"
},
{
"properties": {
"data": {
"description": "**object** detailing a **recommendation** that matches the search criteria",
"properties": {
"attractionCity": {
"description": "ignore (Viator only)",
"nullable": true,
"type": "string"
},
"attractionLatitude": {
"description": "ignore (Viator only)",
"nullable": true,
"type": "number"
},
"attractionLongitude": {
"description": "ignore (Viator only)",
"nullable": true,
"type": "number"
},
"attractionState": {
"description": "ignore (Viator only)",
"type": "string"
},
"attractionStreetAddress": {
"description": "ignore (Viator only)",
"nullable": true,
"type": "string"
},
"descriptionIntro": {
"description": "Introductory text for this recommendation",
"type": "string"
},
"descriptionText": {
"description": "Text for this recommendation",
"type": "string"
},
"destinationId": {
"description": "Destination Id for the destination of this recommendation",
"type": "integer"
},
"editorsPick": {
"description": "ignore (Viator only)",
"type": "boolean"
},
"keywordCount": {
"description": "ignore (Viator only)",
"type": "integer"
},
"keywords": {
"description": "ignore (Viator only)",
"items": {
"description": "ignore (Viator only)",
"type": "string"
},
"type": "array"
},
"overviewSummary": {
"description": "HTML-formatted overview of recommendation",
"type": "string"
},
"pagePrimaryLanguage": {
"description": "language for the natural-language text in this response",
"type": "string"
},
"pageTitle": {
"description": "Title of this page",
"type": "string"
},
"pageUrlName": {
"description": "URL path fragment for this recommendation",
"type": "string"
},
"panoramaCount": {
"description": "ignore (Viator only)",
"type": "integer"
},
"photoCount": {
"description": "ignore (Viator only)",
"type": "integer"
},
"primaryDestinationId": {
"description": "Destination Id for the primary destination of this recommendation",
"type": "integer"
},
"primaryDestinationName": {
"description": "Name of primary destination for this recommendation",
"type": "string"
},
"primaryDestinationUrlName": {
"description": "ignore (Viator only)",
"type": "string"
},
"productCount": {
"description": "Number of products that this recommendation refers to",
"type": "integer"
},
"publishedDate": {
"description": "ignore (Viator only)",
"nullable": true,
"type": "string"
},
"rating": {
"description": "Numeric average rating for this recommendation",
"type": "number"
},
"reviewCount": {
"description": "number of reviews for this recommendation",
"type": "integer"
},
"seoId": {
"description": "ignore (Viator only)",
"type": "integer"
},
"seoType": {
"description": "Type of response; i.e. `\"RECOMMENDATION\"`",
"type": "string"
},
"showPhotos": {
"description": "ignore (Viator only)",
"type": "boolean"
},
"showReviews": {
"description": "ignore (Viator only)",
"type": "boolean"
},
"sortOrder": {
"description": "ignore (Viator only)",
"type": "integer"
},
"tabTitle": {
"description": "Tab-title for this recommendation",
"type": "string"
},
"thumbnailHiResURL": {
"description": "URL for the high-resolution image for this recommendation",
"type": "string"
},
"thumbnailURL": {
"description": "URL for medium-resolution image for this recommendation",
"type": "string"
},
"title": {
"description": "Title of this recommendation",
"type": "string"
},
"userName": {
"description": "ignore (Viator only)",
"type": "string"
},
"webURL": {
"$ref": "#/components/schemas/webURL"
}
},
"type": "object"
}
},
"type": "object"
}
]
},
"ageBandId": {
"description": "**unique numeric identifier** for the age band\n- See: [Working with age bands](#section/Appendices/Working-with-age-bands)\n",
"type": "integer"
},
"bandId": {
"description": "**unique numeric identifier** for the age band\n- See: [Working with age bands](#section/Appendices/Working-with-age-bands)\n",
"type": "integer"
},
"basicErrorModel": {
"properties": {
"dateStamp": {
"description": "**timestamp** of *this* response",
"nullable": true,
"type": "string"
},
"errorCodes": {
"description": "**array** of error codes pertaining to *this* error\n- See: [Viator API error codes](#section/Appendices/Viator-API-error-codes) for a list of possible error codes\n",
"example": [],
"items": {
"type": "string"
},
"nullable": true,
"type": "array"
},
"errorMessage": {
"description": "**array** of error message strings",
"items": {},
"nullable": true,
"type": "array"
},
"errorMessageText": {
"description": "**array** of error message strings in plain text",
"nullable": true,
"type": "string"
},
"errorName": {
"description": "**name** of *this* type of error",
"nullable": true,
"type": "string"
},
"errorReference": {
"description": "**reference number** of *this* error",
"nullable": true,
"type": "string"
},
"errorType": {
"description": "**code** specifying the type of error",
"nullable": true,
"type": "string"
},
"extraInfo": {
"description": "ignore (Viator only)",
"nullable": true,
"type": "object"
},
"extraObject": {
"description": "ignore (Viator only)",
"nullable": true,
"type": "object"
},
"success": {
"description": "**boolean indicator** of *this* request's outcome\n- `true`: the request was successful with no errors\n- `false`: an error was encountered\n",
"nullable": true,
"type": "boolean"
},
"totalCount": {
"description": "**number** of results available for *this* service\n",
"nullable": true,
"type": "integer"
},
"vmid": {
"description": "**unique numeric id** of the server that processed *this* request",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"bookingEngineId": {
"description": "**booking type specifier** for *this* product that indicates whether the booking will be `CONFIRMED` immediately or if it will remain `PENDING` even after the booking has been made\n\n*one of* the following:\n- `\"FreesaleBE\"` – *this* product will be confirmed immediately and the supplier will be sent a notification\n- `\"UnconditionalBE\"` - *this* product will be confirmed immediately and the supplier will not be notified\n- `\"DeferredCRMBE\"` - *this* product is an on-request product and will not be confirmed immediately. *this* product will have a `PENDING` status after it is booked, to be confirmed by the supplier within the time specified in the `hoursConfirmed` field available in the booking response and post-booking services\n- `\"FreesaleOnRequestBE\"` - *this* product is freesale up until a certain number of days before the travel date, referred to as the *on-request period*.\n\nIf a booking is made within the on-request period, *this* product will be an on-request product. Once the booking has been made, the `bookingEngineId` will change to either `\"FreesaleOnRequestBE:OnRequest\"` or `\"FreesaleOnRequestBE:Freesold\"` depending on the travel date and the on-request period \n",
"enum": [
"FreesaleBE",
"UnconditionalBE",
"DeferredCRMBE",
"FreesaleOnRequestBE"
],
"type": "string"
},
"bookingEngineId-response": {
"description": "[booking type indicator](#section/Key-concepts/Booking-concepts) that indicates whether the booking will be `CONFIRMED` immediately or if it will remain `PENDING` even after the booking has been made\n\n*one of* the following:\n- `\"UF\"` (FreesaleBE and UnconditionalBE) – this booking will be confirmed immediately\n- `\"OR\"` (DeferredCRMBE) – the booked product is an on-request product, will not be confirmed immediately and will have a `PENDING` status after it is booked, to be confirmed by the supplier within the time specified in the `hoursConfirmed` field available in the booking response and post-booking services\n- `\"FO\"` (FreesaleOnRequestBE) – the booked product is freesale up until a certain number of days before the travel date, referred to as the *on-request period*.\n",
"enum": [
"UF",
"OR",
"FO"
],
"type": "string"
},
"bookingStatus_item": {
"description": "**object** containing item booking status information",
"properties": {
"amended": {
"description": "**indicator**: `true` if *this* item's booking has been amended",
"type": "boolean"
},
"cancelled": {
"description": "**indicator**: `true` if *this* item's booking has been cancelled",
"type": "boolean"
},
"confirmed": {
"description": "**indicator**: `true` if *this* item's booking is confirmed",
"type": "boolean"
},
"failed": {
"description": "**indicator**: `true` if *this* item's booking has failed",
"type": "boolean"
},
"level": {
"description": "**level** of *this* item's booking status",
"enum": [
"ITEM",
"ITINERARY"
],
"type": "string"
},
"pending": {
"description": "**indicator**: `true` if *this* item's booking is pending",
"type": "boolean"
},
"status": {
"description": "**numeric identifier** of *this* item's booking status",
"type": "integer"
},
"text": {
"description": "**natural-language description** of *this* item's booking status; e.g., 'Waiting to be booked'",
"type": "string"
},
"type": {
"description": "**specifier** of *this* item's booking status\n* See: [bookingStatus fields and meanings](#section/Appendices/bookingStatus-field-values-and-meanings)\n",
"enum": [
"WAITING",
"CONFIRMED",
"UNAVAILABLE",
"PENDING",
"FAILED",
"CANCELLED",
"EXPIRED",
"AMENDED",
"PENDING_AMEND",
"REJECTED",
"ON_HOLD"
],
"type": "string"
}
},
"type": "object"
},
"bookingStatus_itinerary": {
"description": "**object** containing itinerary booking status information",
"properties": {
"amended": {
"description": "**indicator**: `true` if *this* itinerary's booking has been amended",
"type": "boolean"
},
"cancelled": {
"description": "**indicator**: `true` if *this* itinerary's booking has been cancelled",
"type": "boolean"
},
"confirmed": {
"description": "**indicator**: `true` if *this* itinerary's booking is confirmed",
"type": "boolean"
},
"failed": {
"description": "**indicator**: `true` if *this* itinerary's booking has failed",
"type": "boolean"
},
"level": {
"description": "**level** of *this* itinerary's booking status",
"enum": [
"ITEM",
"ITINERARY"
],
"type": "string"
},
"pending": {
"description": "**indicator**: `true` if *this* itinerary's booking is pending",
"type": "boolean"
},
"status": {
"description": "**numeric identifier** of *this* itinerary's booking status",
"type": "integer"
},
"text": {
"description": "**natural-language description** of *this* itinerary's booking status",
"type": "string"
},
"type": {
"description": "**specifier** of *this* itinerary's booking status\n* See: [bookingStatus fields and meanings](#section/Appendices/bookingStatus-field-values-and-meanings)\n",
"enum": [
"WAITING",
"CONFIRMED",
"PENDING",
"FAILED",
"CANCELLED",
"AMENDED",
"PENDING_AMEND"
],
"type": "string"
}
},
"type": "object"
},
"currencyCode": {
"description": "Three-letter code indicating the currency in which `itemPrice` and `refundAmount` are displayed",
"example": "USD",
"type": "string"
},
"destinationType": {
"description": "**destination type specifier**\n- `\"COUNTRY\"`: destination is a country\n- `\"REGION\"`: destination is a recognized region of a country, such as a state, island within a country, stretch of coastline, etc.\n- `\"CITY\"`: destination is a city\n",
"enum": [
"CITY",
"COUNTRY",
"REGION"
],
"type": "string"
},
"iataCode": {
"description": "**IATA airport code** for the destination\n- a three-letter code defined by the International Air Transport Association (IATA) used to identify many airports around the world\n- the IATA code is also known as an 'IATA location identifier', 'IATA station code' or simply a 'location identifier'\n- the IATA code is <u>not available</u> for destinations with a destination type of `'COUNTRY'` or `'REGION'`, as there could be more than one airport within a destination\n",
"nullable": true,
"type": "string"
},
"merchantNetPriceFrom": {
"description": "Numeric 'from' (lowest possible) price that Viator will invoice the merchant for the sale of this product, excluding the transaction fee; i.e. the merchant net rate\n\nFor more information, see: [Merchant pricing](#section/Key-concepts/Merchant-pricing)\n",
"type": "number"
},
"merchantNetPriceFromFormatted": {
"description": "Currency-formatted 'from' (lowest possible) price that Viator will invoice the merchant for the sale of this product, excluding the transaction fee (i.e. the merchant net rate)\n\nFor more information, see: [Merchant pricing](#section/Key-concepts/Merchant-pricing)\n",
"type": "string"
},
"onRequestPeriod": {
"description": "**number** of hours before the travel date that *this* product will be 'on-request' for\n- this field will contain a value if the `bookingEngineId` is `'FreesaleOnRequestBE'`\n- an `onRequestPeriod` of 48 hours means that *this* product is freesale up until 48 hours before the travel date, and is on-request for 48 hours or less until the travel date\n- **note**: 'hours in advance' (the number of hours a product is available for booking before the travel date) may also affect this; however, this value is not available in the API\n",
"nullable": true,
"type": "integer"
},
"onSale": {
"description": "Ignore (Viator only)\n",
"type": "boolean"
},
"photoObject": {
"description": "**object** detailing a single photo from a user",
"properties": {
"caption": {
"description": "**HTML-formatted caption** for *this* photograph\n- may contain basic HTML mark-up - e.g., br, li, b, u, p, i, ul and ol\n",
"type": "string"
},
"editorsPick": {
"description": "**indicator**: `true` if *this* photograph has been tagged as an *editor's pick*; i.e., can be given preference for display",
"type": "boolean"
},
"ownerAvatarURL": {
"description": "**URL** for the avatar image of the user that submitted *this* photograph",
"nullable": true,
"type": "string"
},
"ownerCountry": {
"description": "**country** in which the owner of *this* photograph is located",
"nullable": true,
"type": "string"
},
"ownerId": {
"description": "**unique numeric identifier** of the user that owns the photograph",
"type": "integer"
},
"ownerName": {
"description": "**handle** of the user that submitted *this* photograph; e.g., 'Husker1k'",
"type": "string"
},
"photoHiResURL": {
"description": "**URL** of the high-resolution version of *this* photograph",
"type": "string"
},
"photoId": {
"description": "**unique numeric identifier** of *this* photograph",
"type": "integer"
},
"photoMediumResURL": {
"description": "**URL** of the medium-resolution version of *this* photograph",
"type": "string"
},
"photoURL": {
"description": "**URL** for the standard-resolution version of *this* photograph",
"type": "string"
},
"productCode": {
"description": "**product code** for the product that *this* photograph is of",
"type": "string"
},
"productTitle": {
"description": "**natural-language title** of the product associated with *this* photograph; e.g., 'Sydney and Bondi Hop-on Hop-off Tour'",
"type": "string"
},
"productUrlName": {
"description": "**URL-formatted title** of the product associated with *this* photograph; e.g., `Sydney-and-Bondi-Hop-on-Hop-off-Tour`",
"type": "string"
},
"sortOrder": {
"description": "**sort order** for *this* photograph; e.g., `3`",
"type": "integer"
},
"sslSupported": {
"description": "ignore (Viator only)",
"type": "boolean"
},
"thumbnailURL": {
"description": "**URL** of *this* product's thumbnail image",
"type": "string"
},
"timeUploaded": {
"description": "**date** on which *this* photograph was submitted",
"type": "string"
},
"title": {
"description": "**title** of *this* photograph",
"type": "string"
}
},
"type": "object"
},
"price": {
"description": "**suggested sell ('from') price** for this product in the currency set in the `currencyCode` parameter. This is the cheapest sell price, taking into consideration off-peak periods and discounts on larger groups.\n\n\n - For more information, see: [Merchant pricing](#section/Merchant-APIs/Merchant-pricing)\n",
"type": "number"
},
"priceFormatted": {
"description": "**currency-formatted suggested sell ('from') price** for this product in the currency set in the `currencyCode` parameter\n\n- For more information, see: [Merchant pricing](#section/Merchant-APIs/Merchant-pricing)\n",
"type": "string"
},
"rating": {
"description": "**average user rating** of *this* product\n\nusers rate products by assigning a star-rating from 1-5; this value shows the average of the star ratings provided by users;\n\nthe `ratingCounts` associative array in this response provides a breakdown of how many submissions for each star rating have been received\n",
"type": "number"
},
"ratingCounts": {
"description": "**dictionary** of rating (stars) to number of reviews with each rating for *this* product\"\n\nusers rate products by assigning a star-rating from 1-5; these values show the total number of reviews for each of the star ratings (up to a maximum given in the `reviewCount` field in this response)\n\n- **note**: see response sample for structure\n",
"properties": {
"1": {
"description": "Number of reviews with a one star rating",
"type": "number"
},
"2": {
"description": "Number of reviews with a two star rating",
"type": "number"
},
"3": {
"description": "Number of reviews with a three star rating",
"type": "number"
},
"4": {
"description": "Number of reviews with a four star rating",
"type": "number"
},
"5": {
"description": "Number of reviews with a five star rating",
"type": "number"
}
},
"type": "object"
},
"reviewCount": {
"description": "**number** of user reviews that have been submitted by users for *this* product\n\nIf your account has been configured to limit the number of reviews you can receive, this value will never be higher than that. Otherwise, this value will show the total number of reviews available for this product. If there are more than 24 reviews available, you will need to use the [/product/reviews](#operation/productReviews) service to retrieve the remainder of the reviews.\n",
"type": "integer"
},
"reviewObject": {
"description": "**object** containing a single user review",
"properties": {
"ownerAvatarURL": {
"description": "**URL** of the reviewer's avatar image",
"nullable": true,
"type": "string"
},
"ownerCountry": {
"description": "**country** in which the reviewer is located",
"nullable": true,
"type": "string"
},
"ownerId": {
"description": "**unique numeric identifier** of the user that submitted *this* review",
"type": "integer"
},
"ownerName": {
"description": "**name** of the user that submitted *this* review",
"type": "string"
},
"productCode": {
"description": "**product code** of the product that *this* review is about; e.g., `5010SYDNEY`",
"type": "string"
},
"productTitle": {
"description": "**title** of the product that *this* review is about",
"type": "string"
},
"productUrlName": {
"description": "**URL-formatted title** of the product that *this* review is about",
"type": "string"
},
"publishedDate": {
"description": "**date** that *this* review was published",
"type": "string"
},
"rating": {
"description": "**rating** given by the reviewer",
"type": "integer"
},
"review": {
"description": "**HTML-formatted content** of the review\n- may contain basic HTML mark-up - e.g., br, li, b, u, p, i, ul and ol\n",
"type": "string"
},
"reviewId": {
"description": "**unique numeric identifier** of *this* review",
"type": "integer"
},
"sortOrder": {
"description": "**sort order** for *this* review",
"type": "integer"
},
"sslSupported": {
"description": "ignore (Viator only)",
"type": "boolean"
},
"submissionDate": {
"description": "**date** that *this* review was submitted",
"type": "string"
},
"viatorFeedback": {
"description": "ignore (Viator only)",
"type": "string"
},
"viatorNotes": {
"description": "ignore (Viator only)",
"type": "string"
}
},
"type": "object"
},
"reviews": {
"description": "**array** of user review objects\n\nThe number of reviews returned here will either be the number of reviews you are entitled to according to your account configuration; or, if you are not limited in the number of reviews you can receive, will be a maxiumum of 24 reviews. If the value of `reviewCount` in this response exceeds 24, you can use the [/product/reviews](#operation/productReviews) endpoint to retrieve the remainder of the reviews.\n",
"items": {
"$ref": "#/components/schemas/reviewObject"
},
"type": "array"
},
"rrp": {
"description": "**numeric original price** for this product if the product is on special / a discount has been applied. `0` if there is no discount on this product. See [Special offers and on-sale pricing](#section/Key-concepts/Special-offers-and-on-sale-pricing) for more information.",
"type": "integer"
},
"rrpFormatted": {
"description": "**currency-formatted original price** for this product if the product is on special / a discount has been applied. Empty string if there is no discount on this product. See [Special offers and on-sale pricing](#section/Key-concepts/Special-offers-and-on-sale-pricing) for more information.",
"type": "string"
},
"savingAmount": {
"description": "Ignore (Viator only)\n",
"type": "string"
},
"savingAmountFormated": {
"description": "Ignore (Viator only)\n",
"type": "string"
},
"sortOrder": {
"description": "**sort order** in which to return the results that is *one of*:\n\n - `'TOP_SELLERS'`: the top sellers\n - `'REVIEW_AVG_RATING_A'`: ascending by average traveler rating (low -> high)\n - `'REVIEW_AVG_RATING_D'`: descending by average traveler rating (high -> low)\n - `'PRICE_FROM_A'`: ascending by price (low -> high)\n - `'PRICE_FROM_D'`: descending by price (high -> low)\n",
"enum": [
"TOP_SELLERS",
"REVIEW_AVG_RATING_A",
"REVIEW_AVG_RATING_D",
"PRICE_FROM_A",
"PRICE_FROM_D"
],
"type": "string"
},
"specialOffer": {
"description": "**natural-language description** of any special offers available for *this* product when `specialOfferAvailable` is `true`.\n- empty string if there are no specials available\n- See [Special offers and on-sale pricing](#section/Key-concepts/Special-offers-and-on-sale-pricing) for more information.\n",
"type": "string"
},
"specialOfferAvailable": {
"description": "**indicator**: `true` if a special offer is available for *this* product. If `true` the `specialOffer` field will contain a text string providing details of the special offer which you may wish to display in your product search results. E.g. 'Book by May 27 to save 34% off our previously offered price!'. See [Special offers and on-sale pricing](#section/Key-concepts/Special-offers-and-on-sale-pricing) for more information.",
"type": "boolean"
},
"topX": {
"description": "**start and end rows** to return in the format {start}-{end}\n- e.g. `'1-10'`, `'11-20'`\n\n**Note**: \n- the maximum number of rows per request is 100; therefore, `'100-400'` will return the same as `'100-200'`\n- if `topX` is not specified, the default is `'1-100'`\n",
"type": "string"
},
"translationLevel": {
"description": "**numeric indicator** of the language translation level for *this* product that is one of:\n- `0`: no translation (English only)\n- `80`: full machine translation\n- `100`: full human translation\n\nSee: [Working with human and machine translations](#section/Appendices/Working-with-human-and-machine-translations) for more information\n",
"enum": [
0,
80,
100
],
"type": "integer"
},
"webURL": {
"description": "ignore (Viator only)",
"nullable": true,
"type": "string"
}
},
"securitySchemes": {
"API-key": {
"in": "header",
"name": "exp-api-key",
"type": "apiKey"
},
"Legacy-API-key": {
"in": "query",
"name": "apiKey",
"type": "apiKey"
}
}
}
}