Skip to content
Adobe Commerce Storefront

Search is only available in production builds. Try building and previewing the site to test it out locally.

SEO metadata

Adobe recommends uploading product metadata into Edge Delivery Services so that it can be rendered server-side on product detail pages. This is important so that Google Merchant Center can reliably verify entries from your product sheet. Also, social media sites, which don’t usually parse JavaScript, can leverage this metadata to display rich previews of your product page links.

Verify that all pages, especially catalog pages (PDP and PLP), contain the following metadata:

TypeProperties
Document titletitle
Meta tagsdescription, keywords, og:type, og:title, og:description, og:url, og:image, og:image:secure_url, og:product:price:amount, og:product:price:currency
Schema.org data (JSON-LD)WebSite, Product, AggregateRating, Rating, BreadcrumbList

Schema.org data (JSON-LD)

JavaScript Object Notation for Linked Data (JSON-LD) is a structured data format that helps search engines understand the content of your web pages more explicitly. It is typically added as a script tag in the <head> of your HTML document.

Adobe Commerce storefronts on Edge Delivery Services should include schema.org annotations to expose product data to search engines. This data should be included on all Commerce pages, especially PDPs and PLPs.

You should compare the data available on the site before migrating to Edge Delivery Services to ensure that SKUs for all product variants are included. Use the Rich Results Test to validate the schema.org annotations. The PDP drop-in component in the boilerplate contains an example for JSON-LD data.

Generate metadata

You can use the PDP Metadata Generator tool to automate the process of generating all recommended metadata. The tool fetches product data from the Catalog Service, processes it, and generates a metadata spreadsheet in .xslx format. The spreadsheet can be used for the bulk metadata feature in Edge Delivery Services.

To generate metadata using the PDP Metadata Generator tool:

  1. Navigate to the tools/pdp-metadata/ directory in your local project.

  2. Install dependencies.

    npm install

  3. Run the tool and generate a metadata files in the project directory.

    npm start

The resulting metadata.xlsx and metadata.json files contain all recommended metadata for all of your products based on your site’s commerce configuration.

See the bulk metadata documentation for instructions on how to upload the generated metadata file to Edge Delivery Services.

SKU Casing

Due to a requirement in Edge Delivery Services, all product URLs must use lowercase SKUs. The boilerplate will enforce this by default.

Product Link Generation: A centralized getProductLink(urlKey, sku) function has been implemented to ensure consistent URL generation across all commerce components. This function is used to generate product page links at runtime in the correct casing.

Metadata Generation: Metadata applied through bulk metadata only applies metadata for lowercase urls. The PDP Metadata Generation tool has been updated to produce output in the correct format.

Implementation Requirements

For sites with SKUs containing uppercase letters, you have two options:

Option A: Publish Metadata (Recommended) Upload a metadata.json file to Edge Delivery Services that maps your product paths to the correct metadata. This approach ensures optimal SEO performance. See the tool’s README for more information.

Option B: Remove Lowercase Enforcement If you prefer to maintain uppercase SKUs in URLs, you can modify the getProductLink function in your boilerplate to remove the .toLowerCase() call, but metadata will not be applied.

// In scripts/commerce.js
export function getProductLink(urlKey, sku) {
  return `/products/${urlKey}/${sku}`; // Remove .toLowerCase()
}

Migration Guide

If you’re upgrading from a previous version of the boilerplate:

  1. Review Your SKUs: Identify any products with uppercase SKUs
  2. Choose Implementation Strategy: Decide between metadata publishing or removing lowercase enforcement
  3. Update Product Links: Ensure all commerce components use the centralized getProductLink function
  4. Test Thoroughly: Validate metadata generation and URL consistency
  5. Monitor Performance: Track SEO metrics and page load times