GET /locations/channels/{locationId}/holidays
Bearer auth

Retrieve information on holiday hours for a specific location and channels.

Path parameters

  • locationId string Required

    Unique location Id

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • id string Required

      Unique location Id

    • holidays array[object] Required
      Hide holidays attributes Show holidays attributes object
      • startTime string
      • endTime string
    • channels array[object]

      An array of channel link objects within the location with specific holiday hours set

      Hide channels attributes Show channels attributes object
      • id string

        The unique store identifier channelLinkId

      • holidays array[object]

        Array containing an object list of holidays

        Hide holidays attributes Show holidays attributes object
        • startTime string

          The start time of the holiday period in ISO 8601 date-time format (e.g., "2023-12-19T15:53:00Z")

        • endTime string

          The endTime of the holiday period in ISO 8601 date-time format (e.g., "2023-12-19T16:10"00Z")
  • 400 application/json

    Bad Request
GET /locations/channels/{locationId}/holidays 
curl \
 --request GET 'https://api.staging.deliverect.com/locations/channels/{locationId}/holidays' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "id": "63********************a7",
  "holidays": [
    {
      "startTime": "YYYY-MM-DDTHH:mm:ss.SSSSSSZ",
      "endTime": "YYYY-MM-DDTHH:mm:ss.SSSSSSZ"
    }
  ],
  "channels": [
    {
      "id": "63********************a7",
      "holidays": [
        {
          "startTime": "YYYY-MM-DDTHH:mm:ss.SSSSSSZ",
          "endTime": "YYYY-MM-DDTHH:mm:ss.SSSSSSZ"
        },
        {
          "startTime": "YYYY-MM-DDTHH:mm:ss.SSSSSSZ",
          "endTime": "YYYY-MM-DDTHH:mm:ss.SSSSSSZ"
        },
        {
          "startTime": "YYYY-MM-DDTHH:mm:ss.SSSSSSZ",
          "endTime": "YYYY-MM-DDTHH:mm:ss.SSSSSSZ"
        },
        {
          "startTime": "YYYY-MM-DDTHH:mm:ss.SSSSSSZ",
          "endTime": "YYYY-MM-DDTHH:mm:ss.SSSSSSZ"
        }
      ]
    }
  ]
}
Response examples (400) 
{}