阿里安全开放平台-阿里聚安全

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
reach_trade_interrupt_page_request	ReachTradeInterruptPageRequest	必须			请求模型
└ branch_code String 可选 A0001 网点编码（数据维度为三段码时，需要必传，避免单次数据量过大） └ prov_name String 可选浙江省省名称 └ city_name String 可选杭州市市名称 └ time_dim Number 必须 0 时间维度:0:当天,1:昨日,2:2日内,3:3日内,4:7日内 └ area_name String 可选余杭区区县名称 └ page_no Number 必须 1 页码 └ page_size Number 必须 20 分页大小 └ data_dim Number 必须 1 数据维度:1:CP,2:省,3:市,4:区,5:网点,6三段码 └ contract_code String 可选 123 三段码

名称	类型	示例值	描述
result	BaseResultDTO		结果模型
└ success Boolean true 是否调用成功 module PageDTO 分页模型 └ page_no Number 1 页码 └ page_size Number 10 分页大小 └ total_record Number 100 总记录数 data ReachTradeInterruptQueryResponse [] 当前页查询结果 └ time_dim Number 0 时间维度:0:当天,1:昨日,2:2日内,3:3日内,4:7日内 └ data_dim Number 1 数据维度:1:CP,2:省,3:市,4:区,5:网点,6三段码 └ cp_code String YTO 快递公司编码 └ branch_code String A0001 网点编码-查询维度为网点/三段码时有该字段 └ contract_code String 001 三段码-查询维度为网点、三段码时有该字段 └ prov_name String 浙江省省名称 └ city_name String 杭州市市名称 └ area_name String 西湖区区县名称 └ apply_cnt Number 1000 取号调用量 └ apply_interrupt_cnt Number 12 取号拦截量 └ apply_trade_cnt Number 200 取号调用订单量 └ apply_interrupt_trade_cnt Number 2 取号拦截订单量 └ apply_interrupt_trade_rate String 0.01 取号拦截订单比例 └ avg_interrupt_trade_rate String 0.01 平均拦截订单比例 └ interrupt_trade_rate_rank Number 1 拦截订单占比排名 └ address_interrupt_trade_cnt Number 1 行政区划拦截订单量 └ branch_interrupt_trade_cnt Number 0 网点拦截订单量 └ contract_interrupt_trade_cnt Number 0 三段码拦截订单量 └ seller_interrupt_trade_cnt Number 0 商家黑名单拦截订单量 └ user_interrupt_trade_cnt Number 0 消费者拦截订单量 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);
LogisticsReachTradeInterruptStatQueryRequest req = new LogisticsReachTradeInterruptStatQueryRequest();
LogisticsReachTradeInterruptStatQueryRequest.ReachTradeInterruptPageRequest obj1 = new LogisticsReachTradeInterruptStatQueryRequest.ReachTradeInterruptPageRequest();
obj1.setBranchCode("A0001");
obj1.setProvName("浙江省");
obj1.setCityName("杭州市");
obj1.setTimeDim(0L);
obj1.setAreaName("余杭区");
obj1.setPageNo(1L);
obj1.setPageSize(20L);
obj1.setDataDim(1L);
obj1.setContractCode("123");
req.setReachTradeInterruptPageRequest(obj1);
LogisticsReachTradeInterruptStatQueryResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
LogisticsReachTradeInterruptStatQueryRequest req = new LogisticsReachTradeInterruptStatQueryRequest();
LogisticsReachTradeInterruptStatQueryRequest.ReachTradeInterruptPageRequestDomain obj1 = new LogisticsReachTradeInterruptStatQueryRequest.ReachTradeInterruptPageRequestDomain();
obj1.BranchCode = "A0001";
obj1.ProvName = "浙江省";
obj1.CityName = "杭州市";
obj1.TimeDim = 0L;
obj1.AreaName = "余杭区";
obj1.PageNo = 1L;
obj1.PageSize = 20L;
obj1.DataDim = 1L;
obj1.ContractCode = "123";
req.ReachTradeInterruptPageRequest_ = obj1;
LogisticsReachTradeInterruptStatQueryResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new LogisticsReachTradeInterruptStatQueryRequest;
$reach_trade_interrupt_page_request = new ReachTradeInterruptPageRequest;
$reach_trade_interrupt_page_request->branch_code="A0001";
$reach_trade_interrupt_page_request->prov_name="浙江省";
$reach_trade_interrupt_page_request->city_name="杭州市";
$reach_trade_interrupt_page_request->time_dim="0";
$reach_trade_interrupt_page_request->area_name="余杭区";
$reach_trade_interrupt_page_request->page_no="1";
$reach_trade_interrupt_page_request->page_size="20";
$reach_trade_interrupt_page_request->data_dim="1";
$reach_trade_interrupt_page_request->contract_code="123";
$req->setReachTradeInterruptPageRequest(json_encode($reach_trade_interrupt_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.reach.trade.interrupt.stat.query' \
-d 'partner_id=apidoc' \
-d 'sign=02F0A3404C6AA7119A0844899CC19F22' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-08-28+09%3A51%3A26' \
-d 'v=2.0' \
-d 'reach_trade_interrupt_page_request=null'

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

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

req.reach_trade_interrupt_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.reach.trade.interrupt.stat.query");
add_param(pRequest,"reach_trade_interrupt_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.reach.trade.interrupt.stat.query', {
	'reach_trade_interrupt_page_request':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<logistics_reach_trade_interrupt_stat_query_response>
    <result>
        <success>true</success>
        <module>
            <page_no>1</page_no>
            <page_size>10</page_size>
            <total_record>100</total_record>
            <data>
                <reach_trade_interrupt_query_response>
                    <time_dim>0</time_dim>
                    <data_dim>1</data_dim>
                    <cp_code>YTO</cp_code>
                    <branch_code>A0001</branch_code>
                    <contract_code>001</contract_code>
                    <prov_name>浙江省</prov_name>
                    <city_name>杭州市</city_name>
                    <area_name>西湖区</area_name>
                    <apply_cnt>1000</apply_cnt>
                    <apply_interrupt_cnt>12</apply_interrupt_cnt>
                    <apply_trade_cnt>200</apply_trade_cnt>
                    <apply_interrupt_trade_cnt>2</apply_interrupt_trade_cnt>
                    <apply_interrupt_trade_rate>0.01</apply_interrupt_trade_rate>
                    <avg_interrupt_trade_rate>0.01</avg_interrupt_trade_rate>
                    <interrupt_trade_rate_rank>1</interrupt_trade_rate_rank>
                    <address_interrupt_trade_cnt>1</address_interrupt_trade_cnt>
                    <branch_interrupt_trade_cnt>0</branch_interrupt_trade_cnt>
                    <contract_interrupt_trade_cnt>0</contract_interrupt_trade_cnt>
                    <seller_interrupt_trade_cnt>0</seller_interrupt_trade_cnt>
                    <user_interrupt_trade_cnt>0</user_interrupt_trade_cnt>
                </reach_trade_interrupt_query_response>
            </data>
        </module>
        <one_error_info>
            <error_message>系统异常</error_message>
            <error_code>SYSTEM_ERROR</error_code>
        </one_error_info>
    </result>
</logistics_reach_trade_interrupt_stat_query_response>

{
    "logistics_reach_trade_interrupt_stat_query_response":{
        "result":{
            "success":true,
            "module":{
                "page_no":1,
                "page_size":10,
                "total_record":100,
                "data":{
                    "reach_trade_interrupt_query_response":[
                        {
                            "time_dim":0,
                            "data_dim":1,
                            "cp_code":"YTO",
                            "branch_code":"A0001",
                            "contract_code":"001",
                            "prov_name":"浙江省",
                            "city_name":"杭州市",
                            "area_name":"西湖区",
                            "apply_cnt":1000,
                            "apply_interrupt_cnt":12,
                            "apply_trade_cnt":200,
                            "apply_interrupt_trade_cnt":2,
                            "apply_interrupt_trade_rate":"0.01",
                            "avg_interrupt_trade_rate":"0.01",
                            "interrupt_trade_rate_rank":1,
                            "address_interrupt_trade_cnt":1,
                            "branch_interrupt_trade_cnt":0,
                            "contract_interrupt_trade_cnt":0,
                            "seller_interrupt_trade_cnt":0,
                            "user_interrupt_trade_cnt":0
                        }
                    ]
                }
            },
            "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.reach.trade.interrupt.stat.query (筛单订单拦截量数据查询)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈