电商插件

跳转引导

导购成交

plugin.applyEcCoupon

plugin.batchAddToEcCart

plugin.addToEcCart

plugin.openEcOrder

plugin.submitEcCustomGoods

通用查询

会员运营

电商组件

plugin.applyEcCoupon
收藏
我的收藏

基础库 3.43.0.0 开始支持本接口。

提供开发者发放抖店优惠券能力，仅支持抖音 App 和抖音极速版 App。

支持具有小时达能力店铺，定向跳转进指定小时达店铺。

前置条件

在使用电商插件中的组件和 API 前，需要对行业插件有一个基本了解，可以参考文档：行业插件介绍，然后按照以下步骤及顺序使用电商插件中的能力：

参考电商小程序接入指南完成小程序及资质的准备；

参考申请行业插件完成插件的申请，注意只有小程序拥有电商类目资质才可见申请入口；

参考使用行业插件进行能力的调用；

行业插件在抖音 App 版本 31.8.0 及以上，小程序基础库版本 3.4x.0.0 及以上时支持。

配券后台操作

在商家开发者进行开发之前，需要开发者或者商家前往抖店后台进行优惠券的配置。

配置后的优惠券请同步优惠券 ID 到开发者，以备开发者在页面调用。

以下介绍如何完成优惠券的配置。

登录抖店后台。

创建小程序所需优惠券。

选择【商品优惠券】或【全店通用券】。

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

新建自有渠道券。

获取优惠券 ID 给到开发者。

注意
一定要选择私有渠道券。
券配置后小程序一旦上线不要改动优惠券。

语法

plugin.ApplyEcCoupon(options);

参数说明

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>

// 代码示例
const plugin = tt.requirePlugin('tt95aee3130ae1cbe911');
Page({
  ApplyEcCoupon(e) {
    plugin.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 中调用。

plugin.applyEcCoupon收藏我的收藏