淘宝开放平台

请求地址：

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

名称	类型	是否必须	描述
etc_coupon_activity_query_dto	ETCCouponActivityQueryDTO	必须	入参
└ biz_type String 可选 rent_home 业务类型 └ coupon_category Number 可选 2 /** * 卡券分类（活动类型） * 1：店铺券 * 2：商品券 */ └ coupon_type Number 可选 1 活动类型 └ delivery_scene Number 可选 1 投放场景 └ page_no Number 必须 1 当前分页 └ page_size Number 必须 20 分页大小 └ promotion_scene Number 可选 3 优惠场景（线下码券业务场景） 3：到访礼 4：佣金优惠 └ outer_supplier_id Number 可选 421312 供应者ID └ supplier_type Number 可选 2 供应者类型 └ activity_id_list Number [] 可选 [100105] 活动id列表
etc_coupon_activity_query_option	ETCCouponActivityQueryOption	可选	查询扩展字段
└ is_contain_coupon_issued_and_consumed Boolean 可选 true 是否需要查找券实例已发放数量&已核销数量 └ is_contain_participate_group_info Boolean 可选 false 是否需要查找券模板圈品信息

名称	类型	示例值	描述
result	Result		返回结果
└ msg String 成功返回信息 └ code String success 返回码 data PageCommon 分页信息 └ total Number 100 总数 └ page_no Number 1 当前分页 └ page_size Number 20 分页数量 list ETCCouponActivityDTO [] 卡券活动列表信息 └ discount_rate Number 99 折扣率 └ upper_limit_amount Number 10000 /** * 多次核销扣减上限（封顶金额） / └ promotion_type Number 3 /* * 优惠类型 * 3：折扣率 * 4：满减 / └ biz_type String rent_home 业务类型 ● "new_home": 新房 ● "existing_home":二手房 ● "rent_home": 租房 coupon_template_config_context ETCCouponTemplateConfigContextDTO 扩展信息 └ spread_end_time String 2022-12-07 14:13:57 领取结束时间 └ expire_time String 2022-12-07 14:13:57 有效期至（生效时间） └ time_mode Number 1 有效时间类型（固定有效时间/相对当前时间/相对指定时间） └ spread_start_time String 2022-12-07 14:13:57 领取开始时间 └ rent_promotion_price_type Number 1 /* * 租金优惠金额类型 * 1：租金 * 2：租客服务费（寄租） * 3：服务费（直租） / └ rent_promotion_date_type Number 1 /* * 租金优惠期数类型 * 1：首期 * 2：末期 * 3：每期 / └ effective_end_time String 2022-12-07 14:13:57 活动结束时间 └ inventory Number 1000 库存 use_rule_struct_list UseRuleStruct [] 卡券使用门槛 └ type Number 1 类型 use_rule UseRule 圈选范围 └ min Number 100000 针对区间范围类型，若传金额，单位为分 └ max Number 200000 针对区间范围类型，若传金额，单位为分 └ oper String in 操作符 └ id_list Number [] id列表 └ out_supplier_id Number 421312 供应者ID └ benefit String 利益点利益点 └ promotion_scene Number 3 优惠场景（线下码券业务场景） 3：到访礼 4：佣金优惠 participate_group ParticipateGroup 圈品范围结构 └ common_store_id_list Number [] 通用门店列表 participate_struct_list ParticipateStruct [] 圈品结构列表 participate_id_list ParticipateIdInfo [] 圈品ID列表 └ type Number 3 区分是集中式还是分散式 2:小区 3:公寓 └ community_outer_id String 352331 /* * 外部父节点ID * （例：圈品类型为小区时，填外部小区ID） / └ outer_id String 412312312 /* * 外部子节点ID * （例：圈品类型为小区房源时，填外部小区房源ID，同时填写外部小区ID） / └ store_id Number 214123 门店ID └ type Number 1 圈品类型 └ is_common_with_store Boolean true 是否通用 └ effective_start_time String 2022-12-07 14:13:57 活动开始时间 └ decrease_money Number 1000 减多少钱 (单位分) └ activity_id Number 512412 活动ID └ coupon_category Number 2 /* * 卡券分类（活动类型） * 1：店铺券 * 2：商品券 */ └ coupon_type Number 1 活动类型 └ start_fee Number 2000 startFee （单位分） coupon_template_rule_content ETCCouponTemplateRuleContentDTO 卡券传播规则 └ limit_uid_receive_num Boolean true 是否限制 └ uid_receive_num Number 1 限制数量 └ name String gz测试满减券名称 └ delivery_scene Number 1 投放场景 └ supplier_type Number 2 供应者类型 └ user_receive_num Number 0 用户领取量 └ user_exchange_num Number 0 用户核销数量 └ status Number 20 状态 └ outer_adviser_id String 2022102497 外部经纪人ID └ success Boolean true 返回结果

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaAlihouseMarketingMerchantCouponActivityListRequest req = new AlibabaAlihouseMarketingMerchantCouponActivityListRequest();
AlibabaAlihouseMarketingMerchantCouponActivityListRequest.ETCCouponActivityQueryDTO obj1 = new AlibabaAlihouseMarketingMerchantCouponActivityListRequest.ETCCouponActivityQueryDTO();
obj1.setBizType("rent_home");
obj1.setCouponCategory(2L);
obj1.setCouponType(1L);
obj1.setDeliveryScene(1L);
obj1.setPageNo(1L);
obj1.setPageSize(20L);
obj1.setPromotionScene(3L);
obj1.setOuterSupplierId(421312L);
obj1.setSupplierType(2L);
obj1.setActivityIdList(new Long[] { 100105 };
);
req.setEtcCouponActivityQueryDto(obj1);
AlibabaAlihouseMarketingMerchantCouponActivityListRequest.ETCCouponActivityQueryOption obj2 = new AlibabaAlihouseMarketingMerchantCouponActivityListRequest.ETCCouponActivityQueryOption();
obj2.setIsContainCouponIssuedAndConsumed(true);
obj2.setIsContainParticipateGroupInfo(false);
req.setEtcCouponActivityQueryOption(obj2);
AlibabaAlihouseMarketingMerchantCouponActivityListResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaAlihouseMarketingMerchantCouponActivityListRequest req = new AlibabaAlihouseMarketingMerchantCouponActivityListRequest();
AlibabaAlihouseMarketingMerchantCouponActivityListRequest.ETCCouponActivityQueryDTODomain obj1 = new AlibabaAlihouseMarketingMerchantCouponActivityListRequest.ETCCouponActivityQueryDTODomain();
obj1.BizType = "rent_home";
obj1.CouponCategory = 2L;
obj1.CouponType = 1L;
obj1.DeliveryScene = 1L;
obj1.PageNo = 1L;
obj1.PageSize = 20L;
obj1.PromotionScene = 3L;
obj1.OuterSupplierId = 421312L;
obj1.SupplierType = 2L;
obj1.ActivityIdList = new long[] { 100105 };
;
req.EtcCouponActivityQueryDto_ = obj1;
AlibabaAlihouseMarketingMerchantCouponActivityListRequest.ETCCouponActivityQueryOptionDomain obj2 = new AlibabaAlihouseMarketingMerchantCouponActivityListRequest.ETCCouponActivityQueryOptionDomain();
obj2.IsContainCouponIssuedAndConsumed = true;
obj2.IsContainParticipateGroupInfo = false;
req.EtcCouponActivityQueryOption_ = obj2;
AlibabaAlihouseMarketingMerchantCouponActivityListResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaAlihouseMarketingMerchantCouponActivityListRequest;
$etc_coupon_activity_query_dto = new ETCCouponActivityQueryDTO;
$etc_coupon_activity_query_dto->biz_type="rent_home";
$etc_coupon_activity_query_dto->coupon_category="2";
$etc_coupon_activity_query_dto->coupon_type="1";
$etc_coupon_activity_query_dto->delivery_scene="1";
$etc_coupon_activity_query_dto->page_no="1";
$etc_coupon_activity_query_dto->page_size="20";
$etc_coupon_activity_query_dto->promotion_scene="3";
$etc_coupon_activity_query_dto->outer_supplier_id="421312";
$etc_coupon_activity_query_dto->supplier_type="2";
$etc_coupon_activity_query_dto->activity_id_list="[100105]";
$req->setEtcCouponActivityQueryDto(json_encode($etc_coupon_activity_query_dto));
$etc_coupon_activity_query_option = new ETCCouponActivityQueryOption;
$etc_coupon_activity_query_option->is_contain_coupon_issued_and_consumed="true";
$etc_coupon_activity_query_option->is_contain_participate_group_info="false";
$req->setEtcCouponActivityQueryOption(json_encode($etc_coupon_activity_query_option));
$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.alihouse.marketing.merchant.coupon.activity.list' \
-d 'partner_id=apidoc' \
-d 'session=de852198-88f1-459e-ae45-4556c66bdfae' \
-d 'sign=012D45953F3E28816BB66BDD1FFF3913' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-06-24+05%3A11%3A14' \
-d 'v=2.0' \
-d 'etc_coupon_activity_query_dto=null' \
-d 'etc_coupon_activity_query_option=null'

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

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

req.etc_coupon_activity_query_dto="数据结构示例JSON格式"
req.etc_coupon_activity_query_option="数据结构示例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,"alibaba.alihouse.marketing.merchant.coupon.activity.list");
add_param(pRequest,"etc_coupon_activity_query_dto","数据结构JSON示例");
add_param(pRequest,"etc_coupon_activity_query_option","数据结构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.alihouse.marketing.merchant.coupon.activity.list', {
	'etc_coupon_activity_query_dto':'数据结构JSON示例',
	'etc_coupon_activity_query_option':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_alihouse_marketing_merchant_coupon_activity_list_response>
    <result>
        <msg>成功</msg>
        <code>success</code>
        <data>
            <total>100</total>
            <page_no>1</page_no>
            <page_size>20</page_size>
            <list>
                <e_t_c_coupon_activity_d_t_o>
                    <discount_rate>99</discount_rate>
                    <upper_limit_amount>10000</upper_limit_amount>
                    <promotion_type>3</promotion_type>
                    <biz_type>rent_home</biz_type>
                    <coupon_template_config_context>
                        <spread_end_time>2022-12-07 14:13:57</spread_end_time>
                        <expire_time>2022-12-07 14:13:57</expire_time>
                        <time_mode>1</time_mode>
                        <spread_start_time>2022-12-07 14:13:57</spread_start_time>
                        <rent_promotion_price_type>1</rent_promotion_price_type>
                        <rent_promotion_date_type>1</rent_promotion_date_type>
                    </coupon_template_config_context>
                    <effective_end_time>2022-12-07 14:13:57</effective_end_time>
                    <inventory>1000</inventory>
                    <use_rule_struct_list>
                        <use_rule_struct>
                            <type>1</type>
                            <use_rule>
                                <min>100000</min>
                                <max>200000</max>
                                <oper>in</oper>
                            </use_rule>
                        </use_rule_struct>
                    </use_rule_struct_list>
                    <out_supplier_id>421312</out_supplier_id>
                    <benefit>利益点</benefit>
                    <promotion_scene>3</promotion_scene>
                    <participate_group>
                        <participate_struct_list>
                            <participate_struct>
                                <participate_id_list>
                                    <participate_id_info>
                                        <type>3</type>
                                        <community_outer_id>352331</community_outer_id>
                                        <outer_id>412312312</outer_id>
                                    </participate_id_info>
                                </participate_id_list>
                                <store_id>214123</store_id>
                                <type>1</type>
                            </participate_struct>
                        </participate_struct_list>
                        <is_common_with_store>true</is_common_with_store>
                    </participate_group>
                    <effective_start_time>2022-12-07 14:13:57</effective_start_time>
                    <decrease_money>1000</decrease_money>
                    <activity_id>512412</activity_id>
                    <coupon_category>2</coupon_category>
                    <coupon_type>1</coupon_type>
                    <start_fee>2000</start_fee>
                    <coupon_template_rule_content>
                        <limit_uid_receive_num>true</limit_uid_receive_num>
                        <uid_receive_num>1</uid_receive_num>
                    </coupon_template_rule_content>
                    <name>gz测试满减券</name>
                    <delivery_scene>1</delivery_scene>
                    <supplier_type>2</supplier_type>
                    <user_receive_num>0</user_receive_num>
                    <user_exchange_num>0</user_exchange_num>
                    <status>20</status>
                    <outer_adviser_id>2022102497</outer_adviser_id>
                </e_t_c_coupon_activity_d_t_o>
            </list>
        </data>
        <success>true</success>
    </result>
</alibaba_alihouse_marketing_merchant_coupon_activity_list_response>

{
    "alibaba_alihouse_marketing_merchant_coupon_activity_list_response":{
        "result":{
            "msg":"成功",
            "code":"success",
            "data":{
                "total":100,
                "page_no":1,
                "page_size":20,
                "list":{
                    "e_t_c_coupon_activity_d_t_o":[
                        {
                            "discount_rate":99,
                            "upper_limit_amount":10000,
                            "promotion_type":3,
                            "biz_type":"rent_home",
                            "coupon_template_config_context":{
                                "spread_end_time":"2022-12-07 14:13:57",
                                "expire_time":"2022-12-07 14:13:57",
                                "time_mode":1,
                                "spread_start_time":"2022-12-07 14:13:57",
                                "rent_promotion_price_type":1,
                                "rent_promotion_date_type":1
                            },
                            "effective_end_time":"2022-12-07 14:13:57",
                            "inventory":1000,
                            "use_rule_struct_list":{
                                "use_rule_struct":[
                                    {
                                        "type":1,
                                        "use_rule":{
                                            "min":100000,
                                            "max":200000,
                                            "oper":"in"
                                        }
                                    }
                                ]
                            },
                            "out_supplier_id":421312,
                            "benefit":"利益点",
                            "promotion_scene":3,
                            "participate_group":{,
                                "participate_struct_list":{
                                    "participate_struct":[
                                        {
                                            "participate_id_list":{
                                                "participate_id_info":[
                                                    {
                                                        "type":3,
                                                        "community_outer_id":"352331",
                                                        "outer_id":"412312312"
                                                    }
                                                ]
                                            },
                                            "store_id":214123,
                                            "type":1
                                        }
                                    ]
                                },
                                "is_common_with_store":true
                            },
                            "effective_start_time":"2022-12-07 14:13:57",
                            "decrease_money":1000,
                            "activity_id":512412,
                            "coupon_category":2,
                            "coupon_type":1,
                            "start_fee":2000,
                            "coupon_template_rule_content":{
                                "limit_uid_receive_num":true,
                                "uid_receive_num":1
                            },
                            "name":"gz测试满减券",
                            "delivery_scene":1,
                            "supplier_type":2,
                            "user_receive_num":0,
                            "user_exchange_num":0,
                            "status":20,
                            "outer_adviser_id":"2022102497"
                        }
                    ]
                }
            },
            "success":true
        }
    }
}

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.alihouse.marketing.merchant.coupon.activity.list (商家卡券活动列表查询)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ