按位置或特定 hotelIds. 列表检索酒店的列表。

此方法可用于返回在指定日期范围内具有可订客房的酒店,或返回位于指定位置的所有有效酒店的列表(不含任何可订空房信息)。

此方法支持用多种筛选条件和方法来指定所需位置,从而实现各种不同的前端搜索选项,例如按机场代码或地图上的显示进行搜索。

请求格式
XML/REST URL: GET http://api.ean.com/ean-services/rs/hotel/v3/list?
XML 父元素: <HotelListRequest>

独特协议要求
REST
请求参数
每次搜索可订酒店时,都需要提供最小日期范围、客房计数和成人住客计数以及位置或 hotelId 列表。

要获得“无日期列表”或位于某一位置的所有有效酒店(不含具体的可订空房信息)的列表,只需在请求中忽略 arrivalDatedepartureDateRoomGroup 参数。

基本参数
名称 是否必需 说明
apiExperience 字符串

使用此属性可识别您的请求源。针对您发送的每个请求,从下文提供的集合中选择一个适用的值。

值:
PARTNER_CALL_CENTER - 来自呼叫中心代理的请求
PARTNER_WEBSITE - 来自面向客户网站的请求
PARTNER_MOBILE_WEB - 来自手机格式网站的请求
PARTNER_MOBILE_APP - 来自手机应用程序的请求
PARTNER_BOT_CACHE - 来自缓存 bot 的请求
PARTNER_BOT_REPORTING - 来自报告 bot 的请求
PARTNER_AFFILIATE - 来自作为您自己的联盟伙伴库的 API/平台的请求

arrivalDate 字符串 如需检索可订空房,则为

入住日期,格式为 MM/DD/YYYY。

包括今天的日期以请求当天的可订空房。预订最晚可以到酒店当地时间晚上 11:59(太平洋标准时间和太平洋岛屿时间晚上 9:59)。

departureDate 字符串 如需检索可订空房,则为 退房日期,格式为 MM/DD/YYYY。

最多可搜索该日期往后 500 天内的可订空房。

总住宿天数不能超过 28 晚。
numberOfResults 整型 每个回复返回的酒店数量上限(在需要访问其他结果页之前)。可接受值的范围是 1200。默认:20

不限制数据库列表请求的结果。
RoomGroup 对象 如需检索可订空房,则为 定义住客和客房计数的 Room 数组的容器。对于 REST,请参阅下面的部分。
RoomGroup.Room 数组 如需检索可订空房,则为 Room 节点数定义请求的客房数。每个节点都有自己的成人/儿童住客计数。

酒店规定每次预订的客房不得超过 8 间。
Room.numberOfAdults 整型 如需检索可订空房,则为 客房的成人住客计数。

酒店通常最多招待 4 名住客,多出人员要收加人费。

每间客房最多住 8 名住客,因为大多数酒店都不会超过这个住客数。
Room.numberOfChildren 整型 值 > 0 时为 客房的儿童住客计数。对所有酒店均为必填项。与 childAges 结合使用来确定可订空房及房价。
Room.childAges 逗号分隔
列表或整型数组
儿童计数 > 0 时为 发送客房中各个儿童的年龄,对于 XML 和 REST 采用逗号分隔列表的形式,对于 SOAP 的 childAges,采用各个值形成的数组的形式。

如果有儿童住客,客户必须提供相关信息。如果在预订之前未提供儿童的年龄,可能会收取意料之外的加人费。
includeDetails 布尔型

返回每间客房的取消政策、床型和吸烟喜好(如果可用)。

仅在 minorRev=22 或更高版本中返回其他元素。

includeHotelFeeBreakdown 布尔型 返回元素 HotelFeeBreakdown,其包含 HotelFees 数组的更详细回复结构,包括应用每项费用的频率以及如何应用。在 minorRev=24 或更高版本中提供。
REST 的客房格式
REST 格式将前述元素的值压缩成一个逗号分隔列表。要声明一间客房及其入住人数,请使用以下格式:

&room[room number, starting with 1]=
[number of adults],
[comma-delimited list of children's ages]


例如,要声明一间客房中入住一名成人和两名年龄分别为 5 岁和 12 岁的儿童,可以发送 &room1=1,5,12。对儿童数没有单独的声明 - 每个年龄值都被假设属于一名儿童。


主要搜索方法
有五种主要方法可用于限制请求中返回的酒店选择,具体如下(列出顺序并无特殊含义)。
其中四种方法按定义的位置限制选择,另一种方法允许通过特定的 hotelIds 列表返回一组明确的酒店。
请每次仅使用一种方法。


方法 1:城市/省/自治区/直辖市/国家/地区搜索
名称 对于此方法是否必需 说明
city 字符串
作为搜索范围的城市。仅可使用城市全称。
stateProvinceCode 字符串 对于 US、CA、
AU 为
包含指定城市的州/省的双字符代码。在澳大利亚,您必须使用下面提供的特殊代码。

参考:
美国州代码
加拿大省/领地代码
澳大利亚省/领地代码
  • 澳大利亚首都 - AC
  • 新南威尔士州 - NW
  • 澳北区 - NO
  • 昆士兰 - QL
  • 南澳大利亚 - SA
  • 塔斯马尼亚岛 - TS
  • 维多利亚州 - VC
  • 西澳大利亚州 - WT
countryCode 字符串
指定城市所在国家或地区的双字符 ISO-3166 代码。仅可使用在 ISO-3166 解码表中指定为“正式指定”的国家或地区代码。


方法 2:使用自由文本目的地字符串
名称 对于此方法是否必需 说明
destinationString 字符串 至少包含一个城市名称的字符串。您还可以发送城市和州或省、城市和国家或地区、城市/州或省/国家或地区等。

该参数是获得直接客户输入的最佳选项。

模糊的条目将返回错误,并包含可能的计划位置的列表,其中包括任何可能的 destinationId(参见下文)。


方法 3:使用 destinationId
名称 对于此方法是否必需 说明
destinationId 字符串 特定城市、都市地区或地标的唯一十六进制键值。

通过地理功能请求或从 destinationString 可订空房请求返回的多个位置错误中获取该值。

建筑物、主要周边环境、火车站等地标的值可通过对地标的地理功能请求获得。



方法 4:使用 hotelId 列表
名称 对于此方法是否必需 说明
hotelIdList 逗号分隔的
长整型列表
对固定的一组酒店检查可订空房。以逗号分隔列表的形式发送所需的 hotelId 值。

如果未指定排序顺序,则酒店按 EAN 的默认优化算法进行排序。使用排序选项 NO_SORT 保留列表的顺序。

任何无效 hotelId 值都会以逗号分隔列表的形式返回在回复标题 Invalid-Hotel-Ids 下。

使用长整型列表时,请注意与多个请求中的较小列表相比,回复时间可能会大幅增加。通过 REST 发送长整型列表时,使用 POST 而非 GET。


方法 5:在某个地理区域内搜索
注意:您还可以将此方法与机场坐标文件
相结合来搜索机场
名称 对于此方法是否必需 说明
latitude 字符串 搜索起始点的纬度坐标,采用 DD.MMmmm 格式。
longitude 字符串 搜索起始点的经度坐标,采用 DDD.MMmmm 格式。
searchRadius 整型 确定圆形搜索区域的半径,并使用指定的 latitudelongitude 值确定圆心。
最小值为 1 MI2 KM,最大值为 50 MI80 KM。超过上限的值会在结果返回前自动减小。
默认值为 20 MI
searchRadiusUnit 字符串 设置搜索半径的距离单位。发送
MIKM。如果为空或未包含,则默认值为 MI
sort 字符串 如果希望结果按到起始点的距离进行排序,则必须发送 PROXIMITY 值。否则,默认排序顺序会应用到位于搜索半径内的所有酒店。

请参阅下一部分中对该元素的完整定义,了解所有可用的值。

不为数据库列表请求应用结果。
其他搜索方法
提供以下搜索方法作为次要选项,以便客户通过附近地址或特定酒店进行搜索。


名称 需要其他参数 说明
address 字符串 在当地街道地址附近搜索。回复内容将包含每家酒店与指定地址的接近度。

即使输入了特定酒店的地址,只要它不在默认排序顺序中的顶部,它的位置也不会被替代。

要求定义 citycountryCode 参数。
postalCode 字符串 可选择性地包含地址对应的邮政编码。

要求定义 citycountryCode 参数。
propertyName 字符串 用于搜索可订空房的名称。值可以为确切名称或名称的一部分,例如“Holiday”或“Best”。

回复内容将包含其名称含有该参数包含的值的任何酒店。

如果发送了特定酒店名称,则在指定住宿日期没有可订空房时,返回的回复内容可能为空。

要求定义 citycountryCode 参数。

筛选方法
这些方法通过服务/设施、价格、星级评定和其他常用购物标准来筛选结果。可以在初始搜索之前随主���方法一起提供这些方法,也可将此方法用于动态更新现有的搜索结果页面。还可在内部使用这些方法来限制提供给客户的结果,例如将酒店限制为特定星级以上。

名称 是否必需 说明
includeSurrounding 布尔型 false 发送时,该参数会排除您的搜索参数所定义区域之外的酒店。
如果您想要防止其他附近城市或偏远地区的酒店出现在结果中,请使用该选项。
propertyCategory 整型或整型逗号分隔列表

按酒店类别筛选结果。发送单个值或值列表以返回酒店类别组合。

注意:
这些值与我们静态数据库文件中的分类以及任何其他由 Expedia 提供的数据均不对应。

值:
1:酒店
2:套房
3:度假村
4:度假短租/公寓
5:住宿加早餐酒店
6:全包式

amenities 整型或整型逗号分隔列表

不再建议使用该元素。 该元素的值与 Expedia 的设施或我们自己的设施数据库文件不匹配。

您可以改为使用以下两种方法之一在收到回复后应用设施筛选:

1. 从结果中的 amenityMask 值中解码位掩码以获取每个酒店的各种设施。您可以使用此示例实用工具来检查取消掩码代码:http://sandbox.ean.so/amenity/amenity.php

2. 从本地下载 AttributeList 数据库文件并使用它筛选在请求位置和具有所筛选设施的酒店。

maxStarRating 浮点型 按最高星级筛选结果。
有效的值包括 1.0 - 5.0,以 0.5 为增量。
minStarRating 浮点型 按最低星级筛选结果。
有效的值包括 1.0 - 5.0,以 0.5 为增量。
minRate 浮点型 按房价等于或大于指定值的酒店筛选结果。
针对 averageRate 回复值(住宿日期内各晚房价的平均值)进行搜索。仅对可订空房搜索有效。
maxRate 浮点型 按房价等于或小于指定值的酒店筛选结果。
针对 averageRate 回复值(住宿日期内各晚房价的平均值)进行搜索。仅对可订空房搜索有效。
numberOfBedRooms 整型 该参数仅对公寓/度假短租有效。指定请求的客房数,最大值为 4。
maxRatePlanCount 整型 定义每家酒店返回的房型数。

设置较高的值将尝试在回复内容中返回每家酒店的相应房型数,具体取决于各家酒店的可订空房。

默认值为 1,即仅返回每家酒店的第一个房型。在 Expedia 用户测试过程中,已证明该值可提供最好的转化率,建议将其保留不变,将其他客房保留用于在客房选择阶段进行展示。

排序选项
我们建议发送没有指定排序顺序的初始搜索,因为默认排序顺序经过计算,将最受喜爱且转化率最高的酒店排在顶部。在返回初始列表后,允许客户选择其他排序顺序。
名称 是否必需 说明
sort 字符串 返回酒店的排序偏好。

值:
BUDGET

按盈利能力排序,优先排列处于每个市场价格底端的酒店。它会将具有最高访问预订比的经济型酒店置于顶部。

CHAMPION

按盈利能力排序,优先排列处于每个市场价格中端的酒店。它会将具有最高访问预订比的中端酒店置于顶部。

PREMIUM

按盈利能力排序,优先排列处于每个市场价格顶端的酒店。它会将具有最高访问预订比的高端酒店置于顶部。

HIGH_MARGIN

CHAMPION 排序的基础上,HIGH_MARGIN 排序会更进一步,优先排列利润百分比最大的酒店,确保具有高转化率和利润率的酒店显示于靠近顶部的位置。HIGH_MARGIN 排序会考虑酒店级别的额外费用,优先排列利润百分比高的合作伙伴。

NO_SORT 仅可与 hotelIdList 结合使用。以请求中确切列出的顺序返回酒店。
CITY_VALUE 默认排序顺序,与完全忽略 sort 时相同的顺序返回酒店。指定城市中的酒店排在周围区域的酒店之上。
OVERALL_VALUE 将最受喜爱且转化率最高的酒店排在顶部。
PROMO 将具有促销房价或增值项目的酒店排在未开展促销的酒店之上。
PRICE 按每晚房价从低到高的顺序排序酒店。由于应用到该 API 所访问的酒店列表的业务/市场推广办公室算法的原因,该排序并不是最理想的。在收到结果后,在您自己的代码中可最好地实现准确的价格排序。
PRICE_REVERSE 按每晚房价从高到低的顺序排序酒店。如上所述,预期排序并不是最理想的。
PRICE_AVERAGE 按平均每晚房价从低到高的顺序排序酒店。如上所述,预期排序并不是最理想的。
QUALITY 按酒店星级从高到低的顺序排序酒店。
QUALITY_REVERSE 按酒店星级从低到高的顺序排序酒店。
ALPHA 按字母顺序排序酒店
PROXIMITY 根据与通过 latitudelongitude 参数定义的起始点的接近度进行排序。
POSTAL_CODE 按照邮政编码从较低到较高的顺序进行排序。
TRIP_ADVISOR 如果您有批准的 TripAdvisor 集成,该值将按住客评级从高到低的顺序排序。
其他数据请求

使用此参数可将回复内容限制为特定类型的动态数据。通常与我们的酒店数据库文件结合使用,作为通常由 API 提供的静态信息来源。与仅依靠 API 回复的回复速度相比,将此参数与离线数据库结合使用的集成将使回复速度大大提高。

名称 是否必需 说明
options 字符串或逗号分隔的
字符串列表
定义要返回的受限数据的类型。发送单个值或以逗号分隔列表的形式发送值组合。

值:
DEFAULT 返回以下三种数据类型。如果完全忽略了 options,则回复内容相同。
HOTEL_SUMMARY

返回具有少量标识性静态信息(酒店名称和地址、位置说明、hotelId 等)的动态酒店信息。
不包括动态房价信息。这是可能情况下最精简的可订空房回复内容。

ROOM_RATE_DETAILS 通过 hotelIdroomDescription 返回动态房价信息和最少量的静态信息。
DEEP_LINKS 为仅具有基本静态信息的模板返回深层链接。
分页显示更多酒店

如果初始回复返回的 moreResultsAvailabletrue,可通过以下过程请求下一结果页面。

要分页显示更多结果,只能在后续可订空房请求中发送 supplierTypecacheLocationcacheKey。所有其他非通用参数都必须忽略。

您必须在请求中包含值 supplierType=E。如果不包含该值,当列表用尽时,moreResultsAvailable 可能错误地返回 true

最后,如果返回指明“cacheLocation cannot be found”的错误,则表明缓存已过期,必须重新请求原始搜索。缓存回复内容的生命周期通常为 15-30 分钟。

请参阅分页显示更多结果了解相关示例。


名称 类型 对方法是否必需 说明
supplierType 字符串 必须与值 E 一起发送,以便对系统分页来精确指示其他结果。
cacheKey 字符串 请求的特定缓存回复内容的键。使用上一酒店列表回复中返回的值。
cacheLocation 字符串 定义所请求缓存的 EAN 服务器位置。使用上一酒店列表回复中返回的值。
酒店列表回复
返回位于指定位置且具有符合指定住客计数和住宿日期要求的可订客房的酒店。

如果通过忽略 arrivalDatedepartureDateRoomGroup 请求“无日期列表”,则回复内容包含位于指定位置的所有有效酒店(不含任何具体的可订空房信息)。

回复内容
父元素: HotelListResponse


名称 说明
moreResultsAvailable 布尔型 指示是否有更多酒店结果可供分页。

如果为 true,可通过分页过程获得更多结果。
numberOfRoomsRequested 整型 确认最初请求的客房数(Room 节点数)
cacheKey 字符串 返回的当前回复所对应的缓存的键。在下一分页请求中使用该值。
cacheLocation 字符串 定义所返回当前回复的缓存的 EAN 服务器位置。在下一分页请求中使用该值。
HotelList HotelSummary 数组容器

包含属性 sizeactivePropertyCount,前者用于指示回复中的酒店个体数,后者用于指示位于指定位置的有效(不一定可订)酒店的总数。

HotelList.HotelSummary 对象 个体酒店的数组。每家酒店结果的信息包含在其各自的 HotelSummary 节点中。
包含属性 order,用于指示每家酒店的原始序号,以帮助从动态重新排序中恢复(序列从 0 而不是 1 开始)。
HotelSummary.hotelId 长整型 酒店的 ID。任何后续客房或预订请求中都将使用该 ID。
HotelSummary.name 字符串 酒店名称
HotelSummary.address1 字符串 酒店街道地址
HotelSummary.city 字符串 酒店所在的城市
HotelSummary.stateProvinceCode 字符串 包含指定城市的州/省的双字符代码。仅对 US、CA 和 AU 国家代码返回结果。

参考:
美国州代码
加拿大省/领地代码
澳大利亚省/领地代码
HotelSummary.countryCode 字符串 酒店所在国家或地区的双字符 ISO-3166 代码
HotelSummary.postalCode 字符串 酒店的邮政��码
HotelSummary.airportCode 字符串 与酒店关联的机场代码
HotelSummary.supplierType 字符串 酒店的供应商。该供应商将用于处理下达的任何预订。

值:
E:Expedia Collect
HotelSummary.propertyCategory 字符串 返回酒店的类别。

值:
1:酒店
2:套房
3:度假村
4:度假短租/公寓
5:住宿加早餐酒店
6:全包式
HotelSummary.hotelRating 浮点型 酒店星级 (0-5)。值为 0.0 或为空表示没有星级。
HotelSummary.amenityMask 长整型 查看有关酒店服务/设施掩码的详情
HotelSummary.shortDescription 字符串 酒店输入的简短说明文本。如果条目超过 200 个字符,则会截断。
为获得更好的性能,请将省略号 (…) 添加到该值的末尾,并将其设置为链接到酒店可订空房页面。
HotelSummary.locationDescription 字符串 酒店输入的大体位置,例如“靠近派克市场”
HotelSummary.lowRate 字符串 酒店在最近查询中返回的最低房价。这是统计数字,不一定是当前可订空房的房价。
HotelSummary.highRate 字符串 酒店在最近查询中返回的最高房价。这是统计数字,不一定是当前可订空房的房价。
HotelSummary.rateCurrencyCode 字符串 返回的高房价或低房价的货币代码。
HotelSummary.latitude 浮点型 酒店的纬度坐标。
HotelSummary.longitude 浮点型 酒店的经度坐标。
HotelSummary.proximityDistance 浮点型 酒店到最初指定的起始点坐标(如果使用了该搜索方法)的距离。
HotelSummary.proximityUnit 字符串 proximityDistance 提供的距离的单位:MIKM
HotelSummary.hotelInDestination 布尔型 指示酒店是在最初指定的城市还是在扩展区域,即主要郊区还是其他周边城市。

目的地之外的酒店按离原始区域的距离分组,例如,10 英里以内、20 英里以内等。
HotelSummary.thumbNailUrl 字符串 酒店缩略图(如果提供)的 URL 路径。

不会返回完整 URL,将该值附加在 http://images.travelnow.com 之后,或者通过设置以 origin-images.travelnow.com 为目标的 CNAME 将该值附加在您自己的图像子域之后。支持采用 SSL 的 HTTPS。
字符串 模板上相应酒店页面中的深层链接,创建混合网站时使用。

返回的格式仅与旧模板帐户兼容。如果您拥有 Chameleon 模板帐户,则 URL 将返回错误。请参阅混合网站页面上的深层链接格式指南,创建与您的模板兼容的深层链接。

这些链接也可以通过 CNAME 设置掩码
HotelSummary.RoomRateDetailsList RoomRate
Details
数组容器
仅容器,没有属性。包含所有特定于客房的元素数据。
RoomRateDetailsList.RoomRateDetails 数组 包含酒店返回的第一间客房的详情。如果发送的 maxRatePlanCount 值 >1,则返回其他每间客房的附加说明。
RoomRateDetails.roomTypeCode 字符串 客房的房型代码。
RoomRateDetails.rateCode 字符串 所显示房价的代码。
RoomRateDetails.maxRoomOccupancy 整型 返回客房允许的最大住客数。
RoomRateDetails.quotedRoomOccupancy 整型 确认用于计算房价的实际入住人数。
RoomRateDetails.minGuestAge 整型 客房允许的最小住客年龄
RoomRateDetails.roomDescription 字符串 返回与 roomTypeCode 关联的客房的说明
RoomRateDetails.promoId 字符串 返回促销优惠的 ID(如果有)。在 REST 下,此值以整数形式返回。
RoomRateDetails.promoDescription 字符串 返回促销的说明(如果有)。将最多返回 255 个字符。
RoomRateDetails.promoDetailText 字符串 返回促销的额外详情(如果有)。
RoomRateDetails.currentAllotment 整型 酒店剩余的可订客房数。使用该值可创建紧急消息规则,以提示用户在旅行高峰日期或热门酒店出现可订空房不足的情况。

如果该值返回 0,则表示酒店不缺客房。只是不符合计算该值所需的规则,该值不表示客房绝对可订。
RoomRateDetails.propertyAvailable 布尔型 仅作内部预留房参考。
|仅根据标准请求返回可订预留房。
RoomRateDetails.propertyRestricted 布尔型 仅作内部预留房参考。请参阅取消政策了解任何具体限制。
RoomRateDetails.expediaPropertyId 字符串 Expedia 为酒店指定的 ID。对 Expedia 进行交叉引用时,使用该值映射到 hotelId
RoomRateDetails.BedTypes 数组 各间客房的床型选择。可能返回在预订时包含的单个床型或选择。查看床型详情
minorRev=22 或更高版本中提供。仅当请求中发送了 includeDetails=true 时返回。
RoomRateDetails.smokingPreferences 逗号分隔的字符串列表 客房的可用吸烟偏好(如果有)。

值:
NS:禁止吸烟
S:允许吸烟
E

minorRev=22 或更高版本中提供。仅当请求中发送了 includeDetails=true 时返回。
RoomRateDetails.nonRefundable 布尔型 明确指明在预订后是否可退款。还应在返回的取消政策中指明。
仅针对 minorRev=1019,在此位置中返回。
RoomRateDetails.ValueAdds ValueAdd 的容器 对于指定的客房和房价,包含 ValueAdd 元素(如果可用)的数组。具有 size 属性用于指示返回的增值项目数。
ValueAdds.ValueAdd 数组

包含 description 元素,用于为指定客房和房价提供的免费服务,例如免费早餐或无线上网。

对于 minorRev=2829,不会返回数字 id 属性 – 仅提供 description

对于 minorRev=30,数字 id 属性返回一组与 26 及更低版本返回的值不同的一组值。这两组值都可用于我们的增值参考页面。

RoomRateDetails.RateInfos RateInfo 的容器 包含为各间客房提供详细房价信息的 RateInfo 元素的数组。

如果您使用的是在 minorRev=6 或更早版本上运行的旧集成,返回的 RateInfo 将没有 RateInfos 容器。

RateInfos.RateInfo 对象 包含单个客房在多个不同对象和各个值中的所有房价信息。

属性:
priceBreakdown布尔型 指示是否包含完整价格细分,包括要收取的税和总价。
promo 布尔型 指示返回的房价是否为促销房价。
rateChange 布尔型 指示房价是否至少与住宿期间某一晚的房价不同。
RateInfo.promoId 字符串 返回促销优惠的 ID(如果有)。在低于 minorRev=20RoomRateDetails 中返回
RateInfo.promoDescription 字符串 返回促销的说明(如果有)。将最多返回 255 个字符。在低于 minorRev=20RoomRateDetails 中返回
RateInfo.promoDetailText 字符串 返回促销的额外详情(如果有)。在低于 minorRev=20RoomRateDetails 中返回
RateInfo.currentAllotment 整型 酒店剩余的可订客房数。使用该值可创建紧急消息规则,以提示用户在旅行高峰日期或热门酒店出现可订空房不足的情况。

如果该值返回 0,则表示酒店不缺客房。只是不符合计算该值所需的规则,该值不表示客房绝对可订。
在低于 minorRev=20RoomRateDetails 中返回
RateInfo.cancellationPolicy 字符串 酒店关于此客房的取消政策。必须显示在各个客房页面以及任何预订和预订确认页面上。
minorRev=22 或更高版本中提供。仅当请求中发送了 includeDetails=true 时返回。
RateInfo.CancelPolicyInfoList Cancel
PolicyInfo
的容器
取消政策的详细细节,通常是确定罚款期的时间和对取消收取的罚款。
minorRev=22 或更高版本中提供。仅当请求中发送了 includeDetails=true 时返回。
RateInfo.rateType 字符串 指示返回的房价是通过 EAN 预付还是住宿完成后在酒店支付。对于预付可订空房,返回值 MerchantStandard,对于住宿后支付则不返回任何值。
minorRev=18 或更高版本中提供。在低于 minorRev=20 的回复内容的正文中返回
RateInfo.nonRefundable 布尔型 明确指明在预订后是否可退款。还应在返回的取消政策中指明。
仅随可订空房以及 minorRev=20 和更高版本返回。在低于 minorRev=20RoomRateDetails 中返回
RateInfo.promoType 字符串 指示返回的任何促销是特定于移动设备的促销还是标准促销。对于移动促销返回 Mobile,对于其他所有促销返回 Standard
为了返回移动促销,您必须通过适当的 customerUserAgent 字符串标识您的移动网站或应用程序。
minorRev=21 或更高版本中提供。您必须升级到 minorRev=20 下的模式才能使用此元素。
RateInfo.ChargeableRateInfo 对象 此对象的属性包含要为预订收取的绝对总价以及房价平均值和总计。对象中的节点提供有关各晚房价和附加费的详情。

属性:
total 字符串 要为预订收取的所有每晚房价、税和附加费的总计。这是必须显示给客户的总计值,包含在预订请求中。
surchargeTotal 字符串 Surcharges 数组中 TaxAndServiceFeeExtraPersonFee 的总和。
nightlyRateTotal 字符串 此对象中包含的 nightlyRatesPerRoom 数组中所有值的总和。
maxNightlyRate 字符串 所有返回房价的最高每晚房价
currencyCode 字符串 所返回房价的货币代码
commissionableUsdTotal 字符串 用于计算合作伙伴佣金的金额,以美元为单位。每晚房价总计减去附加费。
averageRate 字符串 应用任何促销值的所有每晚房价的平均值,不含附加费。
averageBaseRate 字符串 未应用任何促销值的所有每晚房价的平均值,不含附加费。如果没有促销,返回的值将与上一值相同。
ChargeableRateInfo.
nightlyRatesPerRoom
数组 NightlyRate 数组的容器。具有 size 属性,用于指示数组中的节点数,这将与请求中的晚数对应。按照住宿日期的顺序相继返回房价。
nightlyRatesPerRoom.
NightlyRate
不适用

提供请求住宿期间一晚的房价。

指示是否存在促销房价、基本房价以及应用促销后的房价(如果适用)。仅包含属性。

对于多间客房请求,该值是所有客房每晚费用的平均值。EAN 建议使用新的每间客房 ChargeableNightlyRates 数组来显示多间客房价格。

对于 minorRev=28 及更低版本的多客房请求,此元素仅提供第一间客房的房价,而不是平均房价。

属性:

promo 布尔型 指示是否为此晚房价应用了促销价。
rate 字符串 应用促销价(如果有)后的每晚房价。
baseRate 字符串 应用促销价(如果有)前的每晚房价。
ChargeableRateInfo.Surcharges 数组 Surcharge 数组的容器。该数组逐个列出各个附加费,这些附加费组成了为 surchargeTotal 返回的值。具有 size 属性,用于指示数组中的节点数。
Surcharges.Surcharge 不适用 详细说明单个附加费的金额和类型。仅包含属性。

属性:
amount 浮点型 特定附加费的金额
type 字符串 附加费的名称。
可能的值:
  • TaxAndServiceFee
  • ExtraPersonFee
  • Tax
  • ServiceFee
  • SalesTax
  • HotelOccupancyTax

只有 TaxAndServiceFeeExtraPersonFee 会加到 surchargeTotal 中。所有其他值都是 TaxAndServiceFee 值的各个组成部分。


注意:SalesTaxHotelOccupancyTax 附加费类型必须按纽约州法律显示。确保您期望并且捕捉这些值,以在最终价格细分中显示为“酒店入住人数和销售税”。
RateInfo.rateType 字符串 指示返回的房价是通过 EAN 预付还是住宿完成后在酒店支付。对于预付可订空房,返回值 MerchantStandard,对于住宿后支付则不返回任何值。
minorRev=18 或更高版本中提供。
RateInfo.HotelFees 数组

该元素细分为酒店收取的某些税费,这些税费不在 Surcharges 数组中另行专门详细说明。

此元素中的所有值由酒店在访客入住或退房时收取。这些不是在预订时收取的任何费用的组成部分。

在填充时,使用此元素满足主要搜索引擎和聚合器要求的房价/税/费用格式。

包含 size 属性,以指示包含的费用数。
minorRev=19 或更高版本中提供。

请注意,子元素 HotelFeeBreakdown 必须专门请求并需要 minorRev=24 或更高版本。

HotelFees.HotelFee 包含用于单项费用的说明、金额和货币的属性。详细说明任何 VAT、州/城市税、度假胜地费或任何其他无法合理避免的收费。
使用由 ChargeableRateInfocurrencyCode 属性指示的可预订货币返回费用。

属性:
description 字符串 收费类型。可能的值:
  • MandatoryFee
  • MandatoryTax
  • ResortFee
amount 字符串 费用的总值。

minorRev=19 或更高版本中提供。

HotelFee.HotelFeeBreakdown 在请求中发送了 includeHotelFeeBreakdown 时返回。详细说明如何应用 HotelFee 中提供的费用以及应用的频率。

注意:所有 HotelFee amount 值均为总计。请不要将它们乘以在此提供的任何 frequency

您可以用 amount 除以 frequency 得出每晚/每日/每周的费用(如果需要)。

minorRev=24 或更高版本中提供。

属性:
unit 字符串 如何分布费用。可能的值:
  • Per Person
  • Per Room
  • Per accommodation
  • Per house
  • Per apartment
  • Per adult
frequency 字符串 费用的频率。可能的值:
  • Per Night
  • Per Day
  • Per Stay
  • Per week
ConvertedRateInfo 对象 转换为客户请求的货币后的房价信息。仅当请求的货币不可用于酒店计费或在客户的市场区域内不可用于计费时返回。包含与 ChargeableRateInfo 相同的属性。
RoomGroup 对象 在请求中发送的 RoomGroup 对象的内容应用到提供的房价时,确认这些内容。

对于 minorRev=29 和更高版本,包含每间客房的每晚房价详细信息。
RoomGroup.Room 数组 确认在原始请求中提供的客房的 numberOfAdultsnumberOfChildrenchildAges 值。
Room.rateKey 字符串 房价和确定房价的参数的键。

每次更改搜索参数时(住客计数更改、变更住宿日期、添加儿童等),必须发送新的请求为该参数获取新值。
Room.ChargeableNightlyRates 数组 客房 NightlyRate 数组的容器。返回的房价具体针对各间客房,并且根据住宿时长按顺序返回。

对于多间客房的平均每晚费用,请使用 nightlyRatesPerRoom 提供的值。

针对 minorRev=29 及更高版本返回。
ChargeableNightlyRates.
NightlyRate
对象 提供请求住宿期间一晚的房价。在此位置内返回时,房价始终特定于包含的 Room

指示是否存在促销房价、基本房价以及应用促销后的房价(如果适用)。仅包含属性。

针对 minorRev=29 及更高版本返回。

属性:
promo 布尔型 指示是否为此晚房价应用了促销价。
rate 字符串 应用促销价(如果有)后的每晚房价。
baseRate 字符串 应用促销价(如果有)前的每晚房价。
ChargeableNightlyRates.
ConvertedNightlyRates
对象 转换为客户请求的货币后的房价信息。仅当请求的货币不可用于酒店计费或在客户的市场区域内不可用于计费时返回。包含与 ChargeableNightyRates 相同的属性。针对 minorRev=29 及更高版本返回。
CachedSupplierResponse


提供缓存的酒店列表回复时,返回 CachedSupplierResponse 元素。

CachedSupplierResponse 元素的属性:
名称 说明
cachedSupplierResponse 对象 包含有关缓存数据的信息,供内部使用。仅随缓存的回复返回。
cacheEntryHitNum 整型 内部
cacheEntryMissNum 整型 内部
cacheEntryExpiredNum 整型 内部
cacheRetrievalTime 长整型 缓存检索时间。
supplierRequestNum 整型 从供应商处请求的结果数
supplierResponseNum 整型 从供应商处返回的结果数
supplierResponseTime 长整型 供应商返回结果的速度
candidatePrepTime 长整型 确定或准备酒店请求列表的时间。
tpidUsed 整型 基于货币或区域设置的内部标识符。
matchedCurrency 布尔型 从缓存返回匹配或转换(推测)的数据。
matchedLocale 布尔型 从缓存返回匹配或转换的数据。
extrapolatedCurrency 布尔型 从缓存返回匹配或转换(推测)的数据。(来自供应商的结果以英语和美元形式进行缓存,在请求时转换为请求的货币和语言)
extrapolatedLocale 布尔型 从缓存返回匹配或转换的数据。