company.CategoryGroup

Request

Fields when send to the api inside a request.

Field Type Description
name [Language: String] Name of the category group
active Bool Set active status of category group
category_ids [Int] Category IDs that are children to this category group
uuid String Optional. A unique ID for this category group. You can choose your own ID's as long as they are unique within a shop. If you don't set an ID, we will generate a UUID.

Response

Fields when returned by the api in a response.

Field Type Description
name [Language: String] Name of the category group
active Bool Set active status of category group
category_ids [Int] Category IDs that are children to this category group
id Int ID of the category group
uuid String Optional. A unique ID for this category group. You can choose your own ID's as long as they are unique within a shop. If you don't set an ID, we will generate a UUID.

Examples

Request

When used inside a request.

Example 1 

{
    "name": {
        "nl": "...",
        "en": "...",
        "fr": "..."
    },
    "active": false,
    "category_ids": [
        10,
        17,
        15
    ],
    "uuid": "..."
}

Response

When returned in a response.

Example 1 

{
    "name": {
        "nl": "...",
        "en": "...",
        "fr": "..."
    },
    "active": true,
    "category_ids": [
        19,
        18,
        19
    ],
    "id": 12,
    "uuid": "..."
}
Version update available Please adjust your integration to the latest stable version (1.9.0)
1.8.0 stable