# 查询橱窗上机构商品列表

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

接口英文名:getallwindow

可通过该接口查询橱窗上机构商品列表 注意:**本次修改(2025年2月修改)支持查询达人所有橱窗商品,但针对删除操作时会进行权限校验。仅支持将属于机构或者机构添加的商品移出橱窗。 **情况如下:

机构 商品类型 添加操作者 是否可将商品移出橱窗 说明
A 普通商品 A 与商品类型无关,操作者是A,则A可以移出橱窗
A 机构A商品 B 与操作者无关,商品属于A,则A可以移出橱窗
A 机构B商品 达人
B 普通商品 A
B 机构A商品 B 与商品类型无关,操作者是B,则B可以移出橱窗
B 机构B商品 达人 与操作者无关,商品属于B,则B可以移出橱窗

# 1. 调用方式

# HTTPS 调用

POST https://api.weixin.qq.com/channels/ec/league/headsupplier/window/getall?access_token=ACCESS_TOKEN

# 云调用

  • 调用方法:channels.ec.league.headsupplier.window.getall

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

# 第三方调用

  • 本接口不支持第三方平台调用。

# 2. 请求参数

# 查询参数 Query String parameters

参数名类型必填示例说明
access_tokenstringACCESS_TOKEN接口调用凭证,可使用 access_token

# 请求体 Request Payload

参数名类型必填说明
finder_idstring视频号finder_id,未填openfinderid时必填,后续废弃
offsetnumber起始位置(从0开始)
page_sizenumber每页数量(默认100, 最大500)
need_total_numboolean是否需要返回橱窗上机构商品总数,默认为false
openfinderidstring带货达人opentalentid,操作达人带货助手橱窗时必填,和openfinderid二选一
is_get_allboolean是否需要查询达人所有橱窗商品,默认为false;【注意:如果传了 true,就会把橱窗所有商品都返回,如果只想要自己机构的商品,请不要设置】
opentalentidstring视频号openfinderid,操作达人视频号橱窗时必填,和opentalentid二选一

# 3. 返回参数

# 返回体 Response Payload

参数名类型说明
errcodenumber错误码
errmsgstring错误信息
listobjarray商品概要列表
next_offsetnumber下一页的位置
has_moreboolean后面是否还有商品
total_numnumber商品总数

# Res.list(Array) Object Payload

商品概要列表

参数名类型说明
appidstring机构appid
product_idnumber机构商品ID
product_window_idnumber商品在橱窗的ID,用来移除橱窗操作
is_operation_allowedboolean是否有操作权限,true-可操作;false-不可操作

# 4. 注意事项

本接口无特殊注意事项

# 5. 代码示例

请求示例

{
    "appid": "app1234",
    "finder_id": "sph1234",
    "offset": 0,
    "page_size": 100,
    "need_total_num": true
}

返回示例


    "errcode": 0,
    "errmsg": "ok",
    "list": [
        {
            "appid": "test1",
            "product_id": 12345
        },
        {
            "appid": "test2",
            "product_id": 12346
        }
    ],
    "next_offset": 100,
    "have_more": true,
    "total_num": 369
}

# 6. 错误码

以下是本接口的错误码列表,其他错误码可参考 通用错误码

错误码错误描述解决方案
10024000参数错误,请开发者检查请求参数是否正确
10024001不合法的finder_id
10024003不合法的appid
10024009不合法的product_id
10024010橱窗操作失败
10024011未获得橱窗授权

# 7. 适用范围

本接口暂未明确可调用账号类型,或在业务中根据调用传参自行确定是否可调用,请已实际调用情况为准。