The identity and technical contract details declared by the specification.
Product
object
5 properties
3 required
TicketsPerBooking
string
Machine-interpretable value indicating whether each traveler needs their own ticket; one of: - "ONEPERBOOKING" - "ONEPERTRAVELER"
TicketInfo
object
Ticket/voucher details for this product
4 properties
2 required
PricingType
string
Machine-interpretable value specifying whether the pricing for this product is calculated per individual or per group (unit); one of: - "PERPERSON" - "UNIT"
AgeBandType
string
Machine-interpretable value that specifies this age band's type; one of: - "ADULT" - "SENIOR" - "YOUTH" - "CHILD" - "INFANT" - "TRAVELER"
AgeBand
object
Age range categories for this product's ticketing scheme
5 properties
PricingUnitType
string
Machine-interpretable value specifying the type of unit/group when type is "UNIT"; one of: - "BIKE" - "BOAT" - "GROUP" - "PACKAGE" - "ROOM" - "AIRCRAFT" - "VEH…
PricingInfo
object
Ticket/voucher details for this product
3 properties
2 required
ImageSourceType
string
Machine-interpretable value indicating the source of this image; one of: - "SUPPLIERPROVIDED" - "PROFESSIONAL"
ImageVariant
object
3 properties
3 required
Image
object
Image information
4 properties
2 required
StreamingVideoVariant
object
Streaming video variant
3 properties
3 required
ProgressiveVideoVariant
object
Progressive video variant
3 properties
3 required
VideoVariants
object
An object of available video delivery options for the same content, structured by delivery strategy. Each variant defines how the video can be retrieved and pl…
2 properties
2 required
Video
object
Product video
2 properties
1 required
LocationReference
object
Details about the location can be retrieved using the [/locations/bulk](operation/locationsBulk) endpoint
1 property
1 required
StartEndPoint
object
2 properties
1 required
Redemption
object
Redemption point details for this product
3 properties
1 required
PickupOptionType
string
Machine-interpretable value encoding the type of traveler pickup option; one of: - "PICKUPEVERYONE" (the supplier will pick up all customers from their respect…
PickupLocation
object
Pickup or meeting point
2 properties
1 required
TravelerPickup
object
Traveler pickup details for this product
5 properties
2 required
Logistics
object
Logistics details for this product
4 properties
1 required
InclusionExclusionItem
object
7 properties
1 required
AdditionalInfo
object
An additional information fact to communicate to travelers regarding this product
2 properties
1 required
CancellationConditionType
string
Machine-interpretable value encoding the type of cancellation policy for this product; one of: - STANDARD - Products in this category are cancellable up to 24…
CancellationCondition
object
Structured description of fees pertaining to cancellations during various time windows.
5 properties
2 required
CancellationPolicy
object
Cancellation policy details for this product.
5 properties
4 required
BookingCutoffType
string
Machine-interpretable value encoding the type of booking cutoff; one of: - "OPENINGTIME" - "CLOSINGTIME" - "STARTTIME" - "FIXEDTIME"
ConfirmationType
string
Machine-interpretable value encoding when bookings for this product will be confirmed; one of: - "INSTANT" (instantly) - "MANUAL" (requires manual action prior…
BookingConfirmationSettings
object
How this product's bookings are confirmed For more information, see [Booking concepts – Booking cutoff times](section/Booking-concepts/Booking-cutoff-times)
5 properties
2 required
BookingRequirements
object
Passenger type and number requirements for booking
3 properties
3 required
LanguageGuide
object
Specifies which language and what type of language guide to include if language guides are available for this product. Note: This element must be included in o…
3 properties
2 required
Destination
object
Reference details about a destination associated with this product
2 properties
2 required
Itinerary
object
Details about the places this product visits See: [Key concepts – Itineraries](section/Key-concepts/Itineraries) for more information
5 properties
3 required
ItineraryDuration
object
Duration information for this itinerary Note: Depending on whether this itinerary has a fixed or variable duration, this object will include either the fixedVa…
4 properties
ItineraryPoi
object
Details about this Point Of Interest (POI)
2 properties
1 required
AdmissionInclusionType
string
Machine-interpretable value encoding whether the admission fee for this place is included; one of: - "YES" - "NO" - "NOTAPPLICABLE"
StandardItineraryItem
object
5 properties
2 required
ActivitiesItineraryItem
object
Location and description of this activity item
2 properties
1 required
ActivityFoodMenu
object
Food menu details for this activity
3 properties
2 required
MultiDayTourAccommodation
object
Details for this accommodation venue
2 properties
1 required
MultiDayTourFoodAndDrinks
object
3 properties
MultiDayTourItineraryDay
object
Details about a single day of a multi-day tour
5 properties
2 required
HopOnHopOffStop
object
Place at which passengers can board or alight the tour vehicle
2 properties
1 required
HopOnHopOffItineraryRoute
object
5 properties
3 required
ItineraryType
string
Machine-interpretable value specifying the type of itinerary available for this product; one of: - "STANDARD" - "ACTIVITY" - "MULTIDAYTOUR" - "HOPONHOPOFF" - "…
TravelerPickupProductOption
object
3 properties
2 required
ProductOptionLogistics
object
Logistics details applicable to this specific product option. When present, use this object instead of the product-level logistics object for start and end poi…
3 properties
ProductOption
object
Detail about a single product option for this product
5 properties
2 required
TranslationDetails
object
Information about whether the text in this response was machine-translated
3 properties
2 required
Supplier
object
Supplier details
2 properties
2 required
ProductReviewCount
object
Breakdown of number of reviews for each rating of this product
2 properties
2 required
ProductReviewSource
object
4 properties
2 required
ProductReviews
object
Summary of reviews and ratings for this product Note: - Review data is updated daily; i.e., all reviews received on a day will be added and averages re-calcula…
4 properties
1 required
ViatorUniqueContent
object
Product details unique to Viator.com Note: - Access to this information is only available if it is enabled for your account. Please speak to your account manag…
5 properties
ProductStatus
string
Machine-interpretable value indicating this product's current availablility; one of: - "ACTIVE" - product is available for sale - "INACTIVE" - product is not a…
ProductsResponse
object
2 properties
1 required
ErrorResponse
object
4 properties
BulkProductRequest
object
1 property
1 required
TagWithAllLocalizations
object
Category/subcategory tag for this product
3 properties
1 required
TagsResponse
object
Numeric product category/subcategory tag identifiers for this product To retrieve details about which tags these identifiers refer to, please use the [/product…
1 property
1 required
BookingQuestionFormatType
string
Machine-interpretable value encoding the required unit type for the answer to the booking question; one of: - "STRING" - "NUMBERANDUNIT" - "DATE" - "TIME" - "L…
BookingQuestionGrouping
string
Machine-interpretable value specifying whether the booking question must be answered individually for each traveler or once per group of travelers in each book…
BookingQuestion
object
A single booking question
10 properties
BookingQuestionsResponse
object
Information about this product's booking questions
1 property
1 required
ProductSearchFlag
string
One of: - "NEWONVIATOR" – products that have been added to Viator's catalogue within the past 270 days - "SKIPTHELINE" – products that allow participants to at…
SearchRatingInfo
object
Only return products that have a rating that is in the range defined here
2 properties
SearchDurationInfo
object
Only return products that have a duration that is in the range defined here.
2 properties
ProductSearchFiltering
object
Only return products that match all the criteria provided here.
12 properties
1 required
ProductSearchSorting
object
How the search results will be sorted
2 properties
ProductSearchPagination
object
Pagination details specifying which search results to return based on start position and item count
2 properties
ProductSearchRequest
object
4 properties
2 required
AvailabilityScheduleSummary
object
Information about the lowest price available for this product Note: The pricing information given here is based on the recommended retail price (RRP). While af…
2 properties
1 required
AvailabilityScheduleExtraChargesSummary
object
Information about the lowest price with extra charges available for this product
3 properties
2 required
ProductSearchPricing
object
High-level summary of product prices - Note: This price may not be available during the date range specified in the filtering section of the request
4 properties
2 required
ProductSummary
object
15 properties
4 required
ProductSearchResponse
object
2 properties
2 required
BulkProductRecommendationsRequest
object
2 properties
2 required
ProductRecommendation
object
2 properties
2 required
FreetextSearchProductFiltering
object
Criteria by which to filter product search results (i.e., when searchTypes includes "PRODUCTS")
8 properties
1 required
FreetextSearchProductSorting
object
Specify the sorting method for product results (i.e., when searchTypes includes "PRODUCTS")
2 properties
SearchType
object
2 properties
FreetextSearchRequest
object
5 properties
3 required
DestinationSearchResult
object
6 properties
ProductReviewsSummaryCount
object
2 properties
2 required
ProductReviewsSummarySource
object
3 properties
2 required
ProductReviewsSummary
object
Summary of reviews and ratings for this attraction Note: - Review data is updated daily; i.e., all reviews received on a day will be added and averages re-calc…
4 properties
1 required
AttractionResult
object
9 properties
FreetextSearchResponse
object
3 properties
PaxMixItem
object
2 properties
2 required
CheckAvailabilityRequest
object
6 properties
4 required
CapacityObject
object
Provides capacity information for the selected bookableItem. Note: Capacity information is not available for all products. The absence of the capacity object o…
1 property
NumberOfTravelers
integer
The number of travelers that this line-item describes the subtotal price for.
RecommendedRetailPrice
number
The recommended retail price for the item and the price at which the product is sold on the Viator.com site
PartnerNetPrice
number
The non-booking fee component of the total amount that Viator will invoice the merchant for this item
PriceObject
object
5 properties
4 required
PriceObjectSubtotal
Components of this price
LineItemPriceObjectSubtotal
object
Subtotal pricing for this line item, including discount information if available
2 properties
1 required
PricingLineItem
object
3 properties
2 required
LineItemPriceObject
object
2 properties
1 required
ExtraChargesItemInDestinationCurrency
object
The Extra Charges amount in destination currency.
3 properties
3 required
ExtraChargesItem
object
List of extra charges. Partners can use this to build a breakdown list of costs.
5 properties
5 required
ExtraChargesSummary
object
Information about the Extra Charges applicable to this bookableItem. Note: - Prices payable to third parties are provided to us by the operator, and may be sub…
3 properties
2 required
CheckAvailabilityBookableItem
object
Details of this bookable item
9 properties
1 required
CheckAvailabilityResponse
object
4 properties
4 required
UnavailableDate
object
2 properties
TimedEntry
object
2 properties
1 required
BasicPriceWithSpecial
Pricing amount information, including 'special' pricing when available. - Note: As the prices listed here may have changed by the time the booking request is m…
1 required
PricingDetails
object
5 properties
1 required
PricingRecord
object
4 properties
OperatingHours
object
2 properties
2 required
DayOperatingHours
object
2 properties
2 required
BookableItemSeason
object
4 properties
1 required
ProductBookableItemSchedule
object
2 properties
1 required
ProductAvailabilitySchedule
object
5 properties
4 required
BulkAvailabilityScheduleRequest
object
1 property
1 required
BulkAvailabilityScheduleResponse
object
1 property
1 required
AvailabilitySchedulesResponse
PartnerCartReference
string
Partner-generated unique cart reference for this group of bookable items.
Currency
string
Merchant Partners: One of USD, EUR, GBP, AUD, CAD Affiliate Partners with API access level "Full Access + Booking": One of USD, EUR, GBP, AUD, CAD, CHF, DKK, F…
PartnerBookingReference
string
Partner-generated unique booking reference for this bookable item.
ProductCode
string
Unique identifier for this product.
ProductOptionCode
string
Product option identifier. For more information see: [Key concepts: Product options](section/Key-concepts/Product-options)
StartTime
string
Starting time for the item in the case that the product/product option has multiple start times. Note: This element must be included for products that have mul…
TravelDate
string
Date of travel (according to the time zone in which the product operates).
AgeBand-2
string
Machine-interpretable value indicating the age-band that this/these traveler(s) fall into; one of: - ADULT - SENIOR - YOUTH - CHILD - INFANT - TRAVELER The val…
PaxMixItem-2
object
2 properties
2 required
BookingsCartHoldRequestItem
object
6 properties
4 required
CartReference
string
Viator-generated unique reference for this cart of bookable items, e.g.CR-44e4a3f8b65d11edafa10242ac120002
BookingReference
string
Unique Viator-generated booking reference for this bookable item.
BookingHoldStatus
string
The status of this bookable item; one of: - BOOKABLE – This item can currently be booked. Check bookingHoldInfo for availability and pricing hold statuses. - R…
BookingsCartHoldResponseItemBase
object
3 properties
3 required
RecommendedRetailPrice-2
number
The recommended retail price for the item and the price at which the product is sold on the Viator.com site.
PartnerNetPrice-2
number
The non-booking fee component of the amount that Viator will invoice the merchant. For affiliate partners with API access level "Full Access + Booking" this is…
PriceSubtotal
object
2 properties
2 required
PricingLineItemPriceSubtotal
object
2 properties
1 required
PricingLineItem-2
object
3 properties
3 required
CartPrice
object
5 properties
5 required
CartLineItemPrice
object
2 properties
1 required
BookingsCartResponseItemPrice
object
2 properties
2 required
HoldInfo
object
2 properties
1 required
BookingHoldInfo
object
Availability and pricing hold information.
2 properties
2 required
BookingsCartHoldResponseBookableItem
HoldRejectionReasonCode
string
In the case that status is REJECTED, this field provides a code as to the reason for the rejection; one of: - BOOKABLEITEMISNOLONGERAVAILABLE – this bookable i…
BookingsCartHoldResponseRejectedItem
BookingsCartHoldResponse
object
9 properties
5 required
BookerInfo
object
Name details for the person making this booking.
2 properties
2 required
CartBookCommunicationInfo
object
Details for correspondence regarding this booking. See: [Booking concepts – Supplier communications](section/Booking-concepts/Supplier-communications) for info…
2 properties
1 required
VoucherDetails
object
Merchant partners only: Additional details to display on the voucher.
5 properties
FraudPreventionDetails
object
Additional booking details used to enhance fraud detection accuracy. Note: Fraud Prevention Details only apply to affiliate partners with API access level "Ful…
5 properties
LoyaltyProgramDetails
object
Additional booking details used to associate partner's Loyalty Program Information with the booking. Note: This data will be used only by Viator’s internal tea…
3 properties
AdditionalBookingDetails
object
3 properties
BookingQuestionAnswers
object
4 properties
2 required
BookingQuestionAnswers-2
array
Answers to booking questions required for this booking. See: [Booking concepts – Booking questions](section/Booking-concepts/Booking-questions) for more inform…
BookingsCartBookRequestItem
object
3 properties
1 required
BookingsCartBookRequest
object
6 properties
4 required
BookingBookStatus
string
One of: CONFIRMED, PENDING, REJECTED Note: For "PENDING" poll [/booking/status](tag/Bookings/operation/bookingsStatus) for further booking status updates
BookingsCartBookResponseItemBase
object
3 properties
3 required
VoucherFormat
string
File format of the voucher; one of: - PDF - HTML Default is HTML if not specified.
VoucherInfo
object
Voucher information for this booking.
4 properties
3 required
BookingsCartBookResponseConfirmedItem
BookingsCartBookResponsePendingItem
CartBookRejectionReasonCode
string
In the case that status is REJECTED, this field provides a code as to the reason for the rejection; one of: - "BOOKABLEITEMISNOLONGERAVAILABLE" – this bookable…
BookingsCartBookResponseRejectedItem
VoucherInfoCart
object
Voucher information for this booking.
4 properties
3 required
BookingsCartBookResponse
object
7 properties
6 required
BookingRequest
object
6 properties
4 required
BookingHoldResponse
object
7 properties
2 required
CommunicationInfo
object
Details for correspondence regarding this booking. See: [Booking concepts – Supplier communications](section/Booking-concepts/Supplier-communications) for info…
2 properties
1 required
AdditionalBookingDetails-2
object
Optional extra details to include with booking
1 property
BookingBookResponse
object
9 properties
BookingStatusRequest
object
3 properties
BookingStatusResponseCommon
object
3 properties
2 required
AmendmentStatus
string
Machine-interpretable string indicating the outcome of the booking amendment request. One of: - AMENDED: The amendment was successful - REJECTED: The amendment…
AmendmentRejectionReasonCode
string
Machine-interpretable reason code indicating why the amendment was REJECTED. One of: - "BOOKABLEITEMISNOLONGERAMENDABLE” – this bookable item is no longer elig…
NextPollAt
string
Timestamp (UTC) indicating the recommended time the endpoint should be hit again. Example: "2025-04-03T02:54:29.082753Z"
BookingStatusResponseConfirmed
BookingStatusResponseTransient
BookingStatusResponseRejected
BookingStatusResponseOther
CancellationReason
object
2 properties
CancellationReasonsResponse
object
1 property
RefundDetails
object
Details of the refund. Note: Bookings that have not been confirmed by the supplier and have a status of "PENDING" will report an itemPrice, refundAmount and re…
4 properties
CancellationQuoteBookingStatus
string
Machine-interpretable string indicating the cancellation status of this itinerary item: - "CANCELLABLE" - this booking is available to be cancelled - "CANCELLE…
CancelBookingQuoteResponse
object
3 properties
2 required
CancellationRequest
object
1 property
1 required
CancellationResultItemReason
string
Machine-interpretable reason code indicating why the cancellation was not successful - "ALREADYCANCELLED": The booking has already been cancelled - "NOTCANCELL…
CancellationBookingStatus
string
Machine-interpretable string indicating the outcome of the booking cancellation request. One of: - "ACCEPTED": The cancellation was successful - "DECLINED": Th…
CancelBookingResponse
object
3 properties
2 required
BookingEventItem
object
4 properties
2 required
BookingEventCancellation
object
2 properties
1 required
BookingEvent
object
9 properties
7 required
BookingsModifiedSinceResponse
object
2 properties
1 required
EventsAcknowledgementRequest
object
1 property
1 required
Address
object
Minimal billing address details for cardholder
2 properties
2 required
CreditCardRequest
object
PCI sensitive details for a debit or credit card and relevant metadata.
6 properties
6 required
PaymentAccountsRequest
object
Wrapper element around payment data.
1 property
1 required
VaultCardRequest
object
The card submission payload.
1 property
1 required
AccountMetaData
object
1 property
CreditCard
object
8 properties
5 required
PaymentAccounts
object
1 property
VaultPaymentResponse
object
1 property
1 required
BulkLocationReferencesRequest
object
1 property
1 required
Location
object
Location detail
2 properties
2 required
LocationAddress
object
Address details for this location
6 properties
LocationCenter
object
Geographic coordinates (latitude/longitude) for this location
2 properties
LocationProvider
string
Name of the location services provider, one of: - "TRIPADVISOR" – location details will be provided in this response - "GOOGLE" – in order to retrieve details…
LocationsResponse
object
1 property
1 required
ExchangeRatesRequest
object
2 properties
ExchangeRateItem
object
5 properties
ExchangeRatesResponse
object
1 property
ProductReviewsRequest
object
8 properties
4 required
ReviewPhoto
object
3 properties
3 required
ReviewPhotoInfo
object
1 property
1 required
ProductReview
object
13 properties
8 required
ProductReviewsResponse
object
3 properties
4 required
BulkSupplierProductRequest
object
1 property
1 required
ContactDetails
object
4 properties
SupplierProductInfo
object
11 properties
4 required
SupplierProductResponse
object
Supplier details for the given product code
1 property
1 required
AttractionsSearchRequest
object
3 properties
1 required
AttractionDetails
object
14 properties
7 required
AttractionsSearchResponse
object
2 properties
DestinationDetails
object
12 properties
7 required
DestinationsResponse
object
2 properties
BookingRef
string
The booking reference code (in format BR-123456789), generated by Viator and returned in the bookingRef element in the response from [/bookings/book](operation…
AmendmentTypes
array
List of booking components that can be amended in this booking: - "BOOKINGDETAILS" - "UPDATEPAXMIX" - "PERTRAVELERQUESTIONS" - "PERBOOKINGQUESTIONS" Notes: - O…
BookingQuestionTraveler
string
Booking question identifier - id field in response from [/products/booking-questions](operation/productsBookingQuestions) endpoint. Possible values: - DATEOFBI…
BookingQuestionUnit
string
Unit in which the answer is provided; one of units in response from [/products/booking-questions](operation/productsBookingQuestions) endpoint.
PaxMixSummary
array
Summary of the current PAX MIX of the booking. It ensures each traveler listed in the PaxMix is assigned a travelerNum and informs which Booking Questions have…
AmendmentCheckResponse
object
5 properties
2 required
AmendmentQuoteRequestCommon
object
1 property
1 required
AmendBookingDetails
object
AmendPerTravelerQuestions
object
AmendPerBookingQuestions
object
AmendmentQuoteRequest
object
1 property
QuoteStatus
string
Machine-interpretable string indicating the outcome of the quote request. One of: - CONFIRMED: The quote was successful - REJECTED: The quote was rejected
AmendmentQuoteResponseCommon
object
2 properties
2 required
QuoteReference
string
Unique Viator-generated quote reference for a booking.
QuoteValidUntil
string
Timestamp (UTC) indicating when the quote expires.
QuoteInitialPrice
number
Total price of the booking at the time of purchase.
QuotePriceDifference
object
The price difference that must be paid (or refunded, if negative) to apply the requested amendment to the booking. This value reflects the cost impact of the p…
5 properties
4 required
AmendmentPricingLineItem
object
3 properties
2 required
AmendmentLineItemPriceObject
object
1 property
1 required
QuoteAmendedPrice
object
A detailed breakdown of the total booking price after the requested amendment has been applied.
2 properties
2 required
PaymentMethod
object
Information about the payment method to be used for this transaction. Notes: - The transaction will be processed using the payment method already associated wi…
3 properties
3 required
AmendmentQuoteResponseConfirmed
QuoteRejectionReasonCode
string
Machine-interpretable reason code indicating why the quote was rejected. One of: - "NOAVAILABILITY": This bookable item is not available for the specified comb…
AmendmentQuoteResponseRejected
AmendmentAmendResponseCommon
object
1 property
1 required
AmendmentAmendResponseInProgress
AmendmentAmendResponseAmended
AmendmentAmendResponseRejected
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Viator publishes across the network.