Category Search

The Category Search web service returns category information for all categories on Kelkoo. This service is key to build a consistent and good user experience as it will allow you to build category site maps and list sub categories within our main product categories.

Request Parameters

The Catalog Listing web service supports the following parameters:

The category parameter determines the starting point for the category list/tree. If no category is specified, the top level category will be used as starting point.

Name Type Summary
category numeric (required)
format string (optional) The format determines what kind of category listing structure will be used.
If the value is List (default), the response will return a flat structure of categories; if the value is Tree, the response will return a tree structure with all subcategories as well.
shortcuts bool (optional) – true or false If set to true, the response will return shortcuts
features string (optional) Limit the result to categories with Refinements. The value can be either “None” or “Refinements”. The default value is “refinements”.

Starting point

If no category is specified in the request, the response will return the list of top level categories. If a category is specified, the response will return the list of subcategories for that category.

Format

If the format is List, the response will only return one level of categories, if the format is Tree, the response will return the complete visual category tree from the starting point.

Shortcuts

If shortcuts is true, the response will return shortcuts as well as categories, and if shortcuts is set to false, the response will return categories only.

Features

It is possible to get categories based on the features they have. This is useful for limiting the categories to categories including for instance refinements.

Response Elements

Top level Element

Name Summary
CategoryListing Contains Category and Shortcut elements. Including the xml schema and namespace definitions. Has the attributes:

  • format: format of the response, Tree or List.
  • id: The category ID of the requested category.
Category Each Refinement element contains a list of RefineValue elements. Only returned if category is specified in the request, there are available Refinements to return and that show_refinements is true. Has the attributes:

  • id: The category ID of the requested category.
  • name: The name of the category.
  • refinements: Can be true or false.
  • catalogs: Can be true or false.
Shortcut Contains information about a category shortcut. Does not have any child elements. Has the attributes:

  • id: The category ID of the requested category.
  • name: The name of the category.

Sample Response

The following is a sample response when you search for the categoryID: 108101 with the service.

<CategorySearch format="List" id="108101">
<Category catalogs="false" id="108101" name="Men's Clothing" refinements="false"/>
<Category catalogs="false" id="100331823" name="Men's Outerwear" refinements="true"/>
<Category catalogs="false" id="100344223" name="Men's Suits" refinements="true"/>
<Category catalogs="false" id="100332123" name="Men's Tops" refinements="true"/>
<Category catalogs="false" id="100332023" name="Men's Trousers" refinements="true"/>
<Category catalogs="false" id="108901" name="Men's Underwear" refinements="true"/>
<Category catalogs="false" id="100484623" name="Fancy Dress" refinements="true"/>
<Category catalogs="false" id="100481723" name="Men's Socks" refinements="true"/>
<Category catalogs="false" id="100481323" name="Men's Shorts" refinements="true"/>
<Category catalogs="false" id="100481423" name="Men's Jeans" refinements="true"/>
<Category catalogs="false" id="100481023" name="Men's Sweaters" refinements="true"/>
</CategorySearch>

Related Web Services

Catalog Reviews and Catalog Search