• JS API 列表
  • 基础
  • TTML
  • 网络
  • 媒体
  • 地图
  • 文件
  • 数据缓存
  • 地理位置
  • 设备
  • 画布
  • 界面
  • 页面导航
  • 开放接口
  • 登录
  • 用户信息
  • 广告
  • 支付
  • 分享
  • 小程序跳转
  • 抖音视频能力
  • 收货地址
  • 设置
  • 授权
  • 评价能力
  • 数据分析
  • 视频拍摄器
  • 引导关注
  • 订阅消息
  • 电商插件能力(即将废弃)
  • 会员运营
  • 权益核销
  • (即将废弃)tt.applyEcCoupon
  • 流量引导
  • 导购成交
  • 商品和订单查询
  • C2B 定制
  • (即将废弃)tt.openEcCart
  • (即将废弃)tt.openEcOrder
  • (即将废弃)tt.getShopRecordToken
  • (即将废弃)tt.updateShopMemberPoints
  • 流量来源识别
  • 隐私信息授权
  • web化
  • 转发和挂载
  • 侧边栏能力
  • 直播能力
  • AI/AR能力
  • 安全能力
  • 行业开放
  • 第三方平台
  • 其它
  • 注意
    本文档即将废弃,新文档请参见 plugin.applyEcCoupon
    基础库 2.74.0.0 开始支持本接口,使用时可用 tt.canIUse 判断是否可用。
    提供开发者发放抖店优惠券能力,仅支持抖音 App 和抖音极速版 App。
    在使用行业相关的组件和 API 前,需要在代码中配置行业 SDK 的权限:行业 SDK 的权限配置,行业 SDK 的权限配置在基础库 2.74.0.0 抖音版本 23.0 以上支持。

    语法

    tt.ApplyEcCoupon(options);

    配券后台操作

    整理如下链路说明。
    在商家开发者进行开发之前,需要开发者或者商家前往抖店后台进行优惠券的配置。
    配置后的优惠券请同步优惠券 id 到开发者,以备开发者在页面调用。
    以下介绍如何完成优惠券的配置。

    step1 登录抖店后台

    step2 创建小程序所需优惠券

      1.选择【商品优惠券】或【全店通用券】
      2.在选择【商品优惠券】或【全店通用券】后选择【自有渠道】,即选择这个创建的优惠券才能用于小程序
      3.新建自有渠道券

    step3 获取优惠券 id 给到开发者

    注意:
      1.一定要选择私有渠道券
      2.券配置后小程序一旦上线不要改动优惠券
    以下介绍 api 部分。

    参数说明

    options 为 Object 类型,属性如下:
    属性名
    类型
    默认值
    必填
    说明
    最低支持版本
    shopId
    string
    --
    当前小程序绑定的抖音小店id
    2.48.0
    couponMetaId
    string
    --
    本次发放券的券批次id
    2.48.0
    couponCount
    number
    1
    本次发放券的券数量
    2.78.0
    success
    function
    --
    接口调用成功的回调函数
    2.48.0
    fail
    function
    --
    接口调用失败的回调函数
    2.48.0
    complete
    function
    --
    接口调用结束的回调函数(调用成功、失败都会执行)
    2.48.0

    回调成功

    参数为 Object 类型,属性如下:
    参数
    参数类型
    说明
    最低支持版本
    errMsg
    string
    回调信息
    2.48.0
    couponIdList
    array
    发券的券码列表
    2.48.0

    回调失败

    参数为 Object 类型,属性如下:
    参数
    参数类型
    说明
    最低支持版本
    errNo
    number
    错误码
    2.48.0
    errMsg
    string
    错误信息
    2.48.0
    错误码说明:
    errNo
    errMsg
    说明
    最低支持版本
    10101
    Platform auth deny
    权限错误,不在白名单内;
    2.48.0
    10301
    The feature is only support in Douyin and DonyinLite
    仅支持在抖音、抖音Lite实用,当前 App 不支持这个功能
    2.48.0
    20000
    xxx should be string, but got xxx
    参数类型校验错误,请检查参数类型
    2.48.0
    21500
    Invalid login status, please check login status
    获取宿主 sessionid 失败,用户未登录
    2.48.0
    21501
    Network error
    网络错误,请检查网络状况
    2.48.0
    21502
    Server error
    服务端网关错误(如 404、502等),请联系客服助手
    2.48.0
    21611
    优惠券不存在
    优惠券批次ID传入有误,请检查是否存在
    2.48.0
    21612
    用户达到此券领取上限
    2.48.0
    21613
    店铺新人才可领取此券
    2.48.0
    21616
    优惠券状态不可领取
    请检查优惠券配置
    2.48.0
    21617
    优惠券不在可领时间内
    2.48.0
    21623
    库存没有了
    2.48.0
    13000
    系统错误
    服务内部错误,请稍后重试或是联系客服
    2.48.0

    代码示例

    <button type="default" size="default" bindtap="ApplyEcCoupon"> 点击领券 </button>
    // 代码示例 Page({ ApplyEcCoupon(e) { tt.ApplyEcCoupon({ shopId: "1234354", couponMetaId: "11122", couponCount: 1, success(res) { console.log("券码列表", res.couponIdList); // 可以使用couponIdList做后续逻辑 console.log("调用成功", res); }, fail(res) { console.log("调用失败", res); }, }); }, });

    Bug & Tip

      Tip:使用该接口时需要用户身份信息,请确保在调用接口前,用户已经登录宿主 App;
      Tip:目前该接口只支持抖音小店,所以请在抖音 App 中调用。