# 获取商品列表
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南
接口英文名:getproductlist
可通过该接口获取微信小店的商品列表
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/channels/ec/product/list/get?access_token=ACCESS_TOKEN
# 云调用
调用方法:channels.ec.product.list.get
出入参和 HTTPS 调用相同,调用方式可查看 云调用 说明文档
# 第三方调用
本接口支持第三方平台代商家调用。
该接口所属的权限集 id 为:129
服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代商家进行调用,具体可查看 第三方调用 说明文档。
# 2. 请求参数
# 查询参数 Query String parameters
参数名 | 类型 | 必填 | 示例 | 说明 |
---|---|---|---|---|
access_token | string | 是 | ACCESS_TOKEN | 接口调用凭证,可使用 access_token、authorizer_access_token |
# 请求体 Request Payload
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
status | number | 否 | 商品状态,不填默认拉全部商品(不包含回收站),具体枚举值请参考下文 |
page_size | number | 是 | 每页数量(默认10,不超过30) |
next_key | string | 否 | 由上次请求返回,记录翻页的上下文。传入时会从上次返回的结果往后翻一页,不传默认获取第一页数据。 |
# 3. 返回参数
# 返回体 Response Payload
参数名 | 类型 | 说明 |
---|---|---|
errcode | number | 错误码 |
errmsg | string | 错误信息 |
product_ids | array | 商品id列表 |
next_key | string | 本次翻页的上下文,用于请求下一页 |
total_num | number | 商品总数 |
# 4. 注意事项
status商品状态
枚举值 | 描述 |
---|---|
0 | 初始值 |
5 | 获取上架商品 |
6 | 收站(只有当传入status==6才会返回回收站中的商品,其他情况不返回) |
11 | 获取所有下架商品(包含自主下架和违规下架),对应枚举值为11、13、14、15、20,具体含义请查看下文获取所有下架商品-商品状态 |
获取所有下架商品-商品状态
枚举值 | 描述 |
---|---|
0 | 初始值 |
5 | 上架 |
6 | 回收站 |
9 | 彻底删除,商品无法再进行任何操作 |
11 | 自主下架 |
13 | 违规下架/风控系统下架 |
14 | 保证金不足下架 |
15 | 品牌过期下架 |
20 | 商品被封禁 |
# 5. 代码示例
请求示例
{
"status": 5,
"page_size": 10,
"next_key": "THE_NEXT_KEY"
}
返回示例
{
"errcode": 0,
"errmsg": "ok",
"product_ids": [
"1234567001",
"1234567002",
"1234567003",
"1234567004",
"1234567005",
"1234567006",
"1234567007",
"1234567008",
"1234567009",
"1234567010"
],
"next_key": "THE_NEXT_KEY_NEW",
"total_num": 100
}
# 6. 错误码
以下是本接口的错误码列表,其他错误码可参考 通用错误码
错误码 | 错误描述 | 解决方案 |
---|---|---|
10020050 | 无权限调用该api,请开发者获取权限后再试 | |
10020051 | 参数有误,请开发者按照文档传参 |
# 7. 适用范围
本接口支持「微信小店」账号类型调用。其他账号类型如无特殊说明,均不可调用。