淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
order_list_param	OrderListParam	可选			订单列表查询参数
└ payment_type Number 可选 1 付费类型 └ buyer_nick String 可选小红买家昵称 └ tids String 可选 333,444 淘宝订单号，逗号间隔 └ out_oids String 可选 111,222 外部订单号，逗号分隔 └ hids String 可选 555,666 酒店号，逗号分隔 └ created_start Date 可选 2017-06-28 00:00:00 下单创建时间段--起始 └ created_end Date 可选 2017-06-28 00:00:00 下单创建时间段--终止 └ checkin_date_start Date 可选 2017-06-28 00:00:00 入住时间段--起始 └ checkin_date_end Date 可选 2017-06-28 00:00:00 入住时间段--截止 └ checkout_date_end Date 可选 2017-06-28 00:00:00 离店时间段--截止 └ trade_status String 可选 2,3 交易状态，逗号间隔 └ page_no Number 可选 1 页码 └ contact_name String 可选小红联系人姓名 └ contact_phone String 可选 13548609889 联系电话 └ sub_type String 可选 2 订单子类型 └ vendor String 可选 taobao 供应商 └ package_order Boolean 可选 true 套餐订单 └ checkout_date_start Date 可选 2017-06-28 00:00:00 离店时间段--开始 └ related_code String 可选 123123 全场景消费：校验关联码 └ part_room_order Boolean 可选 true 是否包房 └ empty_out_confirm_code Boolean 可选 true 设置外部订单为空的类型 * 注：包房订单下才有效，其他查询不生效 └ query_type Number 可选 1 1订单列表查询，2待开发票查询 └ invoice_status String 可选 1,3 预约发票状态，逗号间隔 └ card_id String 可选 331004199012033257 身份证号 └ order_associate_code Number 可选 123456 关联码 └ upset_price Boolean 可选 true 是否底价加价订单 └ booking_name String 可选小红预定人姓名 └ union_status String 可选 101 订单unionStatus

名称	类型	示例值	描述
orders_result_set	OrdersResultSet	ordersResultSet	订单列表结果
└ total_count Number 20 查询总数 top_hotel_orders TopHotelOrder [] topHotelOrders 订单对象 └ hid Number 17465037643 酒店ID └ out_oid String 123456 外部订单号 └ checkout_date Date 2017-04-14 00:00:00 离店日期 └ rp_name String 提前3天 RP名称 └ rp_code String 测试指定房型新增rp1 RP编码 └ rpid Number 8022283643 价格计划ID └ type Number 6 付费类型 └ hotel_name String 智选长湖店酒店名称 └ room_type_name String 标准单间-提前3天含双早房型名称 └ created Date 2017-04-12 10:51:44 创建日期 └ contact_name String IYCDHJV 联系人姓名 └ checkin_date Date 2017-04-12 00:00:00 入店日期 └ nights Number 2 间夜 └ tid Number 9125720159744288 淘宝订单号 └ seller_nick String sandbox_sz_01 卖家昵称 └ room_type_code String a7057ad3-f2e7-e411-949f-1051721b417b 房型编码 └ room_number Number 1 房间数 └ hotel_code String 20d34cde-1ce4-e411-949f-1051721b417b 酒店code └ payment Number 33600 支付金额 └ contact_phone String 13516555310 联系电话 └ trade_status String TRADE_SETTLEING 交易状态 └ buyer_nick String jinjiangzhixingtest 买家昵称 └ rid Number 36121263643 房型ID top_daily_infos TopDailyInfo [] topDailyInfos 每日房价 └ day Date day 日期 └ price Number price 价格 └ break_fast_count Number breakFastCount 早餐数量 top_order_guests TopOrderGuest [] topOrderGuests 客户信息 └ name String name 姓名 └ room_no Number roomNo 房间号 └ person_no Number personNo 人数 └ customer_type Number customerType 客户类型 └ age Number age 年龄 └ split_order Boolean splitOrder 子订单 └ package_order Boolean packageOrder package订单 └ block_room_order Boolean blockRoomOrder 保留房订单 └ discount_fee Number 12300 优惠金额 └ shop_discount_fee Number 12300 店铺优惠 └ city Number 420000 城市 └ book_seller_payment Number 1 卖家优惠 └ refund_status String 1 退款状态 top_info_map Topinfomap topInfoMap 属性集合 └ ht_fnp String 15000 ht_fnp └ promotion_snap_key String cc03e168e9504641ab3e2a85d967b2e7 优惠快照key └ hbs_hotel_addr String 亦庄镇贵圆南路6号。酒店属性 └ hbs_eg_order String 1 eg订单号 └ hbs_buyer_alipay_no String 20881021618066230156 买家支付宝号 └ hbs_charge_commission String [{"channel":"H","commissionType":1},{"channel":"O","commissionType":1}] 汇金 └ cancel_type String 1 取消类型 └ in_seller_service_time_order_flag String 1 卖家服务时间 └ hbs_order_total_price String 2000 总金额 └ occupancy String occupancy 人数 └ hbs_platform_promotion_amt String 0 平台优惠 └ hbs_eagle_eye_trade_id String 0a7d1d2a14994765090351122d2c85 eagle标识 └ cancel_policy_json String {"cancelPolicyType":1,"policyInfo":{}} 取消政策json └ hbs_max_other_fee String 1000 最大杂费 └ first_booking_rate_plan String false 首住RP └ snapshot_key String 1499476508322-6565-11.162.86.42-1858047322 快照key └ hbs_room_type_out_id String sell20138170-1448359538201 外部房型ID └ hbs_all_tags String 3649,641,257,5,1793,193,2052,65 标签集 └ hbs_cancel_polity_info String {"cancel":true,"direct":false,"lastCancelDate":1499529600000} 取消政策详情 └ hbs_seller_alipay_no String 20881021245500840156 支付号 └ hbs_daily_price_info String {"currencyCode":"CNY","dailyPrices":[{"afterPromotionPrice":0,"breakFastCount":0,"currencyCodeName":"CNY","day":1499443200000,"foreignCurrencyPrice":0,"mileage":0,"point":0,"price":1000,"taxForeignPrice":0,"taxPrice":0},{"afterPromotionPrice":0,"breakFastCount":0,"currencyCodeName":"CNY","day":1499529600000,"foreignCurrencyPrice":0,"mileage":0,"point":0,"price":1000,"taxForeignPrice":0,"taxPrice":0}],"exchangeRate":1} 每日房费 └ invoice_rule_t_o String {"canInvoice":1,"invoicDesc":"酒店开具发票","invoiceProvider":1,"invoiceType":"酒店住宿发票","memo":"无发票"} 发票规则 └ hbs_hotel_out_id String sell3605512164-10003759-1448359538103 外币酒店code └ hbs_create_task_key String hco_rate_plan_2300836554269_3688840202_1499476509019_10254833978210492_checkIn,2017-07-08_checkOut,2017-07-10_bizType,760 创建标记 └ hotel_area String 0 酒店区域 └ hbs_new_promotion_order String 1 营销 └ ebooking_direct_tag String 0 acm标记 └ cancel_policy_desc String 免费取消订单取消政策 └ hbs_direct String 0 直连标记 └ close_order_timeout String 30 关单时间 └ block_room String 1 保留房标记 └ morning_buy String 1 凌晨房标记 └ online_booking_room String 1 在线预约订单标识 └ hbs_pms_order_id String 123222 PMS订单号 └ upset_price String 1 低价加价订单 └ hbs_self_help_check_in String true 自助入住标识 └ hbs_xiao_shi_fang String 1 小时房标识 └ hbs_hourage String 4 小时房时长 └ advance_invocie_tag String 1 预约发票标识 └ hour_room_arrive_time String 2017-04-14 14:00:00 最早到店时间 └ hour_room_leave_time String 2017-04-14 16:00:00 最晚离店时间 └ hour_room_reserved_time String 4 小时房时长 └ is_fz_member_order String true 是否是菲住联盟会员 true or false └ booker_member_card_no String 1123123 会员卡卡号 └ invoice_status Number invoiceStatus 发票状态 └ pay_status String payStatus 付费状态 └ union_status_text String unionStatusText 联合状态字符串 └ union_status_val Number unionStatusVal 联合状态 └ check_out_room_price String checkOutRoomPrice 离店金额 └ city_name String cityName 城市 └ sub_type Number subType 子订单 └ payment_type_text String paymentTypeText 付费类型字符串 └ payment_type Number paymentType 付费类型 └ shid Number shid 标准酒店ID └ order_source_type Number orderSourceType 订单来源 └ order_date Date orderDate 订单日期 └ seller_payment Number sellerPayment 卖家支付 └ currency_code String CNY 币种 └ other_fee String otherFee 杂费 └ morning_buy_order_mark Boolean morningBuyOrderMark 凌晨房订单 └ direction_order_mark Number directionOrderMark 直连订单标记 └ total_room_price Number 12300 总房费 └ pay_time Date 2017-04-17 12:00:00 付款时间 └ alipay_trade_no String A112313 支付交易号 top_overseas_price_info TopOverseasPriceInfoDo topOverseasPriceInfoDO topOverseasPriceInfoDO └ seller_payment Number 12100 卖家金额 └ book_seller_payment Number 12100 卖家优惠 └ currency_code String CNY 币种 └ gmt_modified Date 2017-04-17 12:00:00 更新时间 └ vendor String taobao vendor └ reserved_room_order Boolean true 是否保留房 └ related_code String 112 全场景消费：校验关联码 └ logistics_status String 1 订单物流状态 └ out_confirm_code String o1234 外部订单的下单确认码 └ arrive_early Date 2017-04-17 12:00:00 最早到店时间 └ arrive_late Date 2017-04-17 12:00:00 最晚到底时间 └ channel String A 渠道信息 └ rate_id Number 123 rateId └ gid Number 123 gid └ need_confirm_no Boolean false needConfirmNO └ real_room_type_name String 大床房房型名称 └ memo String 订单备注订单备注 └ promotion_amt Number 0 卖家优惠金额 └ error_msg String 订单不存在错误信息 └ error Boolean false 错误标记 └ error_code String 1 错误码

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
XhotelOrderListSearchRequest req = new XhotelOrderListSearchRequest();
XhotelOrderListSearchRequest.OrderListParam obj1 = new XhotelOrderListSearchRequest.OrderListParam();
obj1.setPaymentType(1L);
obj1.setBuyerNick("小红");
obj1.setTids("333,444");
obj1.setOutOids("111,222");
obj1.setHids("555,666");
obj1.setCreatedStart(StringUtils.parseDateTime("2017-06-28 00:00:00"));
obj1.setCreatedEnd(StringUtils.parseDateTime("2017-06-28 00:00:00"));
obj1.setCheckinDateStart(StringUtils.parseDateTime("2017-06-28 00:00:00"));
obj1.setCheckinDateEnd(StringUtils.parseDateTime("2017-06-28 00:00:00"));
obj1.setCheckoutDateEnd(StringUtils.parseDateTime("2017-06-28 00:00:00"));
obj1.setTradeStatus("2,3");
obj1.setPageNo(1L);
obj1.setContactName("小红");
obj1.setContactPhone("13548609889");
obj1.setSubType("2");
obj1.setVendor("taobao");
obj1.setPackageOrder(true);
obj1.setCheckoutDateStart(StringUtils.parseDateTime("2017-06-28 00:00:00"));
obj1.setRelatedCode("123123");
obj1.setPartRoomOrder(true);
obj1.setEmptyOutConfirmCode(true);
obj1.setQueryType(1L);
obj1.setInvoiceStatus("1,3");
obj1.setCardId("331004199012033257");
obj1.setOrderAssociateCode(123456L);
obj1.setUpsetPrice(true);
obj1.setBookingName("小红");
obj1.setUnionStatus("101");
req.setOrderListParam(obj1);
XhotelOrderListSearchResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
XhotelOrderListSearchRequest req = new XhotelOrderListSearchRequest();
XhotelOrderListSearchRequest.OrderListParamDomain obj1 = new XhotelOrderListSearchRequest.OrderListParamDomain();
obj1.PaymentType = 1L;
obj1.BuyerNick = "小红";
obj1.Tids = "333,444";
obj1.OutOids = "111,222";
obj1.Hids = "555,666";
obj1.CreatedStart = DateTime.Parse(2017-06-28 00:00:00");
obj1.CreatedEnd = DateTime.Parse(2017-06-28 00:00:00");
obj1.CheckinDateStart = DateTime.Parse(2017-06-28 00:00:00");
obj1.CheckinDateEnd = DateTime.Parse(2017-06-28 00:00:00");
obj1.CheckoutDateEnd = DateTime.Parse(2017-06-28 00:00:00");
obj1.TradeStatus = "2,3";
obj1.PageNo = 1L;
obj1.ContactName = "小红";
obj1.ContactPhone = "13548609889";
obj1.SubType = "2";
obj1.Vendor = "taobao";
obj1.PackageOrder = true;
obj1.CheckoutDateStart = DateTime.Parse(2017-06-28 00:00:00");
obj1.RelatedCode = "123123";
obj1.PartRoomOrder = true;
obj1.EmptyOutConfirmCode = true;
obj1.QueryType = 1L;
obj1.InvoiceStatus = "1,3";
obj1.CardId = "331004199012033257";
obj1.OrderAssociateCode = 123456L;
obj1.UpsetPrice = true;
obj1.BookingName = "小红";
obj1.UnionStatus = "101";
req.OrderListParam_ = obj1;
XhotelOrderListSearchResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new XhotelOrderListSearchRequest;
$order_list_param = new OrderListParam;
$order_list_param->payment_type="1";
$order_list_param->buyer_nick="小红";
$order_list_param->tids="333,444";
$order_list_param->out_oids="111,222";
$order_list_param->hids="555,666";
$order_list_param->created_start="2017-06-28 00:00:00";
$order_list_param->created_end="2017-06-28 00:00:00";
$order_list_param->checkin_date_start="2017-06-28 00:00:00";
$order_list_param->checkin_date_end="2017-06-28 00:00:00";
$order_list_param->checkout_date_end="2017-06-28 00:00:00";
$order_list_param->trade_status="2,3";
$order_list_param->page_no="1";
$order_list_param->contact_name="小红";
$order_list_param->contact_phone="13548609889";
$order_list_param->sub_type="2";
$order_list_param->vendor="taobao";
$order_list_param->package_order="true";
$order_list_param->checkout_date_start="2017-06-28 00:00:00";
$order_list_param->related_code="123123";
$order_list_param->part_room_order="true";
$order_list_param->empty_out_confirm_code="true";
$order_list_param->query_type="1";
$order_list_param->invoice_status="1,3";
$order_list_param->card_id="331004199012033257";
$order_list_param->order_associate_code="123456";
$order_list_param->upset_price="true";
$order_list_param->booking_name="小红";
$order_list_param->union_status="101";
$req->setOrderListParam(json_encode($order_list_param));
$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.list.search' \
-d 'partner_id=apidoc' \
-d 'session=d573a828-b973-4057-a3b2-412f39860b92' \
-d 'sign=B6EEE2ECC4BD5DE2272005971A2BDBD2' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-10-31+16%3A54%3A01' \
-d 'v=2.0' \
-d 'order_list_param=null'

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

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

req.order_list_param=""
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.list.search");
add_param(pRequest,"order_list_param","数据结构JSON示例");
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.list.search', {
	'order_list_param':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<xhotel_order_list_search_response>
    <orders_result_set>
        <total_count>20</total_count>
        <top_hotel_orders>
            <top_hotel_order>
                <hid>17465037643</hid>
                <out_oid>123456</out_oid>
                <checkout_date>2017-04-14 00:00:00</checkout_date>
                <rp_name>提前3天</rp_name>
                <rp_code>测试指定房型新增rp1</rp_code>
                <rpid>8022283643</rpid>
                <type>6</type>
                <hotel_name>智选长湖店</hotel_name>
                <room_type_name>标准单间-提前3天含双早</room_type_name>
                <created>2017-04-12 10:51:44</created>
                <contact_name>IYCDHJV</contact_name>
                <checkin_date>2017-04-12 00:00:00</checkin_date>
                <nights>2</nights>
                <tid>9125720159744288</tid>
                <seller_nick>sandbox_sz_01</seller_nick>
                <room_type_code>a7057ad3-f2e7-e411-949f-1051721b417b</room_type_code>
                <room_number>1</room_number>
                <hotel_code>20d34cde-1ce4-e411-949f-1051721b417b</hotel_code>
                <payment>33600</payment>
                <contact_phone>13516555310</contact_phone>
                <trade_status>TRADE_SETTLEING</trade_status>
                <buyer_nick>jinjiangzhixingtest</buyer_nick>
                <rid>36121263643</rid>
                <top_daily_infos>
                    <top_daily_info>
                        <day>day</day>
                        <price>price</price>
                        <break_fast_count>breakFastCount</break_fast_count>
                    </top_daily_info>
                </top_daily_infos>
                <top_order_guests>
                    <top_order_guest>
                        <name>name</name>
                        <room_no>roomNo</room_no>
                        <person_no>personNo</person_no>
                        <customer_type>customerType</customer_type>
                        <age>age</age>
                    </top_order_guest>
                </top_order_guests>
                <split_order>splitOrder</split_order>
                <package_order>packageOrder</package_order>
                <block_room_order>blockRoomOrder</block_room_order>
                <discount_fee>12300</discount_fee>
                <shop_discount_fee>12300</shop_discount_fee>
                <city>420000</city>
                <book_seller_payment>1</book_seller_payment>
                <refund_status>1</refund_status>
                <top_info_map>
                    <ht_fnp>15000</ht_fnp>
                    <promotion_snap_key>cc03e168e9504641ab3e2a85d967b2e7</promotion_snap_key>
                    <hbs_hotel_addr>亦庄镇贵圆南路6号。</hbs_hotel_addr>
                    <hbs_eg_order>1</hbs_eg_order>
                    <hbs_buyer_alipay_no>20881021618066230156</hbs_buyer_alipay_no>
                    <hbs_charge_commission>[{&quot;channel&quot;:&quot;H&quot;,&quot;commissionType&quot;:1},{&quot;channel&quot;:&quot;O&quot;,&quot;commissionType&quot;:1}]</hbs_charge_commission>
                    <cancel_type>1</cancel_type>
                    <in_seller_service_time_order_flag>1</in_seller_service_time_order_flag>
                    <hbs_order_total_price>2000</hbs_order_total_price>
                    <occupancy>occupancy</occupancy>
                    <hbs_platform_promotion_amt>0</hbs_platform_promotion_amt>
                    <hbs_eagle_eye_trade_id>0a7d1d2a14994765090351122d2c85</hbs_eagle_eye_trade_id>
                    <cancel_policy_json>{&quot;cancelPolicyType&quot;:1,&quot;policyInfo&quot;:{}}</cancel_policy_json>
                    <hbs_max_other_fee>1000</hbs_max_other_fee>
                    <first_booking_rate_plan>false</first_booking_rate_plan>
                    <snapshot_key>1499476508322-6565-11.162.86.42-1858047322</snapshot_key>
                    <hbs_room_type_out_id>sell20138170-1448359538201</hbs_room_type_out_id>
                    <hbs_all_tags>3649,641,257,5,1793,193,2052,65</hbs_all_tags>
                    <hbs_cancel_polity_info>{&quot;cancel&quot;:true,&quot;direct&quot;:false,&quot;lastCancelDate&quot;:1499529600000}</hbs_cancel_polity_info>
                    <hbs_seller_alipay_no>20881021245500840156</hbs_seller_alipay_no>
                    <hbs_daily_price_info>{&quot;currencyCode&quot;:&quot;CNY&quot;,&quot;dailyPrices&quot;:[{&quot;afterPromotionPrice&quot;:0,&quot;breakFastCount&quot;:0,&quot;currencyCodeName&quot;:&quot;CNY&quot;,&quot;day&quot;:1499443200000,&quot;foreignCurrencyPrice&quot;:0,&quot;mileage&quot;:0,&quot;point&quot;:0,&quot;price&quot;:1000,&quot;taxForeignPrice&quot;:0,&quot;taxPrice&quot;:0},{&quot;afterPromotionPrice&quot;:0,&quot;breakFastCount&quot;:0,&quot;currencyCodeName&quot;:&quot;CNY&quot;,&quot;day&quot;:1499529600000,&quot;foreignCurrencyPrice&quot;:0,&quot;mileage&quot;:0,&quot;point&quot;:0,&quot;price&quot;:1000,&quot;taxForeignPrice&quot;:0,&quot;taxPrice&quot;:0}],&quot;exchangeRate&quot;:1}</hbs_daily_price_info>
                    <invoice_rule_t_o>{&quot;canInvoice&quot;:1,&quot;invoicDesc&quot;:&quot;酒店开具发票&quot;,&quot;invoiceProvider&quot;:1,&quot;invoiceType&quot;:&quot;酒店住宿发票&quot;,&quot;memo&quot;:&quot;无发票&quot;}</invoice_rule_t_o>
                    <hbs_hotel_out_id>sell3605512164-10003759-1448359538103</hbs_hotel_out_id>
                    <hbs_create_task_key>hco_rate_plan_2300836554269_3688840202_1499476509019_10254833978210492_checkIn,2017-07-08_checkOut,2017-07-10_bizType,760</hbs_create_task_key>
                    <hotel_area>0</hotel_area>
                    <hbs_new_promotion_order>1</hbs_new_promotion_order>
                    <ebooking_direct_tag>0</ebooking_direct_tag>
                    <cancel_policy_desc>免费取消订单</cancel_policy_desc>
                    <hbs_direct>0</hbs_direct>
                    <close_order_timeout>30</close_order_timeout>
                    <block_room>1</block_room>
                    <morning_buy>1</morning_buy>
                    <online_booking_room>1</online_booking_room>
                    <hbs_pms_order_id>123222</hbs_pms_order_id>
                    <upset_price>1</upset_price>
                    <hbs_self_help_check_in>true</hbs_self_help_check_in>
                    <hbs_xiao_shi_fang>1</hbs_xiao_shi_fang>
                    <hbs_hourage>4</hbs_hourage>
                    <advance_invocie_tag>1</advance_invocie_tag>
                    <hour_room_arrive_time>2017-04-14 14:00:00</hour_room_arrive_time>
                    <hour_room_leave_time>2017-04-14 16:00:00</hour_room_leave_time>
                    <hour_room_reserved_time>4</hour_room_reserved_time>
                    <is_fz_member_order>true</is_fz_member_order>
                    <booker_member_card_no>1123123</booker_member_card_no>
                </top_info_map>
                <invoice_status>invoiceStatus</invoice_status>
                <pay_status>payStatus</pay_status>
                <union_status_text>unionStatusText</union_status_text>
                <union_status_val>unionStatusVal</union_status_val>
                <check_out_room_price>checkOutRoomPrice</check_out_room_price>
                <city_name>cityName</city_name>
                <sub_type>subType</sub_type>
                <payment_type_text>paymentTypeText</payment_type_text>
                <payment_type>paymentType</payment_type>
                <shid>shid</shid>
                <order_source_type>orderSourceType</order_source_type>
                <order_date>orderDate</order_date>
                <seller_payment>sellerPayment</seller_payment>
                <currency_code>CNY</currency_code>
                <other_fee>otherFee</other_fee>
                <morning_buy_order_mark>morningBuyOrderMark</morning_buy_order_mark>
                <direction_order_mark>directionOrderMark</direction_order_mark>
                <total_room_price>12300</total_room_price>
                <pay_time>2017-04-17 12:00:00</pay_time>
                <alipay_trade_no>A112313</alipay_trade_no>
                <top_overseas_price_info>
                    <seller_payment>12100</seller_payment>
                    <book_seller_payment>12100</book_seller_payment>
                    <currency_code>CNY</currency_code>
                </top_overseas_price_info>
                <gmt_modified>2017-04-17 12:00:00</gmt_modified>
                <vendor>taobao</vendor>
                <reserved_room_order>true</reserved_room_order>
                <related_code>112</related_code>
                <logistics_status>1</logistics_status>
                <out_confirm_code>o1234</out_confirm_code>
                <arrive_early>2017-04-17 12:00:00</arrive_early>
                <arrive_late>2017-04-17 12:00:00</arrive_late>
                <channel>A</channel>
                <rate_id>123</rate_id>
                <gid>123</gid>
                <need_confirm_no>false</need_confirm_no>
                <real_room_type_name>大床房</real_room_type_name>
                <memo>订单备注</memo>
                <promotion_amt>0</promotion_amt>
            </top_hotel_order>
        </top_hotel_orders>
        <error_msg>订单不存在</error_msg>
        <error>false</error>
        <error_code>1</error_code>
    </orders_result_set>
</xhotel_order_list_search_response>

{
    "xhotel_order_list_search_response":{
        "orders_result_set":{
            "total_count":20,
            "top_hotel_orders":{
                "top_hotel_order":[
                    {
                        "hid":17465037643,
                        "out_oid":"123456",
                        "checkout_date":"2017-04-14 00:00:00",
                        "rp_name":"提前3天",
                        "rp_code":"测试指定房型新增rp1",
                        "rpid":8022283643,
                        "type":6,
                        "hotel_name":"智选长湖店",
                        "room_type_name":"标准单间-提前3天含双早",
                        "created":"2017-04-12 10:51:44",
                        "contact_name":"IYCDHJV",
                        "checkin_date":"2017-04-12 00:00:00",
                        "nights":2,
                        "tid":9125720159744288,
                        "seller_nick":"sandbox_sz_01",
                        "room_type_code":"a7057ad3-f2e7-e411-949f-1051721b417b",
                        "room_number":1,
                        "hotel_code":"20d34cde-1ce4-e411-949f-1051721b417b",
                        "payment":33600,
                        "contact_phone":"13516555310",
                        "trade_status":"TRADE_SETTLEING",
                        "buyer_nick":"jinjiangzhixingtest",
                        "rid":36121263643,
                        "top_daily_infos":{
                            "top_daily_info":[
                                {
                                    "day":"day",
                                    "price":price,
                                    "break_fast_count":breakFastCount
                                }
                            ]
                        },
                        "top_order_guests":{
                            "top_order_guest":[
                                {
                                    "name":"name",
                                    "room_no":roomNo,
                                    "person_no":personNo,
                                    "customer_type":customerType,
                                    "age":age
                                }
                            ]
                        },
                        "split_order":splitOrder,
                        "package_order":packageOrder,
                        "block_room_order":blockRoomOrder,
                        "discount_fee":12300,
                        "shop_discount_fee":12300,
                        "city":420000,
                        "book_seller_payment":1,
                        "refund_status":"1",
                        "top_info_map":{
                            "ht_fnp":"15000",
                            "promotion_snap_key":"cc03e168e9504641ab3e2a85d967b2e7",
                            "hbs_hotel_addr":"亦庄镇贵圆南路6号。",
                            "hbs_eg_order":"1",
                            "hbs_buyer_alipay_no":"20881021618066230156",
                            "hbs_charge_commission":"[{\"channel\":\"H\",\"commissionType\":1},{\"channel\":\"O\",\"commissionType\":1}]",
                            "cancel_type":"1",
                            "in_seller_service_time_order_flag":"1",
                            "hbs_order_total_price":"2000",
                            "occupancy":"occupancy",
                            "hbs_platform_promotion_amt":"0",
                            "hbs_eagle_eye_trade_id":"0a7d1d2a14994765090351122d2c85",
                            "cancel_policy_json":"{\"cancelPolicyType\":1,\"policyInfo\":{}}",
                            "hbs_max_other_fee":"1000",
                            "first_booking_rate_plan":"false",
                            "snapshot_key":"1499476508322-6565-11.162.86.42-1858047322",
                            "hbs_room_type_out_id":"sell20138170-1448359538201",
                            "hbs_all_tags":"3649,641,257,5,1793,193,2052,65",
                            "hbs_cancel_polity_info":"{\"cancel\":true,\"direct\":false,\"lastCancelDate\":1499529600000}",
                            "hbs_seller_alipay_no":"20881021245500840156",
                            "hbs_daily_price_info":"{\"currencyCode\":\"CNY\",\"dailyPrices\":[{\"afterPromotionPrice\":0,\"breakFastCount\":0,\"currencyCodeName\":\"CNY\",\"day\":1499443200000,\"foreignCurrencyPrice\":0,\"mileage\":0,\"point\":0,\"price\":1000,\"taxForeignPrice\":0,\"taxPrice\":0},{\"afterPromotionPrice\":0,\"breakFastCount\":0,\"currencyCodeName\":\"CNY\",\"day\":1499529600000,\"foreignCurrencyPrice\":0,\"mileage\":0,\"point\":0,\"price\":1000,\"taxForeignPrice\":0,\"taxPrice\":0}],\"exchangeRate\":1}",
                            "invoice_rule_t_o":"{\"canInvoice\":1,\"invoicDesc\":\"酒店开具发票\",\"invoiceProvider\":1,\"invoiceType\":\"酒店住宿发票\",\"memo\":\"无发票\"}",
                            "hbs_hotel_out_id":"sell3605512164-10003759-1448359538103",
                            "hbs_create_task_key":"hco_rate_plan_2300836554269_3688840202_1499476509019_10254833978210492_checkIn,2017-07-08_checkOut,2017-07-10_bizType,760",
                            "hotel_area":"0",
                            "hbs_new_promotion_order":"1",
                            "ebooking_direct_tag":"0",
                            "cancel_policy_desc":"免费取消订单",
                            "hbs_direct":"0",
                            "close_order_timeout":"30",
                            "block_room":"1",
                            "morning_buy":"1",
                            "online_booking_room":"1",
                            "hbs_pms_order_id":"123222",
                            "upset_price":"1",
                            "hbs_self_help_check_in":"true",
                            "hbs_xiao_shi_fang":"1",
                            "hbs_hourage":"4",
                            "advance_invocie_tag":"1",
                            "hour_room_arrive_time":"2017-04-14 14:00:00",
                            "hour_room_leave_time":"2017-04-14 16:00:00",
                            "hour_room_reserved_time":"4",
                            "is_fz_member_order":"true",
                            "booker_member_card_no":"1123123"
                        },
                        "invoice_status":invoiceStatus,
                        "pay_status":"payStatus",
                        "union_status_text":"unionStatusText",
                        "union_status_val":unionStatusVal,
                        "check_out_room_price":"checkOutRoomPrice",
                        "city_name":"cityName",
                        "sub_type":subType,
                        "payment_type_text":"paymentTypeText",
                        "payment_type":paymentType,
                        "shid":shid,
                        "order_source_type":orderSourceType,
                        "order_date":"orderDate",
                        "seller_payment":sellerPayment,
                        "currency_code":"CNY",
                        "other_fee":"otherFee",
                        "morning_buy_order_mark":morningBuyOrderMark,
                        "direction_order_mark":directionOrderMark,
                        "total_room_price":12300,
                        "pay_time":"2017-04-17 12:00:00",
                        "alipay_trade_no":"A112313",
                        "top_overseas_price_info":{
                            "seller_payment":12100,
                            "book_seller_payment":12100,
                            "currency_code":"CNY"
                        },
                        "gmt_modified":"2017-04-17 12:00:00",
                        "vendor":"taobao",
                        "reserved_room_order":true,
                        "related_code":"112",
                        "logistics_status":"1",
                        "out_confirm_code":"o1234",
                        "arrive_early":"2017-04-17 12:00:00",
                        "arrive_late":"2017-04-17 12:00:00",
                        "channel":"A",
                        "rate_id":123,
                        "gid":123,
                        "need_confirm_no":false,
                        "real_room_type_name":"大床房",
                        "memo":"订单备注",
                        "promotion_amt":0
                    }
                ]
            },
            "error_msg":"订单不存在",
            "error":false,
            "error_code":"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"
	}
}

错误码	错误描述	解决方案
ORDER_NOT_EXIST	查询不存在的订单	查询存在的订单
isv.order-error:ORDER_NOT_EXIST	ORDER_NOT_EXIST	ORDER_NOT_EXIST

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

开放平台

酒店在线预订API

taobao.xhotel.order.list.search (订单列表查询)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ