post

/shopgate.catalog.getProducts.v1

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.

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.

offset
integer

For pagination, you should give the position of the first product, you want to retrieve

format: int32
minimum: 0
default: 0
limit
integer

The maximum number of products you want to retrieve

format: int32
minimum: 1
maximum: 100
default: 20
sort
string

How to sort the result, relevance will be controlled by the merchants shop-system or the import order

Allowed Values: 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

Responses

Successful response.

1 Example
Schema
object
output
ERROR_NO_TYPE
required
totalProductCount
integer

The total number of products that were found, independent of the offset or limit

1 validation
products
array[object]

Send a Test Request

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