Get Order Statistical Chart Data, supports querying historical trends based on different order statuses.
Points to note
- This interface uses the GET method
- User login verification required
- Support querying data for different order statuses (pending payment, pending shipment, pending receipt, etc.)
- Return order statistics trend data within a specified time range
- Data is dimensioned by date, including order quantity statistics
Request address
{域名地址}/api/orders/chart
Description:{域名地址}Replace it with your domain name, such ashttps://en.anqicms.com/api/orders/chart
Request Syntax
GET {域名地址}/api/orders/chart
Request Headers
This interface also involves common request headers. For more information, please refer toCommon Request Headers (Common Request Headers).
Request parameters
| Field name | Type | Required | Description |
|---|---|---|---|
| type | string | No | Type of statistics, default to display all orders, other values: pending (orders to be paid), processing (orders to be shipped), completed (orders to be received) |
Response header
This interface only involves public response headers. For more information, please refer toCommon Request Headers (Common Request Headers).
Return parameters
| Field name | Type | Description |
|---|---|---|
| code | int | Error code |
| msg | string | Error description |
| data | object[] | statistical data array |
data result item parameter
| Field name | Type | Description |
|---|---|---|
| date | string | date (format: YYYY-MM-DD) |
| label | string | statistical item label name |
| value | int | statistical value (order quantity) |
Usage Example
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 | Not authorized |
| 200 | API request OK |