400-BadRequest Category data were not provided.
{Number} parentId The ID of the parent category (use 0 if there is no parent category).
{Boolean} isActive Whether the category is active.
{Number} sortOrder Category's sort order starts from 0.
{Object} name Multi-language object with the category's name.
{Object} headingTitle Multi-language object with the category's title.
{Object} description Multi-language object with the category's description.
{Object} metaTitle Multi-language object with the category's meta title.
{Object} metaDescription Multi-language object with the category's meta description.
{Object} metaKeywords Multi-language object with the category's meta keywords.
{Object} urlKeywords Multi-language object with the category's meta URL keywords.
{String} icon The category icon filename.
{String} image The category image filename.
{Object} imageAltText Multi-language object with image alt text.
{Object} settings Contains the category settings.
{String} settings.categoryListingTemplate Provide a category listing template
(categorie_listing.html
).
{String} settings.productListingTemplate Provide a product listing template
(product_listing_v1.html
).
{String} settings.sortColumn The name of the products column that will be used to sort the products.
{String} settings.sortDirection Provide
ASC
or
DESC
{Boolean} settings.onSitemap Whether the category appears on sitemap.
{String} settings.sitemapPriority A numerical string value that defines the priority.
{String} settings.sitemapChangeFrequency Possible values can contain the always
, hourly
, daily
,
weekly
, monthly
, yearly
, never
.
{Boolean} settings.showAttributes Show attributes flag.
{Boolean} settings.showGraduatedPrice Show graduated price flag.
{Boolean} settings.showQuantity Show quantity flag.
{Boolean} settings.showQuantityInfo Show quantity information flag.
{Boolean} settings.showSubCategories Show sub categories flag.
{Boolean} settings.showSubCategoryImages Show sub category images flag.
{Boolean} settings.showSubCategoryNames Show sub category names flag.
{Boolean} settings.showSubCategoryProducts Show sub category products flag.
{Boolean} settings.isViewModeTiled Whether the category view mode is tiled.
{Boolean} settings.showCategoryFilter Whether to show the category filter.
{Number} settings.filterSelectionMode Filter selection mode value.
{Number} settings.filterValueDeactivation Filter value deactivation mode value.
{Array} settings.groupPermissions Contains objects that have info about the customer group
permissions.
{Number} settings.groupPermissions.id The customer group permissions.
{Boolean} settings.groupPermissions.isPermitted Whether the current group is permitted to view the
category.
{json} Request-Body
{
"parentId": 0,
"isActive": true,
"sortOrder": 0,
"name": {
"en": "test category",
"de": "Testkategorie"
},
"headingTitle": {
"en": "test category",
"de": "Testkategorie"
},
"description": {
"en": "
test category description
",
"de": "
Testkategorie Beschreibung
"
},
"metaTitle": {
"en": "",
"de": ""
},
"metaDescription": {
"en": "",
"de": ""
},
"metaKeywords": {
"en": "",
"de": ""
},
"urlKeywords": {
"en": "test-category",
"de": "Testkategorie"
},
"icon": "item_ltr.gif",
"image": "",
"imageAltText": {
"en": "",
"de": ""
},
"settings": {
"categoryListingTemplate": "categorie_listing.html",
"productListingTemplate": "product_listing_v1.html",
"sortColumn": "p.products_price",
"sortDirection": "ASC",
"onSitemap": true,
"sitemapPriority": "0.5",
"sitemapChangeFrequency": "daily",
"showAttributes": false,
"showGraduatedPrice": false,
"showQuantity": true,
"showQuantityInfo": false,
"showSubCategories": true,
"showSubCategoryImages": true,
"showSubCategoryNames": true,
"showSubCategoryProducts": false,
"isViewModeTiled": false,
"showCategoryFilter": false,
"filterSelectionMode": 0,
"filterValueDeactivation": 0,
"groupPermissions": [
{
"id": "0",
"isPermitted": false
},
{
"id": "1",
"isPermitted": false
},
{
"id": "2",
"isPermitted": false
},
{
"id": "3",
"isPermitted": false
}
]
}
}