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/19/banner HTTP/1.1
Host: api.bakeronline.be
X-VERSION: 1.5.2
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 |
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. |
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 7020
{
"name": "Amir Mohr",
"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": false,
"allow_product_comments": false,
"takeout_use_intervals": true,
"categories": [
{
"name": "Angie Moen I",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": false,
"only_order_in_store": false,
"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
}
],
"white_background": false
},
"seo": {
"title": {
"en": "Molestiae ut ratione corrupti nobis voluptates cupiditate aut aut."
},
"description": {
"en": "Dolorem accusamus molestias non praesentium consequatur iste rerum unde. Autem debitis fuga libero. Rerum impedit expedita rerum voluptatem totam magnam dolorem iste."
},
"url": {
"en": "http://grant.info/quidem-alias-excepturi-veritatis-ut-occaecati-doloremque"
}
}
},
{
"name": "Bernadine Doyle DDS",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": false,
"only_order_in_store": true,
"id": 17,
"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": "Error quas sit et quidem numquam."
},
"description": {
"en": "Et voluptates sed quia explicabo modi ut. Ut dicta omnis molestias earum. Repellat in iste totam enim distinctio."
},
"url": {
"en": "https://leuschke.info/atque-voluptatibus-dolores-sunt-optio-autem-quia-quia.html"
}
}
},
{
"name": "Emory Windler",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"only_order_in_store": true,
"id": 10,
"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": "Aut corrupti et aut non dolorum architecto ut."
},
"description": {
"en": "Aliquid libero nihil architecto id perspiciatis. Blanditiis debitis distinctio autem quia nam et. Vero sed et voluptatum eius et qui quis. Molestiae officiis cumque consequatur iste sunt libero."
},
"url": {
"en": "http://www.nolan.com/sint-velit-atque-esse-nisi-officia"
}
}
}
],
"category_groups": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"category_ids": [
11,
18,
17
],
"id": 14,
"uuid": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"category_ids": [
19,
15,
12
],
"id": 17,
"uuid": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": false,
"category_ids": [
19,
18,
12
],
"id": 16,
"uuid": "..."
}
],
"currency": "...",
"id": 17,
"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
}
}