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.3.0
Accept-Language: en-US,en;q=0.5
Content-Type: application/json
Content-Length: 733
{
"name": "Nadia Bayer",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": false,
"only_order_in_store": false,
"shop_ids": [
12,
16,
19
],
"seo": {
"title": {
"en": "Quam iste ut autem voluptatem cum error a."
},
"description": {
"en": "Ut facere id est quasi. Ipsa hic qui ipsam error quo aliquid quo dicta. A unde consequatur quos exercitationem vel labore. Repellendus cum autem autem eius."
},
"url": {
"en": "http://greenholt.com/voluptatem-nulla-sunt-voluptas-vero-neque"
}
},
"product_ids": [
11,
11,
12
]
}| 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: 13200
{
"name": "Cali Jacobi",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"only_order_in_store": false,
"products": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": true,
"active": true,
"only_order_in_store": false,
"price_type": "PER_UNIT",
"price": 15,
"target_price": false,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 10,
"maximum": 10,
"maximum_day": 17,
"maximum_week": 17
},
"weight": {
"minimum": 17,
"maximum": 19,
"maximum_day": 19,
"maximum_week": 12,
"suggested": 14
},
"persons": {
"minimum": 15,
"maximum": 10
}
},
"id": 15,
"allergens": [
{
"id": 18,
"name": "Fish"
},
{
"id": 15,
"name": "Crustaceans"
},
{
"id": 17,
"name": "Nuts"
}
],
"category_id": 18,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Sequi minus quo reiciendis deleniti culpa numquam voluptatem minima voluptatem."
},
"description": {
"en": "Libero rerum quos aut aperiam fuga quia. Commodi aut dolores ea fugiat. Magni eaque aut et quas. Odio ducimus voluptas eos doloremque."
},
"url": {
"en": "http://upton.com/sed-sed-expedita-ad-reprehenderit-id.html"
}
},
"code": "..."
},
{
"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": true,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 12,
"maximum": 18,
"maximum_day": 12,
"maximum_week": 13
},
"weight": {
"minimum": 19,
"maximum": 14,
"maximum_day": 12,
"maximum_week": 17,
"suggested": 19
},
"persons": {
"minimum": 19,
"maximum": 11
}
},
"id": 14,
"allergens": [
{
"id": 15,
"name": "Peanut"
},
{
"id": 16,
"name": "Soy"
},
{
"id": 10,
"name": "Sesame"
}
],
"category_id": 12,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Quas beatae modi repellendus rerum id."
},
"description": {
"en": "Doloremque animi totam necessitatibus assumenda. Sunt perferendis qui nihil doloremque. Unde beatae molestiae voluptatum in sunt."
},
"url": {
"en": "http://www.bruen.com/cum-cum-velit-eos-quaerat-itaque"
}
},
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": true,
"active": true,
"only_order_in_store": false,
"price_type": "PER_UNIT",
"price": 10,
"target_price": true,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 10,
"maximum": 16,
"maximum_day": 16,
"maximum_week": 11
},
"weight": {
"minimum": 12,
"maximum": 15,
"maximum_day": 18,
"maximum_week": 12,
"suggested": 12
},
"persons": {
"minimum": 18,
"maximum": 11
}
},
"id": 18,
"allergens": [
{
"id": 19,
"name": "Soy"
},
{
"id": 19,
"name": "Sulphite"
},
{
"id": 10,
"name": "Gluten"
}
],
"category_id": 11,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Nesciunt voluptatem alias dignissimos qui et."
},
"description": {
"en": "Et optio quibusdam similique exercitationem velit consequatur quibusdam magni. Iste et eos dolores. Est blanditiis eum inventore aut ab. Voluptatem eligendi dolorem aut magnam laboriosam quo."
},
"url": {
"en": "http://www.olson.biz/quaerat-rerum-neque-et-doloribus.html"
}
},
"code": "..."
}
],
"shops": [
{
"name": "Dr. Favian Bartoletti",
"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": 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": true
}
},
{
"name": "Elisa Moore PhD",
"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,
"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": 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
}
},
{
"name": "Elliott Little DVM",
"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": 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": 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": false
},
"seo": {
"title": {
"en": "Occaecati non doloribus nihil et aut nobis."
},
"description": {
"en": "Dolore modi eum qui blanditiis ut. Ad officia nihil debitis velit quaerat odio temporibus. Nihil rerum veniam omnis id temporibus cum."
},
"url": {
"en": "https://gorczany.org/sed-necessitatibus-maiores-quia-voluptas-maiores-voluptate.html"
}
}
}