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/19 HTTP/1.1
Host: api.bakeronline.be
X-VERSION: 1.10.0
Accept-Language: en-US,en;q=0.5
Content-Type: application/json
Content-Length: 738
{
"name": "Gideon Green",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"only_order_in_store": false,
"shop_ids": [
13,
17,
14
],
"seo": {
"title": {
"en": "Est quidem voluptates dicta itaque et qui."
},
"description": {
"en": "Quia ullam iusto quasi fugiat eum asperiores nulla optio. Animi et est et voluptas qui. Corporis adipisci sit voluptatibus sed atque. Et et earum quasi voluptas non hic et expedita."
},
"url": {
"en": "http://www.murazik.com/"
}
},
"product_ids": [
19,
10,
18
],
"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: 18016
{
"name": "Jayden Kemmer II",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"only_order_in_store": false,
"products": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": true,
"active": true,
"only_order_in_store": false,
"price_type": "PER_UNIT",
"price": 11,
"target_price": false,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 10,
"maximum": 19,
"maximum_day": 14,
"maximum_week": 10
},
"weight": {
"minimum": 14,
"maximum": 13,
"maximum_day": 14,
"maximum_week": 12,
"suggested": 11
},
"persons": {
"minimum": 17,
"maximum": 14
}
},
"id": 16,
"allergens": [
{
"id": 11,
"name": "Celery"
},
{
"id": 15,
"name": "Lupine"
},
{
"id": 12,
"name": "Sesame"
}
],
"category_id": 17,
"price_look_up_code": "...",
"code": "...",
"seo": {
"title": {
"en": "Non quod voluptas saepe eos commodi ex a."
},
"description": {
"en": "Placeat nobis quis sunt molestiae esse. Optio fugiat pariatur ut praesentium quis repellat iste. Labore odit cum beatae consectetur. Quia sint consequatur nam incidunt earum."
},
"url": {
"en": "http://kling.net/"
}
},
"origin": {
"nl": "...",
"en": "...",
"fr": "..."
},
"ingredients": {
"nl": "...",
"en": "...",
"fr": "..."
},
"temperature_type": "any",
"warranty_type": "none",
"warranty_price": 18,
"stock": {
"soldout": false,
"amount": 12,
"soldoutUntil": "2019-01-31 12:00"
},
"daysavailable": [
14,
17,
19
],
"upfront": {
"upfront_use_default": true,
"upfront_type": "days",
"upfront_days": 11,
"upfront_time": "12:00",
"upfront_hours": 13,
"upfront_minutes": 12
},
"use_pickup_after": false,
"pickup_after": "12:00",
"use_pickup_before": true,
"pickup_before": "12:00",
"related_products": [
19,
12,
13
]
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": true,
"active": false,
"only_order_in_store": false,
"price_type": "PER_UNIT",
"price": 11,
"target_price": true,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 12,
"maximum": 15,
"maximum_day": 16,
"maximum_week": 15
},
"weight": {
"minimum": 17,
"maximum": 11,
"maximum_day": 16,
"maximum_week": 13,
"suggested": 19
},
"persons": {
"minimum": 13,
"maximum": 17
}
},
"id": 16,
"allergens": [
{
"id": 14,
"name": "Milk"
},
{
"id": 12,
"name": "Mollusc"
},
{
"id": 12,
"name": "Nuts"
}
],
"category_id": 12,
"price_look_up_code": "...",
"code": "...",
"seo": {
"title": {
"en": "Eligendi dolorem id sed mollitia sed eius."
},
"description": {
"en": "Eum velit corporis dolores iste. Laborum qui aut non id recusandae alias et. Quibusdam quis et voluptatem sed harum fugit maxime."
},
"url": {
"en": "https://mohr.com/iusto-nulla-quia-et-vel-nihil-corrupti.html"
}
},
"origin": {
"nl": "...",
"en": "...",
"fr": "..."
},
"ingredients": {
"nl": "...",
"en": "...",
"fr": "..."
},
"temperature_type": "any",
"warranty_type": "none",
"warranty_price": 13,
"stock": {
"soldout": false,
"amount": 15,
"soldoutUntil": "2019-01-31 12:00"
},
"daysavailable": [
19,
14,
10
],
"upfront": {
"upfront_use_default": true,
"upfront_type": "days",
"upfront_days": 11,
"upfront_time": "12:00",
"upfront_hours": 17,
"upfront_minutes": 18
},
"use_pickup_after": true,
"pickup_after": "12:00",
"use_pickup_before": true,
"pickup_before": "12:00",
"related_products": [
14,
11,
12
]
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": true,
"active": true,
"only_order_in_store": true,
"price_type": "PER_UNIT",
"price": 14,
"target_price": false,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 19,
"maximum": 19,
"maximum_day": 12,
"maximum_week": 11
},
"weight": {
"minimum": 12,
"maximum": 10,
"maximum_day": 13,
"maximum_week": 10,
"suggested": 16
},
"persons": {
"minimum": 16,
"maximum": 16
}
},
"id": 18,
"allergens": [
{
"id": 14,
"name": "Lactose"
},
{
"id": 18,
"name": "Gluten"
},
{
"id": 17,
"name": "Egg"
}
],
"category_id": 18,
"price_look_up_code": "...",
"code": "...",
"seo": {
"title": {
"en": "Et et est nesciunt sit dicta occaecati dolor qui."
},
"description": {
"en": "Veniam nihil quia temporibus sunt amet cumque. Quisquam nam distinctio eum quidem tempore qui. Ut nesciunt nemo et et ipsa ad placeat. Unde sapiente qui ad eos fuga."
},
"url": {
"en": "http://schinner.net/"
}
},
"origin": {
"nl": "...",
"en": "...",
"fr": "..."
},
"ingredients": {
"nl": "...",
"en": "...",
"fr": "..."
},
"temperature_type": "any",
"warranty_type": "none",
"warranty_price": 15,
"stock": {
"soldout": true,
"amount": 14,
"soldoutUntil": "2019-01-31 12:00"
},
"daysavailable": [
17,
18,
13
],
"upfront": {
"upfront_use_default": true,
"upfront_type": "days",
"upfront_days": 14,
"upfront_time": "12:00",
"upfront_hours": 11,
"upfront_minutes": 13
},
"use_pickup_after": false,
"pickup_after": "12:00",
"use_pickup_before": true,
"pickup_before": "12:00",
"related_products": [
13,
11,
16
]
}
],
"shops": [
{
"name": "Dr. Jazmin Haag Jr.",
"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": false,
"delivery_use_intervals": true,
"allow_invoices": false,
"allow_order_comments": false,
"allow_product_comments": false,
"takeout_use_intervals": false,
"allow_order_messages": false,
"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": 14,
"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": 11,
"white_background": false
},
"url": "..."
},
{
"name": "Fredrick Wisoky",
"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": true,
"delivery_use_intervals": true,
"allow_invoices": true,
"allow_order_comments": false,
"allow_product_comments": true,
"takeout_use_intervals": false,
"allow_order_messages": true,
"id": 14,
"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": 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": true
},
"url": "..."
},
{
"name": "Cleo Orn",
"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": true,
"allow_order_comments": false,
"allow_product_comments": false,
"takeout_use_intervals": true,
"allow_order_messages": false,
"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": 14,
"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": false
},
"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": 13,
"white_background": true
},
"seo": {
"title": {
"en": "Sapiente repellat explicabo temporibus est quia asperiores libero."
},
"description": {
"en": "Veniam earum soluta quis autem similique sunt. Tenetur sit dolorem natus perferendis eos iure. Ut error enim numquam."
},
"url": {
"en": "https://www.haag.com/nihil-esse-delectus-quis"
}
}
}