# 获取商品列表

调试诊断

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

接口英文名:getGoodsInfo

该接口用户获取不同审核状态的商品信息。

# 1. 调用方式

# HTTPS 调用

GET https://api.weixin.qq.com/wxaapi/broadcast/goods/getapproved?access_token=ACCESS_TOKEN&offset=OFFSET&limit=LIMIT&status=STATUS

# 云调用

  • 调用方法:liveBroadcast.goodsList

  • 出入参和 HTTPS 调用相同,调用方式可查看 云调用 说明文档

# 第三方调用

  • 本接口支持第三方平台代商家调用。

  • 该接口所属的权限集 id 为:52

  • 服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代商家进行调用,具体可查看 第三方调用 说明文档。

# 2. 请求参数

# 查询参数 Query String parameters

参数名类型必填示例说明
access_tokenstringACCESS_TOKEN接口调用凭证,可使用 access_tokenauthorizer_access_token
offsetnumber-分页条数起点
limitnumber-分页大小,默认30,不超过100
statusnumber-商品状态,0:未审核。1:审核中,2:审核通过,3:审核驳回

# 请求体 Request Payload

# 3. 返回参数

# 返回体 Response Payload

参数名类型说明
goodsobjarray商品列表
totalnumber商品个数

# Res.goods(Array) Object Payload

商品列表

参数名类型说明
goodsIdstring商品ID
namestring商品名称,最长14个汉字,1个汉字相当于2个字符
coverImgUrlstring填入mediaID(mediaID获取后,三天内有效);图片mediaID的获取,请参考新增临时素材;图片规则:图片尺寸最大300像素*300像素;
urlstring商品详情页的小程序路径,路径参数存在 url 的,该参数的值需要进行 encode 处理再填入
priceTypenumber价格类型,1:一口价(只需要传入price,price2不传) 2:价格区间(price字段为左边界,price2字段为右边界,price和price2必传) 3:显示折扣价(price字段为原价,price2字段为现价, price和price2必传)
pricenumber数字,最多保留两位小数,单位元
price2number数字,最多保留两位小数,单位元
third_party_tagnumber1、2:表示是为 API 添加商品,否则是直播控制台添加的商品
thirdPartyAppidstring当商品为第三方小程序的商品则填写为对应第三方小程序的appid,自身小程序商品则填空

# 4. 注意事项

调用额度:10000次/一天

# 5. 代码示例

请求示例

https://api.weixin.qq.com/wxaapi/broadcast/goods/getapproved?access_token=[access_token]& status=2

返回示例

{ ​ "errcode":0, ​ "total":68, ​ "goods": ​ [ ​ { ​ "goodsId":9, ​ "coverImgUrl":"xxxx", ​ "name":"xxxxx" ​ "price":12300, ​ "url":"xxxxxxx", ​ "priceType":1, ​ "price2":0, ​ "thirdPartyTag":0 ​ } ​ ] }

# 6. 错误码

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

错误码错误描述解决方案
-1system error系统繁忙,此时请开发者稍候再试
40001invalid credential  access_token isinvalid or not latest获取 access_token 时 AppSecret 错误,或者 access_token 无效。请开发者认真比对 AppSecret 的正确性,或查看是否正在为恰当的公众号调用接口
200002参数错误

# 7. 适用范围

本接口暂未明确可调用账号类型,或在业务中根据调用传参自行确定是否可调用,请已实际调用情况为准。