Magento Schema Markup Examples for eCommerce

Create a block that gathers exact on-page values and returns a ready-to-encode PHP array.

app/code/Vendor/Module/Block/Schema/Product.php

<?php

declare(strict_types=1);

namespace Vendor\Module\Block\Schema;

use Magento\Catalog\Api\ProductRepositoryInterface;

use Magento\Framework\View\Element\Template;

use Magento\Store\Model\StoreManagerInterface;

class Product extends Template

{

    public function __construct(

        Template\Context $context,

        private readonly ProductRepositoryInterface $productRepo,

        private readonly StoreManagerInterface $storeManager,

        private readonly \Vendor\Module\Helper\Schema $schemaHelper,

        array $data = []

    ) {

        parent::__construct($context, $data);

    }

    public function getProduct(): \Magento\Catalog\Api\Data\ProductInterface

    {

        // Magento already registers current product; fallback to repo if needed

        $p = $this->_registry->registry(‘current_product’);

        return $p ?: $this->productRepo->getById((int)$this->getRequest()->getParam(‘id’));

    }

    public function buildProductSchema(): array

    {

        $p = $this->getProduct();

        $store = $this->storeManager->getStore();

        $canonical = $p->getUrlModel()->getUrl($p);

        $schema = [

            ‘@context’ => ‘https://schema.org’,

            ‘@type’    => ‘Product’,

            ‘@id’      => $canonical . ‘#product’,

            ‘name’     => (string)$p->getName(),

            ‘description’ => strip_tags((string)$p->getShortDescription() ?: (string)$p->getDescription()),

            ‘image’    => $this->schemaHelper->getImageUrls($p), // array of absolute URLs

            ‘sku’      => (string)$p->getSku(),

            ‘brand’    => [

                ‘@type’ => ‘Brand’,

                ‘name’  => (string)($this->schemaHelper->getBrandName($p) ?: ”)

            ],

        ];

        // Identifiers (add only if present)

        if ($gtin = $this->schemaHelper->getGtin($p))  { $schema[‘gtin13’] = $gtin; }

        if ($mpn  = $this->schemaHelper->getMpn($p))   { $schema[‘mpn’]   = $mpn; }

        // Offer or AggregateOffer depending on variants

        $schema[‘offers’] = $this->schemaHelper->buildOfferNode($p, $canonical, $store);

        // Ratings (only if visible and > 0)

        if ($agg = $this->schemaHelper->getAggregateRating($p)) {

            $schema[‘aggregateRating’] = $agg;

        }

        if ($reviews = $this->schemaHelper->getRecentReviews($p, 3)) {

            $schema[‘review’] = $reviews;

        }

        return $schema;

    }

}

app/code/Vendor/Module/Helper/Scheme.php (key helpers)
(Name as Schema.php; shortened for clarity)

<?php

declare(strict_types=1);

namespace Vendor\Module\Helper;

use Magento\Catalog\Api\Data\ProductInterface;

use Magento\Framework\App\Helper\AbstractHelper;

class Schema extends AbstractHelper

{

    public function getImageUrls(ProductInterface $p): array

    {

        // Return unique, absolute URLs (gallery first, then base)

        $urls = [];

        foreach ($p->getMediaGalleryImages() ?? [] as $img) {

            $urls[] = (string)$img->getUrl();

        }

        $base = (string)$this->_getUrlBuilder()->getUrl(”, [‘_direct’ => ltrim((string)$p->getImage(), ‘/’)]);

        if ($base) $urls[] = $base;

        return array_values(array_unique(array_filter($urls)));

    }

    public function getBrandName(ProductInterface $p): ?string

    {

        $text = $p->getAttributeText(‘brand’);

        return is_array($text) ? reset($text) : ($text ?: null);

    }

    public function getGtin(ProductInterface $p): ?string

    {

        foreach ([‘gtin’,’gtin13′,’gtin14′,’ean’,’upc’] as $code) {

            $val = trim((string)$p->getData($code));

            if ($val !== ”) return $val;

        }

        return null;

    }

    public function getMpn(ProductInterface $p): ?string

    {

        $mpn = trim((string)$p->getData(‘mpn’));

        return $mpn !== ” ? $mpn : null;

    }

    public function availabilityUrl(ProductInterface $p): string

    {

        // Minimal example; replace with your stock service

        $inStock = (bool)$p->isAvailable();

        return $inStock ? ‘https://schema.org/InStock’ : ‘https://schema.org/OutOfStock’;

    }

    public function buildOfferNode(ProductInterface $p, string $canonical, \Magento\Store\Api\Data\StoreInterface $store): array

    {

        $currency = $store->getCurrentCurrencyCode() ?: $store->getBaseCurrencyCode();

        // If product has variant prices, summarize as AggregateOffer

        $variantPrices = $this->collectVariantPrices($p);

        if ($variantPrices) {

            return [

                ‘@type’         => ‘AggregateOffer’,

                ‘priceCurrency’ => $currency,

                ‘lowPrice’      => number_format(min($variantPrices), 2, ‘.’, ”),

                ‘highPrice’     => number_format(max($variantPrices), 2, ‘.’, ”),

                ‘offerCount’    => (string)count($variantPrices),

                ‘availability’  => $this->availabilityUrl($p),

            ];

        }

        // Single Offer

        $price = $this->finalPrice($p);

        return [

            ‘@type’         => ‘Offer’,

            ‘url’           => $canonical,

            ‘priceCurrency’ => $currency,

            ‘price’         => number_format($price, 2, ‘.’, ”),

            ‘availability’  => $this->availabilityUrl($p),

            ‘itemCondition’ => ‘https://schema.org/NewCondition’,

            ‘seller’        => [‘@type’ => ‘Organization’, ‘name’ => $store->getName()]

        ];

    }

    public function finalPrice(ProductInterface $p): float

    {

        // Ensure parity with displayed price (same service/formatter)

        return (float)$p->getFinalPrice();

    }

    private function collectVariantPrices(ProductInterface $p): array

    {

        if ($p->getTypeId() !== ‘configurable’) return [];

        $prices = [];

        foreach ($p->getTypeInstance()->getUsedProducts($p) as $child) {

            $prices[] = (float)$child->getFinalPrice();

        }

        return array_filter($prices, fn($v) => $v > 0);

    }

    public function getAggregateRating(ProductInterface $p): ?array

    {

        $count = (int)$p->getData(‘review_count’);

        $summary = (float)$p->getData(‘rating_summary’); // 0–100 in many setups

        if ($count <= 0 || $summary <= 0) return null;

        return [

            ‘@type’ => ‘AggregateRating’,

            ‘ratingValue’ => round($summary / 20, 2), // convert 0–100 → 0–5

            ‘reviewCount’ => $count

        ];

    }

    public function getRecentReviews(ProductInterface $p, int $limit = 3): array

    {

        // Optional: pull last N on-page reviews (author, date, rating, body)

        return []; // keep empty unless you render visible reviews

    }

}