一、概述
微店商品列表 API 接口允许开发者通过编程方式从微店平台获取商品列表数据。这些数据可用于多种场景,如电商数据分析、商品展示、库存管理等。以下是对该接口的详细解析。
二、接口信息
- 请求方式
POST - 请求参数
参数名 类型 是否必填 描述
method 字符串 是 接口方法名,固定为 vdian.item.list.get
access_token 字符串 是 通过 OAuth 2.0 授权获取的访问令牌
page_no 整数 否 页码,默认值为 1
page_size 整数 否 每页显示的商品数量,默认值为 20,最大值为 100
order_by 字符串 否 排序方式,可选值:
- create_time_desc:按创建时间降序排列
- create_time_asc:按创建时间升序排列
- update_time_desc:按更新时间降序排列
- update_time_asc:按更新时间升序排列
status 字符串 否 商品状态,可选值: - onsale:在售商品
- instock:库存商品
- soldout:售罄商品
keyword 字符串 否 搜索关键词,用于筛选包含该关键词的商品
- 请求示例(Python)
weidian-product-list-api
微店商品列表API请求示例
V4
生成 weidian_product_list_request.py
三、响应信息 - 响应格式
JSON - 响应参数
参数名 类型 描述
code 整数 返回码,0 表示成功,非 0 表示失败
msg 字符串 返回信息,成功时为 success,失败时为具体的错误描述
data 对象 包含商品列表数据的对象
data.items 数组 商品列表,每个元素为一个商品对象
data.items[].item_id 字符串 商品 ID
data.items[].title 字符串 商品标题
data.items[].price 浮点数 商品价格
data.items[].stock 整数 商品库存数量
data.items[].thumb_url 字符串 商品缩略图 URL - 响应示例
```js
json
{
"code": 0,
"msg": "success",
"data": {
}"items": [ { "item_id": "123456", "title": "某品牌手机", "price": 3999.00, "stock": 100, "thumb_url": "https://example.com/thumb.jpg" }, { "item_id": "654321", "title": "另一款手机", "price": 2999.00, "stock": 50, "thumb_url": "https://example.com/thumb2.jpg" } ]
}
```
四、错误处理
当 code 不为 0 时,表示请求失败。常见的错误码及含义如下:
错误码 含义 解决方案
1001 access_token 无效 重新获取 access_token
1002 接口方法不存在 检查 method 参数是否正确
1003 参数错误 检查请求参数是否完整、格式是否正确
通过以上步骤和说明,你可以成功调用微店商品列表 API 接口并处理返回的数据。