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