Update Category by lookup key
PATCH/categories/:lookupKey/:lookupValue
Use this endpoint to update category 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
- application/json
Body
Array [
]
Array [
]
Array [
]
descriptions
object[]
names
object[]
parent
object
shortDescriptions
object[]
Responses
- 200
- 404
Update 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)
- Update Category by Id - 200
Schema
Array [
]
Array [
]
Array [
]
data
object
descriptions
object[]
names
object[]
parent
object
shortDescriptions
object[]
{
"data": {
"descriptions": [
{
"language": "NL",
"value": "Fiets"
},
{
"language": "EN",
"value": "Bike"
}
],
"id": 1771,
"names": [
{
"language": "NL",
"value": "Fiets"
},
{
"language": "EN",
"value": "Bike"
}
],
"parent": {
"id": 1320
},
"shortDescriptions": [
{
"language": "NL",
"value": "Fiets"
},
{
"language": "EN",
"value": "Bike"
}
],
"source": "REST-API",
"sourceId": "020000"
},
"messages": [
"Category updated"
],
"total": 1
}
{
"data": {
"descriptions": [
{
"language": "NL",
"value": "Fiets"
},
{
"language": "EN",
"value": "Bike"
}
],
"id": 1771,
"names": [
{
"language": "NL",
"value": "Fiets"
},
{
"language": "EN",
"value": "Bike"
}
],
"parent": {
"id": 1320
},
"shortDescriptions": [
{
"language": "NL",
"value": "Fiets"
},
{
"language": "EN",
"value": "Bike"
}
],
"source": "REST-API",
"sourceId": "020000"
},
"messages": [
"Category updated"
],
"total": 1
}
Update Category by source id - 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)
- Update Category by source id - 404
Schema
error
object
{
"error": {
"code": 30006,
"messages": [
"Category with sourceId [17712] not found"
],
"moreInfo": "https://www.propel.us/docs/errors/30006",
"status": 404,
"type": "CategoryNotFound"
}
}
{
"error": {
"code": 30006,
"messages": [
"Category with sourceId [17712] not found"
],
"moreInfo": "https://www.propel.us/docs/errors/30006",
"status": 404,
"type": "CategoryNotFound"
}
}