Skip to main content
The URL Resolution API is used to resolve a storefront URL (especially SEO URLs) to the matching shop content. This lets the frontend build its routing on speaking URLs and obtain the result of whether the URL belongs to, for example, a product or a category — including the required internal IDs. The detail data can then be specifically retrieved via the Catalog API. A typical flow is: the storefront submits a URL such as /herren/schuhe/sneaker, the API returns the target type (e.g. category) and the corresponding category ID, and afterwards the contents are loaded via the Catalog API.

​
Supported methods

List of all supported methods.
CommandEndpointsGETPUTPOSTDELETE
Identify SEO URLsurls/identify
Retrieve SEO URL of a producturls/product
Retrieve SEO URL of a categoryurls/category

​
SEO URLs

​
GET urls/identify

The following call can be used to determine where an SEO URL leads in the shop (product, category, content page, or start page). 
GET https://<your-shop>.de/api/v1/urls/identify?url=<url>
The response contains the type of URL and — depending on the type — a resource (e.g. an ID or a path).
The API distinguishes between the following types
TypeResourceDescription
"Product"Product IDRefers to a product page and contains the corresponding product ID to which the URL belongs.
"Category"Category IDRefers to a category page and contains the category ID called up via the URL.
"View"Template pathRefers to a shop page or template that is loaded via the specified path.
"Startpage"—Refers to the start page of the shop. No additional resource is output for this type.

​
Examples

Successful identification (main URL) The URL points directly to a product. The type and the corresponding ID are specified in the response. 
GET https://<your-shop>.de/api/v1/urls/identify?url=/products/awesome-widget
Example response 
{
  "type": "Product",
  "id": "12345"
}

​
Successful identification with redirect

Obsolete URLs are recognized and redirected to the current URL. In addition to the ID, a redirect is also delivered. 
GET https://<your-shop>.de/api/v1/urls/identify?url=/products/old-product-name
Example response 
{
  "type": "Product",
  "id": "12345",
  "redirect": "/products/awesome-widget"
}

​
Category

If the URL leads to a category, the response contains a category ID. 
GET https://<your-shop>.de/api/v1/urls/identify?url=/categories/electronics
Example response 
{
  "type": "Category",
  "id": "789"
}

​
Start page

If the URL leads to the start page, there is no additional (ID) resource in the response. 
GET https://<your-shop>.de/api/v1/urls/identify?url=/
Example response 
{
  "type": "Startpage"
}

​
Invalid URL

If the URL is not known to the system, the API responds with a “404 Not Found”. 
GET https://<your-shop>.de/api/v1/urls/identify?url=/non-existent-page
Example response 
HTTP/1.1 404 Not Found

​
GET urls/product

The following call can be used to determine the SEO URL of a product based on the product ID. 
GET https://<your-shop>.de/api/v1/urls/product?productId=<productId>

​
Parameter overview

ParameterTypeDescription
productIdstringRequired field
ID of the product whose SEO URL should be determined.

​
Example response

{
  "url": "/url/to/product"
}
  • If the product was not found, the request returns 404 Not Found.
  • On success, the request returns 200 OK including the output of the product’s SEO URL mentioned in the example in the body.

​
GET urls/category

The following call can be used to determine the SEO URL of a category based on the category ID. 
GET https://<your-shop>.de/api/v1/urls/category?categoryId=<categoryId>

​
Parameter overview

ParameterTypeDescription
categoryIdstringRequired field
ID of the category whose SEO URL should be determined.

​
Example response

{
  "url": "/url/to/category"
}
  • If the category was not found, the request returns 404 Not Found.
  • On success, the request returns 200 OK including the output of the category’s SEO URL mentioned in the example in the body.