# 获取达人橱窗商品列表
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南。
接口英文名:get_product_list
通过该接口可获取达人橱窗的商品列表。
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/channels/ec/talent/window/product/list/get?access_token=ACCESS_TOKEN
# 云调用
- 本接口不支持云调用。
# 第三方调用
本接口支持第三方平台代带货助手调用。第三方服务商调用模式介绍
该接口所属的权限集 id 为:189
服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代带货助手进行调用,具体可查看 第三方调用 说明文档。
# 2. 请求参数
# 查询参数 Query String Parameters
| 参数名 | 类型 | 必填 | 示例 | 说明 |
|---|---|---|---|---|
| access_token | string | 是 | ACCESS_TOKEN | 接口调用凭证,可使用 access_token(带货助手)、authorizer_access_token(服务商代调用) |
# 请求体 Request Payload
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| page_size | number | 是 | 单页商品数(不超过500) |
| page_index | number | 否 | 页面下标,下标从1开始 (不可以与last_buffer一起填写) |
| last_buffer | string | 否 | 由上次请求返回,顺序翻页时需要传入, 会从上次返回的结果往后翻一页(不可以与page_index一起填写) |
# 3. 返回参数
# 返回体 Response Payload
| 参数名 | 类型 | 说明 |
|---|---|---|
| errcode | number | 错误码 |
| errmsg | string | 错误信息 |
| products | objarray | 橱窗商品列表,每个商品包含商品ID、来源类型及对应来源标识 |
| last_buffer | string | 本次翻页的上下文,用于顺序翻页请求 |
# Res.products(Array) Object Payload
橱窗商品列表,每个商品包含商品ID、来源类型及对应来源标识
| 参数名 | 类型 | 说明 |
|---|---|---|
| product_id | number | 橱窗商品id |
| appid | string | 自营商品时返回,代表商品来源店铺的appid |
| product_source | number | 商品来源类型,枚举值:1-自营商品,2-带货商品 |
| out_product_id | string | 带货商品时返回,代表商品在货源小店中的商品id |
# 4. 注意事项
# 翻页说明
接口支持两种翻页方式:
- page_index 分页:通过 page_size + page_index 按页码翻页,约束 page_size × page_index ≤ 10000
- last_buffer 顺序翻页:由上次请求返回的 last_buffer 传入,从上次结果往后翻一页,无数量限制
当数据量较大时,建议优先使用 last_buffer 顺序翻页。
# 商品来源
products 列表中每个商品通过 product_source 字段标识来源:
| 枚举值 | 解释 |
|---|---|
| 1 | 来源店铺的自营商品(此时返回 appid 字段) |
| 2 | 来源选品中心的带货商品(此时返回 out_product_id 字段) |
# 5. 代码示例
请求示例
// page_index 方式请求
{
"page_size": 1,
"page_index": 1
}
// last_buffer 方式请求
{
"page_size": 1,
"last_buffer": "abcdefg"
}
返回示例
{
"errcode": 0,
"errmsg": "ok",
"products": [
{ // 来自自营店铺的商品
"product_id": "1000000000000",
"appid": "wxee9f94a33abcdefg",
"product_source": 1
},
{ // 带货商品
"product_id": "14000000000000",
"out_product_id": "100000012356",
"product_source": 2
}
],
"last_buffer": "EB4YAg="
}
# 6. 错误码
以下是本接口的错误码列表,其他错误码可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。
| 错误码 | 错误描述 | 解决方案 |
|---|---|---|
| 10200003 | 请求参数 page_size 超过限制 | page_size 最大值为 500,请调整后重试 |
| 10200004 | 请求参数 page_index 与 last_buffer 同时存在 | 两种翻页方式互斥,请选择其中一种 |
| 10200005 | 请求参数 page_size × page_index 超过限制 | page_size × page_index 不能超过 10000,建议改用 last_buffer 顺序翻页 |
# 7. 适用范围
本接口支持「带货助手(需申请)」账号类型调用。其他账号类型如无特殊说明,均不可调用。