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/2987/banner HTTP/1.1
Host: api.bakeronline.be
Authorization: Bearer aaeb60584607b19c54603fd0c8d3b4d8787b834321146e24362505009d5a751cfa0a18983415d8b89d786695b227070d2e484f45f53a4b32df757535963c0caa7ffab69852ce534d3c3e66b453247ca740de43e0e681d8bcaadd542c6ade644de83d3feb
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="file"; filename="adriaensen-adams-beerse.jpg"
Content-Type: image/png
...<Binary file here depending on Content-Transfer-Encoding field>...
--boundary--POST /company/shops/@id/banner HTTP/1.1
Host: api.bakeronline.be
Authorization: Bearer aaeb60584607b19c54603fd0c8d3b4d8787b834321146e24362505009d5a751cfa0a18983415d8b89d786695b227070d2e484f45f53a4b32df757535963c0caa7ffab69852ce534d3c3e66b453247ca740de43e0e681d8bcaadd542c6ade644de83d3feb
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="file"; filename="test.txt"
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: 1200
{
"id": 2987,
"name": "Cakewalkers",
"active": true,
"address": {
"street": "Michielspad",
"nr": "90",
"zipcode": "8850",
"city": "La Roche-en-Ardenne",
"country": "BE",
"position": {
"latitude": 51.05,
"longitude": 3.71667
}
},
"avatar": {
"resolutions": [
{
"src": "https://bakeronline.be/uploads/shop-avatars/2987/180x180/boulangerie-patisserie-tilman-namur.jpg",
"width": 124,
"height": 124
}
]
},
"banner": {
"resolutions": [
{
"src": "https://bakeronline.be/uploads/banner/2987/1300x315/adriaensen-adams-beerse.jpg",
"width": 300,
"height": 296
},
{
"src": "https://bakeronline.be/uploads/banner/2987/900x250/adriaensen-adams-beerse.jpg",
"width": 300,
"height": 296
}
]
},
"allow_comments": false,
"allow_orders": true,
"delivery_use_intervals": false,
"categories": [],
"category_groups": []
}HTTP/1.1 400 Bad Request
Content-Type: application/json; charset=utf-8
Content-Length: 124
[
{
"code": "missing_field",
"message": "Field id is required",
"field": "parameters.id"
}
]