Understanding Holidays

When creating a new location, the default holidays are derived from an internal database.  By default, we set the basic holidays for many countries. Attached are our default holidays for the US. These are the default holidays that will be used when you create a new US based location.

Country            Holiday

United States   New Year's Day

United States   Martin Luther King Jr. Day

United States   Presidents' Day

United States   Memorial Day

United States   Independence Day

United States   Labor Day

United States   Columbus Day

United States   Veterans Day

United States   Thanksgiving Day

United States   Christmas Day

Getting a list of your location’s holidays

In order to see what your current holidays are you can use the locations endpoint. Holidays are stored per location and have unique id’s per location.  You can use either the location setup or the consumer endpoint(s) to access this information.

GET​ /setup​/v1​/locations

GET​ /consumer​/v1​/locations

Changing a Holiday Status from Closed to Opened

If your location is open on any of the default holidays, use the PUT Location Holiday endpoint to make the adjustment. This sets the business holiday to open or closed as needed.

PUT​ /setup​/v1​/locations​/{id}​/holidays​/{holidayId}​/{closed}

Checking Holidays and Calendar Blocks

If you want to check that the Holidays and/or Blocks are being applied properly, use the GET Unavailability endpoint and query the day you are questioning. 

GET​ /consumer​/v1​/availability​/{serviceId}​/{startDate}​/{endDate}​/unavailable

Holidays will have a reason code of “PBH”, Public Business Holiday.

     "reasonCode": "PBH",

     "reason": "Christmas Day"

Changing or setting up Additional Holidays/Close Days

In order to change an existing holiday from Closed to Open, or vice versa, use the following location endpoint.

PUT ​/setup​/v1​/locations​/{id}​/holidays​/{holidayId}​/{closed}

If you need to close your operations on any other day(s), this can be set up by using the calendar block endpoint. This will allow you block days as needed.

POST ​/setup​/v1​/calendars​/{id}​/block

World Wide Holiday Defaults (Note this list is updated frequently)