Sales by State Report for EDD

Description

Sales by State Report for Easy Digital Downloads adds a report showing net and gross sales grouped by state, county, or province, for a chosen year and a chosen set of order statuses.

It appears under Downloads Sales by State. Shop managers can also rebuild the report table from Downloads Tools Sales by State.

Use it when you need to know how much each state bought in a given year, counting only the order statuses that matter for sales tax or territory planning.

This plugin is an Easy Digital Downloads extension. It requires Easy Digital Downloads 3.0 or later. There are no settings screens to configure. After you activate the plugin, open the report and choose a country, year, and order statuses.

Documentation: salesbystate.com

How to use

  1. Install and activate Easy Digital Downloads, then install and activate this plugin.
  2. Go to Downloads Sales by State.
  3. Choose a country, a year, and the order statuses that should count.
  4. The table lists Net Sales and Gross Sales for every state in that country.

If the store already has orders, the plugin copies them into its report table in the background. A progress bar appears until that finishes. You can leave the page; the copy continues on its own.

What the report shows

  • Net Sales and Gross Sales for every state in the selected country
  • A summary of both figures across all states
  • Sortable columns and paginated results
  • States with no sales, shown as zero rather than hidden

Filters

  • Country — United States, Canada, and the United Kingdom. Defaults to the store’s business country.
  • Year — a rolling list that starts ten years back and gains a year each January without dropping one. Defaults to the current year.
  • Order status — a checkbox list of EDD order statuses. Defaults to Completed.

How the figures are calculated

Gross Sales is the order total. Net Sales is the order total minus tax. Shipping is not part of Easy Digital Downloads core, so it is stored as zero. Both use the values EDD stores on the order.

Refunds are not modelled as separate records. An EDD refund order (type = refund) is ignored. An order that has been fully refunded is controlled by the status filter. A partial refund is not deducted from its order’s total.

Performance

Sales for a whole year are answered by one indexed query that returns one row per state. The response size does not grow with the number of orders.

Data and privacy

The plugin creates one custom database table holding, per order: the order ID, order status, creation and completed dates, billing country and state codes, currency, and the order, tax, shipping and net totals. It stores no names, addresses, email addresses or any other personal data.

Nothing is sent anywhere. The plugin makes no external HTTP requests, includes no third-party services, and collects no analytics or telemetry.

Deleting the plugin removes the table and its options.

Installation

  1. Upload the plugin to /wp-content/plugins/sales-by-state-report-for-edd, or install it through the Plugins screen.
  2. Activate the plugin. Easy Digital Downloads must already be installed and active.
  3. Go to Downloads Sales by State.

On a store that already has orders, those orders are read into the report table once. This starts on its own. If it has not finished when you open the report, a progress bar shows how far along it is.

FAQ

The report shows zeros but I have orders.

Your existing orders are still being read into the report table. Open the report and the progress bar will show how far along it is. It continues on its own; you can leave the page.

If only Completed is selected, tick any other statuses that should count.

Which address does it group by?

The billing address. Easy Digital Downloads is for digital products, so there is no shipping address on the order.

Are refunds deducted?

The status filter decides whether an order counts. Partial refunds are not deducted from the order’s total. EDD refund records (order type refund) are not imported.

Which date does the year filter use?

The date the order was completed, falling back to the date it was created for orders that were never completed.

Can I change the default order status?

Yes, with the sbsedd_default_statuses filter.

Where can I get support?

Use the WordPress.org support forum for this plugin.

Reviews

There are no reviews for this plugin.

Contributors & Developers

“Sales by State Report for EDD” is open source software. The following people have contributed to this plugin.

Contributors

Changelog

1.0.0

  • Initial release.