# 获取带货商品列表
接口应在服务器端调用，不可在前端（小程序、网页、APP等）直接调用，具体可参考接口调用指南
接口英文名：getfinderproductlist
通过该接口可获取带货商品列表。
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/channels/ec/compass/finder/product/list/get
# 云调用
- 本接口不支持云调用
# 第三方调用
本接口支持第三方平台代商家调用。
该接口所属的权限集 id 为：176
服务商获得其中之一权限集授权后，可通过使用 authorizer_access_token 代商家进行调用，具体可查看 第三方调用 说明文档。
# 2. 请求参数
# 查询参数 Query String parameters
无
# 请求体 Request Payload
| 参数名 | 类型 | 必填 | 示例 | 说明 |
|---|---|---|---|---|
| ds | string | 是 | 20240520 | 日期，格式YYYYMMDD |
# 3. 返回参数
# 返回体 Response Payload
| 参数名 | 类型 | 示例 | 说明 |
|---|---|---|---|
| errcode | number | 0 | 错误码 |
| errmsg | string | ok | 错误信息 |
| product_list | objarray | product_list |
# Res.product_list(Array) Object Payload
product_list
| 参数名 | 类型 | 说明 |
|---|---|---|
| product_id | number | 商品id |
| head_img_url | string | 商品头图 |
| title | string | 商品标题 |
| price | number | 商品价格 |
| first_category_id | number | 1级类目 |
| second_category_id | number | 2级类目 |
| third_category_id | number | 3级类目 |
| data | object | data |
# Res.product_list(Array).data Object Payload
data
| 参数名 | 类型 | 说明 |
|---|---|---|
| pay_gmv | number | 成交金额 |
| create_gmv | number | 下单金额（单位：分） |
| create_cnt | number | 下单订单数 |
| create_uv | number | 下单人数 |
| create_product_cnt | number | 下单件数 |
| pay_cnt | number | 成交订单数 |
| pay_uv | number | 成交人数 |
| pay_product_cnt | number | 成交件数 |
| pure_pay_gmv | number | 成交金额（剔除退款）（单位：分） |
| pay_gmv_per_uv | number | 成交客单价（单位：分) |
| actual_commission | number | 实际结算金额（单位：分） |
| predict_commission | number | 预估佣金金额（单位：分） |
| product_click_uv | number | 商品点击人数 |
| product_click_cnt | number | 商品点击次数 |
| pay_refund_gmv | number | 成交退款金额 |
| pay_refund_uv | number | 成交退款人数 |
| pay_refund_ratio | number | 成交退款率 |
| pay_refund_after_send_ratio | number | 发货后成交退款率 |
| pay_refund_cnt | number | 成交退款订单数 |
| pay_refund_product_cnt | number | 成交退款件数 |
| pay_refund_before_send_ratio | number | 发货前成交退款率 |
| refund_gmv | number | 退款金额（单位：分） |
| refund_product_cnt | number | 退款件数 |
| refund_cnt | number | 退款订单数 |
| refund_uv | number | 退款人数 |
# 4. 注意事项
本接口无特殊注意事项
# 5. 代码示例
请求示例
{
"ds": "20240520"
}
返回示例
{
"errcode": 0,
"errmsg": "ok",
"product_list": {
"product_id": 0,
"head_img_url": "",
"title": "",
"price": 0,
"first_category_id": 0,
"second_category_id": 0,
"third_category_id": 0,
"data": {
"pay_gmv": 0,
"create_gmv": 0,
"create_cnt": 0,
"create_uv": 0,
"create_product_cnt": 0,
"pay_cnt": 0,
"pay_uv": 0,
"pay_product_cnt": 0,
"pure_pay_gmv": 0,
"pay_gmv_per_uv": 0,
"actual_commission": 0,
"predict_commission": 0,
"product_click_uv": 0,
"product_click_cnt": 0,
"pay_refund_gmv": 0,
"pay_refund_uv": 0,
"pay_refund_ratio": 0,
"pay_refund_after_send_ratio": 0,
"pay_refund_cnt": 0,
"pay_refund_product_cnt": 0,
"pay_refund_before_send_ratio": 0,
"refund_gmv": 0,
"refund_product_cnt": 0,
"refund_cnt": 0,
"refund_uv": 0
}
}
}
# 6. 错误码
以下是本接口的错误码列表，其他错误码可参考 通用错误码；调用接口遇到报错，可使用官方提供的 API 诊断工具 辅助定位和分析问题。
| 错误码 | 错误描述 | 解决方案 |
|---|---|---|
| 48001 | 接口权限未开启，需前往视频号助手- 开放能力-开放场景 打开开关 | |
| 10021069 | 请求参数日期格式有误 |
# 7. 适用范围
本接口支持「视频号助手」账号类型调用。其他账号类型如无特殊说明，均不可调用。