POST /company/categories/@category_id/share
This endpoint requires authentication.
| Header | Value |
|---|---|
| Authorization | Set the value to Bearer + + access_token |
POST /company/categories/@category_id/share HTTP/1.1
Host: api.bakeronline.be
X-VERSION: 1.9.0
Accept-Language: en-US,en;q=0.5
| 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. |
| overview_image | 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: 18240
{
"name": "Dr. Dayne Fisher",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"only_order_in_store": true,
"products": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": true,
"active": true,
"only_order_in_store": true,
"price_type": "PER_UNIT",
"price": 12,
"target_price": true,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 14,
"maximum": 10,
"maximum_day": 15,
"maximum_week": 12
},
"weight": {
"minimum": 18,
"maximum": 12,
"maximum_day": 17,
"maximum_week": 17,
"suggested": 15
},
"persons": {
"minimum": 15,
"maximum": 14
}
},
"id": 10,
"allergens": [
{
"id": 10,
"name": "Gluten"
},
{
"id": 17,
"name": "Lactose"
},
{
"id": 17,
"name": "Fish"
}
],
"category_id": 17,
"price_look_up_code": "...",
"code": "...",
"seo": {
"title": {
"en": "Voluptatibus provident quae sint ea iusto ullam reiciendis consequatur ipsam."
},
"description": {
"en": "Facilis fugiat est voluptatum exercitationem accusantium laboriosam deserunt officia. Numquam voluptate modi qui dolore facere sit magnam. Ea qui recusandae tempore consequatur nisi et rerum."
},
"url": {
"en": "http://kuhn.com/ipsam-dolor-qui-optio-neque-eaque"
}
},
"origin": {
"nl": "...",
"en": "...",
"fr": "..."
},
"ingredients": {
"nl": "...",
"en": "...",
"fr": "..."
},
"temperature_type": "any",
"warranty_type": "none",
"warranty_price": 19,
"stock": {
"soldout": false,
"amount": 15,
"soldoutUntil": "2019-01-31 12:00"
},
"daysavailable": [
19,
14,
17
],
"upfront": {
"upfront_use_default": true,
"upfront_type": "days",
"upfront_days": 15,
"upfront_time": "12:00",
"upfront_hours": 15,
"upfront_minutes": 16
},
"use_pickup_after": true,
"pickup_after": "12:00",
"use_pickup_before": true,
"pickup_before": "12:00",
"related_products": [
18,
13,
14
]
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": false,
"active": false,
"only_order_in_store": true,
"price_type": "PER_UNIT",
"price": 18,
"target_price": true,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 15,
"maximum": 13,
"maximum_day": 16,
"maximum_week": 10
},
"weight": {
"minimum": 10,
"maximum": 19,
"maximum_day": 12,
"maximum_week": 19,
"suggested": 15
},
"persons": {
"minimum": 11,
"maximum": 13
}
},
"id": 14,
"allergens": [
{
"id": 15,
"name": "Soy"
},
{
"id": 19,
"name": "Fish"
},
{
"id": 18,
"name": "Egg"
}
],
"category_id": 13,
"price_look_up_code": "...",
"code": "...",
"seo": {
"title": {
"en": "Ut voluptate consequatur mollitia qui ut dolorem."
},
"description": {
"en": "Dolores at iusto totam earum. Optio sunt nam quam mollitia sit aliquam. Non voluptatum libero ipsa quia autem aperiam. Minus possimus nihil beatae sed optio perspiciatis ut."
},
"url": {
"en": "http://www.greenholt.com/excepturi-saepe-officia-illum-et-dolor-aut-incidunt"
}
},
"origin": {
"nl": "...",
"en": "...",
"fr": "..."
},
"ingredients": {
"nl": "...",
"en": "...",
"fr": "..."
},
"temperature_type": "any",
"warranty_type": "none",
"warranty_price": 19,
"stock": {
"soldout": true,
"amount": 11,
"soldoutUntil": "2019-01-31 12:00"
},
"daysavailable": [
13,
16,
19
],
"upfront": {
"upfront_use_default": false,
"upfront_type": "days",
"upfront_days": 17,
"upfront_time": "12:00",
"upfront_hours": 15,
"upfront_minutes": 11
},
"use_pickup_after": true,
"pickup_after": "12:00",
"use_pickup_before": true,
"pickup_before": "12:00",
"related_products": [
19,
17,
12
]
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": true,
"active": false,
"only_order_in_store": true,
"price_type": "PER_UNIT",
"price": 11,
"target_price": true,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 19,
"maximum": 16,
"maximum_day": 19,
"maximum_week": 11
},
"weight": {
"minimum": 17,
"maximum": 11,
"maximum_day": 11,
"maximum_week": 11,
"suggested": 11
},
"persons": {
"minimum": 12,
"maximum": 12
}
},
"id": 14,
"allergens": [
{
"id": 15,
"name": "Milk"
},
{
"id": 18,
"name": "Gluten"
},
{
"id": 18,
"name": "Nuts"
}
],
"category_id": 14,
"price_look_up_code": "...",
"code": "...",
"seo": {
"title": {
"en": "Doloribus sunt magnam rerum ut aliquam nobis eius quia."
},
"description": {
"en": "In non necessitatibus sed. Et voluptates laboriosam neque ipsum et velit sit. Quidem voluptas quia culpa occaecati. Non accusantium non eius maiores aut modi."
},
"url": {
"en": "https://johnson.com/quasi-eaque-enim-consequatur-ut.html"
}
},
"origin": {
"nl": "...",
"en": "...",
"fr": "..."
},
"ingredients": {
"nl": "...",
"en": "...",
"fr": "..."
},
"temperature_type": "any",
"warranty_type": "none",
"warranty_price": 17,
"stock": {
"soldout": true,
"amount": 17,
"soldoutUntil": "2019-01-31 12:00"
},
"daysavailable": [
13,
18,
16
],
"upfront": {
"upfront_use_default": false,
"upfront_type": "days",
"upfront_days": 16,
"upfront_time": "12:00",
"upfront_hours": 13,
"upfront_minutes": 13
},
"use_pickup_after": true,
"pickup_after": "12:00",
"use_pickup_before": true,
"pickup_before": "12:00",
"related_products": [
14,
13,
10
]
}
],
"shops": [
{
"name": "Albin Lehner",
"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": false,
"allow_invoices": false,
"allow_order_comments": true,
"allow_product_comments": false,
"takeout_use_intervals": false,
"allow_order_messages": 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
}
],
"file_id": 15,
"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
}
],
"file_id": 11,
"white_background": true
},
"url": "..."
},
{
"name": "Kariane Kassulke",
"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": true,
"delivery_use_intervals": false,
"allow_invoices": false,
"allow_order_comments": true,
"allow_product_comments": true,
"takeout_use_intervals": false,
"allow_order_messages": 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
}
],
"file_id": 18,
"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
}
],
"file_id": 15,
"white_background": true
},
"url": "..."
},
{
"name": "Casey Murazik",
"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": true,
"delivery_use_intervals": true,
"allow_invoices": false,
"allow_order_comments": true,
"allow_product_comments": false,
"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
}
],
"file_id": 14,
"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
}
],
"file_id": 13,
"white_background": false
},
"url": "..."
}
],
"code": "...",
"id": 19,
"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
}
],
"file_id": 11,
"white_background": false
},
"overview_image": {
"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
}
],
"file_id": 17,
"white_background": false
},
"seo": {
"title": {
"en": "Tempora rem dolore nam soluta omnis aut sit quas."
},
"description": {
"en": "Exercitationem autem odit corrupti voluptatum quibusdam. Facere qui mollitia aliquid reiciendis a minus ad odit. Tempore in repellat qui quaerat doloribus eligendi tempore."
},
"url": {
"en": "http://www.marks.com/quibusdam-numquam-ratione-pariatur-a"
}
}
}