Eureka: Category Collection

Prev Next

The Category Collection type of the Eureka’s Category Merchandising API allows the retrieval of all products belonging to a specific category in the product catalog, helping to narrow down results based on product type. For example, you can retrieve products under the "Footwear" category to get all shoes.

Structures

Flat Structure

Some catalogs use a non-hierarchical or flat category structure where categories are not nested (e.g., Shoes, Footwear instead of Women > Shoes > Sneakers). In this case, you can retrieve products within specific categories, such as Shoes.

Multiple Flat Category Retrieval

Only products belonging to both categories are returned when multiple singular categories are used in a flat category search. These categories are connected using an "AND" condition, meaning that a product must be classified under both to be included. For example, searching for Shoes and Footwear will return only products categorized as both Shoes and Footwear.

The cf parameter should be formatted the same way as in hierarchical structures, such as shoes or shoes~footwear

Merchandising rules cannot be applied to multiple flat category retrievals.

Hierarchical Structure

Some catalogs use a hierarchical category structure, where categories follow a parent-child relationship (e.g., Women > Shoes > Sneakers). In this case, searches should use the whole structure to ensure accurate results. For example, to retrieve products under Women > Shoes, use Women~Shoes.

You can select Flat or Hierarchical structure from Catalog Settings > Category Type page in the InOne panel.
To use the Category Collection type, the category attribute in the product catalog must be properly populated to ensure product retrieval.

Request Parameters

The type path variable value must exactly match the example values provided in the request parameter table.
The cf parameter value must exactly match the values defined in the product catalog.
ParameterDescriptionData TypeRequiredExample
typePath variable that specifies the desired product listing type
StringYes"Category"
cfAllows filtering of products within the specified listing type
StringYescf=Women~Shoes~Trainers
pPartner ID. Navigate to Inone Settings > Account Settings to copy your Partner ID.
StringYes
lLocale is required to get your products in the current language of the website. E.g. en_US, en_GB
StringYesl=en_US
cProducts will be displayed in the given currency (The current currency selected by the end-user on your website). E.g., USD,  AUD
StringYesc=USD
aFilter the products with the following pattern: a={field}~{value}
List of StringNoa=size~38~39
pfIndex indicating from which order the products will start to be listed. It is used for pagination. The default value is pf=0.
IntegerNo
psNumber of products that will be returned in the response. The default value is ps=6.
IntegerNo
stSorting type of the listed products. It only takes one of the predefined sorting types. The default value is st=Relevancy.
StringNo
oiThe listed products will only be displayed as item IDs. The default value is oi=False
BooleanNo
ocThe listed products will be displayed without their variants. The default value is false.
BooleanNo
uUser ID can be found in local storage by the key name spUID. spUID, which is a stringified object and contains data and expired properties.
StringNo