淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
param0	BuyGiftActivityQueryRequest	必须			买赠活动查询入参
└ act_id Number 可选 23678171 活动ID └ out_act_id String 可选 O1234 erp外部活动id

名称	类型	示例值	描述
data	BuyGiftPromotionActivityDTO	0	买赠活动查询结果
└ discount_type Number 3 买赠活动类型 └ out_act_id String O1234 外部订单号 └ act_id String 22118091 营销活动ID └ activity_name String 促销-买赠活动名称 └ description String 大促活动描述 └ start_time Number 1636905600000 活动开始时间 └ end_time Number 1637078399000 活动结束时间 └ weekdays String [] [1,2,3,4] 活动周几生效 └ every_day_periods String [] ["03:00:00_05:00:00"] 活动每天生效时间段 └ terminals String [] [1,2] 优惠适用场景:1:APP 2:POS └ creator_id String 123456 操作人ID └ creator_name String 叶志毅操作人姓名 └ store_ids String [] ["CSSTORE0101","CSSTORE0102"] 门店列表 └ outer_store_ids String [] ["OUTSTORE0101","OUTSTORE0102"] 外部门店列表 └ member_crowd_codes String [] ["NEW_USER","OLD_USER"] 人群编码,saas平台人群编码:NEW_USER: 新用户, OLD_USER：老用户，LIGHT_NEW_USER：闪购新客 limit LimitDTO 限购信息 └ total_limit_cnt Number 100 活动总限购 └ daily_total_limit_cnt Number 100 每日总限购 └ user_total_limit_cnt Number 100 用户总限购 └ user_daily_limit_cnt Number 100 用户每日限购 └ order_limit_cnt Number 100 每单限购
succeed	Boolean	true	成功标识
err_message	String	查询失败	错误信息
err_number	String	500	错误码

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaRetailMarketingBuygiftActivityQueryRequest req = new AlibabaRetailMarketingBuygiftActivityQueryRequest();
AlibabaRetailMarketingBuygiftActivityQueryRequest.BuyGiftActivityQueryRequest obj1 = new AlibabaRetailMarketingBuygiftActivityQueryRequest.BuyGiftActivityQueryRequest();
obj1.setActId(23678171L);
obj1.setOutActId("O1234");
req.setParam0(obj1);
AlibabaRetailMarketingBuygiftActivityQueryResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaRetailMarketingBuygiftActivityQueryRequest req = new AlibabaRetailMarketingBuygiftActivityQueryRequest();
AlibabaRetailMarketingBuygiftActivityQueryRequest.BuyGiftActivityQueryRequestDomain obj1 = new AlibabaRetailMarketingBuygiftActivityQueryRequest.BuyGiftActivityQueryRequestDomain();
obj1.ActId = 23678171L;
obj1.OutActId = "O1234";
req.Param0_ = obj1;
AlibabaRetailMarketingBuygiftActivityQueryResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaRetailMarketingBuygiftActivityQueryRequest;
$param0 = new BuyGiftActivityQueryRequest;
$param0->act_id="23678171";
$param0->out_act_id="O1234";
$req->setParam0(json_encode($param0));
$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.query' \
-d 'partner_id=apidoc' \
-d 'session=b9ac5250-a1b8-4e02-a115-4ceaa74c38e6' \
-d 'sign=9DBE55EE16DE89F73E7BFA2C235A7724' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-21+16%3A14%3A16' \
-d 'v=2.0' \
-d 'param0=0'

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

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

req.param0="0"
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.query");
add_param(pRequest,"param0","数据结构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.query', {
	'param0':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_retail_marketing_buygift_activity_query_response>
    <data>
        <discount_type>3</discount_type>
        <out_act_id>O1234</out_act_id>
        <act_id>22118091</act_id>
        <activity_name>促销-买赠</activity_name>
        <description>大促</description>
        <start_time>1636905600000</start_time>
        <end_time>1637078399000</end_time>
        <weekdays>
            <string>[1</string>
            <string>2</string>
            <string>3</string>
            <string>4]</string>
        </weekdays>
        <every_day_periods>
            <string>[&quot;03:00:00_05:00:00&quot;]</string>
        </every_day_periods>
        <terminals>
            <string>[1</string>
            <string>2]</string>
        </terminals>
        <creator_id>123456</creator_id>
        <creator_name>叶志毅</creator_name>
        <store_ids>
            <string>[&quot;CSSTORE0101&quot;</string>
            <string>&quot;CSSTORE0102&quot;]</string>
        </store_ids>
        <outer_store_ids>
            <string>[&quot;OUTSTORE0101&quot;</string>
            <string>&quot;OUTSTORE0102&quot;]</string>
        </outer_store_ids>
        <member_crowd_codes>
            <string>[&quot;NEW_USER&quot;</string>
            <string>&quot;OLD_USER&quot;]</string>
        </member_crowd_codes>
        <limit>
            <total_limit_cnt>100</total_limit_cnt>
            <daily_total_limit_cnt>100</daily_total_limit_cnt>
            <user_total_limit_cnt>100</user_total_limit_cnt>
            <user_daily_limit_cnt>100</user_daily_limit_cnt>
            <order_limit_cnt>100</order_limit_cnt>
        </limit>
    </data>
    <succeed>true</succeed>
    <err_message>查询失败</err_message>
    <err_number>500</err_number>
</alibaba_retail_marketing_buygift_activity_query_response>

{
    "alibaba_retail_marketing_buygift_activity_query_response":{
        "data":{
            "discount_type":3,
            "out_act_id":"O1234",
            "act_id":"22118091",
            "activity_name":"促销-买赠",
            "description":"大促",
            "start_time":1636905600000,
            "end_time":1637078399000,
            "weekdays":{
                "string":[
                    "[1",
                    "2",
                    "3",
                    "4]"
                ]
            },
            "every_day_periods":{
                "string":[
                    "[\"03:00:00_05:00:00\"]"
                ]
            },
            "terminals":{
                "string":[
                    "[1",
                    "2]"
                ]
            },
            "creator_id":"123456",
            "creator_name":"叶志毅",
            "store_ids":{
                "string":[
                    "[\"CSSTORE0101\"",
                    "\"CSSTORE0102\"]"
                ]
            },
            "outer_store_ids":{
                "string":[
                    "[\"OUTSTORE0101\"",
                    "\"OUTSTORE0102\"]"
                ]
            },
            "member_crowd_codes":{
                "string":[
                    "[\"NEW_USER\"",
                    "\"OLD_USER\"]"
                ]
            },
            "limit":{
                "total_limit_cnt":100,
                "daily_total_limit_cnt":100,
                "user_total_limit_cnt":100,
                "user_daily_limit_cnt":100,
                "order_limit_cnt":100
            }
        },
        "succeed":true,
        "err_message":"查询失败",
        "err_number":"500"
    }
}

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.query (查询单品买赠活动【同城零售】)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ