Categories

This endpoint can be used to retrieve a list of available categories for this client

Reference

POST /categories/

Retrieve a list of the available categories and optionally filter the result using additional parameters.

General search parameters

field type description/constraints Req W U
useCache boolean Use API caching module No No No
groupId array List of groupId's to include in the searchresult. When omitted: all group ids linked with this client will be in the result. No No No
categoryId array List of categoryId's to include. No No No
userId int Only show groups used by this user. No No No
status string Use in combination with userId. No No No
Filter groups by advertisement-status
Available options:
- concept
- active (default)
- archive
availability boolean Use in combination with userId No No No
Show per portal if an active advertisement is available using the specific category
priceAvailable boolean Only include categories where price-data is available (Default: false) No No No
locale array List of locales to include in the search-result No No No
conversiontree boolean Show conversiontree (Default: false) No No No
searchkeyword string search/filter by keyword No No No
page int Show page x from resultset (Default: 1) No No No
itemsPerPage int Number of items per page
Minimum: 1 item
Maximum 100 items (Default: 25)		 No No No
total boolean show one complete list instead of a limited number of items per page.
Default: false		 No No No


Fields

field type constraints W U
groupId int The groupId No No
groupDescriptions array List of groupDescription-objects No No
categories array List of category-object No No


Fields groupDescription

field type constraints W U
locale string The locale. Default: nl_NL No No
description string The description No No


Fields category

field type constraints W U
categoryId int The categoryId No No
categoryDescriptions array List of categoryDescription-objects No No
conversiontree array List of conversiontree-objects showing the category data on Marktplaats. No No
availability object availability-object


Fields categoryDescription

field type constraints W U
locale string The locale. Default: nl_NL No No
description string The description No No


Fields conversiontree

field type constraints W U
portal string The name of the external portal.Default: marktplaats No No
id int/string The id used by this portal No No
descriptions array List of conversiontreeDescription-objects No No


Fields conversiontreeDescription

field type constraints W U
locale string The locale. Default: nl_NL No No
description string The description used by this portal No No


Fields availability

field type constraints W U
marktplaats boolean No No
tweedehands boolean No No
website boolean No No

Example

Request

POST /rest/v1/categories/ HTTP/2

{
 "useCache": false,
 "groupId": [
   1
 ],
 "categoryId": [
   1
 ],
 "locale": [
   "nl_NL"
 ],
 "conversiontree": true,
 "page": 1,
 "itemsPerPage": 100
}

Response

{
"fromCache": false,
"totalItems": 1,
"totalInSet": 1,
"page": 1,
"itemsPerPage": 100,
"speed": 0.00020098686218262,
"data": [
 {
   "groupId": 1,
   "descriptions": [
     {
       "locale": "nl_NL",
       "description": "Antiek en Kunst"
     }
   ],
   "categories": [
     {
       "categoryId": 1,
       "descriptions": [
         {
           "locale": "nl_NL",
           "description": "Antiek | Bestek"
         }
       ],
       "conversiontree": [
         {
           "portal": "marktplaats",
           "id": 2,
           "descriptions": [
             {
               "locale": "nl_NL",
               "description": "Antiek en Kunst | Antiek | Bestek"
             }
           ]
         }
       ]
     }
   ]
 }
]
}