# 获取主页展示商品列表
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南
接口英文名:getstorewindowproductlist
通过该接口可获取微信小店主页对用户展示的商品列表。该接口只会返回状态为上架中的商品。
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/channels/ec/store/window/product/list/get?access_token=ACCESS_TOKEN
# 云调用
- 本接口不支持云调用
# 第三方调用
本接口支持第三方平台代商家调用。
该接口所属的权限集 id 为:129
服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代商家进行调用,具体可查看 第三方调用 说明文档。
# 2. 请求参数
# 查询参数 Query String parameters
参数名 | 类型 | 必填 | 示例 | 说明 |
---|---|---|---|---|
access_token | string | 是 | ACCESS_TOKEN | 接口调用凭证,可使用 access_token、authorizer_access_token |
# 请求体 Request Payload
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
page_size | number | 是 | 每页数量(默认10,不超过30) |
next_key | string | 否 | 由上次请求返回,记录翻页的上下文。传入时会从上次返回的结果往后翻一页,不传默认获取第一页数据。 |
# 3. 返回参数
# 返回体 Response Payload
参数名 | 类型 | 说明 |
---|---|---|
errcode | number | 错误码 |
errmsg | string | 错误信息 |
products | objarray | 商品信息 |
next_key | string | 本次翻页的上下文,用于请求下一页 |
total_num | number | 商品总数 |
# Res.products(Array) Object Payload
商品信息
参数名 | 类型 | 说明 |
---|---|---|
product_id | string | 商品id |
is_set_hide | number | 是否隐藏,设置为隐藏的商品只在首页不可见,并不代表下架。 |
is_set_top | number | 是否置顶 |
# 4. 注意事项
本接口无特殊注意事项
# 5. 代码示例
请求示例
{
"page_size": 10,
"next_key": "THE_NEXT_KEY_NEW"
}
返回示例
{
"errcode": 0,
"errmsg": "ok",
"products": [
{
"product_id" : "1234567001",
"is_set_hide" : 0,
"is_set_top" : 0
},
{
"product_id" : "1234567002",
"is_set_hide" : 0,
"is_set_top" : 0
}
],
"next_key": "THE_NEXT_KEY_NEW",
"total_num": 100
}
# 6. 错误码
以下是本接口的错误码列表,其他错误码可参考 通用错误码
错误码 | 错误描述 | 解决方案 |
---|---|---|
10020050 | 无权限调用该api,请开发者获取权限后再试 | |
10020051 | 参数有误,请开发者按照文档传参 |
# 7. 适用范围
本接口支持「微信小店」账号类型调用。其他账号类型如无特殊说明,均不可调用。