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 |
code | String? | Optional. Nullable. A custom code. You can set this to your own code and use this field to map your categories to Bakeronline categories |
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 |
code | String? | Nullable. A custom code. You can set this to your own code and use this field to map your categories to Bakeronline categories |
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": "Prof. Gabriella Langworth MD",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"only_order_in_store": false,
"seo": {
"title": {
"en": "Cum dolores unde veritatis et dolorem ea quidem distinctio corrupti."
},
"description": {
"en": "Nihil aut optio eligendi maiores autem nulla. Sit hic dicta fuga voluptatem incidunt voluptatum. Reiciendis repellendus fugiat magni nemo excepturi eum possimus."
},
"url": {
"en": "http://wilkinson.com/"
}
},
"code": "..."
}
When returned in a response.
{
"name": "Dr. Webster Thiel",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"only_order_in_store": true,
"code": "...",
"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": false
},
"seo": {
"title": {
"en": "Dolorum maiores optio ea placeat cupiditate earum ut."
},
"description": {
"en": "Aut natus officiis veniam et nostrum. Sapiente quidem et nulla qui quasi laudantium consequatur dolor."
},
"url": {
"en": "http://bechtelar.com/consectetur-ex-aut-quia-porro-repellendus"
}
}
}