GET /categories¶
GET /categories V5 | GET /categories V1
Warning
GET /categories V1 is now officially deprecated and scheduled for removal on May, 1st 2023. Please move to use GET /categories V5.
This URL returns the a map of id to categories in the format described in
Categories for the id’s requested in parameter categoryIds.
This parameter is a comma separated list of integers.
If the parameter categoryIds contains invalid data, i.e. not a positive
integer, the server returns 400 Bad Request.
GET /categories V5¶
GET /categories V5 has the same functionality as V1, except that it returns the categories in V5 format, see Categories for details.
Scope |
|
Accept |
|
Example¶
GET /api/sellside/categories?_traceId=api-test-672698259&categoryIds=1%2C2%2C22 HTTP/1.1
Host: www.mp.test
Authorization: Bearer d66d0344-143d-4cd2-9b62-789c85e536fe
Accept: application/sellside.category.list-v5+json; application/json
200 OK HTTP/1.1
Content-Type: application/sellside.category.list-v5+json
Oauth-Scope: api_ro api_rw console_ro console_rw
Oauth-Scope-Required: get_category
{
"1": {
"links": {
"self": "/api/sellside/category/1",
"parent": "/api/sellside/category/0"
},
"id": 1,
"parentId": 0,
"level": 1,
"path": "1",
"locales": [
"nl_NL"
],
"label": {
"nl_NL": "Antiek en Kunst"
},
"breadcrumbs": {
"nl_NL": [
"Antiek en Kunst"
]
},
"status": "ACTIVE",
"children": []
},
"2": {
"links": {
"self": "/api/sellside/category/2",
"parent": "/api/sellside/category/1"
},
"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": {
"bidMicros": "[10000,2500000]",
"totalBudgetMicros": "[1000000,2000000000000]",
"dailyBudgetMicros": "[10000000,2000000000000]",
"activeAds": "[1,100000]",
"titleLength": "[1,60]",
"descriptionLength": "[1,20000]",
"images": "[0,24]",
"urlMandatory": false,
"shippingOption": "OPTIONAL",
"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"
]
},
"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": []
}],
"children": []
},
"22": {
"links": {
"self": "/api/sellside/category/22",
"parent": "/api/sellside/category/1826"
},
"id": 22,
"parentId": 1826,
"level": 2,
"path": "1826_22",
"locales": [
"nl_NL"
],
"label": {
"nl_NL": "Ringen"
},
"breadcrumbs": {
"nl_NL": [
"Sieraden, Tassen en Uiterlijk",
"Ringen"
]
},
"status": "ACTIVE",
"config": {
"bidMicros": "[20000,2500000]",
"totalBudgetMicros": "[50000000,2000000000000]",
"dailyBudgetMicros": "[10000000,2000000000000]",
"activeAds": "[1,100000]",
"titleLength": "[1,60]",
"descriptionLength": "[1,20000]",
"images": "[0,24]",
"urlMandatory": false,
"shippingOption": "OPTIONAL",
"priceTypes": [
"BIDDING",
"BIDDING_FROM",
"FIXED_PRICE",
"FREE",
"NEGOTIABLE",
"SEE_DESCRIPTION",
"SWAP",
"CREDIBLE_BID",
"ON_DEMAND",
"NOT_APPLICABLE",
"RESERVED"
],
"priceUnits": {},
"verticals": [],
"tags": {
"nl_NL": [
"Ring"
]
},
"region": "DISABLED",
"relatedPaths": [
"1826_1827",
"1826_18",
"1826_13",
"1826_19",
"621_625"
]
},
"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": "condition",
"label": {
"nl_NL": "Conditie"
},
"tooltip": {},
"type": "STRING",
"values": {
"nl_NL": [
"Nieuw",
"Zo goed als nieuw",
"Gebruikt"
]
},
"defaults": {
"nl_NL": "Nieuw"
},
"mandatory": false,
"searchable": true,
"updatable": true,
"writable": true,
"precision": 0,
"range": null,
"length": null,
"prefix": {},
"postfix": {},
"hints": [],
"identifying": false
},
{
"key": "intendedFor",
"label": {
"nl_NL": "Bestemd voor"
},
"tooltip": {},
"type": "STRING",
"values": {
"nl_NL": [
"Dame",
"Heer",
"Dame of Heer"
]
},
"defaults": {},
"mandatory": false,
"searchable": true,
"updatable": true,
"writable": true,
"precision": 0,
"range": null,
"length": null,
"prefix": {},
"postfix": {},
"hints": [],
"identifying": false
},
{
"key": "size",
"label": {
"nl_NL": "Maat"
},
"tooltip": {},
"type": "STRING",
"values": {
"nl_NL": [
"Kleiner dan 17",
"17 tot 18",
"18 tot 19",
"19 tot 20",
"20 of groter"
]
},
"defaults": {},
"mandatory": false,
"searchable": true,
"updatable": true,
"writable": true,
"precision": 0,
"range": null,
"length": null,
"prefix": {},
"postfix": {},
"hints": [],
"identifying": false
},
{
"key": "color",
"label": {
"nl_NL": "Kleur"
},
"tooltip": {},
"type": "STRING",
"values": {
"nl_NL": [
"Blauw",
"Rood",
"Wit",
"Zwart",
"Beige",
"Bruin",
"Geel",
"Goud",
"Grijs",
"Groen",
"Oranje",
"Paars",
"Roze",
"Zilver",
"Overige kleuren"
]
},
"defaults": {},
"mandatory": false,
"searchable": true,
"updatable": true,
"writable": true,
"precision": 0,
"range": null,
"length": null,
"prefix": {},
"postfix": {},
"hints": [],
"identifying": false
},
{
"key": "material",
"label": {
"nl_NL": "Materiaal"
},
"tooltip": {},
"type": "STRING",
"values": {
"nl_NL": [
"Goud",
"Zilver",
"IJzer of Staal",
"Kunststof",
"Overige materialen"
]
},
"defaults": {},
"mandatory": false,
"searchable": true,
"updatable": true,
"writable": true,
"precision": 0,
"range": null,
"length": null,
"prefix": {},
"postfix": {},
"hints": [],
"identifying": false
}
]
}],
"children": []
}
}
GET /categories V1¶
Scope |
|
Accept |
|
Parameters¶
Name |
Type |
Description |
|---|---|---|
categoryIds |
string |
Comma-separated-list of integer id’s to get categories for. |
_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 |
|---|---|---|---|
categoryIds |
2000 |
missing argument |
The parameter needs to be present |
categoryIds |
2001 |
invalid argument |
The comma-separated-list contains one or more non-integer values |
categoryIds |
2004 |
too short |
The value needs to be non-empty |
Example¶
GET /api/sellside/categories?categoryIds=863,431
Accept: application/sellside.category.list-v1+json; application/json
200 OK
Content-Type: application/sellside.category.list-v1+json; charset=utf-8
{
"431": {
"links": {
"parent": "/api/sellside/category/428",
"self": "/api/sellside/category/431"
},
"id": 431,
"parentId": 428,
"level": 2,
"path": "428_431",
"locales": [
"nl_NL"
],
"label": {
"nl_NL": "Zorg | Brommobielen en Scootmobielen"
},
"breadcrumbs": {
"nl_NL": [
"Diversen",
"Zorg | Brommobielen en Scootmobielen"
]
},
"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": false,
"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": [
"445_712",
"91_157"
]
},
"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": "condition",
"label": {
"nl_NL": "Conditie"
},
"tooltip": {},
"type": "STRING",
"values": {
"nl_NL": [
"Nieuw",
"Zo goed als nieuw",
"Gebruikt"
]
},
"defaults": {
"nl_NL": "Nieuw"
},
"mandatory": true,
"searchable": true,
"updatable": true,
"writable": true,
"precision": 0,
"range": null,
"length": null,
"prefix": {},
"postfix": {},
"hints": []
}
]
}
]
},
"863": {
"links": {
"parent": "/api/sellside/category/856",
"self": "/api/sellside/category/863"
},
"id": 863,
"parentId": 856,
"level": 2,
"path": "856_863",
"locales": [
"nl_NL"
],
"label": {
"nl_NL": "Vakantiehuizen | Duitsland"
},
"breadcrumbs": {
"nl_NL": [
"Vakantie",
"Vakantiehuizen | Duitsland"
]
},
"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": false,
"currency": "EUR",
"priceTypes": [
"BIDDING",
"BIDDING_FROM",
"FIXED_PRICE",
"FREE",
"NEGOTIABLE",
"SEE_DESCRIPTION",
"SWAP",
"CREDIBLE_BID",
"ON_DEMAND",
"NOT_APPLICABLE",
"RESERVED"
],
"priceUnits": {},
"verticals": [
"VACATIONS"
],
"tags": {
"nl_NL": [
"vakantiehuis"
]
},
"region": "DISABLED",
"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": "situated",
"label": {
"nl_NL": "Ligging"
},
"tooltip": {},
"type": "STRING",
"values": {
"nl_NL": [
"Dorp",
"Stad",
"Landelijk",
"Recreatiepark",
"Overige"
]
},
"defaults": {},
"mandatory": false,
"searchable": true,
"updatable": true,
"writable": true,
"precision": 0,
"range": null,
"length": null,
"prefix": {},
"postfix": {},
"hints": []
},
{
"key": "surroundings",
"label": {
"nl_NL": "Omgeving"
},
"tooltip": {},
"type": "LIST",
"values": {
"nl_NL": [
"Aan zee",
"Aan meer of rivier",
"In bergen of heuvels",
"In bos",
"In wintersportgebied"
]
},
"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": "letter",
"label": {
"nl_NL": "Verhuurder"
},
"tooltip": {},
"type": "STRING",
"values": {
"nl_NL": [
"Eigenaar",
"Bemiddelingsbureau"
]
},
"defaults": {},
"mandatory": false,
"searchable": true,
"updatable": true,
"writable": true,
"precision": 0,
"range": null,
"length": null,
"prefix": {},
"postfix": {},
"hints": []
},
{
"key": "extras",
"label": {
"nl_NL": "Extra's"
},
"tooltip": {},
"type": "LIST",
"values": {
"nl_NL": [
"Afwasmachine",
"Airconditioning",
"Huisdier toegestaan",
"Internet",
"Kinderbed",
"Open haard",
"Rolstoelvriendelijk",
"Sauna of Jaccuzi",
"Speeltuin",
"Tuin",
"Tv",
"Wasmachine",
"Zwembad"
]
},
"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": []
}
]
}
]
}
}