SEO Rich Data - installation and configuration

Module purpose

The Kowal_SeoRichData module adds schema.org structured data in JSON-LD format to Magento 2. Generated data may include products, offers, prices, availability, ratings, reviews, breadcrumbs, organization data, site name, search box, social profiles, FAQ, and video.

The module configuration is available in the Magento admin panel:

Stores > Configuration > Kowal > SEO Rich Data

Requirements

• Magento 2.
• Access to Magento CLI.
• Access to the Composer repository with the kowal/module-seo-rich-data package.
• Required base package: kowal/base.
• Permissions to run bin/magento commands.

Installation via Composer

1. Add the package repository:

composer config repositories.seo.rich.data vcs https://github.com/kowalco/magento-2-seo-rich-data

2. If the repository is private, add a GitHub access token:

composer config --global --auth github-oauth.github.com 

3. Install the module:

composer require kowal/module-seo-rich-data

4. Enable the module:

php bin/magento module:enable Kowal_SeoRichData

5. Run the Magento upgrade:

php bin/magento setup:upgrade

6. In a production environment, run DI compilation:

php bin/magento setup:di:compile

7. In a production environment, if the project requires it, generate static files:

php bin/magento setup:static-content:deploy

8. Flush the cache:

php bin/magento cache:flush

Manual installation

1. Copy the module to the directory:

app/code/Kowal/SeoRichData

2. Enable the module:

php bin/magento module:enable Kowal_SeoRichData

3. Run the Magento upgrade:

php bin/magento setup:upgrade

4. Flush the cache:

php bin/magento cache:flush

Post-installation steps

After installation, the module adds the product attribute:

The attribute supports the following values:

If the product has no attribute value set, the module treats it as NewCondition.

Configuration scope

All configuration fields are available for the Default, Website, and Store View scopes, according to Magento settings.

Enabled, Show ..., and similar fields use standard Magento values:

Breadcrumbs

This section is responsible for structured data for the navigation path.

Values for the Type field:

Include Your Site Name in Search Results

This section is responsible for WebSite data, which may help Google recognize the website name.

Organization

This section is responsible for Organization data.

The country from this section can be used as a fallback for the shipping country and return policy country if the relevant fields in the product section are empty.

Social Profiles

This section adds the organization social profiles. For the data to make sense, the Organization section should be enabled.

Empty fields are skipped.

Search Box

This section is responsible for SearchAction data, which may allow the store search box to appear in Google results.

Category Rich Data

This section is responsible for generating product data on category pages.

Enabling this option may reduce category page performance because the module must collect data for many products.

Product Rich Data

This section is responsible for the main Product product data and offers data.

Basic product fields

Values for the Description field:

Configurable and grouped products

Values:

Ratings and reviews

Values for the Rating Format field:

Integration with Yotpo requires the availability of a module supporting Yotpo. If the module is not installed, the Yotpo configuration should not be enabled.

Brand, manufacturer, and product identifiers

The EAN / GTIN Attribute field generates the property depending on the number of digits:

The module removes non-digit characters from the EAN / GTIN value before generating JSON-LD.

Shipping details

The shipping section is responsible for generating shippingDetails in offers. Data is added only when the section is enabled and has the complete set of required values.

The shipping cost currency is taken from the product offer currency.

Example meaning of values:

Merchant return policy

The return policy section is responsible for generating hasMerchantReturnPolicy in offers. Data is added only when the section is enabled and has the required values.

Values for the Return Policy Category field:

Values for the Return Method field:

Values for the Return Fees field:

The currency of the Return Shipping Fee field is taken from the product offer currency.

Custom Properties

The Custom Properties field lets you add custom properties to product JSON-LD.

Format:

wlasciwosc_jsonld,kod_atrybutu

If only one element is provided, the module treats it both as the JSON-LD property name and the attribute code.

Default value:

skumpn,sku

Meaning of the default value:

Example of adding a custom attribute:

color,colormaterial,material

Recommended minimum configuration for products

To reduce Google Search Console warnings for product data, configure at least:

Clearing cache after configuration changes

After changing the configuration, run:

php bin/magento cache:flush

If the store uses additional HTTP cache, Varnish, or a CDN, also clear those cache layers.

Verifying operation

1. Open a product page on the frontend.
2. Check the page source and find:

    
Change Log
 
Version: 1.0.17
05/19/2026
Added
Added support for the shippingDetails field in the offers structure for JSON-LD product data.
Added support for the hasMerchantReturnPolicy field in the offers structure for JSON-LD product data.
Added shipping data configuration:
enabling/disabling generation of shippingDetails,
shipping country,
shipping cost,
minimum and maximum order handling time,
minimum and maximum transit time.
Added return policy configuration:
enabling/disabling generation of hasMerchantReturnPolicy,
country where the policy applies,
return policy type,
number of days for returns,
return method,
return fees,
optional return shipping fee amount.
Added EAN / GTIN attribute selection in the product configuration.
Added automatic mapping of EAN / GTIN values to gtin8, gtin12, gtin13, gtin14, or gtin properties, depending on the number length.
Added source models for return policy configuration options:
ReturnPolicyCategory,
ReturnMethod,
ReturnFees.
Changed
Improved retrieval of brand and manufacturer attribute values for JSON-LD.
Added fallback retrieval of attribute values from raw EAV value when getAttributeText() or getData() does not return a value.
Added fallback retrieval of brand / GTIN values from simple products for configurable and grouped products.
Replaced the deprecated BlockProduct::getResultArray() method with shared ModelJsonLdProductInfo logic to keep product data generation consistent on the product page and in category lists.
Extended the offers cache key with shipping and return policy configuration so configuration changes affect the generated JSON-LD.
Fixed
Fixed a case where the configured Brand attribute did not appear in product JSON-LD.
Completed missing data required by Google Search Console for merchant listings:
shippingDetails,
hasMerchantReturnPolicy,
global product identifier via EAN / GTIN.