文档中心 > API类目 > 物流API

cainiao.yima.app.data.upload (包裹侠应用数据同步)

包裹侠应用相关数据上传：UA、动态页面信息。

公共参数

请求地址：

环境	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());

响应示例

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>

异常示例

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>

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

淘宝开放平台

物流API

cainiao.yima.app.data.upload (包裹侠应用数据同步)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ