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. |
| order | Int | Optional. The order for this category group |
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 |
| overview_image | Image? | Nullable. |
| 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. |
| order | Int | Optional. The order for this category group |
When used inside a request.
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": false,
"category_ids": [
11,
15,
16
],
"uuid": "...",
"order": 10
}When returned in a response.
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": false,
"category_ids": [
15,
18,
17
],
"id": 10,
"overview_image": {
"resolutions": [
{
"src": "https://example.com",
"width": 600,
"height": 350
},
{
"src": "https://example.com",
"width": 600,
"height": 350
},
{
"src": "https://example.com",
"width": 600,
"height": 350
}
],
"file_id": 17,
"white_background": false
},
"uuid": "...",
"order": 15
}