淘宝开放平台 - 文档中心

请求地址：

环境	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。

名称	类型	是否必须	示例值	更多限制	描述
gid	Number	可选	123123		商品gid
rp_id	Number	可选	12312		rp_id
start_row	Number	必须	0		分页参数
page_size	Number	必须	100		分页参数
rp_ids	String	可选	[1,1]		按rpId列表筛选特定商品下的报价，若填写该字段，gid必须有效
start_date	Date	可选	2018-12-01 14:00:00		日历化信息开始时间
end_date	Date	可选	2018-12-01 14:00:00		日历化信息结束时间
need_calendar_info	Boolean	可选	false	默认值：false	是否需要日历化信息

名称	类型	示例值	描述
result	ResultSet		result
└ success String false success └ error_msg String 1 errorMsg └ error_code String 1 errorCode first_result XRateListInfo firstResult rate_list Rate [] rateList └ tag_s_j_y_f Number -10000 tagSJYF └ lock_end_time String 0 lockEndTime └ inventory_type_flag Number 0 inventoryTypeFlag └ exchange_rate Number 0 exchangeRate └ cny_currency Boolean true cnyCurrency └ tag_direct_type Number 0 tagDirectType └ version Number 0 version └ seller_nick String 0 sellerNick └ lock_start_time String 0 lockStartTime └ name String 0 name └ rate_id Number -10000 rateId └ tag_j_s_q_r Number -10000 tagJSQR └ exchange_rate_with_high_precision Number 0 exchangeRateWithHighPrecision └ add_bed Number -10000 addBed └ nod Number 0 nod └ rate_plan_id Number -10000 ratePlanId └ currency_code_name String 0 currencyCodeName └ currency_code Number -10000 currencyCode └ status Number -10000 status └ vendor String 0 vendor └ tag_direct Number 0 tagDirect └ nop Number 0 nop └ operator String 0 operator └ price_deposit Number -10000 priceDeposit └ source Number 0 source └ bottom_price_flag Number 0 bottomPriceFlag └ seller_id Number -10000 sellerId └ gid Number -10000 gid └ add_bed_price Number -10000 addBedPrice └ inventery_price String 0 价格库存对象 inv_price_with_switch_unit_list Invpricewithswitchunitlist [] invPriceWithSwitchUnitList └ quota Number 0 普通库存 └ price Number 0 价格,单位分 └ al_quota Number 0 协议保留房库存 └ date String 0 日期,格式:yyyy-MM-dd └ rate_switch Boolean false 价格开关 └ gen_al_quota Number 0 普通保留房库存 tag_json_list TagJsonUnit [] tagJsonList └ rate_id Number 0 rateId └ tag_json String {"ebk-tail-room-Rate":1} rate 维度下特殊标签含义 json: {"ebk-tail-room-Rate":1}, key:ebk-tail-room-Rate 表示rate维度ebk尾房标

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
XhotelRateBatchGetRequest req = new XhotelRateBatchGetRequest();
req.setGid(123123L);
req.setRpId(12312L);
req.setStartRow(0L);
req.setPageSize(100L);
req.setRpIds("[1,1]");
req.setStartDate(StringUtils.parseDateTime("2018-12-01 14:00:00"));
req.setEndDate(StringUtils.parseDateTime("2018-12-01 14:00:00"));
req.setNeedCalendarInfo(false);
XhotelRateBatchGetResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
XhotelRateBatchGetRequest req = new XhotelRateBatchGetRequest();
req.Gid = 123123L;
req.RpId = 12312L;
req.StartRow = 0L;
req.PageSize = 100L;
req.RpIds = "[1,1]";
req.StartDate = DateTime.Parse("2018-12-01 14:00:00");
req.EndDate = DateTime.Parse("2018-12-01 14:00:00");
req.NeedCalendarInfo = false;
XhotelRateBatchGetResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new XhotelRateBatchGetRequest;
$req->setGid("123123");
$req->setRpId("12312");
$req->setStartRow("0");
$req->setPageSize("100");
$req->setRpIds("[1,1]");
$req->setStartDate("2018-12-01 14:00:00");
$req->setEndDate("2018-12-01 14:00:00");
$req->setNeedCalendarInfo("false");
$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.rate.batch.get' \
-d 'partner_id=apidoc' \
-d 'session=bd5608c8-270d-4339-9b5f-fd46054e3d2b' \
-d 'sign=ED2F5510D5F1F8375C9085ACD200F1C7' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-06+18%3A17%3A20' \
-d 'v=2.0' \
-d 'end_date=2018-12-01+14%3A00%3A00' \
-d 'gid=123123' \
-d 'need_calendar_info=false' \
-d 'page_size=100' \
-d 'rp_id=12312' \
-d 'rp_ids=1%2C1' \
-d 'start_date=2018-12-01+14%3A00%3A00' \
-d 'start_row=0'

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

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

req.gid=123123
req.rp_id=12312
req.start_row=0
req.page_size=100
req.rp_ids="[1,1]"
req.start_date="2018-12-01 14:00:00"
req.end_date="2018-12-01 14:00:00"
req.need_calendar_info=false
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.rate.batch.get");
add_param(pRequest,"gid","123123");
add_param(pRequest,"rp_id","12312");
add_param(pRequest,"start_row","0");
add_param(pRequest,"page_size","100");
add_param(pRequest,"rp_ids","1,1");
add_param(pRequest,"start_date","2018-12-01 14:00:00");
add_param(pRequest,"end_date","2018-12-01 14:00:00");
add_param(pRequest,"need_calendar_info","false");
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.rate.batch.get', {
	'gid':'123123',
	'rp_id':'12312',
	'start_row':'0',
	'page_size':'100',
	'rp_ids':'1,1',
	'start_date':'2018-12-01 14:00:00',
	'end_date':'2018-12-01 14:00:00',
	'need_calendar_info':'false'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<xhotel_rate_batch_get_response>
    <result>
        <success>false</success>
        <error_msg>1</error_msg>
        <error_code>1</error_code>
        <first_result>
            <rate_list>
                <rate>
                    <tag_s_j_y_f>-10000</tag_s_j_y_f>
                    <lock_end_time>0</lock_end_time>
                    <inventory_type_flag>0</inventory_type_flag>
                    <exchange_rate>0</exchange_rate>
                    <cny_currency>true</cny_currency>
                    <tag_direct_type>0</tag_direct_type>
                    <version>0</version>
                    <seller_nick>0</seller_nick>
                    <lock_start_time>0</lock_start_time>
                    <name>0</name>
                    <rate_id>-10000</rate_id>
                    <tag_j_s_q_r>-10000</tag_j_s_q_r>
                    <exchange_rate_with_high_precision>0</exchange_rate_with_high_precision>
                    <add_bed>-10000</add_bed>
                    <nod>0</nod>
                    <rate_plan_id>-10000</rate_plan_id>
                    <currency_code_name>0</currency_code_name>
                    <currency_code>-10000</currency_code>
                    <status>-10000</status>
                    <vendor>0</vendor>
                    <tag_direct>0</tag_direct>
                    <nop>0</nop>
                    <operator>0</operator>
                    <price_deposit>-10000</price_deposit>
                    <source>0</source>
                    <bottom_price_flag>0</bottom_price_flag>
                    <seller_id>-10000</seller_id>
                    <gid>-10000</gid>
                    <add_bed_price>-10000</add_bed_price>
                    <inventery_price>0</inventery_price>
                    <inv_price_with_switch_unit_list>
                        <invpricewithswitchunitlist>
                            <quota>0</quota>
                            <price>0</price>
                            <al_quota>0</al_quota>
                            <date>0</date>
                            <rate_switch>false</rate_switch>
                            <gen_al_quota>0</gen_al_quota>
                        </invpricewithswitchunitlist>
                    </inv_price_with_switch_unit_list>
                </rate>
            </rate_list>
            <tag_json_list>
                <tag_json_unit>
                    <rate_id>0</rate_id>
                    <tag_json>{&quot;ebk-tail-room-Rate&quot;:1}</tag_json>
                </tag_json_unit>
            </tag_json_list>
        </first_result>
    </result>
</xhotel_rate_batch_get_response>

{
    "xhotel_rate_batch_get_response":{
        "result":{
            "success":"false",
            "error_msg":"1",
            "error_code":"1",
            "first_result":{
                "rate_list":{
                    "rate":[
                        {
                            "tag_s_j_y_f":-10000,
                            "lock_end_time":"0",
                            "inventory_type_flag":0,
                            "exchange_rate":0,
                            "cny_currency":true,
                            "tag_direct_type":0,
                            "version":0,
                            "seller_nick":"0",
                            "lock_start_time":"0",
                            "name":"0",
                            "rate_id":-10000,
                            "tag_j_s_q_r":-10000,
                            "exchange_rate_with_high_precision":0,
                            "add_bed":-10000,
                            "nod":0,
                            "rate_plan_id":-10000,
                            "currency_code_name":"0",
                            "currency_code":-10000,
                            "status":-10000,
                            "vendor":"0",
                            "tag_direct":0,
                            "nop":0,
                            "operator":"0",
                            "price_deposit":-10000,
                            "source":0,
                            "bottom_price_flag":0,
                            "seller_id":-10000,
                            "gid":-10000,
                            "add_bed_price":-10000,
                            "inventery_price":"0",
                            "inv_price_with_switch_unit_list":{
                                "invpricewithswitchunitlist":[
                                    {
                                        "quota":0,
                                        "price":0,
                                        "al_quota":0,
                                        "date":"0",
                                        "rate_switch":false,
                                        "gen_al_quota":0
                                    }
                                ]
                            }
                        }
                    ]
                },
                "tag_json_list":{
                    "tag_json_unit":[
                        {
                            "rate_id":0,
                            "tag_json":"{\"ebk-tail-room-Rate\":1}"
                        }
                    ]
                }
            }
        }
    }
}

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.rate.batch.get (查询Rate列表)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ