文档中心 > API类目 > 商品API

tmall.product.template.get (产品接口)

产品模板获取接口，对于非关键属性的类目，发布达尔文(监管)产品时，必须先根据类目获取产品模板。
产品模板定义产品发布需要的类目属性，包括：
关键属性:关键属性可以在类目上不存在。不存在的PID，默认为输入，没有子属性。属性名称在prop_name_str中取绑定属性:内容为属性ID(PID)的列表,绑定属性肯定在类目上有，对应属性的类目特征，子属性请根据PID到类目上去取
过滤属性:内容有属性ID(PID)列表，很重要的属性，filter_properties包含的属性，必须填写
如果获取不到模板，非关键属性类目是不能发布产品的

公共参数

请求地址：

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

请求参数

名称	类型	是否必须	示例值	更多限制	描述
cid	Number	必须	1512		类目ID

响应参数

名称	类型	示例值	描述
template	SpuTemplateDO		见SpuTemplateDO说明
└ key_properties Number [] [1,2,3,4] 产品关键属性，内容为属性ID(PID)的列表，注意关键属性可以在类目上不存在。不存在的PID，默认为输入，没有子属性。属性名称在prop_name_str中取 └ affect_properties Number [] [1,2,3,4,5] 产品绑定属性，内容为属性ID(PID)的列表,绑定属性肯定在类目上有，对应属性的类目特征，子属性请根据PID到类目上去取 └ filter_properties Number [] [1,2,3,4] 过滤属性，内容有属性ID(PID)列表，很重要的属性，filter_properties包含的属性，必须填写 └ category_id Number 1512 类目ID └ template_id Number 1289 模板ID，发布产品，必须放到Product中 └ commodity_id Number 1 品类ID，和类目ID类似 └ prop_name_str String 100148233$剂型,100148233$剂型属性名称扁平化结构，只保证不在类目上的CP有值 └ prop_features String “” 预留

请求示例

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
TmallProductTemplateGetRequest req = new TmallProductTemplateGetRequest();
req.setCid(1512L);
TmallProductTemplateGetResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
TmallProductTemplateGetRequest req = new TmallProductTemplateGetRequest();
req.Cid = 1512L;
TmallProductTemplateGetResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new TmallProductTemplateGetRequest;
$req->setCid("1512");
$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.product.template.get' \
-d 'partner_id=apidoc' \
-d 'session=bbec99bd-2b0d-4713-8244-98966c820731' \
-d 'sign=C32BEB557013C77E1D2B3A31500E02EC' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-29+20%3A21%3A15' \
-d 'v=2.0' \
-d 'cid=1512'

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

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

req.cid=1512
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.product.template.get");
add_param(pRequest,"cid","1512");
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.product.template.get', {
	'cid':'1512'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

XML示例
JSON示例

<tmall_product_template_get_response>
    <template>
        <key_properties>
            <number>[1</number>
            <number>2</number>
            <number>3</number>
            <number>4]</number>
        </key_properties>
        <affect_properties>
            <number>[1</number>
            <number>2</number>
            <number>3</number>
            <number>4</number>
            <number>5]</number>
        </affect_properties>
        <filter_properties>
            <number>[1</number>
            <number>2</number>
            <number>3</number>
            <number>4]</number>
        </filter_properties>
        <category_id>1512</category_id>
        <template_id>1289</template_id>
        <commodity_id>1</commodity_id>
        <prop_name_str>100148233$剂 型,100148233$剂 型</prop_name_str>
        <prop_features>“”</prop_features>
    </template>
</tmall_product_template_get_response>

{
    "tmall_product_template_get_response":{
        "template":{
            "key_properties":{
                "number":[
                    [1,
                    2,
                    3,
                    4]
                ]
            },
            "affect_properties":{
                "number":[
                    [1,
                    2,
                    3,
                    4,
                    5]
                ]
            },
            "filter_properties":{
                "number":[
                    [1,
                    2,
                    3,
                    4]
                ]
            },
            "category_id":1512,
            "template_id":1289,
            "commodity_id":1,
            "prop_name_str":"100148233$剂 型,100148233$剂 型",
            "prop_features":"“”"
        }
    }
}

异常示例

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	参数无效。	cid或uid不能为空
isp.service-unavailable	系统发生异常	请过一会后，重新尝试
isv.invalid-parameter:cid	类目不存在	确定类目ID是否确定。

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

商品API