淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	描述
rate_plan_id	Number	必须	2131231	rp_id 必须得填
guarantee_cal	String	可选	[{"date":"yyyy-MM-dd","startDate":"yyyy-MM-dd","endDate":"yyyy-MM-dd","guarantee":{"guaranteeType":2,"guaranteeStartTime":"HH:mm"}},{"date":"yyyy-MM-dd","startDate":"yyyy-MM-dd","endDate":"yyyy-MM-dd","guarantee":{"guaranteeType":3,"guaranteeStartTime":"HH:mm"}}]	在更新rateplan的同时，新增或更新担保日历。 date：担保日历的某一天。 guarantee:担保政策。其中有两个属性：guaranteeType,guaranteeStartTime。 guaranteeType的可选值同guaranteeType字段，详见guaranteeType字段。guaranteeStartTime格式为"HH:mm" 。如果date为空，那么会读取startDate和endDate（格式都为"yyyy-MM-dd"），即担保政策属于某一个时间段。（如果设置了峰时担保类型，那么峰时担保时间不能为空，并且必须大于等于8点）请注意，该字段仅能维护从当前时间开始，10年以内的数据，如果超过10年，会报错。
cancel_policy_cal	String	可选	[{"date":"yyyy-MM-dd","startDate":"yyyy-MM-dd","endDate":"yyyy-MM-dd","cancel_policy":{"cancelPolicyType":1} },{"date":"yyyy-MM-dd","startDate":"yyyy-MM-dd","endDate":"yyyy-MM-dd","cancel_policy":{"cancelPolicyType":4,"policyInfo":{"48":10,"24":20}}}]	在新增rateplan的同时新增取消政策日历。 json格式。 date：日历的某一天，格式为"yyyy-MM-dd" cancel_policy：日历某一天的价格政策。格式和限制同cancel_policy。如果date为空，那么会读取startDate和endDate（格式都为"yyyy-MM-dd"），即取消政策属于某一个时间段。注意：支付类型为预付，那么可以使用所有的退订类型，但是必须是非担保；支付类型为面付或者信任住并且是无担保，那么只能使用1类型的退订；支付类型为面付或者信任住并且为担保，那么只能使用2,5类型的退订；支付类型为在线预约，那么只能使用1,2,5类型的退改。如果支付类型是面付或者信任住并且为担保，那么如果传了4或者6的退订，那么会强制转成类型5。请注意，该字段仅能维护从当前时间开始，10年以内的数据，如果超过10年，会报错。
breakfast_cal	String	可选	[{"date":"yyyy-MM-dd","startDate":"yyyy-MM-dd","endDate":"yyyy-MM-dd","breakfast_count":0},{"date":"yyyy-MM-dd","startDate":"yyyy-MM-dd","endDate":"yyyy-MM-dd","breakfast_count":1}]	在更新rateplan时，同时新增或更新早餐日历。 date：早餐政策属于具体哪一天 breakfast_count：这一天早餐的数量。>=0,<=99 如果date为空，那么会去读取startDate和endDate（格式都为"yyyy-MM-dd"），即早餐正常属于一个时间段。-1为状态早餐，和最终绑定的几人价有关，如果是一人价那么就是我一份早餐，二人价就是两份早餐。请注意，该字段仅能维护从当前时间开始，10年以内的数据，如果超过10年，会报错。
operator	String	必须	操作人	操作人
member_discount_cal	String	可选	[{c:"8",t:1,s: "20191211",e:"20191225"}]	会员价加价规则。c:表示折扣百分比,例子8,意为会员价优惠8%,s:标识起始日期,e:表示截止日期，t:表示加价类型，0:代表折扣。会员价=售价*(1-c%)。该字段使用需要联系小二

名称	类型	示例值	描述
result	ResultSet		result
└ first_result String 0 firstResult └ 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);
XhotelRateplanIncrementUpdateRequest req = new XhotelRateplanIncrementUpdateRequest();
req.setRatePlanId(2131231L);
req.setGuaranteeCal("[{\"date\":\"yyyy-MM-dd\",\"startDate\":\"yyyy-MM-dd\",\"endDate\":\"yyyy-MM-dd\",\"guarantee\":{\"guaranteeType\":2,\"guaranteeStartTime\":\"HH:mm\"}},{\"date\":\"yyyy-MM-dd\",\"startDate\":\"yyyy-MM-dd\",\"endDate\":\"yyyy-MM-dd\",\"guarantee\":{\"guaranteeType\":3,\"guaranteeStartTime\":\"HH:mm\"}}]");
req.setCancelPolicyCal("[{\"date\":\"yyyy-MM-dd\",\"startDate\":\"yyyy-MM-dd\",\"endDate\":\"yyyy-MM-dd\",\"cancel_policy\":{\"cancelPolicyType\":1} },{\"date\":\"yyyy-MM-dd\",\"startDate\":\"yyyy-MM-dd\",\"endDate\":\"yyyy-MM-dd\",\"cancel_policy\":{\"cancelPolicyType\":4,\"policyInfo\":{\"48\":10,\"24\":20}}}]");
req.setBreakfastCal("[{\"date\":\"yyyy-MM-dd\",\"startDate\":\"yyyy-MM-dd\",\"endDate\":\"yyyy-MM-dd\",\"breakfast_count\":0},{\"date\":\"yyyy-MM-dd\",\"startDate\":\"yyyy-MM-dd\",\"endDate\":\"yyyy-MM-dd\",\"breakfast_count\":1}]");
req.setOperator("操作人");
req.setMemberDiscountCal("[{c:\"8\",t:1,s: \"20191211\",e:\"20191225\"}]");
XhotelRateplanIncrementUpdateResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
XhotelRateplanIncrementUpdateRequest req = new XhotelRateplanIncrementUpdateRequest();
req.RatePlanId = 2131231L;
req.GuaranteeCal = "[{\"date\":\"yyyy-MM-dd\",\"startDate\":\"yyyy-MM-dd\",\"endDate\":\"yyyy-MM-dd\",\"guarantee\":{\"guaranteeType\":2,\"guaranteeStartTime\":\"HH:mm\"}},{\"date\":\"yyyy-MM-dd\",\"startDate\":\"yyyy-MM-dd\",\"endDate\":\"yyyy-MM-dd\",\"guarantee\":{\"guaranteeType\":3,\"guaranteeStartTime\":\"HH:mm\"}}]";
req.CancelPolicyCal = "[{\"date\":\"yyyy-MM-dd\",\"startDate\":\"yyyy-MM-dd\",\"endDate\":\"yyyy-MM-dd\",\"cancel_policy\":{\"cancelPolicyType\":1} },{\"date\":\"yyyy-MM-dd\",\"startDate\":\"yyyy-MM-dd\",\"endDate\":\"yyyy-MM-dd\",\"cancel_policy\":{\"cancelPolicyType\":4,\"policyInfo\":{\"48\":10,\"24\":20}}}]";
req.BreakfastCal = "[{\"date\":\"yyyy-MM-dd\",\"startDate\":\"yyyy-MM-dd\",\"endDate\":\"yyyy-MM-dd\",\"breakfast_count\":0},{\"date\":\"yyyy-MM-dd\",\"startDate\":\"yyyy-MM-dd\",\"endDate\":\"yyyy-MM-dd\",\"breakfast_count\":1}]";
req.Operator = "操作人";
req.MemberDiscountCal = "[{c:\"8\",t:1,s: \"20191211\",e:\"20191225\"}]";
XhotelRateplanIncrementUpdateResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new XhotelRateplanIncrementUpdateRequest;
$req->setRatePlanId("2131231");
$req->setGuaranteeCal("[{\"date\":\"yyyy-MM-dd\",\"startDate\":\"yyyy-MM-dd\",\"endDate\":\"yyyy-MM-dd\",\"guarantee\":{\"guaranteeType\":2,\"guaranteeStartTime\":\"HH:mm\"}},{\"date\":\"yyyy-MM-dd\",\"startDate\":\"yyyy-MM-dd\",\"endDate\":\"yyyy-MM-dd\",\"guarantee\":{\"guaranteeType\":3,\"guaranteeStartTime\":\"HH:mm\"}}]");
$req->setCancelPolicyCal("[{\"date\":\"yyyy-MM-dd\",\"startDate\":\"yyyy-MM-dd\",\"endDate\":\"yyyy-MM-dd\",\"cancel_policy\":{\"cancelPolicyType\":1} },{\"date\":\"yyyy-MM-dd\",\"startDate\":\"yyyy-MM-dd\",\"endDate\":\"yyyy-MM-dd\",\"cancel_policy\":{\"cancelPolicyType\":4,\"policyInfo\":{\"48\":10,\"24\":20}}}]");
$req->setBreakfastCal("[{\"date\":\"yyyy-MM-dd\",\"startDate\":\"yyyy-MM-dd\",\"endDate\":\"yyyy-MM-dd\",\"breakfast_count\":0},{\"date\":\"yyyy-MM-dd\",\"startDate\":\"yyyy-MM-dd\",\"endDate\":\"yyyy-MM-dd\",\"breakfast_count\":1}]");
$req->setOperator("操作人");
$req->setMemberDiscountCal("[{c:\"8\",t:1,s: \"20191211\",e:\"20191225\"}]");
$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.increment.update' \
-d 'partner_id=apidoc' \
-d 'session=691511f8-6f8a-4dec-93da-62fbd35c23d7' \
-d 'sign=476B96B5F570D4E5400627E76F0D70DE' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-06+17%3A22%3A14' \
-d 'v=2.0' \
-d 'breakfast_cal=%7B%22date%22%3A%22yyyy-MM-dd%22%2C%22startDate%22%3A%22yyyy-MM-dd%22%2C%22endDate%22%3A%22yyyy-MM-dd%22%2C%22breakfast_count%22%3A0%7D%2C%7B%22date%22%3A%22yyyy-MM-dd%22%2C%22startDate%22%3A%22yyyy-MM-dd%22%2C%22endDate%22%3A%22yyyy-MM-dd%22%2C%22breakfast_count%22%3A1%7D' \
-d 'cancel_policy_cal=%7B%22date%22%3A%22yyyy-MM-dd%22%2C%22startDate%22%3A%22yyyy-MM-dd%22%2C%22endDate%22%3A%22yyyy-MM-dd%22%2C%22cancel_policy%22%3A%7B%22cancelPolicyType%22%3A1%7D+%7D%2C%7B%22date%22%3A%22yyyy-MM-dd%22%2C%22startDate%22%3A%22yyyy-MM-dd%22%2C%22endDate%22%3A%22yyyy-MM-dd%22%2C%22cancel_policy%22%3A%7B%22cancelPolicyType%22%3A4%2C%22policyInfo%22%3A%7B%2248%22%3A10%2C%2224%22%3A20%7D%7D%7D' \
-d 'guarantee_cal=%7B%22date%22%3A%22yyyy-MM-dd%22%2C%22startDate%22%3A%22yyyy-MM-dd%22%2C%22endDate%22%3A%22yyyy-MM-dd%22%2C%22guarantee%22%3A%7B%22guaranteeType%22%3A2%2C%22guaranteeStartTime%22%3A%22HH%3Amm%22%7D%7D%2C%7B%22date%22%3A%22yyyy-MM-dd%22%2C%22startDate%22%3A%22yyyy-MM-dd%22%2C%22endDate%22%3A%22yyyy-MM-dd%22%2C%22guarantee%22%3A%7B%22guaranteeType%22%3A3%2C%22guaranteeStartTime%22%3A%22HH%3Amm%22%7D%7D' \
-d 'member_discount_cal=%7Bc%3A%228%22%2Ct%3A1%2Cs%3A+%2220191211%22%2Ce%3A%2220191225%22%7D' \
-d 'operator=%E6%93%8D%E4%BD%9C%E4%BA%BA' \
-d 'rate_plan_id=2131231'

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

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

req.rate_plan_id=2131231
req.guarantee_cal="[{\"date\":\"yyyy-MM-dd\",\"startDate\":\"yyyy-MM-dd\",\"endDate\":\"yyyy-MM-dd\",\"guarantee\":{\"guaranteeType\":2,\"guaranteeStartTime\":\"HH:mm\"}},{\"date\":\"yyyy-MM-dd\",\"startDate\":\"yyyy-MM-dd\",\"endDate\":\"yyyy-MM-dd\",\"guarantee\":{\"guaranteeType\":3,\"guaranteeStartTime\":\"HH:mm\"}}]"
req.cancel_policy_cal="[{\"date\":\"yyyy-MM-dd\",\"startDate\":\"yyyy-MM-dd\",\"endDate\":\"yyyy-MM-dd\",\"cancel_policy\":{\"cancelPolicyType\":1} },{\"date\":\"yyyy-MM-dd\",\"startDate\":\"yyyy-MM-dd\",\"endDate\":\"yyyy-MM-dd\",\"cancel_policy\":{\"cancelPolicyType\":4,\"policyInfo\":{\"48\":10,\"24\":20}}}]"
req.breakfast_cal="[{\"date\":\"yyyy-MM-dd\",\"startDate\":\"yyyy-MM-dd\",\"endDate\":\"yyyy-MM-dd\",\"breakfast_count\":0},{\"date\":\"yyyy-MM-dd\",\"startDate\":\"yyyy-MM-dd\",\"endDate\":\"yyyy-MM-dd\",\"breakfast_count\":1}]"
req.operator="操作人"
req.member_discount_cal="[{c:\"8\",t:1,s: \"20191211\",e:\"20191225\"}]"
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.increment.update");
add_param(pRequest,"rate_plan_id","2131231");
add_param(pRequest,"guarantee_cal","{"date":"yyyy-MM-dd","startDate":"yyyy-MM-dd","endDate":"yyyy-MM-dd","guarantee":{"guaranteeType":2,"guaranteeStartTime":"HH:mm"}},{"date":"yyyy-MM-dd","startDate":"yyyy-MM-dd","endDate":"yyyy-MM-dd","guarantee":{"guaranteeType":3,"guaranteeStartTime":"HH:mm"}}");
add_param(pRequest,"cancel_policy_cal","{"date":"yyyy-MM-dd","startDate":"yyyy-MM-dd","endDate":"yyyy-MM-dd","cancel_policy":{"cancelPolicyType":1} },{"date":"yyyy-MM-dd","startDate":"yyyy-MM-dd","endDate":"yyyy-MM-dd","cancel_policy":{"cancelPolicyType":4,"policyInfo":{"48":10,"24":20}}}");
add_param(pRequest,"breakfast_cal","{"date":"yyyy-MM-dd","startDate":"yyyy-MM-dd","endDate":"yyyy-MM-dd","breakfast_count":0},{"date":"yyyy-MM-dd","startDate":"yyyy-MM-dd","endDate":"yyyy-MM-dd","breakfast_count":1}");
add_param(pRequest,"operator","操作人");
add_param(pRequest,"member_discount_cal","{c:"8",t:1,s: "20191211",e:"20191225"}");
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.increment.update', {
	'rate_plan_id':'2131231',
	'guarantee_cal':'{"date":"yyyy-MM-dd","startDate":"yyyy-MM-dd","endDate":"yyyy-MM-dd","guarantee":{"guaranteeType":2,"guaranteeStartTime":"HH:mm"}},{"date":"yyyy-MM-dd","startDate":"yyyy-MM-dd","endDate":"yyyy-MM-dd","guarantee":{"guaranteeType":3,"guaranteeStartTime":"HH:mm"}}',
	'cancel_policy_cal':'{"date":"yyyy-MM-dd","startDate":"yyyy-MM-dd","endDate":"yyyy-MM-dd","cancel_policy":{"cancelPolicyType":1} },{"date":"yyyy-MM-dd","startDate":"yyyy-MM-dd","endDate":"yyyy-MM-dd","cancel_policy":{"cancelPolicyType":4,"policyInfo":{"48":10,"24":20}}}',
	'breakfast_cal':'{"date":"yyyy-MM-dd","startDate":"yyyy-MM-dd","endDate":"yyyy-MM-dd","breakfast_count":0},{"date":"yyyy-MM-dd","startDate":"yyyy-MM-dd","endDate":"yyyy-MM-dd","breakfast_count":1}',
	'operator':'操作人',
	'member_discount_cal':'{c:"8",t:1,s: "20191211",e:"20191225"}'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<xhotel_rateplan_increment_update_response>
    <result>
        <first_result>0</first_result>
        <error_code>0</error_code>
        <error_msg>0</error_msg>
        <success>true</success>
    </result>
</xhotel_rateplan_increment_update_response>

{
    "xhotel_rateplan_increment_update_response":{
        "result":{
            "first_result":"0",
            "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.rateplan.increment.update (RatePlan增量更新接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ