Omnibus Directive Configuration Guide | Magento 2
Looking for Omnibus Directive? View the full Omnibus Directive page to explore features, configuration options, and pricing.
Here's where you'll find every setting of the Omnibus Directive extension. The page follows the same order as the admin panel: General, Pricing, Frontend and Debug & Logging. For each option we explain what it does and when you'd change it, plus the product attribute that hides the lowest price for a single product. Most stores only need to enable the module and leave the rest on the defaults, so treat this page as a reference for when you want to fine-tune what is tracked and where it shows up.
Complete reference for all Omnibus Directive configuration options.
Location: Stores → Configuration → Magmodules → Omnibus Directive
General
Version
Shows the installed version and lets you check whether a newer version is available.
Enabled
Switches price tracking and the storefront display on or off. You can enable it per website or store view, for example only for the store views that sell in the EU.
While a store view is disabled, its prices are not recorded. When you enable it later, its history starts from that moment.
Pricing
These settings decide which prices are tracked and how far back the module looks.
Lookback Period (days)
How many days before a price reduction the module looks for the lowest price. The directive requires at least 30 days, which is the default.
When to use:
- Some countries allow or require a different period; change it only if your legal advisor tells you to
Recommended:
- Keep 30 days unless your local implementation of the directive says otherwise
Changing this setting marks the Omnibus indexer as "needs reindex". The indexer cron rebuilds it automatically, or you can run bin/magento indexer:reindex mm_omnibus_lowest_price.
Price Types
Which prices count towards the tracked price. The tracked price is the lowest of the selected types:
- Regular Price - always included
- Special Price - only while it is active (respects the special price from/to dates)
- Catalog Price Rule - the rule price for customers who are not logged in
- Tier Price - only tier prices for quantity 1 that apply to all customer groups or to NOT LOGGED IN
When to use:
- Leave all types selected so the tracked price matches what a guest visitor pays
- Deselect a type if you never use it and want to rule it out completely
Track Configurable Products
When enabled, a configurable product is tracked by the price of its cheapest enabled variant. Its lowest price is shown on category pages and on the product page before an option is selected. When the shopper selects an option or swatch, the lowest price switches to that variant.
When to use:
- Keep it enabled if you sell configurable products
- Disable it only if you don't want the module to show anything for configurable products
Exclude Categories
Products in the selected categories don't show the lowest price. Their price history is still recorded, so you can show it again later without losing history.
When to use:
- Product groups that never have price reductions announced, such as gift cards or services
- Categories where reductions are handled in a different way
Exclude SKUs
Same as Exclude Categories, but for individual products. Enter SKUs separated by commas or on separate lines.
Example:
GIFTCARD-25, GIFTCARD-50
SERVICE-INSTALL
Tip: To hide the lowest price on just a few products, you can also use the "Hide Omnibus Lowest Price" attribute on the product itself (see below).
Frontend
Display Mode
When the lowest price is shown:
| Mode | Shown when |
|---|---|
| Only on Sale | The product is currently reduced (final price below the regular price) |
| Only when Different | The lowest price differs from the current price, also after a price increase |
| Always | Whenever there is a prior price to refer to, after a price increase as well |
Recommended:
- Only on Sale: what the directive asks for, and the cleanest storefront
- Only when Different: if you also want to be transparent about price increases
- Always: mainly useful for testing
Label Text
The text shown in front of the lowest price. Default: "Lowest price in the %1 days before this discount:", where %1 becomes the lookback period.
When to use:
- Translate it per store view, for example "Laagste prijs in de afgelopen 30 dagen:" for a Dutch store view
- Change the wording if your legal advisor prefers different phrasing
If you change the lookback period, update the number of days in the label too.
Display Position
Shows the lowest price right after the price (default) or right before it.
Custom CSS Class
An extra CSS class added to the lowest price block, so your theme can style it without overriding templates.
Example: omnibus-muted and in your theme: .omnibus-muted { font-size: 12px; color: #777; }
Show on Listing
Shows the lowest price on category pages, search results and product widgets (for example "New products" or related products).
Show on Product Page
Shows the lowest price on the product page, below (or above) the main price.
Show Chart on
Pick where the lowest price gets a small info icon: the product page, the category pages, search results and widgets, or both. Hovering or focusing the icon opens a chart of the product's price over the lookback period, drawn from the recorded history, so a customer can see how the reference price came about. Leave empty for no chart (the default). The chart draws the history of the product shown; for a configurable product that is the parent's own history, which starts once the module has recorded its price for more than one day.
Debug & Logging
Debug Mode
Writes detailed records (recorded price changes, snapshots, recalculations, queue messages) to var/log/omnibus-directive-debug.log. Errors are always written to var/log/omnibus-directive-error.log, also when debug mode is off.
Use the buttons below the setting to view the last 100 debug or error records directly in the admin.
Product Attribute: Hide Omnibus Lowest Price
Each product has a "Hide Omnibus Lowest Price" switch in the General section of the product edit page. When set to Yes, the lowest price is not shown for that product. Price history is still recorded.
When no lowest price is shown
A product only gets the line when there is a price to refer to: a price that was in force in the lookback period before the current price began. A product whose recorded history starts at the discount - the module was installed after the sale started, or the product is new - shows nothing rather than its own sale price, and the same holds when every earlier price ended before the lookback period. Run a snapshot well before a sale, so the history is there when you need it.
Price History Grid
Catalog → Inventory → Omnibus Price History shows every recorded price change: product, SKU, store view, regular price, special price, final price and date. Type a SKU or part of a product name in the search box, or use the filters, to check the history of a single product, for example when a customer asks how a lowest price was determined.
Snapshot now above the grid records the current price of every product right away, instead of waiting for the daily snapshot: useful right after installing the module, or after prices were changed outside Magento. The catalog is checked in batches and a bar shows how far it is; a large catalog takes a few minutes and the page stays usable. The button needs the "Run Snapshot" permission under Omnibus Price History.
View history on a row opens the history of that product in that store view: a chart of the final price and the regular price over time with the lowest price of the lookback period as a dashed line, the lowest price itself, and every recorded point in a table. Switch store view at the top when the product has history in more than one.
Need More Help?
Documentation:
- All Help Articles - Complete documentation overview
Support:
- Contact Support - Get help from our team
For a complete overview of features and configuration options, see Omnibus Directive.