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.8.0
Accept-Language: en-US,en;q=0.5
Content-Type: application/json
Content-Length: 807
{
"name": "Estrella Homenick",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": false,
"only_order_in_store": false,
"shop_ids": [
17,
14,
18
],
"seo": {
"title": {
"en": "Deleniti quae et et autem aut expedita et perspiciatis."
},
"description": {
"en": "Id aliquam distinctio hic sequi laudantium. Neque vel earum qui eum. Rerum aut adipisci sint repellat dicta perferendis. Consequuntur explicabo error velit laudantium esse nisi."
},
"url": {
"en": "http://www.ebert.biz/fugit-aut-ut-ad-distinctio-deserunt-repellat-corporis-et"
}
},
"product_ids": [
15,
15,
10
],
"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. |
| 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: 14194
{
"name": "Miss Ocie Donnelly II",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"only_order_in_store": false,
"products": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": false,
"active": false,
"only_order_in_store": true,
"price_type": "PER_UNIT",
"price": 14,
"target_price": true,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 15,
"maximum": 15,
"maximum_day": 14,
"maximum_week": 11
},
"weight": {
"minimum": 16,
"maximum": 14,
"maximum_day": 14,
"maximum_week": 16,
"suggested": 16
},
"persons": {
"minimum": 14,
"maximum": 16
}
},
"id": 16,
"allergens": [
{
"id": 17,
"name": "Egg"
},
{
"id": 19,
"name": "Gluten"
},
{
"id": 16,
"name": "Gluten"
}
],
"category_id": 17,
"price_look_up_code": "...",
"code": "...",
"seo": {
"title": {
"en": "Repudiandae tempore qui ut facere quis quos consectetur labore sit."
},
"description": {
"en": "Libero accusamus nemo voluptatem sint quia. Ea nihil incidunt beatae atque. Amet saepe et deleniti."
},
"url": {
"en": "http://www.bailey.info/nostrum-aperiam-enim-totam-soluta-et"
}
},
"origin": {
"nl": "...",
"en": "...",
"fr": "..."
}
},
{
"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": false,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 17,
"maximum": 14,
"maximum_day": 15,
"maximum_week": 18
},
"weight": {
"minimum": 14,
"maximum": 16,
"maximum_day": 11,
"maximum_week": 12,
"suggested": 19
},
"persons": {
"minimum": 10,
"maximum": 11
}
},
"id": 18,
"allergens": [
{
"id": 14,
"name": "Peanut"
},
{
"id": 15,
"name": "Sesame"
},
{
"id": 12,
"name": "Egg"
}
],
"category_id": 11,
"price_look_up_code": "...",
"code": "...",
"seo": {
"title": {
"en": "Praesentium sint possimus in molestiae et quia excepturi et earum pariatur."
},
"description": {
"en": "Nobis aliquam in cumque. Minus quod eos velit et est quia. Voluptatum voluptatum dolores doloremque ea officia iure."
},
"url": {
"en": "http://www.gulgowski.com/ad-id-aut-non-hic-laudantium-assumenda-recusandae"
}
},
"origin": {
"nl": "...",
"en": "...",
"fr": "..."
}
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": false,
"active": false,
"only_order_in_store": false,
"price_type": "PER_UNIT",
"price": 14,
"target_price": false,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 16,
"maximum": 15,
"maximum_day": 18,
"maximum_week": 16
},
"weight": {
"minimum": 15,
"maximum": 16,
"maximum_day": 14,
"maximum_week": 18,
"suggested": 18
},
"persons": {
"minimum": 15,
"maximum": 19
}
},
"id": 17,
"allergens": [
{
"id": 14,
"name": "Lupine"
},
{
"id": 11,
"name": "Lactose"
},
{
"id": 18,
"name": "Milk"
}
],
"category_id": 10,
"price_look_up_code": "...",
"code": "...",
"seo": {
"title": {
"en": "Magni occaecati nam cupiditate et voluptates excepturi."
},
"description": {
"en": "Reprehenderit eveniet est dolor minima nihil. Asperiores magnam necessitatibus id ea. Harum sequi qui deserunt aut. Rerum sed sunt aut."
},
"url": {
"en": "http://stroman.info/ut-ad-repudiandae-aut-unde"
}
},
"origin": {
"nl": "...",
"en": "...",
"fr": "..."
}
}
],
"shops": [
{
"name": "Dorothy Hills",
"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": false,
"allow_order_comments": false,
"allow_product_comments": false,
"takeout_use_intervals": true,
"allow_order_messages": 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": true
},
"url": "..."
},
{
"name": "Nicola Hahn Jr.",
"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": false,
"allow_invoices": true,
"allow_order_comments": true,
"allow_product_comments": false,
"takeout_use_intervals": false,
"allow_order_messages": true,
"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
},
"url": "..."
},
{
"name": "Graham West DVM",
"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,
"allow_invoices": true,
"allow_order_comments": true,
"allow_product_comments": false,
"takeout_use_intervals": true,
"allow_order_messages": false,
"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": 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
},
"url": "..."
}
],
"code": "...",
"id": 11,
"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": "Ut totam commodi autem qui impedit."
},
"description": {
"en": "Nemo officiis officia id eius quia tenetur eveniet. Suscipit vitae rerum ipsam ullam fugit aliquam atque. At deserunt officiis omnis id voluptate aliquam occaecati."
},
"url": {
"en": "http://mraz.com/"
}
}
}