Get Order Statistics Chart Interface

Get order statistics chart data, supporting historical trend queries by different order statuses.

Precautions

This interface uses the GET method
User login verification is required
Support query data of different order statuses (pending payment, pending shipment, pending receipt, etc.)
Return order statistics trend data within a specified time range
Data is aggregated by date, including order quantity statistics

Request address

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

Description:{域名地址}Need to replace it with your domain address, such ashttps://en.anqicms.com/api/orders/chart

Request syntax

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

Request header

This interface also involves common request headers. For more information, please seeCommon Request Headers (Common Request Headers).

Request Parameters

Field Name	Type	Required	Description
type	string	No	Statistics type, default to show all orders, other values: pending (orders pending payment), processing (orders pending shipment), completed (orders pending delivery)

Response Headers

This interface only involves public response headers. More information, please refer toCommon Request Headers (Common Request Headers).

Return parameters

Field Name	Type	Description
code	integer	Error code
message	string	Error Description
data	object[]	Statistics array

data result item parameter

Field Name	Type	Description
date	string	Date (format: YYYY-MM-DD)
label	string	Statistics item label name
value	integer	Statistical value (order quantity)

Example Usage

Request Example

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

Response Example

{
  "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
    }
  ]
}

Error Code

Error code	Description
0	OK
-1	Error, the reason is indicated in msg
1001	Not logged in
1002	Unauthorized
200	API request OK