淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
memo	String	可选	"客人要求提前离店"	最大长度：512	备注
out_id	String	特殊可选	外部单号		商家订单号
room_no	String	可选	12A		入住房间号
other_fee	Number	必须	12300		杂费总额(不能为负数)
total_room_fee	Number	必须	12300	最小值：0	房费总额(必须大于0)
daily_price_info	String	可选	[{"day":"2015-08-12","price":48800},{"day":"2015-08-13","price":48800}]		每日房价,json格式,如果房价和在阿里旅行下单时发生了变化，必须设置该字段.用于更新阿里旅行端的房价信息,涉及到对用户的优惠信息处理等环节(多间房的时候dailyPriceInfo留空)
check_out	Date	必须	2015-08-10 00:00:00		实际离店日期，用于校验总房费收取
tid	Number	特殊可选	12323	最小值：0	淘宝订单id,必须填写
other_fee_detail	String	可选	{"洗衣费":5000,"水吧":10000,"优惠":1000}	最大长度：1024	杂费明细,如果otherFee>0则该字段必须设置,并和杂费金额相吻合
room_settle_info_list	RoomSettleInfo []	可选		最大列表长度：20	单间房明细
└ room_no String 可选 123 房间号 └ room_fee Number 可选 500 房间费（大于零） └ room_other_fee Number 可选 12 房间杂费（不能为负数） └ room_other_fee_detail String 可选 {"洗衣费":5000,"水吧":10000,"优惠":1000} 房间杂费明细（当房间杂费存在时候，此值不能空。格式与原有杂费格式otherFeeDetail的格式相同）eg;{"洗衣费":5000,"水吧":10000,"优惠":1000} └ room_check_out Date 可选 2015-08-11 00:00:00 房间check out时间 └ room_check_in Date 可选 2015-08-10 00:00:00 房间check in 时间 └ daily_price_info String 可选 [{"day":"2015-08-12","price":48800},{"day":"2015-08-13","price":48800}] 日历价格（每个房间的日历价格，多间房结账必填） └ room_status String 可选 3 房间状态；1:未入住（担保且需扣款）；2:取消成功（卖家取消；担保noshow且双方协商一致不扣款）；3:已入住
contain_guarantee	Number	可选	1	默认值：0	此金额是否包含担保金 0：默认值无意义；1：包含；2：不包含（多间房结账必须传入）

名称	类型	示例值	描述
result	String	success	返回

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
XhotelOrderAlipayfaceSettleMockRequest req = new XhotelOrderAlipayfaceSettleMockRequest();
req.setMemo("\"客人要求提前离店\"");
req.setOutId("外部单号");
req.setRoomNo("12A");
req.setOtherFee(12300L);
req.setTotalRoomFee(12300L);
req.setDailyPriceInfo("[{\"day\":\"2015-08-12\",\"price\":48800},{\"day\":\"2015-08-13\",\"price\":48800}]");
req.setCheckOut(StringUtils.parseDateTime("2015-08-10 00:00:00"));
req.setTid(12323L);
req.setOtherFeeDetail("{\"洗衣费\":5000,\"水吧\":10000,\"优惠\":1000}");
List<XhotelOrderAlipayfaceSettleMockRequest.RoomSettleInfo> list2 = new ArrayList<XhotelOrderAlipayfaceSettleMockRequest.RoomSettleInfo>();
XhotelOrderAlipayfaceSettleMockRequest.RoomSettleInfo obj3 = new XhotelOrderAlipayfaceSettleMockRequest.RoomSettleInfo();
list2.add(obj3);
obj3.setRoomNo("123");
obj3.setRoomFee(500L);
obj3.setRoomOtherFee(12L);
obj3.setRoomOtherFeeDetail("{\"洗衣费\":5000,\"水吧\":10000,\"优惠\":1000}");
obj3.setRoomCheckOut(StringUtils.parseDateTime("2015-08-11 00:00:00"));
obj3.setRoomCheckIn(StringUtils.parseDateTime("2015-08-10 00:00:00"));
obj3.setDailyPriceInfo("[{\"day\":\"2015-08-12\",\"price\":48800},{\"day\":\"2015-08-13\",\"price\":48800}]");
obj3.setRoomStatus("3");
req.setRoomSettleInfoList(list2);
req.setContainGuarantee(1L);
XhotelOrderAlipayfaceSettleMockResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
XhotelOrderAlipayfaceSettleMockRequest req = new XhotelOrderAlipayfaceSettleMockRequest();
req.Memo = "\"客人要求提前离店\"";
req.OutId = "外部单号";
req.RoomNo = "12A";
req.OtherFee = 12300L;
req.TotalRoomFee = 12300L;
req.DailyPriceInfo = "[{\"day\":\"2015-08-12\",\"price\":48800},{\"day\":\"2015-08-13\",\"price\":48800}]";
req.CheckOut = DateTime.Parse("2015-08-10 00:00:00");
req.Tid = 12323L;
req.OtherFeeDetail = "{\"洗衣费\":5000,\"水吧\":10000,\"优惠\":1000}";
List<XhotelOrderAlipayfaceSettleMockRequest.RoomSettleInfoDomain> list2 = new List<XhotelOrderAlipayfaceSettleMockRequest.RoomSettleInfoDomain>();
XhotelOrderAlipayfaceSettleMockRequest.RoomSettleInfoDomain obj3 = new XhotelOrderAlipayfaceSettleMockRequest.RoomSettleInfoDomain();
list2.Add(obj3);
obj3.RoomNo = "123";
obj3.RoomFee = 500L;
obj3.RoomOtherFee = 12L;
obj3.RoomOtherFeeDetail = "{\"洗衣费\":5000,\"水吧\":10000,\"优惠\":1000}";
obj3.RoomCheckOut = DateTime.Parse(2015-08-11 00:00:00");
obj3.RoomCheckIn = DateTime.Parse(2015-08-10 00:00:00");
obj3.DailyPriceInfo = "[{\"day\":\"2015-08-12\",\"price\":48800},{\"day\":\"2015-08-13\",\"price\":48800}]";
obj3.RoomStatus = "3";
req.RoomSettleInfoList_ = list2;
req.ContainGuarantee = 1L;
XhotelOrderAlipayfaceSettleMockResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new XhotelOrderAlipayfaceSettleMockRequest;
$req->setMemo("\"客人要求提前离店\"");
$req->setOutId("外部单号");
$req->setRoomNo("12A");
$req->setOtherFee("12300");
$req->setTotalRoomFee("12300");
$req->setDailyPriceInfo("[{\"day\":\"2015-08-12\",\"price\":48800},{\"day\":\"2015-08-13\",\"price\":48800}]");
$req->setCheckOut("2015-08-10 00:00:00");
$req->setTid("12323");
$req->setOtherFeeDetail("{\"洗衣费\":5000,\"水吧\":10000,\"优惠\":1000}");
$room_settle_info_list = new RoomSettleInfo;
$room_settle_info_list->room_no="123";
$room_settle_info_list->room_fee="500";
$room_settle_info_list->room_other_fee="12";
$room_settle_info_list->room_other_fee_detail="{\"洗衣费\":5000,\"水吧\":10000,\"优惠\":1000}";
$room_settle_info_list->room_check_out="2015-08-11 00:00:00";
$room_settle_info_list->room_check_in="2015-08-10 00:00:00";
$room_settle_info_list->daily_price_info="[{\"day\":\"2015-08-12\",\"price\":48800},{\"day\":\"2015-08-13\",\"price\":48800}]";
$room_settle_info_list->room_status="3";
$req->setRoomSettleInfoList(json_encode($room_settle_info_list));
$req->setContainGuarantee("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.order.alipayface.settle.mock' \
-d 'partner_id=apidoc' \
-d 'session=be66cde5-5c88-4bb9-8ba1-d8793b27ed3c' \
-d 'sign=8BB37C1823B8D3D9E9B9D9112E5A7E20' \
-d 'sign_method=hmac' \
-d 'timestamp=2024-12-27+08%3A50%3A05' \
-d 'v=2.0' \
-d 'check_out=2015-08-10+00%3A00%3A00' \
-d 'contain_guarantee=1' \
-d 'daily_price_info=%7B%22day%22%3A%222015-08-12%22%2C%22price%22%3A48800%7D%2C%7B%22day%22%3A%222015-08-13%22%2C%22price%22%3A48800%7D' \
-d 'memo=%5C%22%E5%AE%A2%E4%BA%BA%E8%A6%81%E6%B1%82%E6%8F%90%E5%89%8D%E7%A6%BB%E5%BA%97%5C%22' \
-d 'other_fee=12300' \
-d 'other_fee_detail=%7B%5C%22%E6%B4%97%E8%A1%A3%E8%B4%B9%5C%22%3A5000%2C%5C%22%E6%B0%B4%E5%90%A7%5C%22%3A10000%2C%5C%22%E4%BC%98%E6%83%A0%5C%22%3A1000%7D' \
-d 'out_id=%E5%A4%96%E9%83%A8%E5%8D%95%E5%8F%B7' \
-d 'room_no=12A' \
-d 'room_settle_info_list=null' \
-d 'tid=12323' \
-d 'total_room_fee=12300'

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

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

req.memo="\"客人要求提前离店\""
req.out_id="外部单号"
req.room_no="12A"
req.other_fee=12300
req.total_room_fee=12300
req.daily_price_info="[{\"day\":\"2015-08-12\",\"price\":48800},{\"day\":\"2015-08-13\",\"price\":48800}]"
req.check_out="2015-08-10 00:00:00"
req.tid=12323
req.other_fee_detail="{\"洗衣费\":5000,\"水吧\":10000,\"优惠\":1000}"
req.room_settle_info_list=""
req.contain_guarantee=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.order.alipayface.settle.mock");
add_param(pRequest,"memo","\"客人要求提前离店\"");
add_param(pRequest,"out_id","外部单号");
add_param(pRequest,"room_no","12A");
add_param(pRequest,"other_fee","12300");
add_param(pRequest,"total_room_fee","12300");
add_param(pRequest,"daily_price_info","{"day":"2015-08-12","price":48800},{"day":"2015-08-13","price":48800}");
add_param(pRequest,"check_out","2015-08-10 00:00:00");
add_param(pRequest,"tid","12323");
add_param(pRequest,"other_fee_detail","{\"洗衣费\":5000,\"水吧\":10000,\"优惠\":1000}");
add_param(pRequest,"room_settle_info_list","数据结构JSON示例");
add_param(pRequest,"contain_guarantee","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.order.alipayface.settle.mock', {
	'memo':'\"客人要求提前离店\"',
	'out_id':'外部单号',
	'room_no':'12A',
	'other_fee':'12300',
	'total_room_fee':'12300',
	'daily_price_info':'{"day":"2015-08-12","price":48800},{"day":"2015-08-13","price":48800}',
	'check_out':'2015-08-10 00:00:00',
	'tid':'12323',
	'other_fee_detail':'{\"洗衣费\":5000,\"水吧\":10000,\"优惠\":1000}',
	'room_settle_info_list':'数据结构JSON示例',
	'contain_guarantee':'1'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<xhotel_order_alipayface_settle_mock_response>
    <result>success</result>
</xhotel_order_alipayface_settle_mock_response>

{
    "xhotel_order_alipayface_settle_mock_response":{
        "result":"success"
    }
}

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"
	}
}

错误码	错误描述	解决方案
isv.invalid-parameter:NOTNULL	参数不能为空	参考api文档检查入参
isv.invalid-parameter:NUM	参数应该是数字	参考api文档检查入参
isv.invalid-parameter:STRING	参数应该是字符串	参考api文档检查入参
isv.invalid-parameter:DATE_FORMAT_ERROR	参数日期格式不正确	参考api文档检查入参
isv.invalid-parameter:RANGE_ERROR	参数只能从指定的可选值中选择	参考api文档检查入参
isv.invalid-parameter:FORMAT_ERROR	参数格式不正确	参考api文档检查入参，重点查看杂费明细json是否格式正确
isv.invalid-parameter:LENGTH_OVERRANGE	参数长度不能超过规定值	参考api文档检查入参
isv.invalid-parameter:BYTES_OVERRANGE	参数字节数不能超过规定值	参考api文档检查入参
isv.remote-service:CONVERT_ERROR	转换对象时出错	检查入参或者联系技术支持
isv.permission-error:NO_PERMISSIONS_ERROR	权限不够、非法访问	检查订单id是否输入有误
isv.invalid-parameter:GET_ORDER_IDS_ALL_NULL_ERROR	参数oid,tid不能都为空	淘宝订单号和卖家订单号至少传入一个
isv.order-error:ORDER_STATUS_MISMATCHING	订单当前状态不允许进行该操作	只有订单处于如下状态才允许进行结算操作： 1. 订单待结算; 2. 核实入住; 3. 核实离店; 4. 取消结算;
isv.order-error:ORDER_NOT_EXIST	未查询到订单数据	检查订单id是否输入正确，是否已经入住
isv.order-error:OTHER_FEE_NOT_VALID	杂费金额不合法	订单总额是0的时候不允许传入大于0的杂费信息
isp.remote-service-error	系统错误	联系技术支持跟进
isv.invalid-parameter:ERROR	参数不正确或者其他费用必须大于0并且小于1000元或者操作时间早于订单checkIn时间等等	按照错误描述信息修改入参。如果不能解决问题、联系技术支持
isv.biz-error:BIZ_ERROR	业务异常	联系技术支持跟进
isv.order-error:NOT_SUPPORT_OPT_TYPE	当前订单不支持该操作类型	预付和面付订单不允许进行该操作
isv.order-parameter:OTHER_FEE_NOT_VALID	房费或者杂费金额不合法	重新核对费用信息后传入
isv.settle-error:ERROR_SETTLE_WITH_ZERO	状态异常的零元结账请求	非零结账
isp.system-error	系统错误	联系阿里技术

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

开放平台

酒店API（新）

taobao.xhotel.order.alipayface.settle.mock (订单结账mock)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ