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/13 HTTP/1.1
Host: api.bakeronline.be
X-VERSION: 1.5.2
Accept-Language: en-US,en;q=0.5
Content-Type: application/json
Content-Length: 731
{
"name": "Dr. Gordon Bayer",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": false,
"only_order_in_store": false,
"shop_ids": [
13,
10,
11
],
"seo": {
"title": {
"en": "Quam dolor minima quia quaerat cupiditate enim aliquam."
},
"description": {
"en": "Vel corporis voluptatem delectus accusantium eligendi exercitationem. Accusamus expedita architecto debitis saepe esse. Repudiandae velit maiores cupiditate impedit beatae neque."
},
"url": {
"en": "http://prohaska.com/"
}
},
"product_ids": [
12,
12,
19
]
}| 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: 13757
{
"name": "Neoma Lynch",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"only_order_in_store": true,
"products": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": true,
"active": false,
"only_order_in_store": true,
"price_type": "PER_UNIT",
"price": 17,
"target_price": true,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 19,
"maximum": 11,
"maximum_day": 16,
"maximum_week": 13
},
"weight": {
"minimum": 17,
"maximum": 12,
"maximum_day": 10,
"maximum_week": 18,
"suggested": 12
},
"persons": {
"minimum": 12,
"maximum": 16
}
},
"id": 14,
"allergens": [
{
"id": 10,
"name": "Nuts"
},
{
"id": 12,
"name": "Milk"
},
{
"id": 15,
"name": "Peanut"
}
],
"category_id": 11,
"price_look_up_code": "...",
"code": "...",
"seo": {
"title": {
"en": "Ut ut dicta omnis unde vel porro non sit rerum."
},
"description": {
"en": "Sapiente et ut vitae facilis. Ipsum ipsum consequatur consequatur id rem quisquam. Delectus necessitatibus assumenda nam atque molestias dolores. Et aut rerum animi quae."
},
"url": {
"en": "http://roberts.com/"
}
}
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": false,
"active": true,
"only_order_in_store": false,
"price_type": "PER_UNIT",
"price": 17,
"target_price": true,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 12,
"maximum": 13,
"maximum_day": 13,
"maximum_week": 17
},
"weight": {
"minimum": 17,
"maximum": 19,
"maximum_day": 18,
"maximum_week": 11,
"suggested": 17
},
"persons": {
"minimum": 10,
"maximum": 15
}
},
"id": 18,
"allergens": [
{
"id": 13,
"name": "Celery"
},
{
"id": 18,
"name": "Fish"
},
{
"id": 18,
"name": "Crustaceans"
}
],
"category_id": 10,
"price_look_up_code": "...",
"code": "...",
"seo": {
"title": {
"en": "Distinctio exercitationem accusamus laboriosam minus rerum molestias soluta ut ut tenetur."
},
"description": {
"en": "Odio quis alias placeat doloremque id. Est ea aliquam a nam quidem magnam. Eum ut sint nostrum officia explicabo quo velit mollitia."
},
"url": {
"en": "http://mcglynn.com/"
}
}
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": true,
"active": false,
"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": 18,
"maximum": 13,
"maximum_day": 15,
"maximum_week": 14
},
"weight": {
"minimum": 17,
"maximum": 14,
"maximum_day": 12,
"maximum_week": 18,
"suggested": 12
},
"persons": {
"minimum": 10,
"maximum": 12
}
},
"id": 16,
"allergens": [
{
"id": 19,
"name": "Mustard"
},
{
"id": 15,
"name": "Mustard"
},
{
"id": 13,
"name": "Mustard"
}
],
"category_id": 15,
"price_look_up_code": "...",
"code": "...",
"seo": {
"title": {
"en": "Dolorem et molestiae eos ut."
},
"description": {
"en": "Sit occaecati veniam sit quod pariatur. Sunt in est non architecto tenetur odio. Similique sit quis dolorem minus aliquid vitae perferendis soluta. Debitis ea accusantium rerum quod provident."
},
"url": {
"en": "https://mclaughlin.com/illo-numquam-asperiores-voluptatem-asperiores-nemo-voluptatum-soluta-perferendis.html"
}
}
}
],
"shops": [
{
"name": "Abelardo Gorczany DDS",
"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,
"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": "Miss Tara Walsh DDS",
"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": true,
"allow_product_comments": true,
"takeout_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
}
},
{
"name": "Mrs. Hallie Stroman III",
"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,
"allow_invoices": false,
"allow_order_comments": true,
"allow_product_comments": false,
"takeout_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": 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
}
}
],
"id": 18,
"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": "Voluptatibus dolore quis consequuntur voluptatem sint aut natus rerum voluptatem."
},
"description": {
"en": "Commodi cumque in ab in a. Dolore ut quod sint id. Eaque voluptatem blanditiis dolor ut sunt repellat. Odio earum cupiditate asperiores rerum cum voluptatem et."
},
"url": {
"en": "http://davis.com/qui-nemo-eos-ut-asperiores"
}
}
}