淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	描述
user_id	String	必须	1	小件员ID
longitude	String	可选	1	经度
latitude	String	可选	1	纬度

名称	类型	示例值	描述
data	AllDocDailyDispatchDto	0	结果
doc_dispatch_item_list DocDailyDispatchItem [] list 结果 └ cannot_notification_prompt String 未检测到联系电话不能发短信提示信息 └ notification_count Number 15 发送次数 └ status Number 0 状态:0，未派送，1:已派送 └ mail_no String 11 运单号 └ receiver_address String 杭州村收件地址 └ can_send_message Boolean true 是否可以发送短信 └ order_id Number 11 订单号 └ receiver_label_list String [] 请提前打电话用户标签 └ receiver_phone String 13244441111 收件人电话 └ receiver_name String 李飞收件人 └ distance Number 1 距离 └ longitude String 1 经度 └ latitude String 1 纬度 └ order_label String {"curStaOrderStatus":"11","pickupTime":1463822433960,”arrivedTime":1463822433960,"stationServiceCode":"112","stationServiceDesc":"自提柜","stationAddress":"杭州市乐嘉国际3号楼5柜11号"} 订单标签，arrivedTime：驿站签收时间，pickTime：用户签收时间 └ expire_label String {"label_006":"006","label_005":"005"} 超时标签 └ poi_label String 略小区标签 └ last_sms_status Number 1 最后一次短信发送状态 └ failed_sms_id Number 111 最后一次短信发送失败ID └ gmt_modified Date 2016-05-31 gmtModified doc_dispatch_item_complete_list DocDailyDispatchItem [] list 结果 └ cannot_notification_prompt String 未检测到联系电话不能发短信提示信息 └ notification_count Number 15 发送次数 └ status Number 1 状态 └ mail_no String 11111 运单号 └ receiver_address String 浙江省杭州市西湖区蒋村花园收件地址 └ can_send_message Boolean true 可以发短信 └ order_id Number 123 订单ID └ receiver_label_list String [] 请提前打电话用户标签 └ receiver_phone String 13500012222 收货电话 └ receiver_name String 李阳收件人 └ distance Number 100 距离 └ longitude String 11 经度 └ latitude String 12 纬度 └ order_label String {"curStaOrderStatus":"11","pickupTime":1463822433960,”arrivedTime":1463822433960,"stationServiceCode":"112","stationServiceDesc":"自提柜","stationAddress":"杭州市乐嘉国际3号楼5柜11号"} 订单标签，arrivedTime：驿站签收时间，pickTime：用户签收时间 └ expire_label String {"label_006":"006","label_005":"005"} 超时标签 └ poi_label String 预留字段小区标签 └ last_sms_status Number 1 最后一次短信发送状态（具体值请咨询空一） └ failed_sms_id Number 2222 最后一次短信发送失败ID └ gmt_modified Date 2016-05-31 gmtModified └ undo_label_num Number 2 undoLabelNum └ complete_label_num Number 3 completeLabelNum
is_success	Boolean	false	是否成功
status_message	String	1	系统自动生成

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
CainiaoYimaDispatchAlistGetRequest req = new CainiaoYimaDispatchAlistGetRequest();
req.setUserId("1");
req.setLongitude("1");
req.setLatitude("1");
CainiaoYimaDispatchAlistGetResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
CainiaoYimaDispatchAlistGetRequest req = new CainiaoYimaDispatchAlistGetRequest();
req.UserId = "1";
req.Longitude = "1";
req.Latitude = "1";
CainiaoYimaDispatchAlistGetResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new CainiaoYimaDispatchAlistGetRequest;
$req->setUserId("1");
$req->setLongitude("1");
$req->setLatitude("1");
$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.yima.dispatch.alist.get' \
-d 'partner_id=apidoc' \
-d 'sign=2403B31AD56E9A4AFDFF493F2A04A432' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-12+11%3A51%3A00' \
-d 'v=2.0' \
-d 'latitude=1' \
-d 'longitude=1' \
-d 'user_id=1'

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

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

req.user_id="1"
req.longitude="1"
req.latitude="1"
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.yima.dispatch.alist.get");
add_param(pRequest,"user_id","1");
add_param(pRequest,"longitude","1");
add_param(pRequest,"latitude","1");
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.yima.dispatch.alist.get', {
	'user_id':'1',
	'longitude':'1',
	'latitude':'1'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<cainiao_yima_dispatch_alist_get_response>
    <data>
        <doc_dispatch_item_list>
            <doc_daily_dispatch_item>
                <cannot_notification_prompt>未检测到联系电话</cannot_notification_prompt>
                <notification_count>15</notification_count>
                <status>0</status>
                <mail_no>11</mail_no>
                <receiver_address>杭州村</receiver_address>
                <can_send_message>true</can_send_message>
                <order_id>11</order_id>
                <receiver_label_list>
                    <string>请提前打电话</string>
                </receiver_label_list>
                <receiver_phone>13244441111</receiver_phone>
                <receiver_name>李飞</receiver_name>
                <distance>1</distance>
                <longitude>1</longitude>
                <latitude>1</latitude>
                <order_label>{&quot;curStaOrderStatus&quot;:&quot;11&quot;,&quot;pickupTime&quot;:1463822433960,”arrivedTime&quot;:1463822433960,&quot;stationServiceCode&quot;:&quot;112&quot;,&quot;stationServiceDesc&quot;:&quot;自提柜&quot;,&quot;stationAddress&quot;:&quot;杭州市乐嘉国际3号楼5柜11号&quot;}</order_label>
                <expire_label>{&quot;label_006&quot;:&quot;006&quot;,&quot;label_005&quot;:&quot;005&quot;}</expire_label>
                <poi_label>略</poi_label>
                <last_sms_status>1</last_sms_status>
                <failed_sms_id>111</failed_sms_id>
                <gmt_modified>2016-05-31</gmt_modified>
            </doc_daily_dispatch_item>
        </doc_dispatch_item_list>
        <doc_dispatch_item_complete_list>
            <doc_daily_dispatch_item>
                <cannot_notification_prompt>未检测到联系电话</cannot_notification_prompt>
                <notification_count>15</notification_count>
                <status>1</status>
                <mail_no>11111</mail_no>
                <receiver_address>浙江省杭州市西湖区蒋村花园</receiver_address>
                <can_send_message>true</can_send_message>
                <order_id>123</order_id>
                <receiver_label_list>
                    <string>请提前打电话</string>
                </receiver_label_list>
                <receiver_phone>13500012222</receiver_phone>
                <receiver_name>李阳</receiver_name>
                <distance>100</distance>
                <longitude>11</longitude>
                <latitude>12</latitude>
                <order_label>{&quot;curStaOrderStatus&quot;:&quot;11&quot;,&quot;pickupTime&quot;:1463822433960,”arrivedTime&quot;:1463822433960,&quot;stationServiceCode&quot;:&quot;112&quot;,&quot;stationServiceDesc&quot;:&quot;自提柜&quot;,&quot;stationAddress&quot;:&quot;杭州市乐嘉国际3号楼5柜11号&quot;}</order_label>
                <expire_label>{&quot;label_006&quot;:&quot;006&quot;,&quot;label_005&quot;:&quot;005&quot;}</expire_label>
                <poi_label>预留字段</poi_label>
                <last_sms_status>1</last_sms_status>
                <failed_sms_id>2222</failed_sms_id>
                <gmt_modified>2016-05-31</gmt_modified>
            </doc_daily_dispatch_item>
        </doc_dispatch_item_complete_list>
        <undo_label_num>2</undo_label_num>
        <complete_label_num>3</complete_label_num>
    </data>
    <is_success>false</is_success>
    <status_message>1</status_message>
</cainiao_yima_dispatch_alist_get_response>

{
    "cainiao_yima_dispatch_alist_get_response":{
        "data":{
            "doc_dispatch_item_list":{
                "doc_daily_dispatch_item":[
                    {
                        "cannot_notification_prompt":"未检测到联系电话",
                        "notification_count":15,
                        "status":0,
                        "mail_no":"11",
                        "receiver_address":"杭州村",
                        "can_send_message":true,
                        "order_id":11,
                        "receiver_label_list":{
                            "string":[
                                "请提前打电话"
                            ]
                        },
                        "receiver_phone":"13244441111",
                        "receiver_name":"李飞",
                        "distance":1,
                        "longitude":"1",
                        "latitude":"1",
                        "order_label":"{\"curStaOrderStatus\":\"11\",\"pickupTime\":1463822433960,”arrivedTime\":1463822433960,\"stationServiceCode\":\"112\",\"stationServiceDesc\":\"自提柜\",\"stationAddress\":\"杭州市乐嘉国际3号楼5柜11号\"}",
                        "expire_label":"{\"label_006\":\"006\",\"label_005\":\"005\"}",
                        "poi_label":"略",
                        "last_sms_status":1,
                        "failed_sms_id":111,
                        "gmt_modified":"2016-05-31"
                    }
                ]
            },
            "doc_dispatch_item_complete_list":{
                "doc_daily_dispatch_item":[
                    {
                        "cannot_notification_prompt":"未检测到联系电话",
                        "notification_count":15,
                        "status":1,
                        "mail_no":"11111",
                        "receiver_address":"浙江省杭州市西湖区蒋村花园",
                        "can_send_message":true,
                        "order_id":123,
                        "receiver_label_list":{
                            "string":[
                                "请提前打电话"
                            ]
                        },
                        "receiver_phone":"13500012222",
                        "receiver_name":"李阳",
                        "distance":100,
                        "longitude":"11",
                        "latitude":"12",
                        "order_label":"{\"curStaOrderStatus\":\"11\",\"pickupTime\":1463822433960,”arrivedTime\":1463822433960,\"stationServiceCode\":\"112\",\"stationServiceDesc\":\"自提柜\",\"stationAddress\":\"杭州市乐嘉国际3号楼5柜11号\"}",
                        "expire_label":"{\"label_006\":\"006\",\"label_005\":\"005\"}",
                        "poi_label":"预留字段",
                        "last_sms_status":1,
                        "failed_sms_id":2222,
                        "gmt_modified":"2016-05-31"
                    }
                ]
            },
            "undo_label_num":2,
            "complete_label_num":3
        },
        "is_success":false,
        "status_message":"1"
    }
}

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"
	}
}

错误码	错误描述	解决方案
isp.S01	系统异常	联系服务端开发人员

API测试工具错误码查询工具 SDK下载

开放平台

驿马前台api

cainiao.yima.dispatch.alist.get (获取小件员今日未派单和已派单列表)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ