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": "Edward Barton",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": false,
"only_order_in_store": true,
"seo": {
"title": {
"en": "Voluptatem dolorem voluptate et eius."
},
"description": {
"en": "Asperiores eos omnis autem quia suscipit at officiis sequi. Est ut rerum voluptatum fugit itaque voluptatem."
},
"url": {
"en": "http://www.koelpin.biz/"
}
}
}When returned in a response.
{
"name": "Evans Heaney",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"only_order_in_store": false,
"id": 13,
"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": false
},
"seo": {
"title": {
"en": "Illo facere exercitationem est libero quasi neque."
},
"description": {
"en": "Pariatur assumenda minus eveniet in corporis sit aut. Vel eum autem consequatur placeat animi et quo. Laudantium saepe explicabo libero aut suscipit."
},
"url": {
"en": "http://ritchie.biz/neque-a-ducimus-maiores-praesentium.html"
}
}
}