淘宝开放平台 - 文档中心

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://gw.api.taobao.com/router/rest	https://eco.taobao.com/router/rest

公共请求参数：

名称	类型	是否必须	描述
method	String	是	API接口名称。
app_key	String	是	TOP分配给应用的AppKey。
target_app_key	String	否	被调用的目标AppKey，仅当被调用的API为第三方ISV提供时有效。
sign_method	String	是	签名的摘要算法，可选值为：hmac，md5。
sign	String	是	API输入参数签名结果，签名算法介绍请点击这里。
session	String	否	用户登录授权成功后，TOP颁发给应用的授权信息，详细介绍请点击这里。当此API的标签上注明：“需要授权”，则此参数必传；“不需要授权”，则此参数不需要传；“可选授权”，则此参数为可选。
timestamp	String	是	时间戳，格式为yyyy-MM-dd HH:mm:ss，时区为GMT+8，例如：2015-01-01 12:00:00。淘宝API服务端允许客户端请求最大时间误差为10分钟。
format	String	否	响应格式。默认为xml格式，可选值：xml，json。
v	String	是	API协议版本，可选值：2.0。
partner_id	String	否	合作伙伴身份标识。
simplify	Boolean	否	是否采用精简JSON返回格式，仅当format=json时有效，默认值为：false。

名称	类型	是否必须	示例值	描述
hid	Number	可选	213	酒店hid
rp_code	String	可选	aliebk	RP code
vendor	String	可选	taobao	vendor
rp_id_list	String	可选	122,1231	rpid逗号分隔
pack_room_flag	Number	可选	0	是否是包房RP
bottom_price_flag	Number	可选	0	是否是加价RP
pay_type	Number	可选	6	支付类型
page_no	Number	必须	1	分页参数
page_size	Number	必须	111	分页参数 pageSize
gid	Number	可选	1	酒店商品id
start_date	Date	可选	2018-09-09 00:00:00	日历化信息开始时间
end_date	Date	可选	2018-09-09 00:00:00	日历化信息结束时间

名称	类型	示例值	描述
result	ResultSet		result
└ error_code String 0 errorCode └ error_msg String 0 errorMsg └ success Boolean false success result_list XRatePlan [] RP 列表 └ fee_service_amount Number 0 额外服务-服务费-金额（1-9999） └ rp_type String 0 rateplan类型 1为小时房 └ parent_rpid Number 0 父rpid，使用场景：当一个rp发布变价rate的时候，记录父rp信息，用于下单时候传递约定的rpcode给外部 └ end_time String 0 每日生效结束时间（仅时分秒有效） └ start_time String 0 每日生效开始时间（仅时分秒有效） └ can_checkin_end String 0 可入住的最晚时间（小时房相关字段） └ pack_room_flag Number 0 是否包房RP 1包房RP,0 非包房rp └ cal_breakfast String [{"data":"{\"breakfastCount\":2}","ds":"2016-06-15","de":"2016-08-31","t":"BREAKFAST"},{"data":"{\"breakfastCount\":0}","ds":"2016-09-01","de":"2016-09-10","t":"BREAKFAST"}] 早餐日历,压缩成的多个日期区间，json格式: [{"data":"{\"breakfastCount\":2}","ds":"2016-06-15","de":"2016-08-31","t":"BREAKFAST"},{"data":"{\"breakfastCount\":0}","ds":"2016-09-01","de":"2016-09-10","t":"BREAKFAST"}] t:表示日历单元类型 data: 表示日历化单元的数据 ds: 表示起始日期 de: 表示终止日期 data.breakfastCount: 早餐数 └ min_days Number 0 最小入住天数（1-365） └ start_time_daily String 0 每日生效开始时间（仅时分秒有效） └ status Number 0 价格计划状态 └ fee_breakfast_amount Number 0 额外提供早餐价格，与feeBreakfastCount对应。如果feeBreakfastCount=2表示2分的价格，依次类推。 └ first_stay Number 0 是否新用户首晚入住专享rp。0-否、1-是。 └ english_name String 0 RP的英文名称 └ fee_breakfast_count Number 0 额外提供早餐最小数量，通常是1。 └ is_student Number 0 是否为学生价, 默认为false └ max_adv_hours Number 0 最大提前预订小时 └ min_amount Number 0 首日入住房间数（1-99）【废弃】 └ bottom_price_flag Number 0 是否底价加价，1是底价加价,0 非底价加价rp └ guarantee_start_time String 0 每日开始担保时间（仅时分秒有效） └ tag_json String 0 rp维度特殊标签含义 json: {"non-direct-RP":1,"super-could-price-change-RP":0,"base-could-derived-RP":1,"ebk-tail-room-RP":0} key的含义: non-direct-RP 表示非直连RP, super-could-price-change-RP 表示rp的super标，打上这个tag，表明这个rateplan下单的时候支持变价，商家系统直接放开价格校验。base-could-derived-RP 表示base rateplan标签，打上了这个tag，表明这是一个base的rateplan，基于该rateplan可以衍生出子rateplan. ebk-tail-room-RP 表示 ebk尾房rate plan级别标 └ fee_gov_tax_percent Number 0 额外服务-政府税-百分比（1%-99%） └ invoice_content String {"type":1;"desc":""} rp维度的发票信息, type:1.酒店提供发票；2.卖家提供发票, desc:发票描叙，比如：卖家包邮提供发票, 格式为：{"type":1;"desc":""} └ member_level String 0 会员等级，可以有多个值，逗号分隔。A-集团差旅 └ cancel_policy String 0 退订政策 └ fee_gov_tax_amount Number 0 额外服务-政府税-金额（1-9999） └ allotment_release_time String 0 协议保留房提前x小时自动确认时间 └ extend_fee String 0 额外费用扩展字段，是一段JSON └ breakfast_count Number 0 早餐（0：不含早，1：含单早，2：含双早，N：含N早（1-99可选）） └ cal_guarantee String [{"t":"GUARANTEE","data":"{\"guaranteeType\":1,\"guaranteeStartTime\":\"18:00\"}","ds":"2017-08-28","de":"2017-11-26"}] 担保日历,压缩成的多个日期区间，Json格式: [{"t":"GUARANTEE","data":"{\"guaranteeType\":1,\"guaranteeStartTime\":\"18:00\"}","ds":"2017-08-28","de":"2017-11-26"}] t:表示日历单元类型 data: 表示日历化单元的数据 data.guaranteeType:表示担保类型 data.guaranteeStartTime 担保时间 ds: 表示起始日期 de: 表示终止日期 └ max_days Number 0 最大入住天数（1-365） └ name String 0 RP的名称 └ cal_change_rule String [{"t":"CANCEL","data":"{\"cancelPolicyType\":5,\"policyInfo\":{\"timeBefore\":6}}","ds":"2017-08-28","de":"2017-11-26"}] 取消日历,压缩成的多个日期区间，json格式: [{"t":"CANCEL","data":"{\"cancelPolicyType\":5,\"policyInfo\":{\"timeBefore\":6}}","ds":"2017-08-28","de":"2017-11-26"}] t:表示日历单元类型 data: 表示日历化单元的数据 ds: 表示起始日期 de: 表示终止日期 data.cancelPolicyType: 取消类型 data.policyInfo: 取消政策信息 └ fee_service_percent Number 0 额外服务-服务费-百分比（1%-99%） └ gmt_effective String 0 gmtEffective └ occupancy Number 0 入住人数（如agoda对于不同入住人数价格不一样） └ min_adv_hours Number 0 最小提前预订小时 └ guarantee_mode Number 0 担保实体类型 1.pci担保 └ rate_plan_id Number 0 ratePlanId └ created_time String 0 创建时间 └ extend String 0 扩展字段 └ payment_type Number 0 支付类型（1：预付，5：面付） └ modified_time String 0 modifiedTime └ agreement Number 0 是否协议价。1-是。 └ sell_gid Number 0 sellGid └ rate_plan_code String 0 卖家自己系统的Code └ guarantee_type Number 0 担保类型 └ source Number 0 source └ end_time_daily String 0 endTimeDaily └ gmt_deadline String 0 gmtDeadline └ hourage String 0 hourage └ common_allot_release_time String 0 普通保留房提前x小时自动确认时间 └ extend_info2 String 0 extendInfo2 └ can_checkin_start String 0 可入住的最早时间（小时房相关字段） └ extend_info3 String 0 extendInfo3 └ channel String 0 销售渠道。如需开通，需要申请权限。目前支持的渠道有 H:飞猪全渠道（选择H，可实现飞猪、高德、支付宝、手淘均可售卖） O:钉钉商旅。如果有多个用","分开，比如H,O。如果需要投放其他渠道，请联系飞猪运营或者技术支持。 └ extend_info1 String 0 extendInfo1 └ company_assist Number 1 是否企业托管RP 0-普通rp,1-企业托管rp └ hotel_company_mapping_d_o_s String [] 酒店-企业-rp映射实体集合json格式 └ can_checkout_end String 0 可离店的最晚时间（小时房相关字段） └ activity_type String 4 活动类型。1: 99梦想券通兑活动, 2: 99梦想券大秒活动, 3:尾房, 4:超级房券

JAVA
.NET
PHP
CURL
Python
C/C++
NodeJS

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
XhotelRateplanBatchGetRequest req = new XhotelRateplanBatchGetRequest();
req.setHid(213L);
req.setRpCode("aliebk");
req.setVendor("taobao");
req.setRpIdList("122,1231");
req.setPackRoomFlag(0L);
req.setBottomPriceFlag(0L);
req.setPayType(6L);
req.setPageNo(1L);
req.setPageSize(111L);
req.setGid(1L);
req.setStartDate(StringUtils.parseDateTime("2018-09-09 00:00:00"));
req.setEndDate(StringUtils.parseDateTime("2018-09-09 00:00:00"));
XhotelRateplanBatchGetResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
XhotelRateplanBatchGetRequest req = new XhotelRateplanBatchGetRequest();
req.Hid = 213L;
req.RpCode = "aliebk";
req.Vendor = "taobao";
req.RpIdList = "122,1231";
req.PackRoomFlag = 0L;
req.BottomPriceFlag = 0L;
req.PayType = 6L;
req.PageNo = 1L;
req.PageSize = 111L;
req.Gid = 1L;
req.StartDate = DateTime.Parse("2018-09-09 00:00:00");
req.EndDate = DateTime.Parse("2018-09-09 00:00:00");
XhotelRateplanBatchGetResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new XhotelRateplanBatchGetRequest;
$req->setHid("213");
$req->setRpCode("aliebk");
$req->setVendor("taobao");
$req->setRpIdList("122,1231");
$req->setPackRoomFlag("0");
$req->setBottomPriceFlag("0");
$req->setPayType("6");
$req->setPageNo("1");
$req->setPageSize("111");
$req->setGid("1");
$req->setStartDate("2018-09-09 00:00:00");
$req->setEndDate("2018-09-09 00:00:00");
$resp = $c->execute($req, $sessionKey);

curl -X POST 'http://gw.api.taobao.com/router/rest' \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'app_key=12129701' \
-d 'format=json' \
-d 'method=taobao.xhotel.rateplan.batch.get' \
-d 'partner_id=apidoc' \
-d 'session=39396b9d-924a-437e-8640-27de0ada09aa' \
-d 'sign=9A56689A55CB2EA0480BBBBCA6700DFD' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-06+19%3A28%3A18' \
-d 'v=2.0' \
-d 'bottom_price_flag=0' \
-d 'end_date=2018-09-09+00%3A00%3A00' \
-d 'gid=1' \
-d 'hid=213' \
-d 'pack_room_flag=0' \
-d 'page_no=1' \
-d 'page_size=111' \
-d 'pay_type=6' \
-d 'rp_code=aliebk' \
-d 'rp_id_list=122%2C1231' \
-d 'start_date=2018-09-09+00%3A00%3A00' \
-d 'vendor=taobao'

# -*- coding: utf-8 -*-
import top.api

req=top.api.XhotelRateplanBatchGetRequest(url,port)
req.set_app_info(top.appinfo(appkey,secret))

req.hid=213
req.rp_code="aliebk"
req.vendor="taobao"
req.rp_id_list="122,1231"
req.pack_room_flag=0
req.bottom_price_flag=0
req.pay_type=6
req.page_no=1
req.page_size=111
req.gid=1
req.start_date="2018-09-09 00:00:00"
req.end_date="2018-09-09 00:00:00"
try:
	resp= req.getResponse(sessionkey)
	print(resp)
except Exception,e:
	print(e)

pTopRequest pRequest = alloc_top_request();
pTopResponse pResponse = NULL;
pTaobaoClient pClient = alloc_taobao_client(url, appkey, appsecret);
set_api_name(pRequest,"taobao.xhotel.rateplan.batch.get");
add_param(pRequest,"hid","213");
add_param(pRequest,"rp_code","aliebk");
add_param(pRequest,"vendor","taobao");
add_param(pRequest,"rp_id_list","122,1231");
add_param(pRequest,"pack_room_flag","0");
add_param(pRequest,"bottom_price_flag","0");
add_param(pRequest,"pay_type","6");
add_param(pRequest,"page_no","1");
add_param(pRequest,"page_size","111");
add_param(pRequest,"gid","1");
add_param(pRequest,"start_date","2018-09-09 00:00:00");
add_param(pRequest,"end_date","2018-09-09 00:00:00");
pResponse = top_execute(pClient,pRequest,sessionKey);
printf("ret code:%d\n",pResponse->code);
if(pResponse->code == 0){
	pTopResponseIterator ite = init_response_iterator(pResponse);
	pResultItem pResultItem = alloc_result_item();
	while(parseNext(ite, pResultItem) == 0){
		printf("%s:%s\n",pResultItem->key,pResultItem->value);
	}
	destroy_response_iterator(ite);
	destroy_result_item(pResultItem);
}
destroy_top_request(pRequest);
destroy_top_response(pResponse);
destroy_taobao_client(pClient);

TopClient = require('./topClient').TopClient;
var client = new TopClient({
	'appkey': 'appkey',
	'appsecret': 'secret',
	'REST_URL': 'http://gw.api.taobao.com/router/rest'
});

client.execute('taobao.xhotel.rateplan.batch.get', {
	'hid':'213',
	'rp_code':'aliebk',
	'vendor':'taobao',
	'rp_id_list':'122,1231',
	'pack_room_flag':'0',
	'bottom_price_flag':'0',
	'pay_type':'6',
	'page_no':'1',
	'page_size':'111',
	'gid':'1',
	'start_date':'2018-09-09 00:00:00',
	'end_date':'2018-09-09 00:00:00'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<xhotel_rateplan_batch_get_response>
    <result>
        <error_code>0</error_code>
        <error_msg>0</error_msg>
        <success>false</success>
        <result_list>
            <x_rate_plan>
                <fee_service_amount>0</fee_service_amount>
                <rp_type>0</rp_type>
                <parent_rpid>0</parent_rpid>
                <end_time>0</end_time>
                <start_time>0</start_time>
                <can_checkin_end>0</can_checkin_end>
                <pack_room_flag>0</pack_room_flag>
                <cal_breakfast>[{&quot;data&quot;:&quot;{\&quot;breakfastCount\&quot;:2}&quot;,&quot;ds&quot;:&quot;2016-06-15&quot;,&quot;de&quot;:&quot;2016-08-31&quot;,&quot;t&quot;:&quot;BREAKFAST&quot;},{&quot;data&quot;:&quot;{\&quot;breakfastCount\&quot;:0}&quot;,&quot;ds&quot;:&quot;2016-09-01&quot;,&quot;de&quot;:&quot;2016-09-10&quot;,&quot;t&quot;:&quot;BREAKFAST&quot;}]</cal_breakfast>
                <min_days>0</min_days>
                <start_time_daily>0</start_time_daily>
                <status>0</status>
                <fee_breakfast_amount>0</fee_breakfast_amount>
                <first_stay>0</first_stay>
                <english_name>0</english_name>
                <fee_breakfast_count>0</fee_breakfast_count>
                <is_student>0</is_student>
                <max_adv_hours>0</max_adv_hours>
                <min_amount>0</min_amount>
                <bottom_price_flag>0</bottom_price_flag>
                <guarantee_start_time>0</guarantee_start_time>
                <tag_json>0</tag_json>
                <fee_gov_tax_percent>0</fee_gov_tax_percent>
                <invoice_content>{&quot;type&quot;:1;&quot;desc&quot;:&quot;&quot;}</invoice_content>
                <member_level>0</member_level>
                <cancel_policy>0</cancel_policy>
                <fee_gov_tax_amount>0</fee_gov_tax_amount>
                <allotment_release_time>0</allotment_release_time>
                <extend_fee>0</extend_fee>
                <breakfast_count>0</breakfast_count>
                <cal_guarantee>[{&quot;t&quot;:&quot;GUARANTEE&quot;,&quot;data&quot;:&quot;{\&quot;guaranteeType\&quot;:1,\&quot;guaranteeStartTime\&quot;:\&quot;18:00\&quot;}&quot;,&quot;ds&quot;:&quot;2017-08-28&quot;,&quot;de&quot;:&quot;2017-11-26&quot;}]</cal_guarantee>
                <max_days>0</max_days>
                <name>0</name>
                <cal_change_rule>[{&quot;t&quot;:&quot;CANCEL&quot;,&quot;data&quot;:&quot;{\&quot;cancelPolicyType\&quot;:5,\&quot;policyInfo\&quot;:{\&quot;timeBefore\&quot;:6}}&quot;,&quot;ds&quot;:&quot;2017-08-28&quot;,&quot;de&quot;:&quot;2017-11-26&quot;}]</cal_change_rule>
                <fee_service_percent>0</fee_service_percent>
                <gmt_effective>0</gmt_effective>
                <occupancy>0</occupancy>
                <min_adv_hours>0</min_adv_hours>
                <guarantee_mode>0</guarantee_mode>
                <rate_plan_id>0</rate_plan_id>
                <created_time>0</created_time>
                <extend>0</extend>
                <payment_type>0</payment_type>
                <modified_time>0</modified_time>
                <agreement>0</agreement>
                <sell_gid>0</sell_gid>
                <rate_plan_code>0</rate_plan_code>
                <guarantee_type>0</guarantee_type>
                <source>0</source>
                <end_time_daily>0</end_time_daily>
                <gmt_deadline>0</gmt_deadline>
                <hourage>0</hourage>
                <common_allot_release_time>0</common_allot_release_time>
                <extend_info2>0</extend_info2>
                <can_checkin_start>0</can_checkin_start>
                <extend_info3>0</extend_info3>
                <channel>0</channel>
                <extend_info1>0</extend_info1>
                <company_assist>1</company_assist>
                <hotel_company_mapping_d_o_s>[]</hotel_company_mapping_d_o_s>
                <can_checkout_end>0</can_checkout_end>
                <activity_type>4</activity_type>
            </x_rate_plan>
        </result_list>
    </result>
</xhotel_rateplan_batch_get_response>

{
    "xhotel_rateplan_batch_get_response":{
        "result":{
            "error_code":"0",
            "error_msg":"0",
            "success":false,
            "result_list":{
                "x_rate_plan":[
                    {
                        "fee_service_amount":0,
                        "rp_type":"0",
                        "parent_rpid":0,
                        "end_time":"0",
                        "start_time":"0",
                        "can_checkin_end":"0",
                        "pack_room_flag":0,
                        "cal_breakfast":"[{\"data\":\"{\\\"breakfastCount\\\":2}\",\"ds\":\"2016-06-15\",\"de\":\"2016-08-31\",\"t\":\"BREAKFAST\"},{\"data\":\"{\\\"breakfastCount\\\":0}\",\"ds\":\"2016-09-01\",\"de\":\"2016-09-10\",\"t\":\"BREAKFAST\"}]",
                        "min_days":0,
                        "start_time_daily":"0",
                        "status":0,
                        "fee_breakfast_amount":0,
                        "first_stay":0,
                        "english_name":"0",
                        "fee_breakfast_count":0,
                        "is_student":0,
                        "max_adv_hours":0,
                        "min_amount":0,
                        "bottom_price_flag":0,
                        "guarantee_start_time":"0",
                        "tag_json":"0",
                        "fee_gov_tax_percent":0,
                        "invoice_content":"{\"type\":1;\"desc\":\"\"}",
                        "member_level":"0",
                        "cancel_policy":"0",
                        "fee_gov_tax_amount":0,
                        "allotment_release_time":"0",
                        "extend_fee":"0",
                        "breakfast_count":0,
                        "cal_guarantee":"[{\"t\":\"GUARANTEE\",\"data\":\"{\\\"guaranteeType\\\":1,\\\"guaranteeStartTime\\\":\\\"18:00\\\"}\",\"ds\":\"2017-08-28\",\"de\":\"2017-11-26\"}]",
                        "max_days":0,
                        "name":"0",
                        "cal_change_rule":"[{\"t\":\"CANCEL\",\"data\":\"{\\\"cancelPolicyType\\\":5,\\\"policyInfo\\\":{\\\"timeBefore\\\":6}}\",\"ds\":\"2017-08-28\",\"de\":\"2017-11-26\"}]",
                        "fee_service_percent":0,
                        "gmt_effective":"0",
                        "occupancy":0,
                        "min_adv_hours":0,
                        "guarantee_mode":0,
                        "rate_plan_id":0,
                        "created_time":"0",
                        "extend":"0",
                        "payment_type":0,
                        "modified_time":"0",
                        "agreement":0,
                        "sell_gid":0,
                        "rate_plan_code":"0",
                        "guarantee_type":0,
                        "source":0,
                        "end_time_daily":"0",
                        "gmt_deadline":"0",
                        "hourage":"0",
                        "common_allot_release_time":"0",
                        "extend_info2":"0",
                        "can_checkin_start":"0",
                        "extend_info3":"0",
                        "channel":"0",
                        "extend_info1":"0",
                        "company_assist":1,
                        "hotel_company_mapping_d_o_s":"[]",
                        "can_checkout_end":"0",
                        "activity_type":"4"
                    }
                ]
            }
        }
    }
}

XML示例
JSON示例

<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

{
	"error_response":{
		"msg":"Remote service error",
		"code":50,
		"sub_msg":"非法参数",
		"sub_code":"isv.invalid-parameter"
	}
}

错误码	错误描述	解决方案

API测试工具错误码查询工具 SDK下载

开放平台

EBK上云API

taobao.xhotel.rateplan.batch.get (RP列表查询)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ