淘宝开放平台

请求地址：

环境	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	必须	43980		快递员ID
manual	Boolean	可选	false	默认值：false	仅在手工同步模式下设置为true，将忽略采样率。
page_version_map	Json	可选	{ "home": "5.8.0", "my-wallet": "5.8.0" }		页面：版本信息
session_code	String	必须	123		seesion
user_agent	AppUserAgentDto	必须			UA
└ app_debug String 可选 0 0：正式包； 1：调试包 └ app_name String 必须菜鸟包裹侠 app名字 └ app_upload_time Number 可选 1530265931000 App上传数据的时间（SDK不要传） └ app_version String 必须 1.0 app版本 └ client_type String 必须 android android/iOS └ cp_code String 必须 K_TTKD cpcode └ device_model String 必须 SM-G9280 设备型号 └ device_name String 必须 samsung 设备名字 └ gps_open Number 可选 1 GPS是否开启0关闭，1开启。 └ latitude String 可选 31.00 纬度 └ longitude String 可选 120.00 经度 └ os_version String 必须 6.0.0 手机OS版本 └ package_name String 必须 com.cainiao.xx 应用包名、bundle id └ sdk_debug String 可选 0 0：正式包； 1：调试包 └ sdk_type String 必须 3rd 2rd：2方版本； 3rd：3方版本； └ sdk_version String 必须 5.8.0 SDK版本 └ utdid String 可选 xxooff utdid

名称	类型	示例值	描述
data	AppDataSyncResultDTO		data
└ message String 服务未开放 message └ pv_ok Boolean true pvOk └ ua_ok Boolean true uaOk
status_code	String	2	statusCode
status_message	String	OK	statusMessage
is_success	Boolean	false	success

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
CainiaoYimaAppDataUploadRequest req = new CainiaoYimaAppDataUploadRequest();
req.setUserId(43980L);
req.setManual(false);
req.setPageVersionMapString("{ 	\"home\": \"5.8.0\", 	\"my-wallet\": \"5.8.0\" }");
req.setSessionCode("123");
CainiaoYimaAppDataUploadRequest.AppUserAgentDto obj1 = new CainiaoYimaAppDataUploadRequest.AppUserAgentDto();
obj1.setAppDebug("0");
obj1.setAppName("菜鸟包裹侠");
obj1.setAppUploadTime(1530265931000L);
obj1.setAppVersion("1.0");
obj1.setClientType("android");
obj1.setCpCode("K_TTKD");
obj1.setDeviceModel("SM-G9280");
obj1.setDeviceName("samsung");
obj1.setGpsOpen(1L);
obj1.setLatitude("31.00");
obj1.setLongitude("120.00");
obj1.setOsVersion("6.0.0");
obj1.setPackageName("com.cainiao.xx");
obj1.setSdkDebug("0");
obj1.setSdkType("3rd");
obj1.setSdkVersion("5.8.0");
obj1.setUtdid("xxooff");
req.setUserAgent(obj1);
CainiaoYimaAppDataUploadResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
CainiaoYimaAppDataUploadRequest req = new CainiaoYimaAppDataUploadRequest();
req.UserId = 43980L;
req.Manual = false;
req.PageVersionMap = "{ 	\"home\": \"5.8.0\", 	\"my-wallet\": \"5.8.0\" }";
req.SessionCode = "123";
CainiaoYimaAppDataUploadRequest.AppUserAgentDtoDomain obj1 = new CainiaoYimaAppDataUploadRequest.AppUserAgentDtoDomain();
obj1.AppDebug = "0";
obj1.AppName = "菜鸟包裹侠";
obj1.AppUploadTime = 1530265931000L;
obj1.AppVersion = "1.0";
obj1.ClientType = "android";
obj1.CpCode = "K_TTKD";
obj1.DeviceModel = "SM-G9280";
obj1.DeviceName = "samsung";
obj1.GpsOpen = 1L;
obj1.Latitude = "31.00";
obj1.Longitude = "120.00";
obj1.OsVersion = "6.0.0";
obj1.PackageName = "com.cainiao.xx";
obj1.SdkDebug = "0";
obj1.SdkType = "3rd";
obj1.SdkVersion = "5.8.0";
obj1.Utdid = "xxooff";
req.UserAgent_ = obj1;
CainiaoYimaAppDataUploadResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new CainiaoYimaAppDataUploadRequest;
$req->setUserId("43980");
$req->setManual("false");
$req->setPageVersionMap("{ 	\"home\": \"5.8.0\", 	\"my-wallet\": \"5.8.0\" }");
$req->setSessionCode("123");
$user_agent = new AppUserAgentDto;
$user_agent->app_debug="0";
$user_agent->app_name="菜鸟包裹侠";
$user_agent->app_upload_time="1530265931000";
$user_agent->app_version="1.0";
$user_agent->client_type="android";
$user_agent->cp_code="K_TTKD";
$user_agent->device_model="SM-G9280";
$user_agent->device_name="samsung";
$user_agent->gps_open="1";
$user_agent->latitude="31.00";
$user_agent->longitude="120.00";
$user_agent->os_version="6.0.0";
$user_agent->package_name="com.cainiao.xx";
$user_agent->sdk_debug="0";
$user_agent->sdk_type="3rd";
$user_agent->sdk_version="5.8.0";
$user_agent->utdid="xxooff";
$req->setUserAgent(json_encode($user_agent));
$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.app.data.upload' \
-d 'partner_id=apidoc' \
-d 'sign=D1B701A4973D25B7CD8E691734BAB0AB' \
-d 'sign_method=hmac' \
-d 'timestamp=2024-05-04+16%3A09%3A17' \
-d 'v=2.0' \
-d 'manual=false' \
-d 'page_version_map=%7B+%09%5C%22home%5C%22%3A+%5C%225.8.0%5C%22%2C+%09%5C%22my-wallet%5C%22%3A+%5C%225.8.0%5C%22+%7D' \
-d 'session_code=123' \
-d 'user_agent=null' \
-d 'user_id=43980'

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

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

req.user_id=43980
req.manual=false
req.page_version_map="{ 	\"home\": \"5.8.0\", 	\"my-wallet\": \"5.8.0\" }"
req.session_code="123"
req.user_agent=""
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.app.data.upload");
add_param(pRequest,"user_id","43980");
add_param(pRequest,"manual","false");
add_param(pRequest,"page_version_map","{ 	\"home\": \"5.8.0\", 	\"my-wallet\": \"5.8.0\" }");
add_param(pRequest,"session_code","123");
add_param(pRequest,"user_agent","数据结构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('cainiao.yima.app.data.upload', {
	'user_id':'43980',
	'manual':'false',
	'page_version_map':'{ 	\"home\": \"5.8.0\", 	\"my-wallet\": \"5.8.0\" }',
	'session_code':'123',
	'user_agent':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<cainiao_yima_app_data_upload_response>
    <data>
        <message>服务未开放</message>
        <pv_ok>true</pv_ok>
        <ua_ok>true</ua_ok>
    </data>
    <status_code>2</status_code>
    <status_message>OK</status_message>
    <is_success>false</is_success>
</cainiao_yima_app_data_upload_response>

{
    "cainiao_yima_app_data_upload_response":{
        "data":{
            "message":"服务未开放",
            "pv_ok":true,
            "ua_ok":true
        },
        "status_code":"2",
        "status_message":"OK",
        "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.app.data.upload (包裹侠应用数据同步)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ