Stock Status Labels & Lead Times for Magento 2

Overview

Custom stock status labels with colours, lead-time and ETA dates, pre-order and backorder text, stock-based rules and out-of-stock-last sorting.

Tested on Magento Open Source 2.4.8 (PHP 8.3). Compatibility with other versions is listed only after it has been tested. Not for SaaS editions that cannot run PHP modules.

What it does

• You build a status library: a label, a colour, an icon, an optional note and a lead time. The text can use {days}, {date} and {qty}, for example "Only {qty} left" or "Ships in {days}".
• Every product gets a status automatically: its own assignment first, then your rules (stock level, categories, SKUs), then the default of its situation (in stock, backorder, out of stock, pre-order).
• The status shows on the product page, on category and search listings (compact) and on shopping cart lines.
• A dispatch date is worked out from the lead time: working days only, a cut-off hour, your time zone and a holiday list.
• Optional: out-of-stock products last in category and search listings, one extra sort criterion in the search engine.
• Mass assignment by SKU and CSV import / export.

Pages

Installation

Composer (recommended)

1. Add the Kavio Labs repository and your licence credentials (see your Kavio Labs account).
2. Run composer require kaviolabs/module-stock-status-manager.
3. Run bin/magento module:enable KavioLabs_StockStatusManager, bin/magento setup:upgrade and, in production mode, bin/magento setup:di:compile and bin/magento setup:static-content:deploy.

Zip upload

1. Download the zip from your Kavio Labs account.
2. Extract it into app/code/KavioLabs/StockStatusManager/ (the folder holds registration.php).
3. Run the same bin/magento commands as above.

Uninstall

• Keep the data: bin/magento module:disable KavioLabs_StockStatusManager (then delete the folder or composer remove the package and run setup:upgrade).
• Remove everything (tables, settings, licence state): Composer install bin/magento module:uninstall KavioLabs_StockStatusManager --remove-data; zip install bin/magento module:uninstall KavioLabs_StockStatusManager --non-composer, then module:disable, delete the folder and run setup:upgrade.

Configuration

Open Stores > Configuration > Kavio Labs > Stock Status Labels & Lead Times. The display, sorting and delivery settings can be changed per website and store view.

1. Enter your licence key in Licence > Licence key and click Save Config. The key is verified at once. A new installation works for a 14-day start period without a key.
2. The licence card shows the status, the licensed domain and the date until which updates are included. Check now verifies again.

General

Where statuses show

Sorting

Out-of-stock products last puts the stock flag in front of the sorting of category and search listings. Whatever order the shopper picks (position, price, name, relevance) is kept inside the in-stock group and the out-of-stock group, and it is right across pages because the search engine does the sorting. It is off by default.

It needs the stock flag in the search index: Multi-Source Inventory with the module Magento_InventoryElasticsearch (the default of Magento 2.4) and Stores > Configuration > Catalog > Inventory > Display Out of Stock Products = Yes, otherwise there are no sold-out products in the listing to move.

Delivery date

The date shown is "Dispatch by ..." in the locale of the store. Pages are cached by Magento: a changed status, rule, assignment or setting purges the affected pages (full page cache and Varnish) by the tag kv_ssm at once; a page that shows a dispatch date or a pre-order is cached only until the next midnight, cut-off hour or release moment of the store's time zone, so the date is never older than that.

Product attributes

The module adds two optional attributes to the General group of the product form: Available from (pre-order) (a date in the future shows the pre-order status until then) and Lead time in days (supplier) (used by statuses that take their lead time from the product).

Usage

1. The status library

Catalog > Inventory > Stock Statuses > Statuses lists your statuses. A status has:

• a name and an optional note shown to shoppers. Use {days} (for example "2-3 days"), {date} (the dispatch date) and {qty} (the stock) in either text;
• a colour and an icon;
• a lead time (from and to, in days) that feeds {days} and the dispatch date;
• Use as: make a status the default for one situation: in stock, out of stock, backorder (no stock but still salable) or pre-order (release date in the future). One status per situation;
• Show the dispatch date next to the label, and Take the lead time from the product attribute "Lead time in days" for supplier lead times.

On the first install the module creates four statuses (In stock, Out of stock, Backorder, Pre-order) so the storefront works at once.

2. Rules

Rules pick a status for products without their own assignment. A rule combines a stock level (any, in stock, out of stock, or between a minimum and a maximum), optional categories (subcategories count) and optional SKUs. Rules run in position order and the first match wins. A status that is switched off is skipped.

3. Assign statuses to products

Products & CSV assigns statuses to many products at once: type SKUs (one per line or comma separated), choose the status for "in stock" and for "out of stock", and optionally a lead time. A status set on a configurable product also covers all of its variants. Assignments beat rules.

CSV export and import use the columns sku;status_in;status_out;lead_min;lead_max. Statuses are matched by name, so a file moves between stores. Lines with an unknown status are skipped and reported.

4. What shoppers see

On the product page the status sits under the price. With a lead time it adds the dispatch date.

In category and search listings a compact badge shows the label only. With Out-of-stock products last switched on, sold-out products move to the end of every sort order.

In the shopping cart each line shows its own status.

Order of decisions

1. The product's own assignment (for the side it is on: in stock or out of stock; variants use their parent's).
2. The first matching active rule.
3. The default status of its situation: pre-order (release date ahead), in stock, backorder (no stock, still salable) or out of stock (not salable).
4. Nothing: the core stock line stays alone.

FAQ

Does it work with Hyva?

The module renders plain server-side markup and needs no Knockout or RequireJS on the storefront. Hyva themes that render the product card through the standard getProductDetailsHtml block hook show the listing badge; check the cart item template of your theme for the cart line.

Does it work on SaaS editions?

No. It needs a store that runs PHP modules (Magento Open Source, self-hosted or on cloud hosting).

Does it change my products, stock or inventory?

No. The statuses live in their own tables and are worked out when a page is built. Stock, sources and reservations are only read. The two optional product attributes are yours to fill in.

Which stock does it read?

With Multi-Source Inventory the index of the stock that serves the current website (default stock or a custom one); without it the classic stock index. It is the indexed quantity: salable quantity reservations are not subtracted. Configurable products take the sum of their variants and are salable when any variant is. A cart line of a configurable product uses the stock of the variant in the cart.

What is the difference between a backorder and an out-of-stock product?

Magento decides: a product that is salable without quantity (backorders allowed) is a backorder, a product that is not salable is out of stock. Pre-order means the release date attribute lies in the future. You can map a different status to each.

How is the dispatch date counted?

From today in the time zone you set, plus the lead time (the upper value of the range), skipping Saturdays, Sundays and your holidays when "Count working days only" is on. An order at or after the cut-off hour counts from the next working day.

Why are sold-out products not at the end of my listing?

The setting needs the stock flag in the search index (Magento_InventoryElasticsearch, part of Multi-Source Inventory), "Display Out of Stock Products" = Yes and a reindex of the catalog search index after you switch the setting on for the first time.

Does the licence check slow down my store?

No. The store reads the stored result; the server is asked only from the Admin or once a day by cron after a key was entered.

Where do I get help?

[email protected], same working day on weekdays.