淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
area_code	String	必须	weilan-001-003		区域围栏码
execute_user_list	ExecuteUserDto []	必须		最大列表长度：20	用户列表
└ execute_user_id Number 必须 43980 user id └ execute_user_type String 必须 CP 账号类型(CP,FWD,PERSON)
personal_session	String	必须	eefsd		个人session
personal_user_id	Number	必须	43980		个人user id

名称	类型	示例值	描述
data	QueryTaskOrderByAreaDto	1234	data
└ allocate_id Number 888 区域id └ allocate_name String A区上门区域名字 └ cabinet_count Number 100 投柜订单数 └ home_count Number 200 上门订单数 └ total_count Number 300 全部订单数 └ small_station_count Number 100 自提点数量
status_code	String	100	statusCode
status_message	String	提示	statusMessage
is_success	Boolean	false	success

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
CainiaoGuoguoCourierTaskorderAreaCountRequest req = new CainiaoGuoguoCourierTaskorderAreaCountRequest();
req.setAreaCode("weilan-001-003");
List<CainiaoGuoguoCourierTaskorderAreaCountRequest.ExecuteUserDto> list2 = new ArrayList<CainiaoGuoguoCourierTaskorderAreaCountRequest.ExecuteUserDto>();
CainiaoGuoguoCourierTaskorderAreaCountRequest.ExecuteUserDto obj3 = new CainiaoGuoguoCourierTaskorderAreaCountRequest.ExecuteUserDto();
list2.add(obj3);
obj3.setExecuteUserId(43980L);
obj3.setExecuteUserType("CP");
req.setExecuteUserList(list2);
req.setPersonalSession("eefsd");
req.setPersonalUserId(43980L);
CainiaoGuoguoCourierTaskorderAreaCountResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
CainiaoGuoguoCourierTaskorderAreaCountRequest req = new CainiaoGuoguoCourierTaskorderAreaCountRequest();
req.AreaCode = "weilan-001-003";
List<CainiaoGuoguoCourierTaskorderAreaCountRequest.ExecuteUserDtoDomain> list2 = new List<CainiaoGuoguoCourierTaskorderAreaCountRequest.ExecuteUserDtoDomain>();
CainiaoGuoguoCourierTaskorderAreaCountRequest.ExecuteUserDtoDomain obj3 = new CainiaoGuoguoCourierTaskorderAreaCountRequest.ExecuteUserDtoDomain();
list2.Add(obj3);
obj3.ExecuteUserId = 43980L;
obj3.ExecuteUserType = "CP";
req.ExecuteUserList_ = list2;
req.PersonalSession = "eefsd";
req.PersonalUserId = 43980L;
CainiaoGuoguoCourierTaskorderAreaCountResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new CainiaoGuoguoCourierTaskorderAreaCountRequest;
$req->setAreaCode("weilan-001-003");
$execute_user_list = new ExecuteUserDto;
$execute_user_list->execute_user_id="43980";
$execute_user_list->execute_user_type="CP";
$req->setExecuteUserList(json_encode($execute_user_list));
$req->setPersonalSession("eefsd");
$req->setPersonalUserId("43980");
$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=cainiao.guoguo.courier.taskorder.area.count' \
-d 'partner_id=apidoc' \
-d 'sign=5AADA9F52A0E9E9A50C7D50C85A83504' \
-d 'sign_method=hmac' \
-d 'timestamp=2024-05-04+22%3A09%3A22' \
-d 'v=2.0' \
-d 'area_code=weilan-001-003' \
-d 'execute_user_list=null' \
-d 'personal_session=eefsd' \
-d 'personal_user_id=43980'

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

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

req.area_code="weilan-001-003"
req.execute_user_list=""
req.personal_session="eefsd"
req.personal_user_id=43980
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,"cainiao.guoguo.courier.taskorder.area.count");
add_param(pRequest,"area_code","weilan-001-003");
add_param(pRequest,"execute_user_list","数据结构JSON示例");
add_param(pRequest,"personal_session","eefsd");
add_param(pRequest,"personal_user_id","43980");
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('cainiao.guoguo.courier.taskorder.area.count', {
	'area_code':'weilan-001-003',
	'execute_user_list':'数据结构JSON示例',
	'personal_session':'eefsd',
	'personal_user_id':'43980'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<cainiao_guoguo_courier_taskorder_area_count_response>
    <data>
        <allocate_id>888</allocate_id>
        <allocate_name>A区上门</allocate_name>
        <cabinet_count>100</cabinet_count>
        <home_count>200</home_count>
        <total_count>300</total_count>
        <small_station_count>100</small_station_count>
    </data>
    <status_code>100</status_code>
    <status_message>提示</status_message>
    <is_success>false</is_success>
</cainiao_guoguo_courier_taskorder_area_count_response>

{
    "cainiao_guoguo_courier_taskorder_area_count_response":{
        "data":{
            "allocate_id":888,
            "allocate_name":"A区上门",
            "cabinet_count":100,
            "home_count":200,
            "total_count":300,
            "small_station_count":100
        },
        "status_code":"100",
        "status_message":"提示",
        "is_success":false
    }
}

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

cainiao.guoguo.courier.taskorder.area.count (综合站批量取件-查询)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ