淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
address_ability_async_request	AddressAbilityAsyncRequest	必须			行政地址能力同步/更新接口
└ request_time Number 必须 1656674541000 时间戳（毫秒） └ request_id String 必须 1656674541000_001 业务请求ID，用于做幂等 └ supplier_id String 必须 10000000001 服务商ID └ outer_code String 必须 12345 外部编码 └ service_type String 必须 2 服务类型：2-驿站正向上门 └ ability_type String 必须 2 能力：2-驿站正向上门 └ address_type String 必须 1 地址传入方式 1-地址库ID传入 2-中文地址传入 address_ids AddressIds [] 可选略地址对象list └ address_id String 可选 330110005 四级地址id └ ability_status String 可选 1 能力状态：1-有能力 2-无能力 └ cooperation_delivery_code String 可选 STO 本次合作的淘天平台认定的配资源code，多个以逗号隔开 └ reason String 可选 ABNORMAL_WEATHER 无能力原因 ABNORMAL_WEATHER 异常天气 NATURAL_CALCMITIES 自然灾害 FIRE_OR_EXPLOSION 火灾爆炸 STRIKE 罢工闹事 GOVERNMENT_VERIFICATION 政府核查 OTHER 其他 └ detail_reason String 可选站点临时关停详细不可上门原因 address_names AddressNames [] 可选略地址名称信息 └ province String 可选浙江省省 └ city String 可选杭州市市 └ area String 可选余杭区区 └ town String 可选五常街道街道 └ aility_status String 可选 1 能力状态：1-有能力 2-无能力 └ cooperation_delivery_code String 可选 STO 合作的淘天平台认定的配资源code，多个逗号隔开

名称	类型	示例值	描述
address_ability_async_response	AddressAbilityAsyncResponse		返回值
└ 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);
LogisticsAddressAbilityTmsAsyncRequest req = new LogisticsAddressAbilityTmsAsyncRequest();
LogisticsAddressAbilityTmsAsyncRequest.AddressAbilityAsyncRequest obj1 = new LogisticsAddressAbilityTmsAsyncRequest.AddressAbilityAsyncRequest();
obj1.setRequestTime(1656674541000L);
obj1.setRequestId("1656674541000_001");
obj1.setSupplierId("10000000001");
obj1.setOuterCode("12345");
obj1.setServiceType("2");
obj1.setAbilityType("2");
obj1.setAddressType("1");
List<LogisticsAddressAbilityTmsAsyncRequest.AddressIds> list3 = new ArrayList<LogisticsAddressAbilityTmsAsyncRequest.AddressIds>();
LogisticsAddressAbilityTmsAsyncRequest.AddressIds obj4 = new LogisticsAddressAbilityTmsAsyncRequest.AddressIds();
list3.add(obj4);
obj4.setAddressId("330110005");
obj4.setAbilityStatus("1");
obj4.setCooperationDeliveryCode("STO");
obj4.setReason("ABNORMAL_WEATHER");
obj4.setDetailReason("站点临时关停");
obj1.setAddressIds(list3);
List<LogisticsAddressAbilityTmsAsyncRequest.AddressNames> list6 = new ArrayList<LogisticsAddressAbilityTmsAsyncRequest.AddressNames>();
LogisticsAddressAbilityTmsAsyncRequest.AddressNames obj7 = new LogisticsAddressAbilityTmsAsyncRequest.AddressNames();
list6.add(obj7);
obj7.setProvince("浙江省");
obj7.setCity("杭州市");
obj7.setArea("余杭区");
obj7.setTown("五常街道");
obj7.setAilityStatus("1");
obj7.setCooperationDeliveryCode("STO");
obj1.setAddressNames(list6);
req.setAddressAbilityAsyncRequest(obj1);
LogisticsAddressAbilityTmsAsyncResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
LogisticsAddressAbilityTmsAsyncRequest req = new LogisticsAddressAbilityTmsAsyncRequest();
LogisticsAddressAbilityTmsAsyncRequest.AddressAbilityAsyncRequestDomain obj1 = new LogisticsAddressAbilityTmsAsyncRequest.AddressAbilityAsyncRequestDomain();
obj1.RequestTime = 1656674541000L;
obj1.RequestId = "1656674541000_001";
obj1.SupplierId = "10000000001";
obj1.OuterCode = "12345";
obj1.ServiceType = "2";
obj1.AbilityType = "2";
obj1.AddressType = "1";
List<LogisticsAddressAbilityTmsAsyncRequest.AddressIdsDomain> list3 = new List<LogisticsAddressAbilityTmsAsyncRequest.AddressIdsDomain>();
LogisticsAddressAbilityTmsAsyncRequest.AddressIdsDomain obj4 = new LogisticsAddressAbilityTmsAsyncRequest.AddressIdsDomain();
list3.Add(obj4);
obj4.AddressId = "330110005";
obj4.AbilityStatus = "1";
obj4.CooperationDeliveryCode = "STO";
obj4.Reason = "ABNORMAL_WEATHER";
obj4.DetailReason = "站点临时关停";
obj1.AddressIds= list3;
List<LogisticsAddressAbilityTmsAsyncRequest.AddressNamesDomain> list6 = new List<LogisticsAddressAbilityTmsAsyncRequest.AddressNamesDomain>();
LogisticsAddressAbilityTmsAsyncRequest.AddressNamesDomain obj7 = new LogisticsAddressAbilityTmsAsyncRequest.AddressNamesDomain();
list6.Add(obj7);
obj7.Province = "浙江省";
obj7.City = "杭州市";
obj7.Area = "余杭区";
obj7.Town = "五常街道";
obj7.AilityStatus = "1";
obj7.CooperationDeliveryCode = "STO";
obj1.AddressNames= list6;
req.AddressAbilityAsyncRequest_ = obj1;
LogisticsAddressAbilityTmsAsyncResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new LogisticsAddressAbilityTmsAsyncRequest;
$address_ability_async_request = new AddressAbilityAsyncRequest;
$address_ability_async_request->request_time="1656674541000";
$address_ability_async_request->request_id="1656674541000_001";
$address_ability_async_request->supplier_id="10000000001";
$address_ability_async_request->outer_code="12345";
$address_ability_async_request->service_type="2";
$address_ability_async_request->ability_type="2";
$address_ability_async_request->address_type="1";
$address_ids = new AddressIds;
$address_ids->address_id="330110005";
$address_ids->ability_status="1";
$address_ids->cooperation_delivery_code="STO";
$address_ids->reason="ABNORMAL_WEATHER";
$address_ids->detail_reason="站点临时关停";
$address_ability_async_request->address_ids = $address_ids;
$address_names = new AddressNames;
$address_names->province="浙江省";
$address_names->city="杭州市";
$address_names->area="余杭区";
$address_names->town="五常街道";
$address_names->aility_status="1";
$address_names->cooperation_delivery_code="STO";
$address_ability_async_request->address_names = $address_names;
$req->setAddressAbilityAsyncRequest(json_encode($address_ability_async_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.address.ability.tms.async' \
-d 'partner_id=apidoc' \
-d 'sign=AEBD3E3C120879334E75671E6DCA5FC5' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-04+15%3A50%3A59' \
-d 'v=2.0' \
-d 'address_ability_async_request=null'

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

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

req.address_ability_async_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.address.ability.tms.async");
add_param(pRequest,"address_ability_async_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.address.ability.tms.async', {
	'address_ability_async_request':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<logistics_address_ability_tms_async_response>
    <address_ability_async_response>
        <success>true</success>
        <code>200</code>
        <message>SUCCESS</message>
        <is_retry>false</is_retry>
    </address_ability_async_response>
</logistics_address_ability_tms_async_response>

{
    "logistics_address_ability_tms_async_response":{
        "address_ability_async_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.address.ability.tms.async (行政地址能力同步/更新接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ