淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
rule_id	String	必须	123		规则ID，由接口提供方分配
page_num	Number	可选	2	默认值：0	页码，从0开始
page_size	Number	可选	100	默认值：20	每页大小

名称	类型	示例值	描述
user_rule_info_list	UserRuleInfo []	1	用户规则信息集合
└ open_id String asfashofkasf 用户在TOP上的openId └ version Number 1609754426 每条记录离线任务生成，代表当时离线任务的时间戳 item_list MapData [] 用户对应的商品详细信息 └ sku_id_list Number [] 123456 商品ID对应的sku集合 └ item_id Number 123 商品ID

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
TbkCartCouponExpireUserQueryRequest req = new TbkCartCouponExpireUserQueryRequest();
req.setRuleId("123");
req.setPageNum(2L);
req.setPageSize(100L);
TbkCartCouponExpireUserQueryResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
TbkCartCouponExpireUserQueryRequest req = new TbkCartCouponExpireUserQueryRequest();
req.RuleId = "123";
req.PageNum = 2L;
req.PageSize = 100L;
TbkCartCouponExpireUserQueryResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new TbkCartCouponExpireUserQueryRequest;
$req->setRuleId("123");
$req->setPageNum("2");
$req->setPageSize("100");
$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.cart.coupon.expire.user.query' \
-d 'partner_id=apidoc' \
-d 'sign=B32B7A5A9A8D012F2F22FC165E1320FF' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-01-16+00%3A45%3A58' \
-d 'v=2.0' \
-d 'page_num=2' \
-d 'page_size=100' \
-d 'rule_id=123'

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

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

req.rule_id="123"
req.page_num=2
req.page_size=100
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.cart.coupon.expire.user.query");
add_param(pRequest,"rule_id","123");
add_param(pRequest,"page_num","2");
add_param(pRequest,"page_size","100");
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.cart.coupon.expire.user.query', {
	'rule_id':'123',
	'page_num':'2',
	'page_size':'100'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<tbk_cart_coupon_expire_user_query_response>
    <user_rule_info_list>
        <user_rule_info>
            <open_id>asfashofkasf</open_id>
            <version>1609754426</version>
            <item_list>
                <map_data>
                    <sku_id_list>
                        <number>123456</number>
                    </sku_id_list>
                    <item_id>123</item_id>
                </map_data>
            </item_list>
        </user_rule_info>
    </user_rule_info_list>
</tbk_cart_coupon_expire_user_query_response>

{
    "tbk_cart_coupon_expire_user_query_response":{
        "user_rule_info_list":{
            "user_rule_info":[
                {
                    "open_id":"asfashofkasf",
                    "version":1609754426,
                    "item_list":{
                        "map_data":[
                            {
                                "sku_id_list":{
                                    "number":[
                                        123456
                                    ]
                                },
                                "item_id":123
                            }
                        ]
                    }
                }
            ]
        }
    }
}

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.tbk.cart.coupon.expire.user.query (购物车催付优惠券到期查询用户信息)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ