Commerce Reporting provides reports and a foundation for building custom reports and dashboards for Drupal Commerce.

When an order is placed, the module records the data needed for reporting in its own report table. Reports query that table instead of the live order data, so they stay fast on high-volume stores, and the report data is available in Views for building your own reports.

Sponsored and maintained by Centarro.

Features

  • Report types for orders, order items, promotions (with Commerce Promotion) and taxes (with Commerce Tax)
  • A Sales report under Commerce > Reports, with daily, weekly, monthly and yearly displays
  • A Purchased items report showing sales by product
  • Report data exposed to Views, with aggregation and timezone-aware date grouping, for building custom reports
  • A batch form to generate or regenerate reports for existing orders, for all report types or a single one
  • Other modules can add their own report types as plugins
  • Separate permissions for viewing reports and generating them

Looking for Drupal Commerce support?

Hire the project maintainers:
Centarro offers Drupal Commerce Support and Development services, ranging from a flat monthly fee for maintenance support (with optional development retainers) to full site architecture and development.
Community support options:
Over 2,000 developers participate in our two support channels on a best-effort basis, Drupal Answers and Drupal Slack (channel: #commerce).

Drupal 9, 10 & 11 / Commerce Reporting 8.x-1.0-rc4

Installation

Commerce Reporting should only be installed via Composer. The zip files on this page are provided for informative purposes only.

composer require 'drupal/commerce_reports:^1.0@RC'

Works with Commerce 2.x and 3.x. Drupal 11 with Commerce 3.x is recommended. Drupal 9 is end of life and no longer receives security updates, so plan to upgrade.

After installing on a site with existing orders, generate reports for them at Commerce > Configuration > Reports > Generate reports.

Note on report data

Reports are a snapshot of each order at the time it was placed. Later changes, such as refunds, cancellations or edits to the order, aren't reflected until the reports are regenerated. Generating reports for all orders can take a while on large stores, so run it during a quiet period.

For more information, see the Commerce Reporting documentation.

Supporting organizations: 
Drupal 8 port, maintenance

Project information

Releases