Methods

  • post - Create Categories
  • put - Update Category (Multiple)

Properties

[
    {
        "addonValues": "string",
        "dateAdded": "string",
        "description": {
            "de": "string",
            "en": "string"
        },
        "headingTitle": {
            "de": "string",
            "en": "string"
        },
        "icon": "string",
        "image": "string",
        "imageAltText": {
            "de": "string",
            "en": "string"
        },
        "isActive": "boolean",
        "lastModified": "string",
        "metaDescription": {
            "de": "string",
            "en": "string"
        },
        "metaKeywords": {
            "de": "string",
            "en": "string"
        },
        "metaTitle": {
            "de": "string",
            "en": "string"
        },
        "name": {
            "de": "string",
            "en": "string"
        },
        "parentId": "int64",
        "settings": {
            "categoryListingTemplate": "string",
            "filterSelectionMode": "int64",
            "filterValueDeactivation": "int64",
            "groupPermissions": [
                {
                    "id": "int64",
                    "isPermitted": "boolean"
                }
            ],
            "isViewModeTiled": "boolean",
            "onSitemap": "boolean",
            "productListingTemplate": "string",
            "showAttributes": "boolean",
            "showCategoryFilter": "boolean",
            "showGraduatedPrice": "boolean",
            "showQuantity": "boolean",
            "showQuantityInfo": "boolean",
            "showSubCategories": "boolean",
            "showSubCategoryImages": "boolean",
            "showSubCategoryNames": "boolean",
            "showSubCategoryProducts": "boolean",
            "sitemapChangeFrequency": "string",
            "sitemapPriority": "double",
            "sortColumn": "string",
            "sortDirection": "string"
        },
        "sortOrder": "int64",
        "urlKeywords": {
            "de": "string",
            "en": "string"
        }
    }
]
[
    {
        "addonValues": null,
        "dateAdded": "2008-08-08 17:16:41",
        "description": {
            "de": "Testkategorie Beschreibung",
            "en": "test category description"
        },
        "headingTitle": {
            "de": "Testkategorie",
            "en": "test category"
        },
        "icon": "item_ltr.gif",
        "image": "",
        "imageAltText": {
            "de": "",
            "en": ""
        },
        "isActive": true,
        "lastModified": "2008-08-25 17:33:52",
        "metaDescription": {
            "de": "",
            "en": ""
        },
        "metaKeywords": {
            "de": "",
            "en": ""
        },
        "metaTitle": {
            "de": "",
            "en": ""
        },
        "name": {
            "de": "Testkategorie",
            "en": "test category"
        },
        "parentId": 0,
        "settings": {
            "categoryListingTemplate": "categorie_listing.html",
            "filterSelectionMode": 0,
            "filterValueDeactivation": 0,
            "groupPermissions": [
                {
                    "id": "0",
                    "isPermitted": false
                },
                {
                    "id": "1",
                    "isPermitted": false
                },
                {
                    "id": "2",
                    "isPermitted": false
                },
                {
                    "id": "3",
                    "isPermitted": false
                }
            ],
            "isViewModeTiled": false,
            "onSitemap": true,
            "productListingTemplate": "product_listing_v1.html",
            "showAttributes": false,
            "showCategoryFilter": false,
            "showGraduatedPrice": false,
            "showQuantity": true,
            "showQuantityInfo": false,
            "showSubCategories": true,
            "showSubCategoryImages": true,
            "showSubCategoryNames": true,
            "showSubCategoryProducts": false,
            "sitemapChangeFrequency": "daily",
            "sitemapPriority": "0.5",
            "sortColumn": "p.products_price",
            "sortDirection": "ASC"
        },
        "sortOrder": 0,
        "urlKeywords": {
            "de": "Testkategorie",
            "en": "test-category"
        }
    }
]
Name Type Description Additional
addonValues string Required
dateAdded string Required
description object GXMultiLangOption Required
description.de string Optional
description.en string Optional
headingTitle object GXMultiLangOption Required
headingTitle.de string Optional
headingTitle.en string Optional
icon string Required
image string Required
imageAltText object GXMultiLangOption Required
imageAltText.de string Optional
imageAltText.en string Optional
isActive boolean Required
lastModified string Required
metaDescription object GXMultiLangOption Required
metaDescription.de string Optional
metaDescription.en string Optional
metaKeywords object GXMultiLangOption Required
metaKeywords.de string Optional
metaKeywords.en string Optional
metaTitle object GXMultiLangOption Required
metaTitle.de string Optional
metaTitle.en string Optional
name object GXMultiLangOption Required
name.de string Optional
name.en string Optional
parentId int64 Required
settings object categorySettings Required
settings.categoryListingTemplate string Required
settings.filterSelectionMode int64 Required
settings.filterValueDeactivation int64 Required
settings.groupPermissions[] array Required
settings.groupPermissions[].id int64 Required
settings.groupPermissions[].isPermitted boolean Required
settings.isViewModeTiled boolean Required
settings.onSitemap boolean Required
settings.productListingTemplate string Required
settings.showAttributes boolean Required
settings.showCategoryFilter boolean Required
settings.showGraduatedPrice boolean Required
settings.showQuantity boolean Required
settings.showQuantityInfo boolean Required
settings.showSubCategories boolean Required
settings.showSubCategoryImages boolean Required
settings.showSubCategoryNames boolean Required
settings.showSubCategoryProducts boolean Required
settings.sitemapChangeFrequency string Required
settings.sitemapPriority double Required
settings.sortColumn string Required
settings.sortDirection string

Possible values are:

  • ASC
  • DSC
Required
sortOrder int64 Required
urlKeywords object GXMultiLangOption Required
urlKeywords.de string Optional
urlKeywords.en string Optional