淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
biz_type	Number	必须	1		业务类型：0：积分计算 1：等级升级计算 2：等级降级计算
open_uid	String	可选	123		open_uid
buyer_nick	String	必须	fdfds1121aad		混淆过的买家昵称
biz_order_id	Number	可选	11111		订单Id
end_date_by_year	String	可选	05-11		每年几月几日结束
exclude_item	String	可选	111,222		排除商品列表
freight_fee	String	可选	5.0		运费，单位元
item_amount_map	Json	可选	{}		商品及对应价格列表，价格为分
month_end_day	Number	可选	11		每月几日结束
month_start_day	Number	可选	1		每月几日开始
query_end_date	String	可选	2017-05-11		活动结束日期
query_start_date	String	可选	2017-05-01		活动开始日期
special_item	String	可选	111,222		特殊商品列表
specify_amount	String	可选	10.0		指定消费金额，单位元
specify_amount_by_date	String	可选	100.0		按日期指定消费金额，单位元
specify_amount_by_day	String	可选	100.0		按天指定消费金额，单位元
specify_count_by_date	Number	可选	5	默认值：0	指定消费笔数
specify_count_by_day	Number	可选	5	默认值：0	按日期指定消费笔数
start_date_by_year	String	可选	5		按天指定消费笔数
stat_type	Number	可选	1		累计类型，0：半年，1：1年，2：2年
total_item_set	Number []	可选	11,22	最大列表长度：20	总的商品列表
total_pay_amount	Number	可选	10000		总消费金额，单位分
user_id	Number	可选	12121		买家Id
week_end_day	Number	可选	7		每周几结束
week_start_day	Number	可选	6		每周几开始
param_map	Json	可选	{}		规则执行参数

名称	类型	示例值	描述
result	RuleResultDto	规则计算结果	result
└ app_key String 1111 appKey └ biz_order_id Number 11212 bizOrderId └ biz_type Number 1 bizType └ grade Number 等级编码 grade └ points String 积分结果 points └ rule_instance_id Number 1111 ruleInstanceId

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
OpencrmRuleExeruleRequest req = new OpencrmRuleExeruleRequest();
req.setBizType(1L);
req.setOpenUid("123");
req.setBuyerNick("fdfds1121aad");
req.setBizOrderId(11111L);
req.setEndDateByYear("05-11");
req.setExcludeItem("111,222");
req.setFreightFee("5.0");
req.setItemAmountMapString("{}");
req.setMonthEndDay(11L);
req.setMonthStartDay(1L);
req.setQueryEndDate("2017-05-11");
req.setQueryStartDate("2017-05-01");
req.setSpecialItem("111,222");
req.setSpecifyAmount("10.0");
req.setSpecifyAmountByDate("100.0");
req.setSpecifyAmountByDay("100.0");
req.setSpecifyCountByDate(5L);
req.setSpecifyCountByDay(5L);
req.setStartDateByYear("5");
req.setStatType(1L);
req.setTotalItemSet("11,22");
req.setTotalPayAmount(10000L);
req.setUserId(12121L);
req.setWeekEndDay(7L);
req.setWeekStartDay(6L);
req.setParamMapString("{}");
OpencrmRuleExeruleResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
OpencrmRuleExeruleRequest req = new OpencrmRuleExeruleRequest();
req.BizType = 1L;
req.OpenUid = "123";
req.BuyerNick = "fdfds1121aad";
req.BizOrderId = 11111L;
req.EndDateByYear = "05-11";
req.ExcludeItem = "111,222";
req.FreightFee = "5.0";
req.ItemAmountMap = "{}";
req.MonthEndDay = 11L;
req.MonthStartDay = 1L;
req.QueryEndDate = "2017-05-11";
req.QueryStartDate = "2017-05-01";
req.SpecialItem = "111,222";
req.SpecifyAmount = "10.0";
req.SpecifyAmountByDate = "100.0";
req.SpecifyAmountByDay = "100.0";
req.SpecifyCountByDate = 5L;
req.SpecifyCountByDay = 5L;
req.StartDateByYear = "5";
req.StatType = 1L;
req.TotalItemSet = "11,22";
req.TotalPayAmount = 10000L;
req.UserId = 12121L;
req.WeekEndDay = 7L;
req.WeekStartDay = 6L;
req.ParamMap = "{}";
OpencrmRuleExeruleResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new OpencrmRuleExeruleRequest;
$req->setBizType("1");
$req->setOpenUid("123");
$req->setBuyerNick("fdfds1121aad");
$req->setBizOrderId("11111");
$req->setEndDateByYear("05-11");
$req->setExcludeItem("111,222");
$req->setFreightFee("5.0");
$req->setItemAmountMap("{}");
$req->setMonthEndDay("11");
$req->setMonthStartDay("1");
$req->setQueryEndDate("2017-05-11");
$req->setQueryStartDate("2017-05-01");
$req->setSpecialItem("111,222");
$req->setSpecifyAmount("10.0");
$req->setSpecifyAmountByDate("100.0");
$req->setSpecifyAmountByDay("100.0");
$req->setSpecifyCountByDate("5");
$req->setSpecifyCountByDay("5");
$req->setStartDateByYear("5");
$req->setStatType("1");
$req->setTotalItemSet("11,22");
$req->setTotalPayAmount("10000");
$req->setUserId("12121");
$req->setWeekEndDay("7");
$req->setWeekStartDay("6");
$req->setParamMap("{}");
$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=taobao.opencrm.rule.exerule' \
-d 'partner_id=apidoc' \
-d 'session=af7fc812-8e23-48e3-9141-60ab6845831c' \
-d 'sign=BEAB7C839CA6B06947C21FD852DB032C' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-18+16%3A32%3A45' \
-d 'v=2.0' \
-d 'biz_order_id=11111' \
-d 'biz_type=1' \
-d 'buyer_nick=fdfds1121aad' \
-d 'end_date_by_year=05-11' \
-d 'exclude_item=111%2C222' \
-d 'freight_fee=5.0' \
-d 'item_amount_map=%7B%7D' \
-d 'month_end_day=11' \
-d 'month_start_day=1' \
-d 'open_uid=123' \
-d 'param_map=%7B%7D' \
-d 'query_end_date=2017-05-11' \
-d 'query_start_date=2017-05-01' \
-d 'special_item=111%2C222' \
-d 'specify_amount=10.0' \
-d 'specify_amount_by_date=100.0' \
-d 'specify_amount_by_day=100.0' \
-d 'specify_count_by_date=5' \
-d 'specify_count_by_day=5' \
-d 'start_date_by_year=5' \
-d 'stat_type=1' \
-d 'total_item_set=11%2C22' \
-d 'total_pay_amount=10000' \
-d 'user_id=12121' \
-d 'week_end_day=7' \
-d 'week_start_day=6'

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

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

req.biz_type=1
req.open_uid="123"
req.buyer_nick="fdfds1121aad"
req.biz_order_id=11111
req.end_date_by_year="05-11"
req.exclude_item="111,222"
req.freight_fee="5.0"
req.item_amount_map="{}"
req.month_end_day=11
req.month_start_day=1
req.query_end_date="2017-05-11"
req.query_start_date="2017-05-01"
req.special_item="111,222"
req.specify_amount="10.0"
req.specify_amount_by_date="100.0"
req.specify_amount_by_day="100.0"
req.specify_count_by_date=5
req.specify_count_by_day=5
req.start_date_by_year="5"
req.stat_type=1
req.total_item_set="11,22"
req.total_pay_amount=10000
req.user_id=12121
req.week_end_day=7
req.week_start_day=6
req.param_map="{}"
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,"taobao.opencrm.rule.exerule");
add_param(pRequest,"biz_type","1");
add_param(pRequest,"open_uid","123");
add_param(pRequest,"buyer_nick","fdfds1121aad");
add_param(pRequest,"biz_order_id","11111");
add_param(pRequest,"end_date_by_year","05-11");
add_param(pRequest,"exclude_item","111,222");
add_param(pRequest,"freight_fee","5.0");
add_param(pRequest,"item_amount_map","{}");
add_param(pRequest,"month_end_day","11");
add_param(pRequest,"month_start_day","1");
add_param(pRequest,"query_end_date","2017-05-11");
add_param(pRequest,"query_start_date","2017-05-01");
add_param(pRequest,"special_item","111,222");
add_param(pRequest,"specify_amount","10.0");
add_param(pRequest,"specify_amount_by_date","100.0");
add_param(pRequest,"specify_amount_by_day","100.0");
add_param(pRequest,"specify_count_by_date","5");
add_param(pRequest,"specify_count_by_day","5");
add_param(pRequest,"start_date_by_year","5");
add_param(pRequest,"stat_type","1");
add_param(pRequest,"total_item_set","11,22");
add_param(pRequest,"total_pay_amount","10000");
add_param(pRequest,"user_id","12121");
add_param(pRequest,"week_end_day","7");
add_param(pRequest,"week_start_day","6");
add_param(pRequest,"param_map","{}");
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('taobao.opencrm.rule.exerule', {
	'biz_type':'1',
	'open_uid':'123',
	'buyer_nick':'fdfds1121aad',
	'biz_order_id':'11111',
	'end_date_by_year':'05-11',
	'exclude_item':'111,222',
	'freight_fee':'5.0',
	'item_amount_map':'{}',
	'month_end_day':'11',
	'month_start_day':'1',
	'query_end_date':'2017-05-11',
	'query_start_date':'2017-05-01',
	'special_item':'111,222',
	'specify_amount':'10.0',
	'specify_amount_by_date':'100.0',
	'specify_amount_by_day':'100.0',
	'specify_count_by_date':'5',
	'specify_count_by_day':'5',
	'start_date_by_year':'5',
	'stat_type':'1',
	'total_item_set':'11,22',
	'total_pay_amount':'10000',
	'user_id':'12121',
	'week_end_day':'7',
	'week_start_day':'6',
	'param_map':'{}'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<opencrm_rule_exerule_response>
    <result>
        <app_key>1111</app_key>
        <biz_order_id>11212</biz_order_id>
        <biz_type>1</biz_type>
        <grade>等级编码</grade>
        <points>积分结果</points>
        <rule_instance_id>1111</rule_instance_id>
    </result>
</opencrm_rule_exerule_response>

{
    "opencrm_rule_exerule_response":{
        "result":{
            "app_key":"1111",
            "biz_order_id":11212,
            "biz_type":1,
            "grade":等级编码,
            "points":"积分结果",
            "rule_instance_id":1111
        }
    }
}

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.opencrm.rule.exerule (规则计算服务接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ