Description
Sales by State Report for SureCart 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 SureCart 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 requires SureCart. 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
- Install and activate SureCart, then install and activate this plugin.
- Go to SureCart Sales by State.
- Choose a country, a year, and the order statuses that should count.
- The table lists Net Sales and Gross Sales for every state in that country.
If the store already has orders, the plugin imports them from the SureCart API into its report table in the background. A progress bar appears until that finishes. You can leave the page; the import 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 United Kingdom. Defaults to the store’s tax address country when that country has states, otherwise the United States.
- 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 SureCart order statuses. Defaults to Paid.
How the figures are calculated
Gross Sales is the checkout total. Net Sales is the checkout total minus tax and shipping. Both use the values SureCart stores on the checkout (converted from cents).
Refunds are not modelled as separate records. 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.
SureCart keeps orders on its API, not in a local WordPress table. Existing orders are imported from the SureCart API into the report table once. After that import, opening or changing the report filters does not call the API.
Data and privacy
The plugin creates one custom database table holding, per order: the order ID, order status, creation and payment dates, billing and shipping 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.
During the one-off import, and when a checkout is confirmed, the plugin reads order, checkout and address data from the SureCart API. It does not send data to any other service, includes no third-party analytics, and collects no telemetry.
Deleting the plugin removes the table and its options.
Installation
- Upload the plugin to
/wp-content/plugins/sales-by-state-report-for-surecart, or install it through the Plugins screen. - Activate the plugin. SureCart must already be installed and active.
- Go to SureCart Sales by State.
On a store that already has orders, those orders are read from the SureCart API 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 Paid is selected, tick any other statuses that should count.
To confirm how much of the import has finished, open Tools Site Health Info Sales by State Report for SureCart.
-
Where does the report appear?
-
Under SureCart Sales by State. Shop managers who can view SureCart orders can open it.
-
Which address does it group by?
-
The shipping address, falling back to the billing address for orders that have no shipping address, such as digital-only orders.
-
Are refunds deducted?
-
The status filter decides whether an order counts. Partial refunds are not deducted from the order’s total.
-
Which date does the year filter use?
-
The invoice issue date when the checkout belongs to an invoice, then the date the checkout was paid, then the date the order was created.
-
Can I change the default order status?
-
Yes, with the
sbssc_default_statusesfilter. -
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 SureCart” is open source software. The following people have contributed to this plugin.
ContributorsTranslate “Sales by State Report for SureCart” into your language.
Interested in development?
Browse the code, check out the SVN repository, or subscribe to the development log by RSS.
Changelog
1.0.1
- Code style cleanup, no functional change. Fixed WP.org listing banner.
1.0.0
- Initial release.
