sitemaps/ endpoint provides an interface for managing XML sitemaps in your shop system. Via the API, new sitemaps can be created, existing ones edited or deleted, and both manual and scheduled generations can be performed. In addition, the interface lets you query status information about past or running generation processes.
Sitemaps can be generated individually for certain subshops and based on freely definable templates. The REST API provides precise control via parameters such as maximum file size or maximum number of URLs per file — so the delivery of the sitemaps can be optimized for your needs.
Using this API requires the corresponding permissions for reading, writing or generating sitemaps.
Supported methods
List of all supported methods.Data fields
Data fields of sitemaps
Sitemaps define which URLs of a shop are to be exported and in which form. Each sitemap is based on a sitemap template and contains additional parameters such as file size, number of entries or subshop assignment. Sitemaps can be created for different subshops and can be exported automatically at defined times. The generated files are stored by default in the directory/sitemaps/<subshopId>. They are publicly accessible and can be retrieved, for example, via a URL like www.your-shop-domain.de/sitemap.xml.
Example
Notes about splitting sitemaps
In order to optimize the loading time of search engines and to comply with technical specifications, the generation of sitemaps can be split automatically across multiple files. This happens when one of the following limits is exceeded:- Maximum number of URLs per file: by default 50,000 URLs.
- Maximum file size per file: by default 50 MB.
maxFileEntries and maxFileSize fields. If one of these limits is exceeded, the system automatically creates a new sitemap file with a sequential counter in the file name.
Data fields of sitemap templates
Sitemap templates describe the structure and content of a sitemap. They specify which resources (e.g. products, categories or content) are exported and which fields are included — such asloc, lastmod, priority or changefreq.
Every sitemap must be based on a template. Changes to a template affect all sitemaps built on it. This way different export configurations can be reused efficiently and managed centrally.
Example
Methods for sitemaps
Through the following endpoints existing sitemaps in the system can be retrieved, edited, created or deleted. In addition, status information about the last export and associated protocols can be queried. To use these endpoints, the corresponding permissions to access sitemap data must be available.GET sitemaps
This method lets you retrieve a list of all sitemaps existing in the system. The response contains the corresponding settings for each sitemap as well as — if already performed — information about generated files. The data can be filtered or sorted by various criteria, e.g. by subshop, export status or file name. To use this endpoint, the corresponding permissions to read sitemaps must be available.Example
Response
Filter fields
id, active, name, fileName, templateId, subshopIds, maxFileSize, maxFileEntries, exportAfterImport, exportStatus, lastExportStarted, lastExportFinished, createdAt, updatedAt
Sort fields
id, active, name, fileName, templateId, subshopIds, maxFileSize, maxFileEntries, exportAfterImport, exportStatus, lastExportStarted, lastExportFinished, createdAt, updatedAt
Error codes
GET sitemaps/{id}
This method can be used to retrieve a single sitemap entry by its ID. The response contains all configuration data of the sitemap, including subshop assignment, export status and generation settings. To use this endpoint, the corresponding permissions to read sitemaps must be available.Example
Response
Error codes
GET sitemaps/{id}/status
This method can be used to query the current export status of a specific sitemap. It returns the respective status per subshop, e.g. whether an export was completed successfully or failed. Although the endpoint currently does not track real processes, it provides structured status data. To use this endpoint, the corresponding permissions to read sitemaps must be available.Example
Response
Error codes
GET sitemaps/protocols
This method can be used to retrieve a list of all protocol entries for sitemaps. The protocols contain meta information about past export operations — such as when a sitemap was exported, which subshop was affected and which status the export had. To use this endpoint, the corresponding permissions to read sitemaps must be available.Example
Response
Filter fields
id, sitemap, template, subshopIds, exportStatus, lastExportStarted, lastExportFinished, createdAt, updatedAt
Sort fields
id, sitemap, template, exportStatus, lastExportStarted, lastExportFinished, createdAt, updatedAt
Error codes
POST sitemaps
This method lets you create a new sitemap entry with all relevant parameters such as file name, template assignment, export times and affected subshops. To use this method, the corresponding permissions to create sitemap data must be available.Example
Request body
Response
Error codes
PUT sitemaps/{id}
This method lets you update an existing sitemap by its unique ID. You can change both technical parameters (e.g. file name, template assignment, export options) and organizational settings (e.g. affected subshops, schedules). To use this method, the corresponding permissions to write sitemap data must be available.Example
Request body
Response
Error codes
DELETE sitemaps/{id}
This method permanently deletes an existing sitemap from the system by its ID. To use this endpoint, the corresponding permissions to delete sitemap data must be available.Example
Response
Error codes
Methods for templates
The following endpoints let you manage sitemap templates, on the basis of which individual sitemaps are generated. A template defines the content structure of a sitemap and typically contains a loop that iterates through relevant shop data. Through the API, templates can be retrieved, created, updated and deleted. To use these functions, the corresponding permissions to read and write sitemaps must be available.GET sitemaps/templates
This endpoint can be used to retrieve a list of all sitemap templates available in the system. These templates define the structure and content of the sitemaps to be exported later and serve as the basis for generating the XML files. To use the endpoint, the corresponding permissions to read sitemap data must be available.Example
Response
Filter fields
id, name, content, createdAt, updatedAt
Sort fields
id, name, content, createdAt, updatedAt
Error codes
GET sitemaps/templates/{id}
This endpoint can be used to load a single sitemap template by its ID. The response contains all relevant information about the template, such as name, content and timestamps of the last changes. To access this endpoint, the corresponding permissions to read sitemaps are required.Example
Response
Error codes
POST sitemaps/templates
This endpoint can be used to create a new sitemap template. The template contains both the name and the template script with which the contents of the sitemap are generated. To create new templates, the corresponding permissions to create sitemaps are required.Example
Request body
Response
Error codes
PUT sitemaps/templates/{id}
This endpoint lets you update an existing sitemap template. You can change both the name and the content of the template. Changes to templates affect the sitemaps based on them as soon as those are regenerated. To use this endpoint, the corresponding permissions to edit sitemaps are required.Example
Request body
Response
Error codes
DELETE sitemaps/templates/{id}
This endpoint lets you delete an existing sitemap template by its ID. Deletion is only possible if the corresponding template exists. For this action, permissions to delete sitemaps must be available.Example
Response
Error codes
Methods for generation
These methods let you control sitemap generation in a targeted way. Depending on the use case, you can generate individual sitemaps directly, trigger scheduled generations, or regenerate sitemaps after importing product data. Execution always requires the corresponding permissions to publish sitemaps.POST sitemaps/generate/hour/{hour}
This method starts the generation of sitemaps that must be generated at a specific hour. The path parameter{hour} specifies the hour in 24-hour format (0 to 23).
The generation is performed asynchronously, which means the response does not contain immediate results.
To use this endpoint, the corresponding permissions to publish sitemaps are required.
Example
Response
Error codes
POST sitemaps/generate/import
This endpoint generates all sitemaps that are scheduled for export after a successful product data import. Execution is asynchronous and the response does not contain any result content. To use this endpoint, the corresponding permissions to publish sitemaps must be available.Example
Response
Error codes
POST sitemaps/{id}/generate
This endpoint starts the generation of a specific sitemap, referenced by its ID. The generation is asynchronous — that is, the response does not return a finished file but only confirms the start of the process. To use the endpoint, the corresponding permissions to publish sitemaps are required. Optionally, the generation can be restricted to specific subshops via thesubshopId query parameter. The parameter can be specified multiple times to select multiple subshops.