Special hours

Special closures and holiday hours

<p style={{ textAlign: "justify" }}>In the preceding sections the Order API component and the Menu API component are described – and within the Menu API description you will find a description of the hours object:</p>

**hours** (object)

* <p style={{ textAlign: "justify" }}>An object with a key for every day of the week, each key having a value which is an array of objects - each object in that array representing 1 block of time - hours are applicable to item availability across entire Menu object - items with distinct menu availability should be in a Menu object with hours matching that availability - if no hours are provided, this menu is assumed to be available during all open hours of the location - if hours are provided for some days but not others, those omitted days are assumed to have no availability for the items in that menu (i.e. probably closed)</p>

An example can be viewed <a href="https://gist.github.com/ray-checkmate/c7ea9afa9cee5d932b94d663f87eb2a5">here</a>.

<p style={{ textAlign: "justify" }}>But – of course – businesses don’t always adhere to their regular hours, since holidays require a special set of hours and closures. And, we are planning on including special_hours in a planned Open API version 2, that will be the new standard.</p>

<p style={{ textAlign: "justify" }}>In the mean-time, while Open API v2 is still pending, ordering platforms that want to make use of special_hours functionality may do so on a per location basis; if you choose to do so, we just need to be told which locations to toggle the behavior “on” for.</p>

When special\_hours have been enabled for a location...

At the same level of depth in the Menu object as “hours” you will find the special\_hours key pointing to an array of objects like so:

`special_hours:`

![](https://files.readme.io/d0151d5-special_hours.png "special_hours.png")

Here you can see an example special\_hours array of Objects in the context of an example <a href="https://gist.github.com/ray-checkmate/2f3117d6e7312001cf7bd8d0c036bbc2">Menu response object</a>.

**date** – the day that the special hours apply in year-month-day format\
**closed** – a Boolean value that lets you know that:

* the **start\_time** and **end\_time** apply to a situation where the store is open between **start\_time** and **end\_time** if closed is **false** 
* the **start\_time** and **end\_time** apply to a situation where the store is closed between **start\_time** and **end\_time** if closed is **true**

**start\_time** – the beginning of time span block\
**end\_time** – the end of time span block

* <p style={{ textAlign: "justify" }}>Each object in the special_hours array is for 1 time span in a single day. And a single day might have multiple objects, each denoting a distinct time span. For example, a store that is open on Easter from 8am to 10am, and then again on the same day from 8pm to 10pm.</p>