Get Category by lookup key
GET/categories/:lookupKey/:lookupValue
Use this endpoint to retrieve category details by lookup key. If multiple categories with the same lookup key exist, use additional filtering depending on the lookup key to uniquely identify the category (e.g. source
and language
for lookup key source
).
Request
Path Parameters
Lookup key. Read more about category lookup keys
The value of the key (id or sourceId)
Query Parameters
Optional. Used in combination with lookup key sourceId
Optional. Default language of the category
Use translation
when retrieving translated fields in all languages. By default, only the default language of the category will be provided. What is resource expanding?
Responses
- 200
- 404
Get Category by Id - 200
Response Headers
Alt-Svc
string
Via
string
alt-svc
string
content-length
string
date
string
return-format
string
server
string
x-request-id
string
- application/json
- Schema
- Example (from schema)
- Get Category by Id - 200
Schema
Array [
]
Array [
]
Array [
]
data
object
descriptions
object[]
names
object[]
shortDescriptions
object[]
{
"data": {
"descriptions": [
{
"language": "NL",
"value": "Fiets"
},
{
"language": "EN",
"value": "Bike"
}
],
"id": 1787,
"names": [
{
"language": "NL",
"value": "Fiets"
},
{
"language": "EN",
"value": "Bike"
}
],
"shortDescriptions": [
{
"language": "NL",
"value": "Fiets"
},
{
"language": "EN",
"value": "Bike"
}
]
},
"messages": [],
"total": 1
}
{
"data": {
"descriptions": [
{
"language": "NL",
"value": "Fiets"
},
{
"language": "EN",
"value": "Bike"
}
],
"id": 1787,
"names": [
{
"language": "NL",
"value": "Fiets"
},
{
"language": "EN",
"value": "Bike"
}
],
"shortDescriptions": [
{
"language": "NL",
"value": "Fiets"
},
{
"language": "EN",
"value": "Bike"
}
]
},
"messages": [],
"total": 1
}
Get Category by sourceId - 404
Response Headers
Alt-Svc
string
Via
string
alt-svc
string
content-length
string
date
string
return-format
string
server
string
x-request-id
string
- application/json
- Schema
- Example (from schema)
- Get Category by sourceId - 404
Schema
error
object
{
"error": {
"code": 30006,
"messages": [
"Category with sourceId [1771] not found"
],
"moreInfo": "https://www.propel.us/docs/errors/30006",
"status": 404,
"type": "CategoryNotFound"
}
}
{
"error": {
"code": 30006,
"messages": [
"Category with sourceId [1771] not found"
],
"moreInfo": "https://www.propel.us/docs/errors/30006",
"status": 404,
"type": "CategoryNotFound"
}
}