获取订单统计图表接口

获取订单统计图表数据,支持按不同订单状态查询历史趋势。

注意事项

  • 该接口采用GET方法
  • 需要用户登录验证
  • 支持查询不同订单状态的数据(待付款、待发货、待收货等)
  • 返回指定时间范围内的订单统计趋势数据
  • 数据以日期为维度,包含订单数量统计

请求地址

{域名地址}/api/orders/chart

说明:{域名地址} 需要替换成你的域名地址,如 https://www.anqicms.com/api/orders/chart

请求语法

GET {域名地址}/api/orders/chart

请求头

此接口还涉及公共请求头。更多信息,请参见公共请求头(Common Request Headers)

请求参数

字段名 类型 必填 说明
type string 统计类型,默认显示全部订单,其他值:pending(待付款订单)、processing(待发货订单)、completed(待收货订单)

响应头

此接口仅涉及公共响应头。更多信息,请参见公共请求头(Common Request Headers)

返回参数

字段名 类型 说明
code int 错误码
msg string 错误原因说明
data object[] 统计数据数组

data 结果 item 参数

字段名 类型 说明
date string 日期(格式:YYYY-MM-DD)
label string 统计项标签名称
value int 统计数值(订单数量)

使用示例

请求示例

GET /api/orders/chart?type=pending HTTP/1.1
Host: www.anqicms.com

响应示例

{
  "code": 0,
  "msg": "",
  "data": [
    {
      "date": "2021-08-01",
      "label": "待付款订单",
      "value": 1
    },
    {
      "date": "2021-08-02",
      "label": "待付款订单",
      "value": 2
    },
    {
      "date": "2021-08-03",
      "label": "待付款订单",
      "value": 0
    },
    {
      "date": "2021-08-04",
      "label": "待付款订单",
      "value": 3
    }
  ]
}

错误代码

错误码 说明
0 OK
-1 错误,错误原因在 msg 中指出
1001 未登录
1002 未授权
200 API 请求 OK