Перейти к содержимому
HallifyРазработчикамПоиск по документации
Открыть Hallify
Разделы

Партнёрские предзаказы

Получить каталог партнёрских предзаказов

GET/external/preorders/catalog

Возвращает каталог разрешённого ключом канала продаж: доступные партнёру товары, модификаторы, цены и правила исполнения.

Авторизация

Authorization: Bearer <HALLIFY_PREORDER_PARTNER_KEY>

Ключ партнёра с ограниченной областью доступа к предзаказам.

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

Параметры

salesChannelIdПараметр запроса · Обязательно

Обязательный фильтр канала продаж: UUID Hallify.

string · uuid
Полное определение
{
  "format": "uuid",
  "type": "string",
  "example": "9b6163a8-afea-4877-818b-8e2ae28a2845"
}

Ответы

200Возвращает партнёрский каталог для заведения и канала продаж, разрешённых ключом.
PreorderExternalCatalogResultDto
Полное определение
{
  "$ref": "#/components/schemas/PreorderExternalCatalogResultDto"
}
Пример ответа · 200 · application/json
{
  "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"
    }
  ]
}
401Отклоняет отсутствующий, некорректный, истёкший, отозванный или недействительный ключ preorderPartnerKey на границе владеющего домена.
TranslatedErrorDto
Полное определение
{
  "$ref": "#/components/schemas/TranslatedErrorDto"
}
Пример ответа · 401 · application/json
{
  "statusCode": 401,
  "error": "errors:http.unauthorized",
  "code": "HTTP_UNAUTHORIZED",
  "message": "errors:http.unauthorized",
  "translationKey": "errors:http.unauthorized"
}

Схемы

PreorderExternalCatalogResultDto

Возвращает партнёрский каталог для заведения и канала продаж, разрешённых ключом.

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": {
    "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": [
    "salesChannelId",
    "menuVersionId",
    "versionNumber",
    "graphHash",
    "publishedAt",
    "servedAt",
    "categories"
  ],
  "description": "Возвращает партнёрский каталог для заведения и канала продаж, разрешённых ключом.",
  "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"
}
TranslatedErrorDto

Стабильная оболочка ошибки общего обработчика HTTP-исключений. Дополнительные машинные данные домена вложены в details.

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

HTTP-статус, повторённый из ответа.

integer
Полное определение
{
  "type": "integer",
  "description": "HTTP-статус, повторённый из ответа.",
  "example": 400
}
errorОбязательно

Ключ перевода HTTP-категории, например errors:http.conflict. Конкретную причину определяют code и translationKey.

string
Полное определение
{
  "type": "string",
  "description": "Ключ перевода HTTP-категории, например errors:http.conflict. Конкретную причину определяют code и translationKey.",
  "example": "errors.request.invalid"
}
codeОбязательно

Стабильный машинный код домена либо стандартный HTTP_*, если доменный код не задан. Используйте это поле и HTTP-статус для программной логики; локализованная формулировка не управляет повторами или бизнес-решениями.

string
Полное определение
{
  "type": "string",
  "example": "HTTP_BAD_REQUEST",
  "description": "Стабильный машинный код домена либо стандартный HTTP_*, если доменный код не задан. Используйте это поле и HTTP-статус для программной логики; локализованная формулировка не управляет повторами или бизнес-решениями."
}
messageОбязательно

Ключ перевода, идентичный translationKey. API не возвращает локализованный текст интерфейса. Найдите перевод ключа и подставьте translationValues в приложении-потребителе.

string
Полное определение
{
  "type": "string",
  "example": "errors:http.badRequest",
  "description": "Ключ перевода, идентичный translationKey. API не возвращает локализованный текст интерфейса. Найдите перевод ключа и подставьте translationValues в приложении-потребителе."
}
translationKeyОбязательно

Канонический ключ перевода, идентичный message. Ключи errors:http.* соответствующего статуса описывают неуточнённые ошибки. Публичные ключи и пояснения EN/RU перечислены в Developers; неизвестный ключ требует локализованного запасного сообщения в клиенте.

string
Полное определение
{
  "type": "string",
  "example": "errors:http.badRequest",
  "description": "Канонический ключ перевода, идентичный message. Ключи errors:http.* соответствующего статуса описывают неуточнённые ошибки. Публичные ключи и пояснения EN/RU перечислены в Developers; неизвестный ключ требует локализованного запасного сообщения в клиенте."
}
translationValuesНеобязательно

Необязательные скалярные значения параметров шаблона перевода. Обрабатывайте их как данные, экранируйте при отображении и никогда не используйте как настройки переводчика.

object
Полное определение
{
  "type": "object",
  "additionalProperties": {
    "oneOf": [
      {
        "type": "string",
        "example": "example"
      },
      {
        "type": "number",
        "example": 0
      },
      {
        "type": "boolean",
        "example": true
      }
    ],
    "example": "example"
  },
  "description": "Необязательные скалярные значения параметров шаблона перевода. Обрабатывайте их как данные, экранируйте при отображении и никогда не используйте как настройки переводчика.",
  "example": {
    "exampleKey": "example"
  }
}
validationErrorsНеобязательно

Ошибки проверки полей с ключами переводов и стабильными кодами валидаторов. Введённые значения и исходные тексты валидаторов не включаются.

array
Полное определение
{
  "description": "Ошибки проверки полей с ключами переводов и стабильными кодами валидаторов. Введённые значения и исходные тексты валидаторов не включаются.",
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/ValidationErrorDto"
  },
  "example": [
    {
      "field": "email",
      "translationKey": "validation:isEmail",
      "code": "isEmail",
      "message": "validation:isEmail"
    }
  ]
}
detailsНеобязательно

Необязательные сведения о доменных препятствиях или ошибках валидации.

oneOf
Полное определение
{
  "description": "Необязательные сведения о доменных препятствиях или ошибках валидации.",
  "oneOf": [
    {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/JsonValue"
      },
      "example": [
        "example"
      ]
    },
    {
      "type": "object",
      "additionalProperties": {
        "$ref": "#/components/schemas/JsonValue"
      },
      "example": {
        "exampleKey": "example"
      }
    }
  ],
  "example": [
    "example"
  ]
}
Полное определение
{
  "type": "object",
  "properties": {
    "statusCode": {
      "type": "integer",
      "description": "HTTP-статус, повторённый из ответа.",
      "example": 400
    },
    "error": {
      "type": "string",
      "description": "Ключ перевода HTTP-категории, например errors:http.conflict. Конкретную причину определяют code и translationKey.",
      "example": "errors.request.invalid"
    },
    "code": {
      "type": "string",
      "example": "HTTP_BAD_REQUEST",
      "description": "Стабильный машинный код домена либо стандартный HTTP_*, если доменный код не задан. Используйте это поле и HTTP-статус для программной логики; локализованная формулировка не управляет повторами или бизнес-решениями."
    },
    "message": {
      "type": "string",
      "example": "errors:http.badRequest",
      "description": "Ключ перевода, идентичный translationKey. API не возвращает локализованный текст интерфейса. Найдите перевод ключа и подставьте translationValues в приложении-потребителе."
    },
    "translationKey": {
      "type": "string",
      "example": "errors:http.badRequest",
      "description": "Канонический ключ перевода, идентичный message. Ключи errors:http.* соответствующего статуса описывают неуточнённые ошибки. Публичные ключи и пояснения EN/RU перечислены в Developers; неизвестный ключ требует локализованного запасного сообщения в клиенте."
    },
    "translationValues": {
      "type": "object",
      "additionalProperties": {
        "oneOf": [
          {
            "type": "string",
            "example": "example"
          },
          {
            "type": "number",
            "example": 0
          },
          {
            "type": "boolean",
            "example": true
          }
        ],
        "example": "example"
      },
      "description": "Необязательные скалярные значения параметров шаблона перевода. Обрабатывайте их как данные, экранируйте при отображении и никогда не используйте как настройки переводчика.",
      "example": {
        "exampleKey": "example"
      }
    },
    "validationErrors": {
      "description": "Ошибки проверки полей с ключами переводов и стабильными кодами валидаторов. Введённые значения и исходные тексты валидаторов не включаются.",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ValidationErrorDto"
      },
      "example": [
        {
          "field": "email",
          "translationKey": "validation:isEmail",
          "code": "isEmail",
          "message": "validation:isEmail"
        }
      ]
    },
    "details": {
      "description": "Необязательные сведения о доменных препятствиях или ошибках валидации.",
      "oneOf": [
        {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/JsonValue"
          },
          "example": [
            "example"
          ]
        },
        {
          "type": "object",
          "additionalProperties": {
            "$ref": "#/components/schemas/JsonValue"
          },
          "example": {
            "exampleKey": "example"
          }
        }
      ],
      "example": [
        "example"
      ]
    }
  },
  "required": [
    "statusCode",
    "error",
    "code",
    "message",
    "translationKey"
  ],
  "description": "Стабильная оболочка ошибки общего обработчика HTTP-исключений. Дополнительные машинные данные домена вложены в details.",
  "example": {
    "statusCode": 400,
    "error": "errors:http.badRequest",
    "code": "HTTP_BAD_REQUEST",
    "message": "errors:http.badRequest",
    "translationKey": "errors:http.badRequest"
  }
}
ValidationErrorDto

Ошибка проверки поля с путём поля, стабильным кодом валидатора и ключом перевода. Человекочитаемый текст принадлежит приложению-потребителю.

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

Публичный путь поля. Вложенные свойства и индексы массива разделены точками.

string
Полное определение
{
  "type": "string",
  "example": "email",
  "description": "Публичный путь поля. Вложенные свойства и индексы массива разделены точками."
}
translationKeyОбязательно

Ключ перевода этого валидатора, идентичный message. Найдите его в клиентском словаре; см. публичный каталог ошибок Developers.

string
Полное определение
{
  "type": "string",
  "example": "validation:isEmail",
  "description": "Ключ перевода этого валидатора, идентичный message. Найдите его в клиентском словаре; см. публичный каталог ошибок Developers."
}
codeОбязательно

Стабильный идентификатор валидатора для ошибки поля. Пользовательские валидаторы могут определять дополнительные идентификаторы.

string
Полное определение
{
  "type": "string",
  "example": "isEmail",
  "description": "Стабильный идентификатор валидатора для ошибки поля. Пользовательские валидаторы могут определять дополнительные идентификаторы."
}
messageОбязательно

Ключ перевода, описывающий ошибку проверки поля, идентичный translationKey. Введённые значения и тексты валидаторов не включаются.

string
Полное определение
{
  "type": "string",
  "example": "validation:isEmail",
  "description": "Ключ перевода, описывающий ошибку проверки поля, идентичный translationKey. Введённые значения и тексты валидаторов не включаются."
}
translationValuesНеобязательно

Необязательные скалярные значения параметров шаблона перевода. Обрабатывайте их как данные, экранируйте при отображении и никогда не используйте как настройки переводчика.

object
Полное определение
{
  "type": "object",
  "additionalProperties": {
    "oneOf": [
      {
        "type": "string",
        "example": "example"
      },
      {
        "type": "number",
        "example": 0
      },
      {
        "type": "boolean",
        "example": true
      }
    ],
    "example": "example"
  },
  "description": "Необязательные скалярные значения параметров шаблона перевода. Обрабатывайте их как данные, экранируйте при отображении и никогда не используйте как настройки переводчика.",
  "example": {
    "exampleKey": "example"
  }
}
Полное определение
{
  "type": "object",
  "properties": {
    "field": {
      "type": "string",
      "example": "email",
      "description": "Публичный путь поля. Вложенные свойства и индексы массива разделены точками."
    },
    "translationKey": {
      "type": "string",
      "example": "validation:isEmail",
      "description": "Ключ перевода этого валидатора, идентичный message. Найдите его в клиентском словаре; см. публичный каталог ошибок Developers."
    },
    "code": {
      "type": "string",
      "example": "isEmail",
      "description": "Стабильный идентификатор валидатора для ошибки поля. Пользовательские валидаторы могут определять дополнительные идентификаторы."
    },
    "message": {
      "type": "string",
      "example": "validation:isEmail",
      "description": "Ключ перевода, описывающий ошибку проверки поля, идентичный translationKey. Введённые значения и тексты валидаторов не включаются."
    },
    "translationValues": {
      "type": "object",
      "additionalProperties": {
        "oneOf": [
          {
            "type": "string",
            "example": "example"
          },
          {
            "type": "number",
            "example": 0
          },
          {
            "type": "boolean",
            "example": true
          }
        ],
        "example": "example"
      },
      "description": "Необязательные скалярные значения параметров шаблона перевода. Обрабатывайте их как данные, экранируйте при отображении и никогда не используйте как настройки переводчика.",
      "example": {
        "exampleKey": "example"
      }
    }
  },
  "required": [
    "field",
    "translationKey",
    "code",
    "message"
  ],
  "description": "Ошибка проверки поля с путём поля, стабильным кодом валидатора и ключом перевода. Человекочитаемый текст принадлежит приложению-потребителю.",
  "example": {
    "field": "email",
    "translationKey": "validation:isEmail",
    "code": "isEmail",
    "message": "validation:isEmail"
  }
}

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

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