淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
routing_keyword_page_request	RoutingKeywordPageRequest	必须			查询请求模型
└ town_name String 可选西湖街道乡镇街道名称 └ prov_name String 可选浙江省省名称 └ page_size Number 必须 10 分页大小 └ branch_code String 可选 90001 网点编码 └ city_name String 可选杭州市市名称 └ area_name String 可选西湖区区县名称 └ page_no Number 必须 1 页码（从1开始） └ rule_type_list String [] 可选 1,2 需要指定查询的规则类型列表,1普通关键字,2行政区划,3路名路号 └ keyword String 可选西溪园区关键字（模糊搜索） └ contract_code String 可选 A01 三段码 └ status Number 可选 1 状态,0失效,1生效

名称	类型	示例值	描述
result	BaseResultDTO		查询结果模型
└ success Boolean true 是否成功 module PageDTO 分页模型 └ page_no Number 1 页码 └ page_size Number 10 分页大小 └ total_record Number 100 总记录数 data RoutingKeywordQueryResponse [] 当前页请求结果列表 └ id Number 123 id └ gmt_create Date 2025-01-01 00:00:00 创建时间 └ gmt_modified Date 2025-01-01 00:00:00 修改时间 └ rule_type Number 1 规则类型,1普通关键字,2行政区划,3路名路号 └ cp_code String STO 快递公司编码 └ prov_name String 浙江省省名称 └ city_name String 杭州市市名称 └ area_name String 西湖区区县名称 └ town_name String 西湖街道乡镇街道名称 └ keywords String [] 关键字列表 └ street String 崇仁路路名 └ parity Number 0 路号,0单号,1双号,2全部 └ num_start Number 1 路号,起始值 └ num_end Number 10 路号,结束值 └ branch_code String 90001 网点编码 └ branch_name String 测试网点1 网点名称 └ contract_code String A01 三段码 └ hit_count Number 10 命中次数 └ status Number 1 状态,0无效,1有效 └ creator String 张三创建人 └ operator String XX 最近操作人 one_error_info ErrorInfo 请求失败模型 └ error_message String 系统异常失败原因文本描述 └ error_code String SYSTEM_ERROR 失败原因编码

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
LogisticsRoutingKeywordQueryRequest req = new LogisticsRoutingKeywordQueryRequest();
LogisticsRoutingKeywordQueryRequest.RoutingKeywordPageRequest obj1 = new LogisticsRoutingKeywordQueryRequest.RoutingKeywordPageRequest();
obj1.setTownName("西湖街道");
obj1.setProvName("浙江省");
obj1.setPageSize(10L);
obj1.setBranchCode("90001");
obj1.setCityName("杭州市");
obj1.setAreaName("西湖区");
obj1.setPageNo(1L);
obj1.setRuleTypeList("1,2");
obj1.setKeyword("西溪园区");
obj1.setContractCode("A01");
obj1.setStatus(1L);
req.setRoutingKeywordPageRequest(obj1);
LogisticsRoutingKeywordQueryResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
LogisticsRoutingKeywordQueryRequest req = new LogisticsRoutingKeywordQueryRequest();
LogisticsRoutingKeywordQueryRequest.RoutingKeywordPageRequestDomain obj1 = new LogisticsRoutingKeywordQueryRequest.RoutingKeywordPageRequestDomain();
obj1.TownName = "西湖街道";
obj1.ProvName = "浙江省";
obj1.PageSize = 10L;
obj1.BranchCode = "90001";
obj1.CityName = "杭州市";
obj1.AreaName = "西湖区";
obj1.PageNo = 1L;
obj1.RuleTypeList = "1,2";
obj1.Keyword = "西溪园区";
obj1.ContractCode = "A01";
obj1.Status = 1L;
req.RoutingKeywordPageRequest_ = obj1;
LogisticsRoutingKeywordQueryResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new LogisticsRoutingKeywordQueryRequest;
$routing_keyword_page_request = new RoutingKeywordPageRequest;
$routing_keyword_page_request->town_name="西湖街道";
$routing_keyword_page_request->prov_name="浙江省";
$routing_keyword_page_request->page_size="10";
$routing_keyword_page_request->branch_code="90001";
$routing_keyword_page_request->city_name="杭州市";
$routing_keyword_page_request->area_name="西湖区";
$routing_keyword_page_request->page_no="1";
$routing_keyword_page_request->rule_type_list="1,2";
$routing_keyword_page_request->keyword="西溪园区";
$routing_keyword_page_request->contract_code="A01";
$routing_keyword_page_request->status="1";
$req->setRoutingKeywordPageRequest(json_encode($routing_keyword_page_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.routing.keyword.query' \
-d 'partner_id=apidoc' \
-d 'sign=E3FBD467634CBCA33CDB1DA8BC019BB5' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-07-12+03%3A27%3A33' \
-d 'v=2.0' \
-d 'routing_keyword_page_request=null'

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

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

req.routing_keyword_page_request="数据结构示例JSON格式"
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.routing.keyword.query");
add_param(pRequest,"routing_keyword_page_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.routing.keyword.query', {
	'routing_keyword_page_request':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<logistics_routing_keyword_query_response>
    <result>
        <success>true</success>
        <module>
            <page_no>1</page_no>
            <page_size>10</page_size>
            <total_record>100</total_record>
            <data>
                <routing_keyword_query_response>
                    <id>123</id>
                    <gmt_create>2025-01-01 00:00:00</gmt_create>
                    <gmt_modified>2025-01-01 00:00:00</gmt_modified>
                    <rule_type>1</rule_type>
                    <cp_code>STO</cp_code>
                    <prov_name>浙江省</prov_name>
                    <city_name>杭州市</city_name>
                    <area_name>西湖区</area_name>
                    <town_name>西湖街道</town_name>
                    <street>崇仁路</street>
                    <parity>0</parity>
                    <num_start>1</num_start>
                    <num_end>10</num_end>
                    <branch_code>90001</branch_code>
                    <branch_name>测试网点1</branch_name>
                    <contract_code>A01</contract_code>
                    <hit_count>10</hit_count>
                    <status>1</status>
                    <creator>张三</creator>
                    <operator>XX</operator>
                </routing_keyword_query_response>
            </data>
        </module>
        <one_error_info>
            <error_message>系统异常</error_message>
            <error_code>SYSTEM_ERROR</error_code>
        </one_error_info>
    </result>
</logistics_routing_keyword_query_response>

{
    "logistics_routing_keyword_query_response":{
        "result":{
            "success":true,
            "module":{
                "page_no":1,
                "page_size":10,
                "total_record":100,
                "data":{
                    "routing_keyword_query_response":[
                        {
                            "id":123,
                            "gmt_create":"2025-01-01 00:00:00",
                            "gmt_modified":"2025-01-01 00:00:00",
                            "rule_type":1,
                            "cp_code":"STO",
                            "prov_name":"浙江省",
                            "city_name":"杭州市",
                            "area_name":"西湖区",
                            "town_name":"西湖街道",
                            "street":"崇仁路",
                            "parity":0,
                            "num_start":1,
                            "num_end":10,
                            "branch_code":"90001",
                            "branch_name":"测试网点1",
                            "contract_code":"A01",
                            "hit_count":10,
                            "status":1,
                            "creator":"张三",
                            "operator":"XX"
                        }
                    ]
                }
            },
            "one_error_info":{
                "error_message":"系统异常",
                "error_code":"SYSTEM_ERROR"
            }
        }
    }
}

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

taobao.logistics.routing.keyword.query (关键字分单配置查询接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ