# 获取货品列表

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

接口英文名:getsupplyproductlist

请求方式:POST

可通过该接口获取微信小店的货品列表

# 1. 调用方式

# HTTPS 调用

POST https://api.weixin.qq.com/channels/ec/supplier/product/list/get?access_token=ACCESS_TOKEN

# 云调用

  • 本接口不支持云调用。

# 第三方调用

# 2. 请求参数

# 查询参数 Query String Parameters

参数名类型必填示例说明
access_tokenstringACCESS_TOKEN接口调用凭证,可使用 access_token(供货商)、authorizer_access_token(服务商代调用)

# 请求体 Request Payload

参数名类型必填说明枚举
statusnumber货品状态,不填默认拉全部货品枚举值
page_sizenumber每页数量(默认10,不超过30)-
next_keystring由上次请求返回,记录翻页的上下文。传入时会从上次返回的结果往后翻一页,不传默认获取第一页数据-

# 3. 返回参数

# 返回体 Response Payload

参数名类型说明
errcodenumber错误码
errmsgstring错误信息
product_idsarray货品id列表
next_keystring本次翻页的上下文,用于请求下一页
total_numnumber货品总数

# 4. 枚举信息

# Body.status Enum

货品状态,不填默认拉全部货品

枚举值描述
0初始值
5上架
6回收站
11自主下架
13违规下架

# 5. 注意事项

本接口无特殊注意事项

# 6. 代码示例

请求示例

{
	"status": 5,
	"page_size": 10,
	"next_key": "THE_NEXT_KEY"
}

返回示例

{
	"errcode": 0,
	"errmsg": "ok",
	"product_ids": [
		"1234567001",
		"1234567002",
		"1234567003"
	],
	"next_key": "THE_NEXT_KEY_NEW",
	"total_num": 100
}

# 7. 错误码

以下是本接口的错误码列表,其他错误码可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。

错误码错误描述解决方案
10020050无权限调用该api请获取权限后再试
10020051参数有误请按照文档要求传参

# 8. 适用范围

本接口支持「小店供货商」账号类型调用。其他账号类型如无特殊说明,均不可调用。