title: "报告 #" post_status: publish comment_status: open taxonomy: category: - woocommerce-rest-api post_tag: - V3 - Includes - Source
报告
本节列出了所有可用于查看报告的 API 端点。
报告过滤器
对于任何类型的报告，可使用以下过滤器来指定销售时段：
| 过滤器 | 类型 | 描述 |
|---|---|---|
period |
字符串 | 支持的时段有：week、month、last_month 和 year。如果使用了无效的时段，则默认使用 week。如果未指定时段，则使用当天 |
date_min |
字符串 | 返回特定开始日期的销售数据。日期需为 YYYY-MM-DD 格式 |
date_max |
字符串 | 返回特定结束日期的销售数据。日期需为 YYYY-MM-DD 格式。设置此参数时也必须设置 filter[date_min] |
查看报告列表
此 API 允许您检索并查看可用报告的简单列表。
HTTP 请求
GET
/wc-api/v3/reports
curl https://example.com/wc-api/v3/reports \
-u consumer_key:consumer_secret
WooCommerce.get('reports', function(err, data, res) {
console.log(res);
});
<?php print_r($woocommerce->get('reports')); ?>
print(wcapi.get("reports").json())
woocommerce.get("reports").parsed_response
JSON 响应示例：
{
"reports": [
"sales",
"sales/top_sellers"
]
}
查看销售报告列表
此 API 允许您检索并查看销售报告列表。
HTTP 请求
GET
/wc-api/v3/reports/sales
curl https://example.com/wc-api/v3/reports/sales?filter[date_min]=2015-01-18&filter[date_max]=2015-01-21 \
-u consumer_key:consumer_secret
WooCommerce.get('reports/sales?filter[date_min]=2015-01-18&filter[date_max]=2015-01-21', function(err, data, res) {
console.log(res);
});
<?php
$query = [
'filter' => [
'date_min' => '2015-01-18',
'date_max' => '2015-01-21'
]
];
print_r($woocommerce->get('reports/sales', $query));
?>
print(wcapi.get("reports/sales?filter[date_min]=2015-01-18&filter[date_max]=2015-01-21").json())
query = {
filter: {
date_min: "2015-01-18",
date_max: "2015-01-21"
}
}
woocommerce.get("reports/sales", query).parsed_response
JSON 响应示例：
{
"sales": {
"total_sales": "580.10",
"average_sales": "145.03",
"total_orders": 4,
"total_items": 31,
"total_tax": "26.10",
"total_shipping": "20.00",
"total_discount": "0.00",
"totals_grouped_by": "day",
"totals": {
"2015-01-18": {
"sales": "-17.00",
"orders": 1,
"items": 1,
"tax": "0.00",
"shipping": "0.00",
"discount": "0.00",
"customers": 0
},
"2015-01-19": {
"sales": "0.00",
"orders": 0,
"items": 0,
"tax": "0.00",
"shipping": "0.00",
"discount": "0.00",
"customers": 0
},
"2015-01-20": {
"sales": "0.00",
"orders": 0,
"items": 0,
"tax": "0.00",
"shipping": "0.00",
"discount": "0.00",
"customers": 0
},
"2015-01-21": {
"sales": "597.10",
"orders": 3,
"items": 30,
"tax": "26.10",
"shipping": "20.00",
"discount": "0.00",
"customers": 0
}
},
"total_customers": 0
}
}
查看热销商品报告列表
此 API 允许您检索并查看热销商品报告列表。
HTTP 请求
GET
/wc-api/v3/reports/sales/top_sellers
curl https://example.com/wc-api/v3/reports/sales/top_sellers?filter[period]=last_month \
-u consumer_key:consumer_secret
WooCommerce.get('reports/sales/top_sellers?filter[period]=last_month', function(err, data, res) {
console.log(res);
});
<?php
$query = [
'filter' => [
'period' => 'last_month'
]
];
print_r($woocommerce->get('reports/sales/top_sellers', $query));
?>
print(wcapi.get("reports/sales/top_sellers?filter[period]=last_month").json())
query = {
filter: {
period: "last_month"
}
}
woocommerce.get("reports/sales/top_sellers", query).parsed_response
JSON 响应示例：
{
"top_sellers": [
{
"title": "Happy Ninja",
"product_id": "37",
"quantity": "24"
},
{
"title": "Flying Ninja",
"product_id": "70",
"quantity": "14"
},
{
"title": "Happy Ninja",
"product_id": "53",
"quantity": "6"
},
{
"title": "Ninja Silhouette",
"product_id": "31",
"quantity": "3"
},
{
"title": "Woo Logo",
"product_id": "15",
"quantity": "3"
},
{
"title": "Woo Album #1",
"product_id": "83",
"quantity": "3"
},
{
"title": "Woo Album #4",
"product_id": "96",
"quantity": "1"
},
{
"title": "Premium Quality",
"product_id": "19",
"quantity": "1"
},
{
"title": "Ninja Silhouette",
"product_id": "56",
"quantity": "1"
}
]
}