Skip to content

CategoryIdSearchPhraseFiltersProductIdsOffsetLimitSortActiveParam

Field Type Required Description
categoryId string the categoryId, but only “flat”, it will not “dive into” subcategories
searchPhrase string a search phrase to search for, not compatible with categoryId, use a category-filter, if you want to search inside categories
filters object 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.
offset integer For pagination, you should give the position of the first product, you want to retrieve
format: int32 · min 0 · default: 0
limit integer The maximum number of products you want to retrieve
format: int32 · max 100 · min 1 · default: 20
sort string How to sort the result, relevance will be controlled by the merchants shop-system or the import order
one of: priceAsc, priceDesc, relevance, random
showInactive boolean Only active products would be returned, it this is omitted or false, set it to true, to fetch inactive ones too
productIds array[string] Can not be combined with filters or a searchPhrase, will retrieve specific products
{
"categoryId": "string",
"searchPhrase": "string",
"offset": 0,
"limit": 0,
"sort": "priceAsc",
"showInactive": true,
"productIds": [
"string"
]
}