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

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

Создать зашифрованный публичный черновик предзаказа

POST/public/preorders/{publicHandle}/drafts

Создаёт кратковременную зашифрованную корзину и процесс подтверждения контакта по правилам заведения, без создания заказа. Начальный метод публичный; дальнейший доступ защищён возвращённым токеном черновика. Обязательный Idempotency-Key возвращает сохранённые статус и тело при повторе того же запроса; повторное использование ключа с другим телом возвращает 409.

Авторизация

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

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

Параметры

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

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

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

Обязательный ключ идемпотентности длиной до 128 символов.

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

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

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

Тело запроса

Обязательно

Создаёт кратковременную зашифрованную корзину и процесс подтверждения контакта по правилам заведения, без создания заказа. Начальный метод публичный; дальнейший доступ защищён возвращённым токеном черновика.

application/json

CreatePublicPreorderDraftDto
Полное определение
{
  "$ref": "#/components/schemas/CreatePublicPreorderDraftDto"
}

Ответы

201Возвращает ссылочный идентификатор черновика, срок действия, маскированное состояние проверки и токен черновика.
PreorderPublicCreateDraftResultDto
Полное определение
{
  "$ref": "#/components/schemas/PreorderPublicCreateDraftResultDto"
}
Пример ответа · 201 · application/json
{
  "draftReference": "example-reference",
  "resumeToken": "synthetic-example-credential",
  "status": "PENDING_VERIFICATION",
  "verificationId": "904a18d4-c890-4387-8e14-bc52c879c7ff",
  "verificationExpiresAt": "2026-12-31T18:00:00.000Z",
  "expiresAt": "2026-12-31T18:00:00.000Z"
}
409Ключ идемпотентности уже обрабатывается или повторно использован с другим телом.
IdempotencyConflictError
Полное определение
{
  "$ref": "#/components/schemas/IdempotencyConflictError"
}
Пример ответа · 409 · application/json
{
  "statusCode": 409,
  "error": "errors:http.conflict",
  "code": "IDEMPOTENCY_REQUEST_IN_PROGRESS",
  "message": "errors:idempotency.inProgress",
  "translationKey": "errors:idempotency.inProgress"
}

Схемы

CreatePublicPreorderDraftDto

Создаёт кратковременную зашифрованную корзину и процесс подтверждения контакта по опубликованным правилам заведения, без создания заказа.

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

Допустимые значения serviceMode: DINE_IN, PICKUP, DELIVERY, CATERING.

string
Полное определение
{
  "type": "string",
  "enum": [
    "DINE_IN",
    "PICKUP",
    "DELIVERY",
    "CATERING"
  ],
  "description": "Допустимые значения `serviceMode`: DINE_IN, PICKUP, DELIVERY, CATERING.",
  "example": "DINE_IN"
}
scheduledForОбязательно

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

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

Целочисленное значение partySize. Ограничения: минимум 1; максимум 10000.

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

Понятное человеку значение contactName.

string
Полное определение
{
  "type": "string",
  "description": "Понятное человеку значение `contactName`.",
  "example": "Example name"
}
contactPhoneНеобязательно

Номер телефона contactPhone. Null означает отсутствие записанного значения в этом представлении.

string · null
Полное определение
{
  "type": "string",
  "nullable": true,
  "description": "Номер телефона `contactPhone`. Null означает отсутствие записанного значения в этом представлении.",
  "example": "+995555000000"
}
contactEmailНеобязательно

Адрес электронной почты contactEmail. Null означает отсутствие записанного значения в этом представлении.

string · email · null
Полное определение
{
  "type": "string",
  "nullable": true,
  "description": "Адрес электронной почты `contactEmail`. Null означает отсутствие записанного значения в этом представлении.",
  "format": "email",
  "example": "user@example.test"
}
addressLine1Необязательно

Основная строка почтового адреса addressLine1. Null означает отсутствие записанного значения в этом представлении.

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

Необязательные дополнительные сведения адреса addressLine2: помещение, этаж или корпус. Null означает отсутствие записанного значения в этом представлении.

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

Город или населённый пункт адреса city. Null означает отсутствие записанного значения в этом представлении.

string · null
Полное определение
{
  "type": "string",
  "nullable": true,
  "description": "Город или населённый пункт адреса `city`. Null означает отсутствие записанного значения в этом представлении.",
  "example": "example"
}
regionНеобязательно

Регион, штат или административная единица region. Null означает отсутствие записанного значения в этом представлении.

string · null
Полное определение
{
  "type": "string",
  "nullable": true,
  "description": "Регион, штат или административная единица `region`. Null означает отсутствие записанного значения в этом представлении.",
  "example": "example"
}
postalCodeНеобязательно

Стабильный код postalCode для классификации или идентификации. Null означает отсутствие записанного значения в этом представлении.

string · null
Полное определение
{
  "type": "string",
  "nullable": true,
  "description": "Стабильный код `postalCode` для классификации или идентификации. Null означает отсутствие записанного значения в этом представлении.",
  "example": "EXAMPLE"
}
countryCodeНеобязательно

Стабильный код countryCode для классификации или идентификации. Null означает отсутствие записанного значения в этом представлении.

string · null
Полное определение
{
  "type": "string",
  "nullable": true,
  "description": "Стабильный код `countryCode` для классификации или идентификации. Null означает отсутствие записанного значения в этом представлении.",
  "example": "GE"
}
administrativeDivisionIdНеобязательно

UUID Hallify для administrativeDivisionId. Null означает отсутствие записанного значения в этом представлении.

string · uuid · null
Полное определение
{
  "type": "string",
  "format": "uuid",
  "nullable": true,
  "description": "UUID Hallify для `administrativeDivisionId`. Null означает отсутствие записанного значения в этом представлении.",
  "example": "c8efbc76-614d-4a79-8f15-db6d48283d46"
}
localityIdНеобязательно

UUID Hallify для localityId. Null означает отсутствие записанного значения в этом представлении.

string · uuid · null
Полное определение
{
  "type": "string",
  "format": "uuid",
  "nullable": true,
  "description": "UUID Hallify для `localityId`. Null означает отсутствие записанного значения в этом представлении.",
  "example": "1bfa5864-39f3-4647-8093-42aea5d9d046"
}
postalCodeIdНеобязательно

UUID Hallify для postalCodeId. Null означает отсутствие записанного значения в этом представлении.

string · uuid · null
Полное определение
{
  "type": "string",
  "format": "uuid",
  "nullable": true,
  "description": "UUID Hallify для `postalCodeId`. Null означает отсутствие записанного значения в этом представлении.",
  "example": "7424d59b-d459-4e7b-8cbc-7f5222274f26"
}
latitudeНеобязательно

Числовое значение latitude, допускающее дроби. Ограничения: минимум -90; максимум 90. Null означает отсутствие записанного значения в этом представлении.

number · null
Полное определение
{
  "type": "number",
  "minimum": -90,
  "maximum": 90,
  "nullable": true,
  "description": "Числовое значение `latitude`, допускающее дроби. Ограничения: минимум -90; максимум 90. Null означает отсутствие записанного значения в этом представлении.",
  "example": 41.7151
}
longitudeНеобязательно

Числовое значение longitude, допускающее дроби. Ограничения: минимум -180; максимум 180. Null означает отсутствие записанного значения в этом представлении.

number · null
Полное определение
{
  "type": "number",
  "minimum": -180,
  "maximum": 180,
  "nullable": true,
  "description": "Числовое значение `longitude`, допускающее дроби. Ограничения: минимум -180; максимум 180. Null означает отсутствие записанного значения в этом представлении.",
  "example": 44.8271
}
coordinateSourceНеобязательно

Допустимые значения coordinateSource: STAFF, EXTERNAL_CLIENT, GEOREFERENCE_CENTROID. Null означает отсутствие записанного значения в этом представлении.

string · null
Полное определение
{
  "type": "string",
  "enum": [
    "STAFF",
    "EXTERNAL_CLIENT",
    "GEOREFERENCE_CENTROID",
    null
  ],
  "nullable": true,
  "description": "Допустимые значения `coordinateSource`: STAFF, EXTERNAL_CLIENT, GEOREFERENCE_CENTROID. Null означает отсутствие записанного значения в этом представлении.",
  "example": "STAFF"
}
coordinateAccuracyНеобязательно

Целочисленное значение coordinateAccuracy. Ограничения: минимум 0; максимум 10. Null означает отсутствие записанного значения в этом представлении.

integer · null
Полное определение
{
  "type": "integer",
  "minimum": 0,
  "maximum": 10,
  "nullable": true,
  "description": "Целочисленное значение `coordinateAccuracy`. Ограничения: минимум 0; максимум 10. Null означает отсутствие записанного значения в этом представлении.",
  "example": 0
}
deliveryInstructionsНеобязательно

Указания для доставки deliveryInstructions. Null означает отсутствие записанного значения в этом представлении.

string · null
Полное определение
{
  "type": "string",
  "nullable": true,
  "description": "Указания для доставки `deliveryInstructions`. Null означает отсутствие записанного значения в этом представлении.",
  "example": "example"
}
noteНеобязательно

Заметка note, введённая человеком и сохранённая с записью. Null означает отсутствие записанного значения в этом представлении.

string · null
Полное определение
{
  "type": "string",
  "nullable": true,
  "description": "Заметка `note`, введённая человеком и сохранённая с записью. Null означает отсутствие записанного значения в этом представлении.",
  "example": "Synthetic example"
}
capacityOverrideReasonНеобязательно

Причина явного превышения вместимости, указанная менеджером. Требуется право preorders.override.

string
Полное определение
{
  "type": "string",
  "description": "Причина явного превышения вместимости, указанная менеджером. Требуется право preorders.override.",
  "minLength": 1,
  "maxLength": 1000,
  "example": "Synthetic example"
}
salesChannelIdОбязательно

UUID Hallify для salesChannelId.

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

UUID Hallify для clientMenuVersionId.

string · uuid
Полное определение
{
  "type": "string",
  "format": "uuid",
  "description": "UUID Hallify для `clientMenuVersionId`.",
  "example": "cd2f2c2a-ba73-4579-8e32-52da8388fd05"
}
clientGraphHashОбязательно

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

string
Полное определение
{
  "type": "string",
  "description": "Непрозрачный токен структуры, возвращённый методом опубликованного меню.",
  "pattern": "^menu-cost-v1\\.graph\\.[A-Za-z0-9_-]{43}$",
  "example": "menu-cost-v1.graph.aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}
itemsОбязательно

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

array
Полное определение
{
  "minItems": 1,
  "maxItems": 100,
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/PreorderCartLineDto"
  },
  "description": "Коллекция `items` в составе представления.",
  "example": [
    {
      "clientLineId": "example-id",
      "quantity": 1
    }
  ]
}
termsVersionОбязательно

Версия условий termsVersion. Ограничения: минимальная длина 1; максимальная длина 64.

string
Полное определение
{
  "type": "string",
  "minLength": 1,
  "maxLength": 64,
  "description": "Версия условий `termsVersion`. Ограничения: минимальная длина 1; максимальная длина 64.",
  "example": "example"
}
privacyVersionОбязательно

Версия уведомления о персональных данных privacyVersion. Ограничения: минимальная длина 1; максимальная длина 64.

string
Полное определение
{
  "type": "string",
  "minLength": 1,
  "maxLength": 64,
  "description": "Версия уведомления о персональных данных `privacyVersion`. Ограничения: минимальная длина 1; максимальная длина 64.",
  "example": "example"
}
Полное определение
{
  "type": "object",
  "properties": {
    "serviceMode": {
      "type": "string",
      "enum": [
        "DINE_IN",
        "PICKUP",
        "DELIVERY",
        "CATERING"
      ],
      "description": "Допустимые значения `serviceMode`: DINE_IN, PICKUP, DELIVERY, CATERING.",
      "example": "DINE_IN"
    },
    "scheduledFor": {
      "type": "string",
      "format": "date-time",
      "description": "Время `scheduledFor` в формате RFC3339; разные часовые смещения могут обозначать один абсолютный момент.",
      "example": "2026-01-15T12:00:00.000Z"
    },
    "partySize": {
      "type": "integer",
      "minimum": 1,
      "maximum": 10000,
      "description": "Целочисленное значение `partySize`. Ограничения: минимум 1; максимум 10000.",
      "example": 1
    },
    "contactName": {
      "type": "string",
      "description": "Понятное человеку значение `contactName`.",
      "example": "Example name"
    },
    "contactPhone": {
      "type": "string",
      "nullable": true,
      "description": "Номер телефона `contactPhone`. Null означает отсутствие записанного значения в этом представлении.",
      "example": "+995555000000"
    },
    "contactEmail": {
      "type": "string",
      "nullable": true,
      "description": "Адрес электронной почты `contactEmail`. Null означает отсутствие записанного значения в этом представлении.",
      "format": "email",
      "example": "user@example.test"
    },
    "addressLine1": {
      "type": "string",
      "nullable": true,
      "description": "Основная строка почтового адреса `addressLine1`. Null означает отсутствие записанного значения в этом представлении.",
      "example": "example"
    },
    "addressLine2": {
      "type": "string",
      "nullable": true,
      "description": "Необязательные дополнительные сведения адреса `addressLine2`: помещение, этаж или корпус. Null означает отсутствие записанного значения в этом представлении.",
      "example": "example"
    },
    "city": {
      "type": "string",
      "nullable": true,
      "description": "Город или населённый пункт адреса `city`. Null означает отсутствие записанного значения в этом представлении.",
      "example": "example"
    },
    "region": {
      "type": "string",
      "nullable": true,
      "description": "Регион, штат или административная единица `region`. Null означает отсутствие записанного значения в этом представлении.",
      "example": "example"
    },
    "postalCode": {
      "type": "string",
      "nullable": true,
      "description": "Стабильный код `postalCode` для классификации или идентификации. Null означает отсутствие записанного значения в этом представлении.",
      "example": "EXAMPLE"
    },
    "countryCode": {
      "type": "string",
      "nullable": true,
      "description": "Стабильный код `countryCode` для классификации или идентификации. Null означает отсутствие записанного значения в этом представлении.",
      "example": "GE"
    },
    "administrativeDivisionId": {
      "type": "string",
      "format": "uuid",
      "nullable": true,
      "description": "UUID Hallify для `administrativeDivisionId`. Null означает отсутствие записанного значения в этом представлении.",
      "example": "c8efbc76-614d-4a79-8f15-db6d48283d46"
    },
    "localityId": {
      "type": "string",
      "format": "uuid",
      "nullable": true,
      "description": "UUID Hallify для `localityId`. Null означает отсутствие записанного значения в этом представлении.",
      "example": "1bfa5864-39f3-4647-8093-42aea5d9d046"
    },
    "postalCodeId": {
      "type": "string",
      "format": "uuid",
      "nullable": true,
      "description": "UUID Hallify для `postalCodeId`. Null означает отсутствие записанного значения в этом представлении.",
      "example": "7424d59b-d459-4e7b-8cbc-7f5222274f26"
    },
    "latitude": {
      "type": "number",
      "minimum": -90,
      "maximum": 90,
      "nullable": true,
      "description": "Числовое значение `latitude`, допускающее дроби. Ограничения: минимум -90; максимум 90. Null означает отсутствие записанного значения в этом представлении.",
      "example": 41.7151
    },
    "longitude": {
      "type": "number",
      "minimum": -180,
      "maximum": 180,
      "nullable": true,
      "description": "Числовое значение `longitude`, допускающее дроби. Ограничения: минимум -180; максимум 180. Null означает отсутствие записанного значения в этом представлении.",
      "example": 44.8271
    },
    "coordinateSource": {
      "type": "string",
      "enum": [
        "STAFF",
        "EXTERNAL_CLIENT",
        "GEOREFERENCE_CENTROID",
        null
      ],
      "nullable": true,
      "description": "Допустимые значения `coordinateSource`: STAFF, EXTERNAL_CLIENT, GEOREFERENCE_CENTROID. Null означает отсутствие записанного значения в этом представлении.",
      "example": "STAFF"
    },
    "coordinateAccuracy": {
      "type": "integer",
      "minimum": 0,
      "maximum": 10,
      "nullable": true,
      "description": "Целочисленное значение `coordinateAccuracy`. Ограничения: минимум 0; максимум 10. Null означает отсутствие записанного значения в этом представлении.",
      "example": 0
    },
    "deliveryInstructions": {
      "type": "string",
      "nullable": true,
      "description": "Указания для доставки `deliveryInstructions`. Null означает отсутствие записанного значения в этом представлении.",
      "example": "example"
    },
    "note": {
      "type": "string",
      "nullable": true,
      "description": "Заметка `note`, введённая человеком и сохранённая с записью. Null означает отсутствие записанного значения в этом представлении.",
      "example": "Synthetic example"
    },
    "capacityOverrideReason": {
      "type": "string",
      "description": "Причина явного превышения вместимости, указанная менеджером. Требуется право preorders.override.",
      "minLength": 1,
      "maxLength": 1000,
      "example": "Synthetic example"
    },
    "salesChannelId": {
      "type": "string",
      "format": "uuid",
      "description": "UUID Hallify для `salesChannelId`.",
      "example": "ff0fa725-ba44-4e7a-82bb-a15650e0a0cc"
    },
    "clientMenuVersionId": {
      "type": "string",
      "format": "uuid",
      "description": "UUID Hallify для `clientMenuVersionId`.",
      "example": "cd2f2c2a-ba73-4579-8e32-52da8388fd05"
    },
    "clientGraphHash": {
      "type": "string",
      "description": "Непрозрачный токен структуры, возвращённый методом опубликованного меню.",
      "pattern": "^menu-cost-v1\\.graph\\.[A-Za-z0-9_-]{43}$",
      "example": "menu-cost-v1.graph.aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
    },
    "items": {
      "minItems": 1,
      "maxItems": 100,
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/PreorderCartLineDto"
      },
      "description": "Коллекция `items` в составе представления.",
      "example": [
        {
          "clientLineId": "example-id",
          "quantity": 1
        }
      ]
    },
    "termsVersion": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64,
      "description": "Версия условий `termsVersion`. Ограничения: минимальная длина 1; максимальная длина 64.",
      "example": "example"
    },
    "privacyVersion": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64,
      "description": "Версия уведомления о персональных данных `privacyVersion`. Ограничения: минимальная длина 1; максимальная длина 64.",
      "example": "example"
    }
  },
  "required": [
    "serviceMode",
    "scheduledFor",
    "partySize",
    "contactName",
    "salesChannelId",
    "clientMenuVersionId",
    "clientGraphHash",
    "items",
    "termsVersion",
    "privacyVersion"
  ],
  "description": "Создаёт кратковременную зашифрованную корзину и процесс подтверждения контакта по опубликованным правилам заведения, без создания заказа.",
  "example": {
    "serviceMode": "DINE_IN",
    "scheduledFor": "2026-01-15T12:00:00.000Z",
    "partySize": 1,
    "contactName": "Example name",
    "salesChannelId": "ff0fa725-ba44-4e7a-82bb-a15650e0a0cc",
    "clientMenuVersionId": "cd2f2c2a-ba73-4579-8e32-52da8388fd05",
    "clientGraphHash": "menu-cost-v1.graph.aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
    "items": [
      {
        "clientLineId": "example-id",
        "quantity": 1
      }
    ],
    "termsVersion": "example",
    "privacyVersion": "example"
  }
}
PreorderCartLineDto

Строка корзины предзаказа, вложенная в коллекцию или агрегат операций.

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

Стабильный идентификатор строки корзины, созданный клиентом.

string
Полное определение
{
  "type": "string",
  "description": "Стабильный идентификатор строки корзины, созданный клиентом.",
  "pattern": "^[A-Za-z0-9][A-Za-z0-9:_-]{0,79}$",
  "example": "example-id"
}
menuItemIdНеобязательно

UUID Hallify для menuItemId.

string · uuid
Полное определение
{
  "type": "string",
  "format": "uuid",
  "description": "UUID Hallify для `menuItemId`.",
  "example": "16ee6f36-c0cb-4311-85e8-2d2b3edea0fd"
}
menuVariantIdНеобязательно

UUID Hallify для menuVariantId.

string · uuid
Полное определение
{
  "type": "string",
  "format": "uuid",
  "description": "UUID Hallify для `menuVariantId`.",
  "example": "94389946-e5d8-4fba-8358-e3a9c8a04b11"
}
quantityОбязательно

Целое количество quantity в единице измерения содержащей его позиции или строки. Ограничения: минимум 1; максимум 999.

integer
Полное определение
{
  "type": "integer",
  "minimum": 1,
  "maximum": 999,
  "description": "Целое количество `quantity` в единице измерения содержащей его позиции или строки. Ограничения: минимум 1; максимум 999.",
  "example": 1
}
modifierOptionIdsНеобязательно

Набор идентификаторов UUID Hallify в modifierOptionIds.

array
Полное определение
{
  "maxItems": 20,
  "type": "array",
  "items": {
    "type": "string",
    "format": "uuid",
    "example": "d251fdb0-274c-4e59-8e7e-b1d90e1433bc"
  },
  "description": "Набор идентификаторов UUID Hallify в `modifierOptionIds`.",
  "example": [
    "d251fdb0-274c-4e59-8e7e-b1d90e1433bc"
  ]
}
componentSelectionsНеобязательно

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

array
Полное определение
{
  "maxItems": 50,
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/OrderItemComponentSelectionDto"
  },
  "description": "Коллекция `componentSelections` в составе представления.",
  "example": [
    {
      "groupId": "example-id",
      "choiceId": "example-id"
    }
  ]
}
serviceFlagsНеобязательно

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

array
Полное определение
{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "VIP",
      "RUSH",
      "FIRE_LATER"
    ],
    "example": "VIP"
  },
  "description": "Коллекция `serviceFlags` в составе представления.",
  "example": [
    "VIP"
  ]
}
specialRequestНеобязательно

Особое пожелание specialRequest. Ограничения: максимальная длина 500.

string
Полное определение
{
  "type": "string",
  "maxLength": 500,
  "description": "Особое пожелание `specialRequest`. Ограничения: максимальная длина 500.",
  "example": "example"
}
Полное определение
{
  "type": "object",
  "properties": {
    "clientLineId": {
      "type": "string",
      "description": "Стабильный идентификатор строки корзины, созданный клиентом.",
      "pattern": "^[A-Za-z0-9][A-Za-z0-9:_-]{0,79}$",
      "example": "example-id"
    },
    "menuItemId": {
      "type": "string",
      "format": "uuid",
      "description": "UUID Hallify для `menuItemId`.",
      "example": "16ee6f36-c0cb-4311-85e8-2d2b3edea0fd"
    },
    "menuVariantId": {
      "type": "string",
      "format": "uuid",
      "description": "UUID Hallify для `menuVariantId`.",
      "example": "94389946-e5d8-4fba-8358-e3a9c8a04b11"
    },
    "quantity": {
      "type": "integer",
      "minimum": 1,
      "maximum": 999,
      "description": "Целое количество `quantity` в единице измерения содержащей его позиции или строки. Ограничения: минимум 1; максимум 999.",
      "example": 1
    },
    "modifierOptionIds": {
      "maxItems": 20,
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid",
        "example": "d251fdb0-274c-4e59-8e7e-b1d90e1433bc"
      },
      "description": "Набор идентификаторов UUID Hallify в `modifierOptionIds`.",
      "example": [
        "d251fdb0-274c-4e59-8e7e-b1d90e1433bc"
      ]
    },
    "componentSelections": {
      "maxItems": 50,
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/OrderItemComponentSelectionDto"
      },
      "description": "Коллекция `componentSelections` в составе представления.",
      "example": [
        {
          "groupId": "example-id",
          "choiceId": "example-id"
        }
      ]
    },
    "serviceFlags": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "VIP",
          "RUSH",
          "FIRE_LATER"
        ],
        "example": "VIP"
      },
      "description": "Коллекция `serviceFlags` в составе представления.",
      "example": [
        "VIP"
      ]
    },
    "specialRequest": {
      "type": "string",
      "maxLength": 500,
      "description": "Особое пожелание `specialRequest`. Ограничения: максимальная длина 500.",
      "example": "example"
    }
  },
  "required": [
    "clientLineId",
    "quantity"
  ],
  "description": "Строка корзины предзаказа, вложенная в коллекцию или агрегат операций.",
  "example": {
    "clientLineId": "example-id",
    "quantity": 1
  }
}
OrderItemComponentSelectionDto

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

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

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

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

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

string
Полное определение
{
  "type": "string",
  "description": "Стабильный идентификатор варианта компонента опубликованной структуры.",
  "maxLength": 160,
  "example": "example-id"
}
menuVariantIdНеобязательно

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

string · uuid
Полное определение
{
  "type": "string",
  "description": "Выбранная продаваемая версия, если у компонента есть версии.",
  "format": "uuid",
  "example": "94389946-e5d8-4fba-8358-e3a9c8a04b11"
}
modifierOptionIdsНеобязательно

Идентификаторы модификаторов, выбранных для этого компонента.

array
Полное определение
{
  "description": "Идентификаторы модификаторов, выбранных для этого компонента.",
  "type": "array",
  "items": {
    "type": "string",
    "format": "uuid",
    "example": "d251fdb0-274c-4e59-8e7e-b1d90e1433bc"
  },
  "example": [
    "d251fdb0-274c-4e59-8e7e-b1d90e1433bc"
  ]
}
Полное определение
{
  "type": "object",
  "properties": {
    "groupId": {
      "type": "string",
      "description": "Стабильный идентификатор группы компонентов опубликованной структуры.",
      "maxLength": 96,
      "example": "example-id"
    },
    "choiceId": {
      "type": "string",
      "description": "Стабильный идентификатор варианта компонента опубликованной структуры.",
      "maxLength": 160,
      "example": "example-id"
    },
    "menuVariantId": {
      "type": "string",
      "description": "Выбранная продаваемая версия, если у компонента есть версии.",
      "format": "uuid",
      "example": "94389946-e5d8-4fba-8358-e3a9c8a04b11"
    },
    "modifierOptionIds": {
      "description": "Идентификаторы модификаторов, выбранных для этого компонента.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid",
        "example": "d251fdb0-274c-4e59-8e7e-b1d90e1433bc"
      },
      "example": [
        "d251fdb0-274c-4e59-8e7e-b1d90e1433bc"
      ]
    }
  },
  "required": [
    "groupId",
    "choiceId"
  ],
  "description": "Выбранные идентификаторы компонентов позиции заказа, применяемые к конфигурации родительской позиции.",
  "example": {
    "groupId": "example-id",
    "choiceId": "example-id"
  }
}
PreorderPublicCreateDraftResultDto

Возвращает ссылочный идентификатор черновика, срок действия, маскированное состояние проверки и токен черновика.

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

Ссылочный идентификатор draftReference, назначенный человеком или провайдером для сверки с исходной записью.

string
Полное определение
{
  "type": "string",
  "description": "Ссылочный идентификатор `draftReference`, назначенный человеком или провайдером для сверки с исходной записью.",
  "example": "example-reference"
}
resumeTokenОбязательно

Токен черновика для продолжения только что созданного публичного предзаказа. Ограничен этим черновиком и истекает вместе с ним.

string
Полное определение
{
  "type": "string",
  "description": "Токен черновика для продолжения только что созданного публичного предзаказа. Ограничен этим черновиком и истекает вместе с ним.",
  "example": "synthetic-example-credential"
}
statusОбязательно

Текущий статус жизненного цикла status; допустимые значения: PENDING_VERIFICATION.

string
Полное определение
{
  "type": "string",
  "enum": [
    "PENDING_VERIFICATION"
  ],
  "description": "Текущий статус жизненного цикла `status`; допустимые значения: PENDING_VERIFICATION.",
  "example": "PENDING_VERIFICATION"
}
verificationIdОбязательно

UUID Hallify для verificationId.

string · uuid
Полное определение
{
  "type": "string",
  "format": "uuid",
  "description": "UUID Hallify для `verificationId`.",
  "example": "904a18d4-c890-4387-8e14-bc52c879c7ff"
}
verificationExpiresAtОбязательно

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

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

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

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

Стабильный код testCode для классификации или идентификации. Null означает отсутствие записанного значения в этом представлении.

string · null
Полное определение
{
  "type": "string",
  "nullable": true,
  "description": "Стабильный код `testCode` для классификации или идентификации. Null означает отсутствие записанного значения в этом представлении.",
  "example": "EXAMPLE"
}
Полное определение
{
  "type": "object",
  "properties": {
    "draftReference": {
      "type": "string",
      "description": "Ссылочный идентификатор `draftReference`, назначенный человеком или провайдером для сверки с исходной записью.",
      "example": "example-reference"
    },
    "resumeToken": {
      "type": "string",
      "description": "Токен черновика для продолжения только что созданного публичного предзаказа. Ограничен этим черновиком и истекает вместе с ним.",
      "example": "synthetic-example-credential"
    },
    "status": {
      "type": "string",
      "enum": [
        "PENDING_VERIFICATION"
      ],
      "description": "Текущий статус жизненного цикла `status`; допустимые значения: PENDING_VERIFICATION.",
      "example": "PENDING_VERIFICATION"
    },
    "verificationId": {
      "type": "string",
      "format": "uuid",
      "description": "UUID Hallify для `verificationId`.",
      "example": "904a18d4-c890-4387-8e14-bc52c879c7ff"
    },
    "verificationExpiresAt": {
      "type": "string",
      "format": "date-time",
      "description": "Время `verificationExpiresAt` в формате RFC3339; разные часовые смещения могут обозначать один абсолютный момент.",
      "example": "2026-12-31T18:00:00.000Z"
    },
    "expiresAt": {
      "type": "string",
      "format": "date-time",
      "description": "Время `expiresAt` в формате RFC3339; разные часовые смещения могут обозначать один абсолютный момент.",
      "example": "2026-12-31T18:00:00.000Z"
    },
    "testCode": {
      "type": "string",
      "nullable": true,
      "description": "Стабильный код `testCode` для классификации или идентификации. Null означает отсутствие записанного значения в этом представлении.",
      "example": "EXAMPLE"
    }
  },
  "required": [
    "draftReference",
    "resumeToken",
    "status",
    "verificationId",
    "verificationExpiresAt",
    "expiresAt"
  ],
  "description": "Возвращает ссылочный идентификатор черновика, срок действия, маскированное состояние проверки и токен черновика.",
  "example": {
    "draftReference": "example-reference",
    "resumeToken": "synthetic-example-credential",
    "status": "PENDING_VERIFICATION",
    "verificationId": "904a18d4-c890-4387-8e14-bc52c879c7ff",
    "verificationExpiresAt": "2026-12-31T18:00:00.000Z",
    "expiresAt": "2026-12-31T18:00:00.000Z"
  }
}
IdempotencyConflictError

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

Полное определение
{
  "example": {
    "statusCode": 409,
    "error": "errors:http.conflict",
    "code": "IDEMPOTENCY_REQUEST_IN_PROGRESS",
    "message": "errors:idempotency.inProgress",
    "translationKey": "errors:idempotency.inProgress"
  },
  "allOf": [
    {
      "$ref": "#/components/schemas/TranslatedErrorDto"
    },
    {
      "type": "object",
      "required": [
        "code"
      ],
      "properties": {
        "statusCode": {
          "type": "integer",
          "enum": [
            409
          ],
          "description": "Статус конфликта HTTP 409.",
          "example": 409
        },
        "code": {
          "type": "string",
          "enum": [
            "IDEMPOTENCY_REQUEST_NOT_READY",
            "IDEMPOTENCY_KEY_PAYLOAD_MISMATCH",
            "IDEMPOTENCY_REQUEST_IN_PROGRESS",
            "IDEMPOTENCY_SCOPE_INCOMPLETE"
          ],
          "description": "Допустимые значения `code`: IDEMPOTENCY_REQUEST_NOT_READY, IDEMPOTENCY_KEY_PAYLOAD_MISMATCH, IDEMPOTENCY_REQUEST_IN_PROGRESS, IDEMPOTENCY_SCOPE_INCOMPLETE.",
          "example": "IDEMPOTENCY_REQUEST_NOT_READY"
        }
      },
      "example": {
        "code": "IDEMPOTENCY_REQUEST_NOT_READY"
      }
    }
  ],
  "description": "Ключ идемпотентности уже обрабатывается или использован повторно с другим телом."
}
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"
  }
}
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 поддерживают вход, язык и тему. Аналитика выключена, пока вы явно ее не разрешите.