淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	描述
out_pub_id	String	必须	1123	64位字符串,uuid，唯一值
type	String	必须	detail	记录类型，detail 详情；poster 海报
template_title	String	必须	测试模板	模板名称
template_id	String	必须	123	模板ID，64字符以内
template_cover_url	String	必须	https://gw.alicdn.com/xx.png	模板封面地址，要求为alicdn下的域名
template_cover_size	String	必须	32:64	模板封面图片尺寸，格式为宽:高，英文:分隔
create_time	Date	必须	2024-08-30 12:00:00	详情发布或海报投放任务创建时间，格式yyyy-MM-dd HH:mm:ss
poster	ItemPubPosterDTO	可选		海报投放信息
└ pub_time_start Date 必须 2024-08-30 12:00:00 投放开始时间 └ pub_time_end Date 必须 2024-08-31 12:00:00 投放结束时间 └ success_item_num Number 必须 100 投放成功商品总数 └ failed_item_num Number 必须 100 投放失败商品总数 └ status String 必须 WAITING 状态；待投放：WAITING ，生效中： RUNNING ，已结束：FINISHED └ items String 必须 1,2,3 商品id列表,英文逗号分隔
detail	ItemPubDetailDTO	可选		详情发布信息
└ item_id Number 必须 123 商品id └ item_url String 必须 http:www.taobao.com 商品在淘宝或天猫的地址 pictures ItemPubDetailDTO [] 必须 [] 详情图片列表 └ url String 必须 https://gw.alicdn.com/xx.png 图片地址，alicdn域名下 └ size String 必须 32:64 图片尺寸，格式为宽:高，英文:分隔

名称	类型	示例值	描述
sync_ret	OutPubRet		回流结果信息
└ out_pub_id String 123 外部发布或投放id └ success Boolean true 回传结果 └ ret String sync_update 操作类型：sync 首次同步；sync_update 更新

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
ItemTemplateRecordSyncRequest req = new ItemTemplateRecordSyncRequest();
req.setOutPubId("1123");
req.setType("detail");
req.setTemplateTitle("测试模板");
req.setTemplateId("123");
req.setTemplateCoverUrl("https://gw.alicdn.com/xx.png");
req.setTemplateCoverSize("32:64");
req.setCreateTime(StringUtils.parseDateTime("2024-08-30 12:00:00"));
ItemTemplateRecordSyncRequest.ItemPubPosterDTO obj1 = new ItemTemplateRecordSyncRequest.ItemPubPosterDTO();
obj1.setPubTimeStart(StringUtils.parseDateTime("2024-08-30 12:00:00"));
obj1.setPubTimeEnd(StringUtils.parseDateTime("2024-08-31 12:00:00"));
obj1.setSuccessItemNum(100L);
obj1.setFailedItemNum(100L);
obj1.setStatus("WAITING");
obj1.setItems("1,2,3");
req.setPoster(obj1);
ItemTemplateRecordSyncRequest.ItemPubDetailDTO obj2 = new ItemTemplateRecordSyncRequest.ItemPubDetailDTO();
obj2.setItemId(123L);
obj2.setItemUrl("http:www.taobao.com");
List<ItemTemplateRecordSyncRequest.ItemPubDetailDTO> list4 = new ArrayList<ItemTemplateRecordSyncRequest.ItemPubDetailDTO>();
ItemTemplateRecordSyncRequest.ItemPubDetailDTO obj5 = new ItemTemplateRecordSyncRequest.ItemPubDetailDTO();
list4.add(obj5);
obj5.setUrl("https://gw.alicdn.com/xx.png");
obj5.setSize("32:64");
obj2.setPictures(list4);
req.setDetail(obj2);
ItemTemplateRecordSyncResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
ItemTemplateRecordSyncRequest req = new ItemTemplateRecordSyncRequest();
req.OutPubId = "1123";
req.Type = "detail";
req.TemplateTitle = "测试模板";
req.TemplateId = "123";
req.TemplateCoverUrl = "https://gw.alicdn.com/xx.png";
req.TemplateCoverSize = "32:64";
req.CreateTime = DateTime.Parse("2024-08-30 12:00:00");
ItemTemplateRecordSyncRequest.ItemPubPosterDTODomain obj1 = new ItemTemplateRecordSyncRequest.ItemPubPosterDTODomain();
obj1.PubTimeStart = DateTime.Parse(2024-08-30 12:00:00");
obj1.PubTimeEnd = DateTime.Parse(2024-08-31 12:00:00");
obj1.SuccessItemNum = 100L;
obj1.FailedItemNum = 100L;
obj1.Status = "WAITING";
obj1.Items = "1,2,3";
req.Poster_ = obj1;
ItemTemplateRecordSyncRequest.ItemPubDetailDTODomain obj2 = new ItemTemplateRecordSyncRequest.ItemPubDetailDTODomain();
obj2.ItemId = 123L;
obj2.ItemUrl = "http:www.taobao.com";
List<ItemTemplateRecordSyncRequest.ItemPubDetailDTODomain> list4 = new List<ItemTemplateRecordSyncRequest.ItemPubDetailDTODomain>();
ItemTemplateRecordSyncRequest.ItemPubDetailDTODomain obj5 = new ItemTemplateRecordSyncRequest.ItemPubDetailDTODomain();
list4.Add(obj5);
obj5.Url = "https://gw.alicdn.com/xx.png";
obj5.Size = "32:64";
obj2.Pictures= list4;
req.Detail_ = obj2;
ItemTemplateRecordSyncResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new ItemTemplateRecordSyncRequest;
$req->setOutPubId("1123");
$req->setType("detail");
$req->setTemplateTitle("测试模板");
$req->setTemplateId("123");
$req->setTemplateCoverUrl("https://gw.alicdn.com/xx.png");
$req->setTemplateCoverSize("32:64");
$req->setCreateTime("2024-08-30 12:00:00");
$poster = new ItemPubPosterDTO;
$poster->pub_time_start="2024-08-30 12:00:00";
$poster->pub_time_end="2024-08-31 12:00:00";
$poster->success_item_num="100";
$poster->failed_item_num="100";
$poster->status="WAITING";
$poster->items="1,2,3";
$req->setPoster(json_encode($poster));
$detail = new ItemPubDetailDTO;
$detail->item_id="123";
$detail->item_url="http:www.taobao.com";
$pictures = new ItemPubDetailDTO;
$pictures->url="https://gw.alicdn.com/xx.png";
$pictures->size="32:64";
$detail->pictures = $pictures;
$req->setDetail(json_encode($detail));
$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=taobao.item.template.record.sync' \
-d 'partner_id=apidoc' \
-d 'session=3d448d02-4b4e-431a-8ab7-7039a2451b66' \
-d 'sign=493D2CB9E61F26CA588C928BC358B8B6' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-06-05+18%3A31%3A01' \
-d 'v=2.0' \
-d 'create_time=2024-08-30+12%3A00%3A00' \
-d 'detail=null' \
-d 'out_pub_id=1123' \
-d 'poster=null' \
-d 'template_cover_size=32%3A64' \
-d 'template_cover_url=https%3A%2F%2Fgw.alicdn.com%2Fxx.png' \
-d 'template_id=123' \
-d 'template_title=%E6%B5%8B%E8%AF%95%E6%A8%A1%E6%9D%BF' \
-d 'type=detail'

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

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

req.out_pub_id="1123"
req.type="detail"
req.template_title="测试模板"
req.template_id="123"
req.template_cover_url="https://gw.alicdn.com/xx.png"
req.template_cover_size="32:64"
req.create_time="2024-08-30 12:00:00"
req.poster="数据结构示例JSON格式"
req.detail="数据结构示例JSON格式"
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,"taobao.item.template.record.sync");
add_param(pRequest,"out_pub_id","1123");
add_param(pRequest,"type","detail");
add_param(pRequest,"template_title","测试模板");
add_param(pRequest,"template_id","123");
add_param(pRequest,"template_cover_url","https://gw.alicdn.com/xx.png");
add_param(pRequest,"template_cover_size","32:64");
add_param(pRequest,"create_time","2024-08-30 12:00:00");
add_param(pRequest,"poster","数据结构JSON示例");
add_param(pRequest,"detail","数据结构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('taobao.item.template.record.sync', {
	'out_pub_id':'1123',
	'type':'detail',
	'template_title':'测试模板',
	'template_id':'123',
	'template_cover_url':'https://gw.alicdn.com/xx.png',
	'template_cover_size':'32:64',
	'create_time':'2024-08-30 12:00:00',
	'poster':'数据结构JSON示例',
	'detail':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<item_template_record_sync_response>
    <sync_ret>
        <out_pub_id>123</out_pub_id>
        <success>true</success>
        <ret>sync_update</ret>
    </sync_ret>
</item_template_record_sync_response>

{
    "item_template_record_sync_response":{
        "sync_ret":{
            "out_pub_id":"123",
            "success":true,
            "ret":"sync_update"
        }
    }
}

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.template.record.sync (回流商品详情和海报的发布记录)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ