Manage Sitemaps

Steps to create a sitemap

To create your first sitemap, follow these steps:

Select countries and define the shop URL.
Manage sitemap product pages.
Manage sitemap category pages.
Set the sitemap schedule.

Optionally, use these options to refine your sitemap configuration:

Enable x-default option for multilingual websites
Set aggregation rules for sitemap index files
Extend sitemap with content pages from an external CMS

You can view your existing sitemaps in the Sitemaps History.

Manage sitemap configuration

Select countries and define the URL pattern

Per default sitemaps are generated per country shop. Select the shops for which sitemaps should be generated.

Go to Add-Ons > Sitemap Add-On > Sitemap Management.
Select the respective shop countries.
Select a language code per shop country from the drop down.
Enter the Storefront URL per shop country.
Click SAVE.

Product Pages

Configure patterns for product pages

In this section, the URL patterns for product pages are defined by using path parameters. The base URL (Storefront URL) does not need to be added.

Go to Add-Ons > Sitemap Add-On > Sitemap Management.
In the Product path configuration, enter the product path by using path parameters.
Click SAVE.

Examples

Product pattern	Example path
`p/{attributes.name}-{id}`	yourshop.com/p/tshirt-123
`product/{attributes.name}/{referenceKey}`	yourshop.com/product/tshirt/321
`p/{attributes.name}-{attributes.brand}-{referenceKey}`	yourshop.com/p/tshirt-adidas-321
`product/{attributes.name}-{referenceKey}-{id}`	yourshop.com/product/tshirt-321-123

Exclude products from sitemap

In this section, you are able to define which products should be excluded from sitemaps.

Go to Add-Ons > Sitemap Add-On > Sitemap Management.
In the Exclude criteria for products, enter product Ids or categories to exclude products.
Click SAVE.

Category Pages

Configure patterns for category pages

In this section, the URL patterns for category pages are defined by using path parameters. The base URL (Storefront URL) does not need to be added.

Go to Add-Ons > Sitemap Add-On > Sitemap Management.
In the Category path configuration, enter the category path by using path parameters.
Click SAVE.

Category pattern	Example path
`c{categoryPath}-{categoryId}`	yourshop.com/c/clothing/women-123
`category/{categoryId}{categoryPath}`	yourshop.com/category/123/clothing/women

Storefront API returns the categoryPath with a leading slash - adding a slash is not necessary when defining a path.

Exclude categories from sitemap

In this section, you are able to define which categories should be excluded from sitemaps.

Go to Add-Ons > Sitemap Add-On > Sitemap Management.
In the Exclude criteria for categories, enter category Ids or category names to exclude categories.
Click SAVE.

Set Sitemap scheduler

The Sitemap Add-on allows you to set a scheduler running at pre-determined intervals.

The scheduler offers four options to choose from: everyday at midnight, everyday at 2am, every Monday midnight or every 8 hours.

Set the interval in which the sitemap should be generated.

Navigate to Add-Ons > Sitemap Add-On > Sitemap Management.
In the Sitemap Scheduler, select the interval from dropdown.
Click SAVE.

Multilingual sitemaps configuration (optional)

The "x-default" value refers to a special language or regional tag used in multilingual websites to indicate the default version of a page when there is no specific language or regional version available for user's preferences.

You can either choose a specific shop country or a static page as your x-default value.

Enable x-default option for a shop country

Go to Add-Ons > Sitemap Add-On > Sitemap Management.
In the X-default selection, select Enable x-default option
Choose type By shop and select a shop country.
Click SAVE.

Example of a generated sitemap

<link rel="alternate" href="https://example.com/de-de" hreflang="de" />
<link rel="alternate" href="https://example.com/en-us" hreflang="en-us" />
<link rel="alternate" href="https://example.com/en-au" hreflang="en-au" />
<link rel="alternate" href="https://example.com/de-de" hreflang="x-default" />

Enable x-default option for a static page

Go to Add-Ons > Sitemap Add-On > Sitemap Management.
In the X-default selection, select Enable x-default option
Choose type Static page and enter the domain name.
Click SAVE.

Example of a generated sitemap

<link rel="alternate" href="https://example.com/de-de" hreflang="de" />
<link rel="alternate" href="https://example.com/en-us" hreflang="en-us" />
<link rel="alternate" href="https://example.com/en-au" hreflang="en-au" />
<link rel="alternate" href="https://example.com/countryselection" hreflang="x-default" />

Set aggregation rules for sitemap index page

Select a sitemap index file preference for subfolder-based storefront URLs

The sitemap index file for subfolder-based storefront URLs (i.e.test.com/de) can be generated according to your preferences. There are two states in which the index file can be displayed: aggregated or disaggregated.

aggregated sitemap index file: the index displays three sitemaps files: categories, products and CMS. Within the files, the respective pages are listed from all shop countries.
disaggregated sitemap index file: the index displays categories, products and CMS files per shop country. Within the files, the respective pages list only shop country specific pages.

Sitemaps History

The history table gives you an overview of the latest 20 sitemaps and their states.
The table features the following information:

STARTED: shows when the latest sitemap has been created in a date and time format.
FINISHED: shows when the latest sitemap has been finished in a date and time format.
STATE: this data field shows one of these states: not created, in progress, created.
FILE: this data field provides a ZIP file so that your sitemap can be downloaded.\