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

请求地址：

环境	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	BuyGiftActivitySkuOperateRequest	必须			添加活动商品参数
sku_elements SkuActivityElementDto [] 必须商品元素信息 └ sku_code String 可选 012387 商品编码，与商品条码必选其一，或者同时传入以商品条码为准 limit LimitDto 可选限购配置信息 └ total_limit_cnt Number 可选 4 赠品总限量/店 └ daily_total_limit_cnt Number 可选 3 赠品每日总限量/店 └ user_total_limit_cnt Number 可选 2 赠品每人限量/店 └ user_daily_limit_cnt Number 可选 1 赠品每人每日限量/店 └ gift_sku_code String 可选 4123 赠品编码，不填默认赠品为商品本身，赠品条码，不填默认赠品为商品本身，若主品传入的是编码，则赠品需传入编码或者不传 └ gift_num Number 可选 1 买N赠M的M参数，赠多少件赠品（目前仅支持买N赠1，giftNum默认为1） └ buy_num Number 必须 1 买N赠M的N参数，买多少件可赠 └ barcode String 可选 690000001 商品条码，与商品编码必选其一，或者同时传入以商品条码为准 └ gift_barcode String 可选 690000002 赠品条码，不填默认赠品为商品本身，若主品传入的是条码，则赠品需传入条码或者不传 sku_channel_configs SkuChannelConfigDTO [] 可选商品渠道配置信息 └ channel String 可选 "2" 渠道编码枚举： 2 美团 3 饿了么 26 京东到家 31 翱象淘鲜达 └ store_ids String [] 可选渠道对应的门店id列表["store001","store002"] └ act_id Number 可选 123 操作活动的ID └ creator_id String 必须 312312 操作人ID（数字类型） └ creator_name String 必须 testName 操作人Name └ out_act_id String 可选 O1234 外部erp活动id

名称	类型	示例值	描述
result	OctopusOpenResult	result	操作结果
└ data String 空串部分商品添加失败时会有错误信息，正常情况下无数据 └ success Boolean true 是否成功 └ error_message String 参数错误错误描述 └ error_code String PARAM_ERROR 错误编码 └ failed_sku_codes String [] 1234 部分失败的商品编码列表

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaRetailMarketingBuygiftActivitySkuAddRequest req = new AlibabaRetailMarketingBuygiftActivitySkuAddRequest();
AlibabaRetailMarketingBuygiftActivitySkuAddRequest.BuyGiftActivitySkuOperateRequest obj1 = new AlibabaRetailMarketingBuygiftActivitySkuAddRequest.BuyGiftActivitySkuOperateRequest();
List<AlibabaRetailMarketingBuygiftActivitySkuAddRequest.SkuActivityElementDto> list3 = new ArrayList<AlibabaRetailMarketingBuygiftActivitySkuAddRequest.SkuActivityElementDto>();
AlibabaRetailMarketingBuygiftActivitySkuAddRequest.SkuActivityElementDto obj4 = new AlibabaRetailMarketingBuygiftActivitySkuAddRequest.SkuActivityElementDto();
list3.add(obj4);
obj4.setSkuCode("012387");
AlibabaRetailMarketingBuygiftActivitySkuAddRequest.LimitDto obj6 = new AlibabaRetailMarketingBuygiftActivitySkuAddRequest.LimitDto();
obj6.setTotalLimitCnt(4L);
obj6.setDailyTotalLimitCnt(3L);
obj6.setUserTotalLimitCnt(2L);
obj6.setUserDailyLimitCnt(1L);
list5.setLimit(obj6);
obj4.setGiftSkuCode("4123");
obj4.setGiftNum(1L);
obj4.setBuyNum(1L);
obj4.setBarcode("690000001");
obj4.setGiftBarcode("690000002");
List<AlibabaRetailMarketingBuygiftActivitySkuAddRequest.SkuChannelConfigDTO> list9 = new ArrayList<AlibabaRetailMarketingBuygiftActivitySkuAddRequest.SkuChannelConfigDTO>();
AlibabaRetailMarketingBuygiftActivitySkuAddRequest.SkuChannelConfigDTO obj10 = new AlibabaRetailMarketingBuygiftActivitySkuAddRequest.SkuChannelConfigDTO();
list9.add(obj10);
obj10.setChannel("\"2\"");
obj10.setStoreIds("");
list7.setSkuChannelConfigs(list9);
obj1.setSkuElements(list3);
obj1.setActId(123L);
obj1.setCreatorId("312312");
obj1.setCreatorName("testName");
obj1.setOutActId("O1234");
req.setParam(obj1);
AlibabaRetailMarketingBuygiftActivitySkuAddResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaRetailMarketingBuygiftActivitySkuAddRequest req = new AlibabaRetailMarketingBuygiftActivitySkuAddRequest();
AlibabaRetailMarketingBuygiftActivitySkuAddRequest.BuyGiftActivitySkuOperateRequestDomain obj1 = new AlibabaRetailMarketingBuygiftActivitySkuAddRequest.BuyGiftActivitySkuOperateRequestDomain();
List<AlibabaRetailMarketingBuygiftActivitySkuAddRequest.SkuActivityElementDtoDomain> list3 = new List<AlibabaRetailMarketingBuygiftActivitySkuAddRequest.SkuActivityElementDtoDomain>();
AlibabaRetailMarketingBuygiftActivitySkuAddRequest.SkuActivityElementDtoDomain obj4 = new AlibabaRetailMarketingBuygiftActivitySkuAddRequest.SkuActivityElementDtoDomain();
list3.Add(obj4);
obj4.SkuCode = "012387";
AlibabaRetailMarketingBuygiftActivitySkuAddRequest.LimitDtoDomain obj5 = new AlibabaRetailMarketingBuygiftActivitySkuAddRequest.LimitDtoDomain();
obj5.TotalLimitCnt = 4L;
obj5.DailyTotalLimitCnt = 3L;
obj5.UserTotalLimitCnt = 2L;
obj5.UserDailyLimitCnt = 1L;
obj4.Limit= obj5;
obj4.GiftSkuCode = "4123";
obj4.GiftNum = 1L;
obj4.BuyNum = 1L;
obj4.Barcode = "690000001";
obj4.GiftBarcode = "690000002";
List<AlibabaRetailMarketingBuygiftActivitySkuAddRequest.SkuChannelConfigDTODomain> list7 = new List<AlibabaRetailMarketingBuygiftActivitySkuAddRequest.SkuChannelConfigDTODomain>();
AlibabaRetailMarketingBuygiftActivitySkuAddRequest.SkuChannelConfigDTODomain obj8 = new AlibabaRetailMarketingBuygiftActivitySkuAddRequest.SkuChannelConfigDTODomain();
list7.Add(obj8);
obj8.Channel = "\"2\"";
obj8.StoreIds = "";
obj4.SkuChannelConfigs= list7;
obj1.SkuElements= list3;
obj1.ActId = 123L;
obj1.CreatorId = "312312";
obj1.CreatorName = "testName";
obj1.OutActId = "O1234";
req.Param_ = obj1;
AlibabaRetailMarketingBuygiftActivitySkuAddResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaRetailMarketingBuygiftActivitySkuAddRequest;
$param = new BuyGiftActivitySkuOperateRequest;
$sku_elements = new SkuActivityElementDto;
$sku_elements->sku_code="012387";
$limit = new LimitDto;
$limit->total_limit_cnt="4";
$limit->daily_total_limit_cnt="3";
$limit->user_total_limit_cnt="2";
$limit->user_daily_limit_cnt="1";
$sku_elements->limit = $limit;
$sku_elements->gift_sku_code="4123";
$sku_elements->gift_num="1";
$sku_elements->buy_num="1";
$sku_elements->barcode="690000001";
$sku_elements->gift_barcode="690000002";
$sku_channel_configs = new SkuChannelConfigDTO;
$sku_channel_configs->channel="\"2\"";
$sku_channel_configs->store_ids="";
$sku_elements->sku_channel_configs = $sku_channel_configs;
$param->sku_elements = $sku_elements;
$param->act_id="123";
$param->creator_id="312312";
$param->creator_name="testName";
$param->out_act_id="O1234";
$req->setParam(json_encode($param));
$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=alibaba.retail.marketing.buygift.activity.sku.add' \
-d 'partner_id=apidoc' \
-d 'session=d11f8a81-9636-43c1-b894-0ca35f39a079' \
-d 'sign=2C05A2D87585452404AEE12B00151575' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-02+20%3A52%3A23' \
-d 'v=2.0' \
-d 'param=null'

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

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

req.param=""
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,"alibaba.retail.marketing.buygift.activity.sku.add");
add_param(pRequest,"param","数据结构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('alibaba.retail.marketing.buygift.activity.sku.add', {
	'param':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_retail_marketing_buygift_activity_sku_add_response>
    <result>
        <data>空串</data>
        <success>true</success>
        <error_message>参数错误</error_message>
        <error_code>PARAM_ERROR</error_code>
        <failed_sku_codes>
            <string>1234</string>
        </failed_sku_codes>
    </result>
</alibaba_retail_marketing_buygift_activity_sku_add_response>

{
    "alibaba_retail_marketing_buygift_activity_sku_add_response":{
        "result":{
            "data":"空串",
            "success":true,
            "error_message":"参数错误",
            "error_code":"PARAM_ERROR",
            "failed_sku_codes":{
                "string":[
                    "1234"
                ]
            }
        }
    }
}

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

alibaba.retail.marketing.buygift.activity.sku.add (添加单品买赠活动商品)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈