Skip to content

Category

Field Type Required Description
code Code Human readable code of the entity
max length 255 · min length 1
parentCategoryCode Code Human readable code of the entity
max length 255 · min length 1
image `null string`
name string max length 255
url `null string`
description `null string`
externalUpdateDate ExternalUpdateDate format: date-time
status string one of: active, inactive
path array[string] Category path based on the category code of the parents
sequenceId integer By default this creates an ascending order of categories meaning 0 is the first.
productCount integer
categoryCount integer
parentCategoriesInfo array[object]
{
"code": "jeans",
"parentCategoryCode": "men",
"catalogCode": "US",
"image": "https://awesomeShop.com/img/jeans1.jpg",
"name": "Jeans",
"description": "This category contains jeans",
"url": "https://awesomeShop.com/c/jeans",
"externalUpdateDate": "2019-01-12T00:00:00.114Z",
"status": "active",
"path": [
"firstLevelCategory",
"secondLevelCategory",
"thirdLevelCategory"
],
"sequenceId": 0,
"parentCategoriesInfo": [
{
"code": "parentCatergory1",
"name": "Parent Category 1"
}
]
}