Product Compliance

Show product safety information (manufacturer, responsible person in the EU, product identification, warnings and safety documents) and the lowest price before a reduction on your product pages, for Luma and Hyvä. This guide covers installation, configuration and day-to-day use.

The module helps you display information; it does not decide what your products need and is not legal advice. You remain responsible for the content you enter.

• Demo, product page (Luma): https://demo.softawarecommerce.com/joust-duffle-bag.html
• Demo, product page (Hyvä): https://demo.softawarecommerce.com/hyva/joust-duffle-bag.html
• Admin demo: https://demo.softawarecommerce.com/try-admin/product-compliance
• Changelog: Release notes · Questions: FAQ

1. Requirements

The checkout is not changed. Softaware Product Attachments is optional: when installed, its public attachments can be listed under "Safety documents".

2. Installation

With Composer. Use the Composer keys from your account on softawarecommerce.com (see https://softawarecommerce.com/shop/composer-access/):

composer config repositories.softaware composer https://repo.softawarecommerce.com
composer config --auth http-basic.repo.softawarecommerce.com PUBLIC_KEY PRIVATE_KEY
composer require softaware/module-product-compliance
bin/magento setup:upgrade
bin/magento setup:di:compile            # production mode only
bin/magento setup:static-content:deploy # production mode only
bin/magento cache:flush
bin/magento softaware:omnibus:backfill  # records all current prices once

On Hyvä, the module registers itself for Tailwind source scanning. Run your usual Hyvä CSS build after installing so the Product Safety section is styled.

To update later: composer update softaware/module-product-compliance, then the same bin/magento commands (the backfill is only needed once).

3. Quick start

1. Softaware > Product Compliance > Manufacturers and Responsible Persons: click Add Manufacturer or Responsible Person and enter your manufacturer. If the manufacturer is outside the EU, add the responsible person in the EU as a second record.
2. Link them to products in one of these ways: set them on a product (group Product Safety (GPSR)), make them the default for brands, categories or attribute sets in the record's Use as Default For section, or choose Default Manufacturer in the configuration.
3. Add warnings in the product's Safety Information and Warnings (GPSR) field, one per line.
4. Optional: upload safety documents and pictograms under Softaware > Product Compliance > Safety Documents and Pictograms and select them on the product.
5. Open Softaware > Product Compliance > Completeness Report, click Check Products Now and work through the Missing column.

The lowest price line needs no setup: prices are recorded from installation on, and the line appears in store views whose rules are EU or Türkiye (see section 6).

4. Settings

Stores > Configuration > Softaware > Product Compliance (also Softaware > Product Compliance > Configuration). Every field says its default and has "Use system value".

General

• Enabled (default Yes): when No, nothing is shown on the storefront (product safety, recall notices, lowest prices). Price recording has its own switch.

Product Safety (GPSR)

• Show Product Safety Section (default Yes).
• Position on the Product Page: Tab / section in the product details (default), Main column below Add to Cart, or Not shown (own layout or theme).
• Section Title: empty shows "Product Safety" (translated).
• Tab Sort Order (default 30): position among the product page tabs.
• Default Manufacturer and Default Responsible Person (EU): used for products without their own value or a brand, category or attribute set default.
• Brand Attribute (global): a dropdown attribute holding the brand, for example manufacturer. Its values can then be linked to a manufacturer or responsible person in their form.
• List Product Attachments (default No): only with Softaware Product Attachments; lists the product's attachments that need no sign-in under "Safety documents".
• Maximum Document Size (MB) (default 10): for uploaded documents and pictograms (PDF, JPG, PNG, GIF, WebP).

Recall and Safety Notice

• Show Global Notice (default No): a notice for all products, for example a product recall.
• Notice Text, Link (an https:// URL or a page path of this store), Link Text (default "More information").
• Show On: All pages (default) or Product pages only.

Notices for single products are set on the product (fields Recall or Safety Notice and Recall Notice Link).

Completeness Report

• Product Types (default simple, configurable, bundle and grouped), Attribute Sets and Categories (none selected means all).
• Only Products Visible on Their Own (default Yes): leaves out "Not Visible Individually" products such as configurable variants; their parent is checked.
• Checks: what counts as missing. Manufacturer missing; Responsible person missing (manufacturer outside the EU or unknown); No safety information or warnings; No product identifiers text; No product image. Default: all except the identifiers text.

Lowest Price Before a Reduction (Omnibus)

• Show Lowest Price (default Yes).
• Rules: Automatic (by store country) (default), EU (30 days, Aldi Süd), Türkiye (10 days), or Off (no lowest price, struck-through prices unchanged). Automatic uses General > Country Options > Default Country: EU/EEA countries use the EU rules, Türkiye its own rules, all other countries including the United Kingdom are off.
• Struck-through Price Is the Prior Price (EU rules, default Yes): the struck-through price and any percentage use the lowest price before the reduction; no reduction is shown when the product is not cheaper than that. Always on with the Türkiye rules.
• Show "Lowest Price" Text (default Yes) and Text: empty shows "Lowest price in the 30 days before the reduction: £X" (translated). In your own text, %1 is the price and %2 the number of days.
• Show Percentage Reduction (default No): a "−20%" style badge calculated from the prior price, rounded down.
• Show on Product Lists and Show on Product Page (both default Yes).
• No Price History Before the Reduction: Use the regular price (default) or Do not show a reduction.
• Excluded Categories (Perishable Goods): products in these categories and their subcategories are left alone.
• Global settings: Record Prices (default Yes), Period (Days) (30 to 365, default 30), Record All Customer Groups (default No: NOT LOGGED IN prices are recorded and shown to everybody), Keep History (Days) (35 to 3650, default 60).

5. Product safety in daily use

Manufacturers and responsible persons

Softaware > Product Compliance > Manufacturers and Responsible Persons lists all records with type, name, trade name, city, country, email, Default For and status. Mass actions: Activate, Deactivate, Delete.

The form has Enabled, Type (Manufacturer or Responsible person (EU)), Name, Registered Trade Name or Trade Mark, Street Address, Postcode, City, Region, Country, Established in the EU (From the country, Yes (EU or Northern Ireland), or No), Email, Website or Contact Page, Phone and Internal Note. Use as Default For links the record to Brands, Categories and Attribute Sets.

Product values

Every attribute set gets the group Product Safety (GPSR):

Leave the manufacturer and responsible person empty to use the defaults. Products without a stored "GPSR Applies to This Product" value (for example products created before the module was installed) count as Yes, and the product form shows Yes for them.

Safety documents and pictograms

Under Softaware > Product Compliance > Safety Documents and Pictograms, each record has Kind (Document (link) or Pictogram (image)), Title, File or Or External URL (https), Store Views and Sort Order. Uploads are checked by extension, content type and image header; SVG and scripts are refused, and files are stored under pub/media/softaware_compliance with random-suffixed names. Pictograms are shown as images next to the warnings; documents are listed as links.

Mass assign

In Catalog > Products, select products and choose Actions > Product Safety: Assign. Tick Change for each field to update: GPSR Applies, manufacturer, responsible person, documents (Add the selected, Remove the selected, or Replace with the selected), and the texts for all store views or one store view.

What shoppers see

The Product Safety section shows the manufacturer and responsible person cards, Product identification (product name, SKU and your identifiers text), Safety information and warnings with pictograms, and Safety documents. On phones the cards stack into one column.

A recall or safety notice (from the product or the global setting) is shown at the top of the page.

Completeness report

Softaware > Product Compliance > Completeness Report has one row per product and store view: store view, SKU, product, type, attribute set, status, Manufacturer (Source), Responsible Person (Source), safety info, documents, recall notice, issues and Missing. The source says where the value came from: Product, Brand, Category, Attribute set or Store default. Use the filters and Export (CSV or XML).

The report is rebuilt every night at 03:15 and when you click Check Products Now. Products with "GPSR Applies to This Product" set to No are left out.

Import and export

Softaware > Product Compliance > Import / Export: Export CSV writes one row per product with the values saved on the product (defaults from brands, categories or attribute sets are not written). Columns: sku, store_code, applies, manufacturer, responsible_person, identifiers, safety_information, documents, recall_notice, recall_url. On import, a missing column is not changed and an empty cell clears the value; rows with a store_code change only that store view's texts. Manufacturers can be given by ID or exact name, documents by IDs or titles separated by |. Click Check File first; nothing is written when any row has an error. Exported cells starting with = + - @ are protected.

6. Lowest price before a reduction

How it works

Prices are recorded from Magento's price index after every price reindex (product save, mass update, import, catalogue price rules, special price start and end) and daily at 01:35, per website and for customer group NOT LOGGED IN (or all groups). Only changes are stored. When a reduction starts, the lowest final price of the period before is stored as the prior price (earlier reductions included) and kept while the reduction continues, also when it is deepened. New products use the lowest price since the first record.

What shoppers see

While a reduction is shown, a line appears near the price on product pages and product lists, for example "Lowest price in the 30 days before the reduction: £32.00" (Türkiye rules: "Lowest price in the 10 days before the discount"). Texts are translated in German and Turkish. For configurable products, the line follows the selected variant.

Price history in the product form

The product form section Price History (Omnibus) shows, per website and customer group, the regular and final price, Reduction Since and Prior Price, a 90-day chart and the latest recorded changes.

Limits

Tier prices and quantity discounts are not recorded or shown. Bundle products are recorded, but no line is shown because their price is a range. Configurable and grouped parents in lists show no line; their variants and grouped rows do.

7. Command line

bin/magento softaware:omnibus:backfill [--assume-regular]   # record all current prices (safe to repeat)
bin/magento softaware:omnibus:show <sku> [-w website] [-g group] [-l rows]
bin/magento softaware:omnibus:prune                         # remove history older than Keep History
bin/magento softaware:gpsr:report                           # rebuild the completeness report
bin/magento softaware:gpsr:export <file> [--store=<code>]
bin/magento softaware:gpsr:import <file> [--check]

--assume-regular uses the regular price as the prior price for reductions that were already running when recording started. Only use it if you know that price applied before those reductions.

Cron jobs (group default): softaware_compliance_omnibus_daily at 01:35 (record and prune) and softaware_compliance_gpsr_report at 03:15 (report and removal of abandoned uploads).

8. GraphQL and integrations

ProductInterface gets softaware_product_safety (manufacturer, responsible person, identifiers, safety information, documents, recall notice) and softaware_omnibus (prior price, percentage, label and more). Feeds and integrations can use the service contracts ProductSafetyInfoProviderInterface and PriorPriceProviderInterface, or the product attributes (sw_gpsr_*, sw_recall_*) for the values saved on the product.

9. Permissions (ACL)

Under Softaware > Product Compliance in System > Permissions > User Roles:

• Manage Manufacturers and Responsible Persons
• Manage Safety Documents
• Edit Product Compliance Data (Mass Assign, Import)
• View Completeness Report and Export
• View Price History

The configuration section is Stores > Settings > Configuration > Softaware Product Compliance.

10. Troubleshooting

• The Product Safety section does not appear. Check Enabled and Show Product Safety Section, that the position is not "Not shown", that the product has "GPSR Applies to This Product" not set to No, and that it has product safety data (for example a manufacturer, set on the product or by a default). Flush the page cache after configuration changes. Up to version 1.1.3, saving an older product without a "GPSR Applies" value in the admin could set it to No; check the field on the product.
• No lowest price line. The line only appears while a reduction is shown. Check Rules for the store view (the automatic rules are off for countries outside the EU/EEA and Türkiye, including the UK), and that the product is not in an excluded category. For reductions that started before installation, see No Price History Before the Reduction.
• The prior price looks wrong. Run bin/magento softaware:omnibus:show <sku> to see the recorded history, or open the product's Price History (Omnibus) section. Prices come from the price index; if the index is behind, the last recorded prices are used.
• The report is out of date. Click Check Products Now or run softaware:gpsr:report.
• Hyvä section unstyled. Run your Hyvä CSS build so the module's classes are included.
• The global notice did not change. Refresh the full page cache after changing it.

11. Uninstall

bin/magento module:disable Softaware_ProductCompliance
composer remove softaware/module-product-compliance
bin/magento setup:upgrade

Uploaded documents in pub/media/softaware_compliance stay on disk until you delete them.