淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
nrt_coupon_send_dto	NrtCouponSendDTO	必须			发券dto
└ biz_code String 必须 YXX 业务code └ open_id String 必须 dfdsdfow 加密后淘系ID └ extra String 可选扩展字段 {"key","value"} └ channel String 必须 app 渠道 └ out_id String 必须 11111 幂等ID └ uuid String 必须 fsdfsfee1f2 券code └ coupon_type Number 必须 1 券类型，247：品类券，276：门店券，357：门店通用券

名称	类型	示例值	描述
model	SendCouponResponse	null	发券结果对象
└ discount Number 10 面额 └ start_fee Number 100 门槛 └ coupon_name String 测试券券名称 └ coupon_template_id Number 12345 券模板ID └ coupon_instance_id Number 12344 券实例ID └ end_time Number 123345 结束时间 └ start_time Number 123345 开始时间

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
TmallNrtCouponSendRequest req = new TmallNrtCouponSendRequest();
TmallNrtCouponSendRequest.NrtCouponSendDTO obj1 = new TmallNrtCouponSendRequest.NrtCouponSendDTO();
obj1.setBizCode("YXX");
obj1.setOpenId("dfdsdfow");
obj1.setExtra("扩展字段");
obj1.setChannel("app");
obj1.setOutId("11111");
obj1.setUuid("fsdfsfee1f2");
obj1.setCouponType(1L);
req.setNrtCouponSendDto(obj1);
TmallNrtCouponSendResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
TmallNrtCouponSendRequest req = new TmallNrtCouponSendRequest();
TmallNrtCouponSendRequest.NrtCouponSendDTODomain obj1 = new TmallNrtCouponSendRequest.NrtCouponSendDTODomain();
obj1.BizCode = "YXX";
obj1.OpenId = "dfdsdfow";
obj1.Extra = "扩展字段";
obj1.Channel = "app";
obj1.OutId = "11111";
obj1.Uuid = "fsdfsfee1f2";
obj1.CouponType = 1L;
req.NrtCouponSendDto_ = obj1;
TmallNrtCouponSendResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new TmallNrtCouponSendRequest;
$nrt_coupon_send_dto = new NrtCouponSendDTO;
$nrt_coupon_send_dto->biz_code="YXX";
$nrt_coupon_send_dto->open_id="dfdsdfow";
$nrt_coupon_send_dto->extra="扩展字段";
$nrt_coupon_send_dto->channel="app";
$nrt_coupon_send_dto->out_id="11111";
$nrt_coupon_send_dto->uuid="fsdfsfee1f2";
$nrt_coupon_send_dto->coupon_type="1";
$req->setNrtCouponSendDto(json_encode($nrt_coupon_send_dto));
$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.coupon.send' \
-d 'partner_id=apidoc' \
-d 'session=6a891b3e-ad6d-4154-900a-3e38366d4c2d' \
-d 'sign=B00FCA0DC052332FE1B8B269B68A34E4' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-15+15%3A27%3A09' \
-d 'v=2.0' \
-d 'nrt_coupon_send_dto=null'

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

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

req.nrt_coupon_send_dto=""
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.coupon.send");
add_param(pRequest,"nrt_coupon_send_dto","数据结构JSON示例");
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.coupon.send', {
	'nrt_coupon_send_dto':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<tmall_nrt_coupon_send_response>
    <model>
        <discount>10</discount>
        <start_fee>100</start_fee>
        <coupon_name>测试券</coupon_name>
        <coupon_template_id>12345</coupon_template_id>
        <coupon_instance_id>12344</coupon_instance_id>
        <end_time>123345</end_time>
        <start_time>123345</start_time>
    </model>
</tmall_nrt_coupon_send_response>

{
    "tmall_nrt_coupon_send_response":{
        "model":{
            "discount":10,
            "start_fee":100,
            "coupon_name":"测试券",
            "coupon_template_id":12345,
            "coupon_instance_id":12344,
            "end_time":123345,
            "start_time":123345
        }
    }
}

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

错误码	错误描述	解决方案
-7	领取太多了，不要贪心~	已达到发券上限
-6	优惠券已领完，下次早点喔~	券已发完，不可再发或者增加库存
-3	优惠券无效，请联系客服~	券已失效，联系客服
-11	业务异常	联系开发者
-9999	系统异常	联系开发者

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

开放平台

零售终端API

tmall.nrt.coupon.send (券发放接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ