post

/shopgate.catalog.getTotalProductCount.v1

This pipeline will utilize the same search mechanism as the ‘getProducts_v1’ pipeline, but will omit the products and extract the totalProductCount only. This is useful in cases where the actual product data is of no interest, because it is faster. It can be combined with filters, to preview the number of products, that would be found in a filter search.

Request Body

Schema
object
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.

Responses

Successful response.

1 Example
Schema
object
output
ERROR_NO_TYPE
required
totalProductCount
integer

The number of products, that would be found when searching while using the given search parameters.

1 validation

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
$$.env
1 variable not set
host