淘宝开放平台

请求地址：

环境	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_blacklist_request	UserBlacklistRequest	必须			上门取退用户黑名单
└ request_id String 必须 1656674541001 业务请求ID，用于做幂等 └ request_time Number 必须 1656674541001 时间戳（毫秒） └ supplier_id String 必须 10000000001 服务商ID └ service_type String 必须 1 服务类型（1-上门取退） └ ability_type String 必须 1 能力（1-上门取退） blacklist Blacklist [] 必须黑名单用户 └ mobile String 必须 13111111111 黑名单用户手机号 └ reason String 可选 1 黑名单用户类型（枚举），多个以英文逗号隔开 1-恶意下单 2-恶意投诉 3-恶意敲诈 4-人身攻击类（辱骂殴打快递员等） 5-其他 └ operate_type Number 必须 1 更新类型 1-新增(增量新增) /更新；2-删除

名称	类型	示例值	描述
user_blacklist_response	UserBlacklistResponse		返回值
└ success Boolean true 系统成功失败 true\|false └ code String 200 响应码 └ message String SUCCESS 响应信息 └ is_retry Boolean false 是否可重试

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
LogisticsExpressUserBlacklistTmsSyncRequest req = new LogisticsExpressUserBlacklistTmsSyncRequest();
LogisticsExpressUserBlacklistTmsSyncRequest.UserBlacklistRequest obj1 = new LogisticsExpressUserBlacklistTmsSyncRequest.UserBlacklistRequest();
obj1.setRequestId("1656674541001");
obj1.setRequestTime(1656674541001L);
obj1.setSupplierId("10000000001");
obj1.setServiceType("1");
obj1.setAbilityType("1");
List<LogisticsExpressUserBlacklistTmsSyncRequest.Blacklist> list3 = new ArrayList<LogisticsExpressUserBlacklistTmsSyncRequest.Blacklist>();
LogisticsExpressUserBlacklistTmsSyncRequest.Blacklist obj4 = new LogisticsExpressUserBlacklistTmsSyncRequest.Blacklist();
list3.add(obj4);
obj4.setMobile("13111111111");
obj4.setReason("1");
obj1.setBlacklist(list3);
obj1.setOperateType(1L);
req.setUserBlacklistRequest(obj1);
LogisticsExpressUserBlacklistTmsSyncResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
LogisticsExpressUserBlacklistTmsSyncRequest req = new LogisticsExpressUserBlacklistTmsSyncRequest();
LogisticsExpressUserBlacklistTmsSyncRequest.UserBlacklistRequestDomain obj1 = new LogisticsExpressUserBlacklistTmsSyncRequest.UserBlacklistRequestDomain();
obj1.RequestId = "1656674541001";
obj1.RequestTime = 1656674541001L;
obj1.SupplierId = "10000000001";
obj1.ServiceType = "1";
obj1.AbilityType = "1";
List<LogisticsExpressUserBlacklistTmsSyncRequest.BlacklistDomain> list3 = new List<LogisticsExpressUserBlacklistTmsSyncRequest.BlacklistDomain>();
LogisticsExpressUserBlacklistTmsSyncRequest.BlacklistDomain obj4 = new LogisticsExpressUserBlacklistTmsSyncRequest.BlacklistDomain();
list3.Add(obj4);
obj4.Mobile = "13111111111";
obj4.Reason = "1";
obj1.Blacklist= list3;
obj1.OperateType = 1L;
req.UserBlacklistRequest_ = obj1;
LogisticsExpressUserBlacklistTmsSyncResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new LogisticsExpressUserBlacklistTmsSyncRequest;
$user_blacklist_request = new UserBlacklistRequest;
$user_blacklist_request->request_id="1656674541001";
$user_blacklist_request->request_time="1656674541001";
$user_blacklist_request->supplier_id="10000000001";
$user_blacklist_request->service_type="1";
$user_blacklist_request->ability_type="1";
$blacklist = new Blacklist;
$blacklist->mobile="13111111111";
$blacklist->reason="1";
$user_blacklist_request->blacklist = $blacklist;
$user_blacklist_request->operate_type="1";
$req->setUserBlacklistRequest(json_encode($user_blacklist_request));
$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=taobao.logistics.express.user.blacklist.tms.sync' \
-d 'partner_id=apidoc' \
-d 'sign=79CAC96EDEE7B39B697D4B9E4CD9834C' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-28+21%3A30%3A28' \
-d 'v=2.0' \
-d 'user_blacklist_request=null'

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

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

req.user_blacklist_request="数据结构示例JSON格式"
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,"taobao.logistics.express.user.blacklist.tms.sync");
add_param(pRequest,"user_blacklist_request","数据结构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('taobao.logistics.express.user.blacklist.tms.sync', {
	'user_blacklist_request':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<logistics_express_user_blacklist_tms_sync_response>
    <user_blacklist_response>
        <success>true</success>
        <code>200</code>
        <message>SUCCESS</message>
        <is_retry>false</is_retry>
    </user_blacklist_response>
</logistics_express_user_blacklist_tms_sync_response>

{
    "logistics_express_user_blacklist_tms_sync_response":{
        "user_blacklist_response":{
            "success":true,
            "code":"200",
            "message":"SUCCESS",
            "is_retry":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下载

天猫供应链

taobao.logistics.express.user.blacklist.tms.sync (上门取退用户黑名单同步)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ