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. |
| overview_image | Image? | Nullable. |
| seo | company.SeoData | Optional. The category's webpage search engine metatags |
When used inside a request.
{
"name": "Elton Schowalter IV",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": false,
"only_order_in_store": false,
"seo": {
"title": {
"en": "Fugiat velit vel quas nihil quia."
},
"description": {
"en": "Expedita maxime eius perferendis voluptatem quam et quia. Ipsum quia quo ut excepturi adipisci non. Et tempore deleniti quisquam inventore consequatur. Ea quo quo laboriosam et asperiores quibusdam."
},
"url": {
"en": "http://goyette.net/rem-ratione-dolor-cum-adipisci"
}
},
"code": "..."
}When returned in a response.
{
"name": "Katheryn O'Hara",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"only_order_in_store": false,
"code": "...",
"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
}
],
"file_id": 16,
"white_background": true
},
"overview_image": {
"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
}
],
"file_id": 11,
"white_background": false
},
"seo": {
"title": {
"en": "Harum ut recusandae sed sint quod dolores debitis et quidem ut amet."
},
"description": {
"en": "Et voluptatum ullam voluptas id. Illum inventore ipsa laborum. Est odit tempora nemo earum et magnam. Perspiciatis totam voluptas libero."
},
"url": {
"en": "https://www.schamberger.info/provident-sunt-ut-quod-totam-incidunt"
}
}
}