淘宝开放平台 - 文档中心

请求地址：

环境	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	ItemPromotionQueryRequest	必须			查询rquest
└ session_id String 可选 alsc_xxxx 会话ID（查询第一页为空，从第二页开始赋值，取值来自第一页返回结果） └ biz_type String 必须 hoard_coupon 商品类型（hoard_coupon-囤券券） └ pid String 必须 alsc_123_131_1313 推广位 └ city_code String 可选 320000 城市编码（国标） └ sort_type String 可选 sell_price_desc 排序（normal-佣金倒序，commission_desc-佣金倒序，commission_rate_desc-佣金比例倒序，sell_price_asc-价格正序，sell_price_desc-价格倒序） └ page_number Number 可选 1 请求页（从1开始） └ page_size Number 可选 20 每页数（1~20） └ sid String 可选 1313 会员ID（需要联系运营申请） └ search_content String 可选麦当劳品牌搜索 └ item_type String 可选 1\|2 商品类型，多值'\|'分隔，默认全部（1-商品券；2-代金券）

名称	类型	示例值	描述
data	PageModel	{}	分页数据
└ session_id String alsc_unionopen_8497813e6deb4bddac841aca76e3bf8a 会话ID records ItemPromotionDto [] [] 数据 └ item_id String 0DE2606D93414EE8ECD84D49995A66D8 商品ID └ item_name String 37店通用\|鲜蔬乌冬面套餐\|5折限量抢购标题 └ picture String https://img.alicdn.com/i4/2200801151512/O1CN01xvUYrB1N2XYk7esnL_!!2200801151512-0-koubei.jpg 图片 └ biz_type String hoard_coupon 商品类型 └ original_price_cent Number 10000 原价（分） └ sell_price_cent Number 8000 售价（分） └ discount String 0.5 折扣 └ start_ime Number 1690375813 起始时间（秒） └ end_time Number 1693054213 结束时间（秒） └ commission_rate String 0.1 佣金比例 └ commission Number 1000 预估佣金（分） └ stock Number 122 库存 └ apply_city_count Number 12 适用城市数量 └ apply_shop_count Number 222 适用门店数量 link PromotionLink 201164007 分享链接 └ wx_appid String wxxxxxxxx 微信小程序appId └ wx_path String xxxxx 微信小程序path链接 └ wx_mini_qrcode String xxxxx 微信小程序二维码 └ alipay_scheme_url String xxxxx 支付宝schemal链接 └ item_type Number 1 商品类型（1-商品券；2-代金券） ticket ItemTicket {} 凭证信息 └ price Number 5000 价格（分） └ quantity Number 2 数量 └ threshold Number 8000 使用门槛（分） └ page_number Number 1 页码 └ page_size Number 20 每页数目 └ total Number 100 总数
result_code	Number	0	返回码
message	String	success	返回消息
error_message	String	xxx不正确	错误消息

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaAlscUnionElemePromotionItempromotionQueryRequest req = new AlibabaAlscUnionElemePromotionItempromotionQueryRequest();
AlibabaAlscUnionElemePromotionItempromotionQueryRequest.ItemPromotionQueryRequest obj1 = new AlibabaAlscUnionElemePromotionItempromotionQueryRequest.ItemPromotionQueryRequest();
obj1.setSessionId("alsc_xxxx");
obj1.setBizType("hoard_coupon");
obj1.setPid("alsc_123_131_1313");
obj1.setCityCode("320000");
obj1.setSortType("sell_price_desc");
obj1.setPageNumber(1L);
obj1.setPageSize(20L);
obj1.setSid("1313");
obj1.setSearchContent("麦当劳");
obj1.setItemType("1|2");
req.setQueryRequest(obj1);
AlibabaAlscUnionElemePromotionItempromotionQueryResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaAlscUnionElemePromotionItempromotionQueryRequest req = new AlibabaAlscUnionElemePromotionItempromotionQueryRequest();
AlibabaAlscUnionElemePromotionItempromotionQueryRequest.ItemPromotionQueryRequestDomain obj1 = new AlibabaAlscUnionElemePromotionItempromotionQueryRequest.ItemPromotionQueryRequestDomain();
obj1.SessionId = "alsc_xxxx";
obj1.BizType = "hoard_coupon";
obj1.Pid = "alsc_123_131_1313";
obj1.CityCode = "320000";
obj1.SortType = "sell_price_desc";
obj1.PageNumber = 1L;
obj1.PageSize = 20L;
obj1.Sid = "1313";
obj1.SearchContent = "麦当劳";
obj1.ItemType = "1|2";
req.QueryRequest_ = obj1;
AlibabaAlscUnionElemePromotionItempromotionQueryResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaAlscUnionElemePromotionItempromotionQueryRequest;
$query_request = new ItemPromotionQueryRequest;
$query_request->session_id="alsc_xxxx";
$query_request->biz_type="hoard_coupon";
$query_request->pid="alsc_123_131_1313";
$query_request->city_code="320000";
$query_request->sort_type="sell_price_desc";
$query_request->page_number="1";
$query_request->page_size="20";
$query_request->sid="1313";
$query_request->search_content="麦当劳";
$query_request->item_type="1|2";
$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.itempromotion.query' \
-d 'partner_id=apidoc' \
-d 'sign=51F0327B753011E8FB96201111C31E1C' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-25+12%3A33%3A53' \
-d 'v=2.0' \
-d 'query_request=%7B%7D'

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

req=top.api.AlibabaAlscUnionElemePromotionItempromotionQueryRequest(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.itempromotion.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.itempromotion.query', {
	'query_request':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_alsc_union_eleme_promotion_itempromotion_query_response>
    <data>
        <session_id>alsc_unionopen_8497813e6deb4bddac841aca76e3bf8a</session_id>
        <records>
            <item_promotion_dto>
                <item_id>0DE2606D93414EE8ECD84D49995A66D8</item_id>
                <item_name>37店通用|鲜蔬乌冬面套餐|5折限量抢购</item_name>
                <picture>https://img.alicdn.com/i4/2200801151512/O1CN01xvUYrB1N2XYk7esnL_!!2200801151512-0-koubei.jpg</picture>
                <biz_type>hoard_coupon</biz_type>
                <original_price_cent>10000</original_price_cent>
                <sell_price_cent>8000</sell_price_cent>
                <discount>0.5</discount>
                <start_ime>1690375813</start_ime>
                <end_time>1693054213</end_time>
                <commission_rate>0.1</commission_rate>
                <commission>1000</commission>
                <stock>122</stock>
                <apply_city_count>12</apply_city_count>
                <apply_shop_count>222</apply_shop_count>
                <link>
                    <wx_appid>wxxxxxxxx</wx_appid>
                    <wx_path>xxxxx</wx_path>
                    <wx_mini_qrcode>xxxxx</wx_mini_qrcode>
                    <alipay_scheme_url>xxxxx</alipay_scheme_url>
                </link>
                <item_type>1</item_type>
                <ticket>
                    <price>5000</price>
                    <quantity>2</quantity>
                    <threshold>8000</threshold>
                </ticket>
            </item_promotion_dto>
        </records>
        <page_number>1</page_number>
        <page_size>20</page_size>
        <total>100</total>
    </data>
    <result_code>0</result_code>
    <message>success</message>
    <error_message>xxx不正确</error_message>
</alibaba_alsc_union_eleme_promotion_itempromotion_query_response>

{
    "alibaba_alsc_union_eleme_promotion_itempromotion_query_response":{
        "data":{
            "session_id":"alsc_unionopen_8497813e6deb4bddac841aca76e3bf8a",
            "records":{
                "item_promotion_dto":[
                    {
                        "item_id":"0DE2606D93414EE8ECD84D49995A66D8",
                        "item_name":"37店通用|鲜蔬乌冬面套餐|5折限量抢购",
                        "picture":"https:\/\/img.alicdn.com\/i4\/2200801151512\/O1CN01xvUYrB1N2XYk7esnL_!!2200801151512-0-koubei.jpg",
                        "biz_type":"hoard_coupon",
                        "original_price_cent":10000,
                        "sell_price_cent":8000,
                        "discount":"0.5",
                        "start_ime":1690375813,
                        "end_time":1693054213,
                        "commission_rate":"0.1",
                        "commission":1000,
                        "stock":122,
                        "apply_city_count":12,
                        "apply_shop_count":222,
                        "link":{
                            "wx_appid":"wxxxxxxxx",
                            "wx_path":"xxxxx",
                            "wx_mini_qrcode":"xxxxx",
                            "alipay_scheme_url":"xxxxx"
                        },
                        "item_type":1,
                        "ticket":{
                            "price":5000,
                            "quantity":2,
                            "threshold":8000
                        }
                    }
                ]
            },
            "page_number":1,
            "page_size":20,
            "total":100
        },
        "result_code":0,
        "message":"success",
        "error_message":"xxx不正确"
    }
}

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.itempromotion.query (本地联盟饿了么单品推广列表（餐饮）)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ