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. |
PATCH /company/categories/11 HTTP/1.1
Host: api.bakeronline.be
X-VERSION: 1.0.0
Accept-Language: en-US,en;q=0.5
Content-Type: application/json
Content-Length: 788
{
"name": "Alexander Howe DVM",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"only_order_in_store": true,
"shop_ids": [
13,
16,
12
],
"seo": {
"title": {
"en": "Nihil accusantium dolore ea eum quas qui hic voluptatem."
},
"description": {
"en": "Ipsam et aspernatur sunt voluptas perferendis amet quis. Porro vitae consequatur libero et dolorem ex ducimus. Aut sunt sunt aut dolor id aut. Hic enim laborum consectetur."
},
"url": {
"en": "http://www.kilback.com/architecto-voluptas-debitis-voluptas-culpa-placeat-expedita"
}
},
"product_ids": [
13,
18,
16
]
}| 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 |
| id | Int | ID of the category |
| banner | 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: 13145
{
"name": "Prof. Kobe Hoeger PhD",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": false,
"only_order_in_store": true,
"products": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": true,
"active": true,
"only_order_in_store": false,
"price_type": "PER_UNIT",
"price": 17,
"target_price": false,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 13,
"maximum": 15,
"maximum_day": 17,
"maximum_week": 10
},
"weight": {
"minimum": 12,
"maximum": 18,
"maximum_day": 10,
"maximum_week": 13,
"suggested": 16
},
"persons": {
"minimum": 16,
"maximum": 18
}
},
"id": 15,
"allergens": [
{
"id": 18,
"name": "Soy"
},
{
"id": 14,
"name": "Fish"
},
{
"id": 13,
"name": "Egg"
}
],
"category_id": 17,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Mollitia consequatur optio sit eligendi maiores molestiae repellat sed."
},
"description": {
"en": "Sunt id ipsum minus aut in sunt. Officia dolore ut veritatis neque. Provident est officiis soluta commodi odit corporis aut. Maiores qui repellat ea aut cupiditate sed doloribus."
},
"url": {
"en": "http://www.thompson.net/quas-et-voluptas-deleniti-veritatis.html"
}
},
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": true,
"active": true,
"only_order_in_store": false,
"price_type": "PER_UNIT",
"price": 12,
"target_price": true,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 17,
"maximum": 19,
"maximum_day": 17,
"maximum_week": 15
},
"weight": {
"minimum": 14,
"maximum": 18,
"maximum_day": 14,
"maximum_week": 17,
"suggested": 12
},
"persons": {
"minimum": 17,
"maximum": 15
}
},
"id": 16,
"allergens": [
{
"id": 12,
"name": "Egg"
},
{
"id": 14,
"name": "Milk"
},
{
"id": 19,
"name": "Soy"
}
],
"category_id": 17,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Labore nihil eum neque ipsam inventore nostrum porro."
},
"description": {
"en": "Dolor qui sint earum est voluptate harum magnam ipsa. Est eos praesentium voluptas hic eos."
},
"url": {
"en": "http://www.kassulke.com/exercitationem-saepe-ut-ut-magni-quo"
}
},
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": false,
"active": false,
"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": 18,
"maximum": 19,
"maximum_day": 13,
"maximum_week": 19
},
"weight": {
"minimum": 16,
"maximum": 13,
"maximum_day": 18,
"maximum_week": 17,
"suggested": 14
},
"persons": {
"minimum": 18,
"maximum": 15
}
},
"id": 16,
"allergens": [
{
"id": 15,
"name": "Mustard"
},
{
"id": 12,
"name": "Crustaceans"
},
{
"id": 10,
"name": "Sesame"
}
],
"category_id": 12,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Commodi consequuntur deserunt est totam ratione odio."
},
"description": {
"en": "Voluptatem delectus officiis quos. Qui veniam accusantium natus at est suscipit magni. Qui ut facere et tempora illo ab reiciendis."
},
"url": {
"en": "http://www.konopelski.com/sint-possimus-nesciunt-soluta-rerum-aut-totam.html"
}
},
"code": "..."
}
],
"shops": [
{
"name": "Lucile Beier",
"active": false,
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE",
"position": {
"latitude": 1.54361,
"longitude": 0.45645
}
},
"allow_comments": true,
"allow_orders": false,
"delivery_use_intervals": false,
"id": 16,
"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
}
],
"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
}
],
"white_background": false
}
},
{
"name": "Oswald Kihn",
"active": false,
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE",
"position": {
"latitude": 1.54361,
"longitude": 0.45645
}
},
"allow_comments": true,
"allow_orders": false,
"delivery_use_intervals": true,
"id": 15,
"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
}
],
"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
}
],
"white_background": true
}
},
{
"name": "Deron Blick",
"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,
"id": 11,
"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
}
],
"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
}
],
"white_background": true
}
}
],
"id": 13,
"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": "Et ex optio nulla suscipit et sapiente expedita."
},
"description": {
"en": "Esse iste consequatur pariatur voluptate. Ducimus atque vel itaque sint. Tempore esse omnis nobis dignissimos autem temporibus."
},
"url": {
"en": "http://kohler.net/eligendi-et-et-reiciendis-voluptatem"
}
}
}