GET /category/{id}

GET /category/{id} v5 | GET /category/{id} v2

Warning

GET /category/{id} v2 is now officially deprecated and scheduled for removal on May, 1st 2023. Please move to use GET /category/{id} v5.

This URL returns the category tree or parts of it in the format described in Categories starting from the category with the given category id. To return the category tree starting from the root node use id 0. If the category does not exist the server returns 404 Not Found. If the id is invalid, i.e. not a positive integer the server returns 400 Bad Request.

The levels parameter specifies how many levels starting from the current one you want to retrieve. The default is 0 which means that only the category itself is returned. To retrieve all sub levels specify a sufficiently large number, e.g. 9999.

GET /category/{id} v5

Scope	api_ro or console_ro
Accept	application/sellside.category-v5+json, application/json

Example

GET /api/sellside/category/2?levels=1
Accept: application/sellside.category-v5+json; application/json

200 OK
Content-Type: application/sellside.category-v5+json; charset=utf-8

{
  "links": {
    "parent": "/api/sellside/category/856",
    "self": "/api/sellside/category/863"
  },
  "id": 863,
  "parentId": 856,
  "level": 2,
  "path": "856_863",
  "label": {
    "nl_NL": "Vakantiehuizen | Duitsland"
  },
  "breadcrumbs": {
    "nl_NL": [
      "Vakantie",
      "Vakantiehuizen | Duitsland"
    ]
  },
  "status": "ACTIVE",
  "config": {
    "bidMicros": "[10000,2500000]",
    "totalBudgetMicros": "[5000000,200000000000]",
    "dailyBudgetMicros": "[1000000,200000000000]",
    "activeAds": "[0,7000]",
    "titleLength": "[1,60]",
    "descriptionLength": "[1,20000]",
    "images": "[1,24]",
    "urlMandatory": false,
    "shippingOption": "DISABLED",
    "priceTypes": ["FIXED_PRICE", "BIDDING_FROM", "SEE_DESCRIPTION"],
    "priceUnits": {
      "per_night": {
        "nl_NL": "per nacht"
      }
    },
    "verticals": [
      "VACATIONS"
    ],
    "tags": {
      "nl_NL": [
        "vakantiehuis"
      ]
    },
    "relatedPaths": [
      "856_892",
      "856_862"
    ]
  },
  "attributeGroups": [
    {
      "label": {
        "nl_NL": "Kenmerken"
      },
      "tooltip": {
        "nl_NL": "Geef hier welk type advertentie u gaat maken en wat de conditie van uw product is"
      },
      "attributes": [
        {
          "key": "region",
          "label": {
            "nl_NL": "Regio"
          },
          "tooltip": {},
          "type": "STRING",
          "values": {
            "nl_NL": [
             "Sauerland",
             "Beieren",
             "Berlijn",
             "Eifel",
             "Harz",
             "Moezel",
             "Noord-Duitsland",
             "Oost-Duitsland",
             "Zwarte Woud",
             "Overige regio's"
              ]
            },
            "defaults": {},
            "mandatory": false,
            "searchable": true,
            "updatable": true,
            "writable": true,
            "precision": 0,
            "range": null,
            "length": null,
            "prefix": {},
            "postfix": {},
            "hints": []
          },
          {
            "key": "type",
            "label": {
              "nl_NL": "Type"
            },
            "tooltip": {},
            "type": "STRING",
            "values": {
              "nl_NL": [
                "Appartement",
                "Boerderij of Cottage",
                "Chalet, Bungalow of Caravan",
                "Landhuis of Villa",
                "Overige typen"
              ]
            },
            "defaults": {},
            "mandatory": false,
            "searchable": true,
            "updatable": true,
            "writable": true,
            "precision": 0,
            "range": null,
            "length": null,
            "prefix": {},
            "postfix": {},
            "hints": []
          },
          {
            "key": "numberOfBedrooms",
            "label": {
              "nl_NL": "Aantal slaapkamers"
            },
            "tooltip": {},
            "type": "STRING",
            "values": {
               "nl_NL": [
                 "1 slaapkamer",
                 "2 slaapkamers",
                 "3 slaapkamers",
                 "4 of meer slaapkamers",
                 "Groepsaccommodatie"
               ]
             },
             "defaults": {},
             "mandatory": false,
             "searchable": true,
             "updatable": true,
             "writable": true,
             "precision": 0,
             "range": null,
             "length": null,
             "prefix": {},
             "postfix": {},
             "hints": []
          },
          {
            "key": "numberOfPersons",
            "label": {
              "nl_NL": "Aantal personen"
            },
            "tooltip": {},
            "type": "NUMBER",
            "values": {},
            "defaults": {},
            "mandatory": false,
            "searchable": true,
            "updatable": true,
            "writable": true,
            "precision": 0,
            "range": "[1,99]",
            "length": null,
            "prefix": {},
            "postfix": {
                "nl_NL": "personen"
            },
            "hints": []
          }
        ]
      }
    ]
}

GET /category/{id} v2

Scope	api_ro or console_ro
Accept	application/sellside.category-v2+json, application/json

Parameters

Name	Type	Description
levels	int	The number of sub category levels to return. Use 9999 for all. The default is 0.
_include	string	Comma-separated-list of fields to include. Optional, default is all fields.
_exclude	string	Comma-separated-list of fields to omit. Optional, default empty.

Errors

Field	Code	Error message	Description
id	2001	invalid argument	not a valid number
id	2002	out of range	negative number
levels	2001	invalid argument	not a valid number
levels	2002	out of range	negative number

Example

GET /api/sellside/category/2?levels=1
Accept: application/sellside.category-v2+json; application/json

200 OK
Content-Type: application/sellside.category-v2+json; charset=utf-8

{
    "links": {
        "parent": "/api/sellside/category/1",
        "self": "/api/sellside/category/2"
    },
    "id": 2,
    "parentId": 1,
    "level": 2,
    "path": "1_2",
    "locales": [
        "nl_NL"
    ],
    "label": {
        "nl_NL": "Antiek | Bestek"
    },
    "breadcrumbs": {
        "nl_NL": [
            "Antiek en Kunst",
            "Antiek | Bestek"
        ]
    },
    "status": "ACTIVE",
    "config": {
        "cpc": "[1,250]",
        "totalBudget": "[5000,200000000]",
        "minDailyBudget": 1000,
        "activeAds": "[1,7000]",
        "titleLength": "[1,60]",
        "descriptionLength": "[1,20000]",
        "images": "[0,8]",
        "urlMandatory": false,
        "shippingOption": "DISABLED",
        "paypalEnabled": true,
        "paypalBpEnabled": true,
        "currency": "EUR",
        "priceTypes": [
            "BIDDING",
            "BIDDING_FROM",
            "FIXED_PRICE",
            "FREE",
            "NEGOTIABLE",
            "SEE_DESCRIPTION",
            "SWAP",
            "CREDIBLE_BID",
            "ON_DEMAND",
            "NOT_APPLICABLE",
            "RESERVED"
        ],
        "priceUnits": {},
        "verticals": [],
        "tags": {},
        "region": "DISABLED",
        "relatedPaths": [
            "1_2614",
            "1_15",
            "504_1941"
        ]
    }
}