POST /company/shops/@id/banner
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 shop you want to upload a banner for |
This endpoint requires uploaded files in the HTTP request. You can check the examples on the right for more information or read more about this on MDN.
| Key | Description |
|---|---|
file |
Upload a single file |
POST /company/shops/15/banner HTTP/1.1
Host: api.bakeronline.be
X-VERSION: 1.7.0
Accept-Language: en-US,en;q=0.5
Content-Type: multipart/form-data;boundary="boundary"
--boundary
Content-Disposition: form-data; name="single"; filename="test.png"
Content-Type: image/png
...<Binary file here depending on Content-Transfer-Encoding field>...
--boundary--| Field | Type | Description |
|---|---|---|
| name | String | Name of the shop (not translateable for now) |
| active | Bool | A boolean value |
| address | Address.detailed | An address |
| allow_comments | Bool | A boolean value |
| allow_orders | Bool | A boolean value |
| delivery_use_intervals | Bool | A boolean value |
| allow_invoices | Bool | A boolean value |
| allow_order_comments | Bool | A boolean value |
| allow_product_comments | Bool | A boolean value |
| takeout_use_intervals | Bool | A boolean value |
| allow_order_messages | Bool | A boolean value |
| categories | [company.Category.simple] | List of the categories of all the categories visible for the shop |
| category_groups | [company.CategoryGroup] | List of the category groups linked to the shop. More information can be found on the category group documentation page. |
| currency | String | A String value |
| id | Int | ID of the shop |
| avatar | Image? | Nullable. |
| banner | Image? | Nullable. |
| url | String | URL the shop in case it is using a platform |
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 6967
{
"name": "Prof. Chloe Frami MD",
"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": true,
"allow_order_comments": false,
"allow_product_comments": true,
"takeout_use_intervals": false,
"allow_order_messages": false,
"categories": [
{
"name": "Manley Bashirian",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"only_order_in_store": true,
"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": "Consectetur laborum quae non praesentium quo et explicabo ex voluptatem sit."
},
"description": {
"en": "Suscipit accusantium quia explicabo doloribus nihil in consectetur voluptatem. Enim distinctio natus magnam voluptate. Est error tempore sit quia aut."
},
"url": {
"en": "http://mraz.com/sint-ullam-tenetur-optio-excepturi-vero-sequi-magni.html"
}
}
},
{
"name": "Ceasar Rogahn",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"only_order_in_store": true,
"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": false
},
"seo": {
"title": {
"en": "Maxime expedita provident qui aliquam quis."
},
"description": {
"en": "Ea vitae qui voluptas. Optio voluptatem qui quia aut dolores rerum. Quod aperiam et est totam fugit temporibus."
},
"url": {
"en": "http://www.bahringer.com/doloremque-asperiores-autem-officiis-iure-magni.html"
}
}
},
{
"name": "Dr. Aurelia Torp Jr.",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"only_order_in_store": false,
"id": 16,
"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": "Quasi aut nobis odio optio."
},
"description": {
"en": "Quia facere et nostrum eos nam est. Error corporis ut illum odit illum odio eos."
},
"url": {
"en": "http://ondricka.info/mollitia-molestias-et-modi-incidunt-debitis-sed"
}
}
}
],
"category_groups": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"category_ids": [
19,
13,
11
],
"id": 16,
"uuid": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": false,
"category_ids": [
14,
13,
10
],
"id": 13,
"uuid": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": false,
"category_ids": [
12,
17,
13
],
"id": 10,
"uuid": "..."
}
],
"currency": "...",
"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": "..."
}