淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
operator	String	必须	XXX小二		操作人
rate_list_inv_info	String	必须	[{"rateId":1234,"useRoomInv":1,"invAndSwitch":[{"date":"yyyy-MM-dd","price":1200,"quota":23,"genAlQuota":44,"alQuota":32,"rateStatus":1},{"date":"yyyy-MM-dd","price":1200,"quota":23,"genAlQuota":4,"alQuota":32,"rateStatus":0}]},{"rateId":4321,"useRoomInv":0,"invAndSwitch":[{"date":"yyyy-MM-dd","price":1200,"quota":23,"alQuota":32,"genAlQuota":41,"rateStatus":1},{"date":"yyyy-MM-dd","price":1200,"quota":23,"genAlQuota":1,"alQuota":32,"rateStatus":1}]}]		json格式: [{"rateId":1234,"useRoomInv":1,"invAndSwitch":[{"date":"yyyy-MM-dd","price":1200,"quota":23,"genAlQuota":44,"alQuota":32,"rateStatus":1},{"date":"yyyy-MM-dd","price":1200,"quota":23,"genAlQuota":4,"alQuota":32,"rateStatus":0}]},{"rateId":4321,"useRoomInv":0,"invAndSwitch":[{"date":"yyyy-MM-dd","price":1200,"quota":23,"alQuota":32,"genAlQuota":41,"rateStatus":1},{"date":"yyyy-MM-dd","price":1200,"quota":23,"genAlQuota":1,"alQuota":32,"rateStatus":1}]}] rateId: 表示 rateId,必传字段 useRoomInv: 表示是否使用房型库存(1表示是,0表示否),可选字段 invAndSwitch: 表示要更新的日历化价格库存以及开关,增量更新,更新哪天就传那天的日历化单元, 可选字段 invAndSwitch.date: 表示日历化单元里的日期,格式:yyyy-MM-dd, 在 invAndSwitch 里的每个日历化单元里是必填字段 invAndSwitch.price: 表示要更新的价格,单位分, 可选字段 invAndSwitch.quota: 表示要更新的普通库存,可选字段 invAndSwitch.genAlQuota: 表示要更新的普通保留房库存,可选字段 invAndSwitch.alQuota: 表示要更新的协议保留房库存,可选字段 invAndSwitch.rateStatus: 表示要更新的价格开关,1表示开,0表示关,可选字段

名称	类型	示例值	描述
result	ResultSet		result
└ first_result String {12343:true,432:"更新失败"} 多个rate的更新结果 └ error_code String 0 errorCode └ error_msg String 0 errorMsg └ success Boolean true success

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
XhotelRatesIncrementUpdateRequest req = new XhotelRatesIncrementUpdateRequest();
req.setOperator("XXX小二");
req.setRateListInvInfo("[{\"rateId\":1234,\"useRoomInv\":1,\"invAndSwitch\":[{\"date\":\"yyyy-MM-dd\",\"price\":1200,\"quota\":23,\"genAlQuota\":44,\"alQuota\":32,\"rateStatus\":1},{\"date\":\"yyyy-MM-dd\",\"price\":1200,\"quota\":23,\"genAlQuota\":4,\"alQuota\":32,\"rateStatus\":0}]},{\"rateId\":4321,\"useRoomInv\":0,\"invAndSwitch\":[{\"date\":\"yyyy-MM-dd\",\"price\":1200,\"quota\":23,\"alQuota\":32,\"genAlQuota\":41,\"rateStatus\":1},{\"date\":\"yyyy-MM-dd\",\"price\":1200,\"quota\":23,\"genAlQuota\":1,\"alQuota\":32,\"rateStatus\":1}]}]");
XhotelRatesIncrementUpdateResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
XhotelRatesIncrementUpdateRequest req = new XhotelRatesIncrementUpdateRequest();
req.Operator = "XXX小二";
req.RateListInvInfo = "[{\"rateId\":1234,\"useRoomInv\":1,\"invAndSwitch\":[{\"date\":\"yyyy-MM-dd\",\"price\":1200,\"quota\":23,\"genAlQuota\":44,\"alQuota\":32,\"rateStatus\":1},{\"date\":\"yyyy-MM-dd\",\"price\":1200,\"quota\":23,\"genAlQuota\":4,\"alQuota\":32,\"rateStatus\":0}]},{\"rateId\":4321,\"useRoomInv\":0,\"invAndSwitch\":[{\"date\":\"yyyy-MM-dd\",\"price\":1200,\"quota\":23,\"alQuota\":32,\"genAlQuota\":41,\"rateStatus\":1},{\"date\":\"yyyy-MM-dd\",\"price\":1200,\"quota\":23,\"genAlQuota\":1,\"alQuota\":32,\"rateStatus\":1}]}]";
XhotelRatesIncrementUpdateResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new XhotelRatesIncrementUpdateRequest;
$req->setOperator("XXX小二");
$req->setRateListInvInfo("[{\"rateId\":1234,\"useRoomInv\":1,\"invAndSwitch\":[{\"date\":\"yyyy-MM-dd\",\"price\":1200,\"quota\":23,\"genAlQuota\":44,\"alQuota\":32,\"rateStatus\":1},{\"date\":\"yyyy-MM-dd\",\"price\":1200,\"quota\":23,\"genAlQuota\":4,\"alQuota\":32,\"rateStatus\":0}]},{\"rateId\":4321,\"useRoomInv\":0,\"invAndSwitch\":[{\"date\":\"yyyy-MM-dd\",\"price\":1200,\"quota\":23,\"alQuota\":32,\"genAlQuota\":41,\"rateStatus\":1},{\"date\":\"yyyy-MM-dd\",\"price\":1200,\"quota\":23,\"genAlQuota\":1,\"alQuota\":32,\"rateStatus\":1}]}]");
$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.rates.increment.update' \
-d 'partner_id=apidoc' \
-d 'session=e6f58e37-01dc-4f62-8053-a17c2fa066e4' \
-d 'sign=9FFA334CBF4268169496DF2FACE8CE51' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-06+19%3A22%3A21' \
-d 'v=2.0' \
-d 'operator=XXX%E5%B0%8F%E4%BA%8C' \
-d 'rate_list_inv_info=%7B%22rateId%22%3A1234%2C%22useRoomInv%22%3A1%2C%22invAndSwitch%22%3A%5B%7B%22date%22%3A%22yyyy-MM-dd%22%2C%22price%22%3A1200%2C%22quota%22%3A23%2C%22genAlQuota%22%3A44%2C%22alQuota%22%3A32%2C%22rateStatus%22%3A1%7D%2C%7B%22date%22%3A%22yyyy-MM-dd%22%2C%22price%22%3A1200%2C%22quota%22%3A23%2C%22genAlQuota%22%3A4%2C%22alQuota%22%3A32%2C%22rateStatus%22%3A0%7D%5D%7D%2C%7B%22rateId%22%3A4321%2C%22useRoomInv%22%3A0%2C%22invAndSwitch%22%3A%5B%7B%22date%22%3A%22yyyy-MM-dd%22%2C%22price%22%3A1200%2C%22quota%22%3A23%2C%22alQuota%22%3A32%2C%22genAlQuota%22%3A41%2C%22rateStatus%22%3A1%7D%2C%7B%22date%22%3A%22yyyy-MM-dd%22%2C%22price%22%3A1200%2C%22quota%22%3A23%2C%22genAlQuota%22%3A1%2C%22alQuota%22%3A32%2C%22rateStatus%22%3A1%7D%5D%7D'

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

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

req.operator="XXX小二"
req.rate_list_inv_info="[{\"rateId\":1234,\"useRoomInv\":1,\"invAndSwitch\":[{\"date\":\"yyyy-MM-dd\",\"price\":1200,\"quota\":23,\"genAlQuota\":44,\"alQuota\":32,\"rateStatus\":1},{\"date\":\"yyyy-MM-dd\",\"price\":1200,\"quota\":23,\"genAlQuota\":4,\"alQuota\":32,\"rateStatus\":0}]},{\"rateId\":4321,\"useRoomInv\":0,\"invAndSwitch\":[{\"date\":\"yyyy-MM-dd\",\"price\":1200,\"quota\":23,\"alQuota\":32,\"genAlQuota\":41,\"rateStatus\":1},{\"date\":\"yyyy-MM-dd\",\"price\":1200,\"quota\":23,\"genAlQuota\":1,\"alQuota\":32,\"rateStatus\":1}]}]"
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.rates.increment.update");
add_param(pRequest,"operator","XXX小二");
add_param(pRequest,"rate_list_inv_info","{"rateId":1234,"useRoomInv":1,"invAndSwitch":[{"date":"yyyy-MM-dd","price":1200,"quota":23,"genAlQuota":44,"alQuota":32,"rateStatus":1},{"date":"yyyy-MM-dd","price":1200,"quota":23,"genAlQuota":4,"alQuota":32,"rateStatus":0}]},{"rateId":4321,"useRoomInv":0,"invAndSwitch":[{"date":"yyyy-MM-dd","price":1200,"quota":23,"alQuota":32,"genAlQuota":41,"rateStatus":1},{"date":"yyyy-MM-dd","price":1200,"quota":23,"genAlQuota":1,"alQuota":32,"rateStatus":1}]}");
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.rates.increment.update', {
	'operator':'XXX小二',
	'rate_list_inv_info':'{"rateId":1234,"useRoomInv":1,"invAndSwitch":[{"date":"yyyy-MM-dd","price":1200,"quota":23,"genAlQuota":44,"alQuota":32,"rateStatus":1},{"date":"yyyy-MM-dd","price":1200,"quota":23,"genAlQuota":4,"alQuota":32,"rateStatus":0}]},{"rateId":4321,"useRoomInv":0,"invAndSwitch":[{"date":"yyyy-MM-dd","price":1200,"quota":23,"alQuota":32,"genAlQuota":41,"rateStatus":1},{"date":"yyyy-MM-dd","price":1200,"quota":23,"genAlQuota":1,"alQuota":32,"rateStatus":1}]}'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<xhotel_rates_increment_update_response>
    <result>
        <first_result>{12343:true,432:&quot;更新失败&quot;}</first_result>
        <error_code>0</error_code>
        <error_msg>0</error_msg>
        <success>true</success>
    </result>
</xhotel_rates_increment_update_response>

{
    "xhotel_rates_increment_update_response":{
        "result":{
            "first_result":"{12343:true,432:\"更新失败\"}",
            "error_code":"0",
            "error_msg":"0",
            "success":true
        }
    }
}

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.rates.increment.update (多个rate的库存房价开关的增量更新接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ