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": "Osvaldo Boehm",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"only_order_in_store": true,
"seo": {
"title": {
"en": "Fugiat veritatis sunt inventore in illum et velit repellat."
},
"description": {
"en": "Omnis voluptas ipsam nobis sed voluptatem suscipit itaque. Qui cumque impedit corrupti aspernatur. Dignissimos nostrum est incidunt et labore nulla est qui."
},
"url": {
"en": "http://brown.com/placeat-aut-animi-aut-voluptatem-et-ut-voluptatem.html"
}
}
}When returned in a response.
{
"name": "Dr. Ariane Schimmel",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": false,
"only_order_in_store": false,
"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": "Qui molestias velit sequi itaque id culpa aut rem sunt adipisci omnis."
},
"description": {
"en": "Tempore voluptate eum non rerum. Dignissimos odit quod asperiores eligendi odit. Itaque et ratione veritatis pariatur nisi. Quos voluptas temporibus sint aut quia."
},
"url": {
"en": "http://morar.com/quibusdam-consectetur-vel-natus-et"
}
}
}