淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
rq	OpenSearchRq	可选			请求
└ start_time Date 可选 2017-05-01 00:00:00 创建开始时间 └ apply_id Number 可选 123 审批单id └ page Number 可选 0 页数，从1开始 └ page_size Number 可选 10 每页返回数量，默认10，最大50 └ depart_id String 可选 depart_1 部门id └ end_time Date 可选 2017-05-01 00:00:00 创建结束时间 └ corp_id String 必须 corp_id 企业id └ user_id String 可选 user_1 用户id └ update_end_time Date 可选 2017-05-01 00:00:00 修改开始时间 └ update_start_time Date 可选 2017-05-01 00:00:00 修改结束时间

名称	类型	示例值	描述
result	BtriphomeResultSupport	result	返回结果
train_order_list OpenTrainOrderRs [] train_order_list 火车票订单列表 └ id Number 123 订单id └ gmt_create Date 2017-05-01 00:00:00 创建时间 └ corp_id String corp_1 企业Id └ gmt_modified Date 2017-05-01 00:00:00 更新时间 └ corp_name String 测试企业企业名称 └ user_id String user_1 用户id └ user_name String 测试用户用户名称 └ depart_id String depart_1 部门id └ depart_name String 测试部门部门名称 └ apply_id Number 123 申请单id └ contact_name String 测试用户联系人名称 └ contact_phone String 13600000000 联系人电话 └ dep_station String 北京南出发站 └ arr_station String 杭州东到达站 └ dep_time Date 2017-05-01 00:00:00 出发时间 └ arr_time Date 2017-05-01 00:00:00 到达时间 └ train_number String G106 车次 └ train_type String 高速动车车次类型 └ seat_type String 二等座座位类型 └ run_time String 5时32分运行时长 └ dep_city String 北京出发城市 └ ticket_no12306 String E952714184 12306票号 └ arr_city String 杭州到达城市 └ rider_name String 测试用户1/测试用户2 乘客姓名 └ ticket_count Number 2 票的数量 price_info_list OpenPriceInfo [] price_info_list 价目信息 └ pay_type Number 1 结算方式:1：个人现付，2:企业现付,4:企业月结，8、企业预存 └ category String 预定成功消费类型 └ type Number 1 资金流向:1:支出，2:收入 └ price String 100.0 价格 └ gmt_create Date 2017-05-01 00:00:00 流水创建时间 └ alipay_trade_no String 208810000000000 支付流水号 └ passenger_name String 张三,李四乘车人，多个用‘,’分割 └ trade_id String 787878787001 订单交易流水号 └ status Number 1 订单状态：0待支付,1出票中,2已关闭(未支付，已经关闭),3,改签成功,4退票成功,5出票完成,6退票申请中,7改签申请中,8已出票,已经邮寄了,9出票失败,10改签失败,11退票失败 cost_center OpenCostCenterDo 成本中心成本中心对象 └ name String 测试成本中心成本中心名称 └ number String abc 成本中心编号 └ corp_id String corp_1 企业Id invoice OpenInvoiceDo 发票信息对象发票信息对象 └ title String 阿里巴巴发票抬头 └ id Number 123 商旅发票id └ thirdpart_itinerary_id String abcdef 第三方行程id user_affiliate_list OpenUserAffiliateDo [] 张三,李四出行人列表 └ user_id String 123 出行人ID └ user_name String 张三出行人名称 └ success Boolean true 成功标识 └ result_msg String 成功返回信息 └ result_code Number 0 返回码

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlitripBtripTrainOrderSearchRequest req = new AlitripBtripTrainOrderSearchRequest();
AlitripBtripTrainOrderSearchRequest.OpenSearchRq obj1 = new AlitripBtripTrainOrderSearchRequest.OpenSearchRq();
obj1.setStartTime(StringUtils.parseDateTime("2017-05-01 00:00:00"));
obj1.setApplyId(123L);
obj1.setPage(0L);
obj1.setPageSize(10L);
obj1.setDepartId("depart_1");
obj1.setEndTime(StringUtils.parseDateTime("2017-05-01 00:00:00"));
obj1.setCorpId("corp_id");
obj1.setUserId("user_1");
obj1.setUpdateEndTime(StringUtils.parseDateTime("2017-05-01 00:00:00"));
obj1.setUpdateStartTime(StringUtils.parseDateTime("2017-05-01 00:00:00"));
req.setRq(obj1);
AlitripBtripTrainOrderSearchResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlitripBtripTrainOrderSearchRequest req = new AlitripBtripTrainOrderSearchRequest();
AlitripBtripTrainOrderSearchRequest.OpenSearchRqDomain obj1 = new AlitripBtripTrainOrderSearchRequest.OpenSearchRqDomain();
obj1.StartTime = DateTime.Parse(2017-05-01 00:00:00");
obj1.ApplyId = 123L;
obj1.Page = 0L;
obj1.PageSize = 10L;
obj1.DepartId = "depart_1";
obj1.EndTime = DateTime.Parse(2017-05-01 00:00:00");
obj1.CorpId = "corp_id";
obj1.UserId = "user_1";
obj1.UpdateEndTime = DateTime.Parse(2017-05-01 00:00:00");
obj1.UpdateStartTime = DateTime.Parse(2017-05-01 00:00:00");
req.Rq_ = obj1;
AlitripBtripTrainOrderSearchResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlitripBtripTrainOrderSearchRequest;
$rq = new OpenSearchRq;
$rq->start_time="2017-05-01 00:00:00";
$rq->apply_id="123";
$rq->page="0";
$rq->page_size="10";
$rq->depart_id="depart_1";
$rq->end_time="2017-05-01 00:00:00";
$rq->corp_id="corp_id";
$rq->user_id="user_1";
$rq->update_end_time="2017-05-01 00:00:00";
$rq->update_start_time="2017-05-01 00:00:00";
$req->setRq(json_encode($rq));
$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=alitrip.btrip.train.order.search' \
-d 'partner_id=apidoc' \
-d 'session=5172a10e-0e40-4039-87d5-aeb95691fc3f' \
-d 'sign=0D48AAC184C8675EC369EDB935365E38' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-10-31+23%3A45%3A12' \
-d 'v=2.0' \
-d 'rq=null'

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

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

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

XML示例
JSON示例

<alitrip_btrip_train_order_search_response>
    <result>
        <train_order_list>
            <open_train_order_rs>
                <id>123</id>
                <gmt_create>2017-05-01 00:00:00</gmt_create>
                <corp_id>corp_1</corp_id>
                <gmt_modified>2017-05-01 00:00:00</gmt_modified>
                <corp_name>测试企业</corp_name>
                <user_id>user_1</user_id>
                <user_name>测试用户</user_name>
                <depart_id>depart_1</depart_id>
                <depart_name>测试部门</depart_name>
                <apply_id>123</apply_id>
                <contact_name>测试用户</contact_name>
                <contact_phone>13600000000</contact_phone>
                <dep_station>北京南</dep_station>
                <arr_station>杭州东</arr_station>
                <dep_time>2017-05-01 00:00:00</dep_time>
                <arr_time>2017-05-01 00:00:00</arr_time>
                <train_number>G106</train_number>
                <train_type>高速动车</train_type>
                <seat_type>二等座</seat_type>
                <run_time>5时32分</run_time>
                <dep_city>北京</dep_city>
                <ticket_no12306>E952714184</ticket_no12306>
                <arr_city>杭州</arr_city>
                <rider_name>测试用户1/测试用户2</rider_name>
                <ticket_count>2</ticket_count>
                <price_info_list>
                    <open_price_info>
                        <pay_type>1</pay_type>
                        <category>预定成功</category>
                        <type>1</type>
                        <price>100.0</price>
                        <gmt_create>2017-05-01 00:00:00</gmt_create>
                        <alipay_trade_no>208810000000000</alipay_trade_no>
                        <passenger_name>张三,李四</passenger_name>
                        <trade_id>787878787001</trade_id>
                    </open_price_info>
                </price_info_list>
                <status>1</status>
                <cost_center>
                    <name>测试成本中心</name>
                    <number>abc</number>
                    <corp_id>corp_1</corp_id>
                </cost_center>
                <invoice>
                    <title>阿里巴巴</title>
                    <id>123</id>
                </invoice>
                <thirdpart_itinerary_id>abcdef</thirdpart_itinerary_id>
                <user_affiliate_list>
                    <open_user_affiliate_do>
                        <user_id>123</user_id>
                        <user_name>张三</user_name>
                    </open_user_affiliate_do>
                </user_affiliate_list>
            </open_train_order_rs>
        </train_order_list>
        <success>true</success>
        <result_msg>成功</result_msg>
        <result_code>0</result_code>
    </result>
</alitrip_btrip_train_order_search_response>

{
    "alitrip_btrip_train_order_search_response":{
        "result":{
            "train_order_list":{
                "open_train_order_rs":[
                    {
                        "id":123,
                        "gmt_create":"2017-05-01 00:00:00",
                        "corp_id":"corp_1",
                        "gmt_modified":"2017-05-01 00:00:00",
                        "corp_name":"测试企业",
                        "user_id":"user_1",
                        "user_name":"测试用户",
                        "depart_id":"depart_1",
                        "depart_name":"测试部门",
                        "apply_id":123,
                        "contact_name":"测试用户",
                        "contact_phone":"13600000000",
                        "dep_station":"北京南",
                        "arr_station":"杭州东",
                        "dep_time":"2017-05-01 00:00:00",
                        "arr_time":"2017-05-01 00:00:00",
                        "train_number":"G106",
                        "train_type":"高速动车",
                        "seat_type":"二等座",
                        "run_time":"5时32分",
                        "dep_city":"北京",
                        "ticket_no12306":"E952714184",
                        "arr_city":"杭州",
                        "rider_name":"测试用户1\/测试用户2",
                        "ticket_count":2,
                        "price_info_list":{
                            "open_price_info":[
                                {
                                    "pay_type":1,
                                    "category":"预定成功",
                                    "type":1,
                                    "price":"100.0",
                                    "gmt_create":"2017-05-01 00:00:00",
                                    "alipay_trade_no":"208810000000000",
                                    "passenger_name":"张三,李四",
                                    "trade_id":"787878787001"
                                }
                            ]
                        },
                        "status":1,
                        "cost_center":{
                            "name":"测试成本中心",
                            "number":"abc",
                            "corp_id":"corp_1"
                        },
                        "invoice":{
                            "title":"阿里巴巴",
                            "id":123
                        },
                        "thirdpart_itinerary_id":"abcdef",
                        "user_affiliate_list":{
                            "open_user_affiliate_do":[
                                {
                                    "user_id":"123",
                                    "user_name":"张三"
                                }
                            ]
                        }
                    }
                ]
            },
            "success":true,
            "result_msg":"成功",
            "result_code":0
        }
    }
}

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

alitrip.btrip.train.order.search (获取火车票订单列表)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ