淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
query_d_t_o	ErpCouponQueryDto	可选			查询对象
└ page_size Number 必须 10 每页数量 └ page_num Number 必须 1 页码 └ channel String 可选 erp 渠道 └ phone String 可选 18612255668 手机号 └ card_no String 可选 11112222 会员卡号 └ coupon_code String 可选 11111 优惠券code

名称	类型	示例值	描述
result	ResponseResult		response
└ error_code String QUERY_RESULT_EMPTY 错误码 └ error_msg String 查询为空中文描述 result PageResponse 结果 └ current_page Number 1 当前页数 result_arr_list ErpCouponDTO [] 对象 └ status String 0 状态,0,未使用 └ start_date String 2018-11-11 优惠券生效日期 └ serller_id String 111 连锁id └ phone String 18612255668 会员手机号 └ order_amount String 199 满多少金额可以用 └ end_date String 2018-11-11 优惠券失效日期 └ describe String 全场通用描述 └ coupon_name String 满199减99 优惠券名称 └ coupon_id String 11 优惠券模板id └ coupon_code String 111aaa 优惠券code └ coupon_amount String 99 优惠券金额 └ channel String erp 渠道 └ card_no String 1231321111 会员卡号 └ bill_date String 2018-11-11 发放日期 └ attribute String { "firstName":"Bill" , "lastName":"Gates" } 额外属性 └ shop String 01,02 使用的门店 └ category String 1001,10012 适用的品类 └ total_count Number 11 总共有多少记录 └ total_page Number 2 总共有多少页 └ success Boolean false 调用是否成功

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaAlihealthNrCrmCouponQuerycouponRequest req = new AlibabaAlihealthNrCrmCouponQuerycouponRequest();
AlibabaAlihealthNrCrmCouponQuerycouponRequest.ErpCouponQueryDto obj1 = new AlibabaAlihealthNrCrmCouponQuerycouponRequest.ErpCouponQueryDto();
obj1.setPageSize(10L);
obj1.setPageNum(1L);
obj1.setChannel("erp");
obj1.setPhone("18612255668");
obj1.setCardNo("11112222");
obj1.setCouponCode("11111");
req.setQueryDTO(obj1);
AlibabaAlihealthNrCrmCouponQuerycouponResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaAlihealthNrCrmCouponQuerycouponRequest req = new AlibabaAlihealthNrCrmCouponQuerycouponRequest();
AlibabaAlihealthNrCrmCouponQuerycouponRequest.ErpCouponQueryDtoDomain obj1 = new AlibabaAlihealthNrCrmCouponQuerycouponRequest.ErpCouponQueryDtoDomain();
obj1.PageSize = 10L;
obj1.PageNum = 1L;
obj1.Channel = "erp";
obj1.Phone = "18612255668";
obj1.CardNo = "11112222";
obj1.CouponCode = "11111";
req.QueryDTO_ = obj1;
AlibabaAlihealthNrCrmCouponQuerycouponResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaAlihealthNrCrmCouponQuerycouponRequest;
$query_d_t_o = new ErpCouponQueryDto;
$query_d_t_o->page_size="10";
$query_d_t_o->page_num="1";
$query_d_t_o->channel="erp";
$query_d_t_o->phone="18612255668";
$query_d_t_o->card_no="11112222";
$query_d_t_o->coupon_code="11111";
$req->setQueryDTO(json_encode($query_d_t_o));
$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=alibaba.alihealth.nr.crm.coupon.querycoupon' \
-d 'partner_id=apidoc' \
-d 'sign=CB1F5DA43805E3FBB8C516454669FA7C' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-20+07%3A34%3A07' \
-d 'v=2.0' \
-d 'query_d_t_o=null'

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

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

req.query_d_t_o=""
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,"alibaba.alihealth.nr.crm.coupon.querycoupon");
add_param(pRequest,"query_d_t_o","数据结构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',
	'REST_URL': 'http://gw.api.taobao.com/router/rest'
});

client.execute('alibaba.alihealth.nr.crm.coupon.querycoupon', {
	'query_d_t_o':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_alihealth_nr_crm_coupon_querycoupon_response>
    <result>
        <error_code>QUERY_RESULT_EMPTY</error_code>
        <error_msg>查询为空</error_msg>
        <result>
            <current_page>1</current_page>
            <result_arr_list>
                <erp_coupon_d_t_o>
                    <status>0</status>
                    <start_date>2018-11-11</start_date>
                    <serller_id>111</serller_id>
                    <phone>18612255668</phone>
                    <order_amount>199</order_amount>
                    <end_date>2018-11-11</end_date>
                    <describe>全场通用</describe>
                    <coupon_name>满199减99</coupon_name>
                    <coupon_id>11</coupon_id>
                    <coupon_code>111aaa</coupon_code>
                    <coupon_amount>99</coupon_amount>
                    <channel>erp</channel>
                    <card_no>1231321111</card_no>
                    <bill_date>2018-11-11</bill_date>
                    <attribute>{ &quot;firstName&quot;:&quot;Bill&quot; , &quot;lastName&quot;:&quot;Gates&quot; }</attribute>
                    <shop>01,02</shop>
                    <category>1001,10012</category>
                </erp_coupon_d_t_o>
            </result_arr_list>
            <total_count>11</total_count>
            <total_page>2</total_page>
        </result>
        <success>false</success>
    </result>
</alibaba_alihealth_nr_crm_coupon_querycoupon_response>

{
    "alibaba_alihealth_nr_crm_coupon_querycoupon_response":{
        "result":{
            "error_code":"QUERY_RESULT_EMPTY",
            "error_msg":"查询为空",
            "result":{
                "current_page":1,
                "result_arr_list":{
                    "erp_coupon_d_t_o":[
                        {
                            "status":"0",
                            "start_date":"2018-11-11",
                            "serller_id":"111",
                            "phone":"18612255668",
                            "order_amount":"199",
                            "end_date":"2018-11-11",
                            "describe":"全场通用",
                            "coupon_name":"满199减99",
                            "coupon_id":"11",
                            "coupon_code":"111aaa",
                            "coupon_amount":"99",
                            "channel":"erp",
                            "card_no":"1231321111",
                            "bill_date":"2018-11-11",
                            "attribute":"{ \"firstName\":\"Bill\" , \"lastName\":\"Gates\" }",
                            "shop":"01,02",
                            "category":"1001,10012"
                        }
                    ]
                },
                "total_count":11,
                "total_page":2
            },
            "success":false
        }
    }
}

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

阿里健康-CRM

alibaba.alihealth.nr.crm.coupon.querycoupon (ERP调用CRM - 查询优惠券)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ