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": "Kane Thompson",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": false,
"only_order_in_store": true,
"seo": {
"title": {
"en": "Ex amet voluptatem placeat in repudiandae harum et."
},
"description": {
"en": "Molestiae rem dolores eveniet explicabo vitae molestiae dolor. Sed enim impedit blanditiis. Eum porro praesentium doloremque. Vero excepturi soluta expedita dolor voluptatem cum hic."
},
"url": {
"en": "http://ernser.org/soluta-libero-animi-est-ducimus-minima-soluta-et"
}
}
}When returned in a response.
{
"name": "Prof. Kolby Ritchie I",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"only_order_in_store": true,
"id": 14,
"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": "Ducimus blanditiis aut in dolorem commodi quaerat et nostrum."
},
"description": {
"en": "Optio id autem consequatur quas. Et sed eum adipisci aut fugit. Qui aliquid animi molestiae. Architecto dolores voluptatem ea aut."
},
"url": {
"en": "http://bogan.com/dolor-culpa-voluptatibus-asperiores-corrupti"
}
}
}