淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
app_battery	String	可选	0		0
arrv_ex_msg	String	可选	快递员定位异常		小件员已到达异常上报msg
arrv_ex_msg_code	Number	可选	10000		小件员已到达异常上报code
arrv_lat	String	可选	124.33		小件员-已到达的纬度
arrv_lng	String	可选	24.33		小件员-已到达的经度
device_type	String	可选	0		0
execute_user_list	ExecuteUserDto []	可选		最大列表长度：20	账号list
└ execute_user_id Number 可选 0 参数executeUserId └ execute_user_type String 可选 foo 参数executeUserType
task_order_id	Number	可选	1042423423		履行任务单ID不能为空
got_code	String	可选	3424		取件码:选填
loc_accuracy	String	可选	0		0
loc_auth	String	可选	0		0
loc_lat	String	可选	0		0
loc_lng	String	可选	0		0
loc_open	String	可选	0		0
loc_succ	String	可选	0		0
loc_time	Number	可选	0		0
loc_type	String	可选	0		0
personal_session	String	可选	dsdf324234234324		个人账号sessionCode不能为空
personal_user_id	Number	可选	324234234324		个人账号ID不能为空
pkg_id	String	可选	0		0
pkg_name	String	可选	0		0
require_order_id	Number	可选	0		0
sdk_version	String	可选	0		0
coordinates	CoordinateDto []	可选		最大列表长度：20	采集经纬度列表
└ arrv_lng String 可选 24.33 小件员-经度 └ arrv_lat String 可选 124.33 小件员-纬度 └ gather_time Number 可选 0 采集节点时间
poi_distance	Number	可选	1		poi距离
dpatch_env	String	可选	1		环境参数
btype	String	可选	上门		订单业务类型
offline	Number	可选	1		离线模块
optime	Number	可选	123		操作时间

名称	类型	示例值	描述
data	OperArriveResDto		参数data
└ operate_result Boolean false 参数operateResult
status_code	String	PARAMS_CANNOT_BE_NULL	错误码
status_message	String	参数不能为空	错误描述
is_success	Boolean	true	是否成功
trace_id	String	32423432	traceId

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
CainiaoGuoguoFulfilArriveRequest req = new CainiaoGuoguoFulfilArriveRequest();
req.setAppBattery("0");
req.setArrvExMsg("快递员定位异常");
req.setArrvExMsgCode(10000L);
req.setArrvLat("124.33");
req.setArrvLng("24.33");
req.setDeviceType("0");
List<CainiaoGuoguoFulfilArriveRequest.ExecuteUserDto> list2 = new ArrayList<CainiaoGuoguoFulfilArriveRequest.ExecuteUserDto>();
CainiaoGuoguoFulfilArriveRequest.ExecuteUserDto obj3 = new CainiaoGuoguoFulfilArriveRequest.ExecuteUserDto();
list2.add(obj3);
obj3.setExecuteUserId(0L);
obj3.setExecuteUserType("foo");
req.setExecuteUserList(list2);
req.setTaskOrderId(1042423423L);
req.setGotCode("3424");
req.setLocAccuracy("0");
req.setLocAuth("0");
req.setLocLat("0");
req.setLocLng("0");
req.setLocOpen("0");
req.setLocSucc("0");
req.setLocTime(0L);
req.setLocType("0");
req.setPersonalSession("dsdf324234234324");
req.setPersonalUserId(324234234324L);
req.setPkgId("0");
req.setPkgName("0");
req.setRequireOrderId(0L);
req.setSdkVersion("0");
List<CainiaoGuoguoFulfilArriveRequest.CoordinateDto> list5 = new ArrayList<CainiaoGuoguoFulfilArriveRequest.CoordinateDto>();
CainiaoGuoguoFulfilArriveRequest.CoordinateDto obj6 = new CainiaoGuoguoFulfilArriveRequest.CoordinateDto();
list5.add(obj6);
obj6.setArrvLng("24.33");
obj6.setArrvLat("124.33");
obj6.setGatherTime(0L);
req.setCoordinates(list5);
req.setPoiDistance(1L);
req.setDpatchEnv("1");
req.setBtype("上门");
req.setOffline(1L);
req.setOptime(123L);
CainiaoGuoguoFulfilArriveResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
CainiaoGuoguoFulfilArriveRequest req = new CainiaoGuoguoFulfilArriveRequest();
req.AppBattery = "0";
req.ArrvExMsg = "快递员定位异常";
req.ArrvExMsgCode = 10000L;
req.ArrvLat = "124.33";
req.ArrvLng = "24.33";
req.DeviceType = "0";
List<CainiaoGuoguoFulfilArriveRequest.ExecuteUserDtoDomain> list2 = new List<CainiaoGuoguoFulfilArriveRequest.ExecuteUserDtoDomain>();
CainiaoGuoguoFulfilArriveRequest.ExecuteUserDtoDomain obj3 = new CainiaoGuoguoFulfilArriveRequest.ExecuteUserDtoDomain();
list2.Add(obj3);
obj3.ExecuteUserId = 0L;
obj3.ExecuteUserType = "foo";
req.ExecuteUserList_ = list2;
req.TaskOrderId = 1042423423L;
req.GotCode = "3424";
req.LocAccuracy = "0";
req.LocAuth = "0";
req.LocLat = "0";
req.LocLng = "0";
req.LocOpen = "0";
req.LocSucc = "0";
req.LocTime = 0L;
req.LocType = "0";
req.PersonalSession = "dsdf324234234324";
req.PersonalUserId = 324234234324L;
req.PkgId = "0";
req.PkgName = "0";
req.RequireOrderId = 0L;
req.SdkVersion = "0";
List<CainiaoGuoguoFulfilArriveRequest.CoordinateDtoDomain> list5 = new List<CainiaoGuoguoFulfilArriveRequest.CoordinateDtoDomain>();
CainiaoGuoguoFulfilArriveRequest.CoordinateDtoDomain obj6 = new CainiaoGuoguoFulfilArriveRequest.CoordinateDtoDomain();
list5.Add(obj6);
obj6.ArrvLng = "24.33";
obj6.ArrvLat = "124.33";
obj6.GatherTime = 0L;
req.Coordinates_ = list5;
req.PoiDistance = 1L;
req.DpatchEnv = "1";
req.Btype = "上门";
req.Offline = 1L;
req.Optime = 123L;
CainiaoGuoguoFulfilArriveResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new CainiaoGuoguoFulfilArriveRequest;
$req->setAppBattery("0");
$req->setArrvExMsg("快递员定位异常");
$req->setArrvExMsgCode("10000");
$req->setArrvLat("124.33");
$req->setArrvLng("24.33");
$req->setDeviceType("0");
$execute_user_list = new ExecuteUserDto;
$execute_user_list->execute_user_id="0";
$execute_user_list->execute_user_type="foo";
$req->setExecuteUserList(json_encode($execute_user_list));
$req->setTaskOrderId("1042423423");
$req->setGotCode("3424");
$req->setLocAccuracy("0");
$req->setLocAuth("0");
$req->setLocLat("0");
$req->setLocLng("0");
$req->setLocOpen("0");
$req->setLocSucc("0");
$req->setLocTime("0");
$req->setLocType("0");
$req->setPersonalSession("dsdf324234234324");
$req->setPersonalUserId("324234234324");
$req->setPkgId("0");
$req->setPkgName("0");
$req->setRequireOrderId("0");
$req->setSdkVersion("0");
$coordinates = new CoordinateDto;
$coordinates->arrv_lng="24.33";
$coordinates->arrv_lat="124.33";
$coordinates->gather_time="0";
$req->setCoordinates(json_encode($coordinates));
$req->setPoiDistance("1");
$req->setDpatchEnv("1");
$req->setBtype("上门");
$req->setOffline("1");
$req->setOptime("123");
$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.fulfil.arrive' \
-d 'partner_id=apidoc' \
-d 'sign=A88C07EEE8CDA90E40789B2578B7B89D' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-29+17%3A03%3A18' \
-d 'v=2.0' \
-d 'app_battery=0' \
-d 'arrv_ex_msg=%E5%BF%AB%E9%80%92%E5%91%98%E5%AE%9A%E4%BD%8D%E5%BC%82%E5%B8%B8' \
-d 'arrv_ex_msg_code=10000' \
-d 'arrv_lat=124.33' \
-d 'arrv_lng=24.33' \
-d 'btype=%E4%B8%8A%E9%97%A8' \
-d 'coordinates=null' \
-d 'device_type=0' \
-d 'dpatch_env=1' \
-d 'execute_user_list=null' \
-d 'got_code=3424' \
-d 'loc_accuracy=0' \
-d 'loc_auth=0' \
-d 'loc_lat=0' \
-d 'loc_lng=0' \
-d 'loc_open=0' \
-d 'loc_succ=0' \
-d 'loc_time=0' \
-d 'loc_type=0' \
-d 'offline=1' \
-d 'optime=123' \
-d 'personal_session=dsdf324234234324' \
-d 'personal_user_id=324234234324' \
-d 'pkg_id=0' \
-d 'pkg_name=0' \
-d 'poi_distance=1' \
-d 'require_order_id=0' \
-d 'sdk_version=0' \
-d 'task_order_id=1042423423'

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

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

req.app_battery="0"
req.arrv_ex_msg="快递员定位异常"
req.arrv_ex_msg_code=10000
req.arrv_lat="124.33"
req.arrv_lng="24.33"
req.device_type="0"
req.execute_user_list=""
req.task_order_id=1042423423
req.got_code="3424"
req.loc_accuracy="0"
req.loc_auth="0"
req.loc_lat="0"
req.loc_lng="0"
req.loc_open="0"
req.loc_succ="0"
req.loc_time=0
req.loc_type="0"
req.personal_session="dsdf324234234324"
req.personal_user_id=324234234324
req.pkg_id="0"
req.pkg_name="0"
req.require_order_id=0
req.sdk_version="0"
req.coordinates=""
req.poi_distance=1
req.dpatch_env="1"
req.btype="上门"
req.offline=1
req.optime=123
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.fulfil.arrive");
add_param(pRequest,"app_battery","0");
add_param(pRequest,"arrv_ex_msg","快递员定位异常");
add_param(pRequest,"arrv_ex_msg_code","10000");
add_param(pRequest,"arrv_lat","124.33");
add_param(pRequest,"arrv_lng","24.33");
add_param(pRequest,"device_type","0");
add_param(pRequest,"execute_user_list","数据结构JSON示例");
add_param(pRequest,"task_order_id","1042423423");
add_param(pRequest,"got_code","3424");
add_param(pRequest,"loc_accuracy","0");
add_param(pRequest,"loc_auth","0");
add_param(pRequest,"loc_lat","0");
add_param(pRequest,"loc_lng","0");
add_param(pRequest,"loc_open","0");
add_param(pRequest,"loc_succ","0");
add_param(pRequest,"loc_time","0");
add_param(pRequest,"loc_type","0");
add_param(pRequest,"personal_session","dsdf324234234324");
add_param(pRequest,"personal_user_id","324234234324");
add_param(pRequest,"pkg_id","0");
add_param(pRequest,"pkg_name","0");
add_param(pRequest,"require_order_id","0");
add_param(pRequest,"sdk_version","0");
add_param(pRequest,"coordinates","数据结构JSON示例");
add_param(pRequest,"poi_distance","1");
add_param(pRequest,"dpatch_env","1");
add_param(pRequest,"btype","上门");
add_param(pRequest,"offline","1");
add_param(pRequest,"optime","123");
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.fulfil.arrive', {
	'app_battery':'0',
	'arrv_ex_msg':'快递员定位异常',
	'arrv_ex_msg_code':'10000',
	'arrv_lat':'124.33',
	'arrv_lng':'24.33',
	'device_type':'0',
	'execute_user_list':'数据结构JSON示例',
	'task_order_id':'1042423423',
	'got_code':'3424',
	'loc_accuracy':'0',
	'loc_auth':'0',
	'loc_lat':'0',
	'loc_lng':'0',
	'loc_open':'0',
	'loc_succ':'0',
	'loc_time':'0',
	'loc_type':'0',
	'personal_session':'dsdf324234234324',
	'personal_user_id':'324234234324',
	'pkg_id':'0',
	'pkg_name':'0',
	'require_order_id':'0',
	'sdk_version':'0',
	'coordinates':'数据结构JSON示例',
	'poi_distance':'1',
	'dpatch_env':'1',
	'btype':'上门',
	'offline':'1',
	'optime':'123'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<cainiao_guoguo_fulfil_arrive_response>
    <data>
        <operate_result>false</operate_result>
    </data>
    <status_code>PARAMS_CANNOT_BE_NULL</status_code>
    <status_message>参数不能为空</status_message>
    <is_success>true</is_success>
    <trace_id>32423432</trace_id>
</cainiao_guoguo_fulfil_arrive_response>

{
    "cainiao_guoguo_fulfil_arrive_response":{
        "data":{
            "operate_result":false
        },
        "status_code":"PARAMS_CANNOT_BE_NULL",
        "status_message":"参数不能为空",
        "is_success":true,
        "trace_id":"32423432"
    }
}

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.fulfil.arrive (快递员已到达arrive)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ