淘宝开放平台 - 文档中心

请求地址：

环境	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	Number	可选	43191212		小件员id
session_code	String	可选	234234		session

名称	类型	示例值	描述
data	DispatchMockResponse	data	data
dispatch_list DailyDispatchPreInfoDto [] 1 dispatchList └ assigned_date Date 1 assignedDate └ contact_pic String 1 contactPic └ contact_uri String 1 contactUri └ cp_code String 1 cpCode └ day_str String 1 dayStr └ expire_label String 1 expireLabel └ failed_sms_id Number 1 failedSmsId └ last_sms_status Number 11 lastSmsStatus └ latitude String 1 latitude └ longitude String 1 longitude └ mail_no String 1 mailNo └ notification_count Number 1 notificationCount └ orange_label String 1 orangeLabel └ order_code String 1 orderCode └ order_label String 1 orderLabel └ order_read Boolean 1 orderRead └ poi_id String 1 poiId └ poi_label String 1 poiLabel └ receiver_address String 1 receiverAddress └ receiver_mobile_phone String 1 receiverMobilePhone └ receiver_name String 1 receiverName └ status Number 1 status └ taobao_id Number 1 taobaoId └ user_label String 1 userLabel └ usr_word String 1 usrWord └ usr_word_id String 1 usrWordId └ usr_word_read Boolean 1 usrWordRead
status_code	String	2	statusCode
status_message	String	1	statusMessage
is_success	Boolean	false	success

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
CainiaoYimaMockDispatchlistRequest req = new CainiaoYimaMockDispatchlistRequest();
req.setUserId(43191212L);
req.setSessionCode("234234");
CainiaoYimaMockDispatchlistResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
CainiaoYimaMockDispatchlistRequest req = new CainiaoYimaMockDispatchlistRequest();
req.UserId = 43191212L;
req.SessionCode = "234234";
CainiaoYimaMockDispatchlistResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new CainiaoYimaMockDispatchlistRequest;
$req->setUserId("43191212");
$req->setSessionCode("234234");
$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.mock.dispatchlist' \
-d 'partner_id=apidoc' \
-d 'sign=7EC3B2F237E83AAAC37CEB8BCC50F152' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-12+13%3A06%3A05' \
-d 'v=2.0' \
-d 'session_code=234234' \
-d 'user_id=43191212'

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

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

req.user_id=43191212
req.session_code="234234"
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.mock.dispatchlist");
add_param(pRequest,"user_id","43191212");
add_param(pRequest,"session_code","234234");
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.mock.dispatchlist', {
	'user_id':'43191212',
	'session_code':'234234'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<cainiao_yima_mock_dispatchlist_response>
    <data>
        <dispatch_list>
            <daily_dispatch_pre_info_dto>
                <assigned_date>1</assigned_date>
                <contact_pic>1</contact_pic>
                <contact_uri>1</contact_uri>
                <cp_code>1</cp_code>
                <day_str>1</day_str>
                <expire_label>1</expire_label>
                <failed_sms_id>1</failed_sms_id>
                <last_sms_status>11</last_sms_status>
                <latitude>1</latitude>
                <longitude>1</longitude>
                <mail_no>1</mail_no>
                <notification_count>1</notification_count>
                <orange_label>1</orange_label>
                <order_code>1</order_code>
                <order_label>1</order_label>
                <order_read>1</order_read>
                <poi_id>1</poi_id>
                <poi_label>1</poi_label>
                <receiver_address>1</receiver_address>
                <receiver_mobile_phone>1</receiver_mobile_phone>
                <receiver_name>1</receiver_name>
                <status>1</status>
                <taobao_id>1</taobao_id>
                <user_label>1</user_label>
                <usr_word>1</usr_word>
                <usr_word_id>1</usr_word_id>
                <usr_word_read>1</usr_word_read>
            </daily_dispatch_pre_info_dto>
        </dispatch_list>
    </data>
    <status_code>2</status_code>
    <status_message>1</status_message>
    <is_success>false</is_success>
</cainiao_yima_mock_dispatchlist_response>

{
    "cainiao_yima_mock_dispatchlist_response":{
        "data":{
            "dispatch_list":{
                "daily_dispatch_pre_info_dto":[
                    {
                        "assigned_date":"1",
                        "contact_pic":"1",
                        "contact_uri":"1",
                        "cp_code":"1",
                        "day_str":"1",
                        "expire_label":"1",
                        "failed_sms_id":1,
                        "last_sms_status":11,
                        "latitude":"1",
                        "longitude":"1",
                        "mail_no":"1",
                        "notification_count":1,
                        "orange_label":"1",
                        "order_code":"1",
                        "order_label":"1",
                        "order_read":1,
                        "poi_id":"1",
                        "poi_label":"1",
                        "receiver_address":"1",
                        "receiver_mobile_phone":"1",
                        "receiver_name":"1",
                        "status":1,
                        "taobao_id":1,
                        "user_label":"1",
                        "usr_word":"1",
                        "usr_word_id":"1",
                        "usr_word_read":1
                    }
                ]
            }
        },
        "status_code":"2",
        "status_message":"1",
        "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.yima.mock.dispatchlist (派件列表mock)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ