/feeds/categories-list | Kelkoo Group Help Center

The /feeds/categories-list endpoints retrieve all categories you have access through KelkooGroup network along with some details about them.

The structure can be a list or a tree.

There are two main use cases for retrieving the categories:

you want to display more information about the categories related to offers from Offer search
you are using Offer feeds and you need to know the list of available categories.

The id field is the identifier of a category in KelkooGroup systems and can be used with other resources. For instance, this identifier must be used when retrieving an offers feed to filter by a category.

Data freshness

The categories do not change much. You can retrieve this resource once a day, it's enough.

Endpoints

/feeds/categories-list: retrieve the categories as a list.

See Request builder

Authentication

See JWT details

Compressed data

Please note that you should ask for compressed data, otherwise you will receive an error 406 Not Acceptable.

Most HTTP client libraries offer a setting to transparently activate compression when configuring the client. See below in the HTTP Headers section how to do it manually.

Query parameters

Name	Type	Domain	Default	Description	Example
`country`*	string			Country filter	`country=fr`
`format`	string	{'json','xml','csv'}	'json'	Output format. Can be specified in the headers. 'csv' is not available as a tree for obvious reasons.	`format=xml`

Filter

Name	Type	Domain	Default	Description	Example
`level`	number	{1-6}		Retrieve only categories at the given level. No filter if not provided.	`level=3`

HTTP headers

Name	Type	Domain	Default	Description	Example
`Accept-Encoding`	string	{'gzip'}		You have to request compressed data. This is the way to do it.	`Accept-Encoding: gzip`
`Accept`	string	{'application/json', 'application/xml', 'text/csv'}		Output format. Can be specified in the parameters. The http parameters wins.	`Accept: application/json`

Response

The response can be either

in json, in xml or in csv

To handle properly this stream, please follow the streaming guide.

JSON format

When I call KelkooGroup API with a valid JWT on https://api.kelkoogroup.net/publisher/shopping/v2/feeds/category-list?country=fr
Then I get a response with status 200
And I get a response with filename categories-fr.json
And I get following json body response

JSON

[
  {
    "name": "Home Page",
    "id": 601,
    "level": 1
  },
  {
    "name": "Alimentation, boissons et tabac",
    "id": 128701,
    "level2": "Alimentation, boissons et tabac",
    "level": 2
  },
  {
    "name": "Alimentation bébé",
    "id": 100567413,
    "level2": "Alimentation, boissons et tabac",
    "level3": "Alimentation bébé",
    "level": 3
  },
  {
    "name": "Auto et Moto",
    "id": 172601,
    "level2": "Auto et Moto",
    "level": 2
  },
  {
    "name": "Auto",
    "id": 173001,
    "level2": "Auto et Moto",
    "level3": "Auto",
    "level": 3
  },
  {
    "name": "Accessoires Auto",
    "id": 7313,
    "level2": "Auto et Moto",
    "level3": "Auto",
    "level4": "Accessoires Auto",
    "level": 4
  },
  {
    "name": "GPS",
    "id": 100278823,
    "level2": "Auto et Moto",
    "level3": "Auto",
    "level4": "GPS",
    "level": 4
  },
  {
    "name": "RandomCat",
    "id": 100000,
    "level2": "RandomCat",
    "level": 2
  }
]

XML format

When I call KelkooGroup API with a valid JWT on https://api.kelkoogroup.net/publisher/shopping/v2/feeds/category-list?country=fr&format=xml
Then I get a response with status 200
And I get a response with filename categories-fr.xml
And I get a response containing the following xml content

XML

<category_list format="list" xmlns="urn:kelkoo">
    <category name="Home Page" id="601" level="1" />
    <category name="Alimentation, boissons et tabac" id="128701" level2="Alimentation, boissons et tabac" level="2"/>
    <category name="Alimentation bébé" id="100567413" level2="Alimentation, boissons et tabac" level3="Alimentation bébé" level="3"/>
    <category name="Auto et Moto" id="172601" level2="Auto et Moto" level="2"/>
    <category name="Auto" id="173001" level2="Auto et Moto" level3="Auto" level="3"/>
    <category name="Accessoires Auto" id="7313" level2="Auto et Moto" level3="Auto" level4="Accessoires Auto" level="4"/>
    <category name="GPS" id="100278823" level2="Auto et Moto" level3="Auto" level4="GPS" level="4"/>
    <category name="RandomCat" id="100000" level2="RandomCat" level="2"/>
</category_list>

CSV format

When I call KelkooGroup API with a valid JWT on https://api.kelkoogroup.net/publisher/shopping/v2/feeds/category-list?country=fr&format=csv
Then I get a response with status 200
And I get a response with filename categories-fr.csv
And I get a response containing the following csv content

"name","id","level","level2","level3","level4","level5","level6","google_product_category_id","google_product_category_name"
"Alimentation, boissons et tabac",128701,2,"Alimentation, boissons et tabac",,,,,,
"Alimentation bébé",100567413,3,"Alimentation, boissons et tabac","Alimentation bébé",,,,,
"Auto et Moto",172601,2,"Auto et Moto",,,,,,
"Auto",173001,3,"Auto et Moto","Auto",,,,,
"Accessoires Auto",7313,4,"Auto et Moto","Auto","Accessoires Auto",,,,
"GPS",100278823,4,"Auto et Moto","Auto","GPS",,,,
"RandomCat",100000,2,"RandomCat",,,,,,