s is for shopping
API product search
Use this API endpoint to implement onsite search capabilities. When submitting a term to search for, you can refine your search result supplying filter information, e.g in the brand or color parameter.
You can only request up to 150 characters as searchterm!
Sort & Pagination
In order to sort the result list you’ll just have to add the parameter
sort to the request.
All current sort types are listed in
link tags in the result.
Available sort criteria are
- Sorts search results by relevance and category pages by popularity.
- Sorts by product price.
- Sorts by
standardand boosts sale products to the beginning of the result list.
Response of search returns a paged results. In order to customize a paged response just add the parameters listed below.
- page index. Only if the page parameter is set, the response will be returned with pagination enabled. Per default the page index is set to
- number of elements returned on one page. The number of page elements is limited by the server side (max. number of page elements = 1000) per default the number of page elements is set to
There are several filter types, listed in
filters of the result. Each results is equipped with
matching filters. Non-matching filters are not returned. Each filter value has
who’s value can be used as request parameter to enable the filter. You’ll find a displayable name
To filter for product for a specific color, append the filter’s
name attribute and the item’s
You can use multiple ids for every filter, just separate them with comma. To exclude products matching a filter,
- in front of every id for this filter. Mixing in- and exclusions is not possible.
Each result is equipped with matching filters. Over time, more filters may appear and filter coverage may increase. The following filters are applicable on (almost) every search result - double check with the available filter section in the response body:
shop: The shop product is offered by
genderAge: The gender a product belongs to (male, female, children)
brand: The products brand
color: The products color
maxPrice: Filter in cents for defining a price range.
Unfortunately a full list of available filters is currently not available! A dedicated api endpoint is planned.
The following mechanisms are built into the product search api to either quickly reduce a huge search result or expand rather small (or zero result) results.
If a search query returns less than about 10 products, the search result contains related products.
They are encapsulated in a
<related> block as
<products> element and are somewhat related to the products matching the
Related brands are available if a brand could be recognized in the search query. They are also
encapsulated in the
<related> block as
<brands> element with a source
The brand in
<source> is the currently selected one, all others are related brands.
If a spelling error is detected in the query term, a
<didyoumean> element of type
spellcheck is added to
the search result. Those hints (and the following below) are encapsulated in a
For each spellcheck hint a rough product count is supplied.
If your search hits zero results and a spellcheck hint is available for the current query term,
a querycorrection is executed automatically. This is marked in the search result page as a
<querycorrection> element inside the
<reformulations> block. The
<original> element contains
the input query term, the
<correction> the executed query.
Reduced alternate searches
If a search hits zero or less than 10 results and no automatic spell correction could be applied (see above), a query reduction algorithm is applied to the query term (if it contains more than one word). Single words are removed from the query and the “reduced” query is executed.
The results are available inside the
<reformulations> container as
query-reduction. Inside, the following elements are available
- The reduced query compiled from the input query term
- The input query term with the removed words highlighted using a
- The products matching the reduced query, maximum of 5.
Related search queries are available for most issued product searches. They are also
encapsulated in the
<reformulations> block as
<didyoumean> element with a source
related-query. The product count is roughly estimated.
An autocomplete API endpoint is available at You can only request up to 50 characters as searchterm!
Results are sorted by approx. result size. The following is the autocomplete result for query term
Personal Shopping Context
You are able to individualize the product search experience by supplying a personal shopping context
for each user. This can be done by adding comma separated keywords in the parameter
psc. Keywords could be
brand names or items related to user. Those will be boosted in product searches.
If you supply
psc and search for
jeans, you’ll find male jeans by diesel (if available)
on the first search result pages. Results are not filtered just individually sorted.
Those keywords could be extracted from connected Facebook profiles or a personal user history.