淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	描述
activity_id	String	可选	10113072800055076	活动id，如修改活动填写
schema_with_value	String	必须	{"activityCardConfig":{"backGroundPic":"//img.alicdn.com/bao/uploaded/i1/2206579686938/O1CN01nZzZdj217ecqLWNhx_!!2206579686938.jpg_480x480.jpg","preHeatBackGroundPic":"//img.alicdn.com/bao/uploaded/i1/2206579686938/O1CN01nZzZdj217ecqLWNhx_!!2206579686938.jpg_480x480.jpg","sellerText":"静节测试SellerText","titleTemplateCode":"1"},"activityName":"静节测试082302","addItemList":[{"discountDisplay":"200","isDiscardFen":false,"isMathFloor":false,"itemId":"581088476692","limitCheck":-1}],"updateItemList":[],"removeItemList":[],"crowdId":"306400010000","discountType":"2","endTime":"1700236840000","operatorId":"263694008","promotionLevel":"1","sellerId":"263694008","source":"TOP","startTime":"1700236740000"}	有值活动schema
activity_source	String	必须	SINGLE_TREASURE	活动类型

名称	类型	示例值	描述
tao_activity_edit_resp	TaoActivityEditResp		响应结果
└ activity_id String 10113072800055076 活动id

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
ActivitySchemaEditRequest req = new ActivitySchemaEditRequest();
req.setActivityId("10113072800055076");
req.setSchemaWithValue("{\"activityCardConfig\":{\"backGroundPic\":\"//img.alicdn.com/bao/uploaded/i1/2206579686938/O1CN01nZzZdj217ecqLWNhx_!!2206579686938.jpg_480x480.jpg\",\"preHeatBackGroundPic\":\"//img.alicdn.com/bao/uploaded/i1/2206579686938/O1CN01nZzZdj217ecqLWNhx_!!2206579686938.jpg_480x480.jpg\",\"sellerText\":\"静节测试SellerText\",\"titleTemplateCode\":\"1\"},\"activityName\":\"静节测试082302\",\"addItemList\":[{\"discountDisplay\":\"200\",\"isDiscardFen\":false,\"isMathFloor\":false,\"itemId\":\"581088476692\",\"limitCheck\":-1}],\"updateItemList\":[],\"removeItemList\":[],\"crowdId\":\"306400010000\",\"discountType\":\"2\",\"endTime\":\"1700236840000\",\"operatorId\":\"263694008\",\"promotionLevel\":\"1\",\"sellerId\":\"263694008\",\"source\":\"TOP\",\"startTime\":\"1700236740000\"}");
req.setActivitySource("SINGLE_TREASURE");
ActivitySchemaEditResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
ActivitySchemaEditRequest req = new ActivitySchemaEditRequest();
req.ActivityId = "10113072800055076";
req.SchemaWithValue = "{\"activityCardConfig\":{\"backGroundPic\":\"//img.alicdn.com/bao/uploaded/i1/2206579686938/O1CN01nZzZdj217ecqLWNhx_!!2206579686938.jpg_480x480.jpg\",\"preHeatBackGroundPic\":\"//img.alicdn.com/bao/uploaded/i1/2206579686938/O1CN01nZzZdj217ecqLWNhx_!!2206579686938.jpg_480x480.jpg\",\"sellerText\":\"静节测试SellerText\",\"titleTemplateCode\":\"1\"},\"activityName\":\"静节测试082302\",\"addItemList\":[{\"discountDisplay\":\"200\",\"isDiscardFen\":false,\"isMathFloor\":false,\"itemId\":\"581088476692\",\"limitCheck\":-1}],\"updateItemList\":[],\"removeItemList\":[],\"crowdId\":\"306400010000\",\"discountType\":\"2\",\"endTime\":\"1700236840000\",\"operatorId\":\"263694008\",\"promotionLevel\":\"1\",\"sellerId\":\"263694008\",\"source\":\"TOP\",\"startTime\":\"1700236740000\"}";
req.ActivitySource = "SINGLE_TREASURE";
ActivitySchemaEditResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new ActivitySchemaEditRequest;
$req->setActivityId("10113072800055076");
$req->setSchemaWithValue("{\"activityCardConfig\":{\"backGroundPic\":\"//img.alicdn.com/bao/uploaded/i1/2206579686938/O1CN01nZzZdj217ecqLWNhx_!!2206579686938.jpg_480x480.jpg\",\"preHeatBackGroundPic\":\"//img.alicdn.com/bao/uploaded/i1/2206579686938/O1CN01nZzZdj217ecqLWNhx_!!2206579686938.jpg_480x480.jpg\",\"sellerText\":\"静节测试SellerText\",\"titleTemplateCode\":\"1\"},\"activityName\":\"静节测试082302\",\"addItemList\":[{\"discountDisplay\":\"200\",\"isDiscardFen\":false,\"isMathFloor\":false,\"itemId\":\"581088476692\",\"limitCheck\":-1}],\"updateItemList\":[],\"removeItemList\":[],\"crowdId\":\"306400010000\",\"discountType\":\"2\",\"endTime\":\"1700236840000\",\"operatorId\":\"263694008\",\"promotionLevel\":\"1\",\"sellerId\":\"263694008\",\"source\":\"TOP\",\"startTime\":\"1700236740000\"}");
$req->setActivitySource("SINGLE_TREASURE");
$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.activity.schema.edit' \
-d 'partner_id=apidoc' \
-d 'session=4e74a576-21dc-4fb4-bc21-8269428f8133' \
-d 'sign=61DFDC682A990FA7743E0B7DE3C537F2' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-14+16%3A23%3A10' \
-d 'v=2.0' \
-d 'activity_id=10113072800055076' \
-d 'activity_source=SINGLE_TREASURE' \
-d 'schema_with_value=%7B%5C%22activityCardConfig%5C%22%3A%7B%5C%22backGroundPic%5C%22%3A%5C%22%2F%2Fimg.alicdn.com%2Fbao%2Fuploaded%2Fi1%2F2206579686938%2FO1CN01nZzZdj217ecqLWNhx_%21%212206579686938.jpg_480x480.jpg%5C%22%2C%5C%22preHeatBackGroundPic%5C%22%3A%5C%22%2F%2Fimg.alicdn.com%2Fbao%2Fuploaded%2Fi1%2F2206579686938%2FO1CN01nZzZdj217ecqLWNhx_%21%212206579686938.jpg_480x480.jpg%5C%22%2C%5C%22sellerText%5C%22%3A%5C%22%E9%9D%99%E8%8A%82%E6%B5%8B%E8%AF%95SellerText%5C%22%2C%5C%22titleTemplateCode%5C%22%3A%5C%221%5C%22%7D%2C%5C%22activityName%5C%22%3A%5C%22%E9%9D%99%E8%8A%82%E6%B5%8B%E8%AF%95082302%5C%22%2C%5C%22addItemList%5C%22%3A%5B%7B%5C%22discountDisplay%5C%22%3A%5C%22200%5C%22%2C%5C%22isDiscardFen%5C%22%3Afalse%2C%5C%22isMathFloor%5C%22%3Afalse%2C%5C%22itemId%5C%22%3A%5C%22581088476692%5C%22%2C%5C%22limitCheck%5C%22%3A-1%7D%5D%2C%5C%22updateItemList%5C%22%3A%5B%5D%2C%5C%22removeItemList%5C%22%3A%5B%5D%2C%5C%22crowdId%5C%22%3A%5C%22306400010000%5C%22%2C%5C%22discountType%5C%22%3A%5C%222%5C%22%2C%5C%22endTime%5C%22%3A%5C%221700236840000%5C%22%2C%5C%22operatorId%5C%22%3A%5C%22263694008%5C%22%2C%5C%22promotionLevel%5C%22%3A%5C%221%5C%22%2C%5C%22sellerId%5C%22%3A%5C%22263694008%5C%22%2C%5C%22source%5C%22%3A%5C%22TOP%5C%22%2C%5C%22startTime%5C%22%3A%5C%221700236740000%5C%22%7D'

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

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

req.activity_id="10113072800055076"
req.schema_with_value="{\"activityCardConfig\":{\"backGroundPic\":\"//img.alicdn.com/bao/uploaded/i1/2206579686938/O1CN01nZzZdj217ecqLWNhx_!!2206579686938.jpg_480x480.jpg\",\"preHeatBackGroundPic\":\"//img.alicdn.com/bao/uploaded/i1/2206579686938/O1CN01nZzZdj217ecqLWNhx_!!2206579686938.jpg_480x480.jpg\",\"sellerText\":\"静节测试SellerText\",\"titleTemplateCode\":\"1\"},\"activityName\":\"静节测试082302\",\"addItemList\":[{\"discountDisplay\":\"200\",\"isDiscardFen\":false,\"isMathFloor\":false,\"itemId\":\"581088476692\",\"limitCheck\":-1}],\"updateItemList\":[],\"removeItemList\":[],\"crowdId\":\"306400010000\",\"discountType\":\"2\",\"endTime\":\"1700236840000\",\"operatorId\":\"263694008\",\"promotionLevel\":\"1\",\"sellerId\":\"263694008\",\"source\":\"TOP\",\"startTime\":\"1700236740000\"}"
req.activity_source="SINGLE_TREASURE"
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.activity.schema.edit");
add_param(pRequest,"activity_id","10113072800055076");
add_param(pRequest,"schema_with_value","{\"activityCardConfig\":{\"backGroundPic\":\"//img.alicdn.com/bao/uploaded/i1/2206579686938/O1CN01nZzZdj217ecqLWNhx_!!2206579686938.jpg_480x480.jpg\",\"preHeatBackGroundPic\":\"//img.alicdn.com/bao/uploaded/i1/2206579686938/O1CN01nZzZdj217ecqLWNhx_!!2206579686938.jpg_480x480.jpg\",\"sellerText\":\"静节测试SellerText\",\"titleTemplateCode\":\"1\"},\"activityName\":\"静节测试082302\",\"addItemList\":[{\"discountDisplay\":\"200\",\"isDiscardFen\":false,\"isMathFloor\":false,\"itemId\":\"581088476692\",\"limitCheck\":-1}],\"updateItemList\":[],\"removeItemList\":[],\"crowdId\":\"306400010000\",\"discountType\":\"2\",\"endTime\":\"1700236840000\",\"operatorId\":\"263694008\",\"promotionLevel\":\"1\",\"sellerId\":\"263694008\",\"source\":\"TOP\",\"startTime\":\"1700236740000\"}");
add_param(pRequest,"activity_source","SINGLE_TREASURE");
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.activity.schema.edit', {
	'activity_id':'10113072800055076',
	'schema_with_value':'{\"activityCardConfig\":{\"backGroundPic\":\"//img.alicdn.com/bao/uploaded/i1/2206579686938/O1CN01nZzZdj217ecqLWNhx_!!2206579686938.jpg_480x480.jpg\",\"preHeatBackGroundPic\":\"//img.alicdn.com/bao/uploaded/i1/2206579686938/O1CN01nZzZdj217ecqLWNhx_!!2206579686938.jpg_480x480.jpg\",\"sellerText\":\"静节测试SellerText\",\"titleTemplateCode\":\"1\"},\"activityName\":\"静节测试082302\",\"addItemList\":[{\"discountDisplay\":\"200\",\"isDiscardFen\":false,\"isMathFloor\":false,\"itemId\":\"581088476692\",\"limitCheck\":-1}],\"updateItemList\":[],\"removeItemList\":[],\"crowdId\":\"306400010000\",\"discountType\":\"2\",\"endTime\":\"1700236840000\",\"operatorId\":\"263694008\",\"promotionLevel\":\"1\",\"sellerId\":\"263694008\",\"source\":\"TOP\",\"startTime\":\"1700236740000\"}',
	'activity_source':'SINGLE_TREASURE'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<activity_schema_edit_response>
    <tao_activity_edit_resp>
        <activity_id>10113072800055076</activity_id>
    </tao_activity_edit_resp>
</activity_schema_edit_response>

{
    "activity_schema_edit_response":{
        "tao_activity_edit_resp":{
            "activity_id":"10113072800055076"
        }
    }
}

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.activity.schema.edit (通过schema编辑小活动)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ