plugin.computePromotion
提供开发者查询平台和商家营销信息以及算价的能力
使用限制
行业插件在抖音 App 版本 31.8.0 及以上,小程序基础库版本 3.4x.0.0 及以上时支持。
语法
plugin.computePromotion(options)
参数说明
options
属性名 | 类型 | 默认值 | 必填 | 说明 | 最低支持版本 |
goodsMarketingInfo | GoodsMarketingInfo[] GoodsMarketingInfo 说明见下文 | | 是 | 商品维度使用的营销 + 商品信息 | 2.51.0.0 |
orderMarketingInfo | OrderMarketingInfo | | 否 | 订单维度使用的营销 | 2.51.0.0 |
needDefaultMarketing | boolean | | 否 | 是否需要返回默认选中营销 | 2.51.0.0 |
callbackData | string | | 否 | 开发者透传字段 | 2.51.0.0 |
success | Function | | 否 | 接口调用成功的回调函数 | 2.51.0.0 |
fail | Function | | 否 | 接口调用失败的回调函数 | 2.51.0.0 |
complete | Function | | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | 2.51.0.0 |
GoodsMarketingInfo
属性名 | 类型 | 默认值 | 必填 | 说明 | 最低支持版本 |
goodsId | string | | 是 | 商品 id | 2.51.0.0 |
skuId | string | | 否 | sku 商品id | 2.51.0.0 |
quantity | number | | 是 | 购买数量 | 2.51.0.0 |
totalAmount | number | | 是 | 商品总价,单位【分】 | 2.51.0.0 |
selectedMarketing | MarketingBundle MarketingBundle 说明见下文 | | 否 | 商品维度选中的营销 | 2.51.0.0 |
OrderMarketingInfo
属性名 | 类型 | 默 认值 | 必填 | 说明 | 最低支持版本 |
totalAmount | number | | 是 | 订单总金额,单位【分】 | 2.51.0.0 |
selectedMarketing | MarketingBundle MarketingBundle 说明见下文 | | 否 | 订单维度选中的营销 | 2.51.0.0 |
MarketingBundle
属性名 | 类型 | 默认值 | 必填 | 说明 | 最低支持版本 |
couponInfo | CouponInfo[] CouponInfo 说明见下文 | | 否 | 优惠券信息 | 2.51.0.0 |
scoreInfo | ScoreInfo[] ScoreInfo 说明见下文 | | 否 | 积分信息 | 2.51.0.0 |
activityInfo | ActivityInfo[] ActivityInfo 说明见下文 | | 否 | 活动信息 | 2.51.0.0 |
CouponInfo
属性名 | 类型 | 默认值 | 必填 | 说明 | 最低支持版本 |
id | string | | 是 | 优惠券 id | 2.51.0.0 |
code | string | | 是 | 优惠券编码 | 2.51.0.0 |
type | number | | 是 | 优惠券类型
| 2.51.0.0 |
name | string | | 是 | 优惠券名称 | 2.51.0.0 |
rule | string | | 否 | 使用规则描述 | 2.51.0.0 |
startTime | number | | 否 | 有效起始时间戳 | 2.51.0.0 |
endTime | number | | 否 | 有效结束时间戳 | 2.51.0.0 |
receiveTime | number | | 否 | 领取时间戳 | 2.51.0.0 |
discountAmount | number | | 否 | 优惠金额,单位 分 | 2.51.0.0 |
deductPercentage | number | | 否 | 折扣千分比,0~1000(1000为最大值,以实际返回值为准) | 2.51.0.0 |
denyReasons | string[] | | 否 | 优惠券不可用原因 | 2.51.0.0 |
detailUrl | string | | 否 | 优惠券详情跳转链接 | 2.51.0.0 |
kind | number | | 是 | 营销类别
| 2.51.0.0 |
creatorType | number | | 是 | 创建人类型
| 2.51.0.0 |
marketingExtend | object | | 否 | 透传字段 | 2.51.0.0 |
ScoreInfo
属性名 | 类型 | 默认值 | 必填 | 说明 | 最低支持版本 |
id | string | | 是 | 积分 id | 2.51.0.0 |
value | number | | 是 | 积分值 | 2.51.0.0 |
name | string | | 是 | 积分名称 | 2.51.0.0 |
kind | number | | 是 | 营销类别
| 2.51.0.0 |
creatorType | number | | 是 | 创建人类型
| 2.51.0.0 |
marketingExtend | object | | 否 | 透传字段 | 2.51.0.0 |
ActivityInfo
属性名 | 类型 | 默认值 | 必填 | 说明 | 最低支持版本 |
id | string | | 是 | 活动 id | 2.51.0.0 |
name | string | | 是 | 活动名称 | 2.51.0.0 |
type | number | | 否 | 1:秒杀 2:运费立减 3:立减 4:会员专享价 5:渠道专享价 6:平台礼金 | 2.51.0.0 |
rule | string | | 是 | 活动规则 | 2.51.0.0 |
startTime | number | | 否 | 活动开始时间戳 | 2.51.0.0 |
endTime | number | | 否 | 活动结束时间戳 | 2.51.0.0 |
kind | number | | 是 | 营销类别
| 2.51.0.0 |
creatorType | number | | 是 | 创建人类型
| 2.51.0.0 |
marketingExtend | object | | 否 | 透传字段 | 2.51.0.0 |
回调成功
object类型
属性名 | 类型 | 说明 |
goodsMarketingList | GoodsMarketing[] GoodsMarketing 说明见下文 | 商品维度营销信息 |
orderMarketing | OrderMarketing OrderMarketing 说明见下文 | 订单维度营销信息 |
calculationResult | CalculationResultInfo CalculationResultInfo 说明见下文 | 算价结果 |
GoodsMarketing
属性名 | 类型 | 默认值 | 必填 | 说明 |
goodsId | string | | 是 | 商品id |
skuId | string | | 否 | sku_id |
quantity | number | | 是 | 商品数量 |
totalAmount | number | | 是 | 商品总价,单位[分] |
availableMarketing | MarketingBundle MarketingBundle 说明见上文 | | 否 | 商品维度可用营销策略 |
unavailableMarketing | MarketingBundle MarketingBundle 说明见上文 | | 否 | 商品维度不可用营销策略 |
OrderMarketing
属性名 | 类型 | 默认值 | 必填 | 说明 |
totalAmount | number | | 是 | 订单总金额,单位[分] |
availableMarketing | MarketingBundle MarketingBundle 说明见上文 | | 否 | 订单维度可用营销策略 |
unavailableMarketing | MarketingBundle MarketingBundle 说明见上文 |