阿里安全开放平台-阿里聚安全

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
category_id	Number	必须	1512		商品发布的目标类目，必须是叶子类目
product_id	Number	必须	12314		商品发布的目标product_id
type	String	可选	b	默认值：b	发布商品类型，一口价填“b”，拍卖填"a"
isv_init	Boolean	可选	true		正常接口调用时，请忽略这个参数或者填FALSE。这个参数提供给ISV对接Schema时，如果想先获取了解所有字段和规则，可以将此字段设置为true，product_id也就不需要提供了，设置为0即可

名称	类型	示例值	描述
add_item_result	String	<rules><field id="prop_1632501" type="input" required="true"><name>货号</name><value type="text"/></field></rules>	返回发布商品的规则文档

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
TmallItemAddSchemaGetRequest req = new TmallItemAddSchemaGetRequest();
req.setCategoryId(1512L);
req.setProductId(12314L);
req.setType("b");
req.setIsvInit(true);
TmallItemAddSchemaGetResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
TmallItemAddSchemaGetRequest req = new TmallItemAddSchemaGetRequest();
req.CategoryId = 1512L;
req.ProductId = 12314L;
req.Type = "b";
req.IsvInit = true;
TmallItemAddSchemaGetResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new TmallItemAddSchemaGetRequest;
$req->setCategoryId("1512");
$req->setProductId("12314");
$req->setType("b");
$req->setIsvInit("true");
$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.item.add.schema.get' \
-d 'partner_id=apidoc' \
-d 'session=6f8f8742-371b-43d1-a0c5-7a28116c506f' \
-d 'sign=3A699437E9C75BBD20644342A462DBFC' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-26+14%3A34%3A25' \
-d 'v=2.0' \
-d 'category_id=1512' \
-d 'isv_init=true' \
-d 'product_id=12314' \
-d 'type=b'

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

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

req.category_id=1512
req.product_id=12314
req.type="b"
req.isv_init=true
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.item.add.schema.get");
add_param(pRequest,"category_id","1512");
add_param(pRequest,"product_id","12314");
add_param(pRequest,"type","b");
add_param(pRequest,"isv_init","true");
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.item.add.schema.get', {
	'category_id':'1512',
	'product_id':'12314',
	'type':'b',
	'isv_init':'true'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<tmall_item_add_schema_get_response>
    <add_item_result>&lt;rules&gt;&lt;field id=&quot;prop_1632501&quot; type=&quot;input&quot; required=&quot;true&quot;&gt;&lt;name&gt;货号&lt;/name&gt;&lt;value type=&quot;text&quot;/&gt;&lt;/field&gt;&lt;/rules&gt;</add_item_result>
</tmall_item_add_schema_get_response>

{
    "tmall_item_add_schema_get_response":{
        "add_item_result":"<rules><field id=\"prop_1632501\" type=\"input\" required=\"true\"><name>货号<\/name><value type=\"text\"\/><\/field><\/rules>"
    }
}

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"
	}
}

错误码	错误描述	解决方案
isv.invalid-parameter:category-not-found	指定的类目不存在	通过类目api 获取天猫标准属性类目的id （cid）
isv.invalid-parameter:product_id	产品id（product_id）不存在	通过商品api类目下添加或搜索产品api得到产品id 。
isv.invalid-parameter:cid	商品类目未授权，请重新选择类目	选择商家已经获得授权的类目，通过类目api 可以获取到商家获得那些品牌授权
isp.remote-service-error:deliveryService:-1	服务错误，稍后重试	服务错误，稍后重试
isp.tmall_item_service_error	服务错误，稍后重试	服务错误，稍后重试
isv.invalid-parameter:product-not-found	未找到相应的产品id（product_id）	产品id 不属于当前使用类目下，通过产品搜索接口重新获取类目和产品id对应关系。
isv.invalid-parameter:not-leaft-category	指定类目不是叶子类目	入参时category_id 必须传人叶子类目
isv.invalid-parameter:cid;isv.invalid-parameter:cid	商品类目未授权，请重新选择类目	选择商家已经获得授权的类目，通过类目api 可以获取到商家获得那些品牌授权
isp.remote-service-error:userService:hsf connect is error	服务错误，稍后重试	服务错误，稍后重试
isv.invalid-permission:publish_itemupdate_item	C卖家（即淘宝卖家）没有调用天猫服务层接口发布或编辑商品的权限	带tmall 字样的schema接口，仅支持天猫商家；淘宝用户使用带taobao 字样的schema接口
isv.invalid-parameter:cid;isv.invalid-parameter:propsinput_str	商品类目未授权，请重新选择类目;商品品牌未授权	调接口时，传人的product_id对应的类目和品牌，卖家并未获得授权。
isv.invalid-parameter:propsinput_str	参照 “isv.invalid-parameter:cid;isv.invalid-parameter:propsinput_str” 的错误说明	参照 “isv.invalid-parameter:cid;isv.invalid-parameter:propsinput_str” 的解决方案
isv.invalid-parameter:category-frozen	当前类目已冻结	做本地缓存，返回该错误后，不要再发起该类目下的请求，请选择其他类目发布
isp.tmallitem-service-error:empty	服务错误，稍后重试	服务错误，稍后重试
isv.invalid-parameter:cid;isp.tmallitem-service-error:empty	服务错误，稍后重试	服务错误，稍后重试
invalid-parameter:product_id	参数product_id格式不正确	请检查product_id参数格式，修改后再提交
isv.invalid-parameter:category-frozen;isp.tmallitem-service-error:empty	当前类目已冻结	做本地缓存，返回该错误后，不要再发起该类目下的请求，请选择其他类目发布
isv.invalid-parameter:empty;invalid-parameter:biz-identity-forbidden	当前类目已冻结	当前类目已冻结，请选择其他类目发布
isp.remote-service-error:	服务错误，稍后重试	服务错误，稍后重试
isv.invalid-parameter:category-not-found;isv.invalid-parameter:cid	商品发布类目不存在	类目不存在，请检查cid参数是否正确
isv.invalid-parameter:category-frozen;isv.invalid-parameter:cid	当前类目已冻结	做本地缓存，返回该错误后，不要再发起该类目下的请求，请选择其他类目发布

API测试工具错误码查询工具 SDK下载

商品API

tmall.item.add.schema.get (天猫发布商品规则获取)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈