PATCH /company/categories/@id
This endpoint requires authentication.
| Header | Value |
|---|---|
| Authorization | Set the value to Bearer + + access_token |
Replace the @ keywords in the URL with their corresponding value.
A dictionary with fields
| Field | Type | Description |
|---|---|---|
| id | Int | The ID of the category you want to update |
Pass the following properties via application/json or form encoding in the body of the 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 |
| shop_ids | [Int] | Minimum 1. IDs of the shops the category will be available for |
| seo | company.SeoData | Optional. The category's webpage search engine metatags |
| product_ids | [Int] | Optional. Set the order of the products in a category by setting the IDs of the products in the right order. You can't add or remove products, only change the order. Don't set this field if you don't want to make changes. |
| 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 |
PATCH /company/categories/11 HTTP/1.1
Host: api.bakeronline.be
X-VERSION: 1.9.0
Accept-Language: en-US,en;q=0.5
Content-Type: application/json
Content-Length: 813
{
"name": "Mauricio Heller MD",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"only_order_in_store": false,
"shop_ids": [
14,
13,
16
],
"seo": {
"title": {
"en": "Modi qui tempore molestiae perferendis facere illum architecto."
},
"description": {
"en": "Excepturi consequatur pariatur ea sit laboriosam. Dicta et temporibus doloremque nihil similique. Laborum mollitia et maxime nobis alias. Cum quaerat sed est repellat."
},
"url": {
"en": "https://miller.com/quis-maxime-maiores-nesciunt-perferendis-quae-doloribus-porro.html"
}
},
"product_ids": [
11,
18,
11
],
"code": "..."
}| 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 |
| products | [company.Product.simple] | Array of company.Product.simple |
| shops | [company.Shop.simple] | Array of company.Shop.simple |
| 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 |
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 18217
{
"name": "Ewell Connelly",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"only_order_in_store": false,
"products": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": false,
"active": true,
"only_order_in_store": true,
"price_type": "PER_UNIT",
"price": 12,
"target_price": false,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 15,
"maximum": 14,
"maximum_day": 13,
"maximum_week": 12
},
"weight": {
"minimum": 14,
"maximum": 14,
"maximum_day": 19,
"maximum_week": 18,
"suggested": 11
},
"persons": {
"minimum": 14,
"maximum": 17
}
},
"id": 11,
"allergens": [
{
"id": 13,
"name": "Nuts"
},
{
"id": 13,
"name": "Milk"
},
{
"id": 17,
"name": "Mollusc"
}
],
"category_id": 11,
"price_look_up_code": "...",
"code": "...",
"seo": {
"title": {
"en": "Quia saepe reprehenderit sapiente qui veritatis et et dolor blanditiis."
},
"description": {
"en": "Est commodi qui molestiae dolore labore voluptatum et dolorem. Voluptas quia voluptas et laborum reiciendis aut quo. Sed sit sed iste adipisci soluta sit laudantium. Reprehenderit dolorem minus aut."
},
"url": {
"en": "https://www.ratke.net/cum-aliquam-natus-illum-fugit-non"
}
},
"origin": {
"nl": "...",
"en": "...",
"fr": "..."
},
"ingredients": {
"nl": "...",
"en": "...",
"fr": "..."
},
"temperature_type": "any",
"warranty_type": "none",
"warranty_price": 13,
"stock": {
"soldout": true,
"amount": 18,
"soldoutUntil": "2019-01-31 12:00"
},
"daysavailable": [
16,
16,
18
],
"upfront": {
"upfront_use_default": false,
"upfront_type": "days",
"upfront_days": 12,
"upfront_time": "12:00",
"upfront_hours": 12,
"upfront_minutes": 15
},
"use_pickup_after": true,
"pickup_after": "12:00",
"use_pickup_before": false,
"pickup_before": "12:00",
"related_products": [
15,
16,
13
]
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": true,
"active": true,
"only_order_in_store": true,
"price_type": "PER_UNIT",
"price": 13,
"target_price": false,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 15,
"maximum": 14,
"maximum_day": 10,
"maximum_week": 14
},
"weight": {
"minimum": 13,
"maximum": 11,
"maximum_day": 17,
"maximum_week": 15,
"suggested": 17
},
"persons": {
"minimum": 13,
"maximum": 17
}
},
"id": 14,
"allergens": [
{
"id": 17,
"name": "Mustard"
},
{
"id": 15,
"name": "Peanut"
},
{
"id": 19,
"name": "Peanut"
}
],
"category_id": 18,
"price_look_up_code": "...",
"code": "...",
"seo": {
"title": {
"en": "Vitae ex modi aut sint commodi rem autem sed sit eum."
},
"description": {
"en": "At ut velit aut blanditiis eum. Sed amet consequuntur explicabo. Est voluptatem sed ut qui maiores fugiat. Omnis et dicta veniam voluptatem itaque debitis error ut."
},
"url": {
"en": "http://bergstrom.info/nesciunt-dolores-molestiae-vero-nam"
}
},
"origin": {
"nl": "...",
"en": "...",
"fr": "..."
},
"ingredients": {
"nl": "...",
"en": "...",
"fr": "..."
},
"temperature_type": "any",
"warranty_type": "none",
"warranty_price": 16,
"stock": {
"soldout": true,
"amount": 16,
"soldoutUntil": "2019-01-31 12:00"
},
"daysavailable": [
19,
18,
15
],
"upfront": {
"upfront_use_default": true,
"upfront_type": "days",
"upfront_days": 10,
"upfront_time": "12:00",
"upfront_hours": 13,
"upfront_minutes": 10
},
"use_pickup_after": false,
"pickup_after": "12:00",
"use_pickup_before": true,
"pickup_before": "12:00",
"related_products": [
14,
15,
15
]
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": false,
"active": false,
"only_order_in_store": true,
"price_type": "PER_UNIT",
"price": 13,
"target_price": true,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 11,
"maximum": 14,
"maximum_day": 10,
"maximum_week": 12
},
"weight": {
"minimum": 19,
"maximum": 16,
"maximum_day": 19,
"maximum_week": 13,
"suggested": 10
},
"persons": {
"minimum": 15,
"maximum": 15
}
},
"id": 11,
"allergens": [
{
"id": 15,
"name": "Celery"
},
{
"id": 18,
"name": "Egg"
},
{
"id": 16,
"name": "Lupine"
}
],
"category_id": 11,
"price_look_up_code": "...",
"code": "...",
"seo": {
"title": {
"en": "Et sed quas ut nisi eveniet incidunt."
},
"description": {
"en": "Optio quasi dignissimos hic eos nulla facere laboriosam. Nam quibusdam deleniti nesciunt eum voluptas ipsam. Quia aut rem sunt doloremque autem nihil et autem."
},
"url": {
"en": "https://www.kling.info/labore-eos-suscipit-ea-quidem-occaecati-iste-pariatur"
}
},
"origin": {
"nl": "...",
"en": "...",
"fr": "..."
},
"ingredients": {
"nl": "...",
"en": "...",
"fr": "..."
},
"temperature_type": "any",
"warranty_type": "none",
"warranty_price": 19,
"stock": {
"soldout": false,
"amount": 10,
"soldoutUntil": "2019-01-31 12:00"
},
"daysavailable": [
12,
14,
13
],
"upfront": {
"upfront_use_default": false,
"upfront_type": "days",
"upfront_days": 19,
"upfront_time": "12:00",
"upfront_hours": 19,
"upfront_minutes": 18
},
"use_pickup_after": false,
"pickup_after": "12:00",
"use_pickup_before": false,
"pickup_before": "12:00",
"related_products": [
11,
17,
15
]
}
],
"shops": [
{
"name": "Dario Nikolaus",
"active": true,
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE",
"position": {
"latitude": 1.54361,
"longitude": 0.45645
}
},
"allow_comments": true,
"allow_orders": true,
"delivery_use_intervals": false,
"allow_invoices": true,
"allow_order_comments": true,
"allow_product_comments": false,
"takeout_use_intervals": false,
"allow_order_messages": false,
"id": 19,
"avatar": {
"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": 12,
"white_background": true
},
"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": 14,
"white_background": true
},
"url": "..."
},
{
"name": "Syble Willms MD",
"active": false,
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE",
"position": {
"latitude": 1.54361,
"longitude": 0.45645
}
},
"allow_comments": false,
"allow_orders": false,
"delivery_use_intervals": true,
"allow_invoices": false,
"allow_order_comments": true,
"allow_product_comments": false,
"takeout_use_intervals": false,
"allow_order_messages": false,
"id": 13,
"avatar": {
"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": 15,
"white_background": false
},
"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": 10,
"white_background": false
},
"url": "..."
},
{
"name": "Daphney Waters",
"active": true,
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE",
"position": {
"latitude": 1.54361,
"longitude": 0.45645
}
},
"allow_comments": false,
"allow_orders": true,
"delivery_use_intervals": false,
"allow_invoices": false,
"allow_order_comments": false,
"allow_product_comments": true,
"takeout_use_intervals": true,
"allow_order_messages": true,
"id": 12,
"avatar": {
"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": 17,
"white_background": true
},
"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": 14,
"white_background": false
},
"url": "..."
}
],
"code": "...",
"id": 16,
"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": 11,
"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": 15,
"white_background": false
},
"seo": {
"title": {
"en": "Aliquid atque quis repudiandae corrupti repudiandae fugit commodi ipsa."
},
"description": {
"en": "Consectetur fugiat sapiente consequuntur fugiat. Consequatur odio ut vero est voluptas eos. Autem eaque vel culpa exercitationem non. Consequatur molestias aut nisi."
},
"url": {
"en": "http://emmerich.com/"
}
}
}