Aerostream Shopping APIs v2.9

Ancillaries Shopping APIs
Version 2.98
Copyright © 2024 JR Technologies

All Rights Reserved.
Confidential - Not for distribution
Contents
Change control............................................................................................................................................3
Introduction - Purpose of this Document....................................................................................................3
1. Shopping API........................................................................................................................................4
1.1 Summary..................................................................................................................................4
TravelOffersRQ........................................................................................................................................5
TravelOfferDetailsRQ...............................................................................................................................6
TravelOffersRS and TravelOfferDetailsRS................................................................................................8
Description of individual objects.......................................................................................................43
TravelOffersRS and TravelOfferDetailsRS – Mapping with Expedia attributes.......................................46
TravelOffersRS and TravelOfferDetailsRS – Mapping with Avis attributes.............................................57
TravelOffersRS and TravelOfferDetailsRS – Mapping with Viator attributes (Schedules – Products –
Availability)............................................................................................................................................64
TravelOffersRS and TravelOfferDetailsRS – Mapping with Viator attributes (Locations – Reviews – Tags
- Booking questions)..............................................................................................................................76
2. Shopping API for Properties.................................................................................................................1
1.2 Summary..................................................................................................................................1
2.2 API Details................................................................................................................................1
3. Shopping API for Experiences..............................................................................................................7
2.1 Summary........................................................................................................................................7
2.2 API Details......................................................................................................................................7
4. Shopping API for Car Hire..................................................................................................................12
3.1 Summary......................................................................................................................................12
3.2 API Details....................................................................................................................................12
5. OrderReshop API...............................................................................................................................15
5.1 Summary................................................................................................................................15
OrderReshopRQ.....................................................................................................................................16
OrderReshopRS.....................................................................................................................................16
Change control............................................................................................................................................3
Introduction - Purpose of this Document....................................................................................................3
1. Shopping API........................................................................................................................................4
1.1 Summary..................................................................................................................................4
Copyright © 2024 JR Technologies, All Rights Reserved. Page 2 of 105

TravelOffersRQ........................................................................................................................................5
TravelOfferDetailsRQ...............................................................................................................................6
TravelOffersRS and TravelOfferDetailsRS................................................................................................8
Description of individual objects.......................................................................................................41
TravelOffersRS and TravelOfferDetailsRS – Mapping with Expedia attributes.......................................42
TravelOffersRS and TravelOfferDetailsRS – Mapping with Avis attributes.............................................51
TravelOffersRS and TravelOfferDetailsRS – Mapping with Viator attributes.........................................57
2. Shopping API for Properties...............................................................................................................77
1.2 Summary................................................................................................................................77
2.2 API Details..............................................................................................................................77
3. Shopping API for Experiences............................................................................................................83
2.1 Summary......................................................................................................................................83
2.2 API Details....................................................................................................................................83
4. Shopping API for Car Hire..................................................................................................................88
3.1 Summary......................................................................................................................................88
3.2 API Details....................................................................................................................................88

Change control
Name Date Changes summary Version
Updated info:
 TravelOffersRQ:
o tripStartDate/tripEndDate (format for Avis)
o ptc required
 TravelOffersRS and TravelOfferDetailsRS:

Maria
29th June 2021 o description of offers.bundleBreakdown and v1.6
Psaraki
offers.bundleBreakdown.priceDetail
o added dayRangeMax
o corrected path vendors.hotel.media (previous:
vendors.hotel.attibuteList.media)
o added mapping of Viator's minDuration, maxDuration and
duration.freeText fields
Maria 17th August Updated info:

v1.7
Psaraki 2021  Uniform PTC codes
Efsevia 15th November Updated info:
V2.8
Kotsifaki 2022  OrderReshopRQ/RS description added
Updated info:
 Expedia guest reviews
 Expedia non-refundable date range
 Expedia salesTax
Maria 8th February  Viator: google locations mapping
Psaraki 2023  Viator: move startTime in AddToCart
 Viator: Experience mapping for locationPoints (locations/bulk) v2.9
 Viator markup
 Update party (authenticatedSenders)
 Viator: update values in pickupLocations.type
Updated Info:
Efsevia 17th February
 Avis tax details
Kotsifaki 2023
 Avis new attribute type “size”
Introduction - Purpose of this Document

This document provides a first high-level overview of the Aerostream Ancillaries Shopping APIs.
For each of the ancillary types (Properties, Experiences & Car Hire), we list all the information that will
be available as part of the shopping response.

In this first version we also map the source vendor API that will provide such information.

1. Shopping API
1.1 Summary
The following methods define the generic Shopping API and are independent of the type of the ancillary:
o getTravelOffers
 returns a list of offers with the available products that match the search criteria
o getTravelOfferDetails
 returns the details of a specific/selected offer
The following three Sections describe the information that will be available as part of the shopping
response for each ancillary type (Property, Experience, Car hire).

TravelOffersRQ
TravelOffersRQ Required Description
sender.authenticatedSenderId * An agreed senderId that must be present in all the requests.
Specifies the airline that this customer is a loyalty member of; 2-
sender.messageSender.iataNumber *
character IATA airline code, e.g. “BA”
The country code of the traveler’s point of sale. This should
sender.messageSender.pos.posCountry * (Expedia and Avis only) represent the country where the shopping transaction is taking
place.
The membership id of the LAH user. The array will contain one
single item when the Customer is the direct message participant or
sender.msgParticipants.agentId * two items when the Customer Service Agent is the direct message
participant. In the latter case, both the Agent and the Customer’s
info should be provided.
Values:
sender.msgParticipants.senderType *  LAH : Loyalty Account Holder
 CSR : Customer Service Agents and Representatives
* (Expedia and Viator
responseParameters.currencyCode Requested currency for the rates. E.g. “EUR”
(availabilityCheck) only)
Desired language for the response. E.g. “en-US”
responseParameters.languageCode *
Applicable to Expedia and Viator.
preferences.servicePreference * Provider; only one item is expected.
Type of the provider:
preferences.servicePreference.  Properties: “0BO”
*
serviceSubcode  Experiences: “0BP”
 Car Hire: “0BN”
preferences.servicePreference. The Provider Id as returned by the Pre-Shopping API
*
serviceProviderId (“vendorBrandId” field)
trip.tripStartDate.formattedDateTime * Start date of the trip, that is:
o Check-in date for properties,
with format YYYY-MM-DD. E.g. 2021-09-08
o Date to check for available experiences,


o Pickup date and time for car hire, with format YYYY-MMM-
DDTHH:MM:SS E.g. 2021-09-08T10:00:00
trip.tripEndDate.formattedDateTime * (Expedia and Avis only) End date of the trip, that is:
o Check-out date for properties,
o Drop off date and time for car hire, with format YYYY-
MMM-DDTHH:MM:SS E.g. 2021-09-08T10:00:00
The destination Id of the trip as returned by the Pre-ShoppingRS
trip.startLocation.externalId.locationId *
(locationId field)
Type of the externalId.locationId, as returned by the Pre-
trip.startLocation.externalId.type * (Expedia and Viator only)
ShoppingRS
trip.endLocation.externalId.locationId * (Avis only) The drop off locationId as returned by the Pre-ShoppingRS
Array of objects to define the travelers. In the case of Avis, only one
trip.travelers * (Expedia and Avis only)
traveler is expected, that is the driver.
An identifier for a particular traveler. Must be unique inside a
trip.travelers.personId *
request message.
The PTC of the traveler.
 for Expedia: {ADT, CHD}
trip.travelers.ptc * (Expedia and Avis only)
 for Avis: {ADT}
The array will always contain one single item for ancillaries.
trip.travelers.age The age of the traveler. This is mandatory for Expedia in case of
PTC=CHD.
trip.travelers.dateOfBirth.
The date of birth of the driver - used in Avis. E.g. "1990-09-10"
formattedDateTime
trip.shopperGroups * (Expedia only) Used to group travelers to define occupancy. For example, travelers
within the same shopperGroup signify that they will stay in the
same room. Array of items.
trip.shopperGroups.shopperRef * Should contain reference(s) to travelers.personId(s). Array of items.
TravelOfferDetailsRQ
TravelOfferDetailsRQ Required Description

payloadAttributes.correlationId * The correlationId as returned by the getTravelOffersRS.

sender.authenticatedSenderId * An agreed senderId that must be present in all the requests.
The country code of the traveler’s point of sale. This should
sender.messageSender.pos.posCountry * (Avis only) represent the country where the shopping transaction is taking
place.
The membership id of the LAH user. The array will contain one
single item when the Customer is the direct message participant or
sender.msgParticipants.agentId * two items when the Customer Service Agent is the direct message
participant. In the latter case, both the Agent and the Customer’s
info should be provided.
Values:
sender.msgParticipants.senderType *  LAH : Loyalty Account Holder
 CSR : Customer Service Agents and Representatives
The unique recommendationId as returned by the
recommendation.recommendationId *
getTravelOffersRS.
The selected offer id as returned by the getTravelOffersRS
recommendation.bundleRef *
(“bundleId” field). Only one item is expected.
preferences.servicePreference * Provider; only one item is expected.
Type of the provider:
preferences.servicePreference.  Properties: “0BO”
*
serviceSubcode  Experiences: “0BP”
 Car Hire: “0BN”
preferences.servicePreference. The Provider Id as returned by the Pre-Shopping API
*
serviceProviderId (“vendorBrandId” field)
Desired language for the response. E.g. “en-US”
responseParameters.languageCode *
Applicable to Expedia and Viator.
Start date of the trip, that is:
o Check-in date for properties,
trip.tripStartDate.formattedDateTime
o Date to check for available experiences,
Applicable only to Viator and to Expedia re-search.
trip.tripEndDate.formattedDateTime End date of the trip, that is:
o Check-out date for properties,


Applicable only to Expedia re-search
Array of objects to define the travelers.
trip.travelers
Applicable only to Viator and to Expedia re-search
An identifier for a particular traveler. Must be unique inside a
trip.travelers.personId
request message.
The PTC of the traveler as returned by a previous
getTravelOfferDetailsRS.
trip.travelers.ptc
 Values: {ADT, CHD, INF, SRC, YTH, TRA}
The array will always contain one single item for ancillaries.
trip.shopperGroups Used to group travelers to define occupancy. For example, travelers
within the same shopperGroup signify that they will stay in the
same room. Array of items.
Applicable only to Expedia re-search.
trip.shopperGroups.shopperRef Should contain reference(s) to travelers.personId(s). Array of items.
TravelOffersRS and TravelOfferDetailsRS

The table covers the getTravelOffersRS and the getTravelOfferDetailsRS for properties, car hire and experiences.
TravelOffersRS Required Description

Unique Id that will be used in the subsequent
recommendationId *
request to identify this Shopping Response
payloadAttributes.correlationId * End-to-end correlation of application logs
payloadAttributes.messageDatetime.formattedDateTime * Timestamp of the response message
sender.authenticatedSenderId * The senderId of the request
The trip information as provided in the request.
Includes the
trip *  trip.startLocation.name
 trip.endLocation.name
when applicable
offers * Array of offers
offers.bundleId * Unique Offer Id in a Shopping Response
offers.vendorRef * A reference to the vendors.vendorId field within

the same message

Specifies the eligible PTCs for this product and
the details of it (e.g. a product defines its own
age ranges per PTC).
offers.offeredPTCs
Array of items.
Used only for experiences in the
PTC code
offers.offeredPTCs.code
Values: {ADT, CHD, INF, SRC, YTH, TRA}
Lower limit (inclusive) of the age range defined
offers.offeredPTCs.startAge
by this PTC
Upper limit (inclusive) of the age range defined
offers.offeredPTCs.endAge
by this PTC
Minimum number of travelers in this PTC
offers.offeredPTCs.minCount
required to book the product
Maximum Number of travelers in this PTC
offers.offeredPTCs.maxCount
allowed to book the product
The property’s rank across all properties as
offers.bundleSequence returned by Expedia.
Used only for properties.
The property’s score as returned by Expedia (the
offers.bundleScore higher the value the better).
For properties:
Array of items that holds the alternative room
rates (one item per room).
Only one item will be returned in the
getTravelOffersRS for each offer (that is the
offers.bundleBreakdown * cheapest rate).
Multiple items will be returned in the
getTravelOfferDetailsRS for each offer.
For experiences and cars:

Only one item will be returned.

The price applicability details. Array of items.
For properties, each item represents a different

rate option.
offers.bundleBreakdown.priceDetail *
For experiences, each item represents a
different product option.
For cars, only one item will be returned.

Unique Price Applicability Id within the same
offers.bundleBreakdown.priceDetail. priceApplicabilityId *
message
The status of the rate as returned by Expedia.
offers.bundleBreakdown.priceDetail. availabilityStatus Enum values: {available}
The number of bookable rooms remaining with
this rate as returned by Expedia. Expedia’s note:
“If the value returns as 2147483647 (max int
offers.bundleBreakdown.priceDetail. availability value), the actual value could not be
determined. Ensure your urgency messaging
ignores such instances when returned.”
Reference to serviceList.serviceId within this
offer.
offers.bundleBreakdown.priceDetail. serviceRef *
The array will always contain one single item for
ancillaries.
Price information for this price applicability. If
there are several groups, this is the total price of
offers.bundleBreakdown.priceDetail. packageTotalPrice *
them. Array of items. Each price represents an
alternative price option.
offers.bundleBreakdown.priceDetail. packageTotalPrice.priceId * Unique Price Id within an offer
offers.bundleBreakdown.priceDetail. packageTotalPrice. Total amount.
*
totalAmount.amount.intValue Sum of netAmount + taxes + markup + fees.
offers.bundleBreakdown.priceDetail. packageTotalPrice. * Decimal points, e.g. 120.35:
totalAmount.amount.scale amount = 12035

scale = 2
offers.bundleBreakdown.priceDetail. packageTotalPrice.totalAmount.
* Currency code
currencyCode
offers.bundleBreakdown.priceDetail. packageTotalPrice.
Base amount
baseAmount.amount.intValue
Decimal points, e.g. 120.35:
amount = 12035
baseAmount.amount.scale
scale = 2
offers.bundleBreakdown.priceDetail. packageTotalPrice.baseAmount.
Currency code
currencyCode
Total tax amount
totalTaxAmount.amount.intValue
amount = 12035
totalTaxAmount.amount.scale
scale = 2
Currency code
totalTaxAmount.amount.currencyCode
offers.bundleBreakdown.priceDetail. packageTotalPrice. Net amount. Cost of goods, without markup.
netAmount.amount.intValue Used only for experiences.
amount = 12035
netAmount.amount.scale
scale = 2
offers.bundleBreakdown.priceDetail. packageTotalPrice.netAmount.
Currency code
currencyCode
Markup amount. Calculation:
netAmount*markupPercent
markup.amount.intValue
Used only for experiences.
amount = 12035
markup.amount.scale
scale = 2
offers.bundleBreakdown.priceDetail. packageTotalPrice.markup.
Currency code
currencyCode
Array of items. Tax breakdown. Used only for
offers.bundleBreakdown.priceDetail. packageTotalPrice.taxDetails
avis.

offers.bundleBreakdown.priceDetail. packageTotalPrice.taxDetails.taxName Name of the tax. E.g. "Local Tax”

offers.bundleBreakdown.priceDetail.
Tax amount
packageTotalPrice.taxDetails.taxAmount.amount.intValue
offers.bundleBreakdown.priceDetail. packageTotalPrice.taxDetails.
amount = 12035
taxAmount.amount.scale
scale = 2
offers.bundleBreakdown.priceDetail. packageTotalPrice.taxDetails.
Currency code
taxAmount.currencyCode
offers.bundleBreakdown.priceDetail. packageTotalPrice. surcharges Any additional surcharges (array)
offers.bundleBreakdown.priceDetail. packageTotalPrice.surcharges. feeCode Fee designator
offers.bundleBreakdown.priceDetail. packageTotalPrice. surcharges.
Fee amount
amount.amount.intValue
offers.bundleBreakdown.priceDetail. packageTotalPrice.surcharges.
amount = 12035
amount.amount.scale
scale = 2
offers.bundleBreakdown.priceDetail. packageTotalPrice.surcharges.
Currency code
amount.currencyCode
offers.bundleBreakdown.priceDetail. packageTotalPrice. Loyalty points; to be used only in the case of a
loyaltyAmount.amount.intValue combined price e.g. EUR + Miles
Decimal points, e.g. 12035:
amount = 12035
loyaltyAmount.amount.scale
scale = 0
offers.bundleBreakdown.priceDetail. packageTotalPrice. loyaltyAmount. For Amounts expressed in Miles 999 will be used
currencyCode as currency code
offers.bundleBreakdown.priceDetail. packageTotalPrice. Loyalty points that will be collected/earned;
earnedPoints.amount.intValue usually when the payment option is full cash
amount = 12035
earnedPoints.amount.scale
scale = 0
offers.bundleBreakdown.priceDetail. packageTotalPrice.earnedPoints. For Amounts expressed in Miles 999 will be used
currencyCode as currency code
offers.bundleBreakdown.priceDetail. passengerPrice * Individual price for a person or a group of
*(Expedia persons. Array of items. The assumption is that
and Avis) all the persons within the group have the same

price. The Price is the total price for the group.
For properties, each group represents the

persons (personRefs) staying in the same room.
Used only for properties and car hire.

For experiences, each group represents persons
(personRefs) of the same type.
Returned only in the getTravelOfferDetailsRS.

offers.bundleBreakdown.priceDetail. passengerPrice.groupPriceId * Unique Group Price Id within an offer
References to travelers.personId. Array of items.
Persons within the same GroupPrice should be
of the same type.
offers.bundleBreakdown.priceDetail. passengerPrice.personRefs * Used in both getTravelOffersRS and
getTravelOfferDetailsRS for properties and cars.
Used only in the getTravelOfferDetailsRS for
experiences.
Price breakdown per unit. Array of items.
Used only for properties and experiences.
*
offers.bundleBreakdown.priceDetail. passengerPrice.unitPrices (Expedia For experiences it will be returned only if the
only) unit is “PER_PERSON”, otherwise the price
represents a group price and no unit price info is
returned.
offers.bundleBreakdown.priceDetail. passengerPrice.unitPrices.unitId * Unique Unit Id within a group price
offers.bundleBreakdown.priceDetail. passengerPrice.unitPrices.unit * Unit designator, e.g. “ priceId”
offers.bundleBreakdown.priceDetail. passengerPrice.unitPrices.unitPrice * Price information for each unit
Total amount
offers.bundleBreakdown.priceDetail. passengerPrice.unitPrices.unitPrice.
totalAmount.amount.intValue
experiencesproperties
offers.bundleBreakdown.priceDetail. passengerPrice.unitPrices.unitPrice. Decimal points, e.g. 120.35:
totalAmount.amount.scale amount = 12035
scale = 2


propertiesexperiences
Currency code
totalAmount.currencyCode
propertiesexperiences
* Base amount
* amount = 12035
scale = 2
* Currency code
baseAmount.currencyCode
* Total tax amount
* amount = 12035
scale = 2
* Currency code
totalTaxAmount.currencyCode
offers.bundleBreakdown.priceDetail. passengerPrice.unitPrices.unitPrice. Array of items. Tax breakdown. Used only for
taxDetails properties.
offers.bundleBreakdown.priceDetail. Name of the tax. E.g. "Tax and Service Fee",
passengerPrice.unitPrices.unitPrice.taxDetails. taxName "Sales Tax"
offers.bundleBreakdown.priceDetail. Code of the tax. E.g. "tax_and_service_fee",
passengerPrice.unitPrices.unitPrice.taxDetails. taxCode "sales_tax"
Tax amount
passengerPrice.unitPrices.unitPrice.taxDetails. taxAmount.amount.intValue
amount = 12035
passengerPrice.unitPrices.unitPrice.taxDetails. taxAmount.amount.scale
scale = 2
passengerPrice.unitPrices.unitPrice.taxDetails. Currency code
taxAmount.amount.currencyCode
offers.bundleBreakdown.priceDetail. passengerPrice.price * Price information for the group. The array will

always contain one single item for ancillaries.

offers.bundleBreakdown.priceDetail. passengerPrice.price.priceId * Unique Price Id within an offer
offers.bundleBreakdown.priceDetail. passengerPrice.price.
* Total amount
* amount = 12035
totalAmount.amount.scale
scale = 2
offers.bundleBreakdown.priceDetail. passengerPrice.price.totalAmount.
* Currency code
currencyCode
Base amount
amount = 12035
scale = 2
offers.bundleBreakdown.priceDetail. passengerPrice.price.baseAmount.
Currency code
currencyCode
Total tax amount
amount = 12035
scale = 2
Currency code
offers.bundleBreakdown.priceDetail. passengerPrice.price.surcharges Any additional surcharges (array)
offers.bundleBreakdown.priceDetail. passengerPrice.price.surcharges.
Fee designator
feeCode
Fee amount
amount = 12035
amount.amount.scale
scale = 2
Currency code
amount.currencyCode
offers.bundleBreakdown.priceDetail. passengerPrice.price.remarks.title Description of the price, e.g. “Pay Later”.

Used only for cars.

offers.bundleBreakdown.priceDetail. packageAttributes * Package information, e.g. hotel room package
offers.bundleBreakdown.priceDetail. packageAttributes.packageId * Unique Package Id within a price applicability
Name of the product option.
offers.bundleBreakdown.priceDetail. packageAttributes.name
Vehicle rate code (for cars).
* (Avis Identification code for the product option (for
offers.bundleBreakdown.priceDetail. packageAttributes.code
only) experiences).
Used only for cars and experiences.
Description of the product option. The array will
offers.bundleBreakdown.priceDetail. packageAttributes.remarks.title always contain one single item for ancillaries.
*
(Expedia
Contain the cancellation policies. Array of items.
offers.bundleBreakdown.priceDetail. packageAttributes.packageRules and
Used only for properties and experiences.
Viator
only)
offers.bundleBreakdown.priceDetail. packageAttributes.packageRules. Unique Package Rule Id within a price
*
packageRuleId applicability
When ruleTypeInd is true, and packageType is
cancel, then cancellation is possible.
offers.bundleBreakdown.priceDetail. packageAttributes.packageRules.
* When ruleTypeInd is false, and packageType is
ruleTypeInd
cancel or conditionalCancel, then cancellation is
not possible, meaning no refund will be given.
offers.bundleBreakdown.priceDetail. packageAttributes.packageRules. * Type of this package rule. E.g. for cancellation
packageType rule, it will be “cancel”, for the Expedia non-
refundable-date-ranges, it will be
“conditionalCancel”. Specifically:
 “cancel” : the cancellation policies of
this package rule will be applied, if
booking is cancelled within the date
range of this rule
 “conditionalCancel” : days or
dateRanges within this package rule are

non-refundable at any time (overwrites

the “cancel” rules)
offers.bundleBreakdown.priceDetail. packageAttributes.packageRules. Effective date and time of cancellation penalty,
startDateTime.formattedDateTime e.g. “2021-04-01T15:00:00.000+02:00”
offers.bundleBreakdown.priceDetail. packageAttributes.packageRules. End date and time of cancellation penalty, e.g.
endDateTime.formattedDateTime “2021-04-01T15:00:00.000+02:00”
Number of nights charged for as penalty
chargeableUnit
Fee amount
feeAmount.amount.intValue
amount = 12035
feeAmount.amount.scale
scale = 2
Currency of the amount object
feeAmount.currencyCode
Description of the package rule.
offers.bundleBreakdown.priceDetail. packageAttributes.packageRules.remark
offers.bundleBreakdown.priceDetail. packageAttributes.packageRules. Description of this product's cancellation policy.
ruleFulltextRef Used only for cars and experiences.
Number of days prior to the product start time
offers.bundleBreakdown.priceDetail. packageAttributes.packageRules. * (Viator that this policy window ends.
dayRangeMin only) Used only for experiences in the
Number of days prior to the tour start time that
this policy window begins. When this field is
offers.bundleBreakdown.priceDetail. packageAttributes.packageRules. absent, it signifies negative infintity; i.e., the
dayRangeMax beginning of time.
Percentage of total price charged for as penalty
offers.bundleBreakdown.priceDetail. packageAttributes.packageRules. * (Viator (if cancelled within the specified time window).
percent only) Used only for experiences in the
offers.bundleBreakdown.priceDetail. packageAttributes.mediaList Array of the available language guides for this

product option.
Type of language guide; one of:
 “GUIDE” – human tour guide
* (Viator  “AUDIO” – audio guide
offers.bundleBreakdown.priceDetail. packageAttributes.mediaList.title
only)  “WRITTEN” – printed guide
Array of language codes for this guide.
offers.bundleBreakdown.priceDetail. packageAttributes.mediaList.
mediaList.type
General structure that holds package's
attributes.
offers.bundleBreakdown.priceDetail. packageAttributes.attributes
The array will always contain one single item for
ancillaries.
List of attribute pairs (key-value)
offers.bundleBreakdown.priceDetail. packageAttributes.attributes. Used for experiences in the
attributePairs getTravelOfferDetailsRS, and for car hire (both
methods).
Attribute keys for experiences
 "cancelIfBadWeather",
"cancelIfInsufficientTravelers",
"ticketInfo" (required)
 "pickupIncluded"
offers.bundleBreakdown.priceDetail. packageAttributes.attributes. Attribute keys for car hire
attributePairs.attribute  "unlimited_distance", "distance_unit"
and “under_age_fee_applied” (required)
 "distance_covered", "distance_overage"
Used for experiences in the
getTravelOfferDetailsRS, and for car hire (both
methods).
offers.bundleBreakdown.priceDetail. packageAttributes.attributes. Attribute value for experiences
attributePairs.value  for “cancelIfBadWeather",

"cancelIfInsufficientTravelers" and
"pickupIncluded":
“true”, “false”
 for " ticketInfo":
the respective description
Attribute value for car hire
 for "unlimited_distance" and
“under_age_fee_applied”: “true”,
“false”
 for "distance_unit", "distance_covered",
"distance_overage": the respective
value as a string
Used for experiences in the
getTravelOfferDetailsRS, and for car hire (both
methods).
The getTravelOffersRS returns an array of pricing
records for this season. Each item contains the
days of the week and start time entries for a
priceAvailabilityList product option of a particular price.
The getTravelOfferDetailsRS returns one pricing
record according to the requested criteria.
Days of the week on which this pricing and
availability information applies. 1: Sunday, 2:
priceAvailabilityList.daysOfWeek
Monday, etc.
Array of items. Used only for experiences.
Array of starting times for this product option
priceAvailabilityList.startTimeList code if timed entry is applicable.
The starting time, e.g. “14:00”.
priceAvailabilityList.startTimeList. formattedDateTime
offers.bundleBreakdown.priceDetail. packageAttributes.beds Bed group information of the room. Array of
items.
Used only for properties in the

offers.bundleBreakdown.priceDetail. packageAttributes.beds.bedGroupId Expedia’s Bed Group Id
offers.bundleBreakdown.priceDetail. packageAttributes.beds.title Description of the bed group
The bed configuration for a given room. Array of
offers.bundleBreakdown.priceDetail. packageAttributes.beds.configuration
items.
offers.bundleBreakdown.priceDetail. packageAttributes.beds.configuration.
The type of bed, e.g. “FullBed”
type
The size of the bed, e.g. “Full”
size
The number of bed(s), e.g. 2
quantity
offers.bundleBreakdown.priceDetail. packageAttributes.attributes General structure that holds product's attributes
Attribute type, for properties: “amenity” (rate
offers.bundleBreakdown.priceDetail. packageAttributes.attributes.type
level)
offers.bundleBreakdown.priceDetail. packageAttributes.attributes.attribute List of attributes
List of services for a particular offer.
For properties, each service contains the room
offers.serviceList *
details.
For experiences and cars, one item is expected.
offers.serviceList.serviceId * Unique Service Id within the same message
* (Viator Description of this product. Used only for
offers.serviceList.description.title
only) experiences.
* (Experia The details of a room service. Used only for
offers.serviceList.room
only) properties.
offers.serviceList.room.name * The name of the room
offers.serviceList.room.roomId * Expedia’s room Id
Room amenities (room level).
offers.serviceList.room.amenityList
offers.serviceList.room.amenityList.id Amenity id
offers.serviceList.room.amenityList.name Amenity name
offers.serviceList.room.amenityList.category Amenity category
Room attributes.
offers.serviceList.room.attributeList

offers.serviceList.room.attributeList.type Attribute type. Values: {“view”}

offers.serviceList.room.attributeList.attribute Arrray of attribute values.
Dimension details of the room. Array of items.
offers.serviceList.room.dimensionList
Returned only in the getTravelOfferDetailsRS
Type of dimension, values {"square_meters",
offers.serviceList.room.dimensionList. dimCategory "square_feet"}
Dimension value, e.g. 85
offers.serviceList.room.dimensionList. dimValue
Unit of measurement. E.g. “m2”, “ft2”
offers.serviceList.room.dimensionList. UOM
Total maximum occupancy allowed for the
offers.serviceList.room.maxOccupants room.
* (Avis The details of a vehicle service. Used only for
offers.serviceList.vehicle
only) cars
offers.serviceList.vehicle.name Name of the vehicle
offers.serviceList.vehicle.make Make of the vehicle
offers.serviceList.vehicle.model Model of the vehicle
The vehicle class code used to identify individual
offers.serviceList.vehicle.vehicleClassCode cars and trucks according to size, axle numbers
and type
offers.serviceList.vehicle.vehicleClassName The name of the vehicle class
offers.serviceList.vehicle.vehicleTransmission The transmission of the vehicle
offers.serviceList.vehicle.mpg Vehicle’s miles per gallon
Vehicle’s Standard Interline Passenger
offers.serviceList.vehicle.sippCode
Procedure (SIPP) code
offers.serviceList.vehicle.fuel Vehicle’s fuel, e.g. “Petrol”, “Diesel”
offers.serviceList.vehicle.attributeList Array of attributes
Attribute type, for vehicles: {“features”,
offers.serviceList.vehicle.attributeList. type
“capacity”, “size”}
offers.serviceList.vehicle.attributeList. attribute List of attributes
 for type “features”:

"Smoke Free", "Air Conditioned",

"Bluetooth Equipped",
"Internet/Network Access"
 for type “capacity” e.g. :
"4 Doors", "7/8 Seats", "2 Large
Suitcase(s)", "4 Small Suitcase(s)"
 for type “size”:
“Small”, “Mid Size”, “Large”,”People
Carriers”
* (Viator The details of an experience service. Used only
offers.serviceList.experience
only) for experiences.
Unique identifier for this product as returned by
offers.serviceList.experience.productId *
Viator.
offers.serviceList.experience.name Name of this product
offers.serviceList.experience.ratings Guest reviews for this product
offers.serviceList.experience.ratings.source It will be “guest” for experiences
offers.serviceList.experience.ratings.count Total count of reviews, e.g. 150
offers.serviceList.experience.ratings.overall Overall rating value for this product, e.g. “4.6”
General structure that holds product's
offers.serviceList.experience.attributeList *
attributes. Array of items.
Both in getTravelOffersRS and
getTravelOfferDetailsRS:
Attribute type, for experiences:

{“additionalInfo”, “itinerary”,
“bookingRequirements”}.
offers.serviceList.experience.attributeList.type *
Required types: “additionalInfo” and
“bookingRequirements”.
Only in getTravelOfferDetailsRS:
Attribute type, for experiences: {“inclusions”,
“exclusions”}
offers.serviceList.experience.attributeList. attribute * List of attributes
 for type “additionalInfo”:

List of additional info descriptions

 for type “inclusions”:
List of inclusions
 for type “exclusions”:
List of exclusions
 for type “itinerary”: contains attribute
pairs for attributes “skipTheLine” and
“privateTour” with values “true”, “false”
 for type “bookingRequirements”:
offers.serviceList.experience.attributeList. attributePairs *
contains attribute pairs for attributes
"minTravelersPerBooking",
"maxTravelersPerBooking",
"requiresAdultForBooking" with their
respective values
Attribute key
 for type “itinerary”: “skipTheLine” and
“privateTour”
(both attributes are required)
offers.serviceList.experience.attributeList. attributePairs.attribute *  for type “bookingRequirements:
"minTravelersPerBooking",
"maxTravelersPerBooking",
"requiresAdultForBooking"
(all attributes are required)
Attribute value
 for “skipTheLine”, “privateTour” and
"requiresAdultForBooking": “true”,
offers.serviceList.experience.attributeList. attributePairs.value * “false”
 for "minTravelersPerBooking" and
"maxTravelersPerBooking":
the respective value as a string
List of tag descriptions.
offers.serviceList.experience.tagList * Used only for experiences in the

offers.serviceList.experience.tagList.id * Tag id
offers.serviceList.experience.tagList.name * Tag name
offers.serviceList.experience.tagList.category Tag category
Language guides available for this product across
all product option codes. Array of items.
offers.serviceList.experience. languageGuides
Type of language guide; one of:
 “GUIDE” – human tour guide
 “AUDIO” – audio guide
offers.serviceList.experience. languageGuides.title *
 “WRITTEN” – printed guide
Array of language codes for this guide.
offers.serviceList.experience. languageGuides.mediaList * Used only for experiences in the
Language code for this guide.
offers.serviceList.experience. languageGuides.mediaList.type * Used only for experiences in the
Array of booking questions that need to be
answered at the creation of an order for this
offers.serviceList.experience.bookingQuestions experience product.
Id of the booking question as returned by Viator,
offers.serviceList.experience.bookingQuestions.id e.g. "DATE_OF_BIRTH"
"HEIGHT"
Required unit type for the answer to the
booking question as returned by Viator. Values:
 "STRING"
offers.serviceList.experience.bookingQuestions.type  "NUMBER_AND_UNIT"
 "DATE"
 "TIME"
 "LOCATION_REF_OR_FREE_TEXT"

Specifies whether the booking question must be

answered individually for each traveler or once
per group of travelers in each booking, as
offers.serviceList.experience.bookingQuestions.group
returned by Viator; one of:
 "PER_TRAVELER"
 "PER_BOOKING"
offers.serviceList.experience.bookingQuestions.title Title of this booking question
Hint (tooltip) for this booking question. E.g. "E.g.
offers.serviceList.experience.bookingQuestions.hint
14 July 2024, 25 May 2026"
Specifies whether an answer must be provided
to this question if it is included in the product's
description, as returned by Viator.
Values:
 “MANDATORY” - it is always mandatory
to provide an answer to this question
offers.serviceList.experience.bookingQuestions. answerIsRequired
 “OPTIONAL” - it is optional to provide an
answer to this question
 “CONDITIONAL” - it is only mandatory to
answer this question if it is made so by
the presence of a related booking
question.
Maximum allowable input length for the answer,
offers.serviceList.experience.bookingQuestions.maxLength
measured in characters (UTF-8)
Units that may be used when answering this
offers.serviceList.experience.bookingQuestions.units
booking question
List of allowed answers for this booking question
offers.serviceList.experience.bookingQuestions. allowedAnswers if the answer represents a selection from a set of
specific answers
Number of days of an activity with
offers.serviceList.experience. experienceDetails.days MULTI_DAY_TOUR type. Used only for
experiences in the getTravelOfferDetailsRS.
offers.serviceList.experience. experienceDetails.experienceDayList Each item in the list describes a particular day,
used only in
 STANDARD

 UNSTRUCTURED (with one DayItem) and

 MULTI_DAY_TOUR (with multiple
DayItems) products
Title of this day of the tour.
Used only in MULTI_DAY_TOUR (with multiple
offers.serviceList.experience. experienceDetails.experienceDayList.name DayItems) products.
Number of this day.
Used only in MULTI_DAY_TOUR (with multiple
offers.serviceList.experience.
* DayItems) products.
experienceDetails.experienceDayList.dayNumber
Details about the places that this product visits
or passes through on this day; used only in
 STANDARD
offers.serviceList.experience.  MULTI_DAY_TOUR and
experienceDetails.experienceDayList.itineraryItems  UNSTRUCTURED products
Array of items.
Description of this product's itinerary.
experienceDetails.experienceDayList.itineraryItems.description
Duration information for this day item.
experienceDetails.experienceDayList.itineraryItems.duration
Duration of this day item in the case that it takes
offers.serviceList.experience. experienceDetails.experienceDayList. a fixed amount of time.
itineraryItems.duration.duration Used only for experiences in the
offers.serviceList.experience. experienceDetails.experienceDayList. Unit of measurement. E.g. “min”


itineraryItems.duration.uom
Details about this Point Of Interest.
* Used only for experiences in the
experienceDetails.experienceDayList.itineraryItems.location
Address details.
offers.serviceList.experience. experienceDetails.experienceDayList.
itineraryItems.location.address
State or province.
itineraryItems.location.address.stateOrProvince
offers.serviceList.experience. experienceDetails.experienceDayList. Street address. One item is expected for
itineraryItems.location.address.streetAddress experiences.
City name or administrative area
itineraryItems.location.address.cityName
Zip or postal code
itineraryItems.location.address.zipCode
Country name
itineraryItems.location.address.countryName
Country code
itineraryItems.location.address.countryCode
* Name of this location.
itineraryItems.location.location.name
* Reference id of this location.
itineraryItems.location.externalId.locationId
Geographic coordinates (lattitude/longitude) for
offers.serviceList.experience. experienceDetails.experienceDayList. this location.
itineraryItems.location.geoLocation Used only for experiences in the
Latitude of this location.
offers.serviceList.experience .experienceDetails.experienceDayList.
itineraryItems.location.geoLocation.latitude.intValue
Decimal points.
itineraryItems.location.geoLocation.latitude.scale

Longitude of this location.

itineraryItems.location.geoLocation.longitude.intValue
Decimal points.
itineraryItems.location.geoLocation.longitude.scale
General structure that holds attributes of this
itinerary item. The array will always contain one
single item.
itineraryItems.attributeList
itineraryItems.attributeList.attributePairs
Attribute keys
 "passByWithoutStopping",
offers.serviceList.experience. experienceDetails.experienceDayList. "admissionIncluded"
itineraryItems.attributeList.attributePairs.attribute (passByWithoutStopping is required)
Value:
 for "passByWithoutStopping": “true”,
“false”
 for "admissionIncluded": “YES”, “NO”,
itineraryItems.attributeList.attributePairs.value
“NOT_APPLICABLE”
Accommodation available for this day of this
tour. Array of items.
offers.serviceList.experience. experienceDetails.experienceDayList. Used only in MULTI_DAY_TOUR (with multiple
itineraryItems.accommodationList DayItems) products.
offers.serviceList.experience. experienceDetails.experienceDayList. Address details.

itineraryItems.accommodationList.address
State or province.
itineraryItems.accommodationList.address. stateOrProvince
offers.serviceList.experience. experienceDetails.experienceDayList. Street address. One item is expected for
itineraryItems.accommodationList. address.streetAddress experiences.
itineraryItems.accommodationList.address.cityName
Zip or postal code
itineraryItems.accommodationList.address.zipCode
Country name
itineraryItems.accommodationList. address.countryName
Country code.
itineraryItems.accommodationList. address. countryCode
* Name of this location.
itineraryItems.accommodationList. location.name
offers.serviceList.experience. experienceDetails.experienceDayList. Geographic coordinates (lattitude/longitude) for
itineraryItems.accommodationList. geoLocation this location.
offers.serviceList.experience .experienceDetails.experienceDayList.
* Latitude of this location.
itineraryItems.accommodationList. geoLocation.latitude.intValue
* Decimal points.
itineraryItems.accommodationList. geoLocation.latitude.scale
* Longitude of this location.
itineraryItems.accommodationList. geoLocation.longitude.intValue
* Decimal points.
itineraryItems.accommodationList. geoLocation.longitude.scale
* Description of this accommodation venue.
itineraryItems.accommodationList. description
Food and drinks available for this day of this
tour. Array of items.
offers.serviceList.experience. experienceDetails.experienceDayList. Used only in MULTI_DAY_TOUR (with multiple
itineraryItems.foodMenus DayItems) products.
offers.serviceList.experience. experienceDetails.experienceDayList. Dish type.

Values { "BREAKFAST", "LUNCH", "DINNER",

"SNACKS", "BOTTLED_WATER",
itineraryItems.foodMenus.dishType
"COFFEE_AND_TEA", "SODA_POP",
"ALCOHOLIC_BEVERAGES", "REFRESHMENTS"}
Name of the dish.
itineraryItems.foodMenus.dishName
Description of the dish.
itineraryItems.foodMenus. dishDescription
Details of the activity, used only in ACTIVITY
products.
offers.serviceList.experience. experienceDetails.activityItem *
offers.serviceList.experience. experienceDetails.activityItem. activityLocation * Location and description of this activity item.
offers.serviceList.experience. experienceDetails.activityItem.
Address details.
activityLocation.address
State or province.
activityLocation.address.stateOrProvince
offers.serviceList.experience. experienceDetails.activityItem. Street address. One item is expected for
activityLocation.address.streetAddress experiences.
activityLocation.address.cityName
Zip or postal code
activityLocation.address.zipCode
Country name
activityLocation.adsress.countryName
Country code.
activityLocation.address.countryCode
offers.serviceList.experience. experienceDetails.activityItem. activityLocation.
Name of this location.
location.name
offers.serviceList.experience. experienceDetails.activityItem. activityLocation. Geographic coordinates (lattitude/longitude) for
geoLocation this location.
offers.serviceList.experience .experienceDetails.activityItem.
activityLocation.geoLocation. latitude.intValue
offers.serviceList.experience. experienceDetails.activityItem. Decimal points.

activityLocation.geoLocation. latitude.scale
activityLocation.geoLocation. longitude.intValue
Decimal points.
activityLocation.geoLocation. longitude.scale
Description of this accommodation venue.
activityLocation.description
offers.serviceList.experience. experienceDetails.activityItem. foodMenus Food menus for this activity.
offers.serviceList.experience. experienceDetails.activityItem. Dish type.
*
foodMenus.dishType Values { "STARTER", "MAIN", "DESSERT"}
* Name of the dish.
foodMenus.dishName
Description of the dish.
foodMenus.dishDescription
Details of the activity, used only in
HOP_ON_HOP_OFF products. Each item of the
offers.serviceList.experience. experienceDetails.hopOnHopOffItems array describes a specific route.
offers.serviceList.experience. experienceDetails.hopOnHopOffItems.name Name of this route
offers.serviceList.experience. experienceDetails.hopOnHopOffItems.duration Duration information for this route.
offers.serviceList.experience. experienceDetails. Duration of this service in the case that it takes a
hopOnHopOffItems.duration.duration fixed amount of time
offers.serviceList.experience. experienceDetails. Lower limit of the duration of this service in the
hopOnHopOffItems.duration.minDuration case that this product's duration varies
offers.serviceList.experience. experienceDetails. Upper limit of the duration of this service in the
hopOnHopOffItems.duration.maxDuration case that this product's duration varies
Duration information for this service returned as
offers.serviceList.experience. experienceDetails.
a free text, used only in UNSTRUCTURED
hopOnHopOffItems.duration.freeText
products
offers.serviceList.experience. experienceDetails.
Unit of measurement. E.g. “min”
hopOnHopOffItems.duration.uom
Description of this product's operating schedule
experienceDetails.hopOnHopOffItems.operatingSchedule

Array of items. Stops on this route. The

offers.serviceList.experience. experienceDetails.hopOnHopOffItems.stopsList OfficeLocation object is defined in the individual
objects below (ref OfficeLocation)
Array of items. Locations of interest relevant to
offers.serviceList.experience. this route. The OfficeLocation object is defined
experienceDetails.hopOnHopOffItems.pointsOfInterestList in the individual objects below (ref
OfficeLocation)
Array of items. Locations of interest relevant to
this experience. Used only for types:
 “ACTIVITY”
offers.serviceList.experience. experienceDetails.pointsOfInterestList
 “UNSTRUCTURED”
The OfficeLocation object is defined in the
individual objects below (ref OfficeLocation)
Details about the delivery of the product.
offers.serviceList.deliveryInstructions Used only for experiences in the
Additional information and instructions. Array of
items.
offers.serviceList.deliveryInstructions. instructions.remarks
Specifies whether travelers can choose a custom
* (Viator pick-up or meeting location for this product.
offers.serviceList.deliveryInstructions. allowCustomTravelerPickup
only) Used only for experiences in the
offers.serviceList.deliveryInstructions. pickupOptionType Specifies the type of traveler pickup option.
 "PICKUP_EVERYONE" (the supplier will
pick up all customers from their
respective locations)
 "PICKUP_AND_MEET_AT_START_POINT"
(the supplier will pick up all customers
from their respective locations; or,
customers can make their own way to
the start point)
 "MEET_EVERYONE_AT_START_POINT"

(all customers must make their own way

to and meet at the start point)
How long prior to the product departure time
offers.serviceList.deliveryInstructions. minutesBeforeDepartureTimeFor will traveler-pickup occur (in minutes).
Pickup Used only for experiences in the
Array of pick-up and meeting points.
offers.serviceList.deliveryInstructions. pickupLocations Used only for experiences in the
Type of pick-up location; one of {"AIRPORT",
"HOTEL", "PORT", "LOCATION", "OTHER"}.
offers.serviceList.deliveryInstructions. pickupLocations.type
Populated with values
{"MEET_AT_DEPARTURE_POINT",
"CONTACT_SUPPLIER_LATER"} only when the
offers.serviceList.deliveryInstructions. pickupLocations.description
location is specified as such.
Address details.
offers.serviceList.deliveryInstructions. pickupLocations.address Used only for experiences in the
offers.serviceList.deliveryInstructions. pickupLocations.address.
State or province
stateOrProvince
Street address. One item is expected for
offers.serviceList.deliveryInstructions. pickupLocations.address.streetAddress
experiences.
offers.serviceList.deliveryInstructions. pickupLocations.address.cityName City name or administrative area
offers.serviceList.deliveryInstructions. pickupLocations.address.zipCode Zip or postal code
offers.serviceList.deliveryInstructions. pickupLocations.adsress.countryName Country name
offers.serviceList.deliveryInstructions. pickupLocations.address.countryCode Country code
offers.serviceList.deliveryInstructions. pickupLocations.location.name * Name of this location.

Reference id of this location.
offers.serviceList.deliveryInstructions.
pickupLocations.location.externalId.locationId
Geographic coordinates (lattitude/longitude) for
this location.
offers.serviceList.deliveryInstructions. pickupLocations.geoLocation
offers.serviceList.deliveryInstructions. pickupLocations.geoLocation.
latitude.intValue
Decimal points.
latitude.scale
longitude.intValue
Decimal points.
longitude.scale
Array of starting point locations and
descriptions. Same structure as pickupLocations.
offers.serviceList.deliveryInstructions.startLocations
Array of ending point locations and descriptions.
Same structure as pickupLocations.
offers.serviceList.deliveryInstructions.endLocations
offers.serviceList.experience. experienceDetails The details of an experience service.
offers.serviceList.experience. experienceDetails.type * The type of the experience service. There are 5
types:
i. STANDARD: a tour-based product
(focused on visiting and viewing) that
occurs at a single location or proceed

through a set of locations on a single day

ii. MULTI_DAY_TOUR: a tour or activity
that occur over multiple days, and
therefore include a breakdown of the
itinerary for each day of the tour, as well
as extra information about food and
accommodation
iii. ACTIVITY: an activity-based product
(focused on the activity rather than the
location) that occurs at a single location
or proceeds through a set of locations
on a single day
iv. HOP_ON_HOP_OFF: a tour that
operates continuously, such as a bus
tour, wherein passengers can use their
ticket to board and alight as they please
at any of the stops along the route
v. UNSTRUCTURED: a text-based
description for products that their
suppliers have not yet upgraded them to
structured data
offers.serviceList.experience. experienceDetails.description Description of this product's itinerary
offers.serviceList.experience. experienceDetails.duration Duration information for this service
Duration of this service in the case that it takes a
offers.serviceList.experience. experienceDetails.duration.duration
fixed amount of time
Lower limit of the duration of this service in the
offers.serviceList.experience. experienceDetails.duration.minDuration
case that this product's duration varies
Upper limit of the duration of this service in the
offers.serviceList.experience. experienceDetails.duration.maxDuration
case that this product's duration varies
Duration information for this service returned as
offers.serviceList.experience. experienceDetails.duration.freeText a free text, used only in UNSTRUCTURED
products
offers.serviceList.experience. experienceDetails.duration.uom Unit of measurement. E.g. “min”
offers.serviceList.media Array of room images (for properties).

Array of vehicle images (for cars). Avis&Budget

return only one image.
Array of product images (for experiences).
offers.serviceList.media.title Title of the image
Populated with value 1, if this is a “hero” image
(for properties) or a “cover” image (for
experiences); not returned otherwise.
offers.serviceList.media.
In getTravelOffersRS only the images with
mediaSequence
mediaSequence=1 are returned.
In getTravelOfferDetailsRS all the images are
returned.
Array of different dimensions of the same image
mediaList
Size of the image. Used only for properties and
offers.serviceList.media. experiences.
mediaList.type For properties, e.g. “350px”
For experiences: width x height, e.g. "60x40"
The request method used to access the link, e.g.
“GET”
mediaList.method
The URL for the link
mediaList.href
* Array of vendors.
vendors In getTravelOfferDetailsRS only one item is
expected.
The vendor’s id.
For properties, the unique Expedia’s property Id.
vendors.vendorId *
For cars, the unique Aerostream’s vendor brand
id.
The vendor’s name.
vendors.vendorName *
For properties, the property name.
*
Details of a hotel vendor, used only for
vendors.hotel (Expedia
properties
only)

vendors.hotel.ratings Array of ratings for the hotel

Source of rating, it can be either “property”
vendors.hotel.ratings.source
(stars) or “guest” (guest reviews)
When source is “property”, type will be
vendors.hotel.ratings.type
populated with value “Star”
vendors.hotel.ratings.overall Value of the overall rating
Rating breakdown information provided by
guests who stayed at this property. Array of
vendors.hotel.ratings.ratingBreakdown
items.
Rating category, e.g. “cleanliness”, “comfort”
vendors.hotel.ratings.ratingBreakdown. attribute
Rating value
vendors.hotel.ratings.ratingBreakdown. value
vendors.hotel.category Category of the property, e.g. “Hotel”
Whether or not a payment for this property can
vendors.hotel.propertyCollectInd
be taken by the property upon arrival
Whether or not a payment for this property can
vendors.hotel.sellerCollectInd
be taken by Expedia at the time of booking
vendors.hotel.chain Name of the chain that this property belongs to
Name of the brand that this property belongs to
vendors.hotel.brand
(each chain might have multiple brands)
vendors.hotel.propertyLocation. Coordinates of the property. The array will
geoLocation always contain one single item for ancillaries.
vendors.hotel.propertyLocation.
Latitude
geolocation.latitude
Longitude
geolocation.longitude
General structure that holds product's
vendors.hotel.attibuteList
attributes. Array of items.
vendors.hotel.attibuteList.type Attribute type.
o getTravelOffersRS for properties:
“general”, “pets” (property level)
o getTravelOfferDetailsRS for properties:

“general”, “pets”, “location”,

“attractions”, "onsitePayment",
"onsiteCurrency" (property level)
List of attributes.
Array of items for types: “general”, “pets”
vendors.hotel.attibuteList.attribute
Only one item will be returned for types:
“location”, “attractions”
vendors.hotel.amenityList Property amenities (property level)
vendors.hotel.amenityList.id Amenity id
vendors.hotel.amenityList.name Amenity name
vendors.hotel.amenityList.category Amenity category
vendors.hotel.amenityList.ranking Amenity ranking
vendors.hotel.media Array of property images
vendors.hotel.media.title Title of the image
Populated with value 1, if this is a “hero” image;
not returned otherwise.
vendors.hotel.media. In getTravelOffersRS only the images with
mediaSequence mediaSequence=1 are returned.
In getTravelOfferDetailsRS all the images are
returned.
vendors.hotel.media.
Array of different dimensions of the same image
mediaList
Size of the image. For properties, e.g. “350px”
mediaList.type
vendors.hotel.media. The request method used to access the link, e.g.
mediaList.method “GET”
The URL for the link
mediaList.href
Address information
vendors.hotel.address
Array of street addresses.
vendors.hotel.address.streetAddress Expedia returns up to two addresses.
vendors.hotel.address.cityName City


State or province
vendors.hotel.address.stateOrProvince
Postal/zip code
vendors.hotel.address.zipCode
Country code
vendors.hotel.address.countryCode
The property’s check-in information.
vendors.hotel.checkInDetails
The time at which a property begins to allow
vendors.hotel.checkInDetails. checkinStartTime check-ins, e.g. "3:00 PM"
The time at which a property stops allowing
vendors.hotel.checkInDetails. checkinEndTime check-ins.
The time by which a guest must check out.
vendors.hotel.checkInDetails. checkoutTime
The property’s check-in policy.
vendors.hotel.checkInDetails. instructions
Any special instructions for checking into this
vendors.hotel.checkInDetails. specialInstructions property that may be specific to this property.
The minimum age for a customer to be able to
vendors.hotel.checkInDetails. minCheckInAge check-in at a property.
The preferred airport of the property.
vendors.hotel.nearbyAirport
Languages spoken at the property. Array of
vendors.hotel.spokenLanguages items.
Information related to a property’s fees. Array of
vendors.hotel.feeList items.
vendors.hotel.feeList.type Type of fee, values: {“mandatory”, “optional”}


Description of the fee.
vendors.hotel.feeList.attribute The array will always contain one single item.
Information about property policies that guests
need to be aware of. The array will always
vendors.hotel.policies
contain one single item.
Type of policy, value: {“know_before_you_go”}
vendors.hotel.policies.type
Description of the policy.
vendors.hotel.policies.attribute The array will always contain one single item.
* (Avis
vendors.carHireOffice Used only for cars
only)
Rental car pickup location and address
vendors.carHireOffice.pickupLocation
information
vendors.carHireOffice.pickupLocation. address Address information
vendors.carHireOffice.pickupLocation. address.streetAddress Array of street addresses
vendors.carHireOffice.pickupLocation. address.cityName City
vendors.carHireOffice.pickupLocation. address.stateOrProvince State or province
vendors.carHireOffice.pickupLocation. address.zipCode Postal/zip code
vendors.carHireOffice.pickupLocation. address.countryCode Country code
vendors.carHireOffice.pickupLocation. location.code Avis/Budget unique location code
vendors.carHireOffice.pickupLocation. location.name Name of the car hire office location
vendors.carHireOffice.pickupLocation. phone.phoneNumber Phone number of the car hire office
vendors.carHireOffice.pickupLocation. workingHours Operating hours of the car hire office
If this is an airport location, the type will be
vendors.carHireOffice.pickupLocation.type
“airport”; otherwise it will not be returned
Rental car dropff location and address
vendors.carHireOffice.dropoffLocation
information
vendors.carHireOffice.dropoffLocation. address Address information
vendors.carHireOffice.dropoffLocation. address.streetAddress Array of street addresses

vendors.carHireOffice.dropoffLocation. address.cityName City

vendors.carHireOffice.dropoffLocation. address.stateOrProvince State or province
vendors.carHireOffice.dropoffLocation. address.zipCode Postal/zip code
vendors.carHireOffice.dropoffLocation. address.countryCode Country code
vendors.carHireOffice.dropoffLocation. location.code Avis/Budget unique location code
vendors.carHireOffice.dropoffLocation. location.name Name of the car hire office location
vendors.carHireOffice.dropoffLocation. phone.phoneNumber Phone number of the car hire office
vendors.carHireOffice.dropoffLocation. workingHours Operating hours of the car hire office
If this is an airport location, the type will be
vendors.carHireOffice.dropoffLocation.type
“airport”; otherwise it will not be returned
vendors.carHireOffice.policies Array of policies
vendors.carHireOffice.policies.type Values: “terms”, “liability”
vendors.carHireOffice.policies.attribute List of terms and conditions
Array of guest reviews for this product.
individualRatings Used only in the getTravelOfferDetailsRS for
experiences and properties.
A reference to the offers.serviceList.serviceId
field within the same message.
individualRatings.serviceRef
experiences.
Rating given by the reviewer.
individualRatings.value Used only in the getTravelOfferDetailsRS for
experiences.
Sort order for this review.
individualRatings.sortOrder Used only in the getTravelOfferDetailsRS for
experiences.
HTML-formatted content of the review.
individualRatings.review Used only in the getTravelOfferDetailsRS for
experiences.
Name of the user that submitted this review.
individualRatings.ownerName Used only in the getTravelOfferDetailsRS for
experiences.
individualRatings.publishedDate. formattedDateTime Date that this review was published.

experiences.
Title of this review.
individualRatings.title Used only in the getTravelOfferDetailsRS for
properties.
Verification source.
individualRatings.verificationSource Used only in the getTravelOfferDetailsRS for
properties.

Description of individual objects

AuthenticatedSender
AuthenticatedSenders Required Description
An agreed senderId that must be present in all the requests.
authenticatedSenderId *  “IAGL-white-label” for Online channel (IAGL UI)
 “IAGL-TAP” for Offline channel (TAP)
Specifies the airline that this customer is a loyalty member of; 2-character
messageSender.iataNumber *
IATA airline code, e.g. “BA”
* (Expedia The country code of the traveler’s point of sale. This should represent the
messageSender.pos.posCountry
and Avis only) country where the shopping transaction is taking place.
messageSender.pos.posCurrency Currency code
messageSender.pos.posLanguage Language code, e.g. “en-US”, “es-ES”
* (Expedia The customer’s IP address as provided in the request.
messageSender.pos.device. ipAddress only – specific Mandatory for Expedia in OrderCreateRQ, OrderReshopRQ, OrderChangeRQ.
messages)
Specifies the device that the request was sent from. Values:
• AGENT_TERMINAL
• WEB_BROWSER
• AIRPORT_KIOSK
messageSender.pos.device. deviceName *
• MOBILE_WEB
• MOBILE_APP
• OTHER
• UNKNOWN
* (only for
messageSender.senderType Type of the sender. Used only for TAP with value “CSR”.
TAP)
* (only for
messageSender.agentID Logged in agent user id. Used only for TAP.
TAP)
* (only for
messageSender. sourceSenderCode Staff number of the agent. Used only for TAP.
TAP)
The membership id of the LAH user. The array will contain one single item
* (only for when the Customer is the direct message participant or two items when the
msgParticipants.agentId
LAH) Customer Service Agent is the direct message participant. In the latter case,
both the Agent and the Customer’s info should be provided.

Values:
 LAH : Loyalty Account Holder
msgParticipants.senderType *
 OPCO : Operational Company of Customer Service Agents and
Representatives
* (only for Airline code of the CSR.
msgParticipants.senderName
TAP) Mantadory for TAP flows and IAGL-white-label Avis flows.
msgParticipants.user.residenceCountryCode Residence country code of LAH
OfficeLocation
OfficeLocation Required Description
address Address details
address.stateOrProvince State or province
address.streetAddress Street addresses array
address.cityName City name or administrative area
address.zipCode Zip or postal code
address.countryName Country name
address.countryCode Country code
location.name * Name of this location
location.code Unique location code (of Avis/Budget)
phone.phoneNumber Phone number of the office
workingHours Operating hours of the office
type If this is an airport location, the type will be “airport”; otherwise it will not be returned
Geographic coordinates (lattitude/longitude) for this location. The array will always
geoLocation
contain one single item for ancillaries.
geoLocation.latitude.intValue * Latitude of this location
geoLocation.latitude.scale * Decimal points
geoLocation.longitude.intValue * Longitude of this location
geoLocation.longitude.scale * Decimal points
description Description of the location

OfficeLocation – Viator’s mapping

OfficeLocation Viator: locations/bulk Google Places API (all fields are optional)
address address
result.address_components.short_name
address.stateOrProvince address.state
(if types.contains("administrative_area_level_1"))
result.address_components.long_name
address.streetAddress address.street
(if types.contains("street_address"))
address.cityName address.administrativeArea
(if types.contains("locality"))
address.zipCode address.postCode
(if types.contains("postal_code"))
address.countryName address.country
(if types.contains("country"))
address.countryCode address.countryCode
(if types.contains("country"))
location.name name result.name
location.externalId.locationId reference -
providerReference (when -
location.externalId.thirdLocation.locationId
'provider'="GOOGLE")
location.externalId.thirdLocation.source “GOOGLE” -
geoLocation center -
geoLocation.latitude.intValue center.latitude result.geometry.location.lat
geoLocation.latitude.scale - -
geoLocation.longitude.intValue center.longitude result.geometry.location.lng
geoLocation.longitude.scale - -
remark unstructuredAddress result.formatted_address

TravelOffersRS and TravelOfferDetailsRS – Mapping with Expedia attributes

Expedia- Expedia-
TravelOffersRS Expedia-getAvailabilityRS
getPropertyContent guestReviews
recommendationId
payloadAttributes.correlationId
payloadAttributes.messageDatetime.
formattedDateTime
sender.authenticatedSenderId
trip.travelers
trip.shopperGroups
offers.bundleId
offers.vendorRef property_id
offers.bundleSequence rank
offers.bundleScore score
offers.bundleBreakdown
priceApplicabilityId
rooms.rates.status
availabilityStatus
rooms.rates.available_rooms
availability
offers.bundleBreakdown.priceDetail. serviceRef
packageTotalPrice
packageTotalPrice.priceId
packageTotalPrice.

packageTotalPrice. totalAmount.amount.scale
packageTotalPrice.totalAmount. currencyCode
packageTotalPrice.
packageTotalPrice. baseAmount.amount.scale
packageTotalPrice.baseAmount. currencyCode
packageTotalPrice.
packageTotalPrice.
packageTotalPrice.
packageTotalPrice. surcharges
packageTotalPrice.surcharges. feeCode
packageTotalPrice. surcharges.
packageTotalPrice.surcharges.
amount.amount.scale
packageTotalPrice.surcharges.
amount.currencyCode
packageTotalPrice.

loyaltyAmount.amount.intValue
packageTotalPrice.
packageTotalPrice. loyaltyAmount.
currencyCode
passengerPrice
passengerPrice.groupPriceId
passengerPrice.personRefs
offers.bundleBreakdown.priceDetail. night
passengerPrice.unitPrices (rooms.rates.occupancy_pricing.nightly)
passengerPrice.unitPrices.unitId
passengerPrice.unitPrices.unit
passengerPrice.unitPrices.unitPrice
rooms.rates.occupancy_pricing.
passengerPrice.unitPrices.unitPrice.
nightly.type(=base_rate).value
nightly.type(=base_rate).currency
baseAmount.currencyCode
offers.bundleBreakdown.priceDetail. rooms.rates.occupancy_pricing.
passengerPrice.unitPrices.unitPrice. nightly.type(=tax_and_service_fee or
totalTaxAmount.amount.intValue sales_tax).value

passengerPrice.unitPrices.unitPrice. nightly.type(=tax_and_service_fee or
totalTaxAmount.currencyCode sales_tax).currency
passengerPrice.unitPrices.unitPrice.taxDetails.
taxName
passengerPrice.unitPrices.unitPrice.taxDetails. nightly.type(=tax_and_service_fee or
taxCode sales_tax)
taxAmount.amount.intValue sales_tax).value
passengerPrice.unitPrices.unitPrice.taxDetails.
taxAmount.amount.scale
taxAmount.amount.currencyCode sales_tax).currency
passengerPrice.price
passengerPrice.price.priceId
passengerPrice.price.
totals.inclusive.request_currency.value
passengerPrice.price.totalAmount.
totals.inclusive.request_currency.currency
currencyCode

totals.exclusive.request_currency.value
passengerPrice.price.baseAmount.
totals.exclusive.request_currency.currency
currencyCode
totals.inclusive.request_currency.value -
totals.exclusive.request_currency.value
totals.exclusive.request_currency.currency
passengerPrice.price.surcharges
passengerPrice.price.surcharges. feeCode totals.property_fees
passengerPrice.price.surcharges.
totals.property_fees.request_currency.value
amount.amount.scale
rooms.rates.occupancy_pricing.totals.
property_fees.request_currency.currency
amount.currencyCode
packageAttributes

packageAttributes.packageId
packageAttributes.packageRules
packageAttributes.packageRules.
packageRuleId
rooms.rates.refundable
packageAttributes.packageRules. ruleTypeInd
“cancel” : rooms.rates.cancel_penalties
“conditionalCancel” :
packageAttributes.packageRules. packageType
rooms.rates.nonrefundable_date_ranges
offers.bundleBreakdown.priceDetail. rooms.rates.cancel_penalties.start or
packageAttributes.packageRules. rooms.rates.nonrefundable_date_ranges.
startDateTime.formattedDateTime start
offers.bundleBreakdown.priceDetail. rooms.rates.cancel_penalties.end or
packageAttributes.packageRules. rooms.rates.nonrefundable_date_ranges.
endDateTime.formattedDateTime end
packageAttributes.packageRules. rooms.rates.cancel_penalties.nights
chargeableUnit
packageAttributes.packageRules. rooms.rates.cancel_penalties.currency
feeAmount.currencyCode
packageAttributes.packageRules. rooms.rates.cancel_penalties.amount
feeAmount.amount
rooms.rates.cancel_penalties.percent
packageAttributes.packageRules.percent
packageAttributes.beds
rooms.rates.bed_groups.id
packageAttributes.beds.begGroupId
rooms.rates.bed_groups.description
packageAttributes.beds.title

rooms.rates.bed_groups.configuration
packageAttributes.beds.configuration
rooms.rates.bed_groups.configuration.type
packageAttributes.beds.configuration. type
rooms.rates.bed_groups.configuration.size
packageAttributes.beds.configuration. size
offers.bundleBreakdown.priceDetail. rooms.rates.bed_groups.configuration.quan
packageAttributes.beds.configuration. quantity tity
packageAttributes.attributes
packageAttributes.attributes.type
rooms.rates.amenities.name
packageAttributes.attributes.attribute
offers.serviceList
offers.serviceList.serviceId
offers.serviceList.room
offers.serviceList.room.name rooms.room_name
offers.serviceList.room.roomId rooms.id
offers.serviceList.room.attributeList. type
rooms.room.amenities.
offers.serviceList.room.attributeList. attribute
amenity.name
offers.serviceList.room.dimensionList
rooms.room.area.
square_meters (variable
offers.serviceList.room.dimensionList.dimCateg name)
ory rooms.room.area.
square_feet (variable
name)
rooms.room.area.
square_meters
offers.serviceList.room.dimensionList.dimValue
rooms.room.area.
square_feet
offers.serviceList.room.dimensionList.UOM

rooms.room.occupancy.
offers.serviceList.room.maxOccupants
max_allowed.total
offers.serviceList.media rooms.room.images
rooms.room.images.
offers.serviceList.media.title
caption
offers.serviceList.media. rooms.room.images.
mediaSequence hero_image
rooms.room.images. links
mediaList
mediaList.type links.size (key)
mediaList.method links.size.method
mediaList.href links.size.href
vendors.vendorId property_id
vendors.vendorName name
vendors.hotel
vendors.hotel.ratings
vendors.hotel.ratings.source
vendors.hotel.ratings.type ratings.property.type
ratings.property. rating or
vendors.hotel.ratings.overall
ratings.guest.overall
vendors.hotel.ratings.ratingBreakdown
vendors.hotel.ratings.ratingBreakdown.attribut ratings.guest.cleanliness
e (variable name)
ratings.guest.service
(variable name)
ratings.guest.comfort
(variable name)
ratings.guest.condition
(variable name)
ratings.guest.location
(variable name)

ratings.guest.
neighborhood (variable
name)
ratings.guest.quality
(variable name)
ratings.guest.value
(variable name)
ratings.guest. amenities
(variable name)
ratings.guest.
recommendation_percent
(variable name)
ratings.guest.cleanliness
ratings.guest.service
ratings.guest.comfort
ratings.guest.condition
ratings.guest.location
ratings.guest.
vendors.hotel.ratings.ratingBreakdown.value
neighborhood
ratings.guest.quality
ratings.guest.value
ratings.guest.amenities
ratings.guest.
recommendation_percent
vendors.hotel.category category
business_model.
vendors.hotel.propertyCollectInd
property_collect
business_model.
vendors.hotel.sellerCollectInd
expedia_collect
vendors.hotel.chain chain.name
vendors.hotel.brand chain.brands.name
geoLocation
vendors.hotel.propertyLocation. location.coordinates.

geolocation.latitude latitude
vendors.hotel.propertyLocation. location.coordinates.
geolocation.longitude longitude
vendors.hotel.attibuteList
vendors.hotel.attibuteList.type
 amenities.
amenity.name
(for type
“amenity”)
 attributes.
general.name
(for type
“general”)
 attributes.
vendors.hotel.attibuteList.attribute pets.name
(for type “pets”)
 descriptions.locati
on
(for type
“location”)
 descriptions.
attractions
(for type
“attractions”)
vendors.hotel.media images
vendors.hotel.media.title images.caption
images.hero_image
mediaSequence
images.links
mediaList
images.links.size (key)
mediaList.type
images.links.size.method
mediaList.method

images.links.size.href
mediaList.href
vendors.hotel.address address
address.line_1
vendors.hotel.address.streetAddress
address.line_2
vendors.hotel.address.cityName address.city
address.
vendors.hotel.address.stateOrProvince
state_province_name
vendors.hotel.address.zipCode address.postal_code
vendors.hotel.address.countryCode address.country_code
vendors.hotel.checkInDetails
vendors.hotel.checkInDetails.checkinStartTime checkin.begin_time
vendors.hotel.checkInDetails.checkinEndTime checkin.end_time
vendors.hotel.checkInDetails.checkoutTime checkout.time
vendors.hotel.checkInDetails.instructions checkin.instructions
vendors.hotel.checkInDetails.specialInstruction checkin.
s special_instructions
vendors.hotel.checkInDetails.minCheckInAge checkin.min_age
airports.preferred.
vendors.hotel.nearbyAirport
iata_airport_code
spoken_languages.
vendors.hotel.spokenLanguages
language.name
vendors.hotel.feeList
fees.mandatory (variable
name)
vendors.hotel.feeList.type
fees.optional (variable
name)
fees.mandatory
vendors.hotel.feeList.attribute
fees.optional
vendors.hotel.policies
policies.
vendors.hotel.policies.type know_before_you_go
(variable name)

policies.
vendors.hotel.policies.attribute
know_before_you_go
individualRatings
verified.
individualRatings.value
recent.rating
verified.
individualRatings.title
recent.title
verified.
individualRatings.review
recent.text
verified.
individualRatings.ownerName recent.
reviewerName
verified.
individualRatings.publishedDate. recent.
formattedDateTime date_submitte
d
‍
TravelOffersRS and TravelOfferDetailsRS – Mapping with Avis attributes

Avis-
TravelOffersRS Avis-getAvailableVehicles Avis-getVehicleRates
getTermsAndConditions
recommendationId
formattedDateTime
trip.travelers
offers.bundleId
offers.vendorRef

serviceRef
packageTotalPrice
vehicles.rate_totals. reservation.rate_totals.
packageTotalPrice.
pay_later.reservation_total totals.reservation_total
packageTotalPrice.
reservation.rate_totals.
packageTotalPrice.totalAmount. vehicles.rate_totals. rate.currency
rate.currency
currencyCode
packageTotalPrice.
pay_later.vehicle_total totals.vehicle_total
packageTotalPrice.
packageTotalPrice.baseAmount. vehicles.rate_totals. rate.currency
rate.currency
currencyCode
packageTotalPrice.
totals.taxes_fees_total
packageTotalPrice.
offers.bundleBreakdown.priceDetail. reservation.rate_totals.
packageTotalPrice. rate.currency

packageTotalPrice.
packageTotalPrice.
currencyCode
passengerPrice
pay_later.reservation_total totals.reservation_total
passengerPrice.price.totalAmount. vehicles.rate_totals. rate.currency
rate.currency
currencyCode
pay_later.vehicle_total totals.vehicle_total

passengerPrice.price.baseAmount. vehicles.rate_totals. rate.currency
rate.currency
currencyCode
totals.taxes_fees_total
rate.currency
passengerPrice.price.remarks.title
packageAttributes
offers.bundleBreakdown.priceDetail. vehicles.rate_totals. reservation.rate_totals.
packageAttributes.code rate.rate_code rate.rate_code
packageRuleId
packageAttributes.packageRules. reservation.disclaimers. type
packageType
reservation.disclaimers.
description
ruleFulltextRef

packageAttributes.attributes.
attributePairs
attributePairs.attribute
reservation.distance.
unlimited_distance
distance_covered
distance_unit
attributePairs.value
distance_overage
vehicles.rate_totals.rate.
under_age_fee_applied
offers.serviceList
offers.serviceList.vehicle
vehicles.category.name
offers.serviceList.vehicle.name
offers.serviceList.vehicle.make vehicles.category.make
offers.serviceList.vehicle.model vehicles.category.model
offers.serviceList.vehicle. vehicles.category.
vehicleClassCode vehicle_class_code
vehicleClassName vehicle_class_name
vehicleTransmission vehicle_transmission
offers.serviceList.vehicle.mpg vehicles.category.mpg
offers.serviceList.vehicle.sippCode vehicles.category.sipp_code
offers.serviceList.vehicle.fuel vehicles.capacity.fuel_type
offers.serviceList.vehicle. attributeList.
type

 vehicles.features - only the

fields that are true
offers.serviceList.vehicle.attributeList.
(for type “features”)
attribute
 vehicles.capacity
(for type “capacity”)
offers.serviceList.media
mediaList
vehicles.category.image_url
mediaList.href
vendors.vendorId
vendors.vendorName product.brand
vendors.carHireOffice
vendors.carHireOffice.pickupLocation reservation.pickup_location
vendors.carHireOffice.pickupLocation. reservation.pickup_location.
address address
reservation.pickup_location.
vendors.carHireOffice.pickupLocation. address.address_line_1
address.streetAddress reservation.pickup_location.
address.address_line_2
address.cityName address.city
address.stateOrProvince address.state_name
vendors.carHireOffice.pickupLocation. reservation.pickup_location .addre
address.zipCode ss.postal_code
address.countryCode address.country_code
location.code location.code
location.name location.name
phone.phoneNumber location.telephone

workingHours location.hours
type location.airport_location (if true)
vendors.carHireOffice.dropoffLocation reservation.dropoff_location
vendors.carHireOffice.dropoffLocation. reservation.dropoff_location.
address address
reservation.dropoff_location.
vendors.carHireOffice.dropoffLocation. address.address_line_1
address.streetAddress reservation.dropoff_location.
address.address_line_2
address.cityName address.city
address.stateOrProvince address.state_name
address.zipCode address.postal_code
address.countryCode address.country_code
location.code location.code
location.name location.name
phone.phoneNumber location.telephone
workingHours location.hours
type location.airport_location (if true)
vendors.carHireOffice.policies
vendors.carHireOffice.policies.type
vendors.carHireOffice.policies.attribute terms.content

TravelOffersRS and TravelOfferDetailsRS – Mapping with Viator attributes (Schedules – Products –

Availability)
Viator- Viator-getProduct
TravelOffersRS getAvailability Viator-getProducts TagscheckAvailabilit
Schedules y
recommendationId
formattedDateTime
trip.travelers
offers.bundleId
offers.vendorRef
offers.offeredPTCs pricingInfo.ageBands
offers.offeredPTCs.code pricingInfo.ageBands. ageBand
offers.offeredPTCs.startAge pricingInfo.ageBands. startAge
offers.offeredPTCs.endAge pricingInfo.ageBands. endAge
pricingInfo.ageBands.
offers.offeredPTCs.minCount
minTravelersPerBooking
pricingInfo.ageBands.
offers.offeredPTCs.maxCount
maxTravelersPerBooking
serviceRef
packageTotalPrice

offers.bundleBreakdown.priceDetail. bookableItems.
packageTotalPrice. summary.fromPrice totalPrice.price.
nettotalAmount.amount.intValue partnerTotalPrice
packageTotalPrice.
totalAmountnetAmount.amount.scale
packageTotalPrice.totalAmountnetAmount. currency currency
currencyCode
packageTotalPrice.
packageTotalPrice.
currencyCode
passengerPrice
passengerPrice.unitPrices
passengerPrice.unitPrices.unitId
passengerPrice.unitPrices.unit seasons.
pricingRecords.
pricingDetails.
pricingPackageType
(only if it is

“PER_PERSON”)
passengerPrice.unitPrices.unitPrice
bookableItems.
seasons.
offers.bundleBreakdown.priceDetail. pricingRecords.
passengerPrice.unitPrices.unitPrice. pricingDetails.
totalAmount.amount.intValue price.original.
recommendedRetail
Price
passengerPrice.unitPrices.unitPrice. currency
totalAmount.currencyCode
passengerPrice.price. summary.fromPrice
passengerPrice.price.totalAmount. currency
currencyCode
packageAttributes
offers.bundleBreakdown.priceDetail. productOptions.title

packageAttributes.name
packageAttributes.code productOptionCode
productOptions. description
packageAttributes.remarks.title
packageRuleId
packageAttributes.packageRules. ruleTypeInd
packageType
cancellationPolicy.type
packageAttributes.packageRules. remark
packageAttributes.packageRules. cancellationPolicy. description
ruleFulltextRef
cancellationPolicy. refundEligibility.
dayRangeMin
dayRangeMin
cancellationPolicy. refundEligibility.
dayRangeMax
dayRangeMax
offers.bundleBreakdown.priceDetail. 100 - cancellationPolicy.
packageAttributes.packageRules. percent refundEligibility. percentageRefundable
packageAttributes.mediaList

productOptions. languageGuides.type
packageAttributes.mediaList.title
offers.bundleBreakdown.priceDetail. productOptions.
packageAttributes.mediaList. mediaList.type languageGuides.language
packageAttributes.attributes. attributePairs
for type “cancelIfBadWeather”:
cancellationPolicy. cancelIfBadWeather
for type “cancelIfInsufficientTravelers”:

cancellationPolicy.
cancelIfInsufficientTravelers
for type “ticketInfo”:
attributePairs.value
ticketInfo. ticketTypeDescription
for type “pickupIncluded”:

if productOptions.description contains
the phrase "pickup included" then set
value to "true", else to "false"
priceAvailabilityList
bookableItems.
productOptionCode.
priceAvailabilityList.daysOfWeek seasons.
pricingRecords.
daysOfWeek

bookableItems.
productOptionCode.
priceAvailabilityList.startTimeList. seasons.
formattedDateTime pricingRecords.
timedEntries.
startTime
offers.serviceList
offers.serviceList.description.title description
offers.serviceList.experience
offers.serviceList.experience. productId productCode
offers.serviceList.experience.name title
offers.serviceList.experience.ratings
offers.serviceList.experience. ratings.source
offers.serviceList.experience. ratings.count
offers.serviceList.experience. ratings.overall
offers.serviceList.experience. attributeList
attributeList.type
for type “additionalInfo”:
additionalInfo.description
offers.serviceList.experience. for type “inclusions”:

attributeList.attribute inclusions.otherDescription
for type “exclusions”:

exclusions.otherDescription
attributeList.attributePairs

attributeList.attributePairs.attribute
for type “itinerary”:
itinerary.skipTheLine
itinerary.privateTour
for type “bookingRequirements”:

bookingRequirements.
attributeList.attributePairs.value
minTravelersPerBooking
maxTravelersPerBooking
requiresAdultForBooking
offers.serviceList.experience. languageGuides languageGuides
languageGuides.type
languageGuides.title
languageGuides.mediaList
languageGuides.language
languageGuides.mediaList.type
bookingQuestions
id
bookingQuestions.id
type
bookingQuestions.type
group
bookingQuestions.group
label
bookingQuestions.title
hint
bookingQuestions.hint

required
bookingQuestions.answerIsRequired
maxLength
bookingQuestions.maxLength
units
bookingQuestions.units
allowedAnswers
bookingQuestions.allowedAnswers
experienceDetails.experienceDayList
itinerary.days.title
experienceDetails.experienceDayList. name
experienceDetails.experienceDayList. itinerary.days.dayNumber
dayNumber
experienceDetails.experienceDayList.
itineraryItems
experienceDetails.experienceDayList. itinerary.itineraryItems. description
itineraryItems.description
itineraryItems.duration
itinerary.itineraryItems. duration.
fixedDurationInMinutes
itineraryItems.duration.duration
itineraryItems.duration.uom
itineraryItems.location

itineraryItems.location.address
itineraryItems.location.address.
stateOrProvince
itineraryItems.location.address.streetAddress
itineraryItems.location.address.cityName
itineraryItems.location.address.zipCode
itineraryItems.location.adsress.countryName
itineraryItems.location.address. countryCode
itineraryItems.location.location.name
itineraryItems.location.geoLocation
offers.serviceList.experience .experienceDeta

ils.experienceDayList.
itineraryItems.location.geoLocation.
latitude.intValue
latitude.scale
longitude.intValue
longitude.scale
itineraryItems.attributeList
itineraryItems.attributeList. attributePairs
itineraryItems.attributeList.
for attribute “passByWithoutStopping”:
itinerary.itineraryItems.
offers.serviceList.experience. passByWithoutStopping
itineraryItems.attributeList. for attribute “admissionIncluded”:
attributePairs.value itinerary.itineraryItems.
admissionIncluded

itineraryItems.accommodationList
itineraryItems.accommodationList. address
itineraryItems.accommodationList. address.
stateOrProvince
itineraryItems.accommodationList.
address.streetAddress
address.cityName
address.zipCode
adsress.countryName
itineraryItems.accommodationList. address.
countryCode

location.name
geoLocation
ils.experienceDayList.
itineraryItems.accommodationList.geoLocatio
n.latitude.intValue
geoLocation.latitude.scale
geoLocation.longitude.intValue
geoLocation.longitude.scale
experienceDetails.experienceDayList. itinerary.days. accommodations.
itineraryItems.accommodationList. description
description
itinerary.days. foodAndDrinks
itineraryItems.foodMenus
experienceDetails.experienceDayList. itinerary.days. foodAndDrinks. type
itineraryItems.foodMenus.dishType

itinerary.days. foodAndDrinks.
typeDescription
itineraryItems.foodMenus.dishName
itinerary.days. foodAndDrinks.
description
itineraryItems.foodMenus. dishDescription
experienceDetails.activityItem
experienceDetails.activityItem. itinerary.activityInfo. location
activityLocation
experienceDetails.activityItem.
activityLocation.address
activityLocation.address. stateOrProvince
activityLocation.address. streetAddress
activityLocation.address.cityName

activityLocation.address.zipCode
activityLocation.address.countryName
activityLocation.address.countryCode
activityLocation.location.name
activityLocation. geoLocation
ils.activityItem. activityLocation.geoLocation.
latitude.intValue
activityLocation.geoLocation. latitude.scale
activityLocation.geoLocation.
longitude.intValue

activityLocation.geoLocation. longitude.scale
experienceDetails.activityItem. itinerary.activityInfo. description
activityLocation.description
experienceDetails.activityItem. foodMenus itinerary.foodMenus
experienceDetails.activityItem. itinerary.foodMenus. course
foodMenus.dishType
experienceDetails.activityItem. itinerary.foodMenus. dishName
foodMenus.dishName
experienceDetails.activityItem. itinerary.foodMenus. dishDescription
foodMenus.dishDescription
if itineraryType "ACTIVITY":
products.itinerary.pointsOfInterest,
if itineraryType "UNSTRUCTURED":
experienceDetails. pointsOfInterestList
products.itinerary.pointOfInterestLocati
ons.location
offers.serviceList.deliveryInstructions
offers.serviceList.deliveryInstructions. logistics.redemption. specialInstructions
instructions.remarks logistics.travelerPickup. additionalInfo
offers.serviceList.deliveryInstructions. logistics.travelerPickup.
allowCustomTravelerPickup allowCustomTravelerPickup

offers.serviceList.deliveryInstructions. logistics.travelerPickup.pickupOptionTyp
pickupOptionType e
minutesBeforeDepartureTimeFor Pickup minutesBeforeDepartureTimeForPickup
logistics.travelerPickup. locations
pickupLocations
pickupLocations.type locations.pickupType
logistics.travelerPickup.
offers.serviceList.deliveryInstructions. locations.location.ref for values
pickupLocations.description "MEET_AT_DEPARTURE_POINT"
"CONTACT_SUPPLIER_LATER"
offers.serviceList.deliveryInstructions.startLoc
products.logistics.start.locations
ations
offers.serviceList.deliveryInstructions.startLoc
products.logistics.start.description
ations.description
offers.serviceList.deliveryInstructions.endLoc
products.logistics.end.locations
ations
offers.serviceList.deliveryInstructions.endLoc
products.logistics.end.description
ations.description
pickupLocations.address
pickupLocations.address. stateOrProvince
pickupLocations.address. streetAddress
pickupLocations.address.cityName

pickupLocations.address.zipCode
pickupLocations.address. countryName
pickupLocations.address.countryCode
pickupLocations.location.name
pickupLocations.geoLocation
pickupLocations.geoLocation.
latitude.intValue
pickupLocations.geoLocation. latitude.scale
pickupLocations.geoLocation.
longitude.intValue
pickupLocations.geoLocation. longitude.scale
experienceDetails
itinerary.itineraryType
experienceDetails.type
itinerary. unstructuredDescription
experienceDetails.description
experienceDetails.duration
offers.serviceList.experience. itinerary.duration.
experienceDetails.duration.duration fixedDurationInMinutes

offers.serviceList.experience. itinerary.duration. variableDuration

experienceDetails.duration. minDuration FromMinutes
offers.serviceList.experience. itinerary.duration.
experienceDetails.duration. maxDuration variableDuration ToMinutes
itinerary.duration. unstructuredDuration
experienceDetails.duration.freeText
experienceDetails.duration.uom
offers.serviceList.media
offers.serviceList.media.title images.caption
images.isCover
mediaSequence
images.variants
mediaList
offers.serviceList.media. images.variants.width x
mediaList.type images.variants.height
images.variants.url
mediaList.href
vendors.vendorId
vendors.vendorName supplier.name
individualRatings
individualRatings.value
individualRatings.sortOrder
individualRatings.review
individualRatings.ownerName
individualRatings.publishedDate.
formattedDateTime

TravelOffersRS and TravelOfferDetailsRS – Mapping with Viator attributes (Locations – Reviews –

Tags - Booking questions)
Viator-getProduct Viator- Viator-getBooking
TravelOffersRS Viator-getLocations
Reviews getProductTags Questions
for type “tags”:

offers.serviceList.experience. tags.
attributeList.attribute allNamesByLocale.
en_UK
bookingQuestions
id
bookingQuestions.id
type
bookingQuestions.type
group
bookingQuestions.group
label
bookingQuestions.title
hint
bookingQuestions.hint
required
bookingQuestions.answerIsRequired
maxLength
bookingQuestions.maxLength
units
bookingQuestions.units

allowedAnswers
bookingQuestions.allowedAnswers
Ref OfficeLocation –
Viator’s mapping
itineraryItems.location
Viator’s mapping
itineraryItems.accommodationList
experienceDetails.activityItem
Viator’s mapping
activityLocation
offers.serviceList.deliveryInstructions. Ref OfficeLocation –
pickupLocations Viator’s mapping
individualRatings
individualRatings.value rating
individualRatings.sortOrder sortOrder
individualRatings.review review
individualRatings.ownerName ownerName
individualRatings.publishedDate.
publishedDate
formattedDateTime

2. Shopping API for Properties
1.2 Summary
o getTravelOffers
 returns a list of offers with the available properties that match the search
criteria; for each property only one rate is returned (the cheapest) and the basic
content information
 returns the details of a specific/selected offer, that is all the available rooms and
rates for the selected property as well as the complete content information
In the case of Expedia, the above APIs leverage the following Expedia APIs:
o getContent
o getAvailability
o getAvailability (getAdditionalRates)
2.2 API Details
getTravelOffers
 The following are Aerostream attributes

o recommendationId
o payloadAttributes/correlationId
o payloadAttributes/echoToken
o payloadAttributes/messageDatetime/formattedDateTime
o trip/travelers/personId
o trip/travelers/ptc
o trip/travelers/age
o shopperGroups/shopperRef
o offers/bundleId
o offers/priceDetail
o offers/priceDetail/price/groupPriceId
o offers/priceDetail/packageAttributes/packageId
o offers/serviceList/serviceId
 The following are attributes that Aerostream gets from Expedia getContentRS API
o property_id
o name
o ratings/property/rating
o ratings/property/type
o ratings/guest/count
o ratings/guest/overall
o category/name
o rank
o business_model/expedia_collect
o business_model/property_collect
o location/coordinates/latitude
o location/coordinates/longitude
o attributes/pets/name - array
o attributes/general/name - array
o amenities/name - array
o images (only images with "hero_image": true) - array
 images/hero_image
 images/links/size
 images/links/size/href
 images/caption
o rooms/id
o rooms/name
o rooms/amenities/name – list
 rooms/amenities/amenity/name
o rooms/images (only images with "hero_image": true) - array
 images/caption
 The following are attributes that Aerostream gets from the Expedia getAvailabilityRS
API
o rooms - array
 rooms/rates - array
 rates/status
 rates/available_rooms
 rates/refundable
 rates/cancel_penalties - array
o cancel_penalties/start
o cancel_penalties/end
o cancel_penalties/nights
o cancel_penalties/amount
o cancel_penalties/percent
o cancel_penalties/currency
 rates/amenities – list
o amenities/amenity/name

 rates/bed_groups - list
o bed_groups/bed_group/id
o bed_groups/bed_group/description
o bed_groups/bed_group/configuration - array
o bed_groups/bed_group/configuration/type
o bed_groups/bed_group/configuration/size
o bed_groups/bed_group/configuration/quantity
 rates/occupancy_pricing - list
 rates/occupancy_pricing/occupancy/nightly -
array
o nightly/type
 mapping: Expedia  Aerostream
 base_rate  baseAmount
 tax_and_service_fee 
totalTaxAmount
 rest types  surcharges
o nightly/value
o nightly/currency
 rates/occupancy_pricing/occupancy/totals/
property_fees/request_currency/value
property_fees/request_currency/currency
exclusive/request_currency/value
exclusive/request_currency/currency
inclusive/request_currency/value
inclusive/request_currency/currency
getTravelOfferDetails
 The following are Aerostream attributes

o recommendationId
o payloadAttributes/correlationId
o payloadAttributes/echoToken
o payloadAttributes/messageDatetime/formattedDateTime
o trip/travelers/personId
o trip/travelers/ptc
o trip/travelers/age
o shopperGroups/shopperRef
o offers/bundleId
o offers/priceDetail
o offers/priceDetail/price/groupPriceId
o offers/priceDetail/packageAttributes/packageId

o offers/serviceList/serviceId
 The following are attributes that Aerostream gets from the Expedia- getContentRS API
o property_id
o name
o address/line_1
o address/city
o address/state_province_name
o address/postal_code
o ratings/property/rating
o ratings/property/type
o ratings/guest (all info)
o location/coordinates/latitude
o location/coordinates/longitude
o category/name
o business_model/expedia_collect
o business_model/property_collect
o checkin/begin_time
o checkin/end_time
o checkin/instructions
o checkin/special_instructions
o checkin/min_age
o checkout/time
o fees/mandatory
o fees/optional
o policies/know_before_you_go
o attributes/general - list
 general/attribute/name
o attributes/pets - list
 pets/attribute/name
o amenities - list
 amenities/amenity/name
o images - array
 images/caption
o rooms - list
 rooms/id
 rooms/name
 rooms/amenities - list
 amenities/amenity/name
 rooms/images - list
 images/hero_image
 images/links/size
 images/links/size/href

 images/caption
 rooms/area/square_feet
 rooms/area/square_meters
 rooms/occupancy/max_allowed/total
o airports/preferred/iata_airport_code
o spoken_languages/id/name
o descriptions/location
o descriptions/attractions
 The following are attributes that Aerostream gets from the Expedia-
getAvailabilityAdditionalRatesRS
o rooms - array
 rooms/rates - array
 rates/status
 rates/available_rooms
 rates/refundable
 rates/cancel_penalties - array
o cancel_penalties/start
o cancel_penalties/end
o cancel_penalties/nights
o cancel_penalties/amount
o cancel_penalties/percent
o cancel_penalties/currency
 rates/amenities – list
o amenities/amenity/name
 rates/bed_groups - list
o bed_groups/bed_group/id
o bed_groups/bed_group/description
o bed_groups/bed_group/configuration - array
o bed_groups/bed_group/configuration/type
o bed_groups/bed_group/configuration/size
o bed_groups/bed_group/configuration/quantity
 rates/occupancy_pricing - list
 rates/occupancy_pricing/occupancy/nightly -
array
o nightly/type
 mapping: Expedia  Aerostream
 base_rate  baseAmount
 tax_and_service_fee 
totalTaxAmount
 rest types  surcharges
o nightly/value
o nightly/currency

property_fees/request_currency/value
property_fees/request_currency/currency
exclusive/request_currency/value
exclusive/request_currency/currency
inclusive/request_currency/value
inclusive/request_currency/currency

3. Shopping API for Experiences

2.1 Summary
 getTravelOffers
 returns a list of offers with the available experiences that match the search criteria
 getTravelOfferDetails
 returns the details of a specific/selected offer
In the case of Viator, the above APIs leverage the following underlying Viator v2 APIs.
o getProducts_modified-since
o getAvailabilitySchedules_modified-since
o getProductReviews
o getProductsTags
o getBookingQuestions
2.2 API Details
getTravelOffers
 The following are attributes that Aerostream gets from the Viator-getProductsRS
o code
o title
o description
o pricingInfo/ageBands - array
 ageBand
 startAge
 endAge
 minTravelersPerBooking
 maxTravelersPerBooking
o images – only “isCover”=true
 caption
 isCover
 variants/height (width x height)
 variants/width
 variants/url
o additionalInfo

o cancellationPolicy
 type
 description
o tags
o itinerary
 itineraryType
 skipTheLine
 privateTour
 duration
 days
o bookingRequirements
 requiresAdultForBooking
 The following are attributes that Aerostream gets from the Viator-getAvailabilitySchedulesRS
o availabilitySchedules/summary/fromPrice
o availabilitySchedules/currency
o availabilitySchedules/bookableItems – array
 productOptionCode
 seasons (applicable element)/pricingRecords
 daysOfWeek
 timedEntries/startTime – array
 The following are attributes that Aerostream gets from the Viator-getProductsTagsRS
o allNamesByLocale/en
 The following are attributes that Aerostream gets from the Viator-getProductReviewsRS
o Calculated fields
 count
 average rating
 The following are attributes that Aerostream gets from the Viator-getProductsRS
o code
o title
o description
o images
o ticketInfo/ticketTypeDescription
o additionalInfo
o cancellationPolicy
 type
 description
 cancelIfBadWeather
 cancelIfInsufficientTravelers

 refundEligibility - array
 dayRangeMin
 dayRangeMax
 percentageRefundable
o tags
o itinerary
 itineraryType
 skipTheLine
 privateTour
 duration
 fixedDurationInMinutes
 variableDurationFromMinutes
 variableDurationToMinutes
 unstructuredDuration
 unstructuredDescription
 itineraryItems – array (only in STANDARD)
 pointOfInterestLocation/location/ref
 duration
o fixedDurationInMinutes
o variableDurationFromMinutes
o variableDurationToMinutes
o unstructuredDuration
 passByWithoutStopping
 admissionIncluded
 description
 days - array (only in MULTI_DAY_TOUR)
 title
 dayNumber
 items - array
o pointOfInterestLocation/location/ref
o duration
 fixedDurationInMinutes
 variableDurationFromMinutes
 variableDurationToMinutes
 unstructuredDuration
o passByWithoutStopping
o admissionIncluded
o description
 accommodations - array
o description
o location/ref
 foodAndDrinks - array
o typeDescription
o description
 activityInfo (only in ACTIVITY)

 location/ref
 description
 foodMenus – array (only in ACTIVITY)
 course
 dishName
 dishDescription
 routes (only in HOP_ON_HOP_OFF)
 operatingSchedule
 duration
 name
 stops - array
o stopLocation/ref
o description
 pointsOfInterest - array
o location/ref
o logistics
 redemption
 specialInstructions
 travelerPickup
 pickupOptionType
 allowCustomTravelerPickup
 locations - array
o location/ref
o pickupType
 minutesBeforeDepartureTimeForPickup
 additionalInfo
o inclusions
 otherDescription
o exclusions
 otherDescription
o bookingRequirements
 requiresAdultForBooking
o languageGuides – array
 type
 language
o productOptions – array
 description
 title
 languageGuides – array
 type
 language

o supplier/name
 The following are attributes that Aerostream gets from the Viator-getAvailabilitySchedulesRS
o availabilitySchedules/currency
o availabilitySchedules/bookableItems – array
 seasons (applicable element)/pricingRecords
(applicable element)
 daysOfWeek
 timedEntries/startTime – array
 pricingDetails – array
o minTravelers
o maxTravelers
o ageBand
o price/original/partnerTotalPrice
recommendedRetailPrice
 The following are attributes that Aerostream gets from the Viator-getProductsTagsRS
o allNamesByLocale/en
 The following are attributes that Aerostream gets from the Viator-getProductReviewsRS
o sortOrder
o ownerName
o rating
o review
o publishedDate
o Calculated fields
 count
 average rating
 The following are attributes that Aerostream gets from the Viator-getBookingQuestionsRS
o id
o type
o group
o label
o hint
o units
o allowedAnswers
o required
o maxLength

4. Shopping API for Car Hire

3.1 Summary
o getTravelOffers
 returns a list of offers with the available cars that match the search criteria
(including the details of each vehicle)
o refreshTravelOfferDetails
In the case of Avis, the above APIs leverage the following Avis APIs:
o getAvailableVehicles
o getVehicleRate
o getVehicleFeaturedRate
o getTermsAndConditions
3.2 API Details
getTravelOffers
 attributes from the Avis- getAvailableVehiclesRS

o product/brand
o vehicles - array
 vehicles/category/name
 vehicles/category/make
 vehicles/category/model
 vehicles/category/vehicle_class_name
 vehicles/category/vehicle_class_code
 vehicles/category/image_url
 vehicles/category/vehicle_transmission
 vehicles/category/mpg
 vehicles/rate_totals/pay_later
 pay_later/reservation_total
 pay_later/vehicle_total
 vehicles/rate_totals/totals
 totals/reservation_total
 totals/vehicle_total
 vehicles/rate_totals/rate/under_age_fee_applied
 vehicles/rate_totals/rate/rate_code
 vehicles/rate_totals/rate/currency

 vehicles/capacity/doors
 vehicles/capacity/seats
 vehicles/capacity/luggage_capacity/large_suitcase
 vehicles/capacity/luggage_capacity/small_suitcase
 vehicles/capacity/fuel_type
 vehicles/features/bluetooth_equipped
 vehicles/features/air_conditioned
 vehicles/features/smoke_free
 vehicles/features/connected_car
o reservation/pickup_location (all)
o reservation/dropoff_location (all)
o reservation/distance (all)
 attributes from the Avis- getTermsAndConditionsRS

o terms - array
o terms/content_type
 attributes from the Avis- getVehicleRateRS

o product/brand
o reservation/pickup_location (all)
o reservation/dropoff_location (all)
o reservation/distance (all)
o reservation/rate_totals
 rate_totals/rate
 rate/currency
 rate/rate_code
 rate/country_code
 rate/amount
 rate_totals/pay_later
 pay_later/reservation_total
 pay_later/taxes_fees_total
 pay_later/taxes_total
 pay_later/vehicle_total
 pay_later/fees_total
 pay_later/extras_total
 pay_later/insurance_total
 pay_later/discount_total
 rate_totals/totals
 totals/reservation_total
 totals/taxes_fees_total
 totals/taxes_total
 totals/vehicle_total

 totals/fees_total
 totals/extras_total
 totals/insurance_total
 totals/discount_total
o reservation/insurance – array
 code
 name
 amount
 total_owed
 selection_note
 selected
 tax_included
o reservation/extras – array
 code
 quantity
 type
 amount
 total_owed
o reservation/disclaimers – array
 type
 description
 attributes from the Avis- getTermsAndConditionsRS

o terms - array
o terms/content_type
refreshTravelOfferDetails
 attributes from the Avis- getVehicleFeaturedRateRS

o product/brand
o reservation/pickup_location
o reservation/dropoff_location
o reservation/email_notification
o reservation/pickup_date
o reservation/dropoff_date
o reservation/vehicle_class_code
o rate_totals/rate
 rate/currency
 rate/rate_code
 rate/country_code
o rate_totals/totals
 totals/reservation_total
 totals/taxes_fees_total
 totals/taxes_total
 totals/vehicle_total
 totals/fees_total

 totals/extras_total
 totals/insurance_total
 totals/discount_total
o insurance – array
 code
 name
 amount
 total_owed
 selection_note
 selected
 tax_included
o extras – array
 code
 quantity
 type
 amount
 total_owed
o passenger
 passenger/contact (all)
 passenger/driver (all)
 passenger/address (all)
5. OrderReshop API
5.1 Summary
The user is able to cancel his existing order. An OrderReshop request is required for to get the
differential price.

OrderReshopRQ
OrderReshopRQ Required Description
An agreed senderId that must be
sender.authenticatedSenderId *
present in all the requests.
Specifies the airline that this
customer is a loyalty member of; 2-
sender.messageSender.iataNumber *
character IATA airline code, e.g.
“BA”
The country code of the traveler’s
* (Expedia and Avis point of sale. This should represent
sender.messageSender.pos.posCountry
only) the country where the shopping
transaction is taking place.
The membership id of the LAH user.
The array will contain one single
item when the Customer is the
direct message participant or two
sender.msgParticipants.agentId * items when the Customer Service
Agent is the direct message
participant. In the latter case, both
the Agent and the Customer’s info
should be provided.
Values:
 LAH : Loyalty Account
sender.msgParticipants.senderType * Holder
 CSR : Customer Service
Agents and Representatives
The unique OrderID of the order as
orderID * returned in the createOrderRS, e.g.
"BAIAGLPCNYU4QY"
The selected orderItem id, which
will be removed. It should be as
deleteBundleRefs.bundleId *
returned in the orderViewRS.
(“bundleId” field).
OrderReshopRS
OrderReshopRS Required Description

Unique Id that will be used in the
recommendationId * subsequent request to identify
this Shopping Response
End-to-end correlation of
payloadAttributes.correlationId *
application logs
payloadAttributes.messageDatetime.formattedDateTime * Timestamp of the response

message
sender.authenticatedSenderId * The senderId of the request
bundles * Array of offers
Unique Offer Id in a ReShopping
bundles.bundleId *
Response
bundles. expiration
Expiration date of reshop offer.
The total price of this bundle.
The Price object is defined in the
individual objects below (ref
bundles.bundlePrice * Price). Relevant fields for this
message:
totalAmount, loyaltyAmount,
surcharges
Array of items. In our
bundle.bundleBreakdown * implementation, only one item
will be returned for each offer.
The price applicability details.
bundle.bundleBreakdown.priceDetail *
Individual price for a specific
ancillary.
bundle.bundleBreakdown.priceDetail. passengerPrice *
Each item represents a different
product option - orderItem.
References to travelers.personId.
Array of items.
Persons within the same
GroupPrice should be of the
bundle.bundleBreakdown.priceDetail. same type.
*
passengerPrice.personRefs Used in both getTravelOffersRS
and getTravelOfferDetailsRS for
properties and cars. Used only in
the getTravelOfferDetailsRS for
experiences.
Price information for the group.
The array will always contain one
single item for ancillaries.
bundle.bundleBreakdown.priceDetail.
* individual objects below (ref
Price). Relevant fields for this
message:
surcharges
bundle.bundleBreakdown.priceDetail. Unique Group Price Id within an
passengerPrice.groupPriceId offer
The differential object
differential represents the difference after
the requested cancellation.

Refers to the groupPrice per

product (bundleBreakdown.
differential. groupPriceRef
priceDetail. passengerPrice.
groupPriceId)
differential. noPriceChangeInd
The old price of existing booking.
differential. oldPrice Price). Relevant fields for this
message:
surcharges
The refund price that will be
returned to the user after the
cancellation of the booking.
differential. refundPrice
message:
totalAmount, loyaltyAmount
The additional surcharges that
user should pay after the
cancellation of the booking.
differential. additionalCollectionPrice
message:
surcharges
The refund price as returned by
the supplier.
differential. supplierRefundPrice individual objects below (ref
message:
totalAmount
Refers to the deleted orderItem
differential. bundleRefs
of the order.
Price
Price Required Description
priceId Unique Price Id for this object
totalAmount.amount.intValue * Total amount
totalAmount.amount.scale * amount = 12035
scale = 2
totalAmount.currencyCode * Currency code
baseAmount.amount.intValue Base amount


baseAmount.amount.scale amount = 12035
scale = 2
baseAmount. currencyCode Currency code
totalTaxAmount.amount.intValue Total tax amount
totalTaxAmount.amount.scale amount = 12035
scale = 2
totalTaxAmount.amount.
Currency code
currencyCode
surcharges Any additional surcharges (array)
surcharges. feeCode Fee designator
surcharges.
Fee amount
surcharges.amount.amount.scale amount = 12035
scale = 2
surcharges.amount.currencyCode Currency code
Boolean indicating whether the fee will be waived
surcharges.isWaived
or not.
String indicating the fee waiver reason. It must be
surcharges.waiverReason set if “isWaived” parameter is true.
loyaltyAmount.amount.intValue Amount expressed in Miles

loyaltyAmount.amount.scale amount = 12035
scale = 0
For Amounts expressed in Miles 999 will be used
loyaltyAmount.currencyCode
as currency code
Amount that will be earned/collected expressed in
earnedPoints.amount.intValue
Miles
earnedPoints.amount.scale amount = 12035
scale = 0
For Amounts expressed in Miles 999 will be used
earnedPoints.currencyCode
as currency code

Aerostream Shopping APIs v2.9

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Aerostream Shopping APIs v2.9

Uploaded by

Copyright:

Available Formats

Ancillaries Shopping APIs

Copyright © 2024 JR Technologies

Copyright © 2024 JR Technologies, All Rights Reserved. Page 2 of 105

Copyright © 2024 JR Technologies, All Rights Reserved. Page 3 of 105

 TravelOffersRS and TravelOfferDetailsRS:

Maria 17th August Updated info:

Introduction - Purpose of this Document

Copyright © 2024 JR Technologies, All Rights Reserved. Page 4 of 105

Copyright © 2024 JR Technologies, All Rights Reserved. Page 5 of 105

Copyright © 2024 JR Technologies, All Rights Reserved. Page 6 of 105

Copyright © 2024 JR Technologies, All Rights Reserved. Page 7 of 105

with format YYYY-MM-DD. E.g. 2021-09-08

Copyright © 2024 JR Technologies, All Rights Reserved. Page 8 of 105

payloadAttributes.correlationId * The correlationId as returned by the getTravelOffersRS.

Copyright © 2024 JR Technologies, All Rights Reserved. Page 9 of 105

with format YYYY-MM-DD. E.g. 2021-09-08

TravelOffersRS and TravelOfferDetailsRS

TravelOffersRS Required Description

Copyright © 2024 JR Technologies, All Rights Reserved. Page 10 of 105

the same message

For experiences and cars:

Copyright © 2024 JR Technologies, All Rights Reserved. Page 11 of 105

The price applicability details. Array of items.

For properties, each item represents a different

For cars, only one item will be returned.

Copyright © 2024 JR Technologies, All Rights Reserved. Page 12 of 105

Copyright © 2024 JR Technologies, All Rights Reserved. Page 13 of 105

offers.bundleBreakdown.priceDetail. packageTotalPrice.taxDetails.taxName Name of the tax. E.g. "Local Tax”

Copyright © 2024 JR Technologies, All Rights Reserved. Page 14 of 105

price. The Price is the total price for the group.

For properties, each group represents the

Used only for properties and car hire.

Returned only in the getTravelOfferDetailsRS.

Copyright © 2024 JR Technologies, All Rights Reserved. Page 15 of 105

Used only in the getTravelOfferDetailsRS for

Copyright © 2024 JR Technologies, All Rights Reserved. Page 16 of 105

always contain one single item for ancillaries.

Copyright © 2024 JR Technologies, All Rights Reserved. Page 17 of 105

Used only for cars.

Copyright © 2024 JR Technologies, All Rights Reserved. Page 18 of 105

non-refundable at any time (overwrites

Copyright © 2024 JR Technologies, All Rights Reserved. Page 19 of 105

Copyright © 2024 JR Technologies, All Rights Reserved. Page 20 of 105

Copyright © 2024 JR Technologies, All Rights Reserved. Page 21 of 105

Copyright © 2024 JR Technologies, All Rights Reserved. Page 22 of 105

offers.serviceList.room.attributeList.type Attribute type. Values: {“view”}

Copyright © 2024 JR Technologies, All Rights Reserved. Page 23 of 105

"Smoke Free", "Air Conditioned",

Attribute type, for experiences:

Copyright © 2024 JR Technologies, All Rights Reserved. Page 24 of 105

List of additional info descriptions

Copyright © 2024 JR Technologies, All Rights Reserved. Page 25 of 105

Copyright © 2024 JR Technologies, All Rights Reserved. Page 26 of 105

Specifies whether the booking question must be

Copyright © 2024 JR Technologies, All Rights Reserved. Page 27 of 105

 UNSTRUCTURED (with one DayItem) and

Copyright © 2024 JR Technologies, All Rights Reserved. Page 28 of 105

Used only for experiences in the

Copyright © 2024 JR Technologies, All Rights Reserved. Page 29 of 105

Longitude of this location.

Copyright © 2024 JR Technologies, All Rights Reserved. Page 30 of 105

Copyright © 2024 JR Technologies, All Rights Reserved. Page 31 of 105

Values { "BREAKFAST", "LUNCH", "DINNER",

Copyright © 2024 JR Technologies, All Rights Reserved. Page 32 of 105