Работа с маркировкой
> СерверККМ V4 > REST API > Работа с ККМДата обновления: 23 июля 2026 г.
POST marking/session/open
Открытие сессии регистрации (проверки) кодов маркировки на ККТ.
URL: {{HTTPRoot}}/marking/session/open
Тело запроса
{
"DeviceName": "{device}"
}
| Имя поля | Тип | Обяз | Назначение | Пример |
|---|---|---|---|---|
| DeviceName | string | + | Название устройства | “Atol” |
Тело ответа
Успешный ответ (200 OK)
{
"Response": true,
"Code": 0,
"Description": "Ok"
}
Поле Result
Тип: BooleanResponse
| Имя поля | Тип | Назначение | Пример |
|---|---|---|---|
| Response | bool | Признак успешного открытия сессии. true — сессия открыта. |
true |
| Code | int | Код ошибки | 0 |
| Description | string | Описание результата | “Ok” |
Примеры ошибок
-1 — Не удалось найти устройство
{
"Response": false,
"Code": -1,
"Description": "Не удалось найти устройство {name}"
}
-1 — Метод или операция не реализована
{
"Response": false,
"Code": -1,
"Description": "Метод или операция не реализована."
}
POST marking/session/close
Закрытие сессии регистрации (проверки) кодов маркировки на ККТ.
URL: {{HTTPRoot}}/marking/session/close
Тело запроса
{
"DeviceName": "{device}"
}
Смотрите документацию POST-запроса marking/session/open
Тело ответа
Успешный ответ (200 OK)
{
"Response": true,
"Code": 0,
"Description": "Ok"
}
Поле Result
Тип: BooleanResponse
| Имя поля | Тип | Назначение | Пример |
|---|---|---|---|
| Response | bool | Признак успешного закрытия сессии. true — сессия закрыта. |
true |
| Code | int | Код ошибки | 0 |
| Description | string | Описание результата | “Ok” |
Примеры ошибок
-1 — Не удалось найти устройство
{
"Response": false,
"Code": -1,
"Description": "Не удалось найти устройство {device}"
}
POST marking/km/request
Локальная проверка кода маркировки на ККТ (ФФД 1.2).
URL: {{HTTPRoot}}/marking/km/request
Тело запроса
{
"DeviceName": "{device}",
"RequestKM": {
"Guid": "46dc63e5-8efa-4da6-b8ee-d6188da7b26a",
"NotSendToServer": false,
"WaitForResult": false,
"MarkingCode": "MDEwNDY3MDU0MDE3NjA5OTIxNSdXOVVtHTkzZEdWeg==",
"PlannedStatus": 1,
"Quantity": 1,
"MeasureOfQuantity": 0,
"FractionalQuantityNumerator": null,
"FractionalQuantityDenominator": null
}
}
| Имя поля | Тип | Обяз | Назначение | Пример |
|---|---|---|---|---|
| DeviceName | string | + | Название устройства | “Atol” |
| RequestKM | Тип данных | + | Параметры проверяемого кода маркировки. | “RequestKM”: |
Тип: RequestKM
| Имя поля | Тип | Обяз | Назначение | Пример |
|---|---|---|---|---|
| Guid | string | + | Уникальный код запроса. Его передаёт клиент из 1С. | “46dc63e5-8efa-4da6-b8ee-d6188da7b26a” |
| NotSendToServer | bool | - | Признак того, что результат проверки не нужно отправлять на сервер ОИСМ. Применяется, если при продаже маркированного товара указывать код маркировки в чеке необязательно. Если не указано — принимается значение false. |
false |
| WaitForResult | bool | - | Признак ожидания ответа ОИСМ. Если не указано — принимается значение false. |
false |
| MarkingCode | string | + | Код маркировки в кодировке Base64. | “MDEwNDY3MDU0MDE3NjA5OTIxNSdXOVVtHTkzZEdWeg==” |
| PlannedStatus | int | + | Планируемый статус (таблица 105 ФФД): 1 — реализован, 2 — мерный в стадии реализации, 3 — возвращён, 4 — часть возвращена, 255 — статус не изменился |
1 |
| Quantity | decimal | + | Количество товара. | 1 |
| MeasureOfQuantity | int | - | Мера количества товара (таблица 114 ФФД). Если не указано — 0. |
0 |
| FractionalQuantityNumerator | int | - | Числитель дробного количества товара. Указывается вместе с FractionalQuantityDenominator. | null |
| FractionalQuantityDenominator | int | - | Знаменатель дробного количества товара. | null |
Тело ответа
Успешный ответ (200 OK)
{
"ISMConnected": true,
"FormatChecking": true,
"Checking": true,
"CheckingResult": false,
"Code": 0,
"Description": "Ошибок нет"
}
Поле Result
Тип: RequestKMResult
| Имя поля | Тип | Назначение | Пример |
|---|---|---|---|
| ISMConnected | bool | Признак наличия связи с ОИСМ на момент отправки запроса | true |
| FormatChecking | bool | Признак того, что проверка формата кода маркировки прошла успешно | true |
| Checking | bool | Признак того, что проверка кода маркировки поставлена в обработку | true |
| CheckingResult | bool | Результат проверки, если он уже доступен на момент ответа. | false |
| Code | int | Код ошибки | 0 |
| Description | string | Описание результата | “Ошибок нет” |
Примеры ошибок
-1 — Не удалось найти устройство
{
"Response": false,
"Code": -1,
"Description": "Не удалось найти устройство {name}"
}
-1 — Метод или операция не реализована
{
"Response": false,
"Code": -1,
"Description": "Метод или операция не реализована."
}
68 — Драйвер не загружен
{
"ISMConnected": false,
"FormatChecking": false,
"Checking": false,
"CheckingResult": false,
"Code": 68,
"Description": "Драйвер не загружен"
}
414 — Операция не разрешена, при регистрации не был установлен признак ТМТ
{
"ISMConnected": false,
"FormatChecking": false,
"Checking": false,
"CheckingResult": false,
"Code": 414,
"Description": "Операция не разрешена, при регистрации не был установлен признак ТМТ"
}
-1 — можно применять только для ФФД 1.2
{
"ISMConnected": false,
"FormatChecking": false,
"Checking": false,
"CheckingResult": false,
"Code": -1,
"Description": "RequestKM() можно применять только для ФФД 1.2. У ККМ '{device}' версия ФФД "
}
GET marking/km/result?device={device}
Получение результата проверки кода маркировки в ОИСМ.
URL: {{HTTPRoot}}/marking/km/result?device={device}
Параметры запроса
| Имя параметра | Тип | Обяз | Назначение | Пример |
|---|---|---|---|---|
| device | string | + | Имя устройства | “Atol” |
Тело ответа
Успешный ответ (200 OK)
{
"Guid": "46dc63e5-8efa-4da6-b8ee-d6188da7b26a",
"Result": false,
"ResultCode": 5,
"StatusInfo": 0,
"HandleCode": 2,
"RequestStatus": 0,
"Code": 0,
"Description": "Ошибок нет"
}
Поле Result
Тип: ProcessingKMResult
| Имя поля | Тип | Назначение | Пример |
|---|---|---|---|
| Guid | string | Уникальный код запроса. Его передаёт клиент из 1С. | “46dc63e5-8efa-4da6-b8ee-d6188da7b26a” |
| RequestStatus | int | Статус получения результата от ОИСМ: 0 — результат получен; 1 — результат ещё не получен; 2 — результат не может быть получен. |
0 |
| Result | bool | Итог проверки кода маркировки | false |
| ResultCode | int | Код результата проверки (тег 2106 ФФД) | 5 |
| StatusInfo | int | Статус информации о коде маркировки (тег 2109 ФФД) | 0 |
| HandleCode | int | Код обработки запроса (тег 2105 ФФД) | 2 |
| Code | int | Код ошибки сервера (0 — без ошибок) | 0 |
| Description | string | Описание результата | “Ошибок нет” |
Примеры ошибок
-1 — Метод или операция не реализована
{
"Response": false,
"Code": -1,
"Description": "Метод или операция не реализована."
}
-1 — Не найдено устройство
{
"Result": false,
"ResultCode": 0,
"HandleCode": 0,
"RequestStatus": 0,
"Code": -1,
"Description": "Ссылка на объект не указывает на экземпляр объекта."
}
99 — Не найден результат последней проверки
{
"Result": false,
"ResultCode": 0,
"HandleCode": 0,
"RequestStatus": 0,
"Code": -99,
"Description": "Не найден результат последней проверки"
}
4 — Не указано имя ККТ
{
"Code": 4,
"Description": "Не указано имя ККТ",
"Success": false
}
-8 — time out подключения
{
"Result": false,
"ResultCode": 0,
"HandleCode": 0,
"RequestStatus": 0,
"Code": -8,
"Description": "Connect timed out."
}
POST marking/km/confirm
Подтверждение, будет ли ранее проверенный код маркировки фактически включён в документ реализации. Подтверждение действительно только в рамках открытой сессии регистрации кодов маркировки.
URL: {{HTTPRoot}}/marking/km/confirm
Тело запроса
{
"DeviceIdent": {
"DeviceName": "{device}"
},
"GUID": "46dc63e5-8efa-4da6-b8ee-d6188da7b26a",
"ConfirmationType": 1
}
| Имя поля | Тип | Обяз | Назначение | Пример |
|---|---|---|---|---|
| DeviceName | string | + | Имя устройства | “Atol” |
| GUID | string | + | Код запроса. Его передаёт клиент из 1С. | “46dc63e5-8efa-4da6-b8ee-d6188da7b26a” |
| ConfirmationType | int | + | Признак подтверждения: 0 — код маркировки включён в документ реализации; 1 — код маркировки не включён. Если поле не передано в запросе, оно принимает значение 0 — то есть отсутствие поля равносильно явному подтверждению продажи. |
1 |
Тело ответа
Успешный ответ (200 OK)
{
"Response": true,
"Code": 0,
"Description": "Ok"
}
Тип: BooleanResponse
Смотрите документацию POST-запроса marking/session/open
Примеры ошибок
-1 — Не найдено устройство
{
"Result": false,
"ResultCode": 0,
"HandleCode": 0,
"RequestStatus": 0,
"Code": -1,
"Description": "Ссылка на объект не указывает на экземпляр объекта."
}
422 — Данный КМ отсутствует в таблице
{
"Response": false,
"Code": 422,
"Description": "Данный КМ отсутствует в таблице"
}
-1 — Не удалось найти устройство
{
"Response": false,
"Code": -1,
"Description": "Не удалось найти устройство {name}"
}
-1 — Нет связи
{
"Response": false,
"Code": -1,
"Description": "Нет связи"
}
POST marking/km/verify
Проверка кодов маркировки. Метод проверки выбирается в настройках устройства, во вкладке “Маркировка”, категория “Способ проверки маркировки”.
Если выбрана проверка “Автоматически”, сервер последовательно пробует ТС ПИоТ (если для устройства настроен адрес), затем ГИС МТ (если настроена учётная запись ОФД), затем локальный модуль ЧЗ (если он готов), и использует первый доступный способ.
По умолчанию используется ГИС МТ и ЛМ ЧЗ.
URL: {{HTTPRoot}}/marking/km/verify
Тело запроса
{
"DeviceName": "{device}",
"Codes": [
"MDEwNDY3MDU0MDE3NjA5OTIxNSdXOVVtHTkzZEdWeg=="
]
}
| Имя поля | Тип | Обяз | Назначение | Пример |
|---|---|---|---|---|
| DeviceName | string | + | Название устройства | “Atol” |
| codes | string[] | + | Массив проверяемых кодов маркировки в кодировке Base64. | [“MDEwNDY3MDU0MDE3NjA5OTIxNSdXOVVtHTkzZEdWeg==”] |
Тело ответа
Успешный ответ (200 OK)
{
"Result": {
"code": 0,
"description": "ok",
"codes": [
{
"cis": "0104670540176099215'W9Um?93dGVz",
"valid": true,
"printView": "0104670540176099215'W9Um",
"groupIds": [
8
],
"verified": true,
"realizable": false,
"utilised": false,
"errorCode": 0,
"message": null,
"isTracking": false,
"sold": false,
"gtin": "04670540176099",
"packageType": "UNIT",
"producerInn": "7725344604",
"grayZone": false,
"isBlocked": false,
"isGreyGtin": false,
"ogvs": [],
"found": true,
"packageQuantity": 0
}
],
"reqId": "2c3ec23e-da52-4f28-aa10-1b27e77e36c2",
"reqTimestamp": 1784078114481,
"isCheckedOffline": false,
"status": 0,
"requiresDownload": false,
"lastUpdate": 0,
"lastSync": 0
},
"Code": 0,
"Description": "OK",
"Success": true
}
Поле Result
Тип: CheckCodeMarkAnswer
| Имя поля | Тип | Назначение | Пример |
|---|---|---|---|
| code | int | Код результата обращения к API «Честного Знака» | 0 |
| description | string | Описание результата | “OK” |
| reqId | string | Идентификатор запроса в сервисе «Честного Знака» | “a1b2c3d4-e5f6-7890-abcd-ef1234567890” |
| reqTimestamp | long | Время выполнения проверки КМ (Unix-время в миллисекундах) | 1781076703146 |
| status | int | Статус локального модуля ЧЗ, используемого ТС ПИоТ для офлайн-проверки: 0 — unknown, неизвестно; 1 — ready (готов к работе); 2 — initialization (идёт инициализация); 3 — failure (ошибка); 4 — not_configured (не инициализирован) |
“OK” |
| requiresDownload | bool | Признак необходимости скачать или обновить локальную базу данных модуля ЧЗ перед офлайн-проверкой | false |
| lastUpdate | long | Время последнего обновления локальной базы данных модуля. 0 — нет данных / не актуально. |
0 |
| lastSync | long | Время последней синхронизации модуля с ГИС МТ. 0 — нет данных. |
0 |
| codes | массив типа данных | Результат проверки по каждому коду маркировки, переданному в запросе. | “codes”: [ { “Cis”: “0104670540176099215’W9Um93dGVz”, “valid”: true, “verified”: true, “realizable”: true, “utilised”: true, “found”: true, “sold”: true, “isBlocked”: true, “isGreyGtin”: true, “gtin”: “04670540176099”, “groupIds”: [8] } ] |
Тип: codes
| Имя поля | Тип | Назначение | Пример |
|---|---|---|---|
| cis | string | Полный код маркировки | “0104670540176099215’W9Um93dGVz” |
| valid | bool | Результат проверки валидности структуры кода идентификации (КИ) / кода маркировки (КиЗ). true — структура валидна, false — не валидна. |
true |
| printView | string | Код маркировки без крипто-подписи | “0104670540176099215’W9Um” |
| groupIds | int[] | Массив идентификаторов товарных групп. 1 (lp) — Предметы одежды, бельё постельное, столовое, туалетное и кухонное 2 (shoes) — Обувные товары 3 (tobacco) — Табачная продукция 4 (perfumery) — Духи и туалетная вода 5 (tires) — Шины и покрышки пневматические резиновые новые 6 (electronics) — Фотокамеры (кроме кинокамер), фотовспышки и лампы-вспышки 8 (milk) — Молочная продукция 9 (bicycle) — Велосипеды и велосипедные рамы 10 (wheelchairs) — Медицинские изделия 12 (otp) — Альтернативная табачная продукция 13 (water) — Упакованная вода 14 (furs) — Товары из натурального меха 15 (beer) — Пиво, напитки, изготавливаемые на основе пива, слабоалкогольные напитки 16 (ncp) — никотиносодержащая продукция 17 (bio) — Биологически активные добавки к пище 19 (antiseptic) — Антисептики и дезинфицирующие средства 20 (petfood) — Корма для животных 21 (seafood) — Морепродукты 22 (nabeer) — Безалкогольное пиво 23 (softdrinks) — Соковая продукция и безалкогольные напитки 26 (vetpharma) — Ветеринарные препараты 27 (toys) — Игры и игрушки для детей 28 (radio) — Радиоэлектронная продукция 31 (titan) — Титановая металлопродукция 32 (conserve) — Консервированная продукция 33 (vegetableoil) — Растительные масла 34 (opticfiber) — Оптоволокно и оптоволоконная продукция 35 (chemistry) — Парфюмерные и косметические средства и бытовая химия 38 (pharmaraw) — Фармацевтическое сырьё, лекарственные средства |
[8] |
| verified | bool | Результат криптографической проверки кода. Для всех товарных групп, кроме “Товары из натурального меха”: true — проверка крипто-подписи успешна, false — проверка крипто-подписи завершилась с ошибкой. Для “Товаров из натурального меха”: true — КиЗ найден в “ИР Маркировки”. false — КиЗ не найден в “ИР Маркировки”. |
true |
| realizable | bool | Признак того, что код находится в статусе “В обороте” | true |
| utilised | bool | Признак нанесения кода на упаковку товара | true |
| found | bool | Признак того, что код найден в ГИС МТ | true |
| errorCode | int | Код ошибки. 0 — ошибки отсутствуют; 1 — «Ошибка валидации КМ»; 2 — “КМ не содержит GTIN”; 3 — “КМ не содержит серийный номер”; 4 — “КМ содержит недопустимые символы”; 5 — “Ошибка верификации крипто-подписи КМ(формат крипто-подписи не соответствует типу КМ)”; 6 — “Ошибка верификации крипто-подписи КМ(крипто-подпись не валидная)”; 7 — “Ошибка верификации крипто-подписи КМ(крипто-ключ не валиден)”; 8 — “КМ не прошел верификацию в стране эмитента”; 9 — “Найденные AI в КМ не поддерживаются”; 10 — “КМ не найден в ГИС МТ” |
0 |
| message | string | Сообщение об ошибке | null |
| isTracking | bool | Признак старта прослеживаемости в товарной группе. true — прослеживаемость в товарной группе для данного КИ / КиЗ включена; false — прослеживаемость в товарной группе для данного КИ /КиЗ не включена |
true |
| sold | bool | Признак того, что товар с данным кодом уже продан | true |
| gtin | string | Код товара (GTIN) | “04670540176099” |
| packageType | string | Тип упаковки. Для товарной группы “Товары из натурального меха” значение всегда UNIT. UNIT, Единица товара (КИ) — Пачка, Потребительская упаковка; GROUP, Групповая — упаковка (КИГУ); SET — Набор (КИН); BUNDLE, Комплект (КИК) — Комплект (КИК). Используется только для товарной группы “Предметы одежды, бельё постельное, столовое, туалетное и кухонное”; BOX — Транспортная упаковка (КИТУ); ATK — Агрегированный таможенный код (АТК). В составе АТК может быть: - КИ; - КИК; - КИГУ (кроме товарной группы “Медицинские изделия”); - КИТУ (только для товарных групп “Антисептики и дезинфицирующие средства”, “Биологически активные добавки к пище”, “Медицинские изделия”, “Пиво, напитки, изготавливаемые на основе пива, слабоалкогольные напитки”, “Соковая продукция и безалкогольные напитки”, “Упакованная вода”). Возвращаются в ответе: LEVEL1 — Транспортная упаковка 1-го уровня (КИТУ). Также может быть групповой упаковкой (КИГУ) — блок. LEVEL2 — Транспортная упаковка 2-го уровня(КИТУ), Короб. LEVEL3 — Транспортная упаковка 3-го уровня (КИТУ), Палета. LEVEL4 — Транспортная упаковка 4-го уровня(КИТУ). LEVEL5 — Транспортная упаковка 5-го уровня(КИТУ) |
“UNIT” |
| producerInn | string | ИНН производителя | “7725344604” |
| grayZone | bool | Признак нахождения продукции в “серой зоне” (только для товарных групп “Альтернативная табачная продукция”, “Никотиносодержащая продукция”, “Табачная продукция”). Возможные значения: true — находится в серой зоне; false — не находится в серой зоне. |
false |
| isBlocked | bool | Признак блокировки кода по решению органа государственной власти (ОГВ) | true |
| isGreyGtin | bool | Признак некорректного (не зарегистрированного в справочниках) GTIN в составе кода | true |
| ogvs | string[] | Органы государственной власти, установившие блокировку кода (заполняется при isBlocked = true): RAR — Росалкогольрегулирование; FTS — ФТС России; FNS — ФНС России; RSHN — Россельхознадзор; RPN — Роспотребнадзор; MVD — МВД России; RZN — Росздравнадзор. |
[] |
| found | bool | Признак наличия КМ в ГИС МТ. true — КМ найден; false — КМ не найден |
true |
| packageQuantity | int | Ёмкость КИГУ. Количество потенциально вмещаемых вложений |
0 |
Примеры ошибок
522 — Не найдена учётная запись ГИС МТ
{
"Result": {
"code": 522,
"description": "Не найдена учётная запись ГИС МТ",
"reqId": "00000000-0000-0000-0000-000000000000",
"reqTimestamp": 0,
"status": 0,
"requiresDownload": false,
"lastUpdate": 0,
"lastSync": 0
},
"Code": 0,
"Description": "OK",
"Success": true
}
POST marking/km/tspiot/verify
Проверка кодов маркировки через ТС ПИоТ.
Для работы запроса на устройстве должен быть настроен адрес ТС ПИоТ
URL: {{HTTPRoot}}/marking/km/tspiot/verify
Тело запроса
{
"DeviceName": "{device}",
"Codes": [
"MDEwNDY3MDU0MDE3NjA5OTIxNSdXOVVtHTkzZEdWeg=="
]
}
Смотрите документацию POST-запроса marking/km/verify
Тело ответа
Успешный ответ (200 OK)
{
"Result": {
"code": 0,
"description": "ok",
"codes": [
{
"cis": "0104670540176099215'W9Um?93dGVz",
"valid": true,
"printView": "0104670540176099215'W9Um",
"groupIds": [
8
],
"verified": true,
"realizable": false,
"utilised": false,
"errorCode": 0,
"message": null,
"isTracking": false,
"sold": false,
"gtin": "04670540176099",
"packageType": "UNIT",
"producerInn": "7725344604",
"grayZone": false,
"isBlocked": false,
"isGreyGtin": false,
"ogvs": [],
"found": true,
"packageQuantity": 0
}
],
"reqId": "360fa86e-699e-43c5-bf48-67c4c083f470",
"reqTimestamp": 1784078640671,
"isCheckedOffline": false,
"status": 0,
"requiresDownload": false,
"lastUpdate": 0,
"lastSync": 0
},
"Code": 0,
"Description": "OK",
"Success": true
}
Смотрите документацию POST-запроса marking/km/verify
Примеры ошибок
-1 — Устройство ‘{device}’ не найдено
{
"Code": -1,
"Description": "Устройство '{device}' не найдено",
"Success": false
}
-1 — Не заполнено поле DeviceName
{
"Code": -1,
"Description": "Не заполнено поле DeviceName",
"Success": false
}
-1 — Для устройства не настроен адрес ТС ПИоТ
{
"Code": -1,
"Description": "Для устройства 'atol2' не настроен адрес ТС ПИоТ",
"Success": false
}
POST marking/km/lmcz/verify
Проверка кодов маркировки через локальный модуль “Честного Знака” (ЛМ ЧЗ).
URL: {{HTTPRoot}}/marking/km/lmcz/verify
Тело запроса
{
"DeviceName": "{device}",
"Codes": [
"MDEwNDY3MDU0MDE3NjA5OTIxNSdXOVVtHTkzZEdWeg=="
]
}
Смотрите документацию POST-запроса marking/km/verify
Тело ответа
Успешный ответ (200 OK)
{
"Result": {
"code": 0,
"description": "OK",
"codes": [
{
"cis": "0104670540176099215'W9Um",
"valid": false,
"verified": false,
"realizable": false,
"utilised": false,
"isTracking": false,
"sold": false,
"gtin": "04670540176099",
"grayZone": false,
"isBlocked": false,
"isGreyGtin": false,
"found": false,
"packageQuantity": 0
}
],
"reqId": "b0bbb45a-e773-8b63-32e6-da06f1002466",
"reqTimestamp": 1781077845362,
"isCheckedOffline": true,
"version": "019e978f-e682-7b78-8127-e7cf95b63586",
"status": 0,
"serviceUrl": "127.0.0.1:5995",
"requiresDownload": false,
"lastUpdate": 0,
"lastSync": 0,
"inst": "019eb008-c2d2-7889-b91a-a3455dc42384"
},
"Code": 0,
"Description": "OK",
"Success": true
}
Поле Result
Тип: CheckCodeMarkAnswer
| Имя поля | Тип | Назначение | Пример |
|---|---|---|---|
| code | int | Код результата проверки (0 — без ошибок) | 0 |
| description | string | Описание результата | “OK” |
| reqId | string | Идентификатор запроса | “b0bbb45a-e773-8b63-32e6-da06f1002466” |
| reqTimestamp | long | Время выполнения проверки кода маркировки (Unix-время в миллисекундах) | 1781077845362 |
| isCheckedOffline | bool | Признак офлайн-проверки через локальный модуль | true |
| status | int | Статус локального модуля ЧЗ: 0 — unknown, неизвестно; 1 — ready (готов к работе); 2 — initialization (идёт инициализация); 3 — failure (ошибка); 4 — not_configured (не инициализирован) |
0 |
| requiresDownload | bool | Признак необходимости скачать или обновить локальную базу данных модуля перед офлайн-проверкой | false |
| lastUpdate | long | Время последнего обновления локальной базы данных модуля. 0 — данных нет или неактуально. | 0 |
| lastSync | long | Время последней синхронизации модуля с ГИС МТ. 0 — данных нет. | 0 |
| version | string | Версия локального модуля | “019e978f-e682-7b78-8127-e7cf95b63586” |
| inst | string | Идентификатор экземпляра локального модуля ЧЗ | “019eb008-c2d2-7889-b91a-a3455dc42384” |
| serviceUrl | string | Адрес локального модуля ЧЗ, к которому фактически было выполнено обращение | “127.0.0.1:5995” |
| codes | Массив типа данных | Результат по каждому КМ | “codes”: [ { “cis”: “0104670540176099215’W9Um”, “valid”: false, “verified”: false, “realizable”: false, “utilised”: false, “isTracking”: false, “sold”: false, “gtin”: “04670540176099”, “grayZone”: false, “isBlocked”: false, “isGreyGtin”: false, “found”: false, “packageQuantity”: 0 } ] |
Тип: codes
| Имя поля | Тип | Назначение | Пример |
|---|---|---|---|
| cis | string | Полный код маркировки | “0104670540176099215’W9Um93dGVz” |
| valid | bool | Результат проверки валидности структуры кода идентификации (КИ) / кода маркировки (КиЗ). true — структура валидна, false — не валидна. |
true |
| printView | string | Код маркировки без крипто-подписи | “0104670540176099215’W9Um” |
| groupIds | int[] | Массив идентификаторов товарных групп. 1 (lp) — Предметы одежды, бельё постельное, столовое, туалетное и кухонное 2 (shoes) — Обувные товары 3 (tobacco) — Табачная продукция 4 (perfumery) — Духи и туалетная вода 5 (tires) — Шины и покрышки пневматические резиновые новые 6 (electronics) — Фотокамеры (кроме кинокамер), фотовспышки и лампы-вспышки 8 (milk) — Молочная продукция 9 (bicycle) — Велосипеды и велосипедные рамы 10 (wheelchairs) — Медицинские изделия 12 (otp) — Альтернативная табачная продукция 13 (water) — Упакованная вода 14 (furs) — Товары из натурального меха 15 (beer) — Пиво, напитки, изготавливаемые на основе пива, слабоалкогольные напитки 16 (ncp) — никотиносодержащая продукция 17 (bio) — Биологически активные добавки к пище 19 (antiseptic) — Антисептики и дезинфицирующие средства 20 (petfood) — Корма для животных 21 (seafood) — Морепродукты 22 (nabeer) — Безалкогольное пиво 23 (softdrinks) — Соковая продукция и безалкогольные напитки 26 (vetpharma) — Ветеринарные препараты 27 (toys) — Игры и игрушки для детей 28 (radio) — Радиоэлектронная продукция 31 (titan) — Титановая металлопродукция 32 (conserve) — Консервированная продукция 33 (vegetableoil) — Растительные масла 34 (opticfiber) — Оптоволокно и оптоволоконная продукция 35 (chemistry) — Парфюмерные и косметические средства и бытовая химия 38 (pharmaraw) — Фармацевтическое сырьё, лекарственные средства |
[8] |
| verified | bool | Результат криптографической проверки кода. Для всех товарных групп, кроме “Товары из натурального меха”: true — проверка крипто-подписи успешна, false — проверка крипто-подписи завершилась с ошибкой. Для “Товаров из натурального меха”: true — КиЗ найден в “ИР Маркировки”. false — КиЗ не найден в “ИР Маркировки”. |
true |
| realizable | bool | Признак того, что код находится в статусе “В обороте” | true |
| utilised | bool | Признак нанесения кода на упаковку товара | true |
| found | bool | Признак того, что код найден в ГИС МТ | true |
| errorCode | int | Код ошибки. 0 — ошибки отсутствуют; 1 — «Ошибка валидации КМ»; 2 — “КМ не содержит GTIN”; 3 — “КМ не содержит серийный номер”; 4 — “КМ содержит недопустимые символы”; 5 — “Ошибка верификации крипто-подписи КМ(формат крипто-подписи не соответствует типу КМ)”; 6 — “Ошибка верификации крипто-подписи КМ(крипто-подпись не валидная)”; 7 — “Ошибка верификации крипто-подписи КМ(крипто-ключ не валиден)”; 8 — “КМ не прошел верификацию в стране эмитента”; 9 — “Найденные AI в КМ не поддерживаются”; 10 — “КМ не найден в ГИС МТ” |
0 |
| message | string | Сообщение об ошибке | null |
| isTracking | bool | Признак старта прослеживаемости в товарной группе. true — прослеживаемость в товарной группе для данного КИ / КиЗ включена; false — прослеживаемость в товарной группе для данного КИ /КиЗ не включена |
true |
| sold | bool | Признак того, что товар с данным кодом уже продан | true |
| gtin | string | Код товара (GTIN) | “04670540176099” |
| packageType | string | Тип упаковки. Для товарной группы “Товары из натурального меха” значение всегда UNIT. UNIT, Единица товара (КИ) — Пачка, Потребительская упаковка; GROUP, Групповая — упаковка (КИГУ); SET — Набор (КИН); BUNDLE, Комплект (КИК) — Комплект (КИК). Используется только для товарной группы “Предметы одежды, бельё постельное, столовое, туалетное и кухонное”; BOX — Транспортная упаковка (КИТУ); ATK — Агрегированный таможенный код (АТК). В составе АТК может быть: - КИ; - КИК; - КИГУ (кроме товарной группы “Медицинские изделия”); - КИТУ (только для товарных групп “Антисептики и дезинфицирующие средства”, “Биологически активные добавки к пище”, “Медицинские изделия”, “Пиво, напитки, изготавливаемые на основе пива, слабоалкогольные напитки”, “Соковая продукция и безалкогольные напитки”, “Упакованная вода”). Возвращаются в ответе: LEVEL1 — Транспортная упаковка 1-го уровня (КИТУ). Также может быть групповой упаковкой (КИГУ) — блок. LEVEL2 — Транспортная упаковка 2-го уровня(КИТУ), Короб. LEVEL3 — Транспортная упаковка 3-го уровня (КИТУ), Палета. LEVEL4 — Транспортная упаковка 4-го уровня(КИТУ). LEVEL5 — Транспортная упаковка 5-го уровня(КИТУ) |
“UNIT” |
| producerInn | string | ИНН производителя | “7725344604” |
| grayZone | bool | Признак нахождения продукции в “серой зоне” (только для товарных групп “Альтернативная табачная продукция”, “Никотиносодержащая продукция”, “Табачная продукция”). Возможные значения: true — находится в серой зоне; false — не находится в серой зоне. |
false |
| isBlocked | bool | Признак блокировки кода по решению органа государственной власти (ОГВ) | true |
| isGreyGtin | bool | Признак некорректного (не зарегистрированного в справочниках) GTIN в составе кода | true |
| ogvs | string[] | Органы государственной власти, установившие блокировку кода (заполняется при isBlocked = true): RAR — Росалкогольрегулирование; FTS — ФТС России; FNS — ФНС России; RSHN — Россельхознадзор; RPN — Роспотребнадзор; MVD — МВД России; RZN — Росздравнадзор. |
[] |
| found | bool | Признак наличия КМ в ГИС МТ. true — КМ найден; false — КМ не найден |
true |
| packageQuantity | int | Ёмкость КИГУ. Количество потенциально вмещаемых вложений |
0 |
Примеры ошибок
11 — Не найден доступный и готовый локальный модуль ЧЗ
{
"Code": 11,
"Description": "Не найден доступный и готовый локальный модуль ЧЗ",
"Success": false
}