淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	描述
tenant_key	String	必须	10006373010	租户标识
token	String	必须	tokenasdasd	用户token
order_status	String	可选	待确认	订单状态
start_time	String	可选	2021-05-25	入住时间
end_time	String	可选	2021-05-30	入住时间
page	Number	可选	1	页数
row	Number	可选	10	每页行数

名称	类型	示例值	描述
result	Response		默认描述
└ success Boolean true 成功 └ error_code String 000000 错误码 order_dtos OrderDto [] 查询结果 └ bed_name String 大床床型名称 └ currency String CNY 币种 └ pay_remain_time Number 1234 支付剩余时间 └ order_status String 2 订单状态 └ total_amount String 264.00 用户支付总价 └ book_date String 2021-12-15 16:37:45 预订日期 └ contact_name String qiaofei 入住人姓名 └ check_out_date String 2022-01-09 离店时间 └ check_in_date String 2022-01-08 入住时间 └ room_number Number 1 房间数量 └ room_name String 双床房房型名称 └ hotel_name String 宜必思杭州西湖庆春路酒店酒店名称 └ order_code String 8159377729066958848 订单号 └ room_photo_url String https://fm-unicorn-hotel.oss-cn-beijing.aliyuncs.com/10006373010/room/B2U2/60186559/O1CN01zEOFal1qOB3qCWDiB_%21%216000000005485-0-hotel.jpg 房型照片 └ shid Number 53900007 酒店房型id └ hotel_id String B2U2 酒店外部id └ adult_number Number 1 成人数量 └ children_number Number 0 儿童数量 └ place_order_type String COMMON 下单类型 └ universal_coupon_id String 12345678 通用券id └ spread String 50.00 差价 └ voucher_name String 三亚三日亲子套餐代金券名称 foreign_currency ForeignCurrencyInfo 外币信息 └ total_amount String 111.11 外币支付金额，含税 └ total_price String 100.00 外币基础价格,不包含税费等 └ total_tax String 11.11 外币总税价 daily_price_list DailyPrice [] 外币每日价格 └ date String 2021-12-31 00:00:00 日期 └ really_price String 100.00 不含税价格单位元 └ out_really_price String 168.68 不含税外币价格单位元 └ currency String HKD 外币币种 └ foreign_currency_payment Boolean false 是否为外币支付 └ error_msg String 无错误信息 └ page_size Number 10 每页的数量 └ size Number 1 当前页的数量 └ page_no Number 1 当前页 └ has_next_page Boolean true 是否有下一页 └ total_page_num Number 20 总页数 └ total_count Number 200 结果总数

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlitripMerchantGalaxyOrderListQueryRequest req = new AlitripMerchantGalaxyOrderListQueryRequest();
req.setTenantKey("10006373010");
req.setToken("tokenasdasd");
req.setOrderStatus("待确认");
req.setStartTime("2021-05-25");
req.setEndTime("2021-05-30");
req.setPage(1L);
req.setRow(10L);
AlitripMerchantGalaxyOrderListQueryResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlitripMerchantGalaxyOrderListQueryRequest req = new AlitripMerchantGalaxyOrderListQueryRequest();
req.TenantKey = "10006373010";
req.Token = "tokenasdasd";
req.OrderStatus = "待确认";
req.StartTime = "2021-05-25";
req.EndTime = "2021-05-30";
req.Page = 1L;
req.Row = 10L;
AlitripMerchantGalaxyOrderListQueryResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlitripMerchantGalaxyOrderListQueryRequest;
$req->setTenantKey("10006373010");
$req->setToken("tokenasdasd");
$req->setOrderStatus("待确认");
$req->setStartTime("2021-05-25");
$req->setEndTime("2021-05-30");
$req->setPage("1");
$req->setRow("10");
$resp = $c->execute($req);

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=alitrip.merchant.galaxy.order.list.query' \
-d 'partner_id=apidoc' \
-d 'sign=B67199BC5B91EAE3F996C0A35D9C800E' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-05+18%3A34%3A37' \
-d 'v=2.0' \
-d 'end_time=2021-05-30' \
-d 'order_status=%E5%BE%85%E7%A1%AE%E8%AE%A4' \
-d 'page=1' \
-d 'row=10' \
-d 'start_time=2021-05-25' \
-d 'tenant_key=10006373010' \
-d 'token=tokenasdasd'

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

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

req.tenant_key="10006373010"
req.token="tokenasdasd"
req.order_status="待确认"
req.start_time="2021-05-25"
req.end_time="2021-05-30"
req.page=1
req.row=10
try:
	resp= req.getResponse()
	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,"alitrip.merchant.galaxy.order.list.query");
add_param(pRequest,"tenant_key","10006373010");
add_param(pRequest,"token","tokenasdasd");
add_param(pRequest,"order_status","待确认");
add_param(pRequest,"start_time","2021-05-25");
add_param(pRequest,"end_time","2021-05-30");
add_param(pRequest,"page","1");
add_param(pRequest,"row","10");
pResponse = top_execute(pClient,pRequest,NULL);
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('alitrip.merchant.galaxy.order.list.query', {
	'tenant_key':'10006373010',
	'token':'tokenasdasd',
	'order_status':'待确认',
	'start_time':'2021-05-25',
	'end_time':'2021-05-30',
	'page':'1',
	'row':'10'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alitrip_merchant_galaxy_order_list_query_response>
    <result>
        <success>true</success>
        <error_code>000000</error_code>
        <order_dtos>
            <order_dto>
                <bed_name>大床</bed_name>
                <currency>CNY</currency>
                <pay_remain_time>1234</pay_remain_time>
                <order_status>2</order_status>
                <total_amount>264.00</total_amount>
                <book_date>2021-12-15 16:37:45</book_date>
                <contact_name>qiaofei</contact_name>
                <check_out_date>2022-01-09</check_out_date>
                <check_in_date>2022-01-08</check_in_date>
                <room_number>1</room_number>
                <room_name>双床房</room_name>
                <hotel_name>宜必思杭州西湖庆春路酒店</hotel_name>
                <order_code>8159377729066958848</order_code>
                <room_photo_url>https://fm-unicorn-hotel.oss-cn-beijing.aliyuncs.com/10006373010/room/B2U2/60186559/O1CN01zEOFal1qOB3qCWDiB_%21%216000000005485-0-hotel.jpg</room_photo_url>
                <shid>53900007</shid>
                <hotel_id>B2U2</hotel_id>
                <adult_number>1</adult_number>
                <children_number>0</children_number>
                <place_order_type>COMMON</place_order_type>
                <universal_coupon_id>12345678</universal_coupon_id>
                <spread>50.00</spread>
                <voucher_name>三亚三日亲子套餐</voucher_name>
                <foreign_currency>
                    <total_amount>111.11</total_amount>
                    <total_price>100.00</total_price>
                    <total_tax>11.11</total_tax>
                    <daily_price_list>
                        <daily_price>
                            <date>2021-12-31 00:00:00</date>
                            <really_price>100.00</really_price>
                            <out_really_price>168.68</out_really_price>
                        </daily_price>
                    </daily_price_list>
                    <currency>HKD</currency>
                </foreign_currency>
                <foreign_currency_payment>false</foreign_currency_payment>
            </order_dto>
        </order_dtos>
        <error_msg>无</error_msg>
        <page_size>10</page_size>
        <size>1</size>
        <page_no>1</page_no>
        <has_next_page>true</has_next_page>
        <total_page_num>20</total_page_num>
        <total_count>200</total_count>
    </result>
</alitrip_merchant_galaxy_order_list_query_response>

{
    "alitrip_merchant_galaxy_order_list_query_response":{
        "result":{
            "success":true,
            "error_code":"000000",
            "order_dtos":{
                "order_dto":[
                    {
                        "bed_name":"大床",
                        "currency":"CNY",
                        "pay_remain_time":1234,
                        "order_status":"2",
                        "total_amount":"264.00",
                        "book_date":"2021-12-15 16:37:45",
                        "contact_name":"qiaofei",
                        "check_out_date":"2022-01-09",
                        "check_in_date":"2022-01-08",
                        "room_number":1,
                        "room_name":"双床房",
                        "hotel_name":"宜必思杭州西湖庆春路酒店",
                        "order_code":"8159377729066958848",
                        "room_photo_url":"https:\/\/fm-unicorn-hotel.oss-cn-beijing.aliyuncs.com\/10006373010\/room\/B2U2\/60186559\/O1CN01zEOFal1qOB3qCWDiB_%21%216000000005485-0-hotel.jpg",
                        "shid":53900007,
                        "hotel_id":"B2U2",
                        "adult_number":1,
                        "children_number":0,
                        "place_order_type":"COMMON",
                        "universal_coupon_id":"12345678",
                        "spread":"50.00",
                        "voucher_name":"三亚三日亲子套餐",
                        "foreign_currency":{
                            "total_amount":"111.11",
                            "total_price":"100.00",
                            "total_tax":"11.11",
                            "daily_price_list":{
                                "daily_price":[
                                    {
                                        "date":"2021-12-31 00:00:00",
                                        "really_price":"100.00",
                                        "out_really_price":"168.68"
                                    }
                                ]
                            },
                            "currency":"HKD"
                        },
                        "foreign_currency_payment":false
                    }
                ]
            },
            "error_msg":"无",
            "page_size":10,
            "size":1,
            "page_no":1,
            "has_next_page":true,
            "total_page_num":20,
            "total_count":200
        }
    }
}

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

开放平台

飞猪商家平台

alitrip.merchant.galaxy.order.list.query (星河-订单列表查询)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ