淘宝开放平台 - 文档中心

请求地址：

环境	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_coupon_template_item_query_request	CouponTemplateItemQueryRequest	可选			请求
└ id Number 可选 1 模板表主键id page_info PageInfo 可选分页信息 └ page_num Number 可选 1 第几页 └ page_size Number 可选 100 每页条数 └ pages Number 可选 10 总共多少页 └ total Number 可选 1000 总共多少条 └ source_id Number 可选 1 ump模板ID user_info UserInfo 可选用户信息 └ user_id Number 可选 32432 用户id └ user_name String 可选 234 用户名称 └ source String 可选 3234 来源 └ logic_group_number Number 可选 213 分组序号 └ wdk_group_id Number 可选 423432 五道口分组id

名称	类型	示例值	描述
result	ApiResult		结果
└ err_code String 参数异常错误码 └ err_msg String 参数异常错误信息 model CouponTemplateOperateResponse 返回 └ id Number 1 模板表主键 page_info PageInfo 分页信息 └ page_num Number 1 第几页 └ page_size Number 100 每页条数 └ pages Number 10 总共多少页 └ total Number 1000 总共多少条 prom_act_sku_list PromActSku [] 券圈品设置 └ logic_group_number Number 213213 商家逻辑分组序号 └ participate_id String 2131 参与者id └ participate_name String 2131 参与者名称 └ participate_type Number 1 参与者类型 └ source_id Number 1 ump模板ID └ success Boolean false 成功标志

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaWdkCouponSkuQueryRequest req = new AlibabaWdkCouponSkuQueryRequest();
AlibabaWdkCouponSkuQueryRequest.CouponTemplateItemQueryRequest obj1 = new AlibabaWdkCouponSkuQueryRequest.CouponTemplateItemQueryRequest();
obj1.setId(1L);
AlibabaWdkCouponSkuQueryRequest.PageInfo obj2 = new AlibabaWdkCouponSkuQueryRequest.PageInfo();
obj2.setPageNum(1L);
obj2.setPageSize(100L);
obj2.setPages(10L);
obj2.setTotal(1000L);
obj1.setPageInfo(obj2);
obj1.setSourceId(1L);
AlibabaWdkCouponSkuQueryRequest.UserInfo obj3 = new AlibabaWdkCouponSkuQueryRequest.UserInfo();
obj3.setUserId(32432L);
obj3.setUserName("234");
obj3.setSource("3234");
obj1.setUserInfo(obj3);
obj1.setLogicGroupNumber(213L);
obj1.setWdkGroupId(423432L);
req.setParamCouponTemplateItemQueryRequest(obj1);
AlibabaWdkCouponSkuQueryResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaWdkCouponSkuQueryRequest req = new AlibabaWdkCouponSkuQueryRequest();
AlibabaWdkCouponSkuQueryRequest.CouponTemplateItemQueryRequestDomain obj1 = new AlibabaWdkCouponSkuQueryRequest.CouponTemplateItemQueryRequestDomain();
obj1.Id = 1L;
AlibabaWdkCouponSkuQueryRequest.PageInfoDomain obj2 = new AlibabaWdkCouponSkuQueryRequest.PageInfoDomain();
obj2.PageNum = 1L;
obj2.PageSize = 100L;
obj2.Pages = 10L;
obj2.Total = 1000L;
obj1.PageInfo= obj2;
obj1.SourceId = 1L;
AlibabaWdkCouponSkuQueryRequest.UserInfoDomain obj3 = new AlibabaWdkCouponSkuQueryRequest.UserInfoDomain();
obj3.UserId = 32432L;
obj3.UserName = "234";
obj3.Source = "3234";
obj1.UserInfo= obj3;
obj1.LogicGroupNumber = 213L;
obj1.WdkGroupId = 423432L;
req.ParamCouponTemplateItemQueryRequest_ = obj1;
AlibabaWdkCouponSkuQueryResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaWdkCouponSkuQueryRequest;
$param_coupon_template_item_query_request = new CouponTemplateItemQueryRequest;
$param_coupon_template_item_query_request->id="1";
$page_info = new PageInfo;
$page_info->page_num="1";
$page_info->page_size="100";
$page_info->pages="10";
$page_info->total="1000";
$param_coupon_template_item_query_request->page_info = $page_info;
$param_coupon_template_item_query_request->source_id="1";
$user_info = new UserInfo;
$user_info->user_id="32432";
$user_info->user_name="234";
$user_info->source="3234";
$param_coupon_template_item_query_request->user_info = $user_info;
$param_coupon_template_item_query_request->logic_group_number="213";
$param_coupon_template_item_query_request->wdk_group_id="423432";
$req->setParamCouponTemplateItemQueryRequest(json_encode($param_coupon_template_item_query_request));
$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=alibaba.wdk.coupon.sku.query' \
-d 'partner_id=apidoc' \
-d 'session=c93f964c-a02b-413c-ac65-2f9cba12c756' \
-d 'sign=F7E0D49C0A64D9F799718BDFAFB12C16' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-25+18%3A51%3A10' \
-d 'v=2.0' \
-d 'param_coupon_template_item_query_request=null'

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

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

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

XML示例
JSON示例

<alibaba_wdk_coupon_sku_query_response>
    <result>
        <err_code>参数异常</err_code>
        <err_msg>参数异常</err_msg>
        <model>
            <id>1</id>
            <page_info>
                <page_num>1</page_num>
                <page_size>100</page_size>
                <pages>10</pages>
                <total>1000</total>
            </page_info>
            <prom_act_sku_list>
                <prom_act_sku>
                    <logic_group_number>213213</logic_group_number>
                    <participate_id>2131</participate_id>
                    <participate_name>2131</participate_name>
                    <participate_type>1</participate_type>
                </prom_act_sku>
            </prom_act_sku_list>
            <source_id>1</source_id>
        </model>
        <success>false</success>
    </result>
</alibaba_wdk_coupon_sku_query_response>

{
    "alibaba_wdk_coupon_sku_query_response":{
        "result":{
            "err_code":"参数异常",
            "err_msg":"参数异常",
            "model":{
                "id":1,
                "page_info":{
                    "page_num":1,
                    "page_size":100,
                    "pages":10,
                    "total":1000
                },
                "prom_act_sku_list":{
                    "prom_act_sku":[
                        {
                            "logic_group_number":213213,
                            "participate_id":"2131",
                            "participate_name":"2131",
                            "participate_type":1
                        }
                    ]
                },
                "source_id":1
            },
            "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下载

开放平台

五道口营销域

alibaba.wdk.coupon.sku.query (优惠券商品查询)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ