Fields when send to the api inside a request.
| Field | Type | Description |
|---|---|---|
| name | [Language: String] | Translated category name |
| description | [Language: String] | Description of this category |
| active | Bool | A boolean value |
| only_order_in_store | Bool | Whether this product can only get ordered in the store with a separate UI for the shop employees, and not in the public webshop |
| seo | company.SeoData | Optional. The category's webpage search engine metatags |
Fields when returned by the api in a response.
| Field | Type | Description |
|---|---|---|
| name | [Language: String] | Translated category name |
| description | [Language: String] | Description of this category |
| active | Bool | A boolean value |
| only_order_in_store | Bool | Whether this product can only get ordered in the store with a separate UI for the shop employees, and not in the public webshop |
| id | Int | ID of the category |
| banner | Image? | Nullable. |
| seo | company.SeoData | Optional. The category's webpage search engine metatags |
When used inside a request.
{
"name": "Clark Schiller",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"only_order_in_store": false,
"seo": {
"title": {
"en": "Qui culpa a error et excepturi voluptatem enim."
},
"description": {
"en": "Sit quaerat non eum ut. Architecto corporis earum et repudiandae. Cumque voluptatem repellat quae sunt. Optio dolor earum fugit dolorum."
},
"url": {
"en": "http://www.cummings.com/ut-dolor-libero-ipsam-doloribus-neque"
}
}
}When returned in a response.
{
"name": "Ms. Sharon Mohr",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": false,
"only_order_in_store": true,
"id": 10,
"banner": {
"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
}
],
"white_background": true
},
"seo": {
"title": {
"en": "Dolor beatae ut facilis sunt enim perspiciatis eligendi fugiat."
},
"description": {
"en": "Voluptatem dolor officia soluta ullam tempore dolor officia. Dignissimos neque sed voluptas et. Ducimus laborum nihil voluptas aspernatur. Distinctio molestiae et libero voluptatem."
},
"url": {
"en": "https://www.runolfsson.net/pariatur-eveniet-accusantium-maiores-ipsa-aut"
}
}
}