淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	描述
tenant_key	String	必须	10006373010	租户id
token	String	可选	OnIRUAfOoYXzO3BQv/INEjB1jzHHqEvtRlYQrcLTrXM/69HByzhLivohAHTHuh5wCeMfwvrVEz09fvEIBmYT/irmh2EVZ7fbSjd6Yg4866EHfHfEzvEOSnHNrzJ1Denv7zdstCLmdjbRyGGuk4oYo+ia2dzFCqm1ZWZpNvFiKxI=	用户token
code	String	可选	123	用户code
version	String	可选	2	版本，适配灰度发布

名称	类型	示例值	描述
result	Response		默认描述
└ success Boolean true 是否成功 └ error_code String error 错误代码 content PopUpInfoVO 返回结果 activity_draw_popup ActivityDrawPopupVo 抽奖弹屏 └ popup_type Number 1 抽奖类型 └ popup_do_text String 立即抽奖弹窗点击文本 └ popup_title String 注册雅高会员标题 └ popup_sub_text String 还有1次抽奖机会文本 └ top_title String 新/人/礼/遇头部标题 └ offer_id String demo 活动id └ popup_exit_text String 暂不抽奖弹窗文本 └ popup_text String 弹窗文本文本 └ title String 商品抽奖券标题 pop_up PopUpVo 活动弹窗 └ pop_up_redirect_url String 111 弹屏跳转链接 └ pop_up_url String 1112 弹屏图片 └ offer_id Number 11 活动id └ type String coupon 弹屏类型 coupon_activity_pop_up CouponActivityPopUpVo 优惠券弹屏 coupon_template_v_o_list DisplayCouponTemplateVo [] 优惠券模板 └ condition_amount String String 使用门槛 └ discount_amount String 50 面额 └ coupon_template_id Number 1 优惠券模板id └ coupon_name String 优惠券优惠券名称 └ condition_desc String 优惠券使用条件描述 └ detail_desc String 优惠券详细描述 └ expired_time_day Number 11111 领取优惠券后的过期时间 └ expired_time_hour Number 11111 领取优惠券后的过期时间 └ expired_time_min Number 11111 领取优惠券后的过期时间 └ book_start_time String 2022-10-10 优惠券预订开始时间 └ book_end_time String 2022-10-10 优惠券预订结束时间 └ check_in_time String 2022-10-10 允许入住开始时间 └ check_out_time String 2022-10-10 允许入住结束时间 └ total_amount Number 100 优惠券总数量 └ received_amount Number 99 已领取数量 └ left_amount Number 1 优惠券剩余数量 └ status String 0 关联状态 └ relate_activity_id_list Number [] 关联活动id replace_rp_code ReplaceRpCode 关联商品 └ replace_rp_code String 111 代替后商品 └ orig_rp_code String 222 原价商品 └ expired_time String 2022-10-10 优惠券过期时间 └ coupon_type String string 优惠券类型 └ pm_activity_id Number 11 活动id └ home_page_popup String 1 1 └ details_page_picture String 1 1 └ error_msg String error 错误信息

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlitripMerchantGalaxyActivityMarketingPopupRequest req = new AlitripMerchantGalaxyActivityMarketingPopupRequest();
req.setTenantKey("10006373010");
req.setToken("OnIRUAfOoYXzO3BQv/INEjB1jzHHqEvtRlYQrcLTrXM/69HByzhLivohAHTHuh5wCeMfwvrVEz09fvEIBmYT/irmh2EVZ7fbSjd6Yg4866EHfHfEzvEOSnHNrzJ1Denv7zdstCLmdjbRyGGuk4oYo+ia2dzFCqm1ZWZpNvFiKxI=");
req.setCode("123");
req.setVersion("2");
AlitripMerchantGalaxyActivityMarketingPopupResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlitripMerchantGalaxyActivityMarketingPopupRequest req = new AlitripMerchantGalaxyActivityMarketingPopupRequest();
req.TenantKey = "10006373010";
req.Token = "OnIRUAfOoYXzO3BQv/INEjB1jzHHqEvtRlYQrcLTrXM/69HByzhLivohAHTHuh5wCeMfwvrVEz09fvEIBmYT/irmh2EVZ7fbSjd6Yg4866EHfHfEzvEOSnHNrzJ1Denv7zdstCLmdjbRyGGuk4oYo+ia2dzFCqm1ZWZpNvFiKxI=";
req.Code = "123";
req.Version = "2";
AlitripMerchantGalaxyActivityMarketingPopupResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlitripMerchantGalaxyActivityMarketingPopupRequest;
$req->setTenantKey("10006373010");
$req->setToken("OnIRUAfOoYXzO3BQv/INEjB1jzHHqEvtRlYQrcLTrXM/69HByzhLivohAHTHuh5wCeMfwvrVEz09fvEIBmYT/irmh2EVZ7fbSjd6Yg4866EHfHfEzvEOSnHNrzJ1Denv7zdstCLmdjbRyGGuk4oYo+ia2dzFCqm1ZWZpNvFiKxI=");
$req->setCode("123");
$req->setVersion("2");
$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=alitrip.merchant.galaxy.activity.marketing.popup' \
-d 'partner_id=apidoc' \
-d 'sign=FF8FAAA994862C84BC77D9EAA90ED960' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-05+19%3A20%3A38' \
-d 'v=2.0' \
-d 'code=123' \
-d 'tenant_key=10006373010' \
-d 'token=OnIRUAfOoYXzO3BQv%2FINEjB1jzHHqEvtRlYQrcLTrXM%2F69HByzhLivohAHTHuh5wCeMfwvrVEz09fvEIBmYT%2Firmh2EVZ7fbSjd6Yg4866EHfHfEzvEOSnHNrzJ1Denv7zdstCLmdjbRyGGuk4oYo%2Bia2dzFCqm1ZWZpNvFiKxI%3D' \
-d 'version=2'

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

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

req.tenant_key="10006373010"
req.token="OnIRUAfOoYXzO3BQv/INEjB1jzHHqEvtRlYQrcLTrXM/69HByzhLivohAHTHuh5wCeMfwvrVEz09fvEIBmYT/irmh2EVZ7fbSjd6Yg4866EHfHfEzvEOSnHNrzJ1Denv7zdstCLmdjbRyGGuk4oYo+ia2dzFCqm1ZWZpNvFiKxI="
req.code="123"
req.version="2"
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,"alitrip.merchant.galaxy.activity.marketing.popup");
add_param(pRequest,"tenant_key","10006373010");
add_param(pRequest,"token","OnIRUAfOoYXzO3BQv/INEjB1jzHHqEvtRlYQrcLTrXM/69HByzhLivohAHTHuh5wCeMfwvrVEz09fvEIBmYT/irmh2EVZ7fbSjd6Yg4866EHfHfEzvEOSnHNrzJ1Denv7zdstCLmdjbRyGGuk4oYo+ia2dzFCqm1ZWZpNvFiKxI=");
add_param(pRequest,"code","123");
add_param(pRequest,"version","2");
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('alitrip.merchant.galaxy.activity.marketing.popup', {
	'tenant_key':'10006373010',
	'token':'OnIRUAfOoYXzO3BQv/INEjB1jzHHqEvtRlYQrcLTrXM/69HByzhLivohAHTHuh5wCeMfwvrVEz09fvEIBmYT/irmh2EVZ7fbSjd6Yg4866EHfHfEzvEOSnHNrzJ1Denv7zdstCLmdjbRyGGuk4oYo+ia2dzFCqm1ZWZpNvFiKxI=',
	'code':'123',
	'version':'2'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alitrip_merchant_galaxy_activity_marketing_popup_response>
    <result>
        <success>true</success>
        <error_code>error</error_code>
        <content>
            <activity_draw_popup>
                <popup_type>1</popup_type>
                <popup_do_text>立即抽奖</popup_do_text>
                <popup_title>注册雅高会员</popup_title>
                <popup_sub_text>还有1次抽奖机会</popup_sub_text>
                <top_title>新/人/礼/遇</top_title>
                <offer_id>demo</offer_id>
                <popup_exit_text>暂不抽奖</popup_exit_text>
                <popup_text>弹窗文本</popup_text>
                <title>商品抽奖券</title>
            </activity_draw_popup>
            <pop_up>
                <pop_up_redirect_url>111</pop_up_redirect_url>
                <pop_up_url>1112</pop_up_url>
                <offer_id>11</offer_id>
            </pop_up>
            <type>coupon</type>
            <coupon_activity_pop_up>
                <coupon_template_v_o_list>
                    <display_coupon_template_vo>
                        <condition_amount>String</condition_amount>
                        <discount_amount>50</discount_amount>
                        <coupon_template_id>1</coupon_template_id>
                        <coupon_name>优惠券</coupon_name>
                        <condition_desc>优惠券</condition_desc>
                        <detail_desc>优惠券</detail_desc>
                        <expired_time_day>11111</expired_time_day>
                        <expired_time_hour>11111</expired_time_hour>
                        <expired_time_min>11111</expired_time_min>
                        <book_start_time>2022-10-10</book_start_time>
                        <book_end_time>2022-10-10</book_end_time>
                        <check_in_time>2022-10-10</check_in_time>
                        <check_out_time>2022-10-10</check_out_time>
                        <total_amount>100</total_amount>
                        <received_amount>99</received_amount>
                        <left_amount>1</left_amount>
                        <status>0</status>
                        <relate_activity_id_list>
                            <number></number>
                        </relate_activity_id_list>
                        <replace_rp_code>
                            <replace_rp_code>111</replace_rp_code>
                            <orig_rp_code>222</orig_rp_code>
                        </replace_rp_code>
                        <expired_time>2022-10-10</expired_time>
                        <coupon_type>string</coupon_type>
                    </display_coupon_template_vo>
                </coupon_template_v_o_list>
                <pm_activity_id>11</pm_activity_id>
                <home_page_popup>1</home_page_popup>
                <details_page_picture>1</details_page_picture>
            </coupon_activity_pop_up>
        </content>
        <error_msg>error</error_msg>
    </result>
</alitrip_merchant_galaxy_activity_marketing_popup_response>

{
    "alitrip_merchant_galaxy_activity_marketing_popup_response":{
        "result":{
            "success":true,
            "error_code":"error",
            "content":{
                "activity_draw_popup":{
                    "popup_type":1,
                    "popup_do_text":"立即抽奖",
                    "popup_title":"注册雅高会员",
                    "popup_sub_text":"还有1次抽奖机会",
                    "top_title":"新\/人\/礼\/遇",
                    "offer_id":"demo",
                    "popup_exit_text":"暂不抽奖",
                    "popup_text":"弹窗文本",
                    "title":"商品抽奖券"
                },
                "pop_up":{
                    "pop_up_redirect_url":"111",
                    "pop_up_url":"1112",
                    "offer_id":11
                },
                "type":"coupon",
                "coupon_activity_pop_up":{
                    "coupon_template_v_o_list":{
                        "display_coupon_template_vo":[
                            {
                                "condition_amount":"String",
                                "discount_amount":"50",
                                "coupon_template_id":1,
                                "coupon_name":"优惠券",
                                "condition_desc":"优惠券",
                                "detail_desc":"优惠券",
                                "expired_time_day":11111,
                                "expired_time_hour":11111,
                                "expired_time_min":11111,
                                "book_start_time":"2022-10-10",
                                "book_end_time":"2022-10-10",
                                "check_in_time":"2022-10-10",
                                "check_out_time":"2022-10-10",
                                "total_amount":100,
                                "received_amount":99,
                                "left_amount":1,
                                "status":"0",
                                "relate_activity_id_list":{
                                    "number":[
                                        
                                    ]
                                },
                                "replace_rp_code":{
                                    "replace_rp_code":"111",
                                    "orig_rp_code":"222"
                                },
                                "expired_time":"2022-10-10",
                                "coupon_type":"string"
                            }
                        ]
                    },
                    "pm_activity_id":11,
                    "home_page_popup":"1",
                    "details_page_picture":"1"
                }
            },
            "error_msg":"error"
        }
    }
}

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下载

开放平台

飞猪商家平台

alitrip.merchant.galaxy.activity.marketing.popup (营销弹屏)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ