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/10/banner HTTP/1.1
Host: api.bakeronline.be
X-VERSION: 1.5.1
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 |
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: 6895
{
"name": "Serena Medhurst",
"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": true,
"categories": [
{
"name": "Patricia Dooley",
"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": false
},
"seo": {
"title": {
"en": "Est excepturi numquam minima hic facilis similique neque enim quod non."
},
"description": {
"en": "Molestiae eius excepturi aut quis. Officiis impedit fugiat fugiat rerum. Quasi nihil nihil aspernatur aut vero soluta ab dolorum."
},
"url": {
"en": "http://christiansen.info/"
}
}
},
{
"name": "Samantha Bernier III",
"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": "Consequatur dolorem sunt optio non quam dolore voluptates odio illum."
},
"description": {
"en": "Praesentium nihil beatae mollitia odit. Sunt consequuntur labore officia aperiam eius iusto amet asperiores."
},
"url": {
"en": "http://schinner.biz/sunt-voluptatum-minus-et-eum-magni"
}
}
},
{
"name": "Layla Hauck MD",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": false,
"only_order_in_store": false,
"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": "Et non fuga aspernatur tempora modi et fuga expedita consequatur officia."
},
"description": {
"en": "Hic voluptatem dolorum voluptatum deleniti quod reiciendis totam. Cum et blanditiis aut dolor esse. Sunt dolore dolorem quasi velit in atque quas sed. Nobis voluptatem qui earum explicabo totam."
},
"url": {
"en": "https://www.ankunding.com/exercitationem-qui-aut-saepe-dolor-repellendus"
}
}
}
],
"category_groups": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"category_ids": [
15,
16,
10
],
"id": 11,
"uuid": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": false,
"category_ids": [
10,
16,
18
],
"id": 11,
"uuid": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": false,
"category_ids": [
13,
11,
19
],
"id": 14,
"uuid": "..."
}
],
"currency": "...",
"id": 15,
"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
}
}