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 |
| seo | company.SeoData | Optional. The category's webpage search engine metatags |
PATCH /company/categories/18 HTTP/1.1
Host: api.bakeronline.be
X-VERSION: 0.2.0
Accept-Language: en-US,en;q=0.5
Content-Type: application/json
Content-Length: 595
{
"name": "Elna Reichel",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"only_order_in_store": false,
"seo": {
"title": {
"en": "Delectus corporis nobis autem maiores consequatur."
},
"description": {
"en": "Et molestias a unde asperiores. Vero aperiam ad aspernatur dicta. Occaecati assumenda ipsa quae adipisci. Perspiciatis accusantium nihil dolores voluptas aliquam magni velit."
},
"url": {
"en": "http://www.wyman.com/"
}
}
}| 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: 13075
{
"name": "Miss Lenora Gibson I",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": false,
"only_order_in_store": true,
"products": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": false,
"active": true,
"only_order_in_store": false,
"price_type": "PER_UNIT",
"price": 15,
"target_price": true,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 16,
"maximum": 11,
"maximum_day": 16,
"maximum_week": 11
},
"weight": {
"minimum": 11,
"maximum": 17,
"maximum_day": 16,
"maximum_week": 19,
"suggested": 18
},
"persons": {
"minimum": 11,
"maximum": 18
}
},
"id": 13,
"allergens": [
{
"id": 18,
"name": "Nuts"
},
{
"id": 11,
"name": "Egg"
},
{
"id": 12,
"name": "Lupine"
}
],
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Consequatur voluptas hic et harum sit nam ipsum dolore."
},
"description": {
"en": "Dicta dolorum optio a magni voluptatem quia. Corporis ex ipsam ipsum voluptatum omnis reiciendis voluptas velit. Aliquid at consectetur omnis neque doloremque architecto. Eligendi facere quae qui a."
},
"url": {
"en": "http://www.weissnat.org/et-consequatur-aut-qui-et-quas.html"
}
}
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": true,
"active": true,
"only_order_in_store": false,
"price_type": "PER_UNIT",
"price": 16,
"target_price": false,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 19,
"maximum": 16,
"maximum_day": 10,
"maximum_week": 14
},
"weight": {
"minimum": 12,
"maximum": 11,
"maximum_day": 11,
"maximum_week": 15,
"suggested": 16
},
"persons": {
"minimum": 11,
"maximum": 15
}
},
"id": 13,
"allergens": [
{
"id": 10,
"name": "Milk"
},
{
"id": 18,
"name": "Peanut"
},
{
"id": 18,
"name": "Fish"
}
],
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Ipsa sunt voluptate debitis ipsa nemo."
},
"description": {
"en": "Eum aliquam consequatur similique pariatur. Perspiciatis sit iure perferendis officiis non occaecati sit nulla. Ullam non voluptatem similique laborum. Officiis itaque qui ipsum iure voluptas magni."
},
"url": {
"en": "http://cremin.com/rerum-eum-eaque-laudantium-fugit-officiis-natus-ad-in"
}
}
},
{
"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": 10,
"maximum": 12,
"maximum_day": 17,
"maximum_week": 12
},
"weight": {
"minimum": 17,
"maximum": 10,
"maximum_day": 12,
"maximum_week": 16,
"suggested": 18
},
"persons": {
"minimum": 15,
"maximum": 19
}
},
"id": 18,
"allergens": [
{
"id": 16,
"name": "Nuts"
},
{
"id": 18,
"name": "Egg"
},
{
"id": 15,
"name": "Mollusc"
}
],
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Distinctio reiciendis nemo tenetur eos eos."
},
"description": {
"en": "Quam ut omnis et repellendus maiores quisquam. Enim commodi quam illum. Sed similique harum dolore earum ab. Quo veniam voluptatem molestiae ab a quod et."
},
"url": {
"en": "http://kutch.com/"
}
}
}
],
"shops": [
{
"name": "Prof. Felipe Smith",
"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": 18,
"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": "Andreanne Jenkins",
"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,
"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
}
],
"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": true
}
},
{
"name": "Marcos Block",
"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": 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
}
],
"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": 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
}
],
"white_background": false
},
"seo": {
"title": {
"en": "Recusandae quibusdam ut odit et qui ducimus placeat est consequatur quia."
},
"description": {
"en": "Iusto et molestiae accusamus dolor est facere ex. Error deleniti nesciunt delectus iste. Sequi eum id sint minima quia autem qui."
},
"url": {
"en": "http://satterfield.info/accusantium-eum-et-et-dolore-in-laboriosam"
}
}
}