Methods

  • get - Get Categories (Multiple)
  • get - Get Categories (Single)
  • get - Get Category Children
  • post - Search Categories
  • post - Search Manufacturers
  • put - Update Category

Properties

{
    "addonValues": "string",
    "dateAdded": "string",
    "description": {
        "de": "string",
        "en": "string"
    },
    "headingTitle": {
        "de": "string",
        "en": "string"
    },
    "icon": "string",
    "id": "int64",
    "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
dateAdded string
description object GXMultiLangOption
description.de string Optional
description.en string Optional
headingTitle object GXMultiLangOption
headingTitle.de string Optional
headingTitle.en string Optional
icon string
id int64 Optional, read only.
image string
imageAltText object GXMultiLangOption
imageAltText.de string Optional
imageAltText.en string Optional
isActive boolean
lastModified string
metaDescription object GXMultiLangOption
metaDescription.de string Optional
metaDescription.en string Optional
metaKeywords object GXMultiLangOption
metaKeywords.de string Optional
metaKeywords.en string Optional
metaTitle object GXMultiLangOption
metaTitle.de string Optional
metaTitle.en string Optional
name object GXMultiLangOption
name.de string Optional
name.en string Optional
parentId int64
settings object categorySettings
settings.categoryListingTemplate string
settings.filterSelectionMode int64
settings.filterValueDeactivation int64
settings.groupPermissions[] array
settings.groupPermissions[].id int64
settings.groupPermissions[].isPermitted boolean
settings.isViewModeTiled boolean
settings.onSitemap boolean
settings.productListingTemplate string
settings.showAttributes boolean
settings.showCategoryFilter boolean
settings.showGraduatedPrice boolean
settings.showQuantity boolean
settings.showQuantityInfo boolean
settings.showSubCategories boolean
settings.showSubCategoryImages boolean
settings.showSubCategoryNames boolean
settings.showSubCategoryProducts boolean
settings.sitemapChangeFrequency string
settings.sitemapPriority double
settings.sortColumn string
settings.sortDirection string

Possible values are:

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