淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
branch_address_id	Number	可选	120000		网点地址信息
execute_user_list	ExecuteUserDto []	可选		最大列表长度：20	账号list
└ execute_user_id Number 可选 0 参数executeUserId └ execute_user_type String 可选 foo 参数executeUserType
personal_session	String	可选	dsdf324234234324		个人账号sessionCode不能为空
personal_user_id	Number	可选	324234234324		个人账号ID不能为空

名称	类型	示例值	描述
status_code	String	PARAMS_CANNOT_BE_NULL	错误码
status_message	String	参数不能为空	错误描述
is_success	Boolean	true	是否成功
trace_id	String	0be4314615320739620257888e18e2	鹰眼ID

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
CainiaoGuoguoFulfilWaybillSubscribeCancelRequest req = new CainiaoGuoguoFulfilWaybillSubscribeCancelRequest();
req.setBranchAddressId(120000L);
List<CainiaoGuoguoFulfilWaybillSubscribeCancelRequest.ExecuteUserDto> list2 = new ArrayList<CainiaoGuoguoFulfilWaybillSubscribeCancelRequest.ExecuteUserDto>();
CainiaoGuoguoFulfilWaybillSubscribeCancelRequest.ExecuteUserDto obj3 = new CainiaoGuoguoFulfilWaybillSubscribeCancelRequest.ExecuteUserDto();
list2.add(obj3);
obj3.setExecuteUserId(0L);
obj3.setExecuteUserType("foo");
req.setExecuteUserList(list2);
req.setPersonalSession("dsdf324234234324");
req.setPersonalUserId(324234234324L);
CainiaoGuoguoFulfilWaybillSubscribeCancelResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
CainiaoGuoguoFulfilWaybillSubscribeCancelRequest req = new CainiaoGuoguoFulfilWaybillSubscribeCancelRequest();
req.BranchAddressId = 120000L;
List<CainiaoGuoguoFulfilWaybillSubscribeCancelRequest.ExecuteUserDtoDomain> list2 = new List<CainiaoGuoguoFulfilWaybillSubscribeCancelRequest.ExecuteUserDtoDomain>();
CainiaoGuoguoFulfilWaybillSubscribeCancelRequest.ExecuteUserDtoDomain obj3 = new CainiaoGuoguoFulfilWaybillSubscribeCancelRequest.ExecuteUserDtoDomain();
list2.Add(obj3);
obj3.ExecuteUserId = 0L;
obj3.ExecuteUserType = "foo";
req.ExecuteUserList_ = list2;
req.PersonalSession = "dsdf324234234324";
req.PersonalUserId = 324234234324L;
CainiaoGuoguoFulfilWaybillSubscribeCancelResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new CainiaoGuoguoFulfilWaybillSubscribeCancelRequest;
$req->setBranchAddressId("120000");
$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->setPersonalSession("dsdf324234234324");
$req->setPersonalUserId("324234234324");
$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.waybill.subscribe.cancel' \
-d 'partner_id=apidoc' \
-d 'sign=34FFF20481F2B0795B286831C5EE5A4F' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-29+17%3A03%3A19' \
-d 'v=2.0' \
-d 'branch_address_id=120000' \
-d 'execute_user_list=null' \
-d 'personal_session=dsdf324234234324' \
-d 'personal_user_id=324234234324'

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

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

req.branch_address_id=120000
req.execute_user_list=""
req.personal_session="dsdf324234234324"
req.personal_user_id=324234234324
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.waybill.subscribe.cancel");
add_param(pRequest,"branch_address_id","120000");
add_param(pRequest,"execute_user_list","数据结构JSON示例");
add_param(pRequest,"personal_session","dsdf324234234324");
add_param(pRequest,"personal_user_id","324234234324");
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.waybill.subscribe.cancel', {
	'branch_address_id':'120000',
	'execute_user_list':'数据结构JSON示例',
	'personal_session':'dsdf324234234324',
	'personal_user_id':'324234234324'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<cainiao_guoguo_fulfil_waybill_subscribe_cancel_response>
    <status_code>PARAMS_CANNOT_BE_NULL</status_code>
    <status_message>参数不能为空</status_message>
    <is_success>true</is_success>
    <trace_id>0be4314615320739620257888e18e2</trace_id>
</cainiao_guoguo_fulfil_waybill_subscribe_cancel_response>

{
    "cainiao_guoguo_fulfil_waybill_subscribe_cancel_response":{
        "status_code":"PARAMS_CANNOT_BE_NULL",
        "status_message":"参数不能为空",
        "is_success":true,
        "trace_id":"0be4314615320739620257888e18e2"
    }
}

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.waybill.subscribe.cancel (电子面单开通服务cancelWaybillSubscribe)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ