JSON-LD

Resulting JSON-LD markup

JSON-LD is a structured data format that helps search engines understand the content of a page. It can be used to describe products, organizations, breadcrumbs, and other entities. For example, for a product, you can provide its name, image, price, and availability.

Example of JSON-LD for the “Smartphone X” product page in the “Electronics” category:

{
  "@context": "https://schema.org",
  "@type": "Product",
  "name": "Smartphone X",
  "image": [
    "https://myshop.com/images/smartphone-x.jpg"
  ],
  "description": "Smartphone X, 256 GB, black",
  "sku": "SM-X-001",
  "brand": {
    "@type": "Brand",
    "name": "Brand X"
  },
  "offers": {
    "@type": "Offer",
    "url": "https://myshop.com/smartphone-x",
    "priceCurrency": "USD",
    "price": "999",
    "availability": "https://schema.org/InStock",
    "itemCondition": "https://schema.org/NewCondition"
  }
}

This markup does not affect the appearance of the website, but it helps search engines, such as Google Search, generate rich results—enhanced search results that can display the price, rating, availability, and other information directly on the search results page.

CS-Cart supports several JSON-LD entities. The entities supported in the current version are described below.

Product and Offer

CS-Cart automatically generates the Product JSON-LD entity. It is used to provide search engines with information about a product. The Product entity can include the following data:

  • product name;
  • product description;
  • product images;
  • SKU;
  • brand;
  • GTIN, MPN, and ISBN identifiers (if available).

Search engines can use the data from the Product entity to understand product characteristics and generate rich results.

The Offer entity is part of the Product entity and describes the terms under which a specific product can be purchased. The Offer entity includes the following data:

  • product price;
  • currency;
  • product availability;
  • product condition;
  • product page URL.

Search engines can use the data from the Offer entity to display product price and availability information directly in search results.

Note

The Product and Offer entities are generated automatically and do not require any additional configuration.

Organization

Note

In version 4.21, two new entities were added: BreadcrumbList and Organization.

To configure the Organization entity, go to Website → SEO in the Admin panel and click JSON-LD in the upper-right corner:

JSON-LD window in SEO section

A window will open where you can configure the organization data.

JSON-LD window with fields to fill in manually

The following data is filled in automatically (taken from the storefront settings):

  • name — storefront name;
  • url — storefront URL;
  • logo — storefront logo.

Enter the following data manually:

  • description — storefront description;
  • telephone — phone number;
  • email — email address;
  • sameAs — an array of links to social media profiles.

Important:

  • only absolute URLs (http:// or https://) are accepted;
  • invalid links are ignored and are not included in JSON-LD;
  • the sameAs array is included only if it contains at least one valid link.