# 获取联盟商品推广列表
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南
接口英文名:getitemlist
可通过该接口获取联盟商品推广列表
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/channels/ec/league/item/list/get?access_token=ACCESS_TOKEN
# 云调用
调用方法:channels.ec.league.item.list.get
出入参和 HTTPS 调用相同,调用方式可查看 云调用 说明文档
# 第三方调用
本接口支持第三方平台代商家调用。
该接口所属的权限集 id 为:141
服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代商家进行调用,具体可查看 第三方调用 说明文档。
# 2. 请求参数
# 查询参数 Query String parameters
参数名 | 类型 | 必填 | 示例 | 说明 |
---|---|---|---|---|
access_token | string | 是 | ACCESS_TOKEN | 接口调用凭证,可使用 access_token、authorizer_access_token |
# 请求体 Request Payload
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
type | number | 是 | 商品推广类别,枚举值详情请参考下文 |
page_size | number | 是 | 单页商品数(不超过100) |
page_index | number | 否 | 页面下标,下标从1开始,默认为1 |
product_id | number | 否 | 商品id,获取特殊推广商品时有效 |
finder_id | string | 否 | 视频号id,获取特殊推广商品时有效 |
last_buffer | string | 否 | 由上次请求返回,顺序翻页时需要传入, 会从上次返回的结果往后翻一页(填了该值后page_index不生效) |
need_total_num | boolean | 否 | 是否需要返回满足筛选条件的商品总数(填last_buffer后该值无效) |
# 3. 返回参数
# 返回体 Response Payload
参数名 | 类型 | 示例 | 说明 |
---|---|---|---|
errcode | number | 0 | 错误码 |
errmsg | string | ok | 错误信息 |
items | objarray | 商品信息 | |
has_more | boolean | 是否还有剩余商品 | |
total_num | number | 商品总数 | |
last_buffer | string | 本次翻页的上下文,用于顺序翻页请求 |
# Res.items(Array) Object Payload
商品信息
参数名 | 类型 | 说明 |
---|---|---|
product_id | number | 商品id |
info_id | number | 特殊推广商品计划id |
# 4. 注意事项
- 接口限制了 page_size × page_index ≤ 5000;
- 命中限制时建议改用传last_buffer顺序翻页的请求方式。
type商品推广类别
枚举值 | 描述 |
---|---|
1 | 普通推广商品 |
2 | 定向推广商品 |
3 | 专属推广商品 |
# 5. 代码示例
请求示例
{
"type": 1,
"page_size": 1,
"page_index": 1
}
返回示例
{
"errcode": 0,
"errmsg": "ok",
"items": {
"product_id": 123456
},
"total_num": 10
}
# 6. 错误码
以下是本接口的错误码列表,其他错误码可参考 通用错误码
错误码 | 错误描述 | 解决方案 |
---|---|---|
10023000 | 参数错误,请开发者检查参数是否正确 | |
10023001 | 不合法的finder_id | |
10023007 | 请先开通优选联盟 | |
10023100 | type类型错误 | |
10023103 | 不存在该推广商品 |
# 7. 适用范围
本接口支持「微信小店(需申请)」账号类型调用。其他账号类型如无特殊说明,均不可调用。