Installation

Sales reporting for Craft Commerce.

Requirements, install, and plugin settings. For a guided first run, see getting started.

Requirements#

• Craft CMS ^5.0.0
• Craft Commerce ^5.0.0
• PHP >=8.2

Install#

composer require fostercommerce/commerce-best-sellers
./craft plugin/install best-sellers

The plugin is also listed in the Craft Plugin Store as “Best Sellers”.

Installing creates three tables and adds a Best Sellers item to the control panel nav, visible to users with the best-sellers:viewReports permission. See permissions.

A fresh install reports zero for every past period until you backfill your existing orders. See data and backfill.

Configure#

Best Sellers -> Settings, a page inside the plugin’s own section rather than an entry under Settings -> Plugins. Gated by best-sellers:manageSettings.

• Default order statuses: statuses pre-selected in the global order status filter on a user’s first visit in a session. No default, which resolves to all statuses. A user’s own selection is stored in their session and takes precedence until it ends.

There is no config file. The setting is stored in project config through savePluginSettings().

Queue#

Backfills and full daily stats rebuilds run as queue jobs, so a worker has to be running for them to finish:

./craft queue/listen

Order saves aggregate that order’s day inline, so day-to-day tracking does not depend on the queue. Failures during a backfill job are written to a log table and listed on the Operations page.