smile / elasticsuite-for-retailer

smile/elasticsuite-for-retailer

Smile ElasticSuite for Retailers - Magento2 toolkit for Retailers : Store Locator, Availability and Prices per store, etc...

  • Aurélien FOUCRET
  • Romain RUAUD
metapackage Compatibility: Not yet tested Code Quality: Fail Tests: N/A Security: Pass OSL-3.0

News

Compatibility

Due to all new paradigms introduced by Magento 2.1 (entity manager, forms based on UI components, staging for the EE edition, ...), the required minimum version of Magento for using this module is Magento 2.1

If your project is based on Magento 2.1.x you can start working with ElasticSuite for Retailer today using the latest 1.2.0-alpha1 release.

This module support PHP 8.3

Requirements

The module requires:

It's a toolkit module to install the RetailerSuite modules.

How to use

  1. Install the module via Composer:
ElasticSuite Version Module Version
ElasticSuite 2.1.x Latest release: composer require smile/elasticsuite-for-retailer:"^1.4"
ElasticSuite 2.3.x Latest release: composer require smile/elasticsuite-for-retailer:"^1.4"
ElasticSuite 2.6.x Latest release: composer require smile/elasticsuite-for-retailer:"^1.4"
ElasticSuite 2.7.x Latest release: composer require smile/elasticsuite-for-retailer:"~1.5.0"
ElasticSuite 2.8.x Latest release: composer require smile/elasticsuite-for-retailer:"~1.6.0"
ElasticSuite 2.9.x Latest release: composer require smile/elasticsuite-for-retailer:"~2.2.0"
ElasticSuite 2.11.x Latest release: composer require smile/elasticsuite-for-retailer:"~2.3.0"
ElasticSuite 2.11.x Latest release: composer require smile/elasticsuite-for-retailer:"~2.4.0"
  1. Enable it:

bin/magento module:enable Smile_Offer

bin/magento module:enable Smile_Seller

bin/magento module:enable Smile_Retailer

bin/magento module:enable Smile_StoreLocator

bin/magento module:enable Smile_RetailerOffer

bin/magento module:enable Smile_StoreDelivery

  1. Optionnal: Drop old SMILE_RETAILER_ADDRESS_RETAILER_ID unique key

if you already used older retailersuite modules on your projects, and you want to upgrade it,
before upgrading, you will have to DROP your current UNIQUE KEY from table smile_retailer_address : SMILE_RETAILER_ADDRESS_RETAILER_ID
This is necessary in order to get a db_schema.xml working correctly.

ALTER TABLE smile_retailer_address DROP INDEX SMILE_RETAILER_ADDRESS_RETAILER_ID

  1. Install the module and rebuild the DI cache:

bin/magento setup:upgrade

How to configure

Stores > Configuration > Elasticsuite > Elastic Suite for Retailer

Navigation mode: Retailer/Drive
* Drive mode: the customer will only see the catalog of the chosen retailer in Front Office.
* Retail mode: the customer will browse the Web catalog by default.
Display offers on product page: Yes/No (When enabled, offers of all stores will be displayed on product page.)

What is ElasticSuite for Retailers ?

This package is a suite of several modules aiming to help merchants dealing with retail and omnichannel mechanics in Magento 2 (Store Locator, Product availability/price per store, pickup in store, etc...).

The package relies on our custom Search and Merchandising tool called ElasticSuite which can be found here.

For more information, read the User Guide "Smile ElasticSuite for retailer". It's available here.

Who is developping ElasticSuite for Retailer ?

SmileLab

SmileLab is the innovation and experimentation department of Smile. Smile is the European leader of Open Source and also a four-times Europe Partner of the the Year (2010-2014) and two-times Spirit of Excellence (2015-2016) awarded by Magento.

Our multidisciplinary team brings together experts in technology, innovation, and new applications.

Together we explore, invent, and test technologies of the future, to better serve our clients.

Main Features

Current version

The current 2.4.0 version has been focused on compatibility with Magento 2.4.6:


Some functionnalities example:
  • Store Locator :

    This feature allows you to create and manage your shops in Magento's back-office. The module comes by default with several pre-configured attributes such as Shop Address, GPS coordinates, Opening Hours, etc...

    Once you have created all your shops, your customers will be able to navigate through them in the Front-Office on a map.

[image: Stores Map]

Each of your stores has also a Shop detail page and eventually a Contact Shop page if you enable this option on the store.

Your customer will be able to choose his favorite shop and this will keep it during all his navigation through your website.


  • Store Offers:

    This features let you create specific offers for a given product and a given shop: you'll be able to define the price and/or the availability for a product in each shop.

Offer Step one Offer Step two

You will be able to enable an option to filter the navigation of the customer to the products available in his favorite shop:

Shop Availability


The customer will even have the possibility to see product's availability in the other shops on the product detail page:

Shop Offer List

  • In Store delivery:

    This feature allow the customer to choose between stores for the shipping address of his order.

Store Delivery

This is handled during checkout via a Store chooser in a popin.

Store Delivery

And more to come!

The next versions that will be coming will include the following features:

  • Shops in autocomplete:

    We plan to add the shops to the autocomplete box results for faster access.

  • And many more!

    We will announce and integrate more features to the roadmap soon.

Documentation

Documentation is available here.

Changelog

All notable changes to this project will be documented in this file.

2.4.2 - 2024-08-29

  • PHP 8.3 compatibility check

2024-05-03

2023-09-20

Dataset compatibility Magento 2.4.6, ES 2.11.x and PHP 8.2

  • Fix Dynamic type declaration
  • Fix Type hinting
  • Replace Zend_Date by DateTime
  • Remove MutationObserver support
  • Fix UI Component Retailer Offer editing
  • Replace Zend_Validate by Laminas\Validator
  • Fix Retailer Grid Column Action
  • Fix Retailer Grid Mass Actions
  • Fix some translations
  • Remove Temando/Shipping Plugin
Versions
Version Stability QA Status Compatibility Released
2.4.2 stable Fail Not yet tested Details 2024-08-29 09:05:46
2.4.1 stable Not tested Not yet tested Details 2024-05-03 16:20:47
2.4.0 stable Not tested Not yet tested Details 2023-09-21 14:05:50
2.3.0 stable Not tested Not yet tested Details 2021-06-22 14:20:08
2.2.0 stable Not tested Not yet tested Details 2021-02-11 15:09:04
2.1.0 stable Not tested Not yet tested Details 2020-08-26 06:55:47
2.0.0 stable Not tested Not yet tested Details 2020-03-18 15:23:59
1.6.0 stable Not tested Not yet tested Details 2019-06-03 07:09:34
1.5.0 stable Not tested Not yet tested Details 2019-05-27 10:21:43
1.4.5 stable Not tested Not yet tested Details 2019-05-27 10:16:32
1.4.4 stable Not tested Not yet tested Details 2019-04-30 13:14:02
1.4.3 stable Not tested Not yet tested Details 2018-11-12 11:04:23
1.4.2 stable Not tested Not yet tested Details 2018-09-07 15:09:27
1.4.1 stable Not tested Not yet tested Details 2018-01-26 14:04:08
1.3.1 stable Not tested Not yet tested Details 2018-01-26 13:05:20
1.4.0 stable Not tested Not yet tested Details 2018-01-25 13:59:10
1.3.0 stable Not tested Not yet tested Details 2017-09-29 10:42:26
1.2.0 stable Not tested Not yet tested Details 2017-03-21 14:59:21
1.2.0-alpha1 alpha Not tested Not yet tested Details 2017-03-20 16:29:10

Requires 11

Package Constraint
php ^8.1
magento/framework >=103.0.4
magento/magento-composer-installer *
smile/elasticsuite ^2.11
smile/module-map ^2.1
smile/module-offer ^2.0
smile/module-retailer ^2.0
smile/module-retailer-offer ^2.0
smile/module-seller ^2.0
smile/module-store-delivery ^2.0
smile/module-store-locator ^2.2

Requires-dev 1

Package Constraint
smile/magento2-smilelab-quality-suite ^3.0

Suggests 5

Package Reason
smile/module-retailer-offer-inventory Add inventory management by offers
smile/module-retailer-elasticsuite-search Index retailers into the search engine and display them into autocomplete and search result.
smile/module-retailer-service Add the ability to add services per retailer
smile/module-retailer-promotion Add the ability to add promotion per retailer
smile/module-retailer-admin Add the ability to manage ACL in admin panel per retailer

Compatibility

Each Magento release line is installed on its supported PHP versions, then the module is built (DI compilation + static-content deploy) and its unit and integration suites are run. The matrix shows the lines and PHP versions the module is confirmed to install and run on. Code-quality results further down (phpstan, phpcs, …) are reported separately and never affect compatibility.

Compatibility matrix (Magento × PHP)
Magento PHP 8.2 PHP 8.3 PHP 8.4 PHP 8.5
2.4.7 not tested not tested
2.4.8 not tested not tested
2.4.9 not tested not tested

Code Quality

Advisory checks against the module's source. Static analysis runs once across the whole module; PHPStan re-runs per Magento + PHP version because resolvable symbols differ between releases. These NEVER affect the Compatibility badge — a phpcs finding can't make a module incompatible.

Static analysis

Coding standards (phpcs), mess detection (phpmd), copy-pasted code (cpd), PHP cross-version compatibility, composer.json validity. Each runs once for the whole module.

Static analysis results
Tool Status Findings Summary
PHPCS N/A 0 metapackage ships no source of its own — phpcs skipped (#122)
PHPMD N/A 0 metapackage ships no source of its own — phpmd skipped (#122)
Cpd N/A 0 metapackage ships no source of its own — cpd skipped (#122)
PHP Compatibility N/A 0 metapackage ships no source of its own — php-compatibility skipped (#122)
Composer validate Info 2 valid; 2 advisory notes (composer validate --strict)

PHPStan

Type-checks the module's PHP against a real Magento install at the configured gate level. Re-runs per Magento and PHP version because resolvable symbols differ between releases. Cell → details modal.

PHPStan results by Magento and PHP version
Magento PHP 8.2 PHP 8.3 PHP 8.4 PHP 8.5
2.4.7 985 985
2.4.8 985 985
2.4.9 977 977

Tests

Unit and integration suites, run for each applicable Magento and PHP version. A test failure speaks to the module's behaviour, not its compatibility with a Magento line, so it is reported here separately and never reddens the compatibility matrix.

Unit tests

Unit tests results by Magento and PHP version
Magento PHP 8.2 PHP 8.3 PHP 8.4 PHP 8.5
2.4.7 N/A N/A
2.4.8 N/A N/A
2.4.9 N/A N/A

Integration tests

Integration tests results by Magento and PHP version
Magento PHP 8.2 PHP 8.3 PHP 8.4 PHP 8.5
2.4.7 N/A N/A
2.4.8 N/A N/A
2.4.9 N/A N/A

Security

Security checks run directly against the module: an audit of its declared dependencies for known vulnerabilities (composer audit) and a scan of its source for malware and web-shell signatures. Each runs once. A malware detection fails the version outright.

Security results
Tool Status Findings Summary
Composer audit Pass 0
Malware scan N/A 0 metapackage ships no source of its own — malware scan skipped (#122)
License
OSL-3.0
Homepage
https://github.com/Smile-SA/elasticsuite-retailers
Authors

More from smile

View vendor
Make it pay

Turn an existing module into recurring revenue.

If you already maintain a Magento 2 module on GitHub or GitLab, listing it on Packagento takes about five minutes. We mirror your tags, handle distribution signing, and route paid licenses through Stripe Connect, so you can keep shipping the way you already do.