plugin.updateShopMemberPoints
收藏
我的收藏

基础库 3.43.0.0 开始支持本接口。
提供开发者更新会员积分功能,需先调用 plugin.getShopRecordToken 获取 recordToken

前置条件

在使用电商插件中的组件和 API 前,需要对行业插件有一个基本了解,可以参考文档:行业插件介绍,然后按照以下步骤及顺序使用电商插件中的能力:
    1.参考 电商小程序接入指南 完成小程序及资质的准备;
    2.参考 申请行业插件 完成插件的申请,注意只有小程序拥有电商类目资质才可见申请入口;
    3.参考 使用行业插件 进行能力的调用;
行业插件在抖音 App 版本 31.8.0 及以上,小程序基础库版本 3.4x.0.0 及以上时支持。

语法

plugin.updateShopMemberPoints(options);

参数说明

options 为 Object 类型 ,属性如下:
属性名
类型
默认值
必填
说明
最低支持版本
shopId
string
--
当前小程序绑定的抖音小店 id
2.55.0
updateInfo
object
--
积分变动信息
2.55.0
success
function
--
接口调用成功的回调函数
2.55.0
fail
function
--
接口调用失败的回调函数
2.55.0
complete
function
--
接口调用结束的回调函数(调用成功、失败都会执行)
2.55.0

updateInfo 说明

属性名
类型
默认值
必填
说明
最低支持版本
type
number
--
积分变动类型:
    1:增加
    2:减少
2.55.0
amount
number
--
更新数量(最小为1,整数)
2.55.0
recordToken
string
--
更新积分 token ,针对客户端连续操作、异常调用等情况,防止重复更新。调用 plugin.getShopRecordToken 获取 recordToken
2.55.0

回调成功

参数为 Object 类型,属性如下:
参数
参数类型
说明
最低支持版本
errMsg
string
回调信息
2.55.0
recordToken
string
更新积分 token
2.55.0

回调失败

参数为 Object 类型,属性如下:
参数
参数类型
说明
最低支持版本
errLogId
string
错误日志id
2.55.0
errMsg
string
错误信息
2.55.0
errNo
number
错误码
2.55.0

错误码说明

errNo
errMsg
说明
最低支持版本
10101
Platform auth deny
权限错误,不在白名单内;
2.55.0
10301
The feature is only support in Douyin and DonyinLite
仅支持在抖音、抖音Lite实用,当前 App 不支持这个功能
2.55.0
20000
xxx should be string, but got xxx
参数类型校验错误,请检查参数类型
2.55.0
21500
Invalid login status, please check login status
获取宿主 sessionid 失败,用户未登录
2.55.0
21501
Network error
网络错误,请检查网络状况
2.55.0
21502
Server error
服务端网关错误(如 404、502等),请联系客服助手
2.55.0
21850
该用户今日发放积分次数已超过限制
备注:这部分目前上下限规则维护在平台,后续会提供新能力实现开发者注册自己的规则,目前平台通用规则如下
    1.单日单个小程序对单唯一用户 可增加的积分上限3000,扣减上限1000
    2.单日单个小程序对单唯一用户 可增加积分次数上限30 ,扣减次数上限10
*单日:0点-23:59:59
*单小程序:一个小程序 id
*单唯一用户:openid 维度
2.55.0
21851
该用户今日发放积分总额已超过限制
2.55.0
21852
该用户今日消耗积分次数已超过限制
2.55.0
21853
该用户今日消耗积分总额已超过限制
2.55.0
13002
unique key 一致性校验失败
从plugin.getShopRecordToken获取的recordToken,需要即获即用,传入错误的recordToken或者超时过期传入,均会返回校验失败
2.55.0
21701
该用户还不是店铺会员
在某店铺下对用户进行积分增减的前提是,该用户必须是该店铺的会员
2.55.0

代码示例

const plugin = tt.requirePlugin('tt95aee3130ae1cbe911'); function updatePoint() { // 1.获取recordToken plugin.getShopRecordToken({ shopId: "xxxxxxxx", type: 1, success: ({ recordToken }) => { // 2. 更新会员积分 plugin.updateShopMemberPoints({ shopId: "xxxxxxxx", updateInfo: { type: 1, amount: 1, recordToken, // 通过plugin.getShopRecordToken()获取recordToken }, success: (res) => console.log("调用成功", res), fail: (err) => console.log("调用失败", err), }); }, fail: (err) => console.log("调用失败", err), }); }

Bug & Tip

Tip:本 API 依赖于 tt.getShopRecordToken ,请确保调用前调用了此 API 成功获取recordToken

后端接入

开发者注册积分操作时的阈值

接口介绍

该接口用于开发者注册积分操作的阈值。
开发者可以使用该接口新增、修改或者删除对应小程序的积分操作阈值。当开发者没有调用该接口或者删除了已注册的阈值时,系统将会使用默认的限制来进行积分操作阈值判定。

请求(request)

基本信息

请求头

参数名
参数类型
是否必须
备注
示例
Content-Type
string
请求的MIME类型,统一为Application/json
"Application/json"

请求体

参数名
参数类型
是否必须
备注
示例
access_token
string
接口调用凭证(小程序开放平台)
"0801121846735352506a356a67395167574457583155554e67654321"
App_id
string
小程序id
tt5daf2b12c2857910
op_type
int32
操作类型:
1:新增或者修改 2:删除
1
single_add_limit
int64
单次增加积分上限
1000
single_add_limit
int64
单次减少积分上限
500
daily_add_count
int64
单日单用户增加积分次数上限
10
daily_deduct_count
int64
单日单用户减少积分次数上限
20

响应(response)

响应体

参数名
参数类型
备注
示例
err_no
int64
错误码,0为成功
0
err_tips
string
错误内容
"success"
log_id
string
日志id,用于查询错误
"101210271802130982251451520919C123"