淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
index_metric_route_query_request	IndexMetricRouteQueryRequest	必须			线路维度指标值查询入参
└ request_time Number 必须 1689067417799 业务请求时间戳（毫秒） └ request_id String 必须 xxx1689067417799xxx 业务请求ID（服务商发起请求的ID） └ supplier_id String 必须 1000001 淘天物流服务商ID └ metric_code String 必须 fetch_sign_achievement_rate 指标code：「fetch_sign_achievement_rate」揽签时效达成率、「long_sign_order_rate」超长单占比、「logistics_stagnation_rate」物流环节停滞率、「wan_qiu_service_rate」物流万求、「tp_service_resolve_rate」首次求助解决率、「new_policy_achievement_rate」新政按需履约达成率、「trajectory_complete_rate」轨迹信息真实率、「logistics_refund_rate」物流原因退款率、「logistics_abnormal_rate」物流问订率、「sign_order_defect_rate」签收问订率、「track_integrity_rate」轨迹信息完整率、「seller_rule_stagnation_rate」物流异常率 └ time_type String 必须 DAY 时间维度类型：「DAY」日视图、「WEEK」周视图、「MONTH」月视图 └ time_value String 必须 2025-01-01 时间维度值：日视图填「年-月-日(yyyy-MM-dd)」、周视图填「年-周(yyyy-ww)」、月视图填「年-月(yyyy-MM)」 └ from_division_id Number 可选 1 发货地地址ID，可调用标准地址库id查询接口进行查询，仅支持全国（传1）、省、市级数据。metric_code为「new_policy_achievement_rate」、「trajectory_complete_rate」、「sign_order_defect_rate」时，只支持全国 └ to_division_id Number 可选 1 收货地地址ID，可调用标准地址库id查询接口进行查询，仅支持全国（传1）、省、市级数据。metric_code为「logistics_refund_rate」时，只支持全国。若传toDivisionId，则其类型需和to_division_type匹配，对应端面「单选一个收货地」操作。若查「市-市」维度，则from_division_id和to_division_id需要至少有一个非空 └ query_scope String 必须 STO 查询范围：「YTO」圆通、「ZTO」中通、「STO」申通、「YUNDA」韵达、「JT」极兔、「SF」顺丰、「POSTB」邮政小包、「JDLKD」京东快递 └ comparison_range String 必须 industry 对比范围：「industry」行业、「franchise」加盟 └ from_division_type String 可选 all 发货地址类型：「all」全国、「province」省、「city」市。若不传，则from_division_id必填，使用from_division_id解析结果。若传from_division_type且不传fromDivisionId，则代表全选该发货地类型下所有地址id └ to_division_type String 可选 all 收货地址类型：「all」全国、「province」省、「city」市。若不传，则to_division_id必填，使用to_division_id解析结果。若传to_division_type且不传to_division_id，则代表全选该收货地类型下所有地址id └ page_index Number 可选 1 分页页码，从1开始。若传空，则默认为1 └ page_size Number 可选 100 分页每页大小，不超过100。若传空，则默认为100

名称	类型	示例值	描述
index_metric_route_query_response	IndexMetricRouteQueryResponse	无	线路维度指标值查询出参
└ success Boolean true 是否成功：「true」、「false」 └ code String SYSTEM_ERROR 错误码 └ message String 系统繁忙，请稍后重试错误信息 data IndexMetricRouteQueryResult 无返回对象 └ best_index_value String 1.00% 单线路指标最优值（行业/加盟）：查询结果为单线路时，该字段会返值；多线路时为空，请使用brand_index_list内的best_index_value字段 brand_index_list LspIndexMetricBrand [] 品牌指标列表 └ tt_brand_code String STO 淘天品牌Code └ tt_brand_name String 申通快递淘天品牌名称 └ index_value String 1.00% 指标值 fetch_sign_index_value LspIndexMetricFetchSign 无【弃用，请使用drill_list】各揽签时效下的指标值 └ fetch_sign_one_day String 1.00% 揽签1日达 └ fetch_sign_two_days String 1.00% 揽签2日达 └ fetch_sign_three_days String 1.00% 揽签3日达 └ fetch_sign_four_days String 1.00% 揽签4日达 └ fetch_sign_five_days String 1.00% 揽签5日达 stagnation_index_value LspIndexMetricStagnation 无【弃用，请使用drill_list】各停滞类型下指标值 └ stagnation_fetch String 1.00% 揽收停滞 └ stagnation_transport String 1.00% 运输节点内停滞 └ stagnation_transport_between String 1.00% 运输节点间停滞 └ stagnation_delivery_sign String 1.00% 派签停滞 trajectory_index_value LspIndexMetricTrajectory 无【弃用，请使用drill_list】各轨迹信息类型下的指标值 └ station_brand String 1.00% 驿站品牌 └ station_address String 1.00% 驿站地址 └ station_phone String 1.00% 驿站电话 └ pick_up_code String 1.00% 取件码 └ rank Number 1 排名 └ best_index_value String 1.00% 线路-指标最优值（行业/加盟） division LspIndexDivision 地址 └ from_province_id String 1/其他 1/其他发货地省份id。值可能为地址id（Long类型），也可能为「其他」（汉字） └ from_province_name String 全国/其他发货地省份 └ from_city_id String 330100/其他发货地城市id。值可能为地址id（Long类型），也可能为「其他」（汉字）。选「全国」、「省」维度时为空 └ from_city_name String 杭州市/其他发货地城市。选「全国」、「省」维度时为空 └ to_province_id String 1/其他收货地省份id。值可能为地址id（Long类型），也可能为「其他」（汉字） └ to_province_name String 全国/其他收货地省份 └ to_city_id String 330100/其他收货地城市id。值可能为地址id（Long类型），也可能为「其他」（汉字）。选「全国」、「省」维度时为空 └ to_city_name String 杭州市/其他收货地城市。选「全国」、「省」维度时为空 logistics_abnormal_index_value LspIndexMetricLogisticsAbnormal 无【弃用，请使用drill_list】各物流异常类型下的指标值 └ fake_trajectory String 1.00% 虚假轨迹 └ extreme_bad_stagnation String 1.00% 极差物流停滞 extreme_bad_index_value LspIndexMetricExtremeBad 无各极差场景下的指标值 └ extreme_bad_fetch String 1.00% 极差揽收停滞 └ extreme_bad_transport String 1.00% 极差运输停滞 └ extreme_bad_delivery_sign String 1.00% 极差派签停滞 drill_list LspIndexMetricDrill [] 下钻列表 └ drill_type Number 101 下钻类型 └ drill_name String 异地签收下钻名称 └ metric_value String 1.00% 下钻类型的指标值 └ parent_drill_type Number 1 亲下钻类型，若无亲下钻类型则返回null └ total Number 1 总数 └ page_index Number 1 分页页码，从1开始 └ page_size Number 100 分页每页大小

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
LogisticsIndexMetricRouteQueryRequest req = new LogisticsIndexMetricRouteQueryRequest();
LogisticsIndexMetricRouteQueryRequest.IndexMetricRouteQueryRequest obj1 = new LogisticsIndexMetricRouteQueryRequest.IndexMetricRouteQueryRequest();
obj1.setRequestTime(1689067417799L);
obj1.setRequestId("xxx1689067417799xxx");
obj1.setSupplierId("1000001");
obj1.setMetricCode("fetch_sign_achievement_rate");
obj1.setTimeType("DAY");
obj1.setTimeValue("2025-01-01");
obj1.setFromDivisionId(1L);
obj1.setToDivisionId(1L);
obj1.setQueryScope("STO");
obj1.setComparisonRange("industry");
obj1.setFromDivisionType("all");
obj1.setToDivisionType("all");
obj1.setPageIndex(1L);
obj1.setPageSize(100L);
req.setIndexMetricRouteQueryRequest(obj1);
LogisticsIndexMetricRouteQueryResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
LogisticsIndexMetricRouteQueryRequest req = new LogisticsIndexMetricRouteQueryRequest();
LogisticsIndexMetricRouteQueryRequest.IndexMetricRouteQueryRequestDomain obj1 = new LogisticsIndexMetricRouteQueryRequest.IndexMetricRouteQueryRequestDomain();
obj1.RequestTime = 1689067417799L;
obj1.RequestId = "xxx1689067417799xxx";
obj1.SupplierId = "1000001";
obj1.MetricCode = "fetch_sign_achievement_rate";
obj1.TimeType = "DAY";
obj1.TimeValue = "2025-01-01";
obj1.FromDivisionId = 1L;
obj1.ToDivisionId = 1L;
obj1.QueryScope = "STO";
obj1.ComparisonRange = "industry";
obj1.FromDivisionType = "all";
obj1.ToDivisionType = "all";
obj1.PageIndex = 1L;
obj1.PageSize = 100L;
req.IndexMetricRouteQueryRequest_ = obj1;
LogisticsIndexMetricRouteQueryResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new LogisticsIndexMetricRouteQueryRequest;
$index_metric_route_query_request = new IndexMetricRouteQueryRequest;
$index_metric_route_query_request->request_time="1689067417799";
$index_metric_route_query_request->request_id="xxx1689067417799xxx";
$index_metric_route_query_request->supplier_id="1000001";
$index_metric_route_query_request->metric_code="fetch_sign_achievement_rate";
$index_metric_route_query_request->time_type="DAY";
$index_metric_route_query_request->time_value="2025-01-01";
$index_metric_route_query_request->from_division_id="1";
$index_metric_route_query_request->to_division_id="1";
$index_metric_route_query_request->query_scope="STO";
$index_metric_route_query_request->comparison_range="industry";
$index_metric_route_query_request->from_division_type="all";
$index_metric_route_query_request->to_division_type="all";
$index_metric_route_query_request->page_index="1";
$index_metric_route_query_request->page_size="100";
$req->setIndexMetricRouteQueryRequest(json_encode($index_metric_route_query_request));
$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=taobao.logistics.index.metric.route.query' \
-d 'partner_id=apidoc' \
-d 'sign=5047B8CA443087233D1A93400C7E223A' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-11-04+01%3A09%3A33' \
-d 'v=2.0' \
-d 'index_metric_route_query_request=%E6%97%A0'

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

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

req.index_metric_route_query_request="无"
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,"taobao.logistics.index.metric.route.query");
add_param(pRequest,"index_metric_route_query_request","数据结构JSON示例");
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('taobao.logistics.index.metric.route.query', {
	'index_metric_route_query_request':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<logistics_index_metric_route_query_response>
    <index_metric_route_query_response>
        <success>true</success>
        <code>SYSTEM_ERROR</code>
        <message>系统繁忙，请稍后重试</message>
        <data>
            <best_index_value>1.00%</best_index_value>
            <brand_index_list>
                <lsp_index_metric_brand>
                    <tt_brand_code>STO</tt_brand_code>
                    <tt_brand_name>申通快递</tt_brand_name>
                    <index_value>1.00%</index_value>
                    <fetch_sign_index_value>
                        <fetch_sign_one_day>1.00%</fetch_sign_one_day>
                        <fetch_sign_two_days>1.00%</fetch_sign_two_days>
                        <fetch_sign_three_days>1.00%</fetch_sign_three_days>
                        <fetch_sign_four_days>1.00%</fetch_sign_four_days>
                        <fetch_sign_five_days>1.00%</fetch_sign_five_days>
                    </fetch_sign_index_value>
                    <stagnation_index_value>
                        <stagnation_fetch>1.00%</stagnation_fetch>
                        <stagnation_transport>1.00%</stagnation_transport>
                        <stagnation_transport_between>1.00%</stagnation_transport_between>
                        <stagnation_delivery_sign>1.00%</stagnation_delivery_sign>
                    </stagnation_index_value>
                    <trajectory_index_value>
                        <station_brand>1.00%</station_brand>
                        <station_address>1.00%</station_address>
                        <station_phone>1.00%</station_phone>
                        <pick_up_code>1.00%</pick_up_code>
                    </trajectory_index_value>
                    <rank>1</rank>
                    <best_index_value>1.00%</best_index_value>
                    <division>
                        <from_province_id>1/其他</from_province_id>
                        <from_province_name>全国/其他</from_province_name>
                        <from_city_id>330100/其他</from_city_id>
                        <from_city_name>杭州市/其他</from_city_name>
                        <to_province_id>1/其他</to_province_id>
                        <to_province_name>全国/其他</to_province_name>
                        <to_city_id>330100/其他</to_city_id>
                        <to_city_name>杭州市/其他</to_city_name>
                    </division>
                    <logistics_abnormal_index_value>
                        <fake_trajectory>1.00%</fake_trajectory>
                        <extreme_bad_stagnation>1.00%</extreme_bad_stagnation>
                        <extreme_bad_index_value>
                            <extreme_bad_fetch>1.00%</extreme_bad_fetch>
                            <extreme_bad_transport>1.00%</extreme_bad_transport>
                            <extreme_bad_delivery_sign>1.00%</extreme_bad_delivery_sign>
                        </extreme_bad_index_value>
                    </logistics_abnormal_index_value>
                    <drill_list>
                        <lsp_index_metric_drill>
                            <drill_type>101</drill_type>
                            <drill_name>异地签收</drill_name>
                            <metric_value>1.00%</metric_value>
                            <parent_drill_type>1</parent_drill_type>
                        </lsp_index_metric_drill>
                    </drill_list>
                </lsp_index_metric_brand>
            </brand_index_list>
            <total>1</total>
            <page_index>1</page_index>
            <page_size>100</page_size>
        </data>
    </index_metric_route_query_response>
</logistics_index_metric_route_query_response>

{
    "logistics_index_metric_route_query_response":{
        "index_metric_route_query_response":{
            "success":true,
            "code":"SYSTEM_ERROR",
            "message":"系统繁忙，请稍后重试",
            "data":{
                "best_index_value":"1.00%",
                "brand_index_list":{
                    "lsp_index_metric_brand":[
                        {
                            "tt_brand_code":"STO",
                            "tt_brand_name":"申通快递",
                            "index_value":"1.00%",
                            "fetch_sign_index_value":{
                                "fetch_sign_one_day":"1.00%",
                                "fetch_sign_two_days":"1.00%",
                                "fetch_sign_three_days":"1.00%",
                                "fetch_sign_four_days":"1.00%",
                                "fetch_sign_five_days":"1.00%"
                            },
                            "stagnation_index_value":{
                                "stagnation_fetch":"1.00%",
                                "stagnation_transport":"1.00%",
                                "stagnation_transport_between":"1.00%",
                                "stagnation_delivery_sign":"1.00%"
                            },
                            "trajectory_index_value":{
                                "station_brand":"1.00%",
                                "station_address":"1.00%",
                                "station_phone":"1.00%",
                                "pick_up_code":"1.00%"
                            },
                            "rank":1,
                            "best_index_value":"1.00%",
                            "division":{
                                "from_province_id":"1\/其他",
                                "from_province_name":"全国\/其他",
                                "from_city_id":"330100\/其他",
                                "from_city_name":"杭州市\/其他",
                                "to_province_id":"1\/其他",
                                "to_province_name":"全国\/其他",
                                "to_city_id":"330100\/其他",
                                "to_city_name":"杭州市\/其他"
                            },
                            "logistics_abnormal_index_value":{
                                "fake_trajectory":"1.00%",
                                "extreme_bad_stagnation":"1.00%",
                                "extreme_bad_index_value":{
                                    "extreme_bad_fetch":"1.00%",
                                    "extreme_bad_transport":"1.00%",
                                    "extreme_bad_delivery_sign":"1.00%"
                                }
                            },
                            "drill_list":{
                                "lsp_index_metric_drill":[
                                    {
                                        "drill_type":101,
                                        "drill_name":"异地签收",
                                        "metric_value":"1.00%",
                                        "parent_drill_type":1
                                    }
                                ]
                            }
                        }
                    ]
                },
                "total":1,
                "page_index":1,
                "page_size":100
            }
        }
    }
}

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

开放平台

天猫供应链

taobao.logistics.index.metric.route.query (淘天指数线路维度指标值查询接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ