POST /company/shops/@id/spotlight
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 spotlight photo 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/spotlight HTTP/1.1
Host: api.bakeronline.be
X-VERSION: 1.10.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 |
| emails | Dictionary | Email settings |
| internal_name | String | A name for the shop that's more clear to people working for the shop when navigating the shop settings, order lists or statistics. |
| VAT | String | VAT number |
| bank_account_number | String | A String value |
| links | Dictionary | A dictionary with fields |
| content | Dictionary | A dictionary with fields |
| contact | Dictionary | A dictionary with fields |
| display | Dictionary | A dictionary with fields |
| spotlight | Dictionary | Set product or category in the spotlight. |
| comments | Dictionary | Comment related settings |
| checkout | Dictionary | Checkout related settings |
| time | Dictionary | A dictionary with fields |
| discount | Dictionary | A dictionary with fields |
| latches | Dictionary | A dictionary with fields |
| modules | Dictionary | A dictionary with fields |
| id | Int | ID of the shop |
| avatar | Image? | Nullable. |
| banner | Image? | Nullable. |
| url | String | URL the shop in case it is using a platform |
| placeholder | Image? | Nullable. |
| photos | [Image] | Array of Image |
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 42576
{
"name": "Dexter Heathcote DDS",
"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": true,
"allow_invoices": true,
"allow_order_comments": true,
"allow_product_comments": true,
"takeout_use_intervals": true,
"allow_order_messages": true,
"categories": [
{
"name": "Dr. Kayla Spinka",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"only_order_in_store": false,
"code": "...",
"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
}
],
"file_id": 17,
"white_background": false
},
"overview_image": {
"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
}
],
"file_id": 19,
"white_background": false
},
"seo": {
"title": {
"en": "Est facere earum voluptatibus hic sed nesciunt aut illum voluptates voluptates minima."
},
"description": {
"en": "Aut velit earum aut voluptas ipsa est. Et et nesciunt recusandae est velit officia eaque. Neque neque dolores neque sed eaque. Aliquid qui quidem exercitationem ut omnis fuga."
},
"url": {
"en": "http://gleichner.com/reiciendis-minus-aut-voluptatem"
}
}
},
{
"name": "Dr. Maybell Berge V",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": false,
"only_order_in_store": true,
"code": "...",
"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
}
],
"file_id": 18,
"white_background": false
},
"overview_image": {
"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
}
],
"file_id": 12,
"white_background": true
},
"seo": {
"title": {
"en": "Est iste accusamus et libero dolorem molestiae suscipit cumque qui."
},
"description": {
"en": "Itaque velit recusandae rem ex aut. Consequatur minus nemo rerum ullam deleniti numquam."
},
"url": {
"en": "https://www.willms.com/minus-asperiores-et-et-maiores-modi-expedita-veritatis"
}
}
},
{
"name": "Ms. Lesly Pollich MD",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"only_order_in_store": false,
"code": "...",
"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
}
],
"file_id": 19,
"white_background": true
},
"overview_image": {
"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
}
],
"file_id": 17,
"white_background": false
},
"seo": {
"title": {
"en": "Voluptatem dolor a eveniet facilis laborum dicta pariatur voluptatibus voluptas."
},
"description": {
"en": "Quam ipsam qui vel pariatur voluptatibus. Magnam est explicabo repellendus minus velit saepe sunt. Distinctio et incidunt voluptas mollitia praesentium omnis et. Alias pariatur at porro est ea."
},
"url": {
"en": "http://www.okuneva.biz/"
}
}
}
],
"category_groups": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": false,
"category_ids": [
19,
10,
10
],
"id": 17,
"overview_image": {
"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
}
],
"file_id": 10,
"white_background": false
},
"uuid": "...",
"order": 15
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": false,
"category_ids": [
19,
14,
15
],
"id": 18,
"overview_image": {
"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
}
],
"file_id": 18,
"white_background": false
},
"uuid": "...",
"order": 18
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": false,
"category_ids": [
15,
17,
16
],
"id": 10,
"overview_image": {
"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
}
],
"file_id": 10,
"white_background": false
},
"uuid": "...",
"order": 18
}
],
"currency": "...",
"emails": {
"note_for_customer": "..."
},
"internal_name": "...",
"VAT": "...",
"bank_account_number": "...",
"links": {
"website": "https://example.com",
"twitter": "https://example.com",
"facebook": "https://example.com",
"instagram": "https://example.com",
"youtube": "https://example.com",
"pinterest": "https://example.com",
"snapchat": "https://example.com"
},
"content": {
"specialties": "...",
"about_us": "...",
"customer_message": "..."
},
"contact": {
"telephone": "...",
"email": "..."
},
"display": {
"display_mode": "blocks",
"collapse_category_groups": false,
"show_category_overview": false,
"show_category_group_overview": false
},
"spotlight": {
"enable": true,
"title": "...",
"type": "product",
"id": 13,
"photo": {
"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
}
],
"file_id": 16,
"white_background": false
}
},
"comments": {
"disable_when_order_is_approved": false
},
"checkout": {
"warranty": {
"ask_for_bank_account_number": true
},
"invoicing": {
"allow": true,
"cost": 15,
"ignore_cost_if_above": 12,
"ignore_cost_if_above_enable": true,
"generate": {
"enable": false,
"expire_days": 15
}
},
"takeout": {
"enable": false,
"auto_approve_orders": true,
"payment_methods": {
"cash": true,
"cash_if_targetprice_isop": true,
"online": false,
"online_if_targetprice": false,
"banktransfer": false,
"banktransfer_with_invoice": true,
"bank_account_numbers": [
{
"name": "...",
"number": "..."
},
{
"name": "...",
"number": "..."
},
{
"name": "...",
"number": "..."
}
]
},
"max_orders": {
"items": [
{
"max_per": "hour",
"max_amount": 16,
"days": {
"all": true,
"custom": [
11,
13,
17
]
},
"intervals": [
{
"max_amount": 12,
"start": "12:00",
"end": "12:00"
},
{
"max_amount": 19,
"start": "12:00",
"end": "12:00"
},
{
"max_amount": 18,
"start": "12:00",
"end": "12:00"
}
]
},
{
"max_per": "hour",
"max_amount": 12,
"days": {
"all": true,
"custom": [
11,
18,
16
]
},
"intervals": [
{
"max_amount": 10,
"start": "12:00",
"end": "12:00"
},
{
"max_amount": 14,
"start": "12:00",
"end": "12:00"
},
{
"max_amount": 12,
"start": "12:00",
"end": "12:00"
}
]
},
{
"max_per": "hour",
"max_amount": 19,
"days": {
"all": true,
"custom": [
11,
15,
16
]
},
"intervals": [
{
"max_amount": 14,
"start": "12:00",
"end": "12:00"
},
{
"max_amount": 13,
"start": "12:00",
"end": "12:00"
},
{
"max_amount": 12,
"start": "12:00",
"end": "12:00"
}
]
}
]
}
},
"delivery": {
"enable": false,
"auto_approve_orders": true,
"info_message": "...",
"minimum_order_price": 19,
"payment_methods": {
"cash": false,
"cash_if_targetprice_isop": true,
"online": false,
"online_if_targetprice": true,
"banktransfer": false,
"banktransfer_with_invoice": false,
"bank_account_numbers": [
{
"name": "...",
"number": "..."
},
{
"name": "...",
"number": "..."
},
{
"name": "...",
"number": "..."
}
]
},
"max_orders": {
"items": [
{
"max_per": "hour",
"max_amount": 13,
"days": {
"all": false,
"custom": [
18,
11,
18
]
},
"intervals": [
{
"max_amount": 17,
"start": "12:00",
"end": "12:00"
},
{
"max_amount": 19,
"start": "12:00",
"end": "12:00"
},
{
"max_amount": 11,
"start": "12:00",
"end": "12:00"
}
]
},
{
"max_per": "hour",
"max_amount": 18,
"days": {
"all": true,
"custom": [
10,
16,
10
]
},
"intervals": [
{
"max_amount": 16,
"start": "12:00",
"end": "12:00"
},
{
"max_amount": 15,
"start": "12:00",
"end": "12:00"
},
{
"max_amount": 14,
"start": "12:00",
"end": "12:00"
}
]
},
{
"max_per": "hour",
"max_amount": 19,
"days": {
"all": true,
"custom": [
11,
18,
16
]
},
"intervals": [
{
"max_amount": 15,
"start": "12:00",
"end": "12:00"
},
{
"max_amount": 12,
"start": "12:00",
"end": "12:00"
},
{
"max_amount": 13,
"start": "12:00",
"end": "12:00"
}
]
}
]
},
"cost": {
"type": "fixed",
"cost_per_day": {
"d1": 17,
"d2": 17,
"d3": 12,
"d4": 15,
"d5": 16,
"d6": 13,
"d7": 12
},
"alternative": {
"enable": true,
"order_price": 18,
"cost_per_day": {
"d1": 14,
"d2": 12,
"d3": 18,
"d4": 12,
"d5": 11,
"d6": 18,
"d7": 17
}
},
"distance_alternatives": [
{
"distance": 10,
"cost_per_day": {
"d1": 11,
"d2": 10,
"d3": 11,
"d4": 17,
"d5": 19,
"d6": 12,
"d7": 11
}
},
{
"distance": 15,
"cost_per_day": {
"d1": 15,
"d2": 14,
"d3": 19,
"d4": 19,
"d5": 18,
"d6": 14,
"d7": 11
}
},
{
"distance": 10,
"cost_per_day": {
"d1": 13,
"d2": 14,
"d3": 14,
"d4": 16,
"d5": 18,
"d6": 11,
"d7": 11
}
}
]
},
"range": {
"everywhere": true,
"has_max_range": true,
"max_range": 16
}
}
},
"time": {
"open": {
"hours": {
"d1": [
{
"start": "12:00",
"end": "12:00"
},
{
"start": "12:00",
"end": "12:00"
},
{
"start": "12:00",
"end": "12:00"
}
],
"d2": [
{
"start": "12:00",
"end": "12:00"
},
{
"start": "12:00",
"end": "12:00"
},
{
"start": "12:00",
"end": "12:00"
}
],
"d3": [
{
"start": "12:00",
"end": "12:00"
},
{
"start": "12:00",
"end": "12:00"
},
{
"start": "12:00",
"end": "12:00"
}
],
"d4": [
{
"start": "12:00",
"end": "12:00"
},
{
"start": "12:00",
"end": "12:00"
},
{
"start": "12:00",
"end": "12:00"
}
],
"d5": [
{
"start": "12:00",
"end": "12:00"
},
{
"start": "12:00",
"end": "12:00"
},
{
"start": "12:00",
"end": "12:00"
}
],
"d6": [
{
"start": "12:00",
"end": "12:00"
},
{
"start": "12:00",
"end": "12:00"
},
{
"start": "12:00",
"end": "12:00"
}
],
"d7": [
{
"start": "12:00",
"end": "12:00"
},
{
"start": "12:00",
"end": "12:00"
},
{
"start": "12:00",
"end": "12:00"
}
]
}
},
"takeout": {
"use_intervals": false,
"hours": {
"d1": [
{
"start": "12:00",
"end": "12:00"
},
{
"start": "12:00",
"end": "12:00"
},
{
"start": "12:00",
"end": "12:00"
}
],
"d2": [
{
"start": "12:00",
"end": "12:00"
},
{
"start": "12:00",
"end": "12:00"
},
{
"start": "12:00",
"end": "12:00"
}
],
"d3": [
{
"start": "12:00",
"end": "12:00"
},
{
"start": "12:00",
"end": "12:00"
},
{
"start": "12:00",
"end": "12:00"
}
],
"d4": [
{
"start": "12:00",
"end": "12:00"
},
{
"start": "12:00",
"end": "12:00"
},
{
"start": "12:00",
"end": "12:00"
}
],
"d5": [
{
"start": "12:00",
"end": "12:00"
},
{
"start": "12:00",
"end": "12:00"
},
{
"start": "12:00",
"end": "12:00"
}
],
"d6": [
{
"start": "12:00",
"end": "12:00"
},
{
"start": "12:00",
"end": "12:00"
},
{
"start": "12:00",
"end": "12:00"
}
],
"d7": [
{
"start": "12:00",
"end": "12:00"
},
{
"start": "12:00",
"end": "12:00"
},
{
"start": "12:00",
"end": "12:00"
}
]
},
"upfront": {
"d1": {
"method": "x_days",
"x_days": {
"days": 16,
"close_at": "12:00"
},
"x_time": {
"hours": 19,
"minutes": 18
}
},
"d2": {
"method": "x_days",
"x_days": {
"days": 14,
"close_at": "12:00"
},
"x_time": {
"hours": 19,
"minutes": 18
}
},
"d3": {
"method": "x_days",
"x_days": {
"days": 10,
"close_at": "12:00"
},
"x_time": {
"hours": 14,
"minutes": 13
}
},
"d4": {
"method": "x_days",
"x_days": {
"days": 17,
"close_at": "12:00"
},
"x_time": {
"hours": 16,
"minutes": 19
}
},
"d5": {
"method": "x_days",
"x_days": {
"days": 14,
"close_at": "12:00"
},
"x_time": {
"hours": 16,
"minutes": 12
}
},
"d6": {
"method": "x_days",
"x_days": {
"days": 17,
"close_at": "12:00"
},
"x_time": {
"hours": 13,
"minutes": 17
}
},
"d7": {
"method": "x_days",
"x_days": {
"days": 19,
"close_at": "12:00"
},
"x_time": {
"hours": 14,
"minutes": 11
}
}
}
},
"delivery": {
"use_intervals": true,
"hours": {
"d1": [
{
"start": "12:00",
"end": "12:00"
},
{
"start": "12:00",
"end": "12:00"
},
{
"start": "12:00",
"end": "12:00"
}
],
"d2": [
{
"start": "12:00",
"end": "12:00"
},
{
"start": "12:00",
"end": "12:00"
},
{
"start": "12:00",
"end": "12:00"
}
],
"d3": [
{
"start": "12:00",
"end": "12:00"
},
{
"start": "12:00",
"end": "12:00"
},
{
"start": "12:00",
"end": "12:00"
}
],
"d4": [
{
"start": "12:00",
"end": "12:00"
},
{
"start": "12:00",
"end": "12:00"
},
{
"start": "12:00",
"end": "12:00"
}
],
"d5": [
{
"start": "12:00",
"end": "12:00"
},
{
"start": "12:00",
"end": "12:00"
},
{
"start": "12:00",
"end": "12:00"
}
],
"d6": [
{
"start": "12:00",
"end": "12:00"
},
{
"start": "12:00",
"end": "12:00"
},
{
"start": "12:00",
"end": "12:00"
}
],
"d7": [
{
"start": "12:00",
"end": "12:00"
},
{
"start": "12:00",
"end": "12:00"
},
{
"start": "12:00",
"end": "12:00"
}
]
},
"upfront": {
"d1": {
"method": "x_days",
"x_days": {
"days": 17,
"close_at": "12:00"
},
"x_time": {
"hours": 13,
"minutes": 11
}
},
"d2": {
"method": "x_days",
"x_days": {
"days": 14,
"close_at": "12:00"
},
"x_time": {
"hours": 10,
"minutes": 15
}
},
"d3": {
"method": "x_days",
"x_days": {
"days": 17,
"close_at": "12:00"
},
"x_time": {
"hours": 19,
"minutes": 17
}
},
"d4": {
"method": "x_days",
"x_days": {
"days": 18,
"close_at": "12:00"
},
"x_time": {
"hours": 13,
"minutes": 13
}
},
"d5": {
"method": "x_days",
"x_days": {
"days": 10,
"close_at": "12:00"
},
"x_time": {
"hours": 10,
"minutes": 17
}
},
"d6": {
"method": "x_days",
"x_days": {
"days": 15,
"close_at": "12:00"
},
"x_time": {
"hours": 19,
"minutes": 15
}
},
"d7": {
"method": "x_days",
"x_days": {
"days": 12,
"close_at": "12:00"
},
"x_time": {
"hours": 19,
"minutes": 12
}
}
}
},
"timezone": "Europe/Brussels"
},
"discount": {
"general": 19,
"first_order": 14
},
"latches": {
"enable": true
},
"modules": {
"joyn": {
"enable": false,
"partner_reference": "..."
},
"paynl": {
"service_id": "...",
"merchant_id": "..."
},
"payconiq": {
"enable": false,
"merchant_id": "...",
"api_key": "...",
"api_secret": "..."
},
"paypal": {
"enable": false,
"client_id": "...",
"api_secret": "..."
},
"payu": {
"enable": false,
"provider": "",
"romania": {
"merchant_code": "...",
"secret_key": "..."
},
"brazil": {
"api_login": "...",
"api_key": "...",
"account_id": "...",
"merchant_id": "..."
},
"single_platform": {
"pos_id": "...",
"second_key": "...",
"secret_key": "..."
},
"iyzico": {
"api_key": "...",
"secret_key": "..."
}
},
"monizze": {
"enable": false,
"merchant_id": "...",
"in_key": "...",
"out_key": "..."
},
"edenred": {
"enable": false,
"merchant_id": "..."
},
"qguard": {
"enable": false,
"contract_id": "..."
},
"viresmo": {
"enable": false,
"api_key": "...",
"organisation_id": "..."
},
"innovend": {
"enable": true
},
"mannamatic": {
"enable": false
}
},
"id": 19,
"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
}
],
"file_id": 14,
"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
}
],
"file_id": 12,
"white_background": true
},
"url": "...",
"placeholder": {
"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
}
],
"file_id": 19,
"white_background": true
},
"photos": [
{
"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
}
],
"file_id": 15,
"white_background": false
},
{
"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
}
],
"file_id": 14,
"white_background": false
},
{
"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
}
],
"file_id": 11,
"white_background": true
}
]
}