# 获取商品列表

> 接口应在服务器端调用，不可在前端（小程序、网页、APP等）直接调用，具体可参考[接口调用指南](/doc/oplatform/developers/dev/guide.md)。

接口英文名：getshopproductlist

通过该接口可获取商品列表。（仅历史数据，暂无当日数据） 

[数据分析开发指南](/doc/store/shop/guide/operation/analytics)

## 1. 调用方式

### HTTPS 调用

```bash
POST https://api.weixin.qq.com/channels/ec/compass/shop/product/list/get?access_token=ACCESS_TOKEN
```

### 云调用

- 本接口不支持云调用。

### 第三方调用

- 本接口支持第三方平台代微信小店商家调用。[第三方服务商调用模式介绍](/doc/store/shop/dev_before/third_party_platforms)

- 该接口所属的权限集 id 为：175

- 服务商获得其中之一权限集授权后，可通过使用 [authorizer_access_token](/doc/oplatform/developers/dev/AuthorizerAccessToken.md) 代微信小店商家进行调用，具体可查看 [第三方调用](/doc/oplatform/Third-party_Platforms/2.0/Before_Develop/call_interface.md) 说明文档。

## 2. 请求参数

### 查询参数 `Query String Parameters`

```json
[
  {
    "参数名": "access_token",
    "类型": "string",
    "必填": "是",
    "示例": "ACCESS_TOKEN",
    "说明": "接口调用凭证，可使用 [access_token](/doc/store/shop/API/apimgnt/common/api_getaccesstoken)（微信小店商家）、[authorizer_access_token](/doc/oplatform/openApi/ticket-token/api_getauthorizeraccesstoken.md)（服务商代调用）"
  }
]
```

### 请求体 `Request Payload`

```json
[
  {
    "参数名": "ds",
    "类型": "string",
    "必填": "是",
    "说明": "日期，格式YYYYMMDD"
  },
  {
    "参数名": "limit",
    "类型": "number",
    "必填": "否",
    "说明": "分页参数，如果不填，默认只会返回10条商品数据"
  },
  {
    "参数名": "offset",
    "类型": "number",
    "必填": "否",
    "说明": "分页参数，如果不填，默认只会返回10条商品数据"
  }
]
```

## 3. 返回参数

### 返回体 `Response Payload`

```json
[
  {
    "参数名": "errcode",
    "类型": "number",
    "示例": "0",
    "说明": "错误码"
  },
  {
    "参数名": "errmsg",
    "类型": "string",
    "示例": "ok",
    "说明": "错误信息"
  },
  {
    "参数名": "product_list",
    "类型": "objarray",
    "示例": "",
    "说明": "商品列表"
  },
  {
    "参数名": "total_count",
    "类型": "number",
    "示例": "",
    "说明": "一共有多少条商品信息"
  }
]
```

">

### Res.product_list(Array) `Object Payload`

商品列表

```json
[
  {
    "参数名": "product_id",
    "类型": "string",
    "说明": "商品id"
  },
  {
    "参数名": "data",
    "类型": "object",
    "说明": "详细数据"
  }
]
```

__data">

### Res.product_list(Array).data `Object Payload`

详细数据

```json
[
  {
    "参数名": "pay_gmv",
    "类型": "string",
    "说明": "成交金额，单位分"
  },
  {
    "参数名": "create_gmv",
    "类型": "string",
    "说明": "下单金额，单位分"
  },
  {
    "参数名": "create_cnt",
    "类型": "string",
    "说明": "下单订单数"
  },
  {
    "参数名": "create_uv",
    "类型": "string",
    "说明": "下单人数"
  },
  {
    "参数名": "create_product_cnt",
    "类型": "string",
    "说明": "下单件数"
  },
  {
    "参数名": "pay_cnt",
    "类型": "string",
    "说明": "成交订单数"
  },
  {
    "参数名": "pay_uv",
    "类型": "string",
    "说明": "成交人数"
  },
  {
    "参数名": "pay_product_cnt",
    "类型": "string",
    "说明": "成交件数"
  },
  {
    "参数名": "pure_pay_gmv",
    "类型": "string",
    "说明": "成交金额（剔除退款）"
  },
  {
    "参数名": "pay_gmv_per_uv",
    "类型": "string",
    "说明": "成交客单价（剔除退款）"
  },
  {
    "参数名": "platform_actual_commission",
    "类型": "string",
    "说明": "实际服务费金额，单位分"
  },
  {
    "参数名": "finderuin_actual_commission",
    "类型": "string",
    "说明": "实际达人佣金支出，单位分"
  },
  {
    "参数名": "captain_actual_commission",
    "类型": "string",
    "说明": "实际团长佣金支出，单位分"
  },
  {
    "参数名": "platform_predict_commission",
    "类型": "string",
    "说明": "预估服务费金额，单位分"
  },
  {
    "参数名": "finderuin_predict_commission",
    "类型": "string",
    "说明": "预估达人佣金支出，单位分"
  },
  {
    "参数名": "captain_predict_commission",
    "类型": "string",
    "说明": "预估团长佣金支出，单位分"
  },
  {
    "参数名": "product_click_uv",
    "类型": "string",
    "说明": "商品点击人数"
  },
  {
    "参数名": "product_click_cnt",
    "类型": "string",
    "说明": "商品点击次数"
  },
  {
    "参数名": "pay_refund_gmv",
    "类型": "string",
    "说明": "成交退款金额，单位分"
  },
  {
    "参数名": "pay_refund_uv",
    "类型": "string",
    "说明": "成交退款人数，单位分"
  },
  {
    "参数名": "pay_refund_ratio",
    "类型": "null",
    "说明": "成交退款率"
  },
  {
    "参数名": "refund_gmv",
    "类型": "string",
    "说明": "退款件数"
  },
  {
    "参数名": "refund_product_cnt",
    "类型": "string",
    "说明": "退款件数"
  },
  {
    "参数名": "refund_cnt",
    "类型": "string",
    "说明": "退款订单数"
  },
  {
    "参数名": "refund_uv",
    "类型": "string",
    "说明": "退款人数"
  },
  {
    "参数名": "pay_refund_cnt",
    "类型": "string",
    "说明": "成交退款订单数"
  }
]
```

## 4. 注意事项

本接口无特殊注意事项

## 5. 代码示例

请求示例

```json
{
    "ds": "20240520"
}
```

返回示例

```json
{
  "errcode": 0,
  "errmsg": "ok",
  "total_count": 54,
  "product_list": [
    {
      "product_id": "10000054370820",
      "head_img_url": "https://store.mp.video.tencent-cloud.com/161/20304/snscosdownload/SZ/reserved/64ad0d7000005f161ed22d3e51618809000000a000004f50?imageView2/1/w/800/h/800/q/50",
      "title": "榴莲yyds",
      "price": "1",
      "first_category_id": "6625",
      "second_category_id": "6631",
      "third_category_id": "545264",
      "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",
        "seller_actual_settle_amount": "1",
        "platform_actual_commission": "0",
        "finderuin_actual_commission": "0",
        "captain_actual_commission": "0",
        "seller_predict_settle_amount": "0",
        "platform_predict_commission": "0",
        "finderuin_predict_commission": "0",
        "captain_predict_commission": "0",
        "product_click_uv": "0",
        "product_click_cnt": "0",
        "pay_refund_gmv": "0",
        "pay_refund_uv": "0",
        "pay_refund_ratio": 0.0,
        "pay_refund_after_send_ratio": 0.0,
        "pay_refund_cnt": "0",
        "pay_refund_product_cnt": "0",
        "pay_refund_before_send_ratio": 0.0,
        "refund_gmv": "0",
        "refund_product_cnt": "0",
        "refund_cnt": "0",
        "refund_uv": "0"
      }
    }
  ]
}
```

## 6. 错误码

以下是本接口的错误码列表，其他错误码可参考 [通用错误码](/doc/store/shop/dev_before/commErrCode)；调用接口遇到报错，可使用官方提供的 [API 诊断工具](https://developers.weixin.qq.com/console/devtools/debug?utm_source=api_errcode) 辅助定位和分析问题。

```json
[
  {
    "错误码": "10021069",
    "错误描述": "请求参数日期格式有误"
  }
]
```

## 7. 适用范围

本接口支持「微信小店」账号类型调用。其他账号类型如无特殊说明，均不可调用。

![](https://res8.wxqcloud.qq.com.cn/wxdoc/56617deb-b17d-4cf1-bccd-71d2c41ccc76.svg)接口变更日志（1条）
2025 年 11 月 24 日新增  `pay_refund_cnt`  字段，删除  `pay_refund_before_send_ratio`  等废弃字段
