# 获取电商数据概览

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

接口英文名:getshopoverall

通过该接口可获取电商数据概览。

# 1. 调用方式

# HTTPS 调用

POST https://api.weixin.qq.com/channels/ec/compass/shop/overall/get?access_token=ACCESS_TOKEN

# 云调用

  • 本接口不支持云调用

# 第三方调用

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

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

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

# 2. 请求参数

# 查询参数 Query String parameters

参数名类型必填示例说明
access_tokenstringACCESS_TOKEN接口调用凭证,可使用 access_tokenauthorizer_access_token

# 请求体 Request Payload

参数名类型必填示例说明
dsstring20240520日期,格式YYYYMMDD

# 3. 返回参数

# 返回体 Response Payload

参数名类型示例说明
errcodenumber0错误码
errmsgstringok错误信息
dataobject电商数据

# Res.data Object Payload

电商数据

参数名类型说明
pay_gmvstring成交金额,单位分
pay_uvstring成交人数
pay_order_cntstring成交退款金额,单位分
pay_refund_gmvstring成交订单数
live_pay_gmvstring直播成交金额,单位分
feed_pay_gmvstring短视频成交金额,单位分

# 4. 注意事项

本接口无特殊注意事项

# 5. 代码示例

请求示例

{
    "ds": "20240520"
}

返回示例

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "pay_gmv": "42292",
    "pay_uv": "8",
    "pay_order_cnt": "10",
    "pay_refund_gmv": "81",
    "live_pay_gmv": "0",
    "feed_pay_gmv": "0"
  }
}

# 6. 错误码

以下是本接口的错误码列表,其他错误码可参考 通用错误码

错误码错误描述解决方案
10021069请求参数日期格式有误

# 7. 适用范围

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