权益池配置,请联系对接的运营小二在 营销权益平台 配置,奖池疑问请咨询@书牧、菜问
代码示例
/**
* 权益单个发放接口(通用)
* doc:https://lark.alipay.com/tmall-marketing-tools/benefit-helps/avqrb7
* @params options
* activityCode 活动code,由权益平台生成(必填)
* sellerID 卖家ID,如果只抽某一商家的权益,需要传(非必填)
* groupName 权益分组ID(非必填),使用该参数,权益池必须开启“按奖品抽奖”规则,指定权益分组发放,一次调用只发放一个权益;
* selectBenefits 权益ID列表(权益ID为字符串形式,非必填),使用该参数,权益池必须开启“按奖品抽奖”规则,指定权益发放,注意:传入多个权益ID,系统也只发放其中一个;
* extraData Map,json格式传入,重要的key如下:sign:如果开启权益透出规则,则需要根据渠道判断是否需要传入;无特殊情况,建议不要开启该规则;WIN_MARK:中奖记录标识,可以标识跨权益池的中奖纪录,非必传;SEND_CHANNEL:发放渠道标识,建议都传,值自定义即可,标识业务渠道;
* isMtop 是否mtop接口,默认true
* asac 安全码,由运营申请,必传
*/
Tida.fetchBenefit({
asac: "1AAAAAA",
activityCode: "75DC75DC75DC",
sellerID: "xxx"
}, function (e) {
$("#api-result textarea").text('drawback:' + JSON.stringify(e));
}, function (e) {
$("#api-result textarea").text('error:' + JSON.stringify(e));
});
中奖返回结果
//奖品类型为品类券(plCoupon)
{
"api": "mtop.tmw.benefit.issue",
"data": {
"code": "0",
"data": {
"benefitID": "17534001",
"benefitName": "品类券测试",
"benefitTemplateID": "1851001",
"benefitType": "plCoupon",
"extra": {
"amount": "10",
"resourceCode": "403127710020",
"couponTag": "44158001",
"startFee": "100",
"days": null,
"memo": "10元品类券",
"startTime": "2018-02-08 09:58:33",
"endTime": "2018-03-06 23:59:59",
"title": "测试品类",
"useDesc": "手机商品测试品类券"
},
"groupId": "0",
"isWin": "true",
"nick": "一**y",
"reasons": [],
"winningRecordId": "6130280041",
"winningTime": "2018-02-27 17:14:24"
},
"msg": "SUCCESS",
"retry": "false",
"succ": "true"
},
"ret": [
"SUCCESS::调用成功"
],
"v": "1.0"
}
//奖品类型为天猫购物券(tmallCoupon)
{
"api": "mtop.tmw.benefit.issue",
"data": {
"succ":"true",
"code": "0",
"data": {
"nick":"c**1",
"benefitName": "0322购物券02",
"benefitType": "tmallCoupon",
"groupId":1,
"benefitID":"1980002",
"extra": {
"subType":"brandCoupon", //购物券类型
"amount": "5",
"effectDay": 1, //几天内失效, 如果有效期是相对时间的话
"startFee": "10.0",
"name": "测试购物券", //在营销平台配置的购物券的名称
"canGrowth":"true",
"startDate":"2017-03-01 00:00:00", //如果有效期是绝对时间的话
"endDate":"2017-03-31 00:00:00" //如果有效期是绝对时间的话
},
"isWin": "true",
"reasons": [],
"winningRecordId": "1980002",
"winningTime":"2017-03-21 12:13:20"
},
"msg": "SUCCESS",
"retry": "false"
},
"ret": [
"SUCCESS::调用成功"
],
"v": "1.0"
}
//奖品类型为现金红包(fpRedEnvelope)
{
"api": "mtop.tmw.benefit.issue",
"data": {
"code": "0",
"data": {
"benefitID": "17441004",
"benefitName": "38新人测试小红包",
"benefitTemplateID": "1779001",
"benefitType": "fpRedEnvelope",
"extra": {
"gmtEffective": null,
"gmtExpired": null,
"amount": "0.01",
"amountCents": "1",
"resourceCode": "1083587800019101",
"effectiveIntervalDesc": "1天0小时0分",
"effectiveInterval": "86400",
"memo": null,
"threshold": null,
"subType": "fpRedEnvelope"
},
"groupId": "0",
"isWin": "true",
"nick": "一**y",
"reasons": [],
"winningRecordId": "6130240038",
"winningTime": "2018-02-27 16:35:48"
},
"msg": "SUCCESS",
"retry": "false",
"succ": "true"
},
"ret": [
"SUCCESS::调用成功"
],
"v": "1.0"
}
//奖品类型为互动店铺优惠券(interactCoupon)
{
"api": "mtop.tmw.benefit.issue",
"data": {
"code": "0",
"data": {
"benefitID": "21002",
"benefitName": "0327超市店铺券1",
"benefitType": "interactCoupon",
"extra": {
"amount": "1",
"startDate": "2017-02-23 00:00:00",
"shopName": "B2C小店68",
"shopId": "58498830",
"sellerId": "263693041",
"startFee": "1.01",
"endDate": "2017-03-31 23:59:59"
},
"groupId": "1",
"isWin": "true",
"nick": "w**k",
"reasons": [],
"winningRecordId": "7400010",
"winningTime": "2017-03-27 21:20:14"
},
"msg": "SUCCESS",
"retry": "false",
"succ": "true"
},
"ret": [
"SUCCESS::调用成功"
],
"v": "1.0"
}
//奖品类型为天猫超市品牌券(tmcsBrandCoupon)
{
"api": "mtop.tmw.benefit.issue",
"data": {
"code": "0",
"data": {
"benefitID": "21001",
"benefitName": "0327超市品牌券1",
"benefitType": "tmcsBrandCoupon",
"extra": {
"amount": "50",
"startDate": "2017-03-16 00:00:00",
"shopName": "天猫超市",
"shopId": "67597230",
"sellerId": "725677994",
"startFee": "50.01",
"endDate": "2017-03-30 23:59:59"
},
"groupId": "1",
"isWin": "true",
"nick": "c**0",
"reasons": [],
"winningRecordId": "7400009",
"winningTime": "2017-03-27 20:51:08"
},
"msg": "SUCCESS",
"retry": "false",
"succ": "true"
},
"ret": [
"SUCCESS::调用成功"
],
"v": "1.0"
}
{
// 对应的奖品类型为定向优惠(finalPrice)
"api": "mtop.tmw.benefit.issue",
"data": {
"code": "0",
"data": {
"benefitID": "19014072",
"benefitName": "日本环球影城大门票",
"benefitTemplateID": "2858061",
"benefitType": "finalPrice",
"extra": {
"itemId": "570165848161",
//商品id
"userBenefitUnEffectiveTime": "1528795866089",
"tagPeriod": "1440",
// 标签有效期
"itemPic": "//gw.alicdn.com/tfs/i7/TB1_EPzgsj_B1NjSZFHTTeDWpXa_095011.jpg",
// 商品图片
"finalPrice": "0.01",
//最终价格
"memo": null,
"userBenefitEffectiveTime": "1528709466089",
"originPrice": "465"
// 原始价格
},
"groupId": "0",
"isWin": "true",
"nick": "酱**0",
"reasons": [],
"winningRecordId": "8917180114",
"winningTime": "2018-06-11 17:31:05"
},
"msg": "SUCCESS",
"retry": "false",
"succ": "true"
},
"ret": [
"SUCCESS::调用成功"
],
"v": "1.0"
}
//奖品类型为淘票票券(taoFilmCoupon)
{
"api": "mtop.tmw.benefit.issue",
"data": {
"code": "0",
"data": {
"benefitID": "18312003",
"benefitName": "习心淘票票测试",
"benefitTemplateID": "2308001",
"benefitType": "taoFilmCoupon",
"extra": {
"amount": "1",
"generalDesc": "【压测】预发压测专用",
"productId": "8416",
"endDate": "2018-12-03 17:45:50",
"effectiveInterval": "2",
"startFee": "0",
"title": "支付新测试",
"itemTitleDesc": "【压测】预发压测专用",
"startDate": "2018-01-18 13:23:59"
},
"groupId": "0",
"isWin": "true",
"nick": "一**y",
"reasons": [],
"winningRecordId": "6965900020",
"winningTime": "2018-04-16 10:31:59"
},
"msg": "SUCCESS",
"retry": "false",
"succ": "true"
},
"ret": [
"SUCCESS::调用成功"
],
"v": "1.0"
}
{ // 类型为商品优惠券
"api": "mtop.tmw.benefit.issue",
"data": {
"code": "0",
"data": {
"benefitID": "18554084",
"benefitName": "250商品券",
"benefitTemplateID": "2509044",
"benefitType": "interactItemCoupon",
"extra": {
"activityId": "cd243832766043abb76f4348794e022a",
"amount": "250",
"itemIds":"38779996128",
"sellerId": "263669477",
"endDate": "2018-06-30 23:59:59",
"startFee": "1000.0",
"shopName": "B2C小店25",
"memo": null,
"shopId": "58498348",
"shopUrl": null,
"startDate": "2018-05-01 00:00:00"
},
"groupId": "0",
"isWin": "true",
"nick": "酱**0",
"reasons": [],
"winningRecordId": "7350060027",
"winningTime": "2018-05-22 19:11:59"
},
"msg": "SUCCESS",
"retry": "false",
"succ": "true"
},
"ret": [
"SUCCESS::调用成功"
],
"v": "1.0"
}
{//奖品类型为购物津贴(shopBonus)
"api": "mtop.tmw.benefit.issue",
"data": {
"code": "0",
"data": {
"benefitID": "18768006",
"benefitName": "618测试-购物津贴",
"benefitTemplateID": "2602006",
"benefitType": "shopBonus",
"extra": {
"amount": "10",
"endDate": "2018-06-17 17:11:09",
"campaignId": "44570001",
"name": "618测试",
"memo": null,
"sendMode": "0",
"effectDay": null,
"canGrowth": null,
"startDate": "2018-03-19 17:30:09",
"useDesc": "618测试11"
},
"groupId": "0",
"isWin": "true",
"nick": "酱**0",
"reasons": [],
"winningRecordId": "7204060001",
"winningTime": "2018-05-12 14:08:17"
},
"msg": "SUCCESS",
"retry": "false",
"succ": "true"
},
"ret": [
"SUCCESS::调用成功"
],
"v": "1.0"
}
{// 智慧门店优惠券,奖品类型为smartStoreShopCoupon
"msg": "SUCCESS",
"code": "0",
"succ": true,
"data": {
"reasons": [],
"extraData": null,
"benefitType": "smartStoreShopCoupon",
"groupId": 0,
"innerErrorCode": null,
"responseData": null,
"benefitID": 18767001,
"benefitPoolID": 968001,
"userId": null,
"isWin": true,
"winningRecordId": 7199580037,
"nick": "e**4",
"winningTime": 1526057779740,
"innerErrorDesc": null,
"benefitTemplateID": 2651001,
"benefitName": "测试",
"extra": {
"activityId": "14ca5fc97669448380768fac23799fa6",
"amount": "2",
"sellerId": "2649119619",
"endDate": "2018-05-24 23:59:59",
"effectiveInterval": null,
"startFee": "2.01",
"shopName": "阿里掌柜测试帐号",
"memo": null,
"shopId": "130963546",
"source": null,
"shopUrl": null,
"startDate": "2018-05-03 00:00:00"
},
},
"success": true,
"retry": false
}
{// 对应的类型为赠品券
"api": "mtop.tmw.benefit.issue",
"data": {
"code": "0",
"data": {
"benefitID": "18888001",
"benefitName": "友德赠品券测试21",
"benefitTemplateID": "2741006",
"benefitType": "giftCoupon",
"extra": {
"couponName": "ceshi2",
"applyEndTime": "2018-05-31 23:59:59",
"brandName": "B2C小店25",
"TRACE_TTID": "11320@taobao_android_5.0.0",
"effectiveEndTime": "2018-05-31 23:59:59",
"templateCode": "8",
"itemDesc": "林清轩",
"storeId": "189962457",
"applyStartTime": "2018-05-17 17:51:37",
"effectiveStartTime": "2018-05-18 00:00:00",
"activityId": "15c6aec4d9044a02aa0daa1a764165e8",
"itemName": "林清轩",
"sellerId": "263669477",
"itemPic": "//img.alicdn.com/imgextra/i4/263669477/TB2cx8PrYuWBuNjSszgXXb8jVXa_!!263669477-0-eapfm.jpeg",
"couponType": "275"
},
"groupId": "0",
"isWin": "true",
"nick": "酱**0",
"reasons": [],
"winningRecordId": "7267940072",
"winningTime": "2018-05-17 21:37:05"
},
"msg": "SUCCESS",
"retry": "false",
"succ": "true"
},
"ret": [
"SUCCESS::调用成功"
],
"v": "1.0"
}
{//猫粮,奖品类型为catFood
"api": "mtop.tmw.benefit.issue",
"data": {
"code": "0",
"data": {
"benefitID": "18766001",
"benefitName": "测试猫粮",
"benefitTemplateID": "2616001",
"benefitType": "catFood",
"extra": {
"amount": "50",
"TRACE_TTID": "11320@taobao_android_5.0.0",
"memo": "这是测试,领了也不会有优惠"
},
"groupId": "0",
"isWin": "true",
"nick": "酱**0",
"reasons": [],
"winningRecordId": "7204060002",
"winningTime": "2018-05-12 14:13:16"
},
"msg": "SUCCESS",
"retry": "false",
"succ": "true"
},
"ret": [
"SUCCESS::调用成功"
],
"v": "1.0"
}
不中奖返回结果
{
"api": "mtop.tmw.benefit.issue",
"data": {
"succ":"true",
"code": "0",
"data": {
"isWin": "false",
"reasons": [] //有些原因过滤掉
},
"msg": "SUCCESS",
"retry": "false"
},
"ret": [
"SUCCESS::调用成功"
],
"v": "1.0"
}
错误返回结果
{
"api": "mtop.tmw.benefit.issue",
"data": {
"succ":"false",
"code": "-1",
"msg": "SYS_ERR",
"retry": "false"
},
"ret": [
"UNKNOWN_FAIL_CODE::UNKNOWN_FAIL_MSG"
],
"v": "1.0"
}