飞猪 - 开放平台

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
from_city_name	String	可选	北京		出发城市名称
from_city_code	String	可选	C001		出发城市code

名称	类型	示例值	描述
ret_desc	String	成功	错误描述
route_list	ShipRoute []		路线列表
└ to_city_name String 深圳到达城市名称 └ from_station_name String 香港机场海天码头出发港口 └ line_name String 普通班次线路名称 └ to_station_code String 123456 到达港口code └ to_station_address String 蛇口港出发港口详细地址 └ to_province_name String 深圳到达属省份 └ to_station_longitude String 105.469673 到达经度 └ to_station_name String 蛇口港到达港口名称 └ from_city_code String 001 出发城市名称 └ lineDesc String xxx 航线描述 └ to_station_latitude String 35.033114 到达纬度 └ from_city_name String 香港出发城市名称 └ from_station_code String 123456789 出发港口code └ region_name String 珠三角区域名 └ to_city_code String 深圳到达城市编码 └ presell_time Number 120 班次发车前可售时间，单位分钟 └ refund_msg String xx 退票提示(1:在线退票 2:不可在线退票 3:不可退票) └ sell_end_time String 18:00 网上可售结束时间HH:mm(18:00)，不传默认无限制 └ is_order_refund Boolean 1 是否按照整个订单退款 └ sell_start_time String 05:00 网上可售开始时间HH:mm(06:00)，不传默认无限制 └ obtain_voucher String 凭订单号和身份证取票取票方式（0:凭身份证自助机取票 1:凭取票号取票，2:支持刷身份证乘车，3:-柜台取票,默认为0） └ max_sell_num Number 5 一单最大乘车人数, 不传默认无限制 └ refund_time Number 120 发车前允许退票时间（单位分钟） └ service_price String 100 服务费 └ is_refund String 1 是否会允许退票 └ support_eticket String true 是否支持电子票 └ presell_day String 7 预售期，不传默认设置为60
ret_code	String	0	错误码
extAttr	String	{"param":"param"}	扩展属性 json格式
success	String	true	成功状态

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

QimenCloudClient client = new DefaultQimenCloudClient(url, appkey, secret);
AlitripShipProductQueryrouteRequest req = new AlitripShipProductQueryrouteRequest();
req.setFromCityName("北京");
req.setFromCityCode("C001");
AlitripShipProductQueryrouteResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlitripShipProductQueryrouteRequest req = new AlitripShipProductQueryrouteRequest();
req.FromCityName = "北京";
req.FromCityCode = "C001";
AlitripShipProductQueryrouteResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlitripShipProductQueryrouteRequest;
$req->setFromCityName("北京");
$req->setFromCityCode("C001");
$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=qimen.alitrip.ship.product.queryroute' \
-d 'partner_id=apidoc' \
-d 'sign=573316B464676A6C9866B6DA3FE0BA13' \
-d 'sign_method=hmac' \
-d 'timestamp=2024-05-02+06%3A06%3A22' \
-d 'v=2.0' \
-d 'from_city_code=C001' \
-d 'from_city_name=%E5%8C%97%E4%BA%AC'

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

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

req.from_city_name="北京"
req.from_city_code="C001"
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,"qimen.alitrip.ship.product.queryroute");
add_param(pRequest,"from_city_name","北京");
add_param(pRequest,"from_city_code","C001");
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('qimen.alitrip.ship.product.queryroute', {
	'from_city_name':'北京',
	'from_city_code':'C001'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<ret_desc>成功</ret_desc>
<route_list>
    <ship_route>
        <to_city_name>深圳</to_city_name>
        <from_station_name>香港机场海天码头</from_station_name>
        <line_name>普通班次</line_name>
        <to_station_code>123456</to_station_code>
        <to_station_address>蛇口港</to_station_address>
        <to_province_name>深圳</to_province_name>
        <to_station_longitude>105.469673</to_station_longitude>
        <to_station_name>蛇口港</to_station_name>
        <from_city_code>001</from_city_code>
        <lineDesc>xxx</lineDesc>
        <to_station_latitude>35.033114</to_station_latitude>
        <from_city_name>香港</from_city_name>
        <from_station_code>123456789</from_station_code>
        <region_name>珠三角</region_name>
        <to_city_code>深圳</to_city_code>
        <presell_time>120</presell_time>
        <refund_msg>xx</refund_msg>
        <sell_end_time>18:00</sell_end_time>
        <is_order_refund>1</is_order_refund>
        <sell_start_time>05:00</sell_start_time>
        <obtain_voucher>凭订单号和身份证取票</obtain_voucher>
        <max_sell_num>5</max_sell_num>
        <refund_time>120</refund_time>
        <service_price>100</service_price>
        <is_refund>1</is_refund>
        <support_eticket>true</support_eticket>
        <presell_day>7</presell_day>
    </ship_route>
</route_list>
<ret_code>0</ret_code>
<extAttr>{&quot;param&quot;:&quot;param&quot;}</extAttr>
<success>true</success>

{
    "ret_desc":"成功",
    "route_list":{
        "ship_route":[
            {
                "to_city_name":"深圳",
                "from_station_name":"香港机场海天码头",
                "line_name":"普通班次",
                "to_station_code":"123456",
                "to_station_address":"蛇口港",
                "to_province_name":"深圳",
                "to_station_longitude":"105.469673",
                "to_station_name":"蛇口港",
                "from_city_code":"001",
                "lineDesc":"xxx",
                "to_station_latitude":"35.033114",
                "from_city_name":"香港",
                "from_station_code":"123456789",
                "region_name":"珠三角",
                "to_city_code":"深圳",
                "presell_time":120,
                "refund_msg":"xx",
                "sell_end_time":"18:00",
                "is_order_refund":1,
                "sell_start_time":"05:00",
                "obtain_voucher":"凭订单号和身份证取票",
                "max_sell_num":5,
                "refund_time":120,
                "service_price":"100",
                "is_refund":"1",
                "support_eticket":"true",
                "presell_day":"7"
            }
        ]
    },
    "ret_code":"0",
    "extAttr":"{\"param\":\"param\"}",
    "success":"true"
}

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

开放平台

综合交通-商家对接

qimen.alitrip.ship.product.queryroute (查询路线接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ