淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
param	CustomerCouponQueryParam	可选			入参对象
└ coupon_status String 可选 -1 优惠券状态 └ mobile String 可选 123456789123 电话 └ havana_id Number 可选 12343123 大麦havanId └ query_type String 必须 coupon 查询类型 └ current_page Number 可选 1 当前页 └ page_size Number 可选 20 每页数

名称	类型	示例值	描述
result	Result		HSF响应对象
└ code String 200 结果码 └ success Boolean true 结果 model Model 分页对象 └ cur_page_num Number 1 当前页 └ total_num Number 69 数据总条数 └ success Boolean true 分页结果 └ page_size Number 20 每页数据数 └ error_code Number 1 错误码 model Model [] 结果对象 └ coupon_num Number 1 获取张数 └ coupon_name String Livehouse150减50元券主标题（优惠券名称）用户看到的优惠券名称 └ access_way_value Number 1 获取方式 └ preferential_way_value String 立减优惠方式 └ only_user_add_num Number 2 单用户限制添加次数 └ used_time_str String 2026-01-20 17:25:46 优惠券使用时间 └ activity_oner String 邹艾运营owner-活动负责人 └ effective_time_text String 2026-01-20 17:25:46 至 2026-02-18 23:59:59 活动时间 └ cost_price String 立减:50.00[元] 优惠券金额单位（元） └ access_way_desc String 活动领取获取方式文案 └ description String 使用门槛：满 150.0 元可用；可用商品：「如果你也听民谣」---三里屯民谣专场演唱会，三里屯｜流行Live现场--【现在就开唱】时光演唱会，【双旦狂欢】雍和宫乐队派对演唱会\|雍和民谣之夜+经典金曲live现场l流行弹唱，「南京站！电音引力场」小长假心跳180开躁｜ENTRY限定派对｜酒水畅饮×脱单热浪｜快乐不设限！，每天都有雍和民谣之夜｜金曲流行演唱会\|live秀纵贯线\|港乐90年代\|乐夏之歌麦霸千禧年民谣流行专场，2026全新《主题演唱会》视觉听觉新体验唱他一个多小时-北京站，上杉升《直到世界尽头》33周年作品集限定视听会，[春心开学季电音派对]「3.22寻爱记」Kaos Nig…… 权益说明 └ coupon_user_range String 演出使用范围-演出专用、电影专用、通用 └ starting_price String 150.00[元] 券使用起步价 └ sid String code_0dbe36b5e8298741 卡券活动的外部传播id └ used_order_id String 2123212313123131232132 核销订单号 └ coupon_product_id Number 285293 码商品id └ expire_time String 2026-02-18 23:59:59 优惠券过期时间 └ create_time String 2026-01-20 17:25:46 优惠券获取时间 └ use_coupon_url_h5 String http://wunoinna.com 优惠券链接（电影和演出券使用规则） └ name String FY26联盟券-LH150减50元-S2 权益名称(活动名称) └ effect_time String 2026-01-20 17:25:46 优惠券生效时间 └ starting_tic_count Number 0 购票起步张数 └ status String 未使用优惠券状态 └ total_page_num Number 4 总页数 └ error_code_str String 错误错误码描述 └ message String 成功分页描述 └ message String 成功结果描述

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
FilmCouponsUserGetRequest req = new FilmCouponsUserGetRequest();
FilmCouponsUserGetRequest.CustomerCouponQueryParam obj1 = new FilmCouponsUserGetRequest.CustomerCouponQueryParam();
obj1.setCouponStatus("-1");
obj1.setMobile("123456789123");
obj1.setHavanaId(12343123L);
obj1.setQueryType("coupon");
obj1.setCurrentPage(1L);
obj1.setPageSize(20L);
req.setParam(obj1);
FilmCouponsUserGetResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
FilmCouponsUserGetRequest req = new FilmCouponsUserGetRequest();
FilmCouponsUserGetRequest.CustomerCouponQueryParamDomain obj1 = new FilmCouponsUserGetRequest.CustomerCouponQueryParamDomain();
obj1.CouponStatus = "-1";
obj1.Mobile = "123456789123";
obj1.HavanaId = 12343123L;
obj1.QueryType = "coupon";
obj1.CurrentPage = 1L;
obj1.PageSize = 20L;
req.Param_ = obj1;
FilmCouponsUserGetResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new FilmCouponsUserGetRequest;
$param = new CustomerCouponQueryParam;
$param->coupon_status="-1";
$param->mobile="123456789123";
$param->havana_id="12343123";
$param->query_type="coupon";
$param->current_page="1";
$param->page_size="20";
$req->setParam(json_encode($param));
$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=taobao.film.coupons.user.get' \
-d 'partner_id=apidoc' \
-d 'sign=B86A21BD59A4B659CC000AD53F50687B' \
-d 'sign_method=hmac' \
-d 'timestamp=2026-03-19+08%3A04%3A09' \
-d 'v=2.0' \
-d 'param=null'

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

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

req.param="数据结构示例JSON格式"
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,"taobao.film.coupons.user.get");
add_param(pRequest,"param","数据结构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',
	'url': 'http://gw.api.taobao.com/router/rest'
});

client.execute('taobao.film.coupons.user.get', {
	'param':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<film_coupons_user_get_response>
    <result>
        <code>200</code>
        <success>true</success>
        <model>
            <cur_page_num>1</cur_page_num>
            <total_num>69</total_num>
            <success>true</success>
            <page_size>20</page_size>
            <error_code>1</error_code>
            <model>
                <model>
                    <coupon_num>1</coupon_num>
                    <coupon_name>Livehouse150减50元</coupon_name>
                    <access_way_value>1</access_way_value>
                    <preferential_way_value>立减</preferential_way_value>
                    <only_user_add_num>2</only_user_add_num>
                    <used_time_str>2026-01-20 17:25:46</used_time_str>
                    <activity_oner>邹艾</activity_oner>
                    <effective_time_text>2026-01-20 17:25:46 至 2026-02-18 23:59:59</effective_time_text>
                    <cost_price>立减:50.00[元]</cost_price>
                    <access_way_desc>活动领取</access_way_desc>
                    <description>使用门槛：满 150.0 元可用；
可用商品：「如果你也听民谣」---三里屯民谣专场演唱会，三里屯｜流行Live现场--【现在就开唱】时光演唱会，【双旦狂欢】雍和宫乐队派对演唱会|雍和民谣之夜+经典金曲live现场l流行弹唱，「南京站！电音引力场」小长假心跳180开躁｜ENTRY限定派对｜酒水畅饮×脱单热浪｜快乐不设限！，每天都有雍和民谣之夜｜金曲流行演唱会|live秀纵贯线|港乐90年代|乐夏之歌麦霸千禧年民谣流行专场，2026全新《主题演唱会》视觉听觉新体验 唱他一个多小时-北京站，上杉升《直到世界尽头》33周年作品集限定视听会，[春心开学季电音派对]「3.22寻爱记」Kaos Nig……</description>
                    <coupon_user_range>演出</coupon_user_range>
                    <starting_price>150.00[元]</starting_price>
                    <sid>code_0dbe36b5e8298741</sid>
                    <used_order_id>2123212313123131232132</used_order_id>
                    <coupon_product_id>285293</coupon_product_id>
                    <expire_time>2026-02-18 23:59:59</expire_time>
                    <create_time>2026-01-20 17:25:46</create_time>
                    <use_coupon_url_h5>http://wunoinna.com</use_coupon_url_h5>
                    <name>FY26联盟券-LH150减50元-S2</name>
                    <effect_time>2026-01-20 17:25:46</effect_time>
                    <starting_tic_count>0</starting_tic_count>
                    <status>未使用</status>
                </model>
            </model>
            <total_page_num>4</total_page_num>
            <error_code_str>错误</error_code_str>
            <message>成功</message>
        </model>
        <message>成功</message>
    </result>
</film_coupons_user_get_response>

{
    "film_coupons_user_get_response":{
        "result":{
            "code":"200",
            "success":true,
            "model":{
                "cur_page_num":1,
                "total_num":69,
                "success":true,
                "page_size":20,
                "error_code":1,
                "model":{
                    "model":[
                        {
                            "coupon_num":1,
                            "coupon_name":"Livehouse150减50元",
                            "access_way_value":1,
                            "preferential_way_value":"立减",
                            "only_user_add_num":2,
                            "used_time_str":"2026-01-20 17:25:46",
                            "activity_oner":"邹艾",
                            "effective_time_text":"2026-01-20 17:25:46 至 2026-02-18 23:59:59",
                            "cost_price":"立减:50.00[元]",
                            "access_way_desc":"活动领取",
                            "description":"使用门槛：满 150.0 元可用；\n可用商品：「如果你也听民谣」---三里屯民谣专场演唱会，三里屯｜流行Live现场--【现在就开唱】时光演唱会，【双旦狂欢】雍和宫乐队派对演唱会|雍和民谣之夜+经典金曲live现场l流行弹唱，「南京站！电音引力场」小长假心跳180开躁｜ENTRY限定派对｜酒水畅饮×脱单热浪｜快乐不设限！，每天都有雍和民谣之夜｜金曲流行演唱会|live秀纵贯线|港乐90年代|乐夏之歌麦霸千禧年民谣流行专场，2026全新《主题演唱会》视觉听觉新体验 唱他一个多小时-北京站，上杉升《直到世界尽头》33周年作品集限定视听会，[春心开学季电音派对]「3.22寻爱记」Kaos Nig……",
                            "coupon_user_range":"演出",
                            "starting_price":"150.00[元]",
                            "sid":"code_0dbe36b5e8298741",
                            "used_order_id":"2123212313123131232132",
                            "coupon_product_id":285293,
                            "expire_time":"2026-02-18 23:59:59",
                            "create_time":"2026-01-20 17:25:46",
                            "use_coupon_url_h5":"http:\/\/wunoinna.com",
                            "name":"FY26联盟券-LH150减50元-S2",
                            "effect_time":"2026-01-20 17:25:46",
                            "starting_tic_count":0,
                            "status":"未使用"
                        }
                    ]
                },
                "total_page_num":4,
                "error_code_str":"错误",
                "message":"成功"
            },
            "message":"成功"
        }
    }
}

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

taobao.film.coupons.user.get (优惠券列表查询)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ