视频号
取消
中文
中文
EN
取消
  • 介绍

    • # 获取已添加到橱窗的商品列表

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

    接口英文名：getwindowproductlist

    通过该接口可获取已添加到橱窗的商品列表。

    # 1. 调用方式

    # HTTPS 调用

    POST https://api.weixin.qq.com/channels/ec/window/product/list/get?access_token=ACCESS_TOKEN

    # 云调用

    • 调用方法：channels.ec.window.product.list.get

    • 出入参和 HTTPS 调用相同，调用方式可查看 云调用 说明文档

    # 第三方调用

    • 本接口支持第三方平台代商家调用。

    • 该接口所属的权限集 id 为：133、177

    • 服务商获得其中之一权限集授权后，可通过使用 authorizer_access_token 代商家进行调用，具体可查看 第三方调用 说明文档。

    # 2. 请求参数

    # 查询参数 Query String parameters

    参数名类型必填示例说明
    access_tokenstring是ACCESS_TOKEN接口调用凭证，可使用 access_token、authorizer_access_token

    # 请求体 Request Payload

    参数名类型必填示例说明
    appidstring否用于指定查询某个店铺来源的商品
    branch_idnumber否用于指定查询属于某个分店ID下的商品
    page_sizenumber是单页商品数（不超过200）
    page_indexnumber否1页面下标，下标从1开始，默认为1
    last_bufferstring否由上次请求返回，顺序翻页时需要传入, 会从上次返回的结果往后翻一页（填了该值后page_index不生效）
    need_total_numbool否是否需要返回满足筛选条件的商品总数
    query_cps_productbool否是否仅查询橱窗中的带货商品

    # 3. 返回参数

    # 返回体 Response Payload

    参数名类型说明
    errcodenumber错误码
    errmsgstring错误信息
    productsobjectproducts
    last_bufferstring本次翻页的上下文，用于顺序翻页请求
    total_numnumber商品总数

    # Res.products Object Payload

    products

    参数名类型说明
    product_idstring(uint64)橱窗商品id，对于带货商品则为带货商品id
    appidstring对于自营商品会返回，代表商品来源店铺的appid
    out_product_idstring对于带货商品会返回, 代表商品在货源小店中的商品id
    product_sourcenumber商品来源,枚举值详情请参考下文

    # 4. 注意事项

    1. 接口限制了 page_size × page_index ≤ 10000。命中限制时建议改用传last_buffer顺序翻页的请求方式。

    2. 入参的 appid 字段与 query_cps_product 字段互斥。两者都存在时，会以 appid 字段优先，仅返回来源指定店铺的自营商品。

    product_source商品来源

    枚举值 描述
    0 来源店铺的自营商品
    1 来源选品中心的带货商品

    # 5. 代码示例

    请求示例

    // 获取店铺商品
{
    "appid": "wxee9f94a3360ad25f",
    "page_size": 1,
    "page_index": 1,
    "need_total_num": true,
}

// 获取带货商品
{
    "page_size": 1,
    "page_index": 1,
    "need_total_num": true,
    "query_cps_product": true

    返回示例

    // 自营商品返回示例
{
    "errcode": 0,
    "errmsg": "ok",
    "products": [
        {
            "product_id": "100234056",
            "appid": "wxee9f94a3360ad25f"
        }
    ],
    "last_buffer": "EB4YAg=",
    "total_num": 11
}

// 带货商品返回示例
{
    "errcode": 0,
    "errmsg": "ok",
    "products": [
        {
            "product_id": "439000124321",
            "out_product_id": "100234056",
            "product_source": 1
        }
    ],
    "last_buffer": "EB4YAg=",
    "total_num": 11
}

    # 6. 错误码

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

    错误码错误描述
    48001接口权限未开启，需前往视频号助手- 开放能力-开放场景 打开开关
    10022001验证视频号身份失败, 请检查是否使用视频号橱窗ID请求
    10022002因违规行为, 橱窗被禁止使用, 请前往'带货中心->个人中心->带货权限'检查橱窗带货权限
    10022006请求参数错误，请检查请求参数是否符合限制

    # 7. 适用范围

    本接口支持「视频号助手」账号类型调用。其他账号类型如无特殊说明，均不可调用。