Enqueues the orders-list column stylesheet properly and confirms compatibility with WordPress 7.1.<\/p>","0.1.0":"
First public release. Requires WooCommerce 10.3 or newer with both the Cost of Goods Sold feature and WooCommerce Analytics enabled. Only orders placed after Cost of Goods Sold was switched on carry cost data, so earlier orders report as uncosted unless you use estimated mode.<\/p>"},"ratings":[],"assets_icons":{"icon-128x128.png":{"filename":"icon-128x128.png","revision":3667541,"resolution":"128x128","location":"assets","locale":"","width":128,"height":128},"icon-256x256.png":{"filename":"icon-256x256.png","revision":3667541,"resolution":"256x256","location":"assets","locale":"","width":256,"height":256},"icon.svg":{"filename":"icon.svg","revision":3667541,"resolution":false,"location":"assets","locale":false}},"assets_banners":{"banner-1544x500.png":{"filename":"banner-1544x500.png","revision":3667541,"resolution":"1544x500","location":"assets","locale":"","width":1544,"height":500},"banner-772x250.png":{"filename":"banner-772x250.png","revision":3667541,"resolution":"772x250","location":"assets","locale":"","width":772,"height":250},"banner.svg":{"filename":"banner.svg","revision":3667541,"resolution":false,"location":"assets","locale":false}},"assets_blueprints":{"blueprint.json":{"filename":"blueprint.json","revision":3667541,"resolution":false,"location":"assets","locale":"","contents":"{\"$schema\":\"https:\\\/\\\/playground.wordpress.net\\\/blueprint-schema.json\",\"meta\":{\"title\":\"Profit Margin Reports for WooCommerce\",\"description\":\"Turns WooCommerce's Cost of Goods Sold data into the profit and margin reports core does not provide.\",\"categories\":[\"Analytics\",\"eCommerce\"],\"author\":\"profit-margin-reports\"},\"landingPage\":\"\\\/wp-admin\\\/admin.php?page=profit-margin-reports\",\"preferredVersions\":{\"php\":\"8.2\",\"wp\":\"latest\"},\"features\":{\"networking\":true},\"login\":true,\"steps\":[{\"step\":\"installPlugin\",\"pluginData\":{\"resource\":\"wordpress.org\\\/plugins\",\"slug\":\"woocommerce\"},\"options\":{\"activate\":true}},{\"step\":\"activatePlugin\",\"pluginPath\":\"profit-margin-reports-for-woocommerce\\\/profit-margin-reports-for-woocommerce.php\"},{\"step\":\"setSiteOptions\",\"options\":{\"woocommerce_feature_cost_of_goods_sold_enabled\":\"yes\",\"woocommerce_analytics_enabled\":\"yes\",\"woocommerce_onboarding_profile\":{\"skipped\":true},\"woocommerce_task_list_hidden\":\"yes\",\"woocommerce_currency\":\"USD\",\"blogname\":\"Profit Margin Reports demo\"}},{\"step\":\"writeFile\",\"path\":\"\\\/tmp\\\/demo-data.php\",\"data\":\" $category ) );\\n\\t\\t}\\n\\n\\t\\t$product = new WC_Product_Simple();\\n\\t\\t$product->set_name( $name );\\n\\t\\t$product->set_status( 'publish' );\\n\\t\\t$product->set_catalog_visibility( 'visible' );\\n\\t\\t$product->set_regular_price( (string) $price );\\n\\t\\t$product->set_price( (string) $price );\\n\\t\\t$product->set_manage_stock( false );\\n\\t\\t$product->set_stock_status( 'instock' );\\n\\t\\tif ( ! is_wp_error( $term ) && isset( $term['term_id'] ) ) {\\n\\t\\t\\t$product->set_category_ids( array( (int) $term['term_id'] ) );\\n\\t\\t}\\n\\n\\t\\tif ( $cost > 0 && method_exists( $product, 'set_cogs_value' ) ) {\\n\\t\\t\\t$product->set_cogs_value( (float) $cost );\\n\\t\\t}\\n\\n\\t\\t$product_id = $product->save();\\n\\t\\t$product_ids[] = $product_id;\\n\\t}\\n\\n\\t$statuses = array( 'completed', 'completed', 'completed', 'processing', 'on-hold' );\\n\\t$stats_store = '\\\\Automattic\\\\WooCommerce\\\\Admin\\\\API\\\\Reports\\\\Orders\\\\Stats\\\\DataStore';\\n\\t$prod_store = '\\\\Automattic\\\\WooCommerce\\\\Admin\\\\API\\\\Reports\\\\Products\\\\DataStore';\\n\\t$made = 0;\\n\\n\\t\\\/*\\n\\t * Sixty days, not thirty. The dashboard opens on \\\"last 30 days\\\" and compares it with the\\n\\t * thirty before it, so a thirty-day seed leaves every comparison reading as an em dash and the\\n\\t * preview looks broken rather than empty. Sixty days is the smallest span that makes the\\n\\t * comparison real while still booting quickly under WebAssembly.\\n\\t *\\\/\\n\\tfor ( $day = 59; $day >= 0; $day-- ) {\\n\\t\\t\\\/*\\n\\t\\t * $day counts down to today, so days 0-29 are the period the dashboard opens on and\\n\\t\\t * 30-59 are the comparison behind it. Give the recent half more volume: with a flat\\n\\t\\t * distribution every delta lands on roughly 0% and the comparison looks broken in a\\n\\t\\t * different way than an em dash does.\\n\\t\\t *\\\/\\n\\t\\t$is_recent = $day < 30;\\n\\t\\t$orders_today = ( 0 === $day % 6 ) ? 3 : 2;\\n\\t\\tif ( $is_recent && 0 === $day % 3 ) {\\n\\t\\t\\t++$orders_today;\\n\\t\\t}\\n\\n\\t\\tfor ( $n = 0; $n < $orders_today; $n++ ) {\\n\\t\\t\\t$order = wc_create_order();\\n\\t\\t\\tif ( is_wp_error( $order ) ) {\\n\\t\\t\\t\\tcontinue;\\n\\t\\t\\t}\\n\\n\\t\\t\\t$line_count = 1 + ( ( $day + $n ) % 3 );\\n\\t\\t\\tfor ( $l = 0; $l < $line_count; $l++ ) {\\n\\t\\t\\t\\t$pid = $product_ids[ ( $day + $n + $l ) % count( $product_ids ) ];\\n\\t\\t\\t\\t$product = wc_get_product( $pid );\\n\\t\\t\\t\\tif ( $product ) {\\n\\t\\t\\t\\t\\t$order->add_product( $product, 1 + ( ( $day + $l ) % 2 ) );\\n\\t\\t\\t\\t}\\n\\t\\t\\t}\\n\\n\\t\\t\\tif ( ! $order->get_items() ) {\\n\\t\\t\\t\\t$order->delete( true );\\n\\t\\t\\t\\tcontinue;\\n\\t\\t\\t}\\n\\n\\t\\t\\t$order->set_billing_first_name( 'Demo' );\\n\\t\\t\\t$order->set_billing_last_name( 'Customer ' . ( ( $day * 10 ) + $n ) );\\n\\t\\t\\t$order->set_billing_country( 'US' );\\n\\t\\t\\t$order->set_date_created( gmdate( 'Y-m-d H:i:s', time() - ( $day * DAY_IN_SECONDS ) - ( $n * HOUR_IN_SECONDS ) ) );\\n\\n\\t\\t\\t\\\/\\\/ calculate_totals() is what records the per-line cost snapshot.\\n\\t\\t\\t$order->calculate_totals( false );\\n\\n\\t\\t\\t$status = $statuses[ ( $day + $n ) % count( $statuses ) ];\\n\\t\\t\\t$order->set_status( $status );\\n\\t\\t\\t$order->set_date_paid( $order->get_date_created() );\\n\\t\\t\\t$order_id = $order->save();\\n\\n\\t\\t\\t\\\/\\\/ Refund one order a week so the refund handling is visible in the demo.\\n\\t\\t\\t$refund_id = 0;\\n\\t\\t\\tif ( 0 === $day % 7 && 0 === $n && 'completed' === $status ) {\\n\\t\\t\\t\\t$items = $order->get_items( 'line_item' );\\n\\t\\t\\t\\t$first = reset( $items );\\n\\t\\t\\t\\tif ( $first && $first->get_quantity() > 0 ) {\\n\\t\\t\\t\\t\\t$unit = (float) $first->get_total() \\\/ max( 1, $first->get_quantity() );\\n\\t\\t\\t\\t\\tif ( $unit > 0 ) {\\n\\t\\t\\t\\t\\t\\t$refund = wc_create_refund(\\n\\t\\t\\t\\t\\t\\t\\tarray(\\n\\t\\t\\t\\t\\t\\t\\t\\t'order_id' => $order_id,\\n\\t\\t\\t\\t\\t\\t\\t\\t'amount' => round( $unit, 2 ),\\n\\t\\t\\t\\t\\t\\t\\t\\t'reason' => 'Demo refund',\\n\\t\\t\\t\\t\\t\\t\\t\\t'line_items' => array(\\n\\t\\t\\t\\t\\t\\t\\t\\t\\t$first->get_id() => array(\\n\\t\\t\\t\\t\\t\\t\\t\\t\\t\\t'qty' => 1,\\n\\t\\t\\t\\t\\t\\t\\t\\t\\t\\t'refund_total' => round( $unit, 2 ),\\n\\t\\t\\t\\t\\t\\t\\t\\t\\t),\\n\\t\\t\\t\\t\\t\\t\\t\\t),\\n\\t\\t\\t\\t\\t\\t\\t)\\n\\t\\t\\t\\t\\t\\t);\\n\\t\\t\\t\\t\\t\\tif ( $refund && ! is_wp_error( $refund ) ) {\\n\\t\\t\\t\\t\\t\\t\\t$refund_id = $refund->get_id();\\n\\t\\t\\t\\t\\t\\t}\\n\\t\\t\\t\\t\\t}\\n\\t\\t\\t\\t}\\n\\t\\t\\t}\\n\\n\\t\\t\\t\\\/*\\n\\t\\t\\t * Action Scheduler never runs here, so WooCommerce would leave its Analytics lookup\\n\\t\\t\\t * tables empty and every report would read zero. Sync inline instead.\\n\\t\\t\\t *\\\/\\n\\t\\t\\t$to_sync = array( $order_id );\\n\\n\\t\\t\\t\\\/*\\n\\t\\t\\t * A refund is its own order record, and WooCommerce writes a separate lookup row for\\n\\t\\t\\t * it. Syncing only the parent leaves the refund unimported, which the plugin correctly\\n\\t\\t\\t * reports as \\\"some orders are missing from Analytics\\\" - accurate, but a warning banner\\n\\t\\t\\t * is not what the preview should open with.\\n\\t\\t\\t *\\\/\\n\\t\\t\\tif ( $refund_id ) {\\n\\t\\t\\t\\t$to_sync[] = $refund_id;\\n\\t\\t\\t}\\n\\n\\t\\t\\tforeach ( $to_sync as $sync_id ) {\\n\\t\\t\\t\\tif ( is_callable( array( $stats_store, 'sync_order' ) ) ) {\\n\\t\\t\\t\\t\\tcall_user_func( array( $stats_store, 'sync_order' ), $sync_id );\\n\\t\\t\\t\\t}\\n\\t\\t\\t\\tif ( is_callable( array( $prod_store, 'sync_order_products' ) ) ) {\\n\\t\\t\\t\\t\\tcall_user_func( array( $prod_store, 'sync_order_products' ), $sync_id );\\n\\t\\t\\t\\t}\\n\\t\\t\\t}\\n\\n\\t\\t\\t++$made;\\n\\t\\t}\\n\\t}\\n\\n\\t\\\/\\\/ Stop WooCommerce showing an \\\"importing analytics\\\" banner over the demo.\\n\\tupdate_option(\\n\\t\\t'woocommerce_admin_import_stats',\\n\\t\\tarray(\\n\\t\\t\\t'imported_from' => '0',\\n\\t\\t\\t'is_importing' => false,\\n\\t\\t)\\n\\t);\\n\\n\\tif ( defined( 'WP_CLI' ) && WP_CLI ) {\\n\\t\\tWP_CLI::log( \\\"Playground demo data: {$made} orders across \\\" . count( $product_ids ) . ' products.' );\\n\\t}\\n}\\n\\n\\\/*\\n * Deliberately NOT self-executing. The Playground blueprint requires this file and then\\n * calls the function itself, so a trailing call here would seed the store twice - which it\\n * silently did, producing double the products and orders.\\n *\\\/\\n\"},{\"step\":\"runPHP\",\"code\":\"\n
WooCommerce ships the cost data. It does not ship the report.<\/p>\n\n
With the Cost of Goods Sold feature enabled, WooCommerce stores a cost for each product and stamps a cost snapshot onto every order line as the order is placed. Then it stops. WooCommerce's own documentation states that Cost of Goods Sold does not integrate with WooCommerce Analytics, and the request to build profit reporting on top of it was closed as not planned.<\/p>\n\n
Profit Margin Reports for WooCommerce is that missing report. It reads the cost data WooCommerce already holds and turns it into gross profit, margin, per-product profitability and a per-order profit figure. Nothing is sent anywhere, nothing is rewritten, and no number is presented as more certain than the data behind it.<\/p>\n\n
Reports honour the same excluded order statuses as WooCommerce Analytics, and refunds are netted the way Analytics nets them: a refund reduces revenue, units and cost on the date the refund was issued.<\/p>\n\n
Every figure is keyed on the order creation date, because the WooCommerce line-item table these reports are built from stores no other date. WooCommerce Analytics defaults its own screens to the paid date. On most stores those are the same day and the totals agree, but on a store that takes payment later than the order is placed, such as bank transfer or invoicing, the two will legitimately disagree about which day a sale lands on.<\/p>\n\n
A profit report is only ever as good as the cost data underneath it. Here is exactly what this plugin can and cannot know.<\/p>\n\n
This plugin makes no external HTTP requests and sends no data anywhere, to its author or to anyone else.<\/p>\n\n
There is no telemetry, no usage tracking, no analytics beacon, no phone-home on activation or deactivation, no remote licence check, and no third-party service of any kind. Every figure it shows is calculated from your own database on your own server, and nothing about your store, your orders, your costs or your customers leaves it.<\/p>\n\n
It sets no cookies, registers no front-end assets and adds nothing to the customer-facing side of your store. It is an admin-only reporting screen.<\/p>\n\n
The compiled files in build\/ are generated from the human-readable source in src\/, which ships with the plugin. To rebuild them:<\/p>\n\n
npm ci && npm run build\n<\/code><\/pre>\n\nThis uses @wordpress\/scripts and requires Node 20 or newer. package.json and package-lock.json ship too, so the build is reproducible from the released files alone.<\/p>\n\n
The build also compiles in nine ISC-licensed d3 packages: d3-array, d3-color, d3-format, d3-interpolate, d3-path, d3-scale, d3-shape, d3-time, and internmap. Their full licence text and copyright notices ship with the plugin in build\/index.js.LICENSE.txt, generated at build time from each package's own licence file.<\/p>\n\n\n
\n- Install and activate WooCommerce 10.3 or newer.<\/li>\n
- Go to WooCommerce > Settings > Advanced > Features and enable Cost of Goods Sold<\/strong>. Until this is on, WooCommerce records no costs at all and every report will be empty.<\/li>\n
- Install this plugin from Plugins > Add New, or upload the plugin folder to
\/wp-content\/plugins\/<\/code>, then activate it.<\/li>\n- Enter costs for your products. The field is Cost of goods<\/strong> on the Product data > General panel. To fill in many products at once, use the backfill assistant on the plugin's own screen.<\/li>\n
- Open WooCommerce > Profit<\/strong> to view your reports.<\/li>\n<\/ol>\n\n
Only orders created after step 2 carry a cost snapshot, so expect the report to start filling in from that point forward. Use estimated mode if you need an approximate picture of the period before that.<\/p>\n\n\n
\nWhy are my reports empty?<\/h3><\/dt>\nWork down this list, in order. The plugin's own status panel checks all of these and tells you which one is failing.<\/p>\n\n
\n- The Cost of Goods Sold feature is off. It is off by default in WooCommerce. While it is off, every cost value WooCommerce returns is zero and nothing is recorded. Enable it at WooCommerce > Settings > Advanced > Features.<\/li>\n
- WooCommerce Analytics is off. The reports read the Analytics lookup tables, so with Analytics disabled there is nothing to query.<\/li>\n
- Your products have no cost entered. Set Cost of goods<\/strong> on each product, or use the backfill assistant.<\/li>\n
- Your orders predate the feature being enabled. See the next question.<\/li>\n
- WooCommerce has orders waiting to be imported into its Analytics tables. Run the Analytics import from WooCommerce > Status > Tools and let it finish.<\/li>\n<\/ol><\/dd>\n
Why do my old orders show no cost?<\/h3><\/dt>\nBecause there is no cost stored on them. WooCommerce copies a product's cost onto the order line at the moment the order is created, which is what makes historical profit accurate even after you change a supplier price. The flip side is that orders created before the Cost of Goods Sold feature was switched on have no cost snapshot at all, and entering product costs today does not retroactively write costs onto those old orders. No plugin can recover data WooCommerce never wrote.<\/p>\n\n
Two things help. Coverage reporting tells you honestly how much of a period is uncosted, and estimated mode applies each product's current cost to those uncosted lines so you get an approximate figure. An estimate is always labelled as an estimate.<\/p><\/dd>\n
How does the CSV cost import work?<\/h3><\/dt>\nUpload a CSV containing a product identifier and a cost, then map which column is which. The plugin shows you every row it matched and every row it could not, and writes nothing until you confirm.<\/p>\n\n
The uploaded file is validated by content rather than by its name, stored under a generated filename so nothing you upload can choose where it lands, and deleted in the same request that parses it. Costs are written through WooCommerce's own product API, never by direct database writes. A template CSV of your existing products can be downloaded from the same screen; values in it are escaped so a product name or SKU beginning with an equals sign cannot execute as a formula when the file is opened in a spreadsheet.<\/p><\/dd>\n
Does this plugin send my data anywhere?<\/h3><\/dt>\nNo. It makes no external HTTP requests of any kind. No telemetry, no tracking, no remote licence check, no third-party services. All calculation happens in your own database on your own server. See the Privacy section above.<\/p><\/dd>\n
Does it work with HPOS?<\/h3><\/dt>\nYes. The plugin declares compatibility with High-Performance Order Storage and reads order data correctly under both HPOS and legacy post-based storage. It also declares compatibility with the Cost of Goods Sold feature itself.<\/p><\/dd>\n
Does it change my cost data?<\/h3><\/dt>\nNo. Reporting is strictly read-only: it queries WooCommerce's tables and writes nothing back to your products or orders.<\/p>\n\n
The single exception is the backfill assistant, which exists specifically to write product costs, and only does so for the products you select, after you confirm, and using WooCommerce's own product API rather than direct database writes. It never touches costs already recorded on existing orders, because those are a historical record.<\/p><\/dd>\n
Do the numbers match WooCommerce Analytics?<\/h3><\/dt>\nUsually, and where they differ there is a reason worth knowing.<\/p>\n\n
The plugin honours the same excluded order statuses configured in your Analytics settings and nets refunds the same way. The difference is the date. These reports key every figure on the order creation date, because the WooCommerce line-item table they read stores no other date, while Analytics defaults to the paid date. If your store is paid at checkout those are the same day and the totals agree. If payment can arrive days after the order, the same sale can land on different days in the two reports.<\/p><\/dd>\n
How are refunds handled?<\/h3><\/dt>\nWooCommerce writes a refund as its own negative line, carrying negative quantity and a negative cost, dated on the day the refund was issued. Reports sum those lines along with everything else, so a refund reduces revenue, units and cost on the refund date. The refunded order is not retrospectively rewritten.<\/p><\/dd>\n
What does the coverage percentage mean?<\/h3><\/dt>\nIt is the share of order lines in the current report that had a cost recorded. At 100 percent, every line was costed and the profit figure is complete. At 60 percent, four lines in ten contributed revenue but no cost, so the true cost is higher and the true profit lower than shown. Coverage is displayed rather than hidden precisely so that a partly costed report is never mistaken for a complete one.<\/p><\/dd>\n
Which orders count, and who can see the reports?<\/h3><\/dt>\nThe same orders WooCommerce Analytics counts: everything except the statuses excluded in your Analytics settings, plus draft, auto-draft and trashed orders, which are never counted because they are not sales. Developers can adjust this with the profit_margin_reports_report_statuses<\/code> filter.<\/p>\n\nAnyone with the view_woocommerce_reports<\/code> capability, which by default means shop managers and administrators. Writing costs through the backfill assistant additionally requires manage_woocommerce<\/code>.<\/p><\/dd>\nIs a very large store going to be slow?<\/h3><\/dt>\nPossibly, in this release. Reports are calculated live against your order tables on each load, with a short-lived cache. Stores with hundreds of thousands of orders may find long date ranges take a while. Pre-aggregation is planned.<\/p><\/dd>\n\n<\/dl>\n\n\n
0.1.1<\/h4>\n\n
Review feedback from the WordPress.org plugin team.<\/p>\n\n
\n- The orders-list column stylesheet is now enqueued through wp_add_inline_style() on a registered handle rather than printed as an inline style tag.<\/li>\n
- Tested against WordPress 7.1.<\/li>\n<\/ul>\n\n
0.1.0<\/h4>\n\n
Initial release.<\/p>\n\n
\n- Profit summary with net revenue, cost of goods, gross profit, gross margin and previous-period comparison.<\/li>\n
- Daily revenue, cost and gross profit series.<\/li>\n
- Product and variation profitability report with sorting and per-row cost coverage.<\/li>\n
- Profit column on the WooCommerce orders list.<\/li>\n
- Cost coverage reporting on every total, so uncosted lines are never mistaken for zero-cost lines.<\/li>\n
- Optional estimated mode using current product costs for lines with no cost snapshot.<\/li>\n
- Cost backfill assistant: set costs as a percentage of the regular price, or import them from a CSV, both with a preview before anything is written.<\/li>\n
- Variation costs are written as absolute values, clearing WooCommerce's per-variation additive flag so a stale flag cannot double a cost.<\/li>\n
- Status panel reporting whether Cost of Goods Sold, Analytics, order storage and Analytics imports are in a state that allows accurate reporting.<\/li>\n
- Compatible with High-Performance Order Storage and with the Cost of Goods Sold feature.<\/li>\n<\/ul>","raw_excerpt":"Gross profit and margin reports built from the Cost of Goods Sold data WooCommerce already stores but never reports on.","jetpack_sharing_enabled":true,"_links":{"self":[{"href":"https:\/\/wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin\/355912","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin"}],"about":[{"href":"https:\/\/wordpress.org\/plugins\/wp-json\/wp\/v2\/types\/plugin"}],"replies":[{"embeddable":true,"href":"https:\/\/wordpress.org\/plugins\/wp-json\/wp\/v2\/comments?post=355912"}],"author":[{"embeddable":true,"href":"https:\/\/wordpress.org\/plugins\/wp-json\/wporg\/v1\/users\/emtiazzahid"}],"wp:attachment":[{"href":"https:\/\/wordpress.org\/plugins\/wp-json\/wp\/v2\/media?parent=355912"}],"wp:term":[{"taxonomy":"plugin_section","embeddable":true,"href":"https:\/\/wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_section?post=355912"},{"taxonomy":"plugin_tags","embeddable":true,"href":"https:\/\/wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_tags?post=355912"},{"taxonomy":"plugin_category","embeddable":true,"href":"https:\/\/wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_category?post=355912"},{"taxonomy":"plugin_contributors","embeddable":true,"href":"https:\/\/wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_contributors?post=355912"},{"taxonomy":"plugin_business_model","embeddable":true,"href":"https:\/\/wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_business_model?post=355912"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}