POST /company/companies/@id/categories
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 company where to create a new category |
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 |
POST /company/companies/17/categories 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: 630
{
"name": "Liliane Lockman",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": false,
"only_order_in_store": false,
"shop_ids": [
13,
15,
10
],
"seo": {
"title": {
"en": "Similique ab corrupti dolor doloremque quis eligendi."
},
"description": {
"en": "Amet et quibusdam facere ad. Est quis est cupiditate quod nam."
},
"url": {
"en": "http://mcglynn.biz/"
}
},
"product_ids": [
15,
19,
19
],
"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: 14315
{
"name": "Myah Muller",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": false,
"only_order_in_store": false,
"products": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": false,
"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": 12,
"maximum": 15,
"maximum_day": 16,
"maximum_week": 19
},
"weight": {
"minimum": 19,
"maximum": 19,
"maximum_day": 12,
"maximum_week": 17,
"suggested": 15
},
"persons": {
"minimum": 19,
"maximum": 17
}
},
"id": 15,
"allergens": [
{
"id": 19,
"name": "Crustaceans"
},
{
"id": 17,
"name": "Fish"
},
{
"id": 19,
"name": "Mollusc"
}
],
"category_id": 12,
"price_look_up_code": "...",
"code": "...",
"seo": {
"title": {
"en": "Quis deserunt architecto culpa officiis itaque fugiat earum."
},
"description": {
"en": "Quod quidem possimus vero facilis. Ipsum odio ea ex reprehenderit et qui numquam. Nobis et omnis aperiam libero temporibus."
},
"url": {
"en": "http://lind.com/"
}
},
"origin": {
"nl": "...",
"en": "...",
"fr": "..."
}
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": false,
"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": 15,
"maximum": 15,
"maximum_day": 11,
"maximum_week": 10
},
"weight": {
"minimum": 13,
"maximum": 17,
"maximum_day": 14,
"maximum_week": 15,
"suggested": 13
},
"persons": {
"minimum": 13,
"maximum": 11
}
},
"id": 13,
"allergens": [
{
"id": 18,
"name": "Soy"
},
{
"id": 18,
"name": "Nuts"
},
{
"id": 16,
"name": "Sulphite"
}
],
"category_id": 12,
"price_look_up_code": "...",
"code": "...",
"seo": {
"title": {
"en": "Consequatur enim aliquam tempora sed amet repellat quos voluptas quia."
},
"description": {
"en": "Doloremque accusantium amet et et. Similique occaecati quidem aut optio rerum. Dignissimos beatae qui quis omnis sapiente et aspernatur et. Molestiae qui quam voluptatum non est qui."
},
"url": {
"en": "http://lehner.com/perferendis-vitae-odio-expedita-itaque-velit-qui-eos.html"
}
},
"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": 18,
"target_price": true,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 15,
"maximum": 18,
"maximum_day": 15,
"maximum_week": 12
},
"weight": {
"minimum": 13,
"maximum": 16,
"maximum_day": 16,
"maximum_week": 15,
"suggested": 13
},
"persons": {
"minimum": 16,
"maximum": 18
}
},
"id": 13,
"allergens": [
{
"id": 11,
"name": "Fish"
},
{
"id": 14,
"name": "Peanut"
},
{
"id": 17,
"name": "Egg"
}
],
"category_id": 16,
"price_look_up_code": "...",
"code": "...",
"seo": {
"title": {
"en": "Placeat eos est rem similique ab modi et est omnis natus id."
},
"description": {
"en": "Quaerat eius sed et quisquam tenetur repudiandae sequi. Nesciunt ullam expedita nemo est aut minus sed. Eum quae id praesentium quaerat."
},
"url": {
"en": "http://hansen.com/"
}
},
"origin": {
"nl": "...",
"en": "...",
"fr": "..."
}
}
],
"shops": [
{
"name": "Ms. Kacie Rutherford II",
"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": false,
"allow_invoices": false,
"allow_order_comments": true,
"allow_product_comments": false,
"takeout_use_intervals": false,
"allow_order_messages": true,
"id": 10,
"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": "Mrs. Marcelle Conn MD",
"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": true,
"allow_order_comments": true,
"allow_product_comments": false,
"takeout_use_intervals": false,
"allow_order_messages": 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": 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": "Wilfred Ward II",
"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": false,
"allow_product_comments": true,
"takeout_use_intervals": false,
"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": 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": "..."
}
],
"code": "...",
"id": 15,
"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": "Voluptas voluptatibus sed dolorem vero quae id placeat in quas officia."
},
"description": {
"en": "Perferendis rerum excepturi eligendi perferendis saepe. Quia sit consequuntur quis eum corporis corporis. Rerum dolore atque fuga sit. Dolor occaecati optio sed saepe."
},
"url": {
"en": "https://jaskolski.com/rerum-possimus-expedita-repellat-ea-ad.html"
}
}
}