淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
agency	NrtAgencyDTO	可选			请求
└ brand_id_str String 可选淘宝心选经营品牌Id(阿里品牌Id)，多个以","分隔 └ op_type String 可选 update 操作类型基础类型 new 、update、delete └ agency_subname String 可选心选商户简称 └ out_id String 可选 123123123 幂等字段 └ agency_code String 可选 tbxx 商户编号 └ version Number 可选 12 版本 └ agency_name String 可选淘宝心选商户名称 └ biz_code String 可选 macalline 业务类型，业务方提供 └ relate_code String 可选 10001 关联的编码

名称	类型	示例值	描述
tmall_nrt_agency_synchronize	ResultDO	{}	返回结果
data NrtStoreDTO true 是否成功 └ agency_id Number 12123 经销商ID └ err_code String E0029 错误码 └ succ Boolean true 调用是否成功 └ err_msg String 服务异常错误信息

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
TmallNrtAgencySynchronizeRequest req = new TmallNrtAgencySynchronizeRequest();
TmallNrtAgencySynchronizeRequest.NrtAgencyDTO obj1 = new TmallNrtAgencySynchronizeRequest.NrtAgencyDTO();
obj1.setBrandIdStr("淘宝心选");
obj1.setOpType("update");
obj1.setAgencySubname("心选");
obj1.setOutId("123123123");
obj1.setAgencyCode("tbxx");
obj1.setVersion(12L);
obj1.setAgencyName("淘宝心选");
obj1.setBizCode("macalline");
obj1.setRelateCode("10001");
req.setAgency(obj1);
TmallNrtAgencySynchronizeResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
TmallNrtAgencySynchronizeRequest req = new TmallNrtAgencySynchronizeRequest();
TmallNrtAgencySynchronizeRequest.NrtAgencyDTODomain obj1 = new TmallNrtAgencySynchronizeRequest.NrtAgencyDTODomain();
obj1.BrandIdStr = "淘宝心选";
obj1.OpType = "update";
obj1.AgencySubname = "心选";
obj1.OutId = "123123123";
obj1.AgencyCode = "tbxx";
obj1.Version = 12L;
obj1.AgencyName = "淘宝心选";
obj1.BizCode = "macalline";
obj1.RelateCode = "10001";
req.Agency_ = obj1;
TmallNrtAgencySynchronizeResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new TmallNrtAgencySynchronizeRequest;
$agency = new NrtAgencyDTO;
$agency->brand_id_str="淘宝心选";
$agency->op_type="update";
$agency->agency_subname="心选";
$agency->out_id="123123123";
$agency->agency_code="tbxx";
$agency->version="12";
$agency->agency_name="淘宝心选";
$agency->biz_code="macalline";
$agency->relate_code="10001";
$req->setAgency(json_encode($agency));
$resp = $c->execute($req, $sessionKey);

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.nrt.agency.synchronize' \
-d 'partner_id=apidoc' \
-d 'session=e34b1120-a85c-4e70-bffc-a9f6e10f903e' \
-d 'sign=EC5AC6DBCCAEC6CDDBE4E5E70068907F' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-15+14%3A19%3A12' \
-d 'v=2.0' \
-d 'agency=null'

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

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

req.agency=""
try:
	resp= req.getResponse(sessionkey)
	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.nrt.agency.synchronize");
add_param(pRequest,"agency","数据结构JSON示例");
pResponse = top_execute(pClient,pRequest,sessionKey);
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.nrt.agency.synchronize', {
	'agency':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<tmall_nrt_agency_synchronize_response>
    <tmall_nrt_agency_synchronize>
        <data>
            <agency_id>12123</agency_id>
        </data>
        <err_code>E0029</err_code>
        <succ>true</succ>
        <err_msg>服务异常</err_msg>
    </tmall_nrt_agency_synchronize>
</tmall_nrt_agency_synchronize_response>

{
    "tmall_nrt_agency_synchronize_response":{
        "tmall_nrt_agency_synchronize":{
            "data":{
                "agency_id":12123
            },
            "err_code":"E0029",
            "succ":true,
            "err_msg":"服务异常"
        }
    }
}

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.nrt.agency.synchronize (经销商同步)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ