Holiday

Request

Fields when send to the api inside a request.

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

Response

Fields when returned by the api in a response.

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

Examples

Request

When used inside a request.

Example 1

{
    "shop_ids": [
        16,
        16,
        12
    ],
    "closed": false,
    "start_date": "2019-01-31",
    "end_date": "2019-01-31",
    "message": "...",
    "upfront": {
        "type": "default",
        "days": 18,
        "time": "12:00",
        "hours": 16,
        "minutes": 11
    },
    "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"
            }
        ]
    }
}

Response

When returned in a response.

Example 1

{
    "shop_ids": [
        18,
        14,
        19
    ],
    "closed": false,
    "start_date": "2019-01-31",
    "end_date": "2019-01-31",
    "message": "...",
    "upfront": {
        "type": "default",
        "days": 12,
        "time": "12:00",
        "hours": 11,
        "minutes": 19
    },
    "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": 19
}
This is a development version Do not use this version in production
1.10.0 development