淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
request	Request	可选
└ actionType String 可选 add\|update, 必填 add\|update, 必填 └ supplierCode String 可选供应商编码 string (50), 必填供应商编码 string (50), 必填 └ supplierName String 可选供应商名称 string (200) , 必填供应商名称 string (200) , 必填 └ name String 可选联系人姓名, string (50) 联系人姓名, string (50) └ tel String 可选联系电话, string (50) 联系电话, string (50) └ email String 可选电子邮箱, string (50) 电子邮箱, string (50) └ countryCode String 可选国家二字码，string（50）国家二字码，string（50） └ province String 可选省份, string (50) 省份, string (50) └ city String 可选城市, string (50) 城市, string (50) └ area String 可选区域, string (50) 区域, string (50) └ town String 可选村镇, string (50) 村镇, string (50) └ detailAddress String 可选详细地址, string (200) 详细地址, string (200) └ isValid String 可选是否有效, Y/N (默认为Y) 是否有效, Y/N (默认为Y) └ remark String 可选备注, string (500) 备注, string (500)

名称	类型	示例值	描述
response	Response
└ flag String success\|failure success\|failure └ code String 响应码响应码 └ message String 响应信息响应信息

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
QimenSupplierSynchronizeRequest req = new QimenSupplierSynchronizeRequest();
QimenSupplierSynchronizeRequest.Request obj1 = new QimenSupplierSynchronizeRequest.Request();
obj1.setActionType("add|update, 必填");
obj1.setSupplierCode("供应商编码 string (50), 必填");
obj1.setSupplierName("供应商名称 string (200) , 必填");
obj1.setName("联系人姓名, string (50)");
obj1.setTel("联系电话, string (50)");
obj1.setEmail("电子邮箱, string (50)");
obj1.setCountryCode("国家二字码，string（50）");
obj1.setProvince("省份, string (50)");
obj1.setCity("城市, string (50)");
obj1.setArea("区域, string (50)");
obj1.setTown("村镇, string (50)");
obj1.setDetailAddress("详细地址, string (200)");
obj1.setIsValid("是否有效, Y/N (默认为Y)");
obj1.setRemark("备注, string (500)");
req.setRequest(obj1);
QimenSupplierSynchronizeResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
QimenSupplierSynchronizeRequest req = new QimenSupplierSynchronizeRequest();
QimenSupplierSynchronizeRequest.RequestDomain obj1 = new QimenSupplierSynchronizeRequest.RequestDomain();
obj1.ActionType = "add|update, 必填";
obj1.SupplierCode = "供应商编码 string (50), 必填";
obj1.SupplierName = "供应商名称 string (200) , 必填";
obj1.Name = "联系人姓名, string (50)";
obj1.Tel = "联系电话, string (50)";
obj1.Email = "电子邮箱, string (50)";
obj1.CountryCode = "国家二字码，string（50）";
obj1.Province = "省份, string (50)";
obj1.City = "城市, string (50)";
obj1.Area = "区域, string (50)";
obj1.Town = "村镇, string (50)";
obj1.DetailAddress = "详细地址, string (200)";
obj1.IsValid = "是否有效, Y/N (默认为Y)";
obj1.Remark = "备注, string (500)";
req.Request_ = obj1;
QimenSupplierSynchronizeResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new QimenSupplierSynchronizeRequest;
$request = new Request;
$request->action_type="add|update, 必填";
$request->supplier_code="供应商编码 string (50), 必填";
$request->supplier_name="供应商名称 string (200) , 必填";
$request->name="联系人姓名, string (50)";
$request->tel="联系电话, string (50)";
$request->email="电子邮箱, string (50)";
$request->country_code="国家二字码，string（50）";
$request->province="省份, string (50)";
$request->city="城市, string (50)";
$request->area="区域, string (50)";
$request->town="村镇, string (50)";
$request->detail_address="详细地址, string (200)";
$request->is_valid="是否有效, Y/N (默认为Y)";
$request->remark="备注, string (500)";
$req->setRequest(json_encode($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.qimen.supplier.synchronize' \
-d 'partner_id=apidoc' \
-d 'sign=815E6BCC0D8D9482AF4614172863534F' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-12+03%3A24%3A17' \
-d 'v=2.0' \
-d 'request=null'

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

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

req.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.qimen.supplier.synchronize");
add_param(pRequest,"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.qimen.supplier.synchronize', {
	'request':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<response>
    <flag>success|failure</flag>
    <code>响应码</code>
    <message>响应信息</message>
</response>

{
    "response":{
        "flag":"success|failure",
        "code":"响应码",
        "message":"响应信息"
    }
}

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

taobao.qimen.supplier.synchronize (供应商同步接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ