淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	描述
tid	Number	可选	123455678	订单号
loan_reason_code	Number	可选	1	垫付操作状态:1、自动垫付，2、手动垫付，3、运营过滤，4、黑名单过滤，5、酒店卖家过滤，6、不需要垫付
voucher	Number	可选	1	未收回凭证:0、未收回,1、已收回已验收,2、已收回未验证,3、已收回已拒绝
account_status	Number	可选	1	追账状态
hid_list	String	可选	1111,1112	酒店ID列表，逗号分隔
check_out_end	Date	可选	2017-06-27 00:16:21	离店时间截止
check_out_start	Date	可选	2017-06-27 23:16:21	离店时间起始
page_no	Number	可选	1	页码，起始值1
query_type	Number	可选	1	查询类型，1未结账订单，2结账异常订单
vendor	String	可选	taobao	系统商标识

名称	类型	示例值	描述
abnormal_order_result_set	AbnormalOrderResultSet	abnormalOrderResultSet	异常订单列表
└ total_count Number 12 总数 credit_loan_orders CreditLoanOrderDo [] creditLoanOrderDOs 结账异常订单对象 └ credit_score Number 12300 creditScore └ gmt_modified String 2017-12-05 12:00:00 gmtModified └ card_pic String 默认字符串 cardPic └ hid Number 21212232 酒店ID └ remark String 默认字符串 remark └ out_hid String a111 外部酒店id └ out_trade_no String 默认字符串 outTradeNo └ pms_pic String 默认字符串 pmsPic └ out_oid String 默认字符串 outOid └ seller_nick String 默认字符串 sellerNick └ hotel_name String 默认字符串 hotelName └ account_status Number 12300 accountStatus └ buyer_nick String 默认字符串 buyerNick └ hotel_phone String 默认字符串 hotelPhone └ auto_result String 默认字符串 autoResult └ biz_id Number 12300 bizId └ alitrip_alipay_no String 默认字符串 alitripAlipayNo └ alipay_trade_no String 默认字符串 alipayTradeNo └ contact_phone String 默认字符串 contactPhone └ loan_reason_code Number 12300 loanReasonCode └ payment Number 12300 payment └ gmt_create String 2017-12-05 12:00:00 gmtCreate └ status Number 12300 status └ other_fee Number 1000 杂费 └ buyer_id Number 12300 buyerId └ check_in String 2017-06-28 00:00:00 入住时间 └ operator String 默认字符串 operator └ noshow Number 0 noshow 0:非、1:是 └ check_out String 2017-06-29 00:00:00 离店时间 └ seller_id Number 12300 sellerId └ contact_name String 默认字符串 contactName └ seller_alipay_no String 默认字符串 sellerAlipayNo └ total_room_price Number 12100 总房价 └ checkin_pic String 默认字符串 checkinPic └ attributes String 默认字符串 attributes └ voucher Number 1 凭证状态,未收回:0,已收回已验证:1,已收回未验证:2,已收回已拒绝:3 └ room_type_name String 默认字符串 roomTypeName └ voucher_info String 默认字符串 voucherInfo └ buyer_alipay_no String 默认字符串 buyerAlipayNo └ vendor String 技术提供商 vendor hotel_no_check_out_credit_orders HotelNoCheckOutCreditOrder [] hotelNoCheckOutCreditOrders 为结账订单 └ tid Number 1323232 订单号 └ tid_str String 111,222 订单号，逗号分隔 └ outer_id String 22222 外部订单号 └ check_in_date Date 2017-06-28 00:00:00 入住时间 └ check_out_date Date 2017-06-28 00:00:00 离店时间 └ check_in_date_str String 2017-06-28 00:00:00 入住时间 └ check_out_date_str String 2017-06-28 00:00:00 离店时间 └ trade_status_code String 1 订单状态 └ room_type_name String 豪华房房型名称 └ contact_name String 小红联系人名称 └ contact_phone_number String 1345438948 联系人电话 └ check_in_name String 2017-06-28 00:00:00 入住人名字 └ hotel_name String 淘宝大酒店酒店名字 └ hotel_tel String 1212121 酒店电话 └ hotel_code String 1111 酒店code └ bd_name String 小二 BD名字 └ seller_nick_name String 淘宝酒店旗舰店卖家昵称 └ collect_day String 2017-06-28 00:00:00 数据采集日期 └ out_trade_no String outTradeNo outTradeNo └ hotel_phone String hotelPhone hotelPhone └ out_oid String 12121 外部订单号 └ error_code String 1 错误码 └ error_msg String 订单不存在错误信息 └ error Boolean false 成功标识

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
XhotelOrderAbnormalSearchRequest req = new XhotelOrderAbnormalSearchRequest();
req.setTid(123455678L);
req.setLoanReasonCode(1L);
req.setVoucher(1L);
req.setAccountStatus(1L);
req.setHidList("1111,1112");
req.setCheckOutEnd(StringUtils.parseDateTime("2017-06-27 00:16:21"));
req.setCheckOutStart(StringUtils.parseDateTime("2017-06-27 23:16:21"));
req.setPageNo(1L);
req.setQueryType(1L);
req.setVendor("taobao");
XhotelOrderAbnormalSearchResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
XhotelOrderAbnormalSearchRequest req = new XhotelOrderAbnormalSearchRequest();
req.Tid = 123455678L;
req.LoanReasonCode = 1L;
req.Voucher = 1L;
req.AccountStatus = 1L;
req.HidList = "1111,1112";
req.CheckOutEnd = DateTime.Parse("2017-06-27 00:16:21");
req.CheckOutStart = DateTime.Parse("2017-06-27 23:16:21");
req.PageNo = 1L;
req.QueryType = 1L;
req.Vendor = "taobao";
XhotelOrderAbnormalSearchResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new XhotelOrderAbnormalSearchRequest;
$req->setTid("123455678");
$req->setLoanReasonCode("1");
$req->setVoucher("1");
$req->setAccountStatus("1");
$req->setHidList("1111,1112");
$req->setCheckOutEnd("2017-06-27 00:16:21");
$req->setCheckOutStart("2017-06-27 23:16:21");
$req->setPageNo("1");
$req->setQueryType("1");
$req->setVendor("taobao");
$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.abnormal.search' \
-d 'partner_id=apidoc' \
-d 'session=4719d153-a311-47c1-a3ae-84b77a99ea31' \
-d 'sign=D73DE49C39377B0BC187732AF46737C5' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-10-24+10%3A30%3A34' \
-d 'v=2.0' \
-d 'account_status=1' \
-d 'check_out_end=2017-06-27+00%3A16%3A21' \
-d 'check_out_start=2017-06-27+23%3A16%3A21' \
-d 'hid_list=1111%2C1112' \
-d 'loan_reason_code=1' \
-d 'page_no=1' \
-d 'query_type=1' \
-d 'tid=123455678' \
-d 'vendor=taobao' \
-d 'voucher=1'

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

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

req.tid=123455678
req.loan_reason_code=1
req.voucher=1
req.account_status=1
req.hid_list="1111,1112"
req.check_out_end="2017-06-27 00:16:21"
req.check_out_start="2017-06-27 23:16:21"
req.page_no=1
req.query_type=1
req.vendor="taobao"
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.abnormal.search");
add_param(pRequest,"tid","123455678");
add_param(pRequest,"loan_reason_code","1");
add_param(pRequest,"voucher","1");
add_param(pRequest,"account_status","1");
add_param(pRequest,"hid_list","1111,1112");
add_param(pRequest,"check_out_end","2017-06-27 00:16:21");
add_param(pRequest,"check_out_start","2017-06-27 23:16:21");
add_param(pRequest,"page_no","1");
add_param(pRequest,"query_type","1");
add_param(pRequest,"vendor","taobao");
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.abnormal.search', {
	'tid':'123455678',
	'loan_reason_code':'1',
	'voucher':'1',
	'account_status':'1',
	'hid_list':'1111,1112',
	'check_out_end':'2017-06-27 00:16:21',
	'check_out_start':'2017-06-27 23:16:21',
	'page_no':'1',
	'query_type':'1',
	'vendor':'taobao'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<xhotel_order_abnormal_search_response>
    <abnormal_order_result_set>
        <total_count>12</total_count>
        <credit_loan_orders>
            <credit_loan_order_do>
                <credit_score>12300</credit_score>
                <gmt_modified>2017-12-05 12:00:00</gmt_modified>
                <card_pic>默认字符串</card_pic>
                <hid>21212232</hid>
                <remark>默认字符串</remark>
                <out_hid>a111</out_hid>
                <out_trade_no>默认字符串</out_trade_no>
                <pms_pic>默认字符串</pms_pic>
                <out_oid>默认字符串</out_oid>
                <seller_nick>默认字符串</seller_nick>
                <hotel_name>默认字符串</hotel_name>
                <account_status>12300</account_status>
                <buyer_nick>默认字符串</buyer_nick>
                <hotel_phone>默认字符串</hotel_phone>
                <auto_result>默认字符串</auto_result>
                <biz_id>12300</biz_id>
                <alitrip_alipay_no>默认字符串</alitrip_alipay_no>
                <alipay_trade_no>默认字符串</alipay_trade_no>
                <contact_phone>默认字符串</contact_phone>
                <loan_reason_code>12300</loan_reason_code>
                <payment>12300</payment>
                <gmt_create>2017-12-05 12:00:00</gmt_create>
                <status>12300</status>
                <other_fee>1000</other_fee>
                <buyer_id>12300</buyer_id>
                <check_in>2017-06-28 00:00:00</check_in>
                <operator>默认字符串</operator>
                <noshow>0</noshow>
                <check_out>2017-06-29 00:00:00</check_out>
                <seller_id>12300</seller_id>
                <contact_name>默认字符串</contact_name>
                <seller_alipay_no>默认字符串</seller_alipay_no>
                <total_room_price>12100</total_room_price>
                <checkin_pic>默认字符串</checkin_pic>
                <attributes>默认字符串</attributes>
                <voucher>1</voucher>
                <room_type_name>默认字符串</room_type_name>
                <voucher_info>默认字符串</voucher_info>
                <buyer_alipay_no>默认字符串</buyer_alipay_no>
                <vendor>技术提供商</vendor>
            </credit_loan_order_do>
        </credit_loan_orders>
        <hotel_no_check_out_credit_orders>
            <hotel_no_check_out_credit_order>
                <tid>1323232</tid>
                <tid_str>111,222</tid_str>
                <outer_id>22222</outer_id>
                <check_in_date>2017-06-28 00:00:00</check_in_date>
                <check_out_date>2017-06-28 00:00:00</check_out_date>
                <check_in_date_str>2017-06-28 00:00:00</check_in_date_str>
                <check_out_date_str>2017-06-28 00:00:00</check_out_date_str>
                <trade_status_code>1</trade_status_code>
                <room_type_name>豪华房</room_type_name>
                <contact_name>小红</contact_name>
                <contact_phone_number>1345438948</contact_phone_number>
                <check_in_name>2017-06-28 00:00:00</check_in_name>
                <hotel_name>淘宝大酒店</hotel_name>
                <hotel_tel>1212121</hotel_tel>
                <hotel_code>1111</hotel_code>
                <bd_name>小二</bd_name>
                <seller_nick_name>淘宝酒店旗舰店</seller_nick_name>
                <collect_day>2017-06-28 00:00:00</collect_day>
                <out_trade_no>outTradeNo</out_trade_no>
                <hotel_phone>hotelPhone</hotel_phone>
                <out_oid>12121</out_oid>
            </hotel_no_check_out_credit_order>
        </hotel_no_check_out_credit_orders>
        <error_code>1</error_code>
        <error_msg>订单不存在</error_msg>
        <error>false</error>
    </abnormal_order_result_set>
</xhotel_order_abnormal_search_response>

{
    "xhotel_order_abnormal_search_response":{
        "abnormal_order_result_set":{
            "total_count":12,
            "credit_loan_orders":{
                "credit_loan_order_do":[
                    {
                        "credit_score":12300,
                        "gmt_modified":"2017-12-05 12:00:00",
                        "card_pic":"默认字符串",
                        "hid":21212232,
                        "remark":"默认字符串",
                        "out_hid":"a111",
                        "out_trade_no":"默认字符串",
                        "pms_pic":"默认字符串",
                        "out_oid":"默认字符串",
                        "seller_nick":"默认字符串",
                        "hotel_name":"默认字符串",
                        "account_status":12300,
                        "buyer_nick":"默认字符串",
                        "hotel_phone":"默认字符串",
                        "auto_result":"默认字符串",
                        "biz_id":12300,
                        "alitrip_alipay_no":"默认字符串",
                        "alipay_trade_no":"默认字符串",
                        "contact_phone":"默认字符串",
                        "loan_reason_code":12300,
                        "payment":12300,
                        "gmt_create":"2017-12-05 12:00:00",
                        "status":12300,
                        "other_fee":1000,
                        "buyer_id":12300,
                        "check_in":"2017-06-28 00:00:00",
                        "operator":"默认字符串",
                        "noshow":0,
                        "check_out":"2017-06-29 00:00:00",
                        "seller_id":12300,
                        "contact_name":"默认字符串",
                        "seller_alipay_no":"默认字符串",
                        "total_room_price":12100,
                        "checkin_pic":"默认字符串",
                        "attributes":"默认字符串",
                        "voucher":1,
                        "room_type_name":"默认字符串",
                        "voucher_info":"默认字符串",
                        "buyer_alipay_no":"默认字符串",
                        "vendor":"技术提供商"
                    }
                ]
            },
            "hotel_no_check_out_credit_orders":{
                "hotel_no_check_out_credit_order":[
                    {
                        "tid":1323232,
                        "tid_str":"111,222",
                        "outer_id":"22222",
                        "check_in_date":"2017-06-28 00:00:00",
                        "check_out_date":"2017-06-28 00:00:00",
                        "check_in_date_str":"2017-06-28 00:00:00",
                        "check_out_date_str":"2017-06-28 00:00:00",
                        "trade_status_code":"1",
                        "room_type_name":"豪华房",
                        "contact_name":"小红",
                        "contact_phone_number":"1345438948",
                        "check_in_name":"2017-06-28 00:00:00",
                        "hotel_name":"淘宝大酒店",
                        "hotel_tel":"1212121",
                        "hotel_code":"1111",
                        "bd_name":"小二",
                        "seller_nick_name":"淘宝酒店旗舰店",
                        "collect_day":"2017-06-28 00:00:00",
                        "out_trade_no":"outTradeNo",
                        "hotel_phone":"hotelPhone",
                        "out_oid":"12121"
                    }
                ]
            },
            "error_code":"1",
            "error_msg":"订单不存在",
            "error":false
        }
    }
}

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下载

开放平台

酒店在线预订API

taobao.xhotel.order.abnormal.search (异常订单列表查询)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ