淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
biz_code	String	必须	xx		业务身份
activity_id	Number	必须	111		活动id

名称	类型	示例值	描述
data	NrtSceneActivityDTO		数据
benefit_list NrtBenefitDTO [] 权益列表 └ gmt_modified Date 1577334366000 修改时间 └ benefit_type String 1 权益类型 └ probability String 1.0000 中奖概率 └ biz_code String xx 业务身份 └ out_relate_id Number 9369 关联的权益模板id └ description String 到店礼测试1226 描述 └ gmt_create Date 1577334272000 创建时间 └ benefit_id Number 1592001 权益id └ total_quantity Number 122 总数 └ benefit_name String 到店礼测试1226 权益名称 └ extra String xx 扩展信息 └ person_limit_count Number 3 个人限领数 └ start_time Date 1577289600000 开始时间 └ end_time Date 1577807999000 结束时间 └ status Number 0 状态 └ img_url String aa.png 权益图片地址 └ use_channel Number 111 使用渠道 └ biz_code String easyHome 业务身份 └ creator_id String 4011263977 创建者id └ item_id Number 610162876846 有价礼包活动对应的商品id └ activity_id Number 400001 活动id └ extra String xx 扩展信息 └ name String xx 活动名称 └ start_time String Thu, 26 Dec 2019 03:47:00 GMT 活动开始时间 └ end_time String Mon, 30 Dec 2019 16:00:00 GMT 活动结束时间 └ activity_type String 0 活动类型 └ modified_id String 4011601563 修改人id └ status Number 2 状态 └ version Number 1111 版本 channel_list ChannelDTO [] 渠道 └ channel_code String 001 渠道编码 └ channel_name String 渠道A 渠道名称
errcode	String	CE001	错误码
succ	Boolean	true	是否成功
errmsg	String	系统异常	错误信息

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
TmallNrtSceneActivityQueryRequest req = new TmallNrtSceneActivityQueryRequest();
req.setBizCode("xx");
req.setActivityId(111L);
TmallNrtSceneActivityQueryResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
TmallNrtSceneActivityQueryRequest req = new TmallNrtSceneActivityQueryRequest();
req.BizCode = "xx";
req.ActivityId = 111L;
TmallNrtSceneActivityQueryResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new TmallNrtSceneActivityQueryRequest;
$req->setBizCode("xx");
$req->setActivityId("111");
$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=tmall.nrt.scene.activity.query' \
-d 'partner_id=apidoc' \
-d 'session=2d753350-09af-4c09-b945-3ff476f115e0' \
-d 'sign=4BF7CE28BD63FB64342D43A9715542B3' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-22+20%3A45%3A29' \
-d 'v=2.0' \
-d 'activity_id=111' \
-d 'biz_code=xx'

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

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

req.biz_code="xx"
req.activity_id=111
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,"tmall.nrt.scene.activity.query");
add_param(pRequest,"biz_code","xx");
add_param(pRequest,"activity_id","111");
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('tmall.nrt.scene.activity.query', {
	'biz_code':'xx',
	'activity_id':'111'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<tmall_nrt_scene_activity_query_response>
    <data>
        <benefit_list>
            <nrt_benefit_d_t_o>
                <gmt_modified>1577334366000</gmt_modified>
                <benefit_type>1</benefit_type>
                <probability>1.0000</probability>
                <biz_code>xx</biz_code>
                <out_relate_id>9369</out_relate_id>
                <description>到店礼测试1226</description>
                <gmt_create>1577334272000</gmt_create>
                <benefit_id>1592001</benefit_id>
                <total_quantity>122</total_quantity>
                <benefit_name>到店礼测试1226</benefit_name>
                <extra>xx</extra>
                <person_limit_count>3</person_limit_count>
                <start_time>1577289600000</start_time>
                <end_time>1577807999000</end_time>
                <status>0</status>
                <img_url>aa.png</img_url>
                <use_channel>111</use_channel>
            </nrt_benefit_d_t_o>
        </benefit_list>
        <biz_code>easyHome</biz_code>
        <creator_id>4011263977</creator_id>
        <item_id>610162876846</item_id>
        <activity_id>400001</activity_id>
        <extra>xx</extra>
        <name>xx</name>
        <start_time>Thu, 26 Dec 2019 03:47:00 GMT</start_time>
        <end_time>Mon, 30 Dec 2019 16:00:00 GMT</end_time>
        <activity_type>0</activity_type>
        <modified_id>4011601563</modified_id>
        <status>2</status>
        <version>1111</version>
        <channel_list>
            <channel_d_t_o>
                <channel_code>001</channel_code>
                <channel_name>渠道A</channel_name>
            </channel_d_t_o>
        </channel_list>
    </data>
    <errcode>CE001</errcode>
    <succ>true</succ>
    <errmsg>系统异常</errmsg>
</tmall_nrt_scene_activity_query_response>

{
    "tmall_nrt_scene_activity_query_response":{
        "data":{
            "benefit_list":{
                "nrt_benefit_d_t_o":[
                    {
                        "gmt_modified":"1577334366000",
                        "benefit_type":"1",
                        "probability":"1.0000",
                        "biz_code":"xx",
                        "out_relate_id":9369,
                        "description":"到店礼测试1226",
                        "gmt_create":"1577334272000",
                        "benefit_id":1592001,
                        "total_quantity":122,
                        "benefit_name":"到店礼测试1226",
                        "extra":"xx",
                        "person_limit_count":3,
                        "start_time":"1577289600000",
                        "end_time":"1577807999000",
                        "status":0,
                        "img_url":"aa.png",
                        "use_channel":111
                    }
                ]
            },
            "biz_code":"easyHome",
            "creator_id":"4011263977",
            "item_id":610162876846,
            "activity_id":400001,
            "extra":"xx",
            "name":"xx",
            "start_time":"Thu, 26 Dec 2019 03:47:00 GMT",
            "end_time":"Mon, 30 Dec 2019 16:00:00 GMT",
            "activity_type":"0",
            "modified_id":"4011601563",
            "status":2,
            "version":1111,
            "channel_list":{
                "channel_d_t_o":[
                    {
                        "channel_code":"001",
                        "channel_name":"渠道A"
                    }
                ]
            }
        },
        "errcode":"CE001",
        "succ":true,
        "errmsg":"系统异常"
    }
}

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

tmall.nrt.scene.activity.query (喵零场景活动查询)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ