Get all holidays from a company

GET /company/companies/@id/holidays

Request

Authentication

This endpoint requires authentication.

Header Value
Authorization Set the value to Bearer + + access_token

URL parameters

Replace the @ keywords in the URL with their corresponding value.

A dictionary with fields

Field Type Description
id Int The ID of the company you want the holidays from

Example request 1

GET /company/companies/19/holidays HTTP/1.1
Host: api.bakeronline.be
X-VERSION: 1.9.0
Accept-Language: en-US,en;q=0.5

Response

Array of Holiday: [Holiday]

Holiday

Field Type Description
shop_ids [Int] Shop ids this holiday applies to
closed Bool Whether the shop is closed during this time or changed it's openings hours
start_date Date Date of when it starts
end_date Date Date of when it ends
message String Message to the customer
upfront Dictionary A dictionary with fields
takeout Dictionary Adjusted calendar hours for takeout
delivery Dictionary Adjusted calendar hours for delivery
open Dictionary Adjusted opening hours
id Int Id of the holiday

Example response 1

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 5130

[
    {
        "shop_ids": [
            11,
            12,
            11
        ],
        "closed": true,
        "start_date": "2019-01-31",
        "end_date": "2019-01-31",
        "message": "...",
        "upfront": {
            "type": "default",
            "days": 16,
            "time": "12:00",
            "hours": 15,
            "minutes": 17
        },
        "takeout": {
            "action": "default",
            "custom_hours": [
                {
                    "start": "12:00",
                    "end": "12:00"
                },
                {
                    "start": "12:00",
                    "end": "12:00"
                },
                {
                    "start": "12:00",
                    "end": "12:00"
                }
            ]
        },
        "delivery": {
            "action": "default",
            "custom_hours": [
                {
                    "start": "12:00",
                    "end": "12:00"
                },
                {
                    "start": "12:00",
                    "end": "12:00"
                },
                {
                    "start": "12:00",
                    "end": "12:00"
                }
            ]
        },
        "open": {
            "action": "default",
            "custom_hours": [
                {
                    "start": "12:00",
                    "end": "12:00"
                },
                {
                    "start": "12:00",
                    "end": "12:00"
                },
                {
                    "start": "12:00",
                    "end": "12:00"
                }
            ]
        },
        "id": 12
    },
    {
        "shop_ids": [
            18,
            14,
            12
        ],
        "closed": true,
        "start_date": "2019-01-31",
        "end_date": "2019-01-31",
        "message": "...",
        "upfront": {
            "type": "default",
            "days": 18,
            "time": "12:00",
            "hours": 17,
            "minutes": 17
        },
        "takeout": {
            "action": "default",
            "custom_hours": [
                {
                    "start": "12:00",
                    "end": "12:00"
                },
                {
                    "start": "12:00",
                    "end": "12:00"
                },
                {
                    "start": "12:00",
                    "end": "12:00"
                }
            ]
        },
        "delivery": {
            "action": "default",
            "custom_hours": [
                {
                    "start": "12:00",
                    "end": "12:00"
                },
                {
                    "start": "12:00",
                    "end": "12:00"
                },
                {
                    "start": "12:00",
                    "end": "12:00"
                }
            ]
        },
        "open": {
            "action": "default",
            "custom_hours": [
                {
                    "start": "12:00",
                    "end": "12:00"
                },
                {
                    "start": "12:00",
                    "end": "12:00"
                },
                {
                    "start": "12:00",
                    "end": "12:00"
                }
            ]
        },
        "id": 17
    },
    {
        "shop_ids": [
            18,
            12,
            13
        ],
        "closed": false,
        "start_date": "2019-01-31",
        "end_date": "2019-01-31",
        "message": "...",
        "upfront": {
            "type": "default",
            "days": 12,
            "time": "12:00",
            "hours": 14,
            "minutes": 18
        },
        "takeout": {
            "action": "default",
            "custom_hours": [
                {
                    "start": "12:00",
                    "end": "12:00"
                },
                {
                    "start": "12:00",
                    "end": "12:00"
                },
                {
                    "start": "12:00",
                    "end": "12:00"
                }
            ]
        },
        "delivery": {
            "action": "default",
            "custom_hours": [
                {
                    "start": "12:00",
                    "end": "12:00"
                },
                {
                    "start": "12:00",
                    "end": "12:00"
                },
                {
                    "start": "12:00",
                    "end": "12:00"
                }
            ]
        },
        "open": {
            "action": "default",
            "custom_hours": [
                {
                    "start": "12:00",
                    "end": "12:00"
                },
                {
                    "start": "12:00",
                    "end": "12:00"
                },
                {
                    "start": "12:00",
                    "end": "12:00"
                }
            ]
        },
        "id": 18
    }
]
1.9.0 stable