淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
area_request	TxpAccountAreaRequest	可选			请求入参
auth_area_dto TxpAccountAreaDTO [] 可选请求变量 └ account_id Number 可选 1234 账号id └ account_name String 可选张三经销商账号名称 └ province_code Number 可选 330000 省code └ province_name String 可选浙江省省名称 └ city_code Number 可选 330100 城市code └ city_name String 可选杭州城市名称 └ area_code Number 可选 330110 区域code └ area_name String 可选余杭区区域名称 └ town_code Number 可选 330110005 街道code └ town_name String 可选五常街道街道名称 └ community_id Number 可选 123456 社区id └ community_name String 可选 xxxx 社区名称 └ store_id Number 可选 123456 门店id └ address String 可选 xxxx 地址 └ account_type String 可选 xxxx 账户类型 └ status String 可选 xxx 状态 └ modifier_name String 可选张三修改人名称 └ creator_name String 可选张三创建人名称 └ modifier_id Number 可选 1234 修改人id └ creator_id Number 可选 1234 创建人id └ version Number 可选 0 版本号 └ attributes String 可选 xxxx 扩展字段 └ gmt_modified Date 可选 2018-06-12 19:59:20 修改时间 └ gmt_create Date 可选 2018-06-12 19:59:20 创建时间 un_auth_area_dto TxpAccountAreaDTO [] 可选请求入参 └ account_id Number 可选 1234 账号id └ account_name String 可选张三经销商账号名称 └ province_code Number 可选 330000 省code └ province_name String 可选浙江省省名称 └ city_code Number 可选 330100 城市code └ city_name String 可选杭州城市名称 └ area_code Number 可选 330110 区域code └ area_name String 可选余杭区区域名称 └ town_code Number 可选 330110005 街道code └ town_name String 可选五常街道街道名称 └ community_id Number 可选 123456 社区id └ community_name String 可选 xxxx 社区名称 └ store_id Number 可选 123456 门店id └ address String 可选 xxxxx 地址 └ account_type String 可选 xxxx 用户类型 └ status String 可选 "" 状态 └ modifier_name String 可选张三修改人名称 └ creator_name String 可选张三创建人名称 └ modifier_id Number 可选 1234 修改人id └ creator_id Number 可选 1234 创建人id └ version Number 可选 0 版本号 └ attributes String 可选 xxxx 扩展字段 └ gmt_modified Date 可选 2018-06-12 19:59:20 修改时间 └ gmt_create Date 可选 2018-06-12 19:59:20 创建时间

名称	类型	示例值	描述
succ	Boolean	true	succ
area_code	String	xxx	code
area_msg	String	xxx	msg
data	Json	1234	data

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
TmallMafiaAccountAreaAuthRequest req = new TmallMafiaAccountAreaAuthRequest();
TmallMafiaAccountAreaAuthRequest.TxpAccountAreaRequest obj1 = new TmallMafiaAccountAreaAuthRequest.TxpAccountAreaRequest();
List<TmallMafiaAccountAreaAuthRequest.TxpAccountAreaDTO> list3 = new ArrayList<TmallMafiaAccountAreaAuthRequest.TxpAccountAreaDTO>();
TmallMafiaAccountAreaAuthRequest.TxpAccountAreaDTO obj4 = new TmallMafiaAccountAreaAuthRequest.TxpAccountAreaDTO();
list3.add(obj4);
obj4.setAccountId(1234L);
obj4.setAccountName("张三经销商");
obj4.setProvinceCode(330000L);
obj4.setProvinceName("浙江省");
obj4.setCityCode(330100L);
obj4.setCityName("杭州");
obj4.setAreaCode(330110L);
obj4.setAreaName("余杭区");
obj4.setTownCode(330110005L);
obj4.setTownName("五常街道");
obj4.setCommunityId(123456L);
obj4.setCommunityName("xxxx");
obj4.setStoreId(123456L);
obj4.setAddress("xxxx");
obj4.setAccountType("xxxx");
obj4.setStatus("xxx");
obj4.setModifierName("张三");
obj4.setCreatorName("张三");
obj4.setModifierId(1234L);
obj4.setCreatorId(1234L);
obj4.setVersion(0L);
obj4.setAttributes("xxxx");
obj4.setGmtModified(StringUtils.parseDateTime("2018-06-12 19:59:20"));
obj4.setGmtCreate(StringUtils.parseDateTime("2018-06-12 19:59:20"));
obj1.setAuthAreaDto(list3);
List<TmallMafiaAccountAreaAuthRequest.TxpAccountAreaDTO> list6 = new ArrayList<TmallMafiaAccountAreaAuthRequest.TxpAccountAreaDTO>();
TmallMafiaAccountAreaAuthRequest.TxpAccountAreaDTO obj7 = new TmallMafiaAccountAreaAuthRequest.TxpAccountAreaDTO();
list6.add(obj7);
obj7.setAccountId(1234L);
obj7.setAccountName("张三经销商");
obj7.setProvinceCode(330000L);
obj7.setProvinceName("浙江省");
obj7.setCityCode(330100L);
obj7.setCityName("杭州");
obj7.setAreaCode(330110L);
obj7.setAreaName("余杭区");
obj7.setTownCode(330110005L);
obj7.setTownName("五常街道");
obj7.setCommunityId(123456L);
obj7.setCommunityName("xxxx");
obj7.setStoreId(123456L);
obj7.setAddress("xxxxx");
obj7.setAccountType("xxxx");
obj7.setStatus("\"\"");
obj7.setModifierName("张三");
obj7.setCreatorName("张三");
obj7.setModifierId(1234L);
obj7.setCreatorId(1234L);
obj7.setVersion(0L);
obj7.setAttributes("xxxx");
obj7.setGmtModified(StringUtils.parseDateTime("2018-06-12 19:59:20"));
obj7.setGmtCreate(StringUtils.parseDateTime("2018-06-12 19:59:20"));
obj1.setUnAuthAreaDto(list6);
req.setAreaRequest(obj1);
TmallMafiaAccountAreaAuthResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
TmallMafiaAccountAreaAuthRequest req = new TmallMafiaAccountAreaAuthRequest();
TmallMafiaAccountAreaAuthRequest.TxpAccountAreaRequestDomain obj1 = new TmallMafiaAccountAreaAuthRequest.TxpAccountAreaRequestDomain();
List<TmallMafiaAccountAreaAuthRequest.TxpAccountAreaDTODomain> list3 = new List<TmallMafiaAccountAreaAuthRequest.TxpAccountAreaDTODomain>();
TmallMafiaAccountAreaAuthRequest.TxpAccountAreaDTODomain obj4 = new TmallMafiaAccountAreaAuthRequest.TxpAccountAreaDTODomain();
list3.Add(obj4);
obj4.AccountId = 1234L;
obj4.AccountName = "张三经销商";
obj4.ProvinceCode = 330000L;
obj4.ProvinceName = "浙江省";
obj4.CityCode = 330100L;
obj4.CityName = "杭州";
obj4.AreaCode = 330110L;
obj4.AreaName = "余杭区";
obj4.TownCode = 330110005L;
obj4.TownName = "五常街道";
obj4.CommunityId = 123456L;
obj4.CommunityName = "xxxx";
obj4.StoreId = 123456L;
obj4.Address = "xxxx";
obj4.AccountType = "xxxx";
obj4.Status = "xxx";
obj4.ModifierName = "张三";
obj4.CreatorName = "张三";
obj4.ModifierId = 1234L;
obj4.CreatorId = 1234L;
obj4.Version = 0L;
obj4.Attributes = "xxxx";
obj4.GmtModified = DateTime.Parse(2018-06-12 19:59:20");
obj4.GmtCreate = DateTime.Parse(2018-06-12 19:59:20");
obj1.AuthAreaDto= list3;
List<TmallMafiaAccountAreaAuthRequest.TxpAccountAreaDTODomain> list6 = new List<TmallMafiaAccountAreaAuthRequest.TxpAccountAreaDTODomain>();
TmallMafiaAccountAreaAuthRequest.TxpAccountAreaDTODomain obj7 = new TmallMafiaAccountAreaAuthRequest.TxpAccountAreaDTODomain();
list6.Add(obj7);
obj7.AccountId = 1234L;
obj7.AccountName = "张三经销商";
obj7.ProvinceCode = 330000L;
obj7.ProvinceName = "浙江省";
obj7.CityCode = 330100L;
obj7.CityName = "杭州";
obj7.AreaCode = 330110L;
obj7.AreaName = "余杭区";
obj7.TownCode = 330110005L;
obj7.TownName = "五常街道";
obj7.CommunityId = 123456L;
obj7.CommunityName = "xxxx";
obj7.StoreId = 123456L;
obj7.Address = "xxxxx";
obj7.AccountType = "xxxx";
obj7.Status = "\"\"";
obj7.ModifierName = "张三";
obj7.CreatorName = "张三";
obj7.ModifierId = 1234L;
obj7.CreatorId = 1234L;
obj7.Version = 0L;
obj7.Attributes = "xxxx";
obj7.GmtModified = DateTime.Parse(2018-06-12 19:59:20");
obj7.GmtCreate = DateTime.Parse(2018-06-12 19:59:20");
obj1.UnAuthAreaDto= list6;
req.AreaRequest_ = obj1;
TmallMafiaAccountAreaAuthResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new TmallMafiaAccountAreaAuthRequest;
$area_request = new TxpAccountAreaRequest;
$auth_area_dto = new TxpAccountAreaDTO;
$auth_area_dto->account_id="1234";
$auth_area_dto->account_name="张三经销商";
$auth_area_dto->province_code="330000";
$auth_area_dto->province_name="浙江省";
$auth_area_dto->city_code="330100";
$auth_area_dto->city_name="杭州";
$auth_area_dto->area_code="330110";
$auth_area_dto->area_name="余杭区";
$auth_area_dto->town_code="330110005";
$auth_area_dto->town_name="五常街道";
$auth_area_dto->community_id="123456";
$auth_area_dto->community_name="xxxx";
$auth_area_dto->store_id="123456";
$auth_area_dto->address="xxxx";
$auth_area_dto->account_type="xxxx";
$auth_area_dto->status="xxx";
$auth_area_dto->modifier_name="张三";
$auth_area_dto->creator_name="张三";
$auth_area_dto->modifier_id="1234";
$auth_area_dto->creator_id="1234";
$auth_area_dto->version="0";
$auth_area_dto->attributes="xxxx";
$auth_area_dto->gmt_modified="2018-06-12 19:59:20";
$auth_area_dto->gmt_create="2018-06-12 19:59:20";
$area_request->auth_area_dto = $auth_area_dto;
$un_auth_area_dto = new TxpAccountAreaDTO;
$un_auth_area_dto->account_id="1234";
$un_auth_area_dto->account_name="张三经销商";
$un_auth_area_dto->province_code="330000";
$un_auth_area_dto->province_name="浙江省";
$un_auth_area_dto->city_code="330100";
$un_auth_area_dto->city_name="杭州";
$un_auth_area_dto->area_code="330110";
$un_auth_area_dto->area_name="余杭区";
$un_auth_area_dto->town_code="330110005";
$un_auth_area_dto->town_name="五常街道";
$un_auth_area_dto->community_id="123456";
$un_auth_area_dto->community_name="xxxx";
$un_auth_area_dto->store_id="123456";
$un_auth_area_dto->address="xxxxx";
$un_auth_area_dto->account_type="xxxx";
$un_auth_area_dto->status="\"\"";
$un_auth_area_dto->modifier_name="张三";
$un_auth_area_dto->creator_name="张三";
$un_auth_area_dto->modifier_id="1234";
$un_auth_area_dto->creator_id="1234";
$un_auth_area_dto->version="0";
$un_auth_area_dto->attributes="xxxx";
$un_auth_area_dto->gmt_modified="2018-06-12 19:59:20";
$un_auth_area_dto->gmt_create="2018-06-12 19:59:20";
$area_request->un_auth_area_dto = $un_auth_area_dto;
$req->setAreaRequest(json_encode($area_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=tmall.mafia.account.area.auth' \
-d 'partner_id=apidoc' \
-d 'sign=0CA5472BFC31F9BC5D4AD6F7CCA7A107' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-22+16%3A42%3A12' \
-d 'v=2.0' \
-d 'area_request=null'

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

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

req.area_request=""
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,"tmall.mafia.account.area.auth");
add_param(pRequest,"area_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('tmall.mafia.account.area.auth', {
	'area_request':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<tmall_mafia_account_area_auth_response>
    <succ>true</succ>
    <area_code>xxx</area_code>
    <area_msg>xxx</area_msg>
    <data>1234</data>
</tmall_mafia_account_area_auth_response>

{
    "tmall_mafia_account_area_auth_response":{
        "succ":true,
        "area_code":"xxx",
        "area_msg":"xxx",
        "data":"1234"
    }
}

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

tmall.mafia.account.area.auth (经销商区域授权)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ