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/12 HTTP/1.1
Host: api.bakeronline.be
X-VERSION: 1.2.0
Accept-Language: en-US,en;q=0.5
Content-Type: application/json
Content-Length: 779
{
"name": "Sandrine Sipes",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": false,
"only_order_in_store": false,
"shop_ids": [
14,
16,
16
],
"seo": {
"title": {
"en": "Possimus facere et minima voluptatem qui quasi quos aliquam."
},
"description": {
"en": "Quia ut voluptatem quo ut. Provident porro aut incidunt repellat doloremque quas. Consectetur debitis cumque recusandae enim esse placeat. Quo voluptatibus tenetur eaque."
},
"url": {
"en": "http://predovic.com/numquam-aperiam-non-dolores-qui-suscipit-at-quas.html"
}
},
"product_ids": [
15,
13,
14
]
}| 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: 13265
{
"name": "Hailee Boehm",
"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": 13,
"maximum": 13,
"maximum_day": 15,
"maximum_week": 10
},
"weight": {
"minimum": 14,
"maximum": 19,
"maximum_day": 12,
"maximum_week": 12,
"suggested": 19
},
"persons": {
"minimum": 14,
"maximum": 14
}
},
"id": 15,
"allergens": [
{
"id": 19,
"name": "Peanut"
},
{
"id": 18,
"name": "Mustard"
},
{
"id": 18,
"name": "Fish"
}
],
"category_id": 13,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Laboriosam quis debitis id sit ut sunt labore reprehenderit laborum voluptas voluptatem."
},
"description": {
"en": "Praesentium a ut rerum quod. In sit ipsum reprehenderit assumenda aut cupiditate. Sapiente earum sint quisquam. Ut maxime sed suscipit. Sit excepturi rem culpa accusamus."
},
"url": {
"en": "https://www.schoen.info/qui-corporis-dolores-mollitia-veritatis"
}
},
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": false,
"active": false,
"only_order_in_store": false,
"price_type": "PER_UNIT",
"price": 10,
"target_price": false,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 19,
"maximum": 12,
"maximum_day": 12,
"maximum_week": 10
},
"weight": {
"minimum": 11,
"maximum": 17,
"maximum_day": 16,
"maximum_week": 12,
"suggested": 16
},
"persons": {
"minimum": 14,
"maximum": 17
}
},
"id": 14,
"allergens": [
{
"id": 17,
"name": "Fish"
},
{
"id": 13,
"name": "Mollusc"
},
{
"id": 19,
"name": "Fish"
}
],
"category_id": 19,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Aut suscipit dignissimos fugiat laborum voluptatem."
},
"description": {
"en": "Voluptatibus non ea reprehenderit delectus culpa eaque soluta et. Sit iusto atque qui odit enim quaerat. Odio vel et ut tempora cupiditate."
},
"url": {
"en": "http://cronin.net/et-exercitationem-incidunt-voluptate-necessitatibus-non-itaque-officiis"
}
},
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": true,
"active": false,
"only_order_in_store": false,
"price_type": "PER_UNIT",
"price": 18,
"target_price": true,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 10,
"maximum": 10,
"maximum_day": 18,
"maximum_week": 10
},
"weight": {
"minimum": 10,
"maximum": 14,
"maximum_day": 12,
"maximum_week": 16,
"suggested": 15
},
"persons": {
"minimum": 17,
"maximum": 16
}
},
"id": 17,
"allergens": [
{
"id": 19,
"name": "Milk"
},
{
"id": 13,
"name": "Lactose"
},
{
"id": 14,
"name": "Mollusc"
}
],
"category_id": 13,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Voluptatem pariatur impedit doloribus necessitatibus quia."
},
"description": {
"en": "Illum maiores earum hic modi atque nostrum. Nisi vero optio tempore voluptatem corporis unde iste. Aut nostrum reprehenderit facere eos fugiat ad cupiditate."
},
"url": {
"en": "http://www.ondricka.com/"
}
},
"code": "..."
}
],
"shops": [
{
"name": "Miss Elinore O'Connell DDS",
"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": 17,
"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": "Mr. Columbus Wiegand I",
"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": 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
}
],
"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": "Prof. Taylor Mosciski III",
"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": 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": false
}
}
],
"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": true
},
"seo": {
"title": {
"en": "Quae voluptatem perspiciatis laborum explicabo numquam aperiam at voluptas velit expedita."
},
"description": {
"en": "Dolor impedit hic et quo. Libero et voluptatem necessitatibus dolores dolorem. Ea possimus et omnis amet."
},
"url": {
"en": "http://schumm.biz/doloremque-itaque-nulla-repudiandae-sit"
}
}
}