Перейти к содержимому
Разделы

Гостевые предзаказы

Получить публичный каталог предзаказов

GET/public/preorders/{publicHandle}/catalog

Возвращает опубликованный каталог предзаказов заведения, правила исполнения и доступность товаров для гостя с разрешённым Origin. Метод публичный, авторизация не требуется.

Авторизация

Учётная запись Hallify не требуется. Соблюдайте предварительные условия и ограничения этого метода.

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

Параметры

publicHandleПуть · Обязательно

Непрозрачный публичный идентификатор канала для поиска опубликованной гостевой конфигурации одного заведения. Не является ключом доступа.

string
Полное определение
{
  "type": "string",
  "example": "example"
}
originЗаголовок · Обязательно

Origin браузера проверяется по разрешённым источникам публичного канала. Отсутствующий или запрещённый Origin отклоняется без раскрытия закрытой конфигурации заведения.

string
Полное определение
{
  "type": "string",
  "example": "example"
}

Ответы

200Возвращает публичный канал предзаказов и доступное представление каталога.
PreorderPublicCatalogResultDto
Полное определение
{
  "$ref": "#/components/schemas/PreorderPublicCatalogResultDto"
}
Пример ответа · 200 · application/json
{
  "publicHandle": "example",
  "venue": {
    "id": "fbc6db41-f1c2-4f74-862d-210bd28ee2a0",
    "name": "Example name",
    "timeZone": "Asia/Tbilisi"
  },
  "termsVersion": "example",
  "privacyVersion": "example",
  "salesChannelId": "ff0fa725-ba44-4e7a-82bb-a15650e0a0cc",
  "menuVersionId": "490ccfcb-caa6-472e-836a-a8416e8cee92",
  "versionNumber": 1,
  "graphHash": null,
  "publishedAt": "2026-01-15T12:00:00.000Z",
  "servedAt": "2026-01-15T12:00:00.000Z",
  "categories": [
    {
      "exampleKey": "example"
    }
  ]
}

Схемы

PreorderPublicCatalogResultDto

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

publicHandleОбязательно

Публичный идентификатор канала publicHandle.

string
Полное определение
{
  "type": "string",
  "description": "Публичный идентификатор канала `publicHandle`.",
  "example": "example"
}
venueОбязательно

Вложенные сведения venue; состав полей указан в схеме.

object
Полное определение
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "UUID Hallify для `id`.",
      "example": "fbc6db41-f1c2-4f74-862d-210bd28ee2a0"
    },
    "name": {
      "type": "string",
      "description": "Понятное человеку значение `name`.",
      "example": "Example name"
    },
    "timeZone": {
      "type": "string",
      "description": "Идентификатор часового пояса IANA в `timeZone` для трактовки местных дат и времени заведения.",
      "example": "Asia/Tbilisi"
    }
  },
  "required": [
    "id",
    "name",
    "timeZone"
  ],
  "description": "Вложенные сведения `venue`; состав полей указан в схеме.",
  "example": {
    "id": "fbc6db41-f1c2-4f74-862d-210bd28ee2a0",
    "name": "Example name",
    "timeZone": "Asia/Tbilisi"
  }
}
termsVersionОбязательно

Версия условий termsVersion.

string
Полное определение
{
  "type": "string",
  "description": "Версия условий `termsVersion`.",
  "example": "example"
}
privacyVersionОбязательно

Версия уведомления о персональных данных privacyVersion.

string
Полное определение
{
  "type": "string",
  "description": "Версия уведомления о персональных данных `privacyVersion`.",
  "example": "example"
}
salesChannelIdОбязательно

UUID Hallify для salesChannelId.

string · uuid
Полное определение
{
  "type": "string",
  "format": "uuid",
  "description": "UUID Hallify для `salesChannelId`.",
  "example": "ff0fa725-ba44-4e7a-82bb-a15650e0a0cc"
}
menuVersionIdОбязательно

UUID Hallify для menuVersionId.

string · uuid
Полное определение
{
  "type": "string",
  "format": "uuid",
  "description": "UUID Hallify для `menuVersionId`.",
  "example": "490ccfcb-caa6-472e-836a-a8416e8cee92"
}
versionNumberОбязательно

Целочисленное значение versionNumber. Ограничения: минимум 1.

integer
Полное определение
{
  "type": "integer",
  "minimum": 1,
  "description": "Целочисленное значение `versionNumber`. Ограничения: минимум 1.",
  "example": 1
}
graphHashОбязательно

Непрозрачный отпечаток graphHash точной опубликованной структуры меню. Клиенты сравнивают его для обнаружения изменений структуры. Null означает отсутствие записанного значения в этом представлении.

string · null
Полное определение
{
  "type": "string",
  "nullable": true,
  "description": "Непрозрачный отпечаток `graphHash` точной опубликованной структуры меню. Клиенты сравнивают его для обнаружения изменений структуры. Null означает отсутствие записанного значения в этом представлении.",
  "example": "deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef"
}
publishedAtОбязательно

Время publishedAt в формате RFC3339; разные часовые смещения могут обозначать один абсолютный момент.

string · date-time
Полное определение
{
  "type": "string",
  "format": "date-time",
  "description": "Время `publishedAt` в формате RFC3339; разные часовые смещения могут обозначать один абсолютный момент.",
  "example": "2026-01-15T12:00:00.000Z"
}
servedAtОбязательно

Время servedAt в формате RFC3339; разные часовые смещения могут обозначать один абсолютный момент.

string · date-time
Полное определение
{
  "type": "string",
  "format": "date-time",
  "description": "Время `servedAt` в формате RFC3339; разные часовые смещения могут обозначать один абсолютный момент.",
  "example": "2026-01-15T12:00:00.000Z"
}
categoriesОбязательно

Коллекция categories в составе представления.

array
Полное определение
{
  "type": "array",
  "items": {
    "type": "object",
    "additionalProperties": {
      "$ref": "#/components/schemas/JsonValue"
    },
    "example": {
      "exampleKey": "example"
    }
  },
  "description": "Коллекция `categories` в составе представления.",
  "example": [
    {
      "exampleKey": "example"
    }
  ]
}
Полное определение
{
  "type": "object",
  "properties": {
    "publicHandle": {
      "type": "string",
      "description": "Публичный идентификатор канала `publicHandle`.",
      "example": "example"
    },
    "venue": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid",
          "description": "UUID Hallify для `id`.",
          "example": "fbc6db41-f1c2-4f74-862d-210bd28ee2a0"
        },
        "name": {
          "type": "string",
          "description": "Понятное человеку значение `name`.",
          "example": "Example name"
        },
        "timeZone": {
          "type": "string",
          "description": "Идентификатор часового пояса IANA в `timeZone` для трактовки местных дат и времени заведения.",
          "example": "Asia/Tbilisi"
        }
      },
      "required": [
        "id",
        "name",
        "timeZone"
      ],
      "description": "Вложенные сведения `venue`; состав полей указан в схеме.",
      "example": {
        "id": "fbc6db41-f1c2-4f74-862d-210bd28ee2a0",
        "name": "Example name",
        "timeZone": "Asia/Tbilisi"
      }
    },
    "termsVersion": {
      "type": "string",
      "description": "Версия условий `termsVersion`.",
      "example": "example"
    },
    "privacyVersion": {
      "type": "string",
      "description": "Версия уведомления о персональных данных `privacyVersion`.",
      "example": "example"
    },
    "salesChannelId": {
      "type": "string",
      "format": "uuid",
      "description": "UUID Hallify для `salesChannelId`.",
      "example": "ff0fa725-ba44-4e7a-82bb-a15650e0a0cc"
    },
    "menuVersionId": {
      "type": "string",
      "format": "uuid",
      "description": "UUID Hallify для `menuVersionId`.",
      "example": "490ccfcb-caa6-472e-836a-a8416e8cee92"
    },
    "versionNumber": {
      "type": "integer",
      "minimum": 1,
      "description": "Целочисленное значение `versionNumber`. Ограничения: минимум 1.",
      "example": 1
    },
    "graphHash": {
      "type": "string",
      "nullable": true,
      "description": "Непрозрачный отпечаток `graphHash` точной опубликованной структуры меню. Клиенты сравнивают его для обнаружения изменений структуры. Null означает отсутствие записанного значения в этом представлении.",
      "example": "deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef"
    },
    "publishedAt": {
      "type": "string",
      "format": "date-time",
      "description": "Время `publishedAt` в формате RFC3339; разные часовые смещения могут обозначать один абсолютный момент.",
      "example": "2026-01-15T12:00:00.000Z"
    },
    "servedAt": {
      "type": "string",
      "format": "date-time",
      "description": "Время `servedAt` в формате RFC3339; разные часовые смещения могут обозначать один абсолютный момент.",
      "example": "2026-01-15T12:00:00.000Z"
    },
    "categories": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": {
          "$ref": "#/components/schemas/JsonValue"
        },
        "example": {
          "exampleKey": "example"
        }
      },
      "description": "Коллекция `categories` в составе представления.",
      "example": [
        {
          "exampleKey": "example"
        }
      ]
    }
  },
  "required": [
    "publicHandle",
    "venue",
    "termsVersion",
    "privacyVersion",
    "salesChannelId",
    "menuVersionId",
    "versionNumber",
    "graphHash",
    "publishedAt",
    "servedAt",
    "categories"
  ],
  "description": "Возвращает публичный канал предзаказов и доступное представление каталога.",
  "example": {
    "publicHandle": "example",
    "venue": {
      "id": "fbc6db41-f1c2-4f74-862d-210bd28ee2a0",
      "name": "Example name",
      "timeZone": "Asia/Tbilisi"
    },
    "termsVersion": "example",
    "privacyVersion": "example",
    "salesChannelId": "ff0fa725-ba44-4e7a-82bb-a15650e0a0cc",
    "menuVersionId": "490ccfcb-caa6-472e-836a-a8416e8cee92",
    "versionNumber": 1,
    "graphHash": null,
    "publishedAt": "2026-01-15T12:00:00.000Z",
    "servedAt": "2026-01-15T12:00:00.000Z",
    "categories": [
      {
        "exampleKey": "example"
      }
    ]
  }
}
JsonValue

Рекурсивно допустимое JSON-значение. Используется только там, где контракт явно разрешает произвольные структурированные данные.

Полное определение
{
  "oneOf": [
    {
      "type": "string",
      "nullable": true,
      "example": "example"
    },
    {
      "type": "number",
      "example": 0
    },
    {
      "type": "boolean",
      "example": true
    },
    {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/JsonValue"
      },
      "example": [
        "example"
      ]
    },
    {
      "type": "object",
      "additionalProperties": {
        "$ref": "#/components/schemas/JsonValue"
      },
      "example": {
        "exampleKey": "example"
      }
    }
  ],
  "description": "Рекурсивно допустимое JSON-значение. Используется только там, где контракт явно разрешает произвольные структурированные данные.",
  "example": "example"
}

Hallify использует обязательные cookies и опциональную аналитику.

Обязательные cookies поддерживают вход, язык и тему. Аналитика выключена, пока вы явно ее не разрешите.