淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
query_request	PromotionQueryRequest	必须			查询rquest
└ session_id String 可选 8497813e6deb4bddac841aca76e3bf8a 会话ID（分页场景首次请求结果返回，后续请求必须携带，服务根据session_id相同请求次数自动翻页返回） └ pid String 必须 alsc_xxx_xxx_xxx 渠道PID └ longitude String 必须 113.562976 经度 └ latitude String 必须 22.123043 纬度 └ city_id String 可选 "" 城市编码（只用于经纬度覆盖多个城市时过滤） └ sort_type String 可选 normal 排序类型，默认normal 排序规则包括:{"normal":"佣金倒序","distance":"距离由近到远","commission":"佣金倒序","monthlySale":"月销量","couponAmount":"叠加券金额倒序","activityReward":"奖励金金额倒序","commissionRate":"佣金比例倒序"} └ in_activity Boolean 可选 false 是否参与奖励金活动（默认false不做过滤） └ has_bonus_stock Boolean 可选 false 否当前有c端奖励金活动库存（默认false不做过滤） └ min_commission_rate String 可选 0.01 店铺佣金比例下限，代表筛选店铺全店佣金大于等于0.01的店铺 └ page_size Number 可选 20 每页数量（include_dynamic=true时，范围1~20；include_dynamic=false时，范围1~100） └ sid String 可选 1111 三方扩展id └ biz_type String 可选 activityCps\|ordinaryCps 指定召回供给枚举 └ filter_first_categories String 可选 xxx,xxx 以一级类目进行类目限定，以,或者\|进行类目分隔 └ filter_one_point_five_categories String 可选 3131\|xxx\|xxx 1.5级类目查询，以"\|"分隔 └ media_activity_id String 可选 xxx 媒体出资活动ID └ search_content String 可选肯德基检索内容（支持门店名称） └ include_dynamic Boolean 可选 false 是否返回门店动态信息，默认返回（false-不返回门店动态信息，page_size最大支持100；true-返回门店动态信息，page_size最大支持20）

名称	类型	示例值	描述
data	PageModel	{}	分页数据
└ session_id String 8497813e6deb4bddac841aca76e3bf8a 会话ID（下次请求作为请求参数，用于标记分页会话自动翻页） records StorePromotionDto [] [] 分页记录 └ title String 淘客连锁店铺2(分店名) 门店名称 └ shop_logo String https://xxx 门店logo └ indistinct_monthly_sales String 400+ 模糊销量 └ commission_rate String 0.2 佣金比例 └ biz_type String activityCps 店铺类型（"activityCps":活动cps,"ordinaryCps":基础cps） activity PromotionActivity {} 奖励金活动数据 └ activity_id String 1 活动Id └ service_fee_cent Number 500 营销计划服务费（分） └ bonus_cent Number 500 奖励金红包面额（分） └ daily_quantity Number 100 活动的日库存 └ daily_sellable_quantity Number 80 活动日剩余库存 └ start_time Number 1639122622 起始时间（秒） └ end_time Number 1639986622 结束时间（秒） └ bounty_min_limit_cent Number 5000 奖励金门槛 (分) link PromotionLink {} 推广链接 └ wx_appid String wxxxxxxxx 小程序appId └ wx_path String xxxxx 微信小程序path链接 └ reduce_wx_appid String wxxxxxxxx 小程序appId-立减活动 └ reduce_wx_path String xxxxx 微信小程序path链接-立减活动 └ media_activity_wx_appid String xxxxx 小程序appId-媒体出资活动 └ media_activity_wx_path String xxxxx 微信小程序path链接-媒体出资活动 └ category_1_id String 260 一级类目ID，高级字段 └ delivery_distance Number 105 配送距离（米），高级字段 └ delivery_time Number 34 配送时间（分），高级字段 └ delivery_price String 4.0 起送价（元），高级字段 └ recommend_reasons String [] ["酱油无骨炸鸡性价比很高","韩国炸鸡中的热卖餐厅"] 推荐理由，高级字段 └ service_rating String 4.6 服务评级，高级字段 items PromotionItem [] E16762823491710995463 推荐商品，高级字段 └ title String A黄xxxx 标题 └ origin_price String 原价 └ price String 39.99 现价 └ picture String https://xxxxx 图片 └ shop_id String xxxxxxxxx 店铺ID（静态加密） └ category_1_name String 全球美食一级类目名称，高级字段 └ commission Number 1345 预估佣金（分） └ discount_tags String [] 满减标签，高级字段 └ delivery_fee String 5 配送费（元），高级字段 └ page_size Number 20 每页数目
result_code	Number	0	返回码
message	String	success	返回消息

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaAlscUnionElemePromotionStorepromotionQueryRequest req = new AlibabaAlscUnionElemePromotionStorepromotionQueryRequest();
AlibabaAlscUnionElemePromotionStorepromotionQueryRequest.PromotionQueryRequest obj1 = new AlibabaAlscUnionElemePromotionStorepromotionQueryRequest.PromotionQueryRequest();
obj1.setSessionId("8497813e6deb4bddac841aca76e3bf8a");
obj1.setPid("alsc_xxx_xxx_xxx");
obj1.setLongitude("113.562976");
obj1.setLatitude("22.123043");
obj1.setCityId("\"\"");
obj1.setSortType("normal");
obj1.setInActivity(false);
obj1.setHasBonusStock(false);
obj1.setMinCommissionRate("0.01");
obj1.setPageSize(20L);
obj1.setSid("1111");
obj1.setBizType("activityCps|ordinaryCps");
obj1.setFilterFirstCategories("xxx,xxx");
obj1.setFilterOnePointFiveCategories("3131|xxx|xxx");
obj1.setMediaActivityId("xxx");
obj1.setSearchContent("肯德基");
obj1.setIncludeDynamic(false);
req.setQueryRequest(obj1);
AlibabaAlscUnionElemePromotionStorepromotionQueryResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaAlscUnionElemePromotionStorepromotionQueryRequest req = new AlibabaAlscUnionElemePromotionStorepromotionQueryRequest();
AlibabaAlscUnionElemePromotionStorepromotionQueryRequest.PromotionQueryRequestDomain obj1 = new AlibabaAlscUnionElemePromotionStorepromotionQueryRequest.PromotionQueryRequestDomain();
obj1.SessionId = "8497813e6deb4bddac841aca76e3bf8a";
obj1.Pid = "alsc_xxx_xxx_xxx";
obj1.Longitude = "113.562976";
obj1.Latitude = "22.123043";
obj1.CityId = "\"\"";
obj1.SortType = "normal";
obj1.InActivity = false;
obj1.HasBonusStock = false;
obj1.MinCommissionRate = "0.01";
obj1.PageSize = 20L;
obj1.Sid = "1111";
obj1.BizType = "activityCps|ordinaryCps";
obj1.FilterFirstCategories = "xxx,xxx";
obj1.FilterOnePointFiveCategories = "3131|xxx|xxx";
obj1.MediaActivityId = "xxx";
obj1.SearchContent = "肯德基";
obj1.IncludeDynamic = false;
req.QueryRequest_ = obj1;
AlibabaAlscUnionElemePromotionStorepromotionQueryResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaAlscUnionElemePromotionStorepromotionQueryRequest;
$query_request = new PromotionQueryRequest;
$query_request->session_id="8497813e6deb4bddac841aca76e3bf8a";
$query_request->pid="alsc_xxx_xxx_xxx";
$query_request->longitude="113.562976";
$query_request->latitude="22.123043";
$query_request->city_id="\"\"";
$query_request->sort_type="normal";
$query_request->in_activity="false";
$query_request->has_bonus_stock="false";
$query_request->min_commission_rate="0.01";
$query_request->page_size="20";
$query_request->sid="1111";
$query_request->biz_type="activityCps|ordinaryCps";
$query_request->filter_first_categories="xxx,xxx";
$query_request->filter_one_point_five_categories="3131|xxx|xxx";
$query_request->media_activity_id="xxx";
$query_request->search_content="肯德基";
$query_request->include_dynamic="false";
$req->setQueryRequest(json_encode($query_request));
$resp = $c->execute($req);

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.alsc.union.eleme.promotion.storepromotion.query' \
-d 'partner_id=apidoc' \
-d 'sign=FCAA8BF1088DC6CB9AFCDFCF5B03A468' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-25+17%3A47%3A26' \
-d 'v=2.0' \
-d 'query_request=%7B%7D'

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

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

req.query_request="{}"
try:
	resp= req.getResponse()
	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.alsc.union.eleme.promotion.storepromotion.query");
add_param(pRequest,"query_request","数据结构JSON示例");
pResponse = top_execute(pClient,pRequest,NULL);
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.alsc.union.eleme.promotion.storepromotion.query', {
	'query_request':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_alsc_union_eleme_promotion_storepromotion_query_response>
    <data>
        <session_id>8497813e6deb4bddac841aca76e3bf8a</session_id>
        <records>
            <store_promotion_dto>
                <title>淘客连锁店铺2(分店名)</title>
                <shop_logo>https://xxx</shop_logo>
                <indistinct_monthly_sales>400+</indistinct_monthly_sales>
                <commission_rate>0.2</commission_rate>
                <biz_type>activityCps</biz_type>
                <activity>
                    <activity_id>1</activity_id>
                    <service_fee_cent>500</service_fee_cent>
                    <bonus_cent>500</bonus_cent>
                    <daily_quantity>100</daily_quantity>
                    <daily_sellable_quantity>80</daily_sellable_quantity>
                    <start_time>1639122622</start_time>
                    <end_time>1639986622</end_time>
                    <bounty_min_limit_cent>5000</bounty_min_limit_cent>
                </activity>
                <link>
                    <wx_appid>wxxxxxxxx</wx_appid>
                    <wx_path>xxxxx</wx_path>
                    <reduce_wx_appid>wxxxxxxxx</reduce_wx_appid>
                    <reduce_wx_path>xxxxx</reduce_wx_path>
                    <media_activity_wx_appid>xxxxx</media_activity_wx_appid>
                    <media_activity_wx_path>xxxxx</media_activity_wx_path>
                </link>
                <category_1_id>260</category_1_id>
                <delivery_distance>105</delivery_distance>
                <delivery_time>34</delivery_time>
                <delivery_price>4.0</delivery_price>
                <recommend_reasons>
                    <string>[&quot;酱油无骨炸鸡性价比很高&quot;</string>
                    <string>&quot;韩国炸鸡中的热卖餐厅&quot;]</string>
                </recommend_reasons>
                <service_rating>4.6</service_rating>
                <items>
                    <promotion_item>
                        <title>A黄xxxx</title>
                        <origin_price></origin_price>
                        <price>39.99</price>
                        <picture>https://xxxxx</picture>
                    </promotion_item>
                </items>
                <shop_id>xxxxxxxxx</shop_id>
                <category_1_name>全球美食</category_1_name>
                <commission>1345</commission>
            </store_promotion_dto>
        </records>
        <page_size>20</page_size>
    </data>
    <result_code>0</result_code>
    <message>success</message>
</alibaba_alsc_union_eleme_promotion_storepromotion_query_response>

{
    "alibaba_alsc_union_eleme_promotion_storepromotion_query_response":{
        "data":{
            "session_id":"8497813e6deb4bddac841aca76e3bf8a",
            "records":{
                "store_promotion_dto":[
                    {
                        "title":"淘客连锁店铺2(分店名)",
                        "shop_logo":"https:\/\/xxx",
                        "indistinct_monthly_sales":"400+",
                        "commission_rate":"0.2",
                        "biz_type":"activityCps",
                        "activity":{
                            "activity_id":"1",
                            "service_fee_cent":500,
                            "bonus_cent":500,
                            "daily_quantity":100,
                            "daily_sellable_quantity":80,
                            "start_time":1639122622,
                            "end_time":1639986622,
                            "bounty_min_limit_cent":5000
                        },
                        "link":{
                            "wx_appid":"wxxxxxxxx",
                            "wx_path":"xxxxx",
                            "reduce_wx_appid":"wxxxxxxxx",
                            "reduce_wx_path":"xxxxx",
                            "media_activity_wx_appid":"xxxxx",
                            "media_activity_wx_path":"xxxxx"
                        },
                        "category_1_id":"260",
                        "delivery_distance":105,
                        "delivery_time":34,
                        "delivery_price":"4.0",
                        "recommend_reasons":{
                            "string":[
                                "[\"酱油无骨炸鸡性价比很高\"",
                                "\"韩国炸鸡中的热卖餐厅\"]"
                            ]
                        },
                        "service_rating":"4.6",
                        "items":{
                            "promotion_item":[
                                {
                                    "title":"A黄xxxx",
                                    "origin_price":" ",
                                    "price":"39.99",
                                    "picture":"https:\/\/xxxxx"
                                }
                            ]
                        },
                        "shop_id":"xxxxxxxxx",
                        "category_1_name":"全球美食",
                        "commission":1345
                    }
                ]
            },
            "page_size":20
        },
        "result_code":0,
        "message":"success"
    }
}

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.alsc.union.eleme.promotion.storepromotion.query (本地联盟饿了么单店推广店铺列表)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ