Manage sitemaps

Overview

To create your first sitemap, follow these steps:

Optionally, use these options to refine your sitemap configuration:

Enable x-default option for multilingual websites
Set aggregation rules for sitemap index files
Set exclusion rules
Configure CMS pages

You can view your existing sitemaps in the Sitemaps History.

Configuration

A sitemap is generated for a specific country.

Select countries and define the URL pattern

Select the shops for which sitemaps should be generated in the Panel:

Go to Add-Ons > Sitemap Add-On > Product and Category Pages.
Select the respective shop country.
Optionally: select a language code which overrides the shop language code (i.e. due to localization strategy or dynamic content).
Enter the Storefront URL per shop country.
Click SAVE.

Configure patterns for product pages

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

Go to Add-Ons > Sitemap Add-On > Product and Category Pages.
In the Product and category path configuration:
1. Enter the product path by using path parameters.
Click SAVE.

Product path parameters

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

Configure patterns for category pages

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

Go to Add-Ons > Sitemap Add-On > Product and Category Pages.
In the Product and category path configuration:
1. Enter the category path by using path parameters.
Click SAVE.

Category path parameters

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.

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 > Settings.
In the Sitemap Scheduler, select the interval from dropdown.
Click SAVE.

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 > Product and Category Pages.
In the X-default selection, select Enable x-default option and choose type:
1. _S_elect 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 > Product and Category Pages.
In the X-default selection, select Enable x-default option and choose type:
1. 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

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.

Set exclusion rules

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

Exclude products from sitemap

Apply on categories, product IDs and attribute groups.

Go to Add-Ons > Sitemap Add-On > Product and Category Pages.
In the Exclude criteria for products, enter the product ID to exclude.
Click SAVE.

Exclude categories from sitemap

Apply on category names and category IDs.

Go to Add-Ons > Sitemap Add-On > Product and Category Pages.
In the Exclude criteria for products, enter the Categories to exclude.
Click SAVE.

Select an Attribute Group from the dropdown list to narrow down the exclusion rules.

Configure CMS pages

The add-on provides the option to list content pages in the CMS sitemap file. Currently, integrations with Storyblok and Contentful exist.

Provide API credentials

Navigate to Add-Ons > Sitemap Add-On > Settings.
In the CMS Integration, select a CMS provider.
For Storyblok: Enter CMS API URL and CMS Token (public).
For Contentful: Enter CMS API URL, CMS Token, Space ID and Environment ID.
Click SAVE.

Set inclusion rules for content pages

Determine which content pages should be listed in the CMS sitemap files.

Go to Add-Ons > Sitemap Add-On > Content Pages.
CMS Source: Enter a folder name if specific content should be displayed. Leave this field empty if all content should be fetched.
Sitemap Path: Enter path parameters in order to define the content pages URL pattern, i.e. {slug}
Shop: Select for which shop these rules should be applied: globally, per shop country.
Click SAVE.\

Example

The content pages from the CMS are included in the sitemap:

All content pages fetched from the path: /content/global in the CMS
All brand pages fetched from the path: /content/brandpages/ in the CMS
A campaign page that was created for the kingsday fetched from the path:
/nl-nl/campaigns/kingsday

Content pages and brand pages are included in all country shops' sitemaps. The campaign page for the kingsday will only appear in the NL shop’s sitemap.

Set exclusion rules for content pages

Determine which content pages should be excluded from the CMS sitemap files.

Go to Add-Ons > Sitemap Add-On > Content Pages.
In the Exclude criteria for content, enter:
1. Slug: Enter page or folder slugs in order to exclude these, for example page: banner folder: test/* → to exclude folders add /* at the end to the slug name.
2. Tag: Enter tags to exclude.
3. ID: Enter content pages ID to exclude.
Click SAVE.

Example

The content pages from the CMS are excluded from the sitemap:

A newsletter in the footer with the slug: footer/newsletter
A test campaign with the slug: promotions/test-campaign
All content with the tag: unpublished
Content pieces/pages with the following ids: 123, 124, 312

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.\