POST Holiday Hours for Locations

The POST Holiday Hours endpoint allows partners to define specific days and hours when a store should remain closed due to holidays. This can be useful for managing store hours during festive seasons or special occasions.

Request Body

The request body should be in JSON format and include an array of location objects, each containing the location’s unique identifier (id) and an array of holiday periods during which the store should remain closed.

Deleting Holiday Hours

In order to delete the holiday hours, send an empty "holidays" array [ ].

{
  "locations": [
    {
      "id": "65***********aa56be7b63",
      "holidays": [    
    
      ]
    }
  ]
}
KeyDescriptionType
locationsAn array of holiday periods during which the store should remain closed.array of objects
idThe locationId of the storestring
holidaysAn array of holiday periods during which the store should remain closed.array of objects
startTimeThe start time of the holiday period in ISO 8601 date-time format (e.g., "2023-12-19T15:53:00Z")timestamp
endTimeThe endTime of the holiday period in ISO 8601 date-time format (e.g., "2023-12-19T16:10"00Z")timestamp
Language
Credentials
OAuth2
Click Try It! to start a request and see the response here!