淘宝开放平台 - 文档中心

请求地址：

环境	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	可选	MTwsrB3Jskxfz3		用户Token

名称	类型	示例值	描述
result	Response		结果
└ success Boolean true 是否成功 └ error_code String 200 状态码 content WeChatCouponVO 优惠券实例 coupon_info_v_o CouponInfoVO [] 优惠券实例对象 └ instance_id Number 163751 实例id └ discount_amount String 222.00 折扣 └ condition_amount String 111.00 门槛 └ detail_desc String 谁谁谁描述 └ coupon_name String 新增优惠券优惠券名字 └ expired_time_min String 2022-03-02 23:59:59 过期时间 └ coupon_type String ELIGIBILITY_COUPON 优惠券类型 └ coupon_template_id Number 37 模板id └ condition_desc String 满111.00适用描述 └ status String AVAILABLE 状态 └ sign String 123123 加密串 └ send_coupon_merchant String 111 商户号 send_coupon_params SendCouponParams [] 1 └ stock_id String 1 1 └ out_request_no String 1 1 └ coupon_code String 1 1 └ error_msg String 错误信息错误信息

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlitripMerchantGalaxyCouponValidListRequest req = new AlitripMerchantGalaxyCouponValidListRequest();
req.setTenantKey("10006373010");
req.setToken("MTwsrB3Jskxfz3");
AlitripMerchantGalaxyCouponValidListResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlitripMerchantGalaxyCouponValidListRequest req = new AlitripMerchantGalaxyCouponValidListRequest();
req.TenantKey = "10006373010";
req.Token = "MTwsrB3Jskxfz3";
AlitripMerchantGalaxyCouponValidListResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlitripMerchantGalaxyCouponValidListRequest;
$req->setTenantKey("10006373010");
$req->setToken("MTwsrB3Jskxfz3");
$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.coupon.valid.list' \
-d 'partner_id=apidoc' \
-d 'sign=5F093475AE41AF813AE066D02150B711' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-05+19%3A28%3A11' \
-d 'v=2.0' \
-d 'tenant_key=10006373010' \
-d 'token=MTwsrB3Jskxfz3'

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

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

req.tenant_key="10006373010"
req.token="MTwsrB3Jskxfz3"
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.coupon.valid.list");
add_param(pRequest,"tenant_key","10006373010");
add_param(pRequest,"token","MTwsrB3Jskxfz3");
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.coupon.valid.list', {
	'tenant_key':'10006373010',
	'token':'MTwsrB3Jskxfz3'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alitrip_merchant_galaxy_coupon_valid_list_response>
    <result>
        <success>true</success>
        <error_code>200</error_code>
        <content>
            <coupon_info_v_o>
                <coupon_info_v_o>
                    <instance_id>163751</instance_id>
                    <discount_amount>222.00</discount_amount>
                    <condition_amount>111.00</condition_amount>
                    <detail_desc>谁谁谁</detail_desc>
                    <coupon_name>新增优惠券</coupon_name>
                    <expired_time_min>2022-03-02 23:59:59</expired_time_min>
                    <coupon_type>ELIGIBILITY_COUPON</coupon_type>
                    <coupon_template_id>37</coupon_template_id>
                    <condition_desc>满111.00适用</condition_desc>
                    <status>AVAILABLE</status>
                </coupon_info_v_o>
            </coupon_info_v_o>
            <sign>123123</sign>
            <send_coupon_merchant>111</send_coupon_merchant>
            <send_coupon_params>
                <send_coupon_params>
                    <stock_id>1</stock_id>
                    <out_request_no>1</out_request_no>
                    <coupon_code>1</coupon_code>
                </send_coupon_params>
            </send_coupon_params>
        </content>
        <error_msg>错误信息</error_msg>
    </result>
</alitrip_merchant_galaxy_coupon_valid_list_response>

{
    "alitrip_merchant_galaxy_coupon_valid_list_response":{
        "result":{
            "success":true,
            "error_code":"200",
            "content":{
                "coupon_info_v_o":{
                    "coupon_info_v_o":[
                        {
                            "instance_id":163751,
                            "discount_amount":"222.00",
                            "condition_amount":"111.00",
                            "detail_desc":"谁谁谁",
                            "coupon_name":"新增优惠券",
                            "expired_time_min":"2022-03-02 23:59:59",
                            "coupon_type":"ELIGIBILITY_COUPON",
                            "coupon_template_id":37,
                            "condition_desc":"满111.00适用",
                            "status":"AVAILABLE"
                        }
                    ]
                },
                "sign":"123123",
                "send_coupon_merchant":"111",
                "send_coupon_params":{
                    "send_coupon_params":[
                        {
                            "stock_id":"1",
                            "out_request_no":"1",
                            "coupon_code":"1"
                        }
                    ]
                }
            },
            "error_msg":"错误信息"
        }
    }
}

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.coupon.valid.list (用户有效优惠券列表)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ