plugin.openEcCart收藏我的收藏
收藏
我的收藏基础库 3.43.0.0 开始支持本接口。
提供从小程序跳转到小店购物车的能力。仅支持抖音 App 和抖音极速版 App。
前置条件
- 1.参考 电商小程序接入指南 完成小程序及资质的准备;
- 2.参考 申请行业插件 完成插件的申请,注意只有小程序拥有电商类目资质才可见申请入口;
- 3.参考 使用行业插件 进行能力的调用;
行业插件在抖音 App 版本 31.8.0 及以上,小程序基础库版本 3.4x.0.0 及以上时支持。
语法
plugin.openEcCart(options);
参数说明
options 为 Object 类型,属性如下:
属性名 | 类型 | 默认值 | 必填 | 说明 | 最低支持版本 |
shopId | string | -- | 是 |
| |
type | number | 1 | 否 | 跳转购物车类型 1:跳转全局购物车(暂时只支持传 1) 2:跳转单店购物车 | 2.72.0 |
selectedType | number | -- | 否 | 跳转购物车后默认选中类型,不传入表示不选中任何商品 1:选中本店店铺的所有商品 2:选中指定加购后的商品,需传入 cartIds | 2.72.0 |
cartIds | array<string> | -- | 否(selectedType为 2 时,必 传) | 跳转后选中的购物车商品 ID 列表,cartIds 的来源如下:
| 2.72.0 |
success | function | -- | 否 | 接口调用成功的回调函数 |
|
fail | function | -- | 否 | 接口调用失败的回调函数 |
|
complete | function | -- | 否 | 接口调用结束的回调函数(调用成功或失败都会执行) |
|
type 的合法值
值 | 类型 | 描述 |
1 | number | 跳转全局购物车。 |
2 | number | 跳转单店购物车。 |
selectedType 的合法值
值 | 类型 | 描述 |
1 | number | 选中本店店铺的所有商品。 |
2 | number | 选中指定加购的商品,需传入 cartIds。 |
cartIds 的合法值
值 | 类型 | 描述 |
["xxxxxx","xxxxxx"] | array<string> | 跳转后选中的购物车商品 ID 列表,cartIds 的来源如下:
|
回调成功
参数为 Object 类型,属性如下:
参数 | 参数类型 | 说明 | 最低支持版本 |
errMsg | string | 回调信息 | 抖音 1.96.0,抖音极速版 2.19.0 |
回调失败
参数为 Object 类型,属性如下:
参数 | 参数类型 | 说明 | 最低支持版本 |
errNo | number | 错误码 |
|
errMsg | string | 错误信息 |
|
错误码说明
errNo | errMsg | 说明 | 最低支持版本 |
10301 | feature is not supported in App | 当前 App 不支持这个功能 |
|
20001 | param should be string, but got xxx | 参数校验错误 |
|
21500 | The session id is unavailable, please check login status | 获取宿主 sessionid 失败,用户未登录 |
|
21501 | server error | 网络错误 |
|
21502 | server data error | 服务端网关错误 |
|
21503 | has no bind relation | 当前小程序与传入的商铺无绑定关系 |
|
21100 | host open schema fail: %s, schema == %s | 宿主 openSchema 错误 |
|
21562 | cartIds cannot be undefined when selectedType is 2 | selectedType 为 2,cartIds 必须存在 | 2.72.0 |
代码示例
<!-- ttml --> <button type="default" size="default" bindtap="openEcCart"> 跳转小店购物车 </button>
// js const plugin = tt.requirePlugin('tt95aee3130ae1cbe911'); plugin.openEcCart({ shopId: "1234354", type: 1, selectedType: 2, cartIds: ["xxxxxx", "xxxxxx", "xxxxxx"], success(res) { console.log("调用成功", res); }, fail(res) { console.log("调用失败", res); }, });
Bug & Tip
- •Tip:使用该接口时需要用户身份信息,请确保在调用接口前,用户已经登录宿主 App;
- •Tip:目前该接口只支持抖音和抖音极速版,所以请在抖音 App 或抖音极速版 App 中调用。