淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	描述
me	String	可选	nfr%2BYTo2k1PX18gaNN%2BIPkIG2PadNYbBnwEsv6mRavWieOoOE3L9OdmbDSSyHbGxBAXjHpLKvZbL1320ML%2BCF5FRtW7N7yJ056Lgym4X01A%3D	带券ID与商品ID的加密串
item_id	String	可选	123	商品ID
activity_id	String	可选	sdfwe3eefsdf	券ID

名称	类型	示例值	描述
data	MapData	data	data
└ coupon_start_fee String 29.00 优惠券门槛金额 └ coupon_remain_count Number 26996 优惠券剩余量 └ coupon_total_count Number 30000 优惠券总量 └ coupon_end_time String 2017-08-17 优惠券结束时间 └ coupon_start_time String 2017-08-15 优惠券开始时间 └ coupon_amount String 10.00 优惠券金额 └ coupon_src_scene Number 1 券类型，1 表示全网公开券，4 表示妈妈渠道券 └ coupon_type Number 0 券属性，0表示店铺券，1表示单品券 └ coupon_activity_id String xsdss 券ID

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
TbkCouponGetRequest req = new TbkCouponGetRequest();
req.setMe("nfr%2BYTo2k1PX18gaNN%2BIPkIG2PadNYbBnwEsv6mRavWieOoOE3L9OdmbDSSyHbGxBAXjHpLKvZbL1320ML%2BCF5FRtW7N7yJ056Lgym4X01A%3D");
req.setItemId("123");
req.setActivityId("sdfwe3eefsdf");
TbkCouponGetResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
TbkCouponGetRequest req = new TbkCouponGetRequest();
req.Me = "nfr%2BYTo2k1PX18gaNN%2BIPkIG2PadNYbBnwEsv6mRavWieOoOE3L9OdmbDSSyHbGxBAXjHpLKvZbL1320ML%2BCF5FRtW7N7yJ056Lgym4X01A%3D";
req.ItemId = "123";
req.ActivityId = "sdfwe3eefsdf";
TbkCouponGetResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new TbkCouponGetRequest;
$req->setMe("nfr%2BYTo2k1PX18gaNN%2BIPkIG2PadNYbBnwEsv6mRavWieOoOE3L9OdmbDSSyHbGxBAXjHpLKvZbL1320ML%2BCF5FRtW7N7yJ056Lgym4X01A%3D");
$req->setItemId("123");
$req->setActivityId("sdfwe3eefsdf");
$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.tbk.coupon.get' \
-d 'partner_id=apidoc' \
-d 'sign=24FA435F64FFAE2C37661C603362A123' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-01-16+01%3A11%3A29' \
-d 'v=2.0' \
-d 'activity_id=sdfwe3eefsdf' \
-d 'item_id=123' \
-d 'me=nfr%252BYTo2k1PX18gaNN%252BIPkIG2PadNYbBnwEsv6mRavWieOoOE3L9OdmbDSSyHbGxBAXjHpLKvZbL1320ML%252BCF5FRtW7N7yJ056Lgym4X01A%253D'

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

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

req.me="nfr%2BYTo2k1PX18gaNN%2BIPkIG2PadNYbBnwEsv6mRavWieOoOE3L9OdmbDSSyHbGxBAXjHpLKvZbL1320ML%2BCF5FRtW7N7yJ056Lgym4X01A%3D"
req.item_id="123"
req.activity_id="sdfwe3eefsdf"
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.tbk.coupon.get");
add_param(pRequest,"me","nfr%2BYTo2k1PX18gaNN%2BIPkIG2PadNYbBnwEsv6mRavWieOoOE3L9OdmbDSSyHbGxBAXjHpLKvZbL1320ML%2BCF5FRtW7N7yJ056Lgym4X01A%3D");
add_param(pRequest,"item_id","123");
add_param(pRequest,"activity_id","sdfwe3eefsdf");
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('taobao.tbk.coupon.get', {
	'me':'nfr%2BYTo2k1PX18gaNN%2BIPkIG2PadNYbBnwEsv6mRavWieOoOE3L9OdmbDSSyHbGxBAXjHpLKvZbL1320ML%2BCF5FRtW7N7yJ056Lgym4X01A%3D',
	'item_id':'123',
	'activity_id':'sdfwe3eefsdf'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<tbk_coupon_get_response>
    <data>
        <coupon_start_fee>29.00</coupon_start_fee>
        <coupon_remain_count>26996</coupon_remain_count>
        <coupon_total_count>30000</coupon_total_count>
        <coupon_end_time>2017-08-17</coupon_end_time>
        <coupon_start_time>2017-08-15</coupon_start_time>
        <coupon_amount>10.00</coupon_amount>
        <coupon_src_scene>1</coupon_src_scene>
        <coupon_type>0</coupon_type>
        <coupon_activity_id>xsdss</coupon_activity_id>
    </data>
</tbk_coupon_get_response>

{
    "tbk_coupon_get_response":{
        "data":{
            "coupon_start_fee":"29.00",
            "coupon_remain_count":26996,
            "coupon_total_count":30000,
            "coupon_end_time":"2017-08-17",
            "coupon_start_time":"2017-08-15",
            "coupon_amount":"10.00",
            "coupon_src_scene":1,
            "coupon_type":0,
            "coupon_activity_id":"xsdss"
        }
    }
}

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"
	}
}

错误码	错误描述	解决方案
1001	非法的me参数值	传入正确的me参数值，含有券ID与商品ID信息
10000	该itemId对应的宝贝已下架或非淘客宝贝	更换新的itemId查询
1002	入参为空	传入正确的参数值
10	优惠券不存在	优惠券不存在，请重新查询
11	优惠券已领完	优惠券已领完，请重新查询
13	该优惠券不适用该商品	该优惠券不适用该商品，请重新查询
14	优惠券类型错误	该优惠券类型错误，请重新查询
15	不支持的优惠券	该优惠券不支持使用，请重新查询
17	优惠券未到开始使用时间	该优惠券未到开始使用时间，请重新查询
1	内部服务错误	稍后重试
12	优惠券已过期	优惠券已过期，请重新查询
16	优惠券未到开始领取时间	优惠券未到开始领取时间，请重新查询
1912	您输入的商品ID不合法，请使用升级后的新商品ID，如有疑问请加入【淘宝联盟】线上合规升级咨询群（钉钉群：44965410）进行咨询	您输入的商品ID不合法，请使用升级后的新商品ID，如有疑问请加入【淘宝联盟】线上合规升级咨询群（钉钉群：44965410）进行咨询

API测试工具错误码查询工具 SDK下载

淘宝客API

taobao.tbk.coupon.get (淘宝客-公用-阿里妈妈推广券详情查询)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ