# 获取商品受限场景信息
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南。
接口英文名:getproductrestrictedinfo
用于查询小店商品在店铺首页/搜索/商品推荐等场景的受限情况(如橱窗隐藏、上架策略限制、售卖限制、库存限制等)。商家可通过本接口按商品ID批量查询受限场景与来源。
- 单次最多查询 50 个商品ID;
- 受限场景与来源枚举见下方字段说明;
- 接口调用频率限制可参考商品接口调用频率限制说明。
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/channels/ec/product/getproductrestrictedinfo?access_token=ACCESS_TOKEN
# 云调用
- 本接口不支持云调用。
# 第三方调用
本接口支持第三方平台代微信小店商家调用。第三方服务商调用模式介绍
该接口所属的权限集 id 为:129
服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代微信小店商家进行调用,具体可查看 第三方调用 说明文档。
# 2. 请求参数
# 查询参数 Query String Parameters
| 参数名 | 类型 | 必填 | 示例 | 说明 |
|---|---|---|---|---|
| access_token | string | 是 | ACCESS_TOKEN | 接口调用凭证,可使用 access_token(微信小店商家)、authorizer_access_token(服务商代调用) |
# 请求体 Request Payload
| 参数名 | 类型 | 必填 | 示例 | 说明 |
|---|---|---|---|---|
| product_ids | numarray | 是 | 商品ID列表,单次最多50个 | - |
# 3. 返回参数
# 返回体 Response Payload
| 参数名 | 类型 | 示例 | 说明 |
|---|---|---|---|
| errcode | number | 错误码 | - |
| errmsg | string | 错误信息 | - |
| data | object | 响应数据 | - |
# Res.data Object Payload
| 参数名 | 类型 | 说明 |
|---|---|---|
| restricted_info_list | objarray | 商品受限信息列表,按请求 product_ids 顺序对齐;缺失的 product_id 不在列表中 |
# Res.data.restricted_info_list(Array) Object Payload
商品受限信息列表,按请求 product_ids 顺序对齐;缺失的 product_id 不在列表中
| 参数名 | 类型 | 说明 |
|---|---|---|
| product_id | number | 商品ID |
| scene_info | objarray | 受限场景列表(同场景多来源保留全部条目) |
# Res.data.restricted_info_list(Array).scene_infoObject Payload
Object Payload受限场景列表(同场景多来源保留全部条目)
| 参数名 | 类型 | 说明 |
|---|---|---|
| scene | number | 受限场景:1=直播间,2=短视频,3=店铺主页及达人橱窗,4=搜索,5=广告,6=订单及卡片,7=优选联盟,8=商品推荐,9=商品售卖,10=隐藏不合规信息 |
| source | number | 策略来源:1=上架策略-低风险,2=上架策略-相似品,3=上架策略-隐藏图片,4=试运营类目,5=橱窗隐藏,6=极简模式,7=售卖限制,8=库存限制(优选联盟观察期) |
# 4. 注意事项
每个商家调用100次/分钟
# 5. 代码示例
请求示例
{
"product_ids": [100000001]
}
返回示例
{
"errcode": 0,
"errmsg": "ok",
"data": {
"restricted_info_list": [
{
"product_id": 100000001,
"scene_info": [
{"scene": 3, "source": 5},
{"scene": 4, "source": 5},
{"scene": 8, "source": 5}
]
}
]
}
}
# 6. 错误码
以下是本接口的错误码列表,其他错误码可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。
| 错误码 | 错误描述 | 解决方案 |
|---|---|---|
| 10020510 | 查询商品受限信息超过限频,操作过于频繁,请稍后再试 | 单商家 100 次/分钟 |
# 7. 适用范围
本接口支持「微信小店」账号类型调用。其他账号类型如无特殊说明,均不可调用。