文档中心 > API类目 > 营销API

taobao.promotion.benefit.selector (权益选择器接口)

权益选择器，查询用户已有权益，提供用户进行已拥有权益的选择操作，权益发放的前置操作 1、目前top的接口只开了1，4，13，14 四种权益, 支付宝红包--1；流量钱包--4；优酷会员--13；彩票-- 14
2、目前只有"支付宝红包"有"benefit_type": "ALIPAY_COUPON",其它三个没有benefit_type
3、接口文档中写的优酷会员卡--2 写错了，正确的是13（已接口返回为准）
4、step=2用config_id查，即1，4，13，14
5、step=3权益id指具体采购的权益id，可以认为是采购的主键（权益id 可以通过step=2 获得）

公共参数

请求地址：

环境	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	BenefitSelectorQuery	必须			权益选择器请求
└ benefit_id Number 可选 4342321 权益id（步骤3必填） └ benefit_type String 可选 ALIPAY_COUPON 权益类型（步骤2,3必填） └ config_id Number 可选 1 新权益类型id └ exclude_options Number 可选 2 需要过滤的option └ step Number 必须 1 选择器步骤可选1,2,3，1：展示卖家能够选择的权益类型2：必填BenefitType，展示卖家该种类型下的权益3：必填BenefitType和benefitId，展示卖家该权益的详情 └ current_page Number 可选 1 选择器步骤选择2时，查询指定类型权益列表分页查询参数 └ page_size Number 可选 20 选择器步骤选择2时，查询指定类型权益列表分页查询参数 └ page_query_request Boolean 可选 false 传true时列表进行分页查询，分页查询时不会对发放完的模板过滤；传false时分页查询的current_page和page_size不传，接口语义和之前一致。

响应参数

名称	类型	示例值	描述
benefit_list	BenefitSelectorVo []		权益列表信息
└ benefit_name String 支付宝红包权益名称 └ benefit_type String ALIPAY_COUPON 权益类型 └ benefit_type_long Number 123 权益类型id pack_detail_list BenefitTemplateVo [] 详情list └ benefit_id Number 12335232 权益id └ denomination Number 500 面额 └ end_time Date 2015-06-10 15:06:53 结束时间 └ extend_feature String {key:value} 扩展信息 └ out_object_id String 201591203012519295912993129 外部关联id（如支付宝红包模板id） └ out_object_name String 支付宝红包1 外部关联名称 └ relate_activity_num Number 10 关联活动数 └ start_time Date 2015-06-10 15:06:53 开始时间 └ status Number 1 状态 └ valid_total_num Number 5 可用总数 └ template_total_count Number 35 选择器步骤选择2时，查询指定类型权益列表分页查询返回值，数据总量
is_success	Boolean	true	接口调用是否成功

请求示例

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
PromotionBenefitSelectorRequest req = new PromotionBenefitSelectorRequest();
PromotionBenefitSelectorRequest.BenefitSelectorQuery obj1 = new PromotionBenefitSelectorRequest.BenefitSelectorQuery();
obj1.setBenefitId(4342321L);
obj1.setBenefitType("ALIPAY_COUPON");
obj1.setConfigId(1L);
obj1.setExcludeOptions(2L);
obj1.setStep(1L);
obj1.setCurrentPage(1L);
obj1.setPageSize(20L);
obj1.setPageQueryRequest(false);
req.setQuery(obj1);
PromotionBenefitSelectorResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

响应示例

XML示例
JSON示例

<promotion_benefit_selector_response>
    <benefit_list>
        <benefit_selector_vo>
            <benefit_name>支付宝红包</benefit_name>
            <benefit_type>ALIPAY_COUPON</benefit_type>
            <benefit_type_long>123</benefit_type_long>
            <pack_detail_list>
                <benefit_template_vo>
                    <benefit_id>12335232</benefit_id>
                    <denomination>500</denomination>
                    <end_time>2015-06-10 15:06:53</end_time>
                    <extend_feature>{key:value}</extend_feature>
                    <out_object_id>201591203012519295912993129</out_object_id>
                    <out_object_name>支付宝红包1</out_object_name>
                    <relate_activity_num>10</relate_activity_num>
                    <start_time>2015-06-10 15:06:53</start_time>
                    <status>1</status>
                    <valid_total_num>5</valid_total_num>
                </benefit_template_vo>
            </pack_detail_list>
            <template_total_count>35</template_total_count>
        </benefit_selector_vo>
    </benefit_list>
    <is_success>true</is_success>
</promotion_benefit_selector_response>

异常示例

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>

错误码解释

错误码	错误描述	解决方案
isv.param-error:112	入参为空	检查入参
isv.param-error:203	发放者id为空	填写发放者id
isv.param-error:2010	活动id为空	填写活动id
isv.param-error:295	活动详情未创建	创建活动详情
isp.param-error:100	操作太频繁	请勿频繁操作
isp.param-error:102	系统繁忙	系统繁忙，请稍后再试
isp.param-error:301	请勿重复操作	请勿重复操作
isv.param-error:250	选择发放的权益不存在	请先去创建权益
isp.param-error:236	发放失败	发放失败，请检查传入参数是否正确并稍后再试
isv.param-error:225	接收者不存在	请填写正确的接收者id
isv.param-error:226	权益不存在，发放失败	权益不存在，请设置正确的权益
isp.param-error:101	流水记录写入失败	请查看发放列表信息是否正确，若异常，请联系相关人员
isp.param-error:214	红包发放失败	系统异常，发放失败，请稍后再试
isv.param-error:2011	步骤参数为空	请填写步骤参数

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

营销API