# 提交精选展示位申请

接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南

接口英文名:submitbannerapply

通过该接口提交精选展示位申请,审核通过后会展示在店铺主页。

配置链接和描述信息,向用户展示你精选的商品或内容。

# 1. 调用方式

# HTTPS 调用

POST https://api.weixin.qq.com/channels/ec/basics/homepage/banner/apply/submit?access_token=ACCESS_TOKEN

# 云调用

  • 本接口不支持云调用。

# 第三方调用

# 2. 请求参数

# 查询参数 Query String Parameters

参数名类型必填示例说明
access_tokenstringACCESS_TOKEN接口调用凭证,可使用 access_token(微信小店商家)、authorizer_access_token(服务商代调用)

# 请求体 Request Payload

参数名类型必填说明
bannerobject精选展示位。

# Body.banner Object Payload

精选展示位。

参数名类型必填示例说明
bannerobjarray精选展示位。最多 5 个,小图模式最少 3 个
scalenumber2展示位的展示样式。1=小图模式,2=大图模式
titlestring示例标题模块标题。最多 32 字

# Body.banner.banner(Array) Object Payload

精选展示位。最多 5 个,小图模式最少 3 个

参数名类型必填示例说明
bannerobject精选展示位
typenumber1展示位类型。1=商品,3=视频号,4=公众号
productobject-
finderobject-
official_accountobject-

# Body.banner.banner(Array).banner Object Payload

精选展示位

参数名类型必填示例说明
img_urlstringhttps://store.mp.video.tencent-cloud.com/abc图片 url。请务必使用 上传图片 接口上传图片(参数 resp_type=1),并将返回的 img_url 填入此处,不接受其他任何格式的图片 url。若 url 曾经做过转换(url 前缀为 mmecimage.cn/p/),则可以直接提交
titlestring测试商品精品展示位标题标题。当 scale 为 1(小图模式)时最多 12 字,为 2(大图模式)时最多 40 字
descriptionstring测试商品精品展示位描述描述。当 scale 为 2(大图模式)时可设置,最多 100 个字。当 scale 为 1(小图模式)时不可设置

# Body.banner.banner(Array).product Object Payload

参数名类型必填示例说明
product_idnumber123商品 ID。可通过 获取商品列表 接口查询本店铺的商品 ID

# Body.banner.banner(Array).finder Object Payload

参数名类型必填示例说明
finder_user_namestringsphabc视频号 ID。可参考下文查询视频号 ID
feed_idstringexport/abc视频 ID。视频号视频的唯一标识。可参考下文查询视频 ID

# Body.banner.banner(Array).official_account Object Payload

参数名类型必填示例说明
urlstringhttps://mp.weixin.qq.com/abc公众号文章链接。可参考下文查询公众号文章链接

# 3. 返回参数

# 返回体 Response Payload

参数名类型示例说明
errcodenumber0错误码
errmsgstringok错误信息
apply_idnumber123申请编号

# 4. 注意事项

# 获取参数

# finder_user_name

代表视频号ID,获取视频号ID的需要登录视频号助手,在首页可以查看自己的视频号ID。

# feed_id

代表视频号视频的唯一标识,获取视频ID需要登录视频号助手,在「动态管理」模块可以复制自己发表的每个视频对应的视频ID。

# official_account.url

公众号文章链接,可在微信客户端打开公众号文章获取分享链接。

# 5. 代码示例

请求示例

{
  "banner": {
    "scale": 2,
    "banner": [
      {
        "type": 1,
        "product": {
          "product_id": 123
        },
        "banner": {
          "description": "测试商品精品展示位描述",
          "img_url": "https://store.mp.video.tencent-cloud.com/abc",
          "title": "测试商品精品展示位标题"
        }
      },
      {
        "type": 3,
        "finder": {
          "feed_id": "export/abc",
          "finder_user_name": "sphabc"
        },
        "banner": {
          "description": "测试视频号视频精品展示位描述",
          "img_url": "https://store.mp.video.tencent-cloud.com/abc",
          "title": "测试视频号视频精品展示位标题"
        }
      },
      {
        "type": 4,
        "official_account": {
          "url": "https://mp.weixin.qq.com/abc"
        },
        "banner": {
          "description": "测试公众号文章精品展示位描述",
          "img_url": "https://store.mp.video.tencent-cloud.com/abc",
          "title": "测试公众号文章精品展示位标题"
        }
      }
    ]
  }
}

返回示例

{
    "errcode": 0,
    "errmsg": "ok",
    "apply_id": 123
}

# 6. 错误码

以下是本接口的错误码列表,其他错误码可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。

错误码错误描述
268549841已有流程中的申请。
268549927参数错误。商品ID不能为空。
268549928参数错误。banner类型有误。
268552545参数错误。描述不能为空。
268552602参数错误。标题长度有误。
268552603参数错误。描述长度有误。
268552604参数错误。描述必须为空。
268552621参数错误。benner类型为视频号时,只能设置视频号相关参数。
268552622参数错误。benner类型为公众号时,只能设置公众号相关参数。
268552764参数错误。scale取值有误。
268552767参数错误。标题不能为空。
268553052参数错误。视频号ID不能为空。
268553053参数错误。视频ID不能为空。
268553233参数错误。benner类型为商品时,只能设置商品相关参数。
268553252参数错误。图片链接不能为空。
268553714参数错误。banner个数有误。
268555516无权限,仅供微信小店使用。
268555602参数错误。图片链接格式有误。
268555603参数错误。图片链接格式有误。
268555694参数错误。视频号ID与视频ID不匹配。
268555696参数错误。商品ID有误。
268555698参数错误。商品必须为上架状态。
268555705参数错误。视频号ID有误。
268555706参数错误。视频ID有误。
268555744转换img_url时发生错误。
268555796参数错误。公众号文章链接有误。
268555797转换img_url时发生错误。

# 7. 适用范围

本接口在不同账号类型下的可调用情况:
微信小店小店供货商
  • ✔:该账号可调用此接口。
  • 其他未明确声明的账号类型,如无特殊说明,均不可调用此接口。