淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	描述
param_nick	String	必须	用户nick	xiance_c1
app_name	String	必须	gs1	应用名
memo	String	可选	memo	描术
operation	String	可选	添加	操作描术
operator	String	可选	admin	操作人
operator_id	Number	可选	12345	操作人系统ID

名称	类型	示例值	描述
result	ResultDo	对像	返回结果
└ error_map String {BARCODE_WHITE_LIST_EXISTS=卖家白名单已存在} 白名单已存在 └ errors_str String 卖家白名单已存在卖家白名单已存在 └ module Boolean 返回对像模型DO └ is_success Boolean true 调用是否成功

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
ItemBarcodeGsAddwhitelistRequest req = new ItemBarcodeGsAddwhitelistRequest();
req.setParamNick("用户nick");
req.setAppName("gs1");
req.setMemo("memo");
req.setOperation("添加");
req.setOperator("admin");
req.setOperatorId(12345L);
ItemBarcodeGsAddwhitelistResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
ItemBarcodeGsAddwhitelistRequest req = new ItemBarcodeGsAddwhitelistRequest();
req.ParamNick = "用户nick";
req.AppName = "gs1";
req.Memo = "memo";
req.Operation = "添加";
req.Operator = "admin";
req.OperatorId = 12345L;
ItemBarcodeGsAddwhitelistResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new ItemBarcodeGsAddwhitelistRequest;
$req->setParamNick("用户nick");
$req->setAppName("gs1");
$req->setMemo("memo");
$req->setOperation("添加");
$req->setOperator("admin");
$req->setOperatorId("12345");
$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.item.barcode.gs.addwhitelist' \
-d 'partner_id=apidoc' \
-d 'sign=9FBCBD5BB1E63BEF228108E48E68FE68' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-05+17%3A36%3A10' \
-d 'v=2.0' \
-d 'app_name=gs1' \
-d 'memo=memo' \
-d 'operation=%E6%B7%BB%E5%8A%A0' \
-d 'operator=admin' \
-d 'operator_id=12345' \
-d 'param_nick=%E7%94%A8%E6%88%B7nick'

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

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

req.param_nick="用户nick"
req.app_name="gs1"
req.memo="memo"
req.operation="添加"
req.operator="admin"
req.operator_id=12345
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.item.barcode.gs.addwhitelist");
add_param(pRequest,"param_nick","用户nick");
add_param(pRequest,"app_name","gs1");
add_param(pRequest,"memo","memo");
add_param(pRequest,"operation","添加");
add_param(pRequest,"operator","admin");
add_param(pRequest,"operator_id","12345");
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.item.barcode.gs.addwhitelist', {
	'param_nick':'用户nick',
	'app_name':'gs1',
	'memo':'memo',
	'operation':'添加',
	'operator':'admin',
	'operator_id':'12345'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<item_barcode_gs_addwhitelist_response>
    <result>
        <error_map>{BARCODE_WHITE_LIST_EXISTS=卖家白名单已存在}</error_map>
        <errors_str>卖家白名单已存在</errors_str>
        <module>返回对像</module>
        <is_success>true</is_success>
    </result>
</item_barcode_gs_addwhitelist_response>

{
    "item_barcode_gs_addwhitelist_response":{
        "result":{
            "error_map":"{BARCODE_WHITE_LIST_EXISTS=卖家白名单已存在}",
            "errors_str":"卖家白名单已存在",
            "module":返回对像,
            "is_success":true
        }
    }
}

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.item.barcode.gs.addwhitelist (添加白名单接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ