This pipeline gives you a (paginated) product list. It can be used to either “search” for products or the content of categories. If the categoryId parameter is set, the searchPhrase will be ignored, to search inside a category (or more categories), you have to use filters combined with a search phrase.
There are some undocumented input parameters, that are only used internally, but in theory you could use them too. These are the boolean parameters “skipHighlightLoading” and “skipLiveshoppingLoading” and will prevent the pipeline from loading there data to the products, for performance reasons or if you just don’t need these data, if you set them to true.
the categoryId, but only “flat”, it will not “dive into” subcategories
a search phrase to search for, not compatible with categoryId, use a category-filter, if you want to search inside categories
The key is the filterId or name of filter, like categories, manufacturer or other attributes/options/properties like “Größe”. The value has to be an object with a values key, that holds an array of strings (the “id” from the filters-endpoint) or minimum and/or maximum integer values. If the filters object (from the filters-endpoint) delivers a source too, you have to send it too. For categories you have to give the content of the id property, which is the name/path of the category, not the category id itself.
For pagination, you should give the position of the first product, you want to retrieve
The maximum number of products you want to retrieve
How to sort the result, relevance will be controlled by the merchants shop-system or the import order
Only active products would be returned, it this is omitted or false, set it to true, to fetch inactive ones too
Can not be combined with filters or a searchPhrase, will retrieve specific products
The total number of products that were found, independent of the offset or limit