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/18/banner HTTP/1.1
Host: api.bakeronline.be
X-VERSION: 1.5.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 |
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. |
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: 6730
{
"name": "Prof. Brando Dickinson DDS",
"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,
"categories": [
{
"name": "Walton Torphy",
"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": false
},
"seo": {
"title": {
"en": "Perferendis illum ut rem omnis quidem architecto rerum ut animi maxime."
},
"description": {
"en": "Culpa voluptas voluptas quidem nobis voluptates non. Est quae veniam at similique ex maxime occaecati. Ab cumque recusandae expedita minus eius."
},
"url": {
"en": "https://tillman.com/sit-temporibus-delectus-quia-dolorem-a-laudantium.html"
}
}
},
{
"name": "Wava Rolfson",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"only_order_in_store": true,
"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": "Omnis mollitia laborum et dolor quis praesentium."
},
"description": {
"en": "Omnis totam natus officia id rerum dolores. Placeat sapiente autem suscipit sit unde necessitatibus qui exercitationem."
},
"url": {
"en": "https://www.nicolas.org/quo-et-nesciunt-magnam-alias"
}
}
},
{
"name": "Deon Stark",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": false,
"only_order_in_store": true,
"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": "Qui sed deserunt voluptatem rerum fuga."
},
"description": {
"en": "Distinctio quo cum ratione quia earum. Velit hic est corrupti molestias. In tempore sit eos facilis doloremque. Qui similique magni et excepturi rerum numquam pariatur perferendis."
},
"url": {
"en": "http://www.champlin.biz/"
}
}
}
],
"category_groups": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"category_ids": [
17,
15,
10
],
"uuid": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"category_ids": [
16,
10,
13
],
"uuid": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": false,
"category_ids": [
17,
12,
16
],
"uuid": "..."
}
],
"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
}
],
"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
}
}