抖音开放平台Logo
开发者文档
小程序
控制台
  • 行业插件介绍
  • 申请行业插件
  • 使用行业插件
  • 电商插件
  • 跳转引导
  • 导购成交
  • plugin.applyEcCoupon
  • plugin.batchAddToEcCart
  • plugin.addToEcCart
  • plugin.openEcOrder
  • plugin.submitEcCustomGoods
  • 通用查询
  • 会员运营
  • 电商组件

    • plugin.addToEcCart
    收藏
    我的收藏

    基础库 3.43.0.0 开始支持本接口。
    提供小程序绑定的抖音小店的商品加购能力，仅支持抖音 App 和抖音极速版 App。

    前置条件

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

    语法

    plugin.addToEcCart(options);

    参数说明

    options 为 Object 类型，属性如下：
    属性名
    类型
    默认值
    必填
    说明
    最低支持版本
    productId
    string
    --
    是
    要加购的商品 ID，来自当前小程序绑定的抖音小店，可从 抖店商品管理模块 获得，确保商品售卖中且有库存
    2.44.0.0
    skuId
    string
    --
    是
    要加购的商品 SKU ID，来自当前小程序绑定的抖音小店，可从 抖店库存管理模块 获得，确保商品售卖中有库存，且 productId 与 skuId 匹配
    2.44.0.0
    skuAmount
    number
    --
    是
    要加购的 SKU 数量，加购的数量与购物车已有数量相加不能超过 100
    2.44.0.0
    success
    function
    --
    否
    接口调用成功的回调函数
    2.44.0.0
    fail
    function
    --
    否
    接口调用失败的回调函数
    2.44.0.0
    complete
    function
    --
    否
    接口调用结束的回调函数（调用成功、失败都会执行）
    2.44.0.0

    回调成功

    参数为 Object 类型，属性如下：
    参数
    参数类型
    说明
    最低支持版本
    errMsg
    string
    回调信息
    2.44.0.0
    cartId
    string
    购物车中的商品 ID
    2.44.0.0

    回调失败

    参数为 Object 类型，属性如下：
    参数
    参数类型
    说明
    最低支持版本
    errNo
    number
    错误码
    2.44.0.0
    errMsg
    string
    错误信息
    2.44.0.0

    错误码说明

    errNo
    errMsg
    说明
    最低支持版本
    10101
    platform auth deny
    权限错误，不在白名单内
    2.44.0.0
    10301
    The feature is not supported in App
    当前 App 不支持这个功能
    2.44.0.0
    20000
    param should be string, but got xxx
    参数校验错误
    2.44.0.0
    21500
    The session id is unavailable, please check login status
    获取宿主登录信息失败，用户未登录
    2.44.0.0
    21501
    server error
    网络错误
    2.44.0.0
    21502
    server data error
    服务端网关错误
    2.44.0.0
    21510
    --
    亲，该商品不支持加购购买，请直接购买
    2.44.0.0
    21520
    --
    当前活动不存在
    2.44.0.0
    每人限购 xx 件，当前已达购买上限
    2.44.0.0
    每人限购 xx 件，当前最多可购买 xx 件
    2.44.0.0
    当前已达购买上限
    2.44.0.0
    当前最多可购买 xx 件
    2.44.0.0
    加购数量大于商品库存
    2.44.0.0
    最多添加 xx 件
    2.44.0.0
    您购物车商品总数已满 xx 件，建议先去结算或清理
    2.44.0.0
    该商品不存在
    2.44.0.0
    同时操作人数过多，请稍后重试
    2.44.0.0
    21521
    --
    该商品不存在
    2.44.0.0
    21540
    --
    生成 cart_id 失败
    2.44.0.0
    添加购物车失败
    2.44.0.0
    21550
    --
    Invalid Params
    2.44.0.0
    21560
    --
    添加购物车失败
    2.44.0.0
    21564
    --
    请求下游失败
    2.44.0.0

    代码示例

    <!-- ttml -->
<button type="default" size="default" bindtap="addToEcCart">
  点击加购
</button>
    // js
const plugin = tt.requirePlugin('tt95aee3130ae1cbe911');
Page({
  addToEcCart(e) {
    plugin.addToEcCart({
      productId: "11123",
      skuId: "333",
      skuAmount: 1,
      success(res) {
        console.log("调用成功", res);
      },
      fail(res) {
        console.log("调用失败", res);
      },
    });
  },
});

    Bug & Tip

      •Tip：使用该接口时需要用户身份信息，请确保在调用接口前，用户已经登录宿主 App；
      •Tip：目前该接口只支持抖音 App 和抖音极速版 App，所以请在抖音 App 和抖音极速版 App 中调用。