WooReportApi extension

WooCommerce Report API Extension

This extension provides comprehensive reporting capabilities for WooCommerce stores. It enables retrieval of sales analytics, top sellers data, and various total reports to help store owners understand their business performance.

Key Features

  • Sales Analytics: Get detailed sales reports with financial metrics
  • Top Sellers: Identify best-performing products and their sales data
  • Total Reports: Access aggregated data for coupons, customers, orders, products, and reviews
  • Flexible Time Periods: Generate reports for different time ranges (week, month, year)
  • Date Range Filtering: Specify custom date ranges for reports

Example Usage

// Get sales report for current month
final salesReport = await wooCommerce.getSalesReport(
  period: WooReportPeriod.month,
);

// Get top sellers for last month
final topSellers = await wooCommerce.getTopSellersReport(
  period: WooReportPeriod.last_month,
);

// Get coupon totals
final couponTotals = await wooCommerce.getCouponsTotalReport();
on

Methods

getCouponsTotalReport({bool? useFaker}) → Future<List<WooCouponTotalReport>>

Available on WooCommerce, provided by the WooReportApi extension

Retrieves the coupon totals report from the WooCommerce store.
getCustomersTotalReport({bool? useFaker}) → Future<List<WooCustomerTotalReport>>

Available on WooCommerce, provided by the WooReportApi extension

Retrieves the customer totals report from the WooCommerce store.
getOrdersTotalReport({bool? useFaker}) → Future<List<WooOrderTotalReport>>

Available on WooCommerce, provided by the WooReportApi extension

Retrieves the order totals report from the WooCommerce store.
getProductReviewsTotalReport({bool? useFaker}) → Future<List<WooProductReviewTotalReport>>

Available on WooCommerce, provided by the WooReportApi extension

Retrieves the product review totals report from the WooCommerce store.
getProductsTotalReport({bool? useFaker}) → Future<List<WooProductTotalReport>>

Available on WooCommerce, provided by the WooReportApi extension

Retrieves the product totals report from the WooCommerce store.
getSalesReport({WooContext context = WooContext.view, WooReportPeriod? period, String? dateMin, String? dateMax, bool? useFaker}) → Future<List<WooSalesReport>>

Available on WooCommerce, provided by the WooReportApi extension

Retrieves a comprehensive sales report from the WooCommerce store.
getTopSellersReport({WooContext context = WooContext.view, WooReportPeriod? period, String? dateMin, String? dateMax, bool? useFaker}) → Future<List<WooTopSellersReport>>

Available on WooCommerce, provided by the WooReportApi extension

Retrieves the top sellers report from the WooCommerce store.