Получить доступные интервалы бронирования

GET/public/reservations/{publicHandle}/availability

Рассчитывает доступные гостю интервалы по опубликованным правилам для местной даты заведения, размера группы и необязательного периода обслуживания. Метод публичный, авторизация не требуется.

Авторизация

x-hallify-widget-context: <HALLIFY_STOREFRONT_WIDGET_CONTEXT>

Краткосрочный server-authenticated widget presentation proof. Связывает настроенный frame origin с точными проверенными parent binding и connection authority. Новый widget-спрос требует этот proof; существующие native capabilities сохраняют отдельные права и исходные сроки.

Руководство по подключению

Параметры

publicHandleПуть · Обязательно: Непрозрачный публичный идентификатор канала для поиска опубликованной гостевой конфигурации одного заведения. Не является ключом доступа.
string
Полное определение
{ "type": "string", "example": "example" }
originЗаголовок · Необязательно: Фактический Origin браузерного запроса для проверки текущих прав представления. Обязателен для новых заявок и продолжения через Storefront. Канонические браузерные запросы Hallify используют Origin, настроенный в HALLIFY_PUBLIC_APP_URL. Заголовок передаёт контекст запроса, не авторизует вызывающего и не заменяет соответствующий гостевой ключ.
string · uri
Полное определение
{ "type": "string", "format": "uri", "maxLength": 2048, "example": "https://example.test/resource" }
x-hallify-connection-idЗаголовок · Необязательно: Необязательный несекретный идентификатор соединения для начального разрешения публичного канала. Не предоставляет прав и не заменяет зафиксированные данные выданного доступа.
string · uuid
Полное определение
{ "type": "string", "format": "uuid", "minLength": 36, "maxLength": 36, "example": "9b6163a8-afea-4877-818b-8e2ae28a2845" }
servicePeriodIdПараметр запроса · Необязательно: Необязательный фильтр периода обслуживания: UUID Hallify.
string · uuid
Полное определение
{ "format": "uuid", "type": "string", "example": "9b6163a8-afea-4877-818b-8e2ae28a2845" }
partySizeПараметр запроса · Обязательно: Количество гостей для расчёта вместимости и доступности бронирования.
integer
Полное определение
{ "minimum": 1, "maximum": 99, "type": "integer", "example": 1 }
dateПараметр запроса · Обязательно: Местная бизнес-дата заведения в формате YYYY-MM-DD без времени суток.
string
Полное определение
{ "type": "string", "example": "example" }

Ответы

200Возвращает доступные интервалы публичного бронирования и соответствующие периоды обслуживания.

ReservationAvailabilityDto

Полное определение

{
  "$ref": "#/components/schemas/ReservationAvailabilityDto"
}

Пример ответа · 200 · application/json

[
  {
    "scheduledAt": "2026-01-15T12:00:00.000Z",
    "endsAt": "2026-12-31T18:00:00.000Z",
    "occupancyEndsAt": "2026-12-31T18:00:00.000Z",
    "offset": "example",
    "servicePeriodId": "4846c409-f4df-40f6-81cc-1d7157a5c646"
  }
]

Схемы

ReservationAvailabilityDto

Возвращает доступные сотрудникам интервалы бронирования и контекст вместимости.

Полное определение

{
  "type": "array",
  "items": {
    "type": "object",
    "required": [
      "scheduledAt",
      "endsAt",
      "occupancyEndsAt",
      "offset",
      "servicePeriodId"
    ],
    "properties": {
      "scheduledAt": {
        "type": "string",
        "format": "date-time",
        "description": "Время `scheduledAt` в формате RFC3339; разные часовые смещения могут обозначать один абсолютный момент.",
        "example": "2026-01-15T12:00:00.000Z"
      },
      "endsAt": {
        "type": "string",
        "format": "date-time",
        "description": "Время `endsAt` в формате RFC3339; разные часовые смещения могут обозначать один абсолютный момент.",
        "example": "2026-12-31T18:00:00.000Z"
      },
      "occupancyEndsAt": {
        "type": "string",
        "format": "date-time",
        "description": "Время `occupancyEndsAt` в формате RFC3339; разные часовые смещения могут обозначать один абсолютный момент.",
        "example": "2026-12-31T18:00:00.000Z"
      },
      "offset": {
        "type": "string",
        "description": "Часовое смещение для элемента доступности бронирования.",
        "example": "example"
      },
      "servicePeriodId": {
        "type": "string",
        "format": "uuid",
        "description": "UUID Hallify для `servicePeriodId`.",
        "example": "4846c409-f4df-40f6-81cc-1d7157a5c646"
      }
    },
    "example": {
      "scheduledAt": "2026-01-15T12:00:00.000Z",
      "endsAt": "2026-12-31T18:00:00.000Z",
      "occupancyEndsAt": "2026-12-31T18:00:00.000Z",
      "offset": "example",
      "servicePeriodId": "4846c409-f4df-40f6-81cc-1d7157a5c646"
    }
  },
  "description": "Возвращает доступные сотрудникам интервалы бронирования и контекст вместимости.",
  "example": [
    {
      "scheduledAt": "2026-01-15T12:00:00.000Z",
      "endsAt": "2026-12-31T18:00:00.000Z",
      "occupancyEndsAt": "2026-12-31T18:00:00.000Z",
      "offset": "example",
      "servicePeriodId": "4846c409-f4df-40f6-81cc-1d7157a5c646"
    }
  ]
}

Примеры запросов

Демонстрационные данные. Примеры не отправляют запросы. В своей интеграции подставьте значения, полученные на предыдущих шагах.

cURL

curl --request GET 'https://api.hallify.co/public/reservations/example/availability?servicePeriodId=b7a1b3de-8581-4d78-8597-435227131989&partySize=1&date=example' \
  -H 'origin: https://example.test/resource' \
  -H 'x-hallify-connection-id: c19ce6d1-1d3c-4c48-801b-35468501181c' \
  -H "x-hallify-widget-context: ${HALLIFY_STOREFRONT_WIDGET_CONTEXT}"

Пример ответа

Возвращает доступные интервалы публичного бронирования и соответствующие периоды обслуживания.

Пример ответа · 200 · application/json

[
  {
    "scheduledAt": "2026-01-15T12:00:00.000Z",
    "endsAt": "2026-12-31T18:00:00.000Z",
    "occupancyEndsAt": "2026-12-31T18:00:00.000Z",
    "offset": "example",
    "servicePeriodId": "4846c409-f4df-40f6-81cc-1d7157a5c646"
  }
]