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

Внешние заказы и POS

Передать подписанную ревизию внешнего заказа

POST/external-order-ingress/{sourceId}/orders

Проверяет точное тело запроса с помощью HMAC-секрета источника. Повтор той же ревизии с тем же телом безопасен. Профиль Hallify HMAC external-orders использует HMAC-SHA256. Каноническое сообщение: RFC3339 + "." + стабильный JSON с сортировкой ключей. Передайте x-hallify-timestamp в формате RFC3339; допустимое расхождение — ±300 секунд. Формат x-hallify-signature: строчные шестнадцатеричные символы; сравнение выполняется за постоянное время. Используйте выданный текст base64url как секрет в UTF-8. Content-Type: application/json. Некорректная подпись: 401 Webhook signature is invalid. Просроченное время: 401 Webhook timestamp is stale. Повторы и конфликты определяются ревизией заказа и отпечатком тела.

Авторизация

x-hallify-signature: <HALLIFY_SIGNATURE>

Подпись HMAC-SHA256. Точный протокол каждой операции указан в метаданных x-hallify-hmac и её описании.

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

Параметры

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

Настроенный источник приёма данных или интеграции в пределах авторизованного родительского ресурса.

string · uuid
Полное определение
{
  "format": "uuid",
  "type": "string",
  "example": "9b6163a8-afea-4877-818b-8e2ae28a2845"
}
x-hallify-timestampЗаголовок · Обязательно

Время в формате RFC3339; допустимое расхождение часов — ±300 секунд.

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

Тело запроса

Обязательно

Внешний идентификатор заказа, монотонная ревизия, способ обслуживания, необязательные подпись и срок исполнения, а также от 1 до 200 позиций. Эти данные составляют подписанную ревизию источника.

application/json

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

Ответы

201Возвращает принятую внешнюю ревизию, связанный заказ Hallify и результат обработки повтора для источника.
ExternalOrderIngressIngestResultDto
Полное определение
{
  "$ref": "#/components/schemas/ExternalOrderIngressIngestResultDto"
}
Пример ответа · 201 · application/json
{
  "id": "a42073ae-5313-4ace-86d8-86fb33fde1a9",
  "orderId": "f3127edf-ce4f-4da7-8be5-81b962024e6c",
  "status": "example",
  "externalOrderId": "example-id",
  "externalRevision": 1,
  "duplicate": false
}
400Некорректный идентификатор источника внешних заказов или тело заказа.
TranslatedErrorDto
Полное определение
{
  "$ref": "#/components/schemas/TranslatedErrorDto"
}
Пример ответа · 400 · application/json
{
  "statusCode": 400,
  "error": "errors:http.badRequest",
  "code": "HTTP_BAD_REQUEST",
  "message": "errors:http.badRequest",
  "translationKey": "errors:http.badRequest"
}
401HMAC-подпись внешнего заказа недействительна или просрочена.
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"
}
404Источник внешних заказов или связанный ресурс не найден.
TranslatedErrorDto
Полное определение
{
  "$ref": "#/components/schemas/TranslatedErrorDto"
}
Пример ответа · 404 · application/json
{
  "statusCode": 404,
  "error": "errors:http.notFound",
  "code": "HTTP_NOT_FOUND",
  "message": "errors:http.notFound",
  "translationKey": "errors:http.notFound"
}
409Ревизия, тело или состояние внешнего заказа конфликтуют с текущим состоянием.
TranslatedErrorDto
Полное определение
{
  "$ref": "#/components/schemas/TranslatedErrorDto"
}
Пример ответа · 409 · application/json
{
  "statusCode": 409,
  "error": "errors:http.conflict",
  "code": "HTTP_CONFLICT",
  "message": "errors:http.conflict",
  "translationKey": "errors:http.conflict"
}
503Секрет подписи внешних заказов недоступен.
TranslatedErrorDto
Полное определение
{
  "$ref": "#/components/schemas/TranslatedErrorDto"
}
Пример ответа · 503 · application/json
{
  "statusCode": 503,
  "error": "errors:http.serviceUnavailable",
  "code": "HTTP_SERVICE_UNAVAILABLE",
  "message": "errors:http.serviceUnavailable",
  "translationKey": "errors:http.serviceUnavailable"
}

Схемы

ExternalOrderIngressDto

Проверяет точное тело запроса с помощью HMAC-секрета источника.

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

Непрозрачный идентификатор externalOrderId; клиент не должен предполагать формат UUID. Ограничения: максимальная длина 191.

string
Полное определение
{
  "type": "string",
  "maxLength": 191,
  "description": "Непрозрачный идентификатор `externalOrderId`; клиент не должен предполагать формат UUID. Ограничения: максимальная длина 191.",
  "example": "example-id"
}
externalRevisionОбязательно

Монотонно возрастающая ревизия externalRevision для оптимистичного контроля конкурентных изменений. Ограничения: минимум 1.

integer
Полное определение
{
  "type": "integer",
  "minimum": 1,
  "description": "Монотонно возрастающая ревизия `externalRevision` для оптимистичного контроля конкурентных изменений. Ограничения: минимум 1.",
  "example": 1
}
displayLabelНеобязательно

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

string
Полное определение
{
  "type": "string",
  "maxLength": 120,
  "description": "Отображаемая подпись `displayLabel`. Ограничения: максимальная длина 120.",
  "example": "example"
}
serviceModeОбязательно

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

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

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

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

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

array
Полное определение
{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/ExternalOrderItemDto"
  },
  "description": "Коллекция `items` в составе представления.",
  "example": [
    {
      "clientMenuVersionId": "cd2f2c2a-ba73-4579-8e32-52da8388fd05",
      "clientGraphHash": "menu-cost-v1.graph.aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "quantity": 1
    }
  ]
}
Полное определение
{
  "type": "object",
  "properties": {
    "externalOrderId": {
      "type": "string",
      "maxLength": 191,
      "description": "Непрозрачный идентификатор `externalOrderId`; клиент не должен предполагать формат UUID. Ограничения: максимальная длина 191.",
      "example": "example-id"
    },
    "externalRevision": {
      "type": "integer",
      "minimum": 1,
      "description": "Монотонно возрастающая ревизия `externalRevision` для оптимистичного контроля конкурентных изменений. Ограничения: минимум 1.",
      "example": 1
    },
    "displayLabel": {
      "type": "string",
      "maxLength": 120,
      "description": "Отображаемая подпись `displayLabel`. Ограничения: максимальная длина 120.",
      "example": "example"
    },
    "serviceMode": {
      "type": "string",
      "enum": [
        "PICKUP",
        "DELIVERY",
        "CATERING"
      ],
      "description": "Допустимые значения `serviceMode`: PICKUP, DELIVERY, CATERING.",
      "example": "PICKUP"
    },
    "dueAt": {
      "type": "string",
      "format": "date-time",
      "description": "Время `dueAt` в формате RFC3339; разные часовые смещения могут обозначать один абсолютный момент.",
      "example": "2026-12-31T18:00:00.000Z"
    },
    "items": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ExternalOrderItemDto"
      },
      "description": "Коллекция `items` в составе представления.",
      "example": [
        {
          "clientMenuVersionId": "cd2f2c2a-ba73-4579-8e32-52da8388fd05",
          "clientGraphHash": "menu-cost-v1.graph.aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
          "quantity": 1
        }
      ]
    }
  },
  "required": [
    "externalOrderId",
    "externalRevision",
    "serviceMode",
    "items"
  ],
  "description": "Проверяет точное тело запроса с помощью HMAC-секрета источника.",
  "example": {
    "externalOrderId": "example-id",
    "externalRevision": 1,
    "serviceMode": "PICKUP",
    "items": [
      {
        "clientMenuVersionId": "cd2f2c2a-ba73-4579-8e32-52da8388fd05",
        "clientGraphHash": "menu-cost-v1.graph.aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
        "quantity": 1
      }
    ]
  }
}
ExternalOrderItemDto

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

salesChannelIdНеобязательно

Идентификатор канала продаж заведения для определения активного меню.

string · uuid
Полное определение
{
  "type": "string",
  "description": "Идентификатор канала продаж заведения для определения активного меню.",
  "format": "uuid",
  "example": "ff0fa725-ba44-4e7a-82bb-a15650e0a0cc"
}
clientMenuVersionIdОбязательно

Идентификатор версии меню, которую клиент использовал при составлении позиции.

string · uuid
Полное определение
{
  "type": "string",
  "description": "Идентификатор версии меню, которую клиент использовал при составлении позиции.",
  "format": "uuid",
  "example": "cd2f2c2a-ba73-4579-8e32-52da8388fd05"
}
clientGraphHashОбязательно

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

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

Цена единицы, которую клиент показывал при составлении позиции.

number
Полное определение
{
  "type": "number",
  "description": "Цена единицы, которую клиент показывал при составлении позиции.",
  "example": 12,
  "minimum": 0,
  "maximum": 9999999999.99
}
expectedTotalНеобязательно

Итоговая цена строки, которую клиент показывал при составлении позиции.

number
Полное определение
{
  "type": "number",
  "description": "Итоговая цена строки, которую клиент показывал при составлении позиции.",
  "example": 24,
  "minimum": 0,
  "maximum": 9999999999.99
}
enteredUnitPriceНеобязательно

Явная цена единицы при обслуживании для позиции с открытой ценой. Передаётся отдельно от клиентских полей проверки согласованности цен.

number
Полное определение
{
  "type": "number",
  "description": "Явная цена единицы при обслуживании для позиции с открытой ценой. Передаётся отдельно от клиентских полей проверки согласованности цен.",
  "example": 45,
  "minimum": 0,
  "maximum": 9999999999.99
}
priceEntryNoteНеобязательно

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

string
Полное определение
{
  "type": "string",
  "description": "Операционная заметка аудита для открытой цены. Обязательна, если её требует опубликованное правило.",
  "maxLength": 500,
  "example": "Synthetic example"
}
openPriceApprovalCredentialНеобязательно

Явное подтверждение сотрудника, необходимое только при превышении порога согласования открытой цены.

allOf
Полное определение
{
  "description": "Явное подтверждение сотрудника, необходимое только при превышении порога согласования открытой цены.",
  "allOf": [
    {
      "$ref": "#/components/schemas/OrderItemOpenPriceApprovalCredentialDto"
    }
  ],
  "example": {
    "employeeNumber": "1.00",
    "pin": "example"
  }
}
measuredQuantityНеобязательно

Явное измеренное количество для весовой или мерной позиции. Передайте десятичную строку в опубликованной единице измерения; quantity таких строк всегда равно 1.

string
Полное определение
{
  "type": "string",
  "description": "Явное измеренное количество для весовой или мерной позиции. Передайте десятичную строку в опубликованной единице измерения; quantity таких строк всегда равно 1.",
  "example": "350",
  "pattern": "^(?:0|[1-9]\\d{0,8})(?:\\.\\d{1,3})?$"
}
menuItemIdНеобязательно

Идентификатор позиции меню. Передайте его ИЛИ menuVariantId.

string · uuid
Полное определение
{
  "type": "string",
  "description": "Идентификатор позиции меню. Передайте его ИЛИ menuVariantId.",
  "format": "uuid",
  "example": "16ee6f36-c0cb-4311-85e8-2d2b3edea0fd"
}
menuVariantIdНеобязательно

Идентификатор варианта меню. Передайте его ИЛИ menuItemId.

string · uuid
Полное определение
{
  "type": "string",
  "description": "Идентификатор варианта меню. Передайте его ИЛИ menuItemId.",
  "format": "uuid",
  "example": "94389946-e5d8-4fba-8358-e3a9c8a04b11"
}
quantityОбязательно

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

integer
Полное определение
{
  "type": "integer",
  "description": "Количество для новой исторической строки позиции заказа.",
  "minimum": 1,
  "example": 1
}
modifierOptionIdsНеобязательно

Идентификаторы выбранных модификаторов позиции заказа.

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

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

array
Полное определение
{
  "description": "Выбор групп компонентов, принадлежащих опубликованной структуре позиции.",
  "maxItems": 50,
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/OrderItemComponentSelectionDto"
  },
  "example": [
    {
      "groupId": "example-id",
      "choiceId": "example-id"
    }
  ]
}
serviceFlagsНеобязательно

Структурированные признаки обслуживания позиции.

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

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

string
Полное определение
{
  "type": "string",
  "description": "Произвольный текст особого пожелания для кухни.",
  "maxLength": 500,
  "example": "example"
}
Полное определение
{
  "type": "object",
  "properties": {
    "salesChannelId": {
      "type": "string",
      "description": "Идентификатор канала продаж заведения для определения активного меню.",
      "format": "uuid",
      "example": "ff0fa725-ba44-4e7a-82bb-a15650e0a0cc"
    },
    "clientMenuVersionId": {
      "type": "string",
      "description": "Идентификатор версии меню, которую клиент использовал при составлении позиции.",
      "format": "uuid",
      "example": "cd2f2c2a-ba73-4579-8e32-52da8388fd05"
    },
    "clientGraphHash": {
      "type": "string",
      "description": "Непрозрачный токен структуры опубликованного меню, который клиент использовал при составлении позиции.",
      "pattern": "^menu-cost-v1\\.graph\\.[A-Za-z0-9_-]{43}$",
      "maxLength": 128,
      "example": "menu-cost-v1.graph.aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
    },
    "expectedUnitPrice": {
      "type": "number",
      "description": "Цена единицы, которую клиент показывал при составлении позиции.",
      "example": 12,
      "minimum": 0,
      "maximum": 9999999999.99
    },
    "expectedTotal": {
      "type": "number",
      "description": "Итоговая цена строки, которую клиент показывал при составлении позиции.",
      "example": 24,
      "minimum": 0,
      "maximum": 9999999999.99
    },
    "enteredUnitPrice": {
      "type": "number",
      "description": "Явная цена единицы при обслуживании для позиции с открытой ценой. Передаётся отдельно от клиентских полей проверки согласованности цен.",
      "example": 45,
      "minimum": 0,
      "maximum": 9999999999.99
    },
    "priceEntryNote": {
      "type": "string",
      "description": "Операционная заметка аудита для открытой цены. Обязательна, если её требует опубликованное правило.",
      "maxLength": 500,
      "example": "Synthetic example"
    },
    "openPriceApprovalCredential": {
      "description": "Явное подтверждение сотрудника, необходимое только при превышении порога согласования открытой цены.",
      "allOf": [
        {
          "$ref": "#/components/schemas/OrderItemOpenPriceApprovalCredentialDto"
        }
      ],
      "example": {
        "employeeNumber": "1.00",
        "pin": "example"
      }
    },
    "measuredQuantity": {
      "type": "string",
      "description": "Явное измеренное количество для весовой или мерной позиции. Передайте десятичную строку в опубликованной единице измерения; quantity таких строк всегда равно 1.",
      "example": "350",
      "pattern": "^(?:0|[1-9]\\d{0,8})(?:\\.\\d{1,3})?$"
    },
    "menuItemId": {
      "type": "string",
      "description": "Идентификатор позиции меню. Передайте его ИЛИ menuVariantId.",
      "format": "uuid",
      "example": "16ee6f36-c0cb-4311-85e8-2d2b3edea0fd"
    },
    "menuVariantId": {
      "type": "string",
      "description": "Идентификатор варианта меню. Передайте его ИЛИ menuItemId.",
      "format": "uuid",
      "example": "94389946-e5d8-4fba-8358-e3a9c8a04b11"
    },
    "quantity": {
      "type": "integer",
      "description": "Количество для новой исторической строки позиции заказа.",
      "minimum": 1,
      "example": 1
    },
    "modifierOptionIds": {
      "description": "Идентификаторы выбранных модификаторов позиции заказа.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid",
        "example": "d251fdb0-274c-4e59-8e7e-b1d90e1433bc"
      },
      "example": [
        "d251fdb0-274c-4e59-8e7e-b1d90e1433bc"
      ]
    },
    "componentSelections": {
      "description": "Выбор групп компонентов, принадлежащих опубликованной структуре позиции.",
      "maxItems": 50,
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/OrderItemComponentSelectionDto"
      },
      "example": [
        {
          "groupId": "example-id",
          "choiceId": "example-id"
        }
      ]
    },
    "serviceFlags": {
      "type": "array",
      "description": "Структурированные признаки обслуживания позиции.",
      "items": {
        "type": "string",
        "enum": [
          "VIP",
          "RUSH",
          "FIRE_LATER"
        ],
        "example": "VIP"
      },
      "example": [
        "VIP"
      ]
    },
    "specialRequest": {
      "type": "string",
      "description": "Произвольный текст особого пожелания для кухни.",
      "maxLength": 500,
      "example": "example"
    }
  },
  "required": [
    "clientMenuVersionId",
    "clientGraphHash",
    "quantity"
  ],
  "description": "Внешний заказ, вложенный в коллекцию или агрегат операций.",
  "example": {
    "clientMenuVersionId": "cd2f2c2a-ba73-4579-8e32-52da8388fd05",
    "clientGraphHash": "menu-cost-v1.graph.aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
    "quantity": 1
  }
}
OrderItemOpenPriceApprovalCredentialDto

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

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

Табельный номер сотрудника, согласующего открытую цену.

string
Полное определение
{
  "type": "string",
  "description": "Табельный номер сотрудника, согласующего открытую цену.",
  "maxLength": 64,
  "example": "1.00"
}
pinОбязательно

PIN сотрудника только для серверной проверки согласования. Не сохраняется и не возвращается.

string
Полное определение
{
  "type": "string",
  "description": "PIN сотрудника только для серверной проверки согласования. Не сохраняется и не возвращается.",
  "minLength": 4,
  "maxLength": 8,
  "example": "example"
}
Полное определение
{
  "type": "object",
  "properties": {
    "employeeNumber": {
      "type": "string",
      "description": "Табельный номер сотрудника, согласующего открытую цену.",
      "maxLength": 64,
      "example": "1.00"
    },
    "pin": {
      "type": "string",
      "description": "PIN сотрудника только для серверной проверки согласования. Не сохраняется и не возвращается.",
      "minLength": 4,
      "maxLength": 8,
      "example": "example"
    }
  },
  "required": [
    "employeeNumber",
    "pin"
  ],
  "description": "Табельный номер и секретный PIN сотрудника для согласования открытой цены позиции заказа.",
  "example": {
    "employeeNumber": "1.00",
    "pin": "example"
  }
}
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"
  }
}
ExternalOrderIngressIngestResultDto

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

Полное определение
{
  "oneOf": [
    {
      "type": "object",
      "required": [
        "id",
        "orderId",
        "status",
        "externalOrderId",
        "externalRevision",
        "duplicate"
      ],
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid",
          "description": "UUID Hallify для `id`.",
          "example": "a42073ae-5313-4ace-86d8-86fb33fde1a9"
        },
        "orderId": {
          "type": "string",
          "format": "uuid",
          "description": "UUID Hallify для `orderId`.",
          "example": "f3127edf-ce4f-4da7-8be5-81b962024e6c"
        },
        "status": {
          "type": "string",
          "description": "Текущий статус жизненного цикла `status`.",
          "example": "example"
        },
        "externalOrderId": {
          "type": "string",
          "description": "Непрозрачный идентификатор `externalOrderId`; клиент не должен предполагать формат UUID.",
          "example": "example-id"
        },
        "externalRevision": {
          "type": "integer",
          "minimum": 0,
          "description": "Монотонно возрастающая ревизия `externalRevision` для оптимистичного контроля конкурентных изменений. Ограничения: минимум 0.",
          "example": 1
        },
        "duplicate": {
          "type": "boolean",
          "enum": [
            false
          ],
          "description": "Допустимые значения `duplicate`: false.",
          "example": false
        }
      },
      "example": {
        "id": "a42073ae-5313-4ace-86d8-86fb33fde1a9",
        "orderId": "f3127edf-ce4f-4da7-8be5-81b962024e6c",
        "status": "example",
        "externalOrderId": "example-id",
        "externalRevision": 1,
        "duplicate": false
      }
    },
    {
      "type": "object",
      "required": [
        "id",
        "orderId",
        "payloadHash",
        "status",
        "duplicate"
      ],
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid",
          "description": "UUID Hallify для `id`.",
          "example": "a7476fce-e842-42a4-896a-c23b0e88b420"
        },
        "orderId": {
          "type": "string",
          "format": "uuid",
          "description": "UUID Hallify для `orderId`.",
          "example": "f3127edf-ce4f-4da7-8be5-81b962024e6c"
        },
        "payloadHash": {
          "type": "string",
          "description": "Непрозрачный отпечаток `payloadHash` канонического тела для определения повторов и сравнения доказательств.",
          "example": "deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef"
        },
        "status": {
          "type": "string",
          "description": "Текущий статус жизненного цикла `status`.",
          "example": "example"
        },
        "duplicate": {
          "type": "boolean",
          "enum": [
            true
          ],
          "description": "Допустимые значения `duplicate`: true.",
          "example": true
        }
      },
      "example": {
        "id": "a7476fce-e842-42a4-896a-c23b0e88b420",
        "orderId": "f3127edf-ce4f-4da7-8be5-81b962024e6c",
        "payloadHash": "deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef",
        "status": "example",
        "duplicate": true
      }
    }
  ],
  "description": "Возвращает принятую внешнюю ревизию, связанный заказ Hallify и результат обработки повтора для источника.",
  "example": {
    "id": "a42073ae-5313-4ace-86d8-86fb33fde1a9",
    "orderId": "f3127edf-ce4f-4da7-8be5-81b962024e6c",
    "status": "example",
    "externalOrderId": "example-id",
    "externalRevision": 1,
    "duplicate": false
  }
}
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 поддерживают вход, язык и тему. Аналитика выключена, пока вы явно ее не разрешите.