Оглавление

Перечень принятых сокращений

Сокращение Расшифровка

ЕЛК

Единый личный кабинет

НИС «ASL BELGISI»

Национальная информационная система мониторинга маркировки и отслеживания продукции «ASL BELGISI»

КИ

Код идентификации

КИГУ

Код идентификации групповой упаковки

КМ

Код маркировки

НДС

Налог на добавленную стоимость

НК

Национальный каталог

СКЗИ

Средства криптографической защиты информации

ТГ

Товарная группа

ТН ВЭД

Товарная номенклатура внешнеэкономической деятельности

УКЭП

Усиленная квалифицированная электронная подпись

УОТ

Участник оборота товаров

ЭП

Электронная подпись

API

(англ. Application Programming Interface) - Интерфейс прикладного программирования

CSV

(англ. Comma-Separated Values) - Текстовый формат, предназначенный для представления табличных данных

GTIN

(англ. Global Trade Item Number) - Международный код маркировки и учёта логистических единиц

JSON

(англ. JavaScript Object Notation) - Текстовый формат обмена данными, основанный на JavaScript

MIME

(англ. Multipurpose Internet Mail Extensions) - Cпецификация для кодирования информации и форматирования сообщений

TLS

(англ. Transport Layer Security) - Протокол защиты транспортного уровня

URL

(англ. Uniform Resource Locator) - Определитель местонахождения ресурса

XML

(англ. eXtensible Markup Language) - Расширяемый язык разметки

XSD

Язык описания структуры XML-документа

ZIP

Формат архивации файлов

1. Общие положения

1.1. Общая информация

Для работы с интерфейсом True-API необходимо зарегистрироваться в НИС «ASL BELGISI» через единый личный кабинет (далее - ЕЛК) НИС «ASL BELGISI»: https://asllikbelgisi.uz/login-kep. Участнику оборота товаров (далее - УОТ) необходимо иметь ЕЛК с подключенной товарной группой (далее - ТГ), по которой планируется передача сведений по кодам маркировки (далее - КМ). После успешной аутентификации пользователь может работать с методами интерфейса прикладного программирования (далее - API) True-API и оперировать данными исключительно в рамках зарегистрированной им в НИС «ASL BELGISI» товарной группы (ТГ). Для всех методов интерфейса True-API используется единый адрес сервера (url стенда, хост): https://asllikbelgisi.uz/api/v3/true-api/.

1.2. Принципы взаимодействия с True-API

Взаимодействие участников эксперимента и оператора НИС «ASL BELGISI» осуществляется в электронном виде. Обмен документами на бумажном носителе не предусмотрен. Электронное взаимодействие осуществляется по одному из двух вариантов:

  1. Предоставление сведений — обмен электронными документами, на основании которых могут вноситься изменения в реестры НИС «ASL BELGISI». Представление сведений определено как обязанность участников.

  2. Запрос сведений — обмен, при котором сведения из реестров НИС «ASL BELGISI» предоставляются участникам в соответствии с установленными разрешениями на получение сведений. При этом изменения в реестры не вносятся. Запрос и последующее представление сведений из НИС «ASL BELGISI» инициируется участником по своему усмотрению и применяется, например, для проверки статусов КМ или статуса регистрации участника.

Электронное взаимодействие осуществляется путем обмена электронными документами в соответствии с определенным порядком. Для юридически значимых электронных документов применяется усиленная квалифицированная электронная подпись (далее - УКЭП). Электронное взаимодействие осуществляется с применением программных интерфейсов взаимодействия (API) НИС «ASL BELGISI» и информационных систем участников.

При взаимодействии через API выполняются следующие требования:

  1. Аутентификация и авторизация участника (определение полномочий на осуществление электронного взаимодействия) осуществляется при помощи УКЭП.

  2. При предоставлении и запросе сведений защита передаваемых данных выполняется с применением протокола TLS/HTTPS шифрованием канала передачи данных сертифицированными средствами криптографической защиты информации (далее - СКЗИ).

1.2.1. Информация о ошибках при запросах методов True-API

Возвращаемые методом ошибки имеют следующий общий формат:

Код Наименование Описание Формат сообщения об ошибке

200

ОК

Статус ответа в случае успеха

201

CREATED

Статус ответа в случае успеха

202

ACCEPTED

Статус ответа в случае успеха

400

ERROR Bad Request

Ошибка в параметрах запроса (отсутствует обязательный параметр)

Общий формат:

"Content-Type": application/json
body:
{
"error_message": "<текст сообщения об ошибке>"
}

1) Пример формата для всех методов и для методов национального каталога (далее - НК) (только при отсутствии параметра apikey или feed):

{
"error_message": "Отсутствует обязательный параметр: <имя обязательного параметра>"
}

2) Пример формата для НК-методов при отсутствии остальных параметров:

{
"error_message": "Ошибка в параметрах запроса"
}

Ошибка в параметрах запроса (неверный тип параметра)

1) Пример формата для всех методов, кроме НК:

{
"error_message": "Параметр <имя параметра> требует значение типа <требуемый тип параметра>"
}

2) Пример формата для НК-методов:

{
"error_message": "Ошибка в параметрах запроса"
}

401

ERROR Unauthorized

Ошибка авторизации. Информация об ошибке возвращается в формате XML

1) Пример формата для случая, если не указан токен для всех методов, требующих токен:

<UnauthorizedException>
<error>unauthorized</error>
<error_description>Full authentication is required to access this resource</error_description>
</UnauthorizedException>

2) Пример формата для случая, если указан устаревший токен для всех методов, требующих токен:

<InvalidTokenException>
<error>invalid_token</error>
<error_description>Access token expired: <токен></error_description>
</InvalidTokenException>

402

ERROR

Ошибка в атрибутивном составе тела запроса

403

ERROR Forbidden

Доступ запрещён

Пример формата для случая, если пользователь (УОТ) не имеет доступа к конкретному удаленному сервису (а для НК-методов если указан неправильный ключ API):

{
"error_message": "Отсутствует доступ к ресурсу"
}

404

ERROR Not Found

Запрашиваемая информация не найдена в НИС «ASL BELGISI»

1) Пример формата для всех методов, кроме НК:

{
"error_message": "<Описание параметра> не найден"
}

2) Пример формата для НК-методов:

{
"error_message": "Данные не найдены"
}

Ошибка в указании URL метода

Пример формата:

{
"error_message": "Метод с указанным URL не найден"
}

409

ERROR

Запрос не может быть выполнен из-за конфликтного обращения к ресурсу

410

ERROR

Ресурс ранее был доступен по указанному URL, но сейчас он удалён и недоступен

413

ERROR

Превышен допустимый размер тела запроса

Пример формата:

{
"error_message": "Слишком большой запрос"
}

500

ERROR Internal Server Error

Внутренняя ошибка удалённых систем (технически детализированное описание не возвращается)

Пример формата:

{
"error_message": "Ошибка при выполнении запроса"
}

503

ERROR Service Unavailable

Проблема с доступом к удалённой системе

Пример формата:

{
"error_message": "Удаленная система недоступна"
}

504

ERROR

Ошибка при получении ответа системы

Пример формата:

{
error_message: "Отсутствует ответ системы"
}

1.2.2. Информация о вложенности параметров

Вложенные параметры помечены "*".

Пример вложенности:

Параметр Описание

results

…​

*agentInn

…​

*children

…​

**brand

…​

Читать как: параметр "results" содержит параметры "agentInn" и "children", а "children" содержит параметр "brand".

1.2.3. Требования к файлам обмена

Файл обмена должен подписываться УКЭП лица, имеющего право действовать от имени УОТ, и соответствовать следующим требованиям:

  1. Файл формата JSON:

    • для обмена с НИС «ASL BELGISI» используется JSON стандарта RFC 7159 (https://tools.ietf.org/html/rfc7159);

    • использует кодировку UTF-8;

    • в результирующем JSON также может содержаться набор полей, специфичных для конкретного товара.

  2. Файл обмена формата CSV:

    • соответствует стандарту RFC 4180;

    • использует кодировку UTF-8;

    • содержит символ "," в контенте файла в качестве разделителя.

  3. Файл обмена формата XML:

    • XML-формат описан в XSD-схемах.

    • содержит единственный экземпляр электронного документа;

    • использует кодировку UTF-8;

    • содержит первую строку вида <?xml version="1.0" encoding="utf-8"?>;

    • определяет стандартные типы данных в соответствии со стандартом ISO (https://www.w3schools.com/xml/schema_dtypes_date.asp);

    • проверяется на корректность на основании XSD-схемы - логической модели для обмена информацией, описывающей логические элементы и атрибуты XML-файлов.

Максимальный размер документа, передаваемого по True-API, не должен превышать 30 мегабайт.

Примечание. Согласно стандарту, описывающему содержимое JSON-файлов, допустимы следующие значения: object, array, number, string, true, false, null. Для пояснения ограничений, накладываемых логикой НИС «ASL BELGISI» на обрабатываемые данные, и облегчения программной реализации процессов сериализации/десериализации данных в системах, работающих с True-API, в описании запросов и ответов методов True-API используются обозначения типов данных в стиле языка Java. Например, в некоторых местах вместо number используется integer, decimal. Аналогично используются обозначения типов enum, boolean, Area of (Object), ComplexType.

1.2.4. Экранирование

При передаче параметров запросов API-методов должно быть реализовано экранирование согласно следующим стандартам:

  • при передаче параметров в URL-запросе, должно применяться экранирование согласно стандарту RFC3986 (см. описание стандарта в п. 2.1 https://www.protocols.ru/WP/rfc3986/);

  • при передаче параметров в JSON-строке тела URL-запроса должно применяться экранирование согласно стандарту RFC8259 (см. описание стандарта в п. 7 https://www.protocols.ru/WP/rfc8259/);

  • при использовании CSV-файлов в UNIX-системах для экранирования символа ' (апостроф) используется символ '' (двойной апостроф), при этом кавычки не экранируются, экранирование осуществляется согласно стандарту rfc180 (см. описание стандарта в https://tools.ietf.org/html/rfc4180);

  • при передаче параметров в XML-строке тела запроса URL должно применяться экранирование согласно стандарту W3C (см. описание стандарта https://www.w3.org/TR/xml/).

Обязательные экранируемые символы:

1.При работе посредством открытого API с использованием GET запросов с кодами идентификации (КИ) в строке запроса URL применяется экранирование по стандарту rfc3986 для следующих специальных символов:

Обязательные экранируемые символы при передаче параметров в URL запросе:

Символ Название символа Экранируемый символ

!

Восклицательный знак

%21

"

Двойная кавычка

%"22

%

Знак процента

%25

&

Амперсанд

%26

'

Одинарная кавычка (апостроф)

%27

(

Открывающая круглая скобка

%28

)

Закрывающая круглая скобка

%29

*

Звездочка

%2A

+

Плюс

%2B

,

Запятая

%2C

-

Минус (тире)

%2D

.

Точка

%2E

/

Слэш

%2F

:

Двоеточие

%3A

;

Точка с запятой

%3B

<

Меньше

%3C

=

Равно

%3D

>

Больше

%3E

?

Вопросительный знак

%3F

\

Обратный слэш (бэкслэш)

%5C

_

Нижнее подчеркивание

%5F

Пример:

./cises/aggregated/list?codes=0104650117240408211dmfcZNcM"4 =>
./cises/aggregated/list?codes=0104650117240408211dmfcZNcM%224

2.Для JSON по стандарту rfc8259 применяется следующее обязательное экранирование:

Обязательные экранируемые символы при передаче КИ в параметре GET запроса API:

Символ Название символа Экранируемый символ

"

Двойная кавычка

%22

%

Знак процента

%25

&

Амперсанд

%26

+

Плюс

%2B

[

Открывающаяся квадратная скобка

%5B

]

Закрывающаяся квадратная скобка

%5D

\

Обратный слэш (бэкслэш)

%5C

{

Открывающаяся фигурная скобка

%7B

}

Закрывающаяся фигурная скобка

%7D

|

Вертикальная черта

%7C

Пример:

010460026601035321t%7*S+4 =>
010460026601035321t%257*S%2B4

При работе (посредством открытого API с использованием POST запросов в формате JSON) в строке с КИ при наличии символа двойной кавычки ( " ) необходимо экранировать символом бэкслэш ( \ ).

Пример:

0104650117240408211dmfcZNcM"4 =>
0104650117240408211dmfcZNcM\"4

3.Пример экранирования для CSV файлов по стандарту rfc180:

"010481097886269421''5LLRY<%"JZTVZ"

4.Пример экранирования для XML файлов по стандарту W3C:

<cis>0104650117240408211dmfcZNcM<4</cis>
cis>0104650117240408211dmfcZNcM&lt;4</cis

1.2.5. Тип возвращаемого API-методами контента

Методы True-API преимущественно возвращают ответы в формате JSON, т.е. MIME-type application/json. Некоторые методы в корректном ответе возвращают двоичное содержимое (например, документы в ZIP) MIME-type application/zip или application/octet-stream, а в случае ошибки - описание этой самой ошибки в JSON. Таким образом, один и тот же метод в зависимости от ситуации может вернуть разные типы содержимого (контента).

Для корректной работы методов True-API параметр Accept заголовка запроса должен быть установлен так, чтобы учитывались все возможные ответы сервера, т.е. и application/zip, и application/json. Самый простой вариант - использовать универсальный шаблон:

Accept: /

Для ограничения набора возвращаемых типов контента можно указывать несколько заголовков запроса методов True-API:

Accept: application/octet-stream
Accept: application/json

Если в перечне заголовков запроса методов True-API не окажется ни одного подходящего под сгенерированный сервером ответ, то True-API вернется ответ c кодом = 406 (Not Acceptable) с пустым телом ответа.

Вернуться к разделу "Оглавление".

2. Аутентификация

2.1. GET /auth/key

Запрос авторизации при единой аутентификации.

Для работы с интерфейсом True-API необходимо зарегистрироваться в Системе через личный кабинет (ЛК) НИС «ASL BELGISI»: https://asllikbelgisi.uz/login-kep.

Участнику оборота товаров (УОТ) необходимо иметь ЛК с подключенной товарной группой (ТГ), по которой планируется передача сведений по кодам маркировки (КМ).

После успешной аутентификации пользователь сможет работать с методами API и оперировать данными исключительно в рамках ТГ, зарегистрированной им в НИС «ASL BELGISI».

Метод предназначен для получения аутентификационного токена по УКЭП:

  1. Пользователь получает пару "UUID - data", где UUID - идентификатор текущей аутентификации, data - строка на подпись пользователю.

  2. Пользователь отправляет в НИС «ASL BELGISI» данные в том же виде, в котором они ему пришли (пару "UUID - data"), только теперь data - это строка, подписанная его УКЭП.

  3. Сервер отвечает на запрос либо сообщением с кодом 200 (OK) и токеном, либо сообщением об ошибке.

Описание запроса

Параметр Значение

URL

<url стенда>/auth/key

Метод

GET

Пример запроса

GET <url стенда>/auth/key

Принимаемые параметры

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

UUID

Уникальный идентификатор сгенерированных случайных данных

String

Да

data

Случайная строка данных в формате BASE64

String

Да

Пример успешного ответа

{
   "uuid": "a63ff582-b723-4da7-958b-453da27a6c62",
   "data": "GNUFBAZBMPIUUMLXNMIOGSHTGFXZMT"
}

2.2. POST /auth/simpleSignIn

Получение ключа сессии при единой аутентификации.

  1. Пользователь отправляет в НИС «ASL BELGISI» данные в том же виде, в котором они ему пришли (пару "uuid - data"), только теперь data - это строка, подписанная его УКЭП.

  2. Сервер отвечает на запрос либо сообщением с кодом 200 (успешно) и токеном, либо сообщением об ошибке.

Описание запроса

Параметр Значение

URL

<url стенда>/auth/simpleSignIn

Метод

POST

Content-Type

application/json

Передаваемые параметры

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

UUID

Уникальный идентификатор подписанных случайных данных

String

Да

data

Подписанные УКЭП зарегистрированного УОТ - случайные данные в формате BASE64 (ЭП присоединенная)

String

Да

Пример запроса

POST /auth/simpleSignIn
Content-Type: application/json; charset=utf-8
cache-control: no-cache
{
    "uuid": "a63ff582-b723-4da7-958b-453da27a6c62",
    "data": "GNUFBAZBMPIUUMLXNMIOGSHTGFXZMT"
}

Принимаемые параметры

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

token

Аутентификационный токен в формате BASE64. Указывается в случае успешного ответа

String

Нет

code

Код ошибки. Указывается в случае неуспешного ответа

String

Нет

error_message

Сообщение об ошибке

String

Нет

description

Описание ошибки

String

Нет

Пример успешного ответа

{
    "token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.e.........mk6qe0lB12w9zEs"
}

Формат и коды ошибок

Код ошибки Описание Формат сообщения об ошибке

400

Операция не выполнена. Если отсутствует поле 'UUID' или 'data'

401

Не авторизован, в запросе отсутствует clientToken

{
"error_message": "Ошибка авторизации или компания не зарегистрирована в НИС «ASL BELGISI»"
}

500

Операция не выполнена. Внутренняя ошибка сервера

2.3. POST /auth/refresh

Продление ключа сессии при единой аутентификации.

  1. Пользователь отправляет запрос в ИС МПТ без параметров (по header по прежнему идентифицируются данные аутентификации/авторизации УОТ).

  2. Сервер отвечает на запрос либо сообщением с кодом 200 (всё ок) и токеном, либо сообщением об ошибке.

Описание запроса

Параметр Значение

URL

<url стенда>/auth/refresh

Метод

POST

Content-Type

application/json

Пример запроса

POST /auth/refresh
Content-Type: application/json; charset=utf-8
cache-control: no-cache

Принимаемые параметры

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

token

Аутентификационный токен в формате BASE64. Указывается в случае успешного ответа

String

Нет

code

Код ошибки. Указывается в случае неуспешного ответа

String

Нет

error_message

Сообщение об ошибке

String

Нет

description

Описание ошибки

String

Нет

Пример успешного ответа

{
    "token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.e.........mk6qe0lB12w9zEs"
}

Формат и коды ошибок

Код ошибки Описание Формат сообщения об ошибке

400

Операция не выполнена. Если отсутствует поле 'UUID' или 'data'

401

Не авторизован, в запросе отсутствует clientToken

{
"error_message": "Ошибка авторизации или компания не зарегистрирована в НИС «ASL BELGISI»"
}

500

Операция не выполнена. Внутренняя ошибка сервера

Вернуться к разделу "Оглавление".

3. Методы работы с кодами маркировки (КМ)

3.1. POST /cises/my

Запрос на получение списка кодов маркировки для участника оборота товаров.
Запрос списка КМ происходит в несколько этапов:

  • С помощью метода POST /cises/my формируется заказ на список КМ.

  • Проверка статуса заказа с помощью вызова метода GET /cises/orders/{uuid}/status.

  • Получение результата заказа с помощью вызова метода GET /cises/orders/{uuid}/result.

Идентификатор УОТ берется из токена.

Описание запроса

Параметр Значение

URL

<url стенда>/cises/my

Метод

POST

Content-Type

application/json

Authorization

clientToken

Передаваемые параметры

Параметры тела запроса

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

gtin

Код товара.
Для табачных КМ:
- для потребительских упаковок типа "единица товара" применяются проверки типа like 'gtin%';
- для упаковки 1-го уровня применяется конструкция like '(01)gtin(21)%'.

Для нетабачных КМ (применительно к ТГ "Алкогольная продукция"):
для потребительских упаковок типа "единица товара" и упаковок 1-го уровня применяются проверки типа like '01gtin%'

String

Да

packageType

Код типа упаковки. См. справочник "Типы упаковки"

String

Нет

producedDate

Дата нанесения в формате "yyyy-MM-ddTHH:mm:ss.SSS’Z"

String (DateTime)

Нет

Пример запроса

POST <url стенда>/cises/my
Content-Type: application/json
Authorization: Bearer <ТОКЕН>
{
    "gtin": "00000046210654",
    "packageType": "UNIT",
    "producedDate": 2020-04-16T09:29:01.120Z
}"

Принимаемые параметры

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

uuid

Идентификатор заказа. При наличии заказа в НИС «ASL BELGISI»

String

Нет

Пример ответа

{
"uuid": "00000000-0000-0000-0000-000000000000"
}

Формат и коды ошибок

Код ошибки Описание Формат сообщения об ошибке

400

Операция не выполнена. При неверной структуре JSON в теле запроса или отсутствии обязательного поля gtin

{
"error_message": "GTIN должен быть указан в параметрах запроса" }

или

{
"error_message": "Неизвестный GTIN" }

при неверной структуре JSON в теле запроса:

{
"error_message": "JSON parse error: Unexpected character (',' (code 44)): was expecting double-quote to start field name; nested exception is com.fasterxml.jackson.core.JsonParseException: Unexpected character (',' (code 44)): was expecting double-quote to start field name\n at [Source: (PushbackInputStream); line: 2, column: 6]" }

401

Не авторизован, в запросе отсутствует clientToken

403

Нет доступа к запрашиваемой информации

При проверке доступа для зарегистрированных УОТ:
{
"error_message": "Отсутствует доступ к ресурсу"
}
При неподписанном договоре:
{
"error_message": "Отсутствует действующий договор по ТГ"
}

500

Операция не выполнена. Внутренняя ошибка сервера

3.2. GET /cises/orders/{uuid}/status

Запрос проверки статуса заказа на список кодов маркировки. Метод возвращает статус заказа по его идентификатору, полученному методом POST /cises/my.

Описание запроса

Параметр Значение

URL

<url стенда>/cises/orders/{uuid}/status

Метод

GET

Content-Type

application/json

Передаваемые параметры

Параметры заголовка запроса:

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

uuid

Идентификатор заказа

String

Да

Пример запроса

GET <url стенда>/cises/orders/f6a9662a-f7d0-444e-8ae0-3fd29d860a31/status
Authorization: Bearer <ТОКЕН>

Принимаемые параметры

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

status

Код статуса заказа при наличии заказа в НИС «ASL BELGISI». Принимаемые значения:

NEW - Зарегистрирован
PRODUCTION - Производство
VALIDATION_FAILED - Ошибка в проверке
IN PROGRESS - Заказ в процессе выполнения
SUCCESS - Заказ выполнен
ERROR - При выполнении заказа возникла ошибка
RESULT_EXPIRED - Заказ устарел

String

Нет

В случае успеха возвращается код 200 со статусом SUCCESS.

Формат и коды ошибок

Код ошибки Описание Формат сообщения об ошибке

400

Операция не выполнена. При неверном идентификаторе заказа

401

Не авторизован, в запросе отсутствует clientToken

403

Нет доступа к запрашиваемой информации

При проверке доступа для зарегистрированных УОТ:
{
"error_message": "Отсутствует доступ к ресурсу"
}
При неподписанном договоре:
{
"error_message": "Отсутствует действующий договор по ТГ"
}

404

Запрашиваемая информация не найдена

Если указан неверный метод: { "error_message": "Метод с указанным URL не найден" }
Если информация не найдена: { "error_message": "Заказ с идентификатором f6a9662a-f7d0-444e-8ae0-3fd29d860a31 не найден" }

500

Операция не выполнена. Внутренняя ошибка сервера

3.3. GET /cises/orders/{uuid}/result

Запрос результата заказа на список кодов маркировки. Метод возвращает результат заказа по его идентификатору, полученному методом POST /cises/my.

Описание запроса

Параметр Значение

URL

<url стенда>/cises/orders/{uuid}/result

Метод

GET

Content-Type

application/zip

Authorization

clientToken

Передаваемые параметры

Параметры заголовка запроса:

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

uuid

Идентификатор заказа

String

Да

Пример запроса

GET <url стенда>/cises/orders/f6a9662a-f7d0-444e-8ae0-3fd29d860a31/result
Authorization: Bearer <ТОКЕН>

Принимаемые параметры

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

Максимальный размер ZIP-файла ~ 1 Мб. ZIP-файл хранится в НИС «ASL BELGISI» в течение часа.Если ZIP-файл был скачан пользователем, то возможно повторное получение этого файла по UUID заказа. Если был сбой при скачивании zip-файла, то повторное скачивание доступно.

В случае успеха возвращается код 200 с возможностью загрузки архива:

content-disposition: attachment; filename="cis-list.zip"

Файл в архиве содержит информацию о всех КМ для запрошенного GTIN:

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

child

Список дочерних КМ в агрегате

Array of [String]

Нет

cis

КМ

String

Да

gtin

Код товара. Если код товара менее 14 символов, то он дополняется ведущими нулями

String

Да

packageType

Код типа упаковки. См. справочник "Типы упаковки"

String

Да

parent

Родительский КМ

String

Нет

producedDate

Дата ввода товара (для табака) в оборот в формате yyyy-MM-ddTHH:mm:ss.SSS’Z

String (date-time)

Нет

status

Код статуса КМ. См. справочник "Статусы КМ"

String

Да

Пример ответа

[
  {
     "cis": "(01)00000046210654(21)4u4qrBQ",
     "gtin": "00000046210654",
     "producedDate": "2019-12-04T00:46:40Z",
     "parent": "000000462106549OOv1s0XzlzIFDjtcXJjz5cB",
     "child": [
        "00000046210654QuHCUeP",
        "00000046210654kGS951L",
        "00000046210654ndSJVa0"
        ],
     "packageType": "LEVEL1",
     "status": "APPLIED"
  },
  {
     "cis": "(01)00000046210654(21)keFlbgA",
     "gtin": "00000046210654",
     "producedDate": "2019-12-04T00:46:40Z",
     "packageType": "LEVEL1",
     "status": "APPLIED_NOT_PAID"
  },
  {
     "cis": "(01)00000046210654(21)HmfHkrV",
     "gtin": "00000046210654",
     "packageType": "LEVEL1",
     "status": "EMITTED"
  }
]

Формат и коды ошибок

Код ошибки Описание Формат сообщения об ошибке

400

Операция не выполнена. При неверном идентификаторе заказа

401

Не авторизован, в запросе отсутствует clientToken

403

Нет доступа к запрашиваемой информации

При проверке доступа для зарегистрированных УОТ:
{
"error_message": "Отсутствует доступ к ресурсу"
}
При неподписанном договоре:
{
"error_message": "Отсутствует действующий договор по ТГ"
}

404

Запрашиваемая информация не найдена

Если указан неверный метод:
{ "error_message": "Метод с указанным URL не найден" }

Если информация не найдена:
{ "error_message": "Заказ с идентификатором f6a9662a-f7d0-444e-8ae0-3fd29d860a31 не найден" }

500

Операция не выполнена. Внутренняя ошибка сервера

3.4. POST /cises/info

Метод получения подробной информации о кодах маркировки по списку.

Общедоступная информация:

  • информация о КМ;

  • данные о производителе;

  • дата и время производства;

  • текущий статус в обороте;

  • текущий собственник в обороте - показ только владельцу, Оператору и Администратору.

Описание запроса

Параметр Значение

URL

<URL стенда> /cises/info

Метод

POST

Content-Type

application/json

Authorization

clientToken

Передаваемые параметры

Параметры заголовка запроса:

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

pg

Товарная группа. См. справочник "Список поддерживаемых товарных групп"

Array of [String]

Нет

Параметры тела запроса:

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

codes

Массив кодов маркировки. Не более 1000 КМ в массиве

Array of [String]

Да

Пример запроса

POST <url стенда>/cises/info
Authorization: Bearer <ТОКЕН>
Content-Type: application/json
["000000462106549pJu6lt", "(01)00000046210654(21)4u4qrBQ", "00000046177780REVBECpjQnGgflKIlkrXQCBr"]

Принимаемые параметры

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

cisInfo

Список КМ с параметрами. При наличии КМ в НИС «ASL BELGISI»

Object (CisInfoResponseData)

Нет

*requestedCis

КМ из запроса

String

Да

*cis

КМ НИС «ASL BELGISI»

String

Да

*gtin

Код товара

String

Да

*productGroup

Наименование товарной группы. См. справочник "Список поддерживаемых товарных групп"

String

Да

*productGroupId

Идентификатор товарной группы. См. справочник "Список поддерживаемых товарных групп"

Number

Да

*productName

Наименование продукции

String

Нет

*brand

Бренд

String

Нет

*producedDate

Дата ввода товара в оборот

String (DateTime)

Нет

*packageType

Код типа упаковки. См. справочник "Типы упаковки"

String

Да

*ownerInn

ИНН собственника товара

String

Нет

*ownerName

Наименование собственника товара

String

Нет

*status

Код статуса КМ

String

Да

*child

Список дочерних КМ в агрегате

Array of [String]

Нет

*parent

Родительский КМ

String

Нет

*producerInn

ИНН производителя

String

Нет

*producerName

Наименование производителя

String

Нет

*exporterName

Наименование экспортера

String

Нет

errorCode

Код ошибки

String

Нет

errorMessage

Сообщение об ошибке

String

Нет

Пример ответа

[
  {
    "cisInfo": {
      "requestedCis": "00000046177780REVBECpjQnGgflKIlkrXQCBr",
      "cis": "00000046177780REVBECpjQnGgflKIlkrXQCBr",
      "gtin": "04780005557773",
      "productName": "Сигареты \"тест\"",
      "productGroupId": 3,
      "productGroup": "tobacco",
      "brand": "Parlament",
      "producedDate": "2021-01-19T12:05:45.603Z",
      "packageType": "LEVEL2",
      "ownerInn": "306535627",
      "ownerName": "\"CRPT TURON\" MChJ",
      "status": "INTRODUCED",
      "child": [
        "(01)04780005557773(21)NxnwqVN",
        "(01)04780005557773(21)&zhBDTO"
      ],
      "producerInn": "306535627",
      "producerName": "\"CRPT TURON\" MChJ"
    }
  }
]

Примечание. Для владельцев и производителей товаров осуществляется проверка доступа к соответствующей информации по кодам маркировки, которая осуществляется по ИНН из авторизованного токена в таблице КМ на соответствие (prid) для производителей или (o) для владельцев. При полном несоответствии значений ИНН для запрашиваемых КМ в ответе на запрос выводится пустой массив.

Формат и коды ошибок

Код ошибки Описание Формат сообщения об ошибке

400

Операция не выполнена. Неверные входные параметры

{ "error_message": "В запросе не указан ни один КМ" }

При отсутствии тела запроса:

{ "error_message": "Required request body is missing" }

При неверной структуре JSON в теле запроса:

{ "error_message": "JSON parse error: Cannot deserialize instance of …​; line: 1, column: 1]" }

401

Не авторизован, в запросе отсутствует clientToken

403

Нет доступа к запрашиваемой информации

При проверке наличия токена авторизации или доступа для зарегистрированных УОТ:
{
"error_message": "Отсутствует доступ к ресурсу"
}
При неподписанном договоре:
{
"error_message": "Отсутствует действующий договор по ТГ"
}

404

Запрашиваемая информация не найдена

Если ни один из указанных КМ не найден:
{
"error_message": "КМ не найдены"
}

500

Операция не выполнена. Произошла внутренняя ошибка

{
"errorMessage": "Ошибка получения информации о КМ",
"errorCode": "500"
}

3.5. POST /cises/publicInfo

Метод получения сжатой информации о кодах маркировки по списку (аналог POST /cises/info).

Табачные коды по блокам можно указывать в запросах как со скобками для идентификаторов применения, так и без. В ответе код всегда будет возвращаться в том виде, в котором был зарегистрирован в Системе (эмитирован).

Необходимо экранировать спецсимволы КМ, указанных в теле запроса.

Условия успешного запроса Условия корректности кода Ограничения на получение информации по владельцу кодов

- УОТ зарегистрирован в НИС МПТ (статус = REGISTRED)
- УОТ имеет действующий договор на подключение к товарной группе (Статус такого договора = 4 (enabling, т.е. документы подписаны УОТ) или 5 (active, т.е. документы подписаны Оператором))

Код зарегистрирован в НИС МПТ в рамках указанной ТГ (иначе код ошибки)

Ограничений нет

Коды могут не принадлежать текущему УОТ, делающему запрос (информацию по ним все равно выдавать)

Ошибки по одному из выше приведенных пунктов:

- блокируют получение данных по кодам
- вернется http-код 403

Если у кода есть ошибка, то:

- это не блокирует процесс получения данных по остальным кодам
- такие коды помечаются как ошибочные с описанием ошибки
- остальные (корректные) коды показаны с реквизитами

Описание запроса

Параметр Значение

URL

<url стенда>/true-api/cises/publicInfo

Метод

POST

Content-Type

application/json

Authorization

bearer-token

Передаваемые параметры

Параметры заголовка запроса:

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

pg

Товарная группа согласно справочнику товарных групп

Ограничиваем enum до: ТГ "Табачная продукция", ТГ "Алкогольная продукция" и ТГ "Пиво и пивные напитки"

String

Да

Параметры тела запроса:

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

codes

Массив КМ без криптохвоста, криптохвост перед обработкой удаляется. Не более 1000 КМ в массиве.

Указываются как КИ, так и КИГУ/КИТУ

Array of [String]

Да

Пример запроса

POST <url стенда>/cises/publicInfo?pg=3
Authorization: Bearer <ТОКЕН>
Content-Type: application/json
["000000462106549pJu6lt", "(01)00000046210654(21)4u4qrBQ", "00000046177780REVBECpjQnGgflKIlkrXQCBr"]

Принимаемые параметры

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

cisInfo

Элемент массива КМ с параметрами (если найден)

Object (CisInfoResponseData)

Да

*requestedCis

КМ из запроса

String

Да

*productGroup

Наименование товарной группы. См. справочник "Список поддерживаемых товарных групп"

String

Нет

*productGroupId

Идентификатор товарной группы. См. справочник "Список поддерживаемых товарных групп"

Number

Нет

*packageType

Код типа упаковки. См. справочник "Типы упаковки"

String

Нет

*status

Код статуса КМ

- EMITTED - Эмитирован (0)
- APPLIED_PAID - Нанесен (1)
- INTRODUCED - Введён в оборот (2)
- WRITTEN_OFF - Списан (3)
- WITHDRAWN - Выведен из оборота, продан (4)
- INTRODUCED_RETURNED - Возвращен в оборот (6)
- DISAGGREGATED - Дезагрегирован (7)
- APPLIED - Нанесен, не оплачен (12)

String

Нет

*errorCode

Код ошибки КМ

cis_not_found - Код не найден в НИС МПТ в рамках указанной товарной группы

String

Нет

*errorMessage

Сообщение об ошибке (расшифровка кода)

String

Нет

Пример успешного ответа

[
  {
    "cisInfo": {
      "requestedCis": "00000046177780REVBECpjQnGgflKIlkrXQCBr",
      "productGroupId": 3,
      "productGroup": "tobacco",
      "packageType": "LEVEL2"
      "status": "INTRODUCED"
    }
  },
  {
    "cisInfo": {
      "requestedCis": "04780003874322_pCPl0p",
      "productGroupId": 3,
      "productGroup": "tobacco",
      "packageType": "UNIT"
      "status": "INTRODUCED"
    }
  }
]

Пример ответа с ошибкой по одному из кодов

[
  {
   "cisInfo": {
      "requestedCis": "00000046177780REVBECpjQnGgflKIlkrXQCBr"a
       "errorCode": "cis_not_found",
       "errorMessage": "Код не найден в НИС МПТ в рамках указанной товарной группы"
    }
  }
],
  {
    "cisInfo": {
      "requestedCis": "04780003874322_pCPl0p",
      "productGroupId": 3,
      "productGroup": "tobacco",
      "packageType": "UNIT"
      "status": "INTRODUCED"
    }
  }
]

Формат и коды ошибок

Код ошибки Описание Формат сообщения об ошибке

400

Операция не выполнена. Неверные входные параметры

{
"error_message": "В запросе не указан ни один КМ"
}

При отсутствии тела запроса:

{
"error_message": "Required request body is missing"
}

При неверной структуре JSON в теле запроса:

{
"error_message": "JSON parse error: Cannot deserialize instance of java.util.ArrayList out of START_OBJECT token; nested exception is com.fasterxml.jackson.databind.exc.MismatchedInputException: Cannot deserialize instance of java.util.ArrayList out of START_OBJECT token\n at [Source: (PushbackInputStream); line: 1, column: 1]"
}

401

Не авторизован, в запросе отсутствует clientToken или срок его жизни истек

403

При неподписанном договоре, если на КМ и агрегаты вернулась ошибка 403

{
"error_message": "Отсутствует действующий договор по ТГ"
}

500

Операция не выполнена. Произошла внутренняя ошибка

{
"errorMessage": "Ошибка получения информации о КМ", "errorCode": "500"
}

3.6. POST /cises/aggregated/list

Запрос списка агрегированных кодов маркировок по списку родительских кодов маркировки (POST).

Метод возвращает два слоя дерева агрегатов о списке запрашиваемых кодов маркировки товара: в одном запросе указывается несколько КМ. Табачные коды по блокам можно указывать в запросах как со скобками, так и без. В ответе код всегда будет возвращаться в том виде, в котором был зарегистрирован в Системе (эмитирован).

Необходимо экранировать спецсимволы КМ, указанные в теле запроса.

Описание запроса

Параметр Значение

URL

<url стенда>/cises/aggregated/list

Метод

POST

Content-Type

application/json

Authorization

bearer-token

Передаваемые параметры

Параметры запроса:

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

pg

Товарная группа согласно справочнику товарных групп

String

Да

childrenPage

Номер страницы вложений в агрегат первого слоя. Значение по умолчанию: 1. Не используется товарной группой "Табачная продукция"

Number

Нет

childrenLimit

Размер страницы вложений в агрегат первого слоя. Значение по умолчанию: 50. Не используется товарной группой "Табачная продукция"

Number

Нет

Параметры тела запроса:

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

codes

Массив КМ без криптохвоста, криптохвост перед обработкой удаляется. Длина массива от 1 до 1000 КМ

Array of [String]

Да

Пример запроса

POST <url стенда>/cises/aggregated/list?pg=3
Authorization: Bearer <ТОКЕН>
Content-Type: application/json
[
  "00699197189103795172",
  "00000046210654nUXppgnBkJOIQLahPdDGgXmM"
]

Принимаемые параметры:

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

codes

Список массивов КМ в агрегате при наличии агрегата

Map <string, Map <string, …, List <string>>>

Нет

Map:

{
"additionalProp1": {
"additionalProp1": ["string"],
"additionalProp2": ["string"],
"additionalProp3": ["string"]
},
"additionalProp2": {
"additionalProp1": ["string"],
"additionalProp2": ["string"],
"additionalProp3": ["string"]
}
}

Пример ответа

{
  "00699197189103795172": {
    "00000046177780DItXrCWcUqxInpitetIedrFN": [
      "(01)04600266010599(21)pZ=GexA"
    ],
    "(01)04600266010599(21)pZ=GexA": [
      "00000046187406tdfU4YY"
    ]
  },
  "00000046210654nUXppgnBkJOIQLahPdDGgXmM": {
    "(01)04600266010599(21)DdTe2n+": [
      "00000046187406Cm+M2nN",
      "00000046187406JK2\"+&,"
    ]
  }
}

Примечание. Для владельцев и производителей товаров осуществляется проверка доступа к соответствующей информации по кодам маркировки, которая осуществляется по ИНН из авторизованного токена в таблице КМ на соответствие (prid) для производителей или (o) для владельцев. При полном несоответствии значений ИНН для запрашиваемых КМ в ответе на запрос выводится пустой массив.

Формат и коды ошибок

Код ошибки Описание Формат сообщения об ошибке

400

Операция не выполнена. Неверные входные параметры

Если не заданы обязательные параметры запроса:
{
"error_message": "Некорректные параметры вызова метода"
}

При отсутствии тела запроса:
{
"error_message": "Отсутствует обязательное тело запроса" }
При неверной структуре JSON в теле запроса:
{
"error_message": "JSON parse error: Cannot deserialize …​ line: 1, column: 1]" }

401

Не авторизован, в запросе отсутствует clientToken

403

Нет доступа к запрашиваемой информации

При проверке доступа для зарегистрированных УОТ:
{
"error_message": "Отсутствует доступ к ресурсу"
}
При неподписанном договоре:
{
"error_message": "Отсутствует действующий договор по ТГ"
}

404

Запрашиваемая информация не найдена

Если ни один из указанных КМ не найден:
{
"error_message": "Ни один из указанных КМ не найден"
}

500

Операция не выполнена. Внутренняя ошибка сервера

3.7. POST /cises/aggregated/publicList

Запрос списка агрегированных кодов маркировок по списку родительских кодов маркировки (аналог POST cises/aggregated/list).

Метод возвращает первый слой дерева агрегатов о списке запрашиваемых кодах маркировки товара.

Табачные коды по блокам можно указывать в запросах как со скобками для идентификаторов применения, так и без. В ответе код всегда будет возвращаться в том виде, в котором был зарегистрирован в Системе (эмитирован).

Необходимо экранировать спецсимволы КМ, указанных в теле запроса.

Условия успешного запроса Условия корректности кода Ограничения на получение информации по владельцу кодов

- УОТ зарегистрирован в НИС МПТ (статус = REGISTRED)
- УОТ имеет действующий договор на подключение к товарной группе (Статус такого договора = 4 (enabling, т.е. документы подписаны УОТ) или 5 (active, т.е. документы подписаны Оператором))

Код зарегистрирован в НИС МПТ в рамках указанной ТГ (иначе код ошибки)

Ограничений нет

Коды могут не принадлежать текущему УОТ, делающему запрос (информацию по ним все равно выдавать)

Ошибки по одному из выше приведенных пунктов:

- блокируют получение данных по кодам
- вернется http-код 403

Если у кода есть одна из двух вышеприведенных ошибок, то:

- это не блокирует процесс получения данных по остальным кодам
- такие коды помечаются как ошибочные с описанием ошибки
- остальные (корректные) коды показаны с реквизитами

Описание запроса

Параметр Значение

URL

<url стенда>/true-api/cises/aggregated/publicList

Метод

POST

Content-Type

application/json

Authorization

bearer-token

Передаваемые параметры

Параметры заголовка запроса:

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

pg

Товарная группа согласно справочнику товарных групп

String

Да

Параметры тела запроса:

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

codes

Возможные варианты передачи Кодов:
* передавать Коды без криптохвоста (КИ);
* передавать Коды с криптохвостом (КМ). Криптохвост у кода будет отсечен сервисом true-api перед запросом в другие сервисы (lk-phoenix).

Длина массива от 1 до 1000 КМ Указываются как КИ, так и КИГУ/КИТУ

Array of [String]

Да

Пример запроса

POST <url стенда>/cises/aggregated/publicList?pg=3
Authorization: Bearer <ТОКЕН>
Content-Type: application/json
[
  "14780085115563tasSsyiWzFVFBjYnolePLlNe",
  "98988785115563tasSsyiWzFVFBjYnopooi(k"
]

Принимаемые параметры

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

cisInfo

Элемент массива КМ с параметрами (если найден)

Object (CisInfoResponseData)

Да

*requestedCis

КМ из запроса

String

Да

*status

Код статуса КМ

- EMITTED - Эмитирован (0)
- APPLIED_PAID - Нанесен (1)
- INTRODUCED - Введён в оборот (2)
- WRITTEN_OFF - Списан (3)
- WITHDRAWN - Выведен из оборота, продан (4)
- INTRODUCED_RETURNED - Возвращен в оборот (6)
- DISAGGREGATED - Дезагрегирован (7)
- APPLIED - Нанесен, не оплачен (12)

String

Нет

*codes

Список массивов КМ в агрегате при наличии агрегата (коды следующих уровней вложенности)

Map <string, Map <string, …, List <string>>

Нет

*errorCode

Код ошибки КМ

cis_not_found - Код не найден в НИС МПТ в рамках указанной товарной группы

String

Нет

*errorMessage

Сообщение об ошибке (расшифровка кода)

String

Нет

Пример успешного ответа

[
  {
    "cisInfo": {
      "requestedCis": "14780085115563tasSsyiWzFVFBjYnolePLlNe",
      "status": "INTRODUCED_RETURNED",
      "codes":
           {
              "(01)04780085115566(21)P2bom'F": [
                  "04780085115559(wXpO*o",
                   "04780085115559%nLORXC"
            ],
                 "(01)04780085115566(21)U2qfTMZ": [
                         "04780085115559Ote4ds\"",
                         "04780085115559/1UB9dj"
           ]
         }
      }
    },
     {
      "cisInfo": {
      "requestedCis": "98988785115563tasSsyiWzFVFBjYnopooi(k",
      "status": "INTRODUCED",
      "codes":
           {
              "(01)04790087615566(21)opP9mjk": [
                  "04790087615566(wXpO*y",
                   "047900876155669%nLOooC"
            ],
                 "(01)04780085109536(21)U98uyT_": [
                         "04780085109536Ote9(98"",
                         "04780085109536/1iu&65"
           ]
         }
      }
  }

]

Пример ответа с ошибкой по одному из кодов

[
  {
   "cisInfo": {
      "requestedCis": "00000046177780REVBECpjQnGgflKIlkrXQCBr"a
       "errorCode": "cis_not_found",
       "errorMessage": "Код не найден в НИС МПТ в рамках указанной товарной группы"
    }
  },

    {
      "cisInfo": {
      "requestedCis": "98988785115563tasSsyiWzFVFBjYnopooi(k",
      "status": "INTRODUCED",
      "codes":
           {
              "(01)04790087615566(21)opP9mjk": [
                  "04790087615566(wXpO*y",
                   "047900876155669%nLOooC"
            ],
                 "(01)04780085109536(21)U98uyT_": [
                         "04780085109536Ote9(98"",
                         "04780085109536/1iu&65"
           ]
         }
      }
  }

]


]

Формат и коды ошибок

Код ошибки Описание Формат сообщения об ошибке

400

Операция не выполнена. Неверные входные параметры

Если не заданы обязательные параметры запроса:

{
"error_message": "Некорректные параметры вызова метода"
}

При отсутствии тела запроса:

{
"error_message": "Отсутствует обязательное тело запроса"
}

При неверной структуре JSON в теле запроса:

{
"error_message": "JSON parse error: Cannot deserialize instance of java.util.ArrayList out of START_OBJECT token; nested exception is com.fasterxml.jackson.databind.exc.MismatchedInputException: Cannot deserialize instance of java.util.ArrayList out of START_OBJECT token\n at [Source: (PushbackInputStream); line: 1, column: 1]"
}

401

Не авторизован, в запросе отсутствует clientToken

403

При неподписанном договоре

{
"error_message": "Отсутствует действующий договор по ТГ"
}

500

Операция не выполнена. Внутренняя ошибка сервера

3.8. GET /cises/aggregated/list?codes={codes}

Запрос списка агрегированных кодов маркировок по списку родительских кодов маркировки (GET).

Метод возвращает первый слой дерева агрегатов о списке запрашиваемых кодов маркировки товара: в одном запросе указываются один либо несколько КМ. Табачные коды по блокам можно указывать в запросах как со скобками, так и без. В ответе код всегда будет возвращаться в том виде, в котором был зарегистрирован в Системе (эмитирован). Запятая не интерпретируется как разделитель для параметров запроса, а считается частью самого параметра.

Описание запроса

Параметр Значение

URL

<url стенда>/cises/aggregated/list?codes

Метод

GET

Content-Type

application/json

Authorization

clientToken

Передаваемые параметры

Параметры запроса:

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

pg

Товарная группа согласно справочнику товарных групп

String

Да

codes

КМ без криптохвоста, криптохвост перед обработкой удаляется. Длина массива от 1 до 1000 КМ

Array of [String]

Да

childrenPage

Номер страницы вложений в агрегат первого слоя. Значение по умолчанию: 1. Не используется товарной группой "Табачная продукция"

Number

Нет

childrenLimit

Размер страницы вложений в агрегат первого слоя. Значение по умолчанию: 50. Не используется товарной группой "Табачная продукция"

Number

Нет

Пример запроса

GET <url стенда>/cises/aggregated/list?pg=3&codes=00000046226846O%22XA%3ECo&codes=(01)00000046210654(21)oFTjHaM
Authorization: Bearer <ТОКЕН>

Принимаемые параметры

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

codes

Список массивов КМ в агрегате при наличии агрегата

Map<string, Map<string, …, List<string>>>

Нет

Пример ответа

{
   "000000462106549OOv1s0XzlzIFDjtcXJjz5cB":{
      "(01)04600266010599(21)DdTe2n+":[],
      "(01)00000046210654(21)hYVhjnW":[]
   },
   "(01)04600266010599(21)DdTe2n+":{
      "00000046187406iNR+uIx": [],
      "00000046187406lNSaeLg": [],
      "00000046187406+agLuid": []
   },
   "00000046226846O\"XA>Co":{}
}

Примечание. Для владельцев и производителей товаров осуществляется проверка доступа к соответствующей информации по кодам маркировки, которая осуществляется по ИНН из авторизованного токена в таблице КМ на соответствие (prid) для производителей или (o) для владельцев. При полном несоответствии значений ИНН для запрашиваемых КМ в ответе на запрос выводится пустой массив.

Формат и коды ошибок

Код ошибки Описание Формат сообщения об ошибке

400

Операция не выполнена. Неверные входные параметры

Если не заданы обязательные параметры запроса:
{
"error_message": "Некорректные параметры вызова метода"
}

401

Не авторизован, в запросе отсутствует clientToken

403

Нет доступа к запрашиваемой информации

При проверке доступа для зарегистрированных УОТ:
{
"error_message": "Отсутствует доступ к ресурсу"
}
При неподписанном договоре:
{
"error_message": "Отсутствует действующий договор по ТГ"
}

404

Запрашиваемая информация не найдена

Если ни один из указанных КМ не найден:
{
"error_message": "Ни один из указанных КМ не найден"
}

500

Операция не выполнена. Внутренняя ошибка сервера

3.9. POST /cises/list

Получение информации по списку КМ.

Метод возвращает подробную информацию о списке запрашиваемых КМ: в одном запросе может указываться несколько КМ. Табачные коды по блокам можно указывать в запросах, как со скобками, так и без. В ответе код всегда будет возвращаться в том виде, в котором был зарегистрирован в Системе (эмитирован). Запятая не интерпретируется как разделитель для параметров запроса, а считается частью самого параметра.

Общедоступная информация:

  • информация о КМ;

  • данные о производителе;

  • дата и время производства;

  • текущий статус в обороте;

  • текущий собственник в обороте – показ только владельцу, Оператору НИС «ASL BELGISI» и Администратору.

Описание запроса

Параметр Значение

URL

<url стенда>/cises/list

Метод

POST

Authorization

clientToken

Передаваемые параметры

Параметры заголовка запроса:

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

values

Список КМ. В списке должно быть от 1 до 1000 КМ (без/с криптохвостом, криптохвост перед обработкой удаляется). КМ в списке перечисляются по формату: <URL>?values=<cis1>[&values=<cisN>]

String

Да

Пример запроса

POST <url стенда>/cises/list?values=000000462106549OOv1s0XzlzIFDjtcXJjz5cB&values=00000046210654QuHCUeP
Content-Type: application/json
Authorization: Bearer <ТОКЕН>

Принимаемые параметры

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

requestedCis

Код маркировки (КМ) из запроса для табака

String

Нет

cis

КМ

String

Да

status

Код статуса КМ. См. справочник "Статусы КМ"

String

Да

gtin

Код товара. Если код товара менее 14 символов, то он дополняется ведущими нулями

String

Да

productName

Наименование продукции

String

Нет

productGroup

Наименование товарной группы согласно справочнику товарных групп

String

Нет

productGroupId

Идентификатор товарной группы согласно справочнику товарных групп

String

Нет

producedDate

Дата ввода товара в оборот в формате yyyy-MM-ddTHH:mm:ss.SSS’Z

String (date-time)

Нет

packageType

Код типа упаковки. См. справочник "Типы упаковки"

String

Да

emissionDate

Дата эмиссии в формате yyyy-MM-ddTHH:mm:ss.SSS’Z

String (date-time)

Нет

emissionType

Тип эмиссии:
LOCAL – собственное производство
FOREIGN – ввезен из-за рубежа
REMAINS – маркировка остатков
CROSSBORDER – ввезен из стран ЕАЭС

String

Нет

producerInn

ИНН производителя. Для ЛП для агрегатов не возвращается

String

Нет

producerName

Наименование производителя. Для ЛП для агрегатов не возвращается

String

Нет

ownerInn

ИНН собственника товара

String

Нет

ownerName

Наименование собственника товара

String

Нет

tnVedEaes

10-ти значный код ТН ВЭД

String

Нет

tnVedEaesGroup

Код товарной позиции ТН ВЭД ЕАЭС товара

String

Нет

parent

Родительский КМ

String

Нет

child

Список дочерних КМ в агрегате

Array of [String]

Нет

Пример ответа

[
  {
    "requestedCis": "string",
    "cis": "string",
    "status": "string",
    "gtin": "string",
    "productName": "string",
    "productGroup": "string",
    "productGroupId": 0,
    "producedDate": "2020-07-15T12:00:09.892Z",
    "packageType": "string",
    "producerInn": "string",
    "producerName": "string",
    "ownerInn": "string",
    "ownerName": "string",
    "tnVedEaes": "string",
    "parent": "string",
    "child": [
      "(01)00000046210654(21)yK9DfvR",
      "(01)00000046210654(21)qpu7OmU",
      "(01)00000046210654(21)hYVhjnW",
      "(01)00000046210654(21)ZSXXmk2",
      "(01)00000046210654(21)AKD1le7",
      "(01)00000046210654(21)1XkYTC4"
    ]
  }
]

Примечание. Для владельцев и производителей товаров осуществляется проверка доступа к соответствующей информации по кодам маркировки, которая осуществляется по ИНН из авторизованного токена в таблице КМ на соответствие (prid) для производителей или (o) для владельцев. При полном несоответствии значений ИНН для запрашиваемых КМ в ответе на запрос выводится пустой массив.

Формат и коды ошибок

Код ошибки Описание Формат сообщения об ошибке

400

Операция не выполнена. Не заполнены обязательные параметры

При отсутствии обязательного параметра values:
{
"error_message": "Отсутствует обязательный параметр: values"
}

403

Нет доступа к запрашиваемой информации

При проверке наличия токена авторизации или доступа для зарегистрированных УОТ:
{
"error_message": "Отсутствует доступ к ресурсу"
}
При неподписанном договоре:
{
"error_message": "Отсутствует действующий договор по ТГ"
}

404

Запрашиваемая информация не найдена

Если ни один из указанных КМ не найден:
{
"error_message": "КМ не найдены"
}

500

Операция не выполнена. Внутренняя ошибка сервера

{
"error_message": "string"
}

3.10. GET /cises/listV2

Метод получения подробной информации о кодах маркировки по списку.

Описание запроса

Параметр Значение

URL

<URL стенда>/cises/listV2

Метод

GET

Content-Type

application/json

Authorization

clientToken

Передаваемые параметры

Параметры запроса:

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

cis

КМ

String

Нет

cisStatus

Код статуса КМ. Текущий статус КМ:
EMITTED – Эмитирован. Выпущен
APPLIED – Эмитирован. Нанесен
INTRODUCED – В обороте
WITHDRAW – Выбыл
WRITTEN_OFF - Списан
INTRODUCED_RETURNED - Возврат в оборот
DISAGGREGATED - Дезагрегирован

String

Нет

gtin

Код товара. Если код товара менее 14 символов, то он дополняется ведущими нулями

String

Нет

sn

Серийный номер кода маркировки

String

Нет

tnVed10

10-тизначный код ТН ВЭД

String

Нет

emissionDateFrom

Дата эмиссии от в формате yyyy-MM-ddTHH:mm:ss.SSS’Z

String (date-time)

Нет

emissionDateTo

Дата эмиссии до в формате yyyy-MM-ddTHH:mm:ss.SSS’Z

String (date-time)

Нет

emissionType

Код типа производства. Тип эмиссии:
LOCAL – собственное производство
FOREIGN – ввезен из-за рубежа
REMAINS – маркировка остатков
CROSSBORDER – ввезен из стран ЕАЭС

String

Нет

order

Направление сортировки. Допустимые значения:
ASC – по возрастанию
DESC – по убыванию

String

Нет

producerInn

ИНН производителя в МОТП

String

Нет

ownerInn

ИНН владельца

String

Нет

cisPackageType

Тип упаковки:
UNIT (потребительская)
LEVEL1 (групповая)
LEVEL2 (транспортная-короб)
LEVEL3 (транспортная-слой на палетте)
LEVEL4 (транспортная-палетта)
LEVEL5 (транспортная-метро-юнит)

String

Нет

uit

Уникальный идентификатор товара (УИТ). Использовать только совместно с параметром orderedColumnValue

String

Нет

orderedColumnValue

Значение столбца, "точки отсчета" (запись, с которой начинается выборка), по которому сортируются записи. Использовать только совместно с параметром uit

String

Нет

orderColumn

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

String

Нет

limit

Максимальное количество записей, которое вернется в качестве ответа, не более 10000 записей. (По умолчанию 10 записей)

integer

Нет

pageDir

Выбор направления. Допустимые значения:
PREV – Предыдущий раздел
NEXT – Следующий раздел

Array of [String]

Нет

Пример запроса

GET <url стенда>/cises/listV2?gtin=04780085115559&cisStatus=APPLIED&limit=5
Authorization: Bearer <ТОКЕН>

Принимаемые параметры

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

results

Object (LpCisInfo)

Да

*cis

Код идентификации товара

String

Нет

*gtin

Код товара

String

Нет

*sgtin

Код товара и Серийный номер КМ

String

Нет

*tnvedGroup

Код товарной позиции ТН ВЭД ЕАС товара

String

Нет

*productName

Наименование товара

String

Нет

*ownerInn

ИНН собственника товара

String

Нет

*ownerName

Наименование собственника товара

String

Нет

*producerInn

ИНН производителя

String

Нет

*producerName

Наименование производителя

String

Нет

*status

Код статуса КМ. См. справочник "Статусы КМ"

String

Нет

*goodsStatus

Статус товара:
EMITTED – Эмитирован. Выпущен
APPLIED – Эмитирован. Нанесен
INTRODUCED – В обороте
WITHDRAW – Выбыл
WRITTEN_OFF - Списан
INTRODUCED_RETURNED - Возврат в оборот
DISAGGREGATED - Дезагрегирован

String

Нет

*docNum

Регистрационный номер документа

String

Нет

*emissionDate

Дата эмиссии в формате yyyy-MM-ddTHH:mm:ss.SSS’Z

String(DateTime)

Нет

*producedDate

Дата ввода товара с КИ в формате yyyy-MM-ddTHH:mm:ss.SSS’Z

String(DateTime)

Нет

*cisPackageType

Тип упаковки:
UNIT (потребительская)
LEVEL1 (групповая)
LEVEL2 (транспортная-короб)
LEVEL3 (транспортная-слой на палетте)
LEVEL4 (транспортная-палетта)
LEVEL5 (транспортная-метро-юнит)

String

Нет

*emissionType

Тип эмиссии:
LOCAL – собственное производство
FOREIGN – ввезен из-за рубежа

String

Нет

*type

Тип КМ:
PRINTED (нанесен на товар принтом)
GLUED (наклеен на товар)
HINGED (навешан на товар)

String

Нет

*markingType

Вид нанесения КМ:
ON_PACKAGE (на упаковке)
ON_PRODUCT (на самом продукте)
ON_PRODUCT_LABEL (на лейбле продукта)

String

Нет

*prodOrderType

Тип производственного заказа:
SELF_MADE
OPERATOR

String

Нет

*lastDocId

Последний регистрационный номер документа, зафиксированный в системе по этому КМ

String

Нет

*name

Наименование товара

String

Нет

*brand

Товарный знак (бренд)

String

Нет

*model

Производитель товара (model из gs1

String

Нет

*certDoc

Вид документа обязательной сертификации

Object

Нет

**type

Тип документа (вольный текст)

String

Нет

**number

Номер документа

String

Нет

**date

Дата документа

String

Нет

*prevCis

Предыдущий СИ

String

Нет

*statusEx

Тоже, что "status"

String

Нет

total

Общее количество значений, подходящие под параметры фильтрации

Number

Да

* – Набор специфичных атрибутов товара может меняться как от товарной группы, так и от набора характеристик товара в национальном каталоге для указанного GTIN и в ответе может возвращаться дополнительными параметрами.

Пример ответа

{
  "results": [
    {
      "cis": "04780085115559)YN3DrH",
      "gtin": "04780085115559",
      "sgtin": ")YN",
      "tnvedGroup": "3DrH",
      "productName": "Сигареты с фильтром Турон",
      "ownerName": "\"CRPT TURON\" MChJ",
      "ownerInn": "306535627",
      "producerName": "\"CRPT TURON\" mas‘uliyati cheklangan jamiyati",
      "producerInn": "306535627",
      "status": "WITHDRAWN",
      "goodsStatus": "WITHDRAWN",
      "docNum": "789рр8-99"
      "emissionDate": "2020-12-17T13:37:48.352Z",
      "producedDate": "2020-12-17T13:39:19.115Z",
      "cisPackageType": "LEVEL1"
      "emissionType": "LOCAL",
      "type": "PRINTED",
      "markingType": "ON_PACKAGE",
      "prodOrderType": "SELF_MADE",
      "lastDocId": "UZ1909120024010000000001333344",
      "name": "Сигареты с фильтром Турон",
      "brand": "Турон",
      "model": "string",
      "certDoc":
           {
             "type": "certificate",
             "number": "776OO-PP",
             "date": "12.01.2020"
           },
      "prevCis": "string",
      "statusEx": "WITHDRAWN"
    }
  ],
  "total": 102686
}

Формат и коды ошибок

Код ошибки Описание Формат сообщения об ошибке

400

Операция не выполнена. При ошибках запроса

{
"error_message": "string"
}

401

Не авторизован, в запросе отсутствует clientToken

403

Нет доступа к запрашиваемой информации

При проверке доступа для зарегистрированных УОТ:
{
"error_message": "Отсутствует доступ к ресурсу"
}
При неподписанном договоре:
{
"error_message": "Отсутствует действующий договор по ТГ"
}

500

Операция не выполнена. Внутренняя ошибка сервера

3.11. GET /cises/list/check-before-shipment

Метод получения подробной информации о кодах маркировки по списку.

Описание запроса

Параметр Значение

URL

<url стенда>/cises/list/check-before-shipment

Метод

GET

Content-Type

application/json

Authorization

clientToken

Передаваемые параметры

Параметры запроса:

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

emissionDateFrom

Дата эмиссии от в формате yyyy-MM-ddTHH:mm:ss.SSS’Z

String (date-time)

Нет

emissionDateTo

Дата эмиссии до в формате yyyy-MM-ddTHH:mm:ss.SSS’Z

String (date-time)

Нет

packs

Код типа упаковки. Фильтрация по товарным упаковкам:
ALL – товары и упаковки;
UNIT – только товары;
PACK – только упаковки.
По умолчанию подставляется PACK.

String

Нет

pg

Товарная группа:
TOBACCO;
ALCOHOL;
BEER.

String

Нет

producerInn

ИНН производителя в МОТП

String

Нет

limit

Максимальное количество записей, которое вернется в качестве ответа. Значение от 1 до n

integer

Да

Пример запроса

GET <url стенда>/cises/list/check-before-shipment?emissionDateFrom=2021-04-13T12:00:00.000Z&emissionDateTo=2021-04-29T00:00:00.000Z&packs=PACK&pg=tobacco&producerInn=875618767&limit=1000
Authorization: Bearer <ТОКЕН>

Принимаемые параметры

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

results

Object (LpCisInfo)

Да

*cis

Код идентификации товара

String

Нет

*countChildren

Количество дочерних КИ

Number

Нет

*emissionDate

Дата эмиссии в формате yyyy-MM-ddTHH:mm:ss.SSS’Z

String(DateTime)

Нет

*gtin

Код товара

String

Нет

*ownerInn

ИНН собственника товара

String

Нет

*ownerName

Наименование собственника товара

String

Нет

*packType

Код типа упаковки. См. справочник "Типы упаковки"

String

Нет

*parent

Код идентификации упаковки, в которую агрегирован товар

String

Нет

*productName

Наименование товара

String

Нет

*status

Код статуса кода:
EMITTED – Эмитирован. Выпущен;
APPLIED – Эмитирован. Получен;
INTRODUCED – В обороте;
WRITTEN_OFF - КМ списан;
WITHDRAW – Выбыл;
DISAGGREGATED - расформирован (только для упаковок).

String

Нет

*emissionType

Тип эмиссии:
LOCAL – собственное производство;
FOREIGN – ввезен из-за рубежа;
REMAINS – маркировка остатков;
CROSSBORDER – ввезен из стран ЕАЭ.

String

Нет

*receiptDate

Дата вывода из оборота (продажа) в формате yyyy-MM-ddTHH:mm:ss.SSS’Z

String (DateTime)

Нет

*productGroup

Товарная группа:
TOBACCO;
ALCOHOL;
BEER.

String

Нет

total

Общее количество значений, подходящие под параметры фильтрации

Number

Да

Пример ответа

{
  "results": [
    {
      "cis": "00000046177780AdaNelDpzmdgsBGpDBiqEIhz",
      "countChildren": 5656,
      "emissionDate": "2020-12-17T13:37:48.352Z",
      "gtin": "04780085115559",
      "ownerInn": "306535627",
      "ownerName": "\"CRPT TURON\" MChJ",
      "packType": "2",
      "parent": "00000046178871AdaNelDyymdgsBGpDYuynjUm",
      "productName": "Сигареты с фильтром Турон",
      "status": "WITHDRAW",
      "emissionType": "LOCAL",
      "receiptDate": "2021-04-11T11:32:01.124Z",
      "productGroup": "TOBACCO"
    }
  ],
  "total": 56762
}

Формат и коды ошибок

Код ошибки Описание Формат сообщения об ошибке

400

Операция не выполнена. При ошибках запроса

{
"error_message": "string"
}

401

Не авторизован, в запросе отсутствует clientToken

500

Операция не выполнена. Внутренняя ошибка сервера

3.12. GET /cises/history

Метод возвращает информацию о движении (истории) запрашиваемых кодов идентификации (КИ) товара по событиям, в которых УОТ принимал участие, чей токен используется при выполнении запроса. В одном запросе указывается один КИ.

Каждый УОТ видит производителя продукции, своего продавца и текущего владельца. Если данных УОТ, сформировавшего запрос, нет в цепочке движения, то возвращается только производитель и текущий владелец. Если КИ выведен из оборота, то вместо текущего владельца возвращается соответствующая информация.

Описание запроса

Параметр Значение

URL

<url стенда>/cises/history

Метод

GET

Content-Type

application/json

Authorization

clientToken

Передаваемые параметры

Параметры запроса:

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

code

Код идентификации товара (cis). Если КИ содержит специальные символы, то они экранируются

String

Да

Пример запроса

GET <url стенда>/cises/history?code=(01)00000046210654(21)oFTjHaM
Authorization: Bearer <ТОКЕН>

Принимаемые параметры

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

cis

КИ товара в НИС «ASL BELGISI»

String

Да

gtin

Код товара. Если код товара менее 14 символов, то он дополняется ведущими нулями

String

Да

productName

Наименование продукции

String

Нет

producedDate

Дата ввода товара в оборот в формате yyyy-MM-ddTHH:mm:ss.SSS’Z

String (date-time)

Нет

packageType

Код типа упаковки. См. справочник "Типы упаковки"

String

Да

ownerInn

ИНН собственника товара

String

Да

ownerName

Наименование собственника товара

String

Нет

status

Код статуса КИ. См. справочник "Статусы КИ"

String

Да

child

Список дочерних КИ в агрегате

Array of [String]

Нет

parent

Родительский КИ

String

Нет

producerInn

ИНН производителя

String

Да

producerName

Наименование производителя

String

Нет

timestamp

Отметка времени в формате yyyy-MM-ddTHH:mm:ss.SSS’Z

String (date-time)

Да

emissionDate

Дата эмиссии в формате yyyy-MM-ddTHH:mm:ss.SSS’Z

String (date-time)

Да

operationDate

Дата последней проведенной операции с КИ в формате yyyy-MM-ddTHH:mm:ss.SSS’Z

String (date-time)

Да

docId

ID документа

String

Нет

Пример ответа

[
  {
    "cis": "(01)04780085115566(21)),u_ULu",
    "gtin": "04780085115566",
    "packageType": "LEVEL1",
    "ownerInn": "306535627",
    "status": "INTRODUCED",
    "child": [
      "04780085115559D8Hrg2m",
      "04780085115559Go<qd,n"
    ],
    "producerInn": "306535627",
    "timestamp": "2021-03-11T07:42:12.267Z",
    "operationDate": "2021-03-11T10:41:42.000Z",
    "emissionDate": "2021-02-11T01:45:49.662Z",
    "docId": "49f0479b-708d-41da-8c7a-adb6a6927c1c"
  },
  {
    "cis": "(01)04780085115566(21)),u_ULu",
    "gtin": "04780085115566",
    "packageType": "LEVEL1",
    "ownerInn": "306535627",
    "status": "APPLIED",
    "child": [
      "04780085115559D8Hrg2m",
      "04780085115559Go<qd,n"
    ],
    "parent": "14780085115563UqFyfGljRdMhnqlcAFQRJxwz",
    "producerInn": "306535627",
    "timestamp": "2021-02-11T01:47:21.003Z",
    "operationDate": "2021-02-11T01:46:38.030Z",
    "emissionDate": "2021-02-11T01:45:49.662Z",
    "docId": "130cad50-5a91-4d71-a6f4-4e51d07a65aa"
  },
  {
    "cis": "(01)04780085115566(21)),u_ULu",
    "gtin": "04780085115566",
    "packageType": "LEVEL1",
    "ownerInn": "306535627",
    "status": "APPLIED",
    "producerInn": "306535627",
    "timestamp": "2021-02-11T01:45:49.662Z",
    "operationDate": "2021-02-11T01:45:49.662Z",
    "emissionDate": "2021-02-11T01:45:49.662Z",
    "docId": "1f2e3235-6e0e-47b6-a382-93e59e9efed0"
  },
  {
    "cis": "(01)04780085115566(21)),u_ULu",
    "gtin": "04780085115566",
    "packageType": "LEVEL1",
    "ownerInn": "306535627",
    "status": "EMITTED",
    "producerInn": "306535627",
    "timestamp": "2021-02-11T01:45:01.720Z",
    "operationDate": "2021-02-11T01:45:01.720Z",
    "emissionDate": "2021-02-11T01:45:01.720Z"
  }
]

Формат и коды ошибок

Код ошибки Описание Формат сообщения об ошибке

400

Операция не выполнена. Неверные входные параметры

При неправильном формате КИ в запросе: { "error_message": "Неверный формат КИ" }

При некорректной структуре GTIN КИ в запросе: { "error_message": "Неизвестный GTIN" }

401

Не авторизован, в запросе отсутствует clientToken или clientToken устаревший

403

Нет доступа к запрашиваемой информации

При проверке доступа для зарегистрированных УОТ:
{
"error_message": "Отсутствует доступ к ресурсу"
}
При неподписанном договоре:
{
"error_message": "Отсутствует действующий договор по ТГ"
}

404

Запрашиваемая информация не найдена

Если указанный КИ не найден:
{
"error_message": "КИ не найдены"
}

500

Операция не выполнена. Внутренняя ошибка сервера

Вернуться к разделу "Оглавление".

4. Методы работы с товарами (GTIN)

4.1. GET /product/gtin

Получение списка кодов товаров (GTIN) участника оборота товара по ИНН.

Метод возвращает список кодов товаров с возможностью указания параметров фильтрации в запросе.

Описание запроса

Параметр Значение

URL

<url стенда>/product/gtin

Метод

GET

Authorization

clientToken

Передаваемые параметры

Параметры запроса:

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

pg

Наименование товарной группы

String

Да

limit

Значение устанавливает количество записей в ответе. Не более 10000 записей. (По умолчанию 10 записей)

String

Нет

page

Номер страницы ответа, начальное значение 0

String

Нет

Пример запроса

GET "<url стенда>/product/gtin?limit=20&pg=tobacco" -H "accept: application/json" -H "Authorization: Bearer ey....w"

Принимаемые параметры

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

gtings

Список кодов товаров. При наличии кодов товаров в НИС «ASL BELGISI»

Array of [String]

Да

total

Общее количество найденных товаров

Number

Да

errorCode

Код ошибки. Параметр указывается при наличии ошибки

String

Нет

Пример ответа

{
"gtins": [
"04780002222223",
"04780004444449",
"04780003874322",
"04780004443442",
"04780004443435",
"04781223344558",
"04780004443336",
"08002235004091",
"04780062061718",
"04780062060261",
"04780110004001",
"04780004443411",
"04780100565697",
"04670034567488",
"04650071330023",
"04780004443428",
"04601653997769",
"04781122334452",
"04780004443312",
"05380004560010"
],
"total": 40
}

Формат и коды ошибок

Код ошибки Описание Формат сообщения об ошибке

400

Операция не выполнена. Неверные входные параметры

При неверном значении товарной группы в параметре pg:
{
"error_message": "Could not determine product group by name 'shoe'"
}

401

Не авторизован, в запросе отсутствует clientToken

403

Нет доступа к запрашиваемой информации

При проверке доступа для зарегистрированных УОТ:
{
"error_message": "Отсутствует доступ к ресурсу"
}
При неподписанном договоре:
{
"error_message": "Отсутствует действующий договор по ТГ"
}

500

Операция не выполнена. Внутренняя ошибка сервера

4.2. GET /products/info

Запрос карточки товара по одному уникальному идентификатору товара.

Метод возвращает информацию о запрашиваемом товаре (в одном запросе указывается cis (КИ) одной единицы товара).

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

Описание запроса

Параметр Значение

URL

<url стенда>/products/info

Метод

GET

Передаваемые параметры

Параметры URL запроса:

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

cis

КИ

String

Да

Пример запроса

GET "<url стенда>/products/info?cis=%2801%2904871234567890%2821%296M%3AA%3EBD" -H "accept: */*"

Принимаемые параметры

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

id

Идентификатор товара

Number

Да

name

Наименование товара

String

Нет

gtin

Код товара

String

Да

packageType

Тип упаковки. Возможные значения:
"trade-unit" - индивидуальная упаковка товара;
"inner-pack" - упаковка 1-го уровня;
"box" - упаковка 2-го уровня;
"pallet" - упаковка 3-го уровня

String

Да

innerUnitCount

Число экземпляров товара

Number

Да

specificAttributes

Набор специфичных атрибутов товара

Array of [String]

Нет

Пример ответа

{
"id": 92,
"name": "Сигареты с фильтром",
"gtin": "04870003870025",
"packageType": "trade-unit",
"innerUnitCount": 1,
"specificAttributes": {}
}

Формат и коды ошибок

Код ошибки Описание Формат сообщения об ошибке

400

Операция не выполнена. Неверные входные параметры

При неправильном формате КИ в URL:
{
"error_message": "Неверный формат КМ"
}

403

Нет доступа к запрашиваемой информации

При проверке наличия токена авторизации или доступа для зарегистрированных УОТ:
{
"error_message": "Отсутствует доступ к ресурсу"
}
При неподписанном договоре:
{
"error_message": "Отсутствует действующий договор по ТГ"
}

404

Запрашиваемая информация не найдена

Если не найден продукт с таким КИ:
{
"error_message": "Продукт не найден"
}

500

Операция не выполнена. Внутренняя ошибка сервера

4.3. POST /product/route/gtin

Получение товарных групп по коду товара (GTIN).

Метод возвращает информацию о товарных группах для запрашиваемых кодов товаров, в одном запросе указываются один либо несколько кодов товаров.

Описание запроса

Параметр Значение

URL

<url стенда>/product/route/gtin

Метод

POST

Content-Type

application/json

Authorization

clientToken

Передаваемые параметры

Параметры тела запроса:

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

data

Список кодов товаров

Array of [String]

Да

gtin

Код товара

String

Да

Пример запроса

POST <url стенда>/product/route/gtin
authorization: Bearer <ТОКЕН>
Content-Type: application/json
{
"data": [
"00000046210654",
"04630034070029"
]
}

Принимаемые параметры

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

data

Код товара

String

Нет

tg-id

Идентификатор товарной группы

См. справочник "Список поддерживаемых товарных групп"

String

Нет

tg-name

Наименование товарной группы

String

Нет

error-code

Код ошибки при обработке кода товара

String

Нет

error-msg

Сообщение об ошибке при обработке кода товара

String

Нет

Пример ответа

[
{
"data":"00000046210654",
"tg-id":"3",
"tg-name":"tobacco"
},
{
"data":"04630034070012",
"error-code":"401",
"error-msg":"Для доступа к этому ресурсу требуется полная аутентификация"
},
{
"data":"000000432183564",
"error-code": "404",
"error-msg": "Not found"
}
]

Формат и коды ошибок

Код ошибки Описание Формат сообщения об ошибке

400

Операция не выполнена. Неверные входные параметры

При неверной структуре в теле запроса:
{
"error_message": "JSON parse error: Cannot deserialize …​ line: 1, column: 10]"
}

401

Не авторизован, в запросе отсутствует clientToken

403

Нет доступа к запрашиваемой информации

При проверке наличия токена авторизации или доступа для зарегистрированных УОТ:
{
"error_message": "Отсутствует доступ к ресурсу"
}
При неподписанном договоре:
{
"error_message": "Отсутствует действующий договор по ТГ"
}

404

Запрашиваемая информация не найдена

При отсутствии всех запрошенных gtin в базе:
{
"error_message": "Not Found"
}

500

Операция не выполнена. Внутренняя ошибка сервера

{
"error_message": "string"
}

4.4. GET /products/listV2

Метод получения подробной информации о товарах по заданному фильтру.

Метод возвращает список товаров (с подробной информацией), которые доступны в данный момент времени участнику оборота товаров, согласно заданному фильтру.

Описание запроса

Параметр Значение

URL

<url стенда>/products/listV2

Метод

GET

Authorization

clientToken

Пример URL запроса:

curl -X GET "<url-стенда>/api/v3/true-api/products/listV2?cis=00000046332158Z0YOcDM" -H "accept: */*" -H "Authorization: Bearer ey...c"

Передаваемые параметры

параметры URL запроса

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

cis

Код идентификации, используемый для фильтрации по списку КИ

string

Нет

emissionDateFrom

Дата эмиссии, от. Задается в формате yyyy-MM-ddTHH:mm:ss.SSS’Z

string (date-time)

Нет

emissionDateTo

Дата эмиссии, до. Задается в формате yyyy-MM-ddTHH:mm:ss.SSS’Z

string (date-time)

Нет

gtin

Код товара

string

Нет

producerInn

ИНН производителя/импортера

string

Нет

sn

Серийный номер кода идентификации

string

Нет

ownerInn

ИНН владельца

string

Нет

cisPackageType

Тип упаковки. см. Справочник "Типы упаковки"

enum

Нет

tnVed10

Код товарной номенклатуры (10 знаков)

string

Нет

emissionType

См. справочник "Способ выпуска товаров в оборот"

string

Нет

pageDir

Выбор направления: PREV – предыдущий раздел; NEXT – следующий раздел

string

Нет

uit

Значение КИ, "точки отсчета" (запись, с которой начнется выборка), по которому сортируются записи. Использовать только совместно с параметром orderedColumnValue

string

Нет

order

Направление сортировки: ASC – по возрастанию; DESC – по убыванию

string

Нет

orderColumn

Название столбца, по которому будет производиться сортировка. Допустимое значение emd - дата эмиссии

string

Нет

orderedColumnValue

Значение столбца, "точки отсчета" (запись, с которой начинается выборка), по которому сортируются записи. Использовать только совместно с параметром uit

string

Нет

limit

Значение устанавливает количество записей в ответе, не более 10000 записей. (По умолчанию 49 записей)

integer

Нет

cisStatus

Статус КМ товара (см. справочник "Статусы КМ")

string

Нет

Пример ответа:

{
"results": [
{
"cis": "00000046332158Z0YOcDM",
"gtin": "00000046332158",
"sgtin": "Z0Y",
"tnvedGroup": "OcDM",
"productName": "Пачка",
"ownerName": "ИП ...",
"ownerInn": "810716401076",
"producerName": "ИП...",
"producerInn": "810716401076",
"status": "APPLIED",
"emissionDate": "2020-07-31T10:43:34.000Z",
"producedDate": "2020-07-31T10:43:34.733Z",
"emissionType": "LOCAL",
"lastDocId": "8e0d3528-53eb-4e71-94ad-bfde6bad0bf6",
"name": "Пачка",
"brand": "Золотая ява",
"statusEx": "APPLIED",
"tnVedCode10": "2402209000"
}
],
"total": 19323
}

Параметры ответа:

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

results:

Да

*cis

Код идентификации, используемый для фильтрации по списку КИ

string

Да

*emissionDate

Дата эмиссии КИ. Возвращается в формате yyyy-MM-ddTHH:mm:ss.SSS’Z

string (date-time)

Да

*emissionType

См. Справочник "Способ выпуска товаров в оборот"

string

Да

*gtin

Код товара

string

Нет

*lastDocId

Последний регистрационный номер документа, зафиксированный в НИС «ASL BELGISI» по этому КМ

string

Нет

*ownerInn

ИНН собственника товара

string

Нет

*ownerName

Наименование собственника товара

string

Нет

*producerInn

ИНН участника, осуществившего эмиссию КМ

string

Нет

*producerName

Наименование участника оборота товаров

string

Нет

*producedDate

Дата ввода товара с КМ в оборот. Возвращается в формате yyyy-MM-ddTHH:mm:ss.SSS’Z

string (date-time)

Нет

*productName

Наименование товара на этикетке

string

Нет

*sgtin

Код товара и Серийный номер КМ

string

Нет

*status

Статус КМ товара, см. Справочник "Статусы КМ"

enum

Да

*statusEx

Тоже, что "status"

enum

Нет

*tnVedCode10

Код товарной номенклатуры (10 знаков)

string

Нет

*tnvedGroup

Код товарной позиции ТН ВЭД ЕАС товара

string

Нет

total

Общее количество значений, подходящих под параметры фильтрации

integer

Нет

Формат и коды ошибок

Код ошибки Описание Формат сообщения об ошибке

401

Ошибка авторизации

403

Нет доступа к запрашиваемой информации

При проверке доступа для зарегистрированных УОТ:
{
"error_message": "Отсутствует доступ к ресурсу"
}
При неподписанном договоре:
{
"error_message": "Отсутствует действующий договор по ТГ"
}

500

Произошла внутренняя ошибка сервера

Вернуться к разделу "Оглавление".

5. Методы работы с Национальным каталогом (НК)

5.1. GET /nk/attributes

Метод получения списка атрибутов как публичных, так и приватных для запрашивающего аккаунта.

Метод возвращает перечень атрибутов для создания карточки товара с указанным кодом ТН ВЭД или идентификатором категории. Если не указан код ТН ВЭД или идентификатор категории, возвращается полный список атрибутов доступных для запрашивающего аккаунта.

Описание запроса

Параметр Значение

URL

<url стенда>/nk/attributes

Метод

GET

Content-Type

application/json

clientToken

apikey

Передаваемые параметры

Параметры заголовка запроса

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

apikey

Параметр, необходимый для авторизации и совершения запросов API. Предоставляется системой

String

Да

format

Формат вывода ответа. Возможные значения:
- "json"
- "xml"

String

Нет

attr_type

Тип атрибута. Возможные значения:
"a" - вернуть все атрибуты (значение по умолчанию);
"m" - вернуть только обязательные атрибуты;
"r" - вернуть только рекомендуемые атрибуты;
"o" - вернуть только опциональные атрибуты

String

Нет

cat_id

Идентификатор категории, к которой относятся атрибуты.

Обязательный, если указан attr_type и не указан tnved

String

Нет

Пример запроса

<url стенда>/nk/attributes?attributes?apikey=XXX&cat_id=30933&attr_type=m

Принимаемые параметры

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

apiversion

Номер версии API метода

Number

Да

result

Результат при наличии ответа

Area of (Object)

Нет

attr_id

Идентификатор атрибута

Number

Да

attr_name

Наименование атрибута

String

Да

attr_group_name

Наименование группы, к которой относится атрибут

String

Да

attr_group_id

Идентификатор группы, к которой относится атрибут

Number

Да

attr_value_type

Массив возможных значений типа атрибута

Array[string]

Да

attr_field_type

Тип значения атрибута

String

Да

second_layer

Признак принадлежности атрибута ко второму слою атрибутов (атрибуты, необходимые для ввода товаров в оборот)

Принимает значения:
true - атрибут необходим;
false - атрибут не необходим

Boolean

Да

attr_preset

Массив возможных значений атрибута

Array[string]

Да

attr_type

Тип атрибута, при наличии cat_id в запросе

String

Нет

Пример ответа

{
"apiversion":3,
"result":[
{
"attr_group_name":"Потребительские свойства",
"attr_field_type":"text",
"attr_value_type":[],
"attr_group_id":103,
"attr_name":"Возраст потребителя",
"attr_id":557,
"second_layer":true,
"attr_type":"m",
"attr_preset":[]
}
]
}

Формат и коды ошибок

Код ошибки Описание Формат сообщения об ошибке

400

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

{ "error_message": "Ошибка в параметрах запроса" }

403

Указан неправильный ключ API

{ "error_message": "Отсутствует доступ к ресурсу" }

404

Не найдены атрибуты для указанной категории

{ "error_message": "Данные не найдены" }

500

Операция не выполнена. Внутренняя ошибка сервера

503

Сервис недоступен, техническое обслуживание, повторите запрос позже

5.2. GET /nk/brands

Метод получения списка торговых марок. При отправке ID торговой сети в ответе возвращаются данные о брендах.

Описание запроса

Параметр Значение

URL

<url стенда>/nk/brands

Метод

GET

Content-Type

application/json

clientToken

apikey

Передаваемые параметры

Параметры заголовка запроса

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

apikey

Параметр, необходимый для авторизации и совершения запросов API. Предоставляется системой

String

Да

Принимаемые параметры

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

apiversion

Номер версии API метода

Number

Да

result

Результат при наличии ответа

Area of (Object)

Нет

brand_id

Идентификатор бренда

Number

Да

brand_name

Наименование бренда

String

Да

Пример ответа

{
"apiversion":3,
"result":[
{
"brand_id":29096,
"brand_name":"Bercatti"
},
{
"brand_id":28964,
"brand_name":"OUTEMER"
},
{
"brand_id":7105,
"brand_name":"Roshen"
}
]
}

Формат и коды ошибок

Код ошибки Описание Формат сообщения об ошибке

403

Указан неправильный ключ API

{"error_message": "Отсутствует доступ к ресурсу"}

500

Операция не выполнена. Внутренняя ошибка сервера

5.3. GET /nk/categories

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

Описание запроса

Параметр Значение

URL

<url стенда>/nk/categories

Метод

GET

Content-Type

application/json

clientToken

apikey

Передаваемые параметры

Параметры заголовка запроса

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

apikey

Параметр, необходимый для авторизации и совершения запросов API. Предоставляется системой

String

Да

Принимаемые параметры

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

apiversion

Номер версии API метода

Number

Да

result

Результат при наличии ответа

Area of (Object)

Нет

cat_id

Идентификатор категории

Number

Да

cat_name

Наименование категории

String

Да

cat_parent_id

Идентификатор родительской категории

Number

Да

cat_level

Уровень в дереве категорий

String

Да

Пример ответа

{
"apiversion":3,
"result":[
{
"cat_id":14001,
"cat_name":"Продукты питания",
"cat_parent_id":14000,
"cat_level":"1"
},
{
"cat_id":14002,
"cat_name":"Напитки",
"cat_parent_id":14001,
"cat_level":2
}
]
}

Формат и коды ошибок

Код ошибки Описание Формат сообщения об ошибке

403

Указан неправильный ключ API

{ "error_message": "Отсутствует доступ к ресурсу" }

500

Операция не выполнена. Внутренняя ошибка сервера

5.4. POST /nk/feed

Метод создания и обновления товаров.

Метод предназначен для получения XML товаров для подписи по goodId или коду товара. При отправке массива ID товаров либо массива строк кодов товаров в ответе возвращается массив XML товаров для подписания и (при наличии) массив объектов с информацией об ошибках при отсутствии товаров по ID/коду товара.

Количество товаров в запросе - не более 25.

Описание запроса

Параметр Значение

URL

<url стенда>/nk/feed

Метод

POST

Content-Type

application/json

clientToken

apikey

Передаваемые параметры

Параметры заголовка запроса

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

apikey

Параметр, необходимый для авторизации и совершения запросов API. Предоставляется системой

String

Да

Параметры тела запроса

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

goodIds

Массив ID товаров. Обязательно, если не указан gtins

Array of [number]

Нет

gtins

Массив строк кодов товаров. Обязательно, если не указан goodIds

Array of [string]

Нет

publicationAgreement

Согласие на публикацию товаров на сайте национального каталога:
true/1 - согласны;
false/0 - не согласны
При отсутствии данного параметра будет выставлено значение по умолчанию - "Не согласен".

Boolean

Нет

Пример запроса

POST <url стенда>/nk/feed-product-document?apikey=XXX
Content-Type: application/json; charset=utf-8
{
"goodIds": [123, 234, 345
],
"gtins":[
"4612312312312",
"123123123123"
],
"publicationAgreement": false
}

Принимаемые параметры

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

apiversion

Номер версии API метода

Number

Да

result

Результат при наличии ответа

Area of (Object)

Нет

*xmls

Массив XML товаров для подписания

Array

Да

**goodId

ID товара

Number

Да

**xml

XML товара для подписания

String

Да

*errors

Массив ошибок по каждому товару

Array

Да

**goodId

ID товара

Number

Да

**message

Текст сообщения

String

Да

*GTIN

Код товара

String

Да

*message

Текст ошибки. Также при ненахождении товара по коду товара

String

Да

Пример ответа

{
"apiversion":3,
"result":[
{
"xmls":[
{
"goodId":123,
"xml":"<?xml version=\"1.0\" encoding=\"UTF-8\"?>..."
},
{
"goodId":234,
"xml":"<?xml version=\"1.0\" encoding=\"UTF-8\"?>..."
}
],
"errors":[
{
"goodId":345,
"message":"Информация о товаре ... устарела или скомпроментирована. Попробуйте еще раз."
},
{
"GTIN":"123123123123",
"message":"Не удалось получить товар по GTIN"
}
]
}
]
}

Формат и коды ошибок

Код ошибки Описание Формат сообщения об ошибке

403

Указан неправильный ключ API

{ "error_message": "Отсутствует доступ к ресурсу" }

413

Если больше 25 запрашиваемых идентификаторов в теле запроса

{ "error_message": "Слишком большой запрос" }

500

Операция не выполнена. Внутренняя ошибка сервера

5.5. GET /nk/feed-moderation

Метод отправки на модерацию карточки товаров в статусе "Черновик".

Если указаны более одного из обязательных параметров, то возвращается результат выборки, соответствующий данному алгоритму:

  • good_id - при указании возвращается товар с соответствующим идентификатором или ошибка 404. При этом код товара+inn игнорируются;

  • gtin+inn - при указании возвращается товар с соответствующим кодом товара для ИНН или ошибка 404.

Описание запроса

Параметр Значение

URL

<url стенда>/nk/feed-moderation

Метод

GET

Content-Type

application/json

clientToken

apiKey

Передаваемые параметры

Параметры заголовка запроса

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

apiKey

Параметр, необходимый для авторизации и совершения запросов API. Предоставляется системой

String

Да

good_id

ID товара в каталоге. Обязательно, если не указаны gtin и inn

String

Нет

gtin

Код товара. Обязательно, если не указан good_id

String

Нет

inn

ИНН аккаунта. Обязательно, если не указан good_id

String

Нет

Принимаемые параметры

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

Параметр

Описание

Тип

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

apiversion

Номер версии API метода

Number

Да

result

Результат при наличии ответа

Area of (Object)

Нет

*good_draft_id

ID шаблона товара в каталоге

Number

Да

*error

Текст ошибки. Параметр указывается при наличии ошибки

String

Нет

Пример ответа

{
 "apiversion":3,
 "result":{
    "good_draft_id":123456,
    "error":"Черновик GTIN 02XXXXXXXX601050000383 не в том статусе."
           }
}

Формат и коды ошибок

Код ошибки Описание Формат сообщения об ошибке

403

Указан неправильный ключ API

{ "error_message": "Отсутствует доступ к ресурсу" }

500

Операция не выполнена. Внутренняя ошибка сервера

5.6. GET /nk/feed-product

Метод получения карточки товара, в том числе неопубликованной карточки.

Метод возвращает всю имеющуюся информацию о продукте, то есть все заполненные атрибуты карточки товара независимо от статуса самой карточки, в отличие от метода product, который возвращает информацию только по опубликованным карточкам. Требует указания следующих параметров: идентификатор товара (goodId), код товара (штрих-код) и указание apikey владельца товара.

Если указаны оба параметра (good_id и gtin), то возвращается результат выборки по good_id. При этом код товара игнорируется.

Описание запроса

Параметр Значение

URL

<url стенда>/nk/feed-product

Метод

GET

Content-Type

application/json

clientToken

apikey

Передаваемые параметры

Параметры заголовка запроса

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

apikey

Параметр, необходимый для авторизации и совершения запросов API. Предоставляется системой

String

Да

good_id

ID товара в каталоге. Обязательно, если не указан gtin

String

Нет

gtin

Код товара. Обязательно, если не указан good_id

String

Нет

Принимаемые параметры

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

apiversion

Number

Да

Номер версии API метода

result

Area of (Object)

Нет

Результат при наличии ответа

*identified_by

[Array]

Да

массив содержащий информацию о штрих-кодах

**value

String

Да

штрих-код или локальный идентификатор

**type

String

Да

Тип идентификатора

Возможные значения:

"gtin" — глобальный код товара (штрих-код);

barcode" — штрих-код Barcode (штрихкод с неправильной контрольной цифрой)

**party_id

String

Нет

Идентификатор торговой сети

возвращается только при условии, что параметр type имеет значение barcode.

**multiplier

Number

Да

Количество товаров в упаковке

Значение по умолчанию = 1

**level

String

Да

Тип упаковки (уровень упаковки). Возможные значения: "trade-unit" - штука;
"box" - коробка;
"layer" - слой на палете;
"pallet" - палета;
"metro-unit" - метро-юнит;
"show-pack" - шоу-пак;
"inner-pack" - спайка

*good_id

Number

Да

Идентификатор товара

*good_name

String

Да

Наименование товара

*good_img

String

Да

Изображение товара

*good_status

String

Да

Статус карточки товара

*categories

[Array]

Да

Массив категорий

**cat_id

Number

Да

Идентификатор категории, в которой расположен товар, исключая родителей этой категории

**cat_name

String

Да

Наименование категории, в которой расположен товар

**party_cat_id

Number

Да

Идентификатор категории торговой сети, в которой расположен товар/ Только для владельца сети, если указан party_id в запросе

**party_cat_name

String

Да

Наименование категории торговой сети, в которой расположен товар

*party_brand_id

String

Нет

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

*brand_id

Number

Да

Идентификатор бренда

*brand_name

String

Да

Наименование бренда

*good_rating

Number

Да

Рейтинг товара

*good_images

Array

Да

Массив с изображениями

**photo_type

String

Да

тип фотографии. Возможные значения:
"default" - фотография по умолчанию (вид спереди);
"facing" - crop-фотография для планограмм (обрезанная по контуру товара);
"left" - фотография товара слева;
"right" - фотография товара справа;
"back" - фотография товара сзади;
"3ds" - 3D серия;
"marketing" - коммерческая фотография товара;
"ecommerce" - e-commerce фото;
"undef" - single shot, фотография товара с не предопределенного ракурса;
"cubi" — фотография измерения ВГХ

**photo_date

String (date-time)

Да

Дата создания фотографии в формате yyyy-MM-ddTHH:mm:ss.SSS’Z

**photo_url

[String]

Да

Ссылка на med (medium) размер фотографии

**barcode

String

Нет

Штрихкод или артикул товара, для которого сделана фотография

*good_attrs

Array

Нет

Массив атрибутов (отдаются только те, которые принадлежат аккаунту apike)

**attr_id

Number

Да

Идентификатор атрибута

**attr_name

String

Да

Наименование атрибута

**attr_value_id

String

Нет

Идентификатор значения атрибута

**attr_value

String

Да

Значение атрибута

**value_id

Number

Нет

Идентификатор значения атрибута

**attr_value_type

Array[string]

Да

Массив возможных значений типа атрибута

**attr_group_id

Number

Да

Идентификатор группы, к которой относится атрибут

**attr_group_name

String

Да

Наименование группы, к которой относится атрибут

**measure_date

String (date-time)

Нет

Дата измерения атрибута в формате yyyy-MM-ddTHH:mm:ss.SSS’Z

**published_date

String (date-time)

Нет

Дата публикации атрибута в формате yyyy-MM-ddTHH:mm:ss.SSS’Z

**effective_date

String (date-time)

Нет

Дата, с которой действительно значение атрибута, в формате yyyy-MM-ddTHH:mm:ss.SSS’Z

**expired_date

String (date-time)

Нет

Дата, с которой недействительно значение атрибута, в формате yyyy-MM-ddTHH:mm:ss.SSS’Z

**location_id

String

Нет

Идентификатор локации, в которой было проведено измерение

**party_location_id

String

Нет

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

**level

String

Нет

Уровень упаковки

**gtin

String

Нет

Код товара (Штрих-код)

**multiplier

Number

Нет

Мультипликатор

**certificate_number

String

Нет

Номер сертификата. Только у атрибутов из группы "Сертификаты"

**certificate_issued_date

String (date-time)

Нет

Дата начала срока действия в формате yyyy-MM-ddTHH:mm:ss.SSS’Z

**certificate_valid_until_date

String (date-time)

Нет

Дата окончания срока действия в формате yyyy-MM-ddTHH:mm:ss.SSS’Z

**certificate_applicant

String

Нет

Заявитель

**certificate_manufacturer

String

Нет

Изготовитель

**certificate_product_description

String

Нет

Продукция

*good_reviews

Array

Да

Массив с отзывами

**review_id

Number

Да

Идентификатор отзыва

**review_author

String

Да

Автор (имя, фамилия, псевдоним)

**review_rating

Number

Да

Рейтинг отзыва при наличии

**review_text

String

Да

Текст отзыва

**review_date

String (date-time)

Да

Дата создания отзыва в формате yyyy-MM-ddTHH:mm:ss.SSS’Z

**review_author_img

String

Да

Ссылка на фотографию автора

**review_replies

Array

Нет

Массив с отзывами. Если отзыв имеет ответы (т.е. отзывы с review_parent_id = review_id данного/родительского отзыва)

***review_id

Number

Да

Идентификатор отзыва-ответа

***review_author

String

Да

Автор (имя, фамилия, псевдоним)

***review_rating

Number

Да

Рейтинг отзыва-ответа

***review_text

String

Да

Текст отзыва-ответа

***review_date

String (date-time)

Да

Дата создания отзыва в формате yyyy-MM-ddTHH:mm:ss.SSS’Z

***review_author_img

String

Да

Ссылка на фотографию автора

*good_reviews_count

Number

Да

Количество отзывов

*good_url

String

Да

Ссылка на страницу товара

*good_prices

Array

Да

Массив цен на товар по торговым сетям данного аккаунта

**party_id

Number

Да

Идентификатор торговой сети

**address

Array

Да

Местонахождение

***country

String

Да

Название страны согласно ISO 3166-2

***city

String

Да

Название города

***street

String

Да

Название улицы, дом

***location

Array

Да

Координаты

****lat

String

Да

Географическая широта

****lon

String

Да

Географическая долгота

Формат и коды ошибок

Код ошибки Описание Формат сообщения об ошибке

400

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

{ "error_message": "Ошибка в параметрах запроса" }

403

Указан неправильный ключ API

{ "error_message": "Отсутствует доступ к ресурсу" }

404

Если не найден продукт

{ "error_message": "Данные не найдены" }

500

Операция не выполнена. Внутренняя ошибка сервера

5.7. POST /nk/feed-product-document

Метод получения XML товаров по массиву ID товаров или коду товара.

Метод предназначен для получения XML товаров для подписи по goodId или коду товара. При отправке массива ID товаров либо массива строк кодов товаров в ответе возвращается массив XML товаров для подписания и (при наличии) массив объектов с информацией об ошибках при отсутствии товаров по ID/коду товара.

Количество товаров в запросе - не более 25.

Описание запроса

Параметр Значение

URL

<url стенда>/nk/feed-product-document

Метод

POST

Content-Type

application/json

clientToken

apikey

Передаваемые параметры

Параметры заголовка запроса

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

apikey

Параметр, необходимый для авторизации и совершения запросов API. Предоставляется системой

String

Да

Параметры тела запроса

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

goodIds

Массив ID товаров. Обязательно, если не указан gtins

Array[number]

Нет

gtins

Массив строк кодов товаров. Обязательно, если не указан goodIds

Array[string]

Нет

publicationAgreement

Согласие на публикацию товаров на сайте НК:
true/1 - согласны;
false/0 - не согласны
При отсутствии данного параметра будет выставлено значение по умолчанию - "Не согласен".

Boolean

Нет

Пример запроса

"POST <url стенда>/nk/feed-product-document?apikey=XXX
Content-Type":application/json; charset=utf-8
{
"goodIds":[123, 234, 345],
"gtins":[
"4612312312312",
"123123123123"
],
"publicationAgreement":false
}

Принимаемые параметры

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

apiversion

Номер версии API метода

Number

Да

result

Результат при наличии ответа

Area of (Object)

Нет

*xmls

Массив XML товаров для подписания

Array of [Objects]

Да

**goodId

ID товара

Number

Да

**xml

XML товара для подписания

String

Да

*errors

Массив ошибок по каждому товару

Array of [Objects]

Да

**goodId

ID товара

Number

Да

**GTIN

Код товара

String

Да

**message

Текст ошибки. Также при ненахождении товара по коду товара

String

Да

Пример ответа

{
"apiversion":3,
"result":[
{
"xmls":[
{
"goodId":123,
"xml":"<?xml version=\"1.0\" encoding=\"UTF-8\"?>..."
},
{
"goodId":234,
"xml":"<?xml version=\"1.0\" encoding=\"UTF-8\"?>..."
}
],
"errors":[
{
"goodId":345,
"message":"Информация о товаре ... устарела или скомпроментирована. Попробуйте еще раз."
},
{
"GTIN":"123123123123",
"message":"Не удалось получить товар по GTIN"
}
]
}
]
}

Формат и коды ошибок

Код ошибки Описание Формат сообщения об ошибке

403

Указан неправильный ключ API

{ "error_message": "Отсутствует доступ к ресурсу" }

413

Если больше 25 запрашиваемых идентификаторов в теле запроса

{ "error_message": "Слишком большой запрос" }

500

Операция не выполнена. Внутренняя ошибка сервера

5.8. POST /nk/feed-product-sign

Метод получения массива ID прошедших валидацию товаров.

Метод принимает массив объектов, в объектах содержатся good_id товара и подписанный XML для этого товара.

Количество товаров в запросе - не более 25.

Описание запроса

Параметр Значение

URL

<url стенда>/nk/feed-product-sign

Метод

POST

Content-Type

application/json

clientToken

apikey

Передаваемые параметры

Параметры заголовка запроса

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

apikey

Параметр, необходимый для авторизации и совершения запросов API. Предоставляется системой

String

Да

Параметры тела запроса

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

body

Массив подписанных XML товаров

Array

Да

*goodId

ID товара, для которого передаётся XML

Number

Да

*xml

Подписанный XML товара

String

Да

Пример запроса

"POST <url стенда>/nk/feed-product-sign?apikey=XXX
Content-Type":application/json; charset=utf-8
[
   {
      "goodId":5000,
      "xml":"<?xml version="1.0" encoding="UTF-8"?>..."
   },
   {
      "goodId":3,
      "xml":"<?xml version="1.0" encoding="UTF-8"?>..."
   },
   {
      "goodId":5,
      "xml":"<?xml version="1.0" encoding="UTF-8"?>..."
   }
]

Принимаемые параметры

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

apiversion

Номер версии API метода

Number

Да

result

Результат при наличии ответа

Area of (Object)

Нет

*signed

Массив ID товаров, XML для которых прошли валидацию, были сохранены, и товар переведен в статус "Опубликован". При наличии успешно провалидированных товаров

Array of [Numbers]

Да

*errors

Массив ошибок по каждому товару

Array of [Objects]

Да

**goodId

ID товара

Number

Да

**message

Текст ошибки

String

Да

Пример ответа

{
"apiversion":3,
"result":{
"signed":[5000,3],
"errors":[
{
"goodId":5,
"message":"Информация о товаре ... устарела или скомпроментирована. Попробуйте еще раз. "
}
]
}
}

Формат и коды ошибок

Код ошибки Описание Формат сообщения об ошибке

403

Указан неправильный ключ API

{ "error_message": "Отсутствует доступ к ресурсу" }

500

Операция не выполнена. Внутренняя ошибка сервера

5.9. GET /nk/feed-status

Метод получения статуса фида по ID фида от его заказчика.

Метод предназначен для проверки статуса ранее отправленного пакета обновлений (фида). Результат можно получить только для тех фидов, которые были отправлены компанией (лабораторией).

Описание запроса

Параметр Значение

URL

<url стенда>/nk/feed-status

Метод

GET

Content-Type

application/json

clientToken

apikey

Передаваемые параметры

Параметры заголовка запроса

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

apikey

Параметр, необходимый для авторизации и совершения запросов API. Предоставляется системой

String

Да

feed_id

Идентификатор фида

String

Да

Принимаемые параметры

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

apiversion

Номер версии API метода

Number

Да

result

Результат при наличии ответа

Area of (Object)

Нет

feed_id

Идентификатор фида

Number

Да

status_id

Идентификатор статуса фида. Возможные значения:
0 - запрос не принят;
1 - запрос получен, данные на модерации;
2 - товары прошли модерацию;
3 - одобренные модератором товары подписаны

Number

Да

status

Статус фида. Возможные значения:
Rejected - запрос не принят;
Received - запрос получен, данные на модерации;
Moderated - товары прошли модерацию;
Signed - одобренные модератором товары подписаны

String

Да

received_at

Время создания фида в формате yyyy-MM-ddTHH:mm:ss.SSS’Z

String

Да

status_updated_at

Время перехода фида в текущий статус в формате yyyy-MM-ddTHH:mm:ss.SSS’Z

String (DateTime)

Да

result

Ошибки при валидации контента

Array

Нет

item

Список дополнительных сообщений. При наличии сообщения. Структура каждого сообщения:
gtin - глобальный штрих-код к которому относится сообщение. Если связанного штрих-кода нет, то значение null;
good_id - идентификатор товара в каталоге, к которому относится сообщение. Если связанного товара нет, то значение null;
attribute_id - идентификатор атрибута в каталоге, к которому относится сообщение. Если связанного атрибута нет, то значение null;
attribute_name - название атрибута в каталоге, к которому относится сообщение. Значение может не передаваться;
status_code - числовой код ошибки;
status_message - текст статуса; message — текст сообщения

Array

Нет

totalErrors

Общее количество ошибок

Number

Нет

commonError

Общая ошибка при разборе информации

String

Нет

Пример ответа

{
"apiversion": 3,
"result": {
"feed_id": 47155,
"status": "Rejected",
"status_id": 0,
"received_at": "2020-08-27T18:32:23Z",
"status_updated_at": "2020-08-27T18:32:23Z",
"result": {
"0": [
"Не указан обязательный параметр код товара",
"Значение атрибута tnved обязательно должно быть",
"Значение атрибута brand обязательно должно быть",
"Значение атрибута good_name обязательно должно быть",
"Нет данных для изменения"
],
"totalErrors": "5"
}
}
}

Формат и коды ошибок

Код ошибки Описание Формат сообщения об ошибке

400

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

При отсутствии параметра feed_id:
{ "error_message": "Отсутствует обязательный параметр: feed_id" }
При недопустимом значении параметра feed_id:
{ "error_message": "Ошибка в параметрах запроса" }

403

Указан неправильный ключ API

Если указан неправильный ключ API:
{ "error_message": "Отсутствует доступ к ресурсу" }
При указании feed_id, не принадлежащего пользователю:
{ "error_message": "Отсутствует доступ к ресурсу" }

404

Если не найдена карточка продукта

{ "error_message": "Данные не найдены" }

500

Операция не выполнена. Внутренняя ошибка сервера

5.10. GET /nk/generate-gtins

Метод предназначен для генерации и получения списка черновиков кодов товаров.
При отправке числа новых кодов товаров и (при необходимости) ключа поставщика/производителя товаров в ответе возвращается число доступных в течение месяца для генерации кодов товаров, число уже сгенерированных кодов товаров, список новых кодов товаров.

Описание запроса

Параметр Значение

URL

<url стенда>/nk/generate-gtins

Метод

GET

Content-Type

application/json

clientToken

apikey

Передаваемые параметры

Параметры заголовка запроса

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

apikey

Параметр, необходимый для авторизации и совершения запросов API. Предоставляется системой

String

Да

quantity

Количество новых черновиков кодов товаров, которые нужно сгенерировать

Обязателен при запросе генерации новых черновиков gtin

String

Да

supplier_key

Ключ поставщика или производителя товаров

String

Нет

Принимаемые параметры

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

apiversion

Номер версии API метода

Number

Да

result

Результат при наличии ответа

Area of (Object)

Нет

*monthly-limit

Ежемесячное ограничение

Object

Да

**limit

Общее количество черновиков кодов товаров, доступных для генерации в течение одного месяца

Number

Да

**usage

Количество черновиков кодов товаров, которые уже были сгенерированы в течение этого месяца

Number

Да

*drafts

Список черновиков. При наличии сгенерированных черновиков

array

Да

**gtin

Код товара, который был сгенерирован

string

Да

Пример ответа

{
"apiversion":3,
"result":{
"monthly-limit":{
"limit":100,
"usage":6
},
"drafts":[
{
"gtin":"4600002575689"
},
{
"gtin":"4600002575696"
},
{
"gtin":"4600002575702"
}
]
}

Формат и коды ошибок

Код ошибки Описание Формат сообщения об ошибке

403

Указан неправильный ключ API

{ "error_message": "Отсутствует доступ к ресурсу" }

500

Операция не выполнена. Внутренняя ошибка сервера

5.11. GET /nk/image

Метод предназначен для пропорционального изменения размера изображения с заполнением недостающих полей белым цветом. При отправке данных об изображении в ответе возвращается JPEG изменённого изображения.

Описание запроса

Параметр Значение

URL

<url стенда>/nk/image

Метод

GET

Content-Type

application/json

clientToken

apikey

Передаваемые параметры

Параметры заголовка запроса

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

apikey

Параметр, необходимый для авторизации и совершения запросов API. Предоставляется системой

String

Да

name

Полный URI изображения

String

Нет

width

Ширина рисунка на выходе в пикселях. Должен быть в границах [100, 1000](результирующая ширина в пикселях)

String

Нет

height

Высота рисунка на выходе в пикселях. Должен быть в границах [100, 1000](результирующая высота в пикселях)

String

Нет

no-background

Параметр добавления белого фона к рисунку для соблюдения размеров. Возможные значения:

"1" - фон не добавлять;

"0" - фон добавлять (значение по умолчанию)

String

Нет

Пример запроса

<url стенда>/nk/image?apikey=XXX&name=<сервер_НК>/i/300x200/5a7eb614-13d3-69ed-caf7-420624d1bdd3.jpg&width=300&height=400

Принимаемые параметры

Изображение измененного размера в формате image/jpeg.

Формат и коды ошибок

Код ошибки Описание Формат сообщения об ошибке

403

Указан неправильный ключ API

{ "error_message": "Отсутствует доступ к ресурсу" }

500

Операция не выполнена. Внутренняя ошибка сервера

5.12. GET /nk/product

Метод получения полной информации о товаре.

Метод возвращает краткую или полную информацию о продукте (товаре). Требует обязательного указания одного из следующих параметров: идентификатор товара или код товара (штрих-код) товара.

Если указаны оба обязательных параметра, то возвращается результат выборки, соответствующий параметру good_id. Если карточка товара с данным идентификатором не обнаружена, то возвращается ошибка 404 независимо от указания кода товара в запросе.

Описание запроса

Параметр Значение

URL

<url стенда>/nk/product

Метод

GET

Content-Type

application/json

clientToken

apikey

Передаваемые параметры

Параметры заголовка запроса

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

apikey

Параметр, необходимый для авторизации и совершения запросов API. Предоставляется системой

String

Да

good_id

Идентификатор товара в каталоге. Обязательно, если не указан gtin

String

Нет

gtin

Глобальный код товара (штрих-код). Обязательно, если не указан good_id

String

Нет

product_name

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

String

Нет

cat_id

Идентификатор категории. Используется при запросе на поиск отсутствующего товара

String

Нет

Принимаемые параметры

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

apiversion

Number

Да

Номер версии API метода

result

Area of (Object)

Нет

Результат при наличии ответа

*identified_by

[Array]

Да

Массив содержащий информацию о штрих-кодах

**value

String

Да

Штрих-код или локальный идентификатор

**type

String

Да

Тип идентификатора. Возможные значения:
"gtin" - глобальный код товара (штрих-код);
"barcode" - штрих-код Barcode (штрихкод с неправильной контрольной цифрой)

**party_id

String

Нет

Идентификатор торговой сети. Возвращается только при условии, что параметр type имеет значение barcode

**multiplier

Number

Да

Количество товаров в упаковке. Значение по умолчанию = 1

**level

String

Да

Тип упаковки (уровень упаковки). Возможные значения:
"trade-unit" - штука;
"box" - коробка;
"layer" - слой на палете;
"pallet" - палета;
"metro-unit" - метро-юнит;
"show-pack" - шоу-пак;
"inner-pack" - спайка

*good_id

Number

Да

Идентификатор товара

*good_name

String

Да

Наименование товара

*good_img

String

Да

Изображение товара

*categories

[Array]

Да

Массив категорий

**cat_id

Number

Да

Идентификатор категории, в которой расположен товар, исключая родителей этой категории

**cat_name

String

Да

Наименование категории, в которой расположен товар

**party_cat_id

Number

Да

Идентификатор категории торговой сети, в которой расположен товар. Только для владельца сети, если указан party_id в запросе

**party_cat_name

String

Да

Наименование категории торговой сети, в которой расположен товар

*party_brand_id

String

Нет

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

*brand_id

Number

Да

Идентификатор бренда

*brand_name

String

Да

Наименование бренда

*good_rating

Number

Да

Рейтинг товара

*good_images

Array

Да

Массив с изображениями

**photo_type

String

Да

Тип фотографии. Возможные значения:
"default" - фотография по умолчанию (вид спереди);
"facing" - crop-фотография для планограмм (обрезанная по контуру товара);
"left" - фотография товара слева;
"right" - фотография товара справа;
"back" - фотография товара сзади;
"3ds" - 3D серия;
"marketing" - коммерческая фотография товара;
"ecommerce" - e-commerce фото;
"undef" - single shot, фотография товара с не предопределенного ракурса;
"cubi" - фотография измерения ВГХ

**photo_date

String (date-time)

Да

Дата создания фотографии в формате yyyy-MM-ddTHH:mm:ss.SSS’Z

**photo_url

[String]

Да

Ссылка на med (medium) размер фотографии

**barcode

String

Нет

Штрихкод или артикул товара, для которого сделана фотография

*good_attrs

Array

Нет

Массив атрибутов. Приватные атрибуты отдаются только те, которые принадлежат аккаунту apikey

**attr_id

Number

Да

Идентификатор атрибута

**attr_name

String

Да

Наименование атрибута

**attr_value_id

String

Нет

Идентификатор значения атрибута

**attr_value

String

Да

Значение атрибута

**value_id

Number

Нет

Идентификатор значения атрибута

**attr_value_type

Array[string]

Да

Массив возможных значений типа атрибута

**attr_group_id

Number

Да

Идентификатор группы, к которой относится атрибут

**attr_group_name

String

Да

Наименование группы, к которой относится атрибут

**measure_date

String (date-time)

Нет

Дата измерения атрибута в формате yyyy-MM-ddTHH:mm:ss.SSS’Z

**published_date

String (date-time)

Нет

Дата публикации атрибута в формате yyyy-MM-ddTHH:mm:ss.SSS’Z

**effective_date

String (date-time)

Нет

Дата, с которой действительно значение атрибута, в формате yyyy-MM-ddTHH:mm:ss.SSS’Z

**expired_date

String (date-time)

Нет

Дата, с которой недействительно значение атрибута, в формате yyyy-MM-ddTHH:mm:ss.SSS’Z

**location_id

String

Нет

Идентификатор локации, в которой было проведено измерение

**party_location_id

String

Нет

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

**level

String

Нет

Уровень упаковки

**gtin

String

Нет

Код товара (Штрих-код)

**multiplier

Number

Нет

Мультипликатор

**certificate_number

String

Нет

Номер сертификата. Только у атрибутов из группы "Сертификаты"

**certificate_issued_date

String (date-time)

Нет

Дата начала срока действия в формате yyyy-MM-ddTHH:mm:ss.SSS’Z

**certificate_valid_until_date

String (date-time)

Нет

Дата окончания срока действия в формате yyyy-MM-ddTHH:mm:ss.SSS’Z

**certificate_applicant

String

Нет

Заявитель

**certificate_manufacturer

String

Нет

Изготовитель

**certificate_product_description

String

Нет

Продукция

*good_reviews

Array

Да

Массив с отзывами

**review_id

Number

Да

Идентификатор отзыва

**review_author

String

Да

Автор (имя, фамилия, псевдоним)

**review_rating

Number

Да

Рейтинг отзыва при наличии

**review_text

String

Да

Текст отзыва

**review_date

String (date-time)

Да

Дата создания отзыва в формате yyyy-MM-ddTHH:mm:ss.SSS’Z

**review_author_img

String

Да

Ссылка на фотографию автора

**review_replies

Array

Нет

Массив с отзывами. Если отзыв имеет ответы (т.е. отзывы с review_parent_id = review_id данного/родительского отзыва)

***review_id

Number

Да

Идентификатор отзыва-ответа

***review_author

String

Да

Автор (имя, фамилия, псевдоним)

***review_rating

Number

Да

Рейтинг отзыва-ответа

***review_text

String

Да

Текст отзыва-ответа

***review_date

String (date-time)

Да

Дата создания отзыва в формате yyyy-MM-ddTHH:mm:ss.SSS’Z

***review_author_img

String

Да

Ссылка на фотографию автора

*good_reviews_count

Number

Да

Количество отзывов

*good_url

String

Да

Ссылка на страницу товара

*good_prices

Array

Да

Массив цен на товар по торговым сетям данного аккаунта

**party_id

Number

Да

Идентификатор торговой сети

**address

Array

Да

Местонахождение

***country

String

Да

Название страны согласно ISO 3166-2

***city

String

Да

Название города

***street

String

Да

Название улицы, дом

***location

Array

Да

Координаты

****lat

String

Да

Географическая широта

****lon

String

Да

Географическая долгота

Формат и коды ошибок

Код ошибки Описание Формат сообщения об ошибке

400

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

{ "error_message": "Ошибка в параметрах запроса" }

403

Указан неправильный ключ API

{ "error_message": "Отсутствует доступ к ресурсу" }

404

Если не найден продукт

{ "error_message": "Данные не найдены" }

500

Операция не выполнена. Внутренняя ошибка сервера

5.13. GET /nk/short-product

Метод получения краткой информации о товаре.

Метод возвращает краткую или полную информацию о продукте (товаре). Требует обязательного указания одного из следующих параметров: идентификатор товара, код товара (штрих-код) с указанием идентификатора торговой сети, который относится к запрашиваемому аккаунту.

Если указаны более одного из обязательных параметров, то возвращается результат выборки, соответствующий данному алгоритму: good_id - при указании, возвращается товар с соответствующим идентификатором или ошибка 404. При этом код товара (штрих код) игнорируется. gtin - при указании, возвращается товар с соответствующим кодом товара (штрих код) или ошибка 404.

Описание запроса

Параметр Значение

URL

<url стенда>/nk/short-product

Метод

GET

Content-Type

application/json

clientToken

apikey

Передаваемые параметры

Параметры заголовка запроса

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

apikey

Параметр, необходимый для авторизации и совершения запросов API. Предоставляется системой

String

Да

good_id

Идентификатор товара в каталоге. Обязательно, если не указан gtin

String

Нет

gtin

Глобальный код товара (штрих-код). Обязательно, если не указан good_id

String

Нет

product_name

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

String

Нет

cat_id

Идентификатор категории. Используется при запросе на поиск отсутствующего товара

String

Нет

Пример запроса

<url стенда>/nk/short-product?apikey=XXX&gtin=0000000000000

Принимаемые параметры

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

apiversion

Number

Да

Номер версии API метода

result

Area of (Object)

Нет

Результат при наличии ответа

*identified_by

[Array]

Да

Массив содержащий информацию о штрих-кодах

**value

String

Да

Штрих-код или локальный идентификатор

**type

String

Да

Тип идентификатора. Возможные значения:
"gtin" - глобальный код товара (штрих-код);
"barcode" — штрих-код Barcode (штрихкод с неправильной контрольной цифрой)

**party_id

String

Нет

Идентификатор торговой сети. Возвращается только при условии, что параметр type имеет значение barcode

**multiplier

Number

Да

Количество товаров в упаковке. Значение по умолчанию = 1

**level

String

Да

Тип упаковки (уровень упаковки). Возможные значения:
"trade-unit" — штука;
"box" — коробка;
"layer" — слой на палете;
"pallet" — палета;
"metro-unit" — метро-юнит;
"show-pack" — шоу-пак;
"inner-pack" — спайка</li></ul>

*categories

[Array]

Да

Массив категорий

**cat_id

Number

Да

Идентификатор категории, в которой расположен товар, исключая родителей этой категории

**cat_name

String

Да

Наименование категории, в которой расположен товар

**party_cat_id

Number

Да

Идентификатор категории торговой сети, в которой расположен товар. Только для владельца сети, если указан party_id в запросе

**party_cat_name

String

Нет

Наименование категории торговой сети, в которой расположен товар

*good_images

Array

Да

Массив с изображениями

**photo_type

String

Да

Тип фотографии. Возможные значения:
"facing" — crop-фотография для планограмм (обрезанная по контуру товара)

**photo_date

String (date-time)

Да

Дата создания фотографии в формате yyyy-MM-ddTHH:mm:ss.SSS’Z

**photo_url

[String]

Да

Ссылка на med (medium) размер фотографии

**arcode

String

Нет

Штрихкод или артикул товара, для которого сделана фотография

*good_attrs

Array

Нет

Массив атрибутов. Приватные атрибуты отдаются только те, которые принадлежат аккаунту apikey

**attr_id

Number

Да

Идентификатор атрибута

**attr_name

String

Да

Наименование атрибута

**attr_value_id

String

Нет

Идентификатор значения атрибута

**attr_value

String

Да

Значение атрибута

**value_id

Number

Нет

Идентификатор значения атрибута

**attr_value_type

Array[string]

Да

Массив возможных значений типа атрибута

**attr_group_id

Number

Да

Идентификатор группы, к которой относится атрибут

**attr_group_name

String

Да

Наименование группы, к которой относится атрибут

**measure_date

String (date-time)

Нет

Дата измерения атрибута в формате yyyy-MM-ddTHH:mm:ss.SSS’Z

**published_date

String (date-time)

Нет

Дата публикации атрибута в формате yyyy-MM-ddTHH:mm:ss.SSS’Z

**effective_date

String (date-time)

Нет

Дата, с которой действительно значение атрибута, в формате yyyy-MM-ddTHH:mm:ss.SSS’Z

**expired_date

String (date-time)

Нет

Дата, с которой недействительно значение атрибута, в формате yyyy-MM-ddTHH:mm:ss.SSS’Z

**location_id

String

Нет

Идентификатор локации, в которой было проведено измерение

**party_location_id

String

Нет

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

**level

String

Нет

Уровень упаковки

**gtin

String

Нет

код товара (Штрих-код)

**multiplier

Number

Нет

Мультипликатор

**certificate_number

String

Нет

Номер сертификата. Только у атрибутов из группы "Сертификаты"

**certificate_issued_date

String (date-time)

Нет

Дата начала срока действия в формате yyyy-MM-ddTHH:mm:ss.SSS’Z

**certificate_valid_until_date

String (date-time)

Нет

Дата окончания срока действия в формате yyyy-MM-ddTHH:mm:ss.SSS’Z

**certificate_applicant

String

Нет

Заявитель

**certificate_manufacturer

String

Нет

Изготовитель

**certificate_product_description

String

Нет

Продукция

Формат и коды ошибок

Код ошибки Описание Формат сообщения об ошибке

400

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

Если пропущен обязательный параметр или недопустимое значение параметра:
{ "error_message": "Ошибка в параметрах запроса" }

403

Указан неправильный ключ API

{ "error_message": "Отсутствует доступ к ресурсу" }

404

Если не найден продукт

{ "error_message": "Данные не найдены" }

500

Операция не выполнена. Внутренняя ошибка сервера

Вернуться к разделу "Оглавление".

6. Методы работы с документами

6.1. Документ "Уведомление о ввозе (импорт)"

6.1.1. POST /documents/transit/import/third_countries

Создание уведомления о ввозе из третьих стран. Передача документа осуществляется в формате XML. Идентификатор УОТ берется из токена.

Описание запроса

Параметр Значение

URL

<url стенда>/documents/transit/import/third_countries

Метод

POST

Content-Type

application/json

Authorization

clientToken

Передаваемые параметры

Параметры тела запроса

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

document

Содержимое документа xmlFile в кодировке base64. Структура и формат уведомления приведена ниже

String, Base64

Да

signature

Структура УКЭП кодированная в Base64. Представляет собой стандартную структуру данных, содержащую подписи, сертификаты и дополнительную информацию для проверки подписи документа

String, Base64

Да

Пример запроса

POST <url стенда>/documents/transit/import/third_countries
Content-Type: application/xml
Authorization: Bearer <ТОКЕН>
{
"document: "cHJvZHVjdF9kb2N1bWVudAp7Cmpzb24gZGVzY3JpcHRpb24KfQ==",
 "signature": "MIIFtwYJKoZIhvcNAQcCoIIFqDCCBaQCAQExDjgUAMAsGCSqGSIb3DQ"
}

Структура документа "Уведомление о ввозе из третьих стран"

Параметры заголовка запроса:

Поле Описание Тип Обязательность

fileId

Идентификатор файла

String(43)

Да

version

Версия

String

Да

sendingDateTime

Дата и время отправки сообщения в НИС «ASL BELGISI» в формате YYYY-MM-DDThh:mm:ssZ, часовой пояс Нур-Султан

String(DateTime)

Да

document

Сведения о передаваемом документе Уведомление о ввозе товаров, неявляющихся участниками ЕАЭС

ComplexType

Да

*mainInfo

Общая информация об Уведомлении

ComplexType

Да

**importerInfo

Сведения о покупателе (импортере)

ComplexType

Да

***importerName

Наименование импортера

String{1;100}

Да

***importerCode

ИНН получателя (импортера)

String(12)

Да

**exportCountry

Страна экспорта согласно справочнику стран

String

Да

**customDocument

Сведения о документе таможенного оформления

ComplexType

Да

***declarationNumber

Регистрационный номер документа

String

Да

***declarationDate

Дата регистрации документа в формате DD.MM.YYYY

Date

Да

***currency

Валюта (трехзначный код валюты)

String

Да

***currencyRate

Ставка валюты

decimal

Да

*productItems

Сведения о кодах идентификации из декларации, и сведения о товарах, связанными с этими кодами

ComplexType

Да

**item

Информация по каждому загружаемому коду идентификации

ComplexType

Да

***iCodeFromDeclaration

КИ/КИГУ/КИТУ, заявленные в таможенной декларации

String

Да

***product

Списки товаров

ComplexType

Да

****tnved

ТНВЭД - товарная номенклатура внешнеэкономической деятельности Евразийского экономического союза

String(10)

Да

****gtin

GTIN товара

String

Да

****originCountry

Страна производства товара

String

Да

****certificateNumber

Номер разрешительного документа

String

Да

****certificateDate

Дата разрешительного документа

Date

Да

****itemNumber

Номер товара в Декларации на товары (ДТ)

Integer

Да

****customValue

Таможенная стоимость

decimal

Да

****unitPrice

Цена за единицу продукции

decimal

Да

****ExciseTax

Сумма акциза

decimal

Да

****vat

Сумма НДС

decimal

Да

****iCode

Перечень (массив) КИ потребительских упаковок (level 0), связанных с конкретным товаром

String

Нет

Принимаемые параметры

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

documentId

Идентификатор документа в НИС «ASL BELGISI»

GUID

Да

Формат и коды ошибок

Код ошибки Описание

400

Операция не выполнена. Невалидный формат XML документа

422

Ошибка проверки подписи

500

Операция не выполнена. Внутренняя ошибка сервера

6.2. Прочие методы

6.2.1. GET /doc/listV2

Метод получения списка документов ранее загруженных в НИС «ASL BELGISI» с расширенным составом атрибутов.

Описание запроса

Параметр Значение

URL

<URL стенда>api/v3/doc/listV2

Метод

GET

Content-Type

application/json

Передаваемые параметры

Параметры заголовка запроса:

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

dateFrom

Дата документа, от. Задается в формате yyyy-MM-ddTHH:mm:ss.SSS’Z

String (DateTime)

Нет

dateTo

Дата документа, до. Задается в формате yyyy-MM-ddTHH:mm:ss.SSS’Z

String (DateTime)

Нет

did

Значение номера документа, "точки отсчета" (запись, с которой начнется выборка), по которому сортируются записи. Использовать только совместно с параметром orderedColumnValue

String

Нет

documentFormat

Тип документа:
MANUAL – формат json;
UPD – ЭДО;
XML – формат xml;
CSV – формат csv

String

Нет

documentStatus

Статус документа. Справочник "Статусы документов"

String

Нет

documentType

см. Справочник "Типы документов"

Array [string]

Нет

inputFormat

Входящий (true)/исходящий (false) документ

Boolean

Нет

limit

Значение устанавливает количество записей в ответе, не более 10000 записей. (По умолчанию 10 записей). При указании параметра, необходимо указать товарную группу

Number

Нет

number

Номер документа

String

Нет

order

Направление сортировки:
ASC – по возрастанию;
DESC – по убыванию

String

Нет

orderColumn

Название столбца, по которому будет производиться сортировка. Допустимое значение receivedAt - дата эмиссии

String

Нет

orderedColumnValue

Значение столбца, "точки отсчета" (запись, с которой начинается выборка), по которому сортируются записи. Использовать только совместно с параметром did

String

Нет

pageDir

Выбор направления:
PREV – Предыдущий раздел;
NEXT – Следующий раздел

String

Нет

participantInn

ИНН участника, осуществившего эмиссию КМ

String

Нет

pg

Товарная группа. См. "Список поддерживаемых товарных групп"

String

Нет

Пример запроса

GET url стенда>/doc/listV2?documentFormat=MANUAL&documentType=AGGREGATION_DOCUMENT&limit=10&order=ASC&pg=tobacco
Authorization: Bearer <Токен>

Принимаемые параметры

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

number

Идентификатор документа в НИС «ASL BELGISI»

String

Нет

docDate

Дата и время документа. Возвращается в формате yyyy-MM-ddTHH:mm:ss.SSS’Z

String (DateTime)

Нет

receivedAt

Дата и время получения документа в формате yyyy-MM-ddTHH:mm:ss.SSS’Z

String (DateTime)

Нет

type

Тип документа См. Справочник "Типы документов"

String

Да

status

Статус обработки документа См. Справочник "Статусы документов"

String

Да

externalId

Id документа во внешней системе ЭДО

String

Нет

senderInn

ИНН отправителя документа

String

Нет

senderName

Наименование отправителя документа

String

Нет

receiverInn

ИНН получателя документа

String

Нет

receiverName

Наименование получателя документа

String

Нет

invoiceNumber

Номер счёта-фактуры, УКД, если используется. Для ТГ "Табачная продукция" не выводится

String

Нет

invoiceDate

Дата счёта-фактуры, УКД, если используется, в формате yyyy-MM-ddTHH:mm:ss.SSS’Z. Для ТГ "Табачная продукция" не выводится

String (DateTime)

Нет

total

Общая сумма документа в разменных денежных единицах (тийин)

Number

Нет

vat

Сумма НДС документа в разменных денежных единицах (тийин)

Number

Нет

downloadStatus

Статус загрузки документа. См. Справочник "Статусы документов"

String

Нет

downloadDesc

Описание загрузки документа. При наличии ошибки в загрузке документа

String

Нет

body

Контент документа. Содержимое документа в формате JSON с набором полей, специфичных для каждого типа документа

Object

Нет

content

Контент документа. Содержимое документа в начальном виде

String

Нет

input

Признак того, что документ является входящим/исходящим. Возможные значения:
true – входящий
false – исходящий

Boolean

Нет

pdfFile

Ссылка на PDF-файл

String

Нет

errors

Ошибки. Параметр возвращается при наличии ошибки

String

Нет

docErrors

Список ошибок обработки документа. Только в случае ошибки. Для ТГ "Табачная продукция" не выводится

String

Нет

errorMessage

Сообщение об ошибке при обработке json, xml. Параметр возвращается при наличии ошибки.

Значение параметра:
"code: <documentDataDto.errors.code> error: <documentDataDto.errors.DocumentValidationError>", например, "code: 71 error: "

String

Нет

errorMessages

Список сообщений об ошибке при обработке самого документа.

Параметр возвращается при наличии ошибок. Значение параметра:
"<documentDataDto.errors.data>", например,
""reason":["ciss"],"count":1,"tpe":"ReasonErrorData""

List of <string>

Нет

sender

Отправитель

String

Нет

*name

Наименование отправителя

String

Нет

*address

Адрес

String

Нет

*inn

ИНН отправителя

String

Нет

*kpp

Код причины постановки на учет. Не заполняется

String

Нет

receiver

Получатель. Только для УД

String

Нет

*name

Наименование получателя

String

Нет

*address

Адрес

String

Нет

*inn

ИНН получателя

String

Нет

*kpp

Код причины постановки на учет. Не заполняется

String

Нет

total

Количество вернувшихся ответов

Number

Да

Пример ответа

{
  "results": [
    {
      "number": "407076ca-3cb3-485f-90aa-95c79ac558d9",
      "docDate": "2019-05-11T00:00:00.000Z",
      "receivedAt": "2021-02-12T14:20:49.300Z",
      "type": "WRITE_OFF",
      "status": "CHECKED_OK",
      "senderName": "ИП Брэд Питт",
      "total": 0,
      "downloadStatus": "CHECKED_OK",
      "downloadDesc": "",
      "input": false,
      "pdfFile": ""
    },
    {
      "number": "71c12ad3-af91-48f4-80b3-25fced118b9f",
      "docDate": "2020-08-25T11:23:31.076Z",
      "receivedAt": "2020-08-25T11:23:55.379Z",
      "type": "AGGREGATION_DOCUMENT",
      "status": "CHECKED_NOT_OK",
      "senderName": "ИП Брэд Питт",
      "total": 0,
      "downloadStatus": "CHECKED_NOT_OK",
      "downloadDesc": "Содержание документа некорректно. Некорректные данные: senderInn",
      "input": false,
      "pdfFile": "",
      "errors": [
        "Содержание документа некорректно. Некорректные данные: senderInn"
      ]
    }
  ],
  "total": 105
}

Формат и коды ошибок

Код ошибки Описание Формат сообщения об ошибке

400

Операция не выполнена. Ошибки в параметрах фильтра

{ "error_message": "string" }

403

Нет доступа к запрашиваемой информации

При проверке доступа для зарегистрированных УОТ:
{
"error_message": "Отсутствует доступ к ресурсу"
}

500

Операция не выполнена. Внутренняя ошибка сервера

{ "error_message": "string" }

6.2.2. GET /documents/{document_id}/info

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

Ограничение:

  • УОТ может получить список только тех документов, где он является стороной документа.

Описание запроса

Параметр Значение

URL

<url стенда>/documents/{document_id}/info

Метод

GET

Content-Type

application/json

Передаваемые параметры

Параметры заголовка запроса:

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

document_id

Идентификатор документа / номер документа, формируемый в НИС «ASL BELGISI»

String

Да

Пример запроса

GET <url стенда>/documents/2f373b02-727c-4370-8e79-0add09876c07/info
Authorization: Bearer <Токен>

Принимаемые параметры

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

number

Номер документа

String

Да

docDate

Дата и время документа. Возвращается в формате yyyy-MM-ddTHH:mm:ss.SSS’Z

String (DateTime)

Да

receivedAt

Дата и время получения документа в формате yyyy-MM-ddTHH:mm:ss.SSS’Z

String (DateTime)

Да

type

Тип документа См. Справочник "Типы документов"

String

Да

status

Статус обработки документа См. Справочник "Статусы документов"

String

Да

externalId

Id документа во внешней системе ЭДО

String

Нет

senderInn

ИНН отправителя документа

String

Да

senderName

Наименование отправителя документа

String

Да

receiverInn

ИНН получателя документа

String

Нет

receiverName

Наименование получателя документа

String

Нет

invoiceNumber

Номер счёта-фактуры, УКД. Для ТГ "Табачная продукция" не выводится

String

Нет

invoiceDate

Дата счёта-фактуры, УКД. Возвращается в формате yyyy-MM-ddTHH:mm:ss.SSS’Z. Для ТГ "Табачная продукция" не выводится

String (DateTime)

Нет

total

Общая сумма документа в разменных денежных единицах (тийин)

Number

Нет

vat

Сумма НДС документа в разменных денежных единицах (тийин)

Number

Нет

downloadStatus

Статус загрузки документа. См. Справочник "Статусы документов"

String

Нет

downloadDesc

Описание загрузки документа. При наличии ошибки в загрузке документа

String

Нет

body

Контент документа. Содержимое документа в формате JSON с набором полей, специфичных для каждого типа документа

Object

Нет

content

Контент документа. Содержимое документа в начальном виде

String

Да

input

Признак того, что документ является входящим/исходящим. Возможные значения:
true – входящий
false – исходящий

Boolean

Нет

pdfFile

Ссылка на PDF-файл

String

Нет

errors

Ошибки. Параметр возвращается при наличии ошибки

Area of [String]

Нет

docErrors

Список ошибок обработки документа. Только в случае ошибки.
Для ТГ "Табачная продукция" не выводится

String

Нет

errorMessage

Сообщение об ошибке при обработке json, xml. Параметр возвращается при наличии ошибки.

Значение параметра:
"code: <documentDataDto.errors.code> error: <documentDataDto.errors.DocumentValidationError>", например, "code: 71 error: "

String

Нет

errorMessages

Список сообщений об ошибке при обработке самого документа.

Параметр возвращается при наличии ошибок. Значение параметра: "<documentDataDto.errors.data>", например, ""reason":["ciss"],"count":1,"tpe":"ReasonErrorData""

List of <string>

Нет

sender

Отправитель

String

Нет

*name

Наименование

String

Нет

*address

Адрес

String

Нет

*inn

ИНН

String

Нет

*kpp

Код причины постановки на учет. Не заполняется

String

Нет

receiver

Получатель. Только для УД

String

Нет

*name

Наименование

String

Нет

*address

Адрес

String

Нет

*inn

ИНН

String

Нет

*kpp

Код причины постановки на учет. Не заполняется

String

Нет

Пример ответа

{
  "number": "2f373b02-727c-4370-8e79-0add09876c07",
  "docDate": "2020-02-08T09:30:47.000Z",
  "receivedAt": "2021-02-09T11:38:18.623Z",
  "type": "IMPORT",
  "status": "CHECKED_OK",
  "senderInn": "306535627",
  "senderName": "\"CRPT TURON\" MChJ",
  "content": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<!--Sample XML file generated by XMLSpy v2018 rel. 2 sp1 (x64) (http://www.altova.com)-->\n<file xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" fileId=\"2f373b02-727c-4370-8e79-0add09876c07\" version=\"1.0\" sendingDateTime=\"2020-02-08T09:30:47Z\" xsi:noNamespaceSchemaLocation=\"xsd_notific_import_uz.xsd\">\n\t<document>\n\t\t<mainInfo>\n\t\t\t<importerInfo importerName=\""CRPT TURON" MChJ\" importerCode=\"306535627\"/>\n\t\t\t<exportCountry>RU</exportCountry>\n\t\t\t<customDocument declarationNumber=\"306535627/07022020/176296\" declarationDate=\"07.02.2020\" currency=\"RUB\" currencyRate=\"12.0000\"/>\n\t\t</mainInfo>\n\t\t<productItems>\n\t\t\t<item iCodeFromDeclaration=\"010467003456748821QSXFzdG\">\n\t\t\t\t<product tnved=\"2203000100\" gtin=\"04670034567488\" originCountry=\"ML\" certificateNumber=\"TEST123\" certificateDate=\"04.12.2020\" itemNumber=\"1\" customValue=\"1290.22\" unitPrice=\"23.40\" ExciseTax=\"12.10\" vat=\"5.12\">\n\t\t\t\t\t<iCode><![CDATA[010467003456748821QSXFzdG]]></iCode>\n\t\t\t\t</product>\n\t\t\t</item>\n\t\t</productItems>\n\t</document>\n</file>\n"
}

Формат и коды ошибок

Код ошибки Описание Формат сообщения об ошибке

400

Операция не выполнена. Неверные входные параметры, отсутствует документ с указанным в URL идентификатором

{ "error_message": "Ошибка получения тела документа" }

401

Не авторизован, в запросе отсутствует clientToken

<UnauthorizedException> <error>unauthorized</error> <error_description>Full authentication is required to access this resource</error_description> </UnauthorizedException>

403

Нет доступа к запрашиваемой информации

При проверке доступа для зарегистрированных УОТ:
{
"error_message": "Отсутствует доступ к ресурсу"
}

500

Операция не выполнена. Внутренняя ошибка сервера

{ "error_message": "Произошла внутренняя ошибка" }

6.2.3. GET /receipt/listV2

Метод получения списка чеков, ранее загруженных в НИС «ASL BELGISI».

Описание запроса

Параметр Значение

URL

<url стенда>/receipt/listV2

Метод

GET

Content-Type

application/json

Передаваемые параметры

Параметры заголовка запроса:

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

dateFrom

Дата документа, от. Задается в формате yyyy-MM-ddTHH:mm:ss.SSS’Z

String (DateTime)

Нет

dateTo

Дата документа, до. Задается в формате yyyy-MM-ddTHH:mm:ss.SSS’Z

String (DateTime)

Нет

did

Номер документа

String

Нет

limit

Значение устанавливает количество записей в ответе, не более 10000 записей. (По умолчанию 10 записей). При указании параметра, необходимо указать товарную группу

Number

Нет

order

Направление сортировки:
ASC – по возрастанию;
DESC – по убыванию

String

Нет

pageDir

Выбор направления:
PREV – Предыдущий раздел;
NEXT – Следующий раздел

String

Нет

senderInn

ИНН участника

String

Нет

pg

Товарная группа. Параметр обязательно указывать для товарных групп:
tobacco – Табачная продукция;
alcohol – Алкогольная продукция

String

Нет

Пример запроса

curl -X GET   "<url стенда>/receipt/listV2?number=string&
 dateFrom=2020-04-04T07%3A43%3A27.237Z&dateTo=2020-04-04T07%3A43%3A27.237Z&participantInn=string&\
 documentType=UNKNOWN&documentStatus=IN_PROGRESS&documentFormat=MANUAL&\``
 inputFormat=true&pageDir=PREV&did=string&orderColumn=string&\
 order=ASC&orderedColumnValue=string&limit=0&pg=string" \ -H
 "accept: */*" -H "Authorization: Bearer <ТОКЕН>'

Принимаемые параметры

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

did

Значение номера документа

String

Да

receiptDate

Дата документа. Задается в формате yyyy-MM-ddTHH:mm:ss.SSS’Z

String(Date)

Да

type

Тип документа:
RECEIPT – чек;
RECEIPT_RETURN – чек возврата

String

Да

status

Статус обработки документа См. Справочник "Статусы документов"

String

Да

senderName

Наименование отправителя

String

Да

senderInn

ИНН отправителя

String

Да

Пример ответа

{
    "did":"UZ1909120024010000002149483407",
    "receiptDate":"2020-12-30T17:42:56.000Z",
    "type":"RECEIPT",
    "status":"CHECKED_OK",
    "senderName":"\"CRPT TURON\" MChJ",
    "senderInn":"306535627"
}

Формат и коды ошибок

Код ошибки Описание Формат сообщения об ошибке

400

Операция не выполнена. Ошибки в параметрах фильтра

{ "error_message": "string" }

403

Нет доступа к запрашиваемой информации

При проверке доступа для зарегистрированных УОТ:
{
"error_message": "Отсутствует доступ к ресурсу"
}

500

Операция не выполнена. Внутренняя ошибка сервера

{ "error_message": "string" }

6.2.4. GET /receipt/{receiptId}/info

Запрос информации о чеке по его идентификатору.

Описание запроса

Параметр Значение

URL

<url стенда>/receipt/{receiptId}/info

Метод

GET

Content-Type

application/json

Передаваемые параметры

Параметры заголовка запроса:

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

receiptId

Идентификатор чека

String

Да

pg

Товарная группа. См. справочник "Список поддерживаемых товарных групп"

String

Нет

Пример запроса

curl -X GET "<url стенда>/receipt/12345/info" -H
 "accept: */*" -H "Authorization: Bearer <Токен>

Принимаемые параметры

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

documentId

Номер документа

String

Да

documentDate

Дата и время документа. Возвращается в формате UnixTime

String

Да

receivedAt

Дата и время загрузки документа. Возвращается в формате UnixTime

String

Да

type

Тип документа:
RECEIPT – чек
RECEIPT_RETURN – чек возврата

String

Да

status

Статус обработки документа См. Справочник "Статусы документов"

String

Да

senderInn

ИНН отправителя чека

String

Да

senderName

Отправитель чека

String

Да

fiscalDocumentNumber

Порядковый номер фискального документа (чека)

Number

Да

fiscalSign

Фискальная подпись (признак, отметка)

String

Нет

operationType

Признак расчета:
1 - обработка чека (приход)
2 - возвращение товара по чеку

Number

Да

kktRegId

Номер фискального модуля (терминала или ККМ)

String

Да

shiftNumber

Номер смены

Number

Нет

products

Предмет расчета в чеке

Area of [objects]

Да

*gtin

Код товара из чека

String

Да

*cis

КМ проданного товара из чека

String

Да

*id

Идентификатор товара/услуги в НИС «ASL BELGISI» согласно gtin коду

Number

Да

*name

Наименование товара/услуги (согласно наименованию в НИС «ASL BELGISI»)

String

Да

*price

Стоимость товара/услуги (указана за единицу товара/услуги, сум)

Number

Нет

*sum

Стоимость товара/услуги (совокупно за указанное количество (объем) товара/услуги, сум) из чека

Number

Да

*count

Количество (объем) товара/услуги, указанное в чеке

Number

Да

*nds

В том числе НДС (совокупно за указанное количество (объем) товара/услуги, сум) из чека

Number

Да

*producerId

Идентификатор продавца в НИС «ASL BELGISI»

Number

Нет

*percentage

Скидка, указанная за товар/услугу, сум

Number

Нет

*packageType

Тип упаковки. См. справочник "Типы упаковок"

String

Нет

docErrors

Список ошибок обработки документа. Только в случае ошибки

Area of [String]

Нет

Пример ответа

{
  "kktRegId": "UZ190912002401",
  "userInn": "306535627",
  "fiscalDocumentNumber": "2147483369",
  "fiscalSign": "77778",
  "shiftNumber": "4294967295",
  "operationType": "1",
  "senderInn": "306535627",
  "senderName": "\"CRPT TURON\" MChJ",
  "documentId": "UZ1909120024010000002147483369",
  "products": [
    {
      "id": 38,
      "name": "Сигареты с фильтром Турон",
      "gtin": "04780085115566",
      "price": "5000",
      "count": 3,
      "packageType": "block",
      "sum": "15000",
      "nds": "1500",
      "percentage": "0",
      "producerId": "34",
      "cis": "(01)04780085115566(21)LGgD3Np",
      "valid": true
    },
    {
      "id": 31,
      "name": "Пиво светлое Krona, 4х0.5л",
      "gtin": "05380004560027",
      "price": "25000",
      "count": 1,
      "packageType": "pack",
      "sum": "25000",
      "nds": "2500",
      "percentage": "0",
      "producerId": "34",
      "cis": "010538000456002721L4QoIaCUr;IPZ",
      "valid": true
    }
  ],
  "status": "CHECKED_OK",
  "type": "RECEIPT",
  "documentDate": 1609350176000000,
  "receivedAt": 1609339420956000
}

Формат и коды ошибок

Код ошибки Описание Формат сообщения об ошибке

400

Операция не выполнена. При неверном идентификаторе чека

{ "error_message": "string" }

403

Нет доступа к запрашиваемой информации

При проверке доступа для зарегистрированных УОТ:
{
"error_message": "Отсутствует доступ к ресурсу"
}
При проверке доступа к чекам:
{
"error_message": "Чек с идентификатором <UUID> принадлежит другому владельцу"
}

500

Операция не выполнена. Внутренняя ошибка сервера

{ "error_message": "string" }

Вернуться к разделу "Оглавление".

7. Методы биллинга

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

7.1. POST /elk/crm-api/prequests

Метод получения счета на оплату.

Метод возвращает от SD статус обработки запроса на получение счёта на оплату. Идентификатор УОТ (ParticipantId) берётся из токена. При успешном выполнении запроса на указанный в запросе e-mail отправляется файл со счётом на оплату.

Описание запроса

Параметр Значение

URL

<url стенда>/elk/crm-api/prequests

Метод

POST

Content-Type

application/json

Authorization

clientToken

Передаваемые параметры

Параметры тела запроса

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

contractId

Идентификатор договора УОТ с НИС «ASL BELGISI»

String

Да

amount

Сумма счёта на оплату с учетом НДС.

Значение данного параметра будет указано в счёте на оплату

String

Да

sendto

e-mail УОТ. На данный e-mail будет отправлен счёт на оплату

String

Да

Пример запроса

POST <url стенда>/elk/crm-api/prequests
authorization: Bearer <ТОКЕН>
Content-Type: application/json
{
  "contractId": 1000005356,
  "amount": 120000000,
  "sendto": "test@test.com"
}

Принимаемые параметры

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

status

Код статуса обработки запроса на получение счёта на оплату

Да

String

response

Идентификатор созданного счета на оплату

Да

Number

error_message

Текст сообщения об ошибке при обработке запроса.

Параметр указывается при наличии ошибки

Нет

String

Пример ответа в случае успеха

{
"status": 200
}

Формат и коды ошибок

Код ошибки Описание Формат сообщения об ошибке

400

Неверные входные параметры

Если отсутствует тело запроса:
{ "error_message": "Required request body is missing" }

401

Не авторизован, в запросе отсутствует clientToken

<UnauthorizedException> <error>unauthorized</error> <error_description>Full authentication is required to access this resource</error_description> </UnauthorizedException>

500

Операция не выполнена. Внутренняя ошибка сервера

7.2. GET /elk/product-groups/balance

Получение баланса УОТ по одной ТГ.

Метод предназначен для получения значения баланса лицевого счета УОТ для запрашиваемой товарной группы. Выполнять запрос можно ТОЛЬКО для получения собственного баланса денежных средств.

Описание запроса

Параметр Значение

URL

<url стенда>/elk/product-groups/balance

Метод

GET

Content-Type

application/json

Передаваемые параметры

Параметры заголовка запроса:

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

productGroupId

Идентификатор товарной группы УОТ. См. справочник "Список поддерживаемых товарных групп"

Number

Да

Пример запроса

GET <url стенда>/elk/product-groups/balance?productGroupId=3
Authorization: Bearer:<ТОКЕН>;

Принимаемые параметры

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

balance

Значение баланса в разменных денежных единицах (тийин)

Number

Нет

contractId

Идентификатор договора УОТ с НИС «ASL BELGISI»

Number

Нет

organisationId

Идентификатор организации УОТ в НИС «ASL BELGISI»

Number

Да

productGroupId

Идентификатор товарной группы УОТ

см. Справочник "Список поддерживаемых товарных групп"

Number

Да

Пример ответа

{
  "balance": 120000000,
  "contractId": 1000005356
  "organisationId": 600000749,
  "productGroupId": 3
}

Формат и коды ошибок

Код ошибки Описание Формат сообщения об ошибке

400

Ошибка выполнения запроса

Если УОТ не принадлежит запрашиваемая ТГ:
{ "error_message": "Участнику не принадлежит продуктовая группа с кодом: 11" }

401

Не авторизован, в запросе отсутствует clientToken

В случае отсутствия токена:
<UnauthorizedException> <error>unauthorized</error> <error_description>Full authentication is required to access this resource</error_description> </UnauthorizedException>

Если токен некорректный:
{ "error": "invalid_token" }

404

Некорректные значения

В случае, если в токене отсутствует pid:
{ "error_message": "В токене отсутствует свойство pid" }+

В случае, если в ответе вернулся пустой массив, означающий указание в запросе некорректного/несуществующего в Системе ID УОТа, либо отсутствие у УОТа лицевого счета в Системе:
{ "error_message": "В токене указано некорректное значение параметра pid, либо в Системе нет пользователя с идентификатором 600000124, либо у пользователя с идентификатором 60000001 нет лицевого счёта в Системе" }

500

Операция не выполнена. Внутренняя ошибка сервера

7.3. GET /elk/product-groups/balance/all

Получение баланса УОТ по всем ТГ.
Метод предназначен для получения значения баланса лицевых счетов УОТ для каждой его товарной группы.
Выполнять запрос можно ТОЛЬКО для получения собственного баланса денежных средств.

Описание запроса

Параметр Значение

URL

<url стенда>/elk/product-groups/balance/all

Метод

GET

Content-Type

application/json/zip

Authorization

clientToken

Пример запроса

<url стенда>/elk/product-groups/balance/all
Authorization: Bearer:<ТОКЕН>

Принимаемые параметры

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

balance

Значение баланса в тийинах

Number

Нет

contractId

Идентификатор договора УОТ с НИС «ASL BELGISI» на подключенную ТГ

Number

Нет

organisationId

Идентификатор организации УОТ в НИС «ASL BELGISI»

Number

Да

productGroupId

Идентификатор товарной группы УОТ

см. справочник "Список поддерживаемых товарных групп"

Number

Да

Пример ответа

[
   {
      "balance": 120000000,
      "organisationId": 600000749,
      "productGroupId": 3
   },
   {
      "organisationId": 600000749,
      "productGroupId": 11
   },
   {
      "balance": 0,
      "contractId": 1000005356,
      "organisationId": 600000749,
      "productGroupId": 15
   }
]

Формат и коды ошибок

Код ошибки Описание Формат сообщения об ошибке

401

Не авторизован, в запросе отсутствует clientToken

<UnauthorizedException> <error>unauthorized</error> <error_description>Full authentication is required to access this resource</error_description> </UnauthorizedException>

404

Некорректные значения

В случае, если в токене отсутствует pid:
{ "error_message": "В токене отсутствует свойство pid" }

В случае, если в ответе вернулся пустой массив, означающий указание в запросе некорректного/несуществующего в Системе ID УОТа, либо отсутствие у УОТа лицевого счета в Системе:
{ "error_message": "В токене указано некорректное значение параметра pid, либо в Системе нет пользователя с идентификатором 600000124, либо у пользователя с идентификатором 60000001 нет лицевого счёта в Системе" }

500

Операция не выполнена. Внутренняя ошибка сервера

Вернуться к разделу "Оглавление".

8. Справочники

Примечание. Список и состав справочников будет обновляться по мере разработки и обновления методов True-API.

8.1. Список поддерживаемых товарных групп

Идентификатор Наименование Описание

3

tobacco

Табачная продукция

11

alcohol

Алкогольная продукция

15

beer

Пиво и пивные напитки

18

appliances

Бытовая техника

7

pharma

Лекарственные средства

13

water

Вода и прохладительные напитки

8.2. Типы упаковки

Код Описание Комментарий для МОТП Комментарий для не МОТП

UNIT

Единица товара

Пачка

Товарная упаковка

LEVEL1

Упаковка 1-го уровня

Блок

Транспортная упаковка 1-го уровня

LEVEL2

Упаковка 2-го уровня

Коробка

Транспортная упаковка 2-го уровня (на данный момент это SSCC)

LEVEL3

Упаковка 3-го уровня

Паллета

LEVEL4

Упаковка 4-го уровня

LEVEL4

LEVEL5

Упаковка 5-го уровня

LEVEL5

BUNDLE

Комплект

BUNDLE

8.3. Статусы КМ

Код в БД Код Описание

0

EMITTED

Эмитирован

1

APPLIED

Нанесён

2

INTRODUCED

Введен в оборот

3

WRITTEN_OFF

Утилизирован

4

WITHDRAWN

Выведен из оборота

5

RESERVED_NOT_USED

Зарезервировано. Не использовать

6

INTRODUCED_RETURNED

Возвращён в оборот

7

DISAGGREGATED

Дезагрегирован

8

WAIT_SHIPMENT

Ожидает отгрузки

9

EXPORTED

Используется для документов экспорта

12

APPLIED_NOT_PAID

Нанесён, не оплачен

8.4. Типы документов

Код Наименование Формат Описание формата типа документа

RECEIPT

Чек

Формируется оператором фискальных данных

RECEIPT_RETURN

Чек возврата

Формируется оператором фискальных данных

IMPORT

Уведомление о ввозе из третьих стран

WRITE_OFF

Документ о списании КМ

AGGREGATION_DOCUMENT

Документ агрегации

8.5. Статусы документов в ядре НИС «ASL BELGISI»

Код Описание

IN_PROGRESS

Проверяется

CHECKED_OK

Оформлен

CHECKED_NOT_OK

Ошибка при проверке

PROCESSING_ERROR

Ошибка при обработке

UNDEFINED

Не определён

CANCELLED

Документ отменён

WAIT_ACCEPTANCE

Ожидание приемку. Только для документа "Отгрузка". Устанавливается при успешной обработке документа "Отгрузка товара";

WAIT_PARTICIPANT_REGISTRATION

Ожидает регистрации участника в Системе. Только для документа "Отгрузка". Устанавливается при успешной обработке документа "Отгрузка товара" в сторону незарегистрированного участника

8.6. Способ выпуска товаров в оборот

Код Описание

FOREIGN

Ввезён в Республику Узбекистан

LOCAL

Производство Республики Узбекистан

8.7. Справочник кодов стран

Краткое название страны Полное название страны Буквенный код

АВСТРАЛИЯ

АВСТРАЛИЯ

AU

АВСТРИЯ

АВСТРИЙСКАЯ РЕСПУБЛИКА

AT

АЗЕРБАЙДЖАН

РЕСПУБЛИКА АЗЕРБАЙДЖАН

AZ

АЛАНДСКИЕ ОСТРОВА

АЛАНДСКИЕ ОСТРОВА

AX

АЛБАНИЯ

РЕСПУБЛИКА АЛБАНИЯ

AL

АЛЖИР

АЛЖИРСКАЯ НАРОДНАЯ ДЕМОКРАТИЧЕСКАЯ РЕСПУБЛИКА

DZ

АМЕРИКАНСКОЕ САМОА

АМЕРИКАНСКОЕ (ВОСТОЧНОЕ) САМОА (США)

AS

АНГИЛЬЯ

АНГИЛЬЯ

AI

АНГОЛА

РЕСПУБЛИКА АНГОЛА

AO

АНДОРРА

КНЯЖЕСТВО АНДОРРА

AD

АНТАРКТИДА

АНТАРКТИДА

AQ

АНТИГУА И БАРБУДА

АНТИГУА И БАРБУДА

AG

АРГЕНТИНА

АРГЕНТИНСКАЯ РЕСПУБЛИКА

AR

АРМЕНИЯ

РЕСПУБЛИКА АРМЕНИЯ

AM

АРУБА

ОСТРОВ АРУБА

AW

АФГАНИСТАН

ПЕРЕХОДНОЕ ИСЛАМСКОЕ ГОСУДАРСТВО АФГАНИСТАН

AF

БАГАМСКИЕ ОСТРОВА

БАГАМСКИЕ ОСТРОВА

BS

БАНГЛАДЕШ

НАРОДНАЯ РЕСПУБЛИКА БАНГЛАДЕШ

BD

БАРБАДОС

БАРБАДОС

BB

БАХРЕЙН

КОРОЛЕВСТВО БАХРЕЙН

BН

БЕЛАРУСЬ

РЕСПУБЛИКА БЕЛАРУСЬ

BY

БЕЛИЗ

БЕЛИЗ

BZ

БЕЛЬГИЯ

КОРОЛЕВСТВО БЕЛЬГИИ

BE

БЕНИН

РЕСПУБЛИКА БЕНИН

BJ

БЕРМУДСКИЕ ОСТРОВА

БЕРМУДСКИЕ ОСТРОВА

BM

БОЛГАРИЯ

РЕСПУБЛИКА БОЛГАРИЯ

BG

БОЛИВИЯ

БОЛИВИЯ, МНОГОНАЦИОНАЛЬНОЕ ГОСУДАРСТВО

BO

БОНЭЙР, СИНТ-ЭСАТИУС И САБА

БОНЭЙР, СИНТ-ЭСАТИУС И САБА

BQ

БОСНИЯ И ГЕРЦЕГОВИНА

БОСНИЯ И ГЕРЦЕГОВИНА

BA

БОТСВАНА

РЕСПУБЛИКА БОТСВАНА

BW

БРАЗИЛИЯ

ФЕДЕРАТИВНАЯ РЕСПУБЛИКА БРАЗИЛИЯ

BR

БРИТАНСКИЕ ТЕРРИТОРИИ

БРИТАНСКАЯ ТЕРРИТОРИЯ В ИНДИЙСКОМ ОКЕАНЕ (БРИТ.)

IO

БРУНЕЙ-ДАРУССАЛАМ

БРУНЕЙ-ДАРУССАЛАМ

BN

БУВЕ

ОСТРОВ БУВЕ

BV

БУРКИНА-ФАСО

БУРКИНА-ФАСО

BF

БУРУНДИ

РЕСПУБЛИКА БУРУНДИ

BI

БУТАН

КОРОЛЕВСТВО БУТАН

BT

ВАНУАТУ

РЕСПУБЛИКА ВАНУАТУ

VU

ВАТИКАН

ГОСУДАРСТВО-ГОРОД ВАТИКАН

VA

ВЕНГРИЯ

ВЕНГЕРСКАЯ РЕСПУБЛИКА

НU

ВЕНЕСУЭЛА

БОЛИВАРИЙСКАЯ РЕСПУБЛИКА ВЕНЕСУЭЛА

VE

ВИРГИН. ОСТРОВА (США)

ВИРГИНСКИЕ ОСТРОВА (США)

VI

ВИРГИН. ОСТРОВА (БРИТ.)

БРИТАНСКИЕ ВИРГИНСКИЕ ОСТРОВА

VG

ВЬЕТНАМ

СОЦИАЛИСТИЧЕСКАЯ РЕСПУБЛИКА ВЬЕТНАМ

VN

ГАБОН

ГАБОНСКАЯ РЕСПУБЛИКА

GA

ГАИТИ

РЕСПУБЛИКА ГАИТИ

НT

ГАЙАНА

РЕСПУБЛИКА ГАЙАНА

GY

ГАМБИЯ

РЕСПУБЛИКА ГАМБИЯ

GM

ГАНА

РЕСПУБЛИКА ГАНА

GН

ГВАДЕЛУПА

ГВАДЕЛУПА (ФР.)

GP

ГВАТЕМАЛА

РЕСПУБЛИКА ГВАТЕМАЛА

GT

ГВИНЕЯ

ГВИНЕЙСКАЯ РЕСПУБЛИКА

GN

ГВИНЕЯ-БИСАУ

РЕСПУБЛИКА ГВИНЕЯ-БИСАУ

GW

ГЕРМАНИЯ

ФЕДЕРАТИВНАЯ РЕСПУБЛИКА ГЕРМАНИЯ

DE

ГЕРНСИ

ГЕРНСИ

GG

ГИБРАЛТАР

ГИБРАЛТАР (БРИТ.)

GI

ГОНДУРАС

РЕСПУБЛИКА ГОНДУРАС

НN

ГОНКОНГ

СПЕЦИАЛЬНЫЙ АДМИНИСТРАТИВНЫЙ РЕГИОН КИТАЯ ГОНКОНГ

НK

ГРЕНАДА

ГРЕНАДА

GD

ГРЕНЛАНДИЯ

ГРЕНЛАНДИЯ

GL

ГРЕЦИЯ

ГРЕЧЕСКАЯ РЕСПУБЛИКА

GR

ГРУЗИЯ

РЕСПУБЛИКА ГРУЗИЯ

GE

ГУАМ

ГУАМ (США)

GU

ДАНИЯ

КОРОЛЕВСТВО ДАНИЯ

DK

ДЖЕРСИ

ДЖЕРСИ

JE

ДЖИБУТИ

РЕСПУБЛИКА ДЖИБУТИ

DJ

ДОМИНИКА

СОДРУЖЕСТВО ДОМИНИКИ

DM

ДОМИНИКАНСКАЯ РЕСПУБЛИКА

ДОМИНИКАНСКАЯ РЕСПУБЛИКА

DO

ЕГИПЕТ

АРАБСКАЯ РЕСПУБЛИКА ЕГИПЕТ (АРЕ)

EG

ЗАМБИЯ

РЕСПУБЛИКА ЗАМБИЯ

ZM

ЗАПАДНАЯ САХАРА

ЗАПАДНАЯ САХАРА

EН

ЗИМБАБВЕ

РЕСПУБЛИКА ЗИМБАБВЕ

ZW

ИЗРАИЛЬ

ГОСУДАРСТВО ИЗРАИЛЬ

IL

ИНДИЯ

РЕСПУБЛИКА ИНДИЯ

IN

ИНДОНЕЗИЯ

РЕСПУБЛИКА ИНДОНЕЗИЯ

ID

ИОРДАНИЯ

ИОРДАНСКОЕ ХАШИМИТСКОЕ КОРОЛЕВСТВО

JO

ИРАК

РЕСПУБЛИКА ИРАК

IQ

ИРАН

ИСЛАМСКАЯ РЕСПУБЛИКА ИРАН

IR

ИРЛАНДИЯ

ИРЛАНДИЯ

IE

ИСЛАНДИЯ

РЕСПУБЛИКА ИСЛАНДИЯ

IS

ИСПАНИЯ

КОРОЛЕВСТВО ИСПАНИЯ

ES

ИТАЛИЯ

ИТАЛЬЯНСКАЯ РЕСПУБЛИКА

IT

ЙЕМЕН

ЙЕМЕНСКАЯ РЕСПУБЛИКА

YE

КАБО-ВЕРДЕ

РЕСПУБЛИКА КАБО-ВЕРДЕ

CV

КАЗАХСТАН

РЕСПУБЛИКА КАЗАХСТАН

KZ

КАЙМАН

ОСТРОВА КАЙМАН

KY

КАМБОДЖА

КОРОЛЕВСТВО КАМБОДЖА

KН

КАМЕРУН

РЕСПУБЛИКА КАМЕРУН

CM

КАНАДА

КАНАДА

CA

КАТАР

ГОСУДАРСТВО КАТАР

QA

КЕНИЯ

РЕСПУБЛИКА КЕНИЯ

KE

КИПР

РЕСПУБЛИКА КИПР

CY

КИРИБАТИ

РЕСПУБЛИКА КИРИБАТИ

KI

КИТАЙ

КИТАЙСКАЯ НАРОДНАЯ РЕСПУБЛИКА (КНР)

CN

КОКОСОВЫЕ ОСТРОВА

КОКОСОВЫЕ (КИЛИНГ) ОСТРОВА

CC

КОЛУМБИЯ

РЕСПУБЛИКА КОЛУМБИЯ

CO

КОМОРСКИЕ ОСТРОВА

СОЮЗ КОМОРЫ

KM

КОНГО

РЕСПУБЛИКА КОНГО

CG

КОНГО (ДРК)

ДЕМОКРАТИЧЕСКАЯ РЕСПУБЛИКА КОНГО

CD

КОРЕЯ

РЕСПУБЛИКА КОРЕЯ

KR

КОРЕЯ (КНДР)

КОРЕЙСКАЯ НАРОДНО-ДЕМОКРАТИЧЕСКАЯ РЕСПУБЛИКА

KP

КОСТА-РИКА

РЕСПУБЛИКА КОСТА-РИКА

CR

КОТ Д’ИВУАР

РЕСПУБЛИКА КОТ Д’ИВУАР

CI

КУБА

РЕСПУБЛИКА КУБА

CU

КУВЕЙТ

ГОСУДАРСТВО КУВЕЙТ

KW

КЫРГЫЗСТАН

РЕСПУБЛИКА КЫРГЫЗСТАН

KG

КЮРАСАО

КЮРАСАО

CW

ЛАОС

ЛАОССКАЯ НАРОДНО-ДЕМОКРАТИЧЕСКАЯ РЕСПУБЛИКА

LA

ЛАТВИЯ

ЛАТВИЙСКАЯ РЕСПУБЛИКА

LV

ЛЕСОТО

КОРОЛЕВСТВО ЛЕСОТО

LS

ЛИБЕРИЯ

РЕСПУБЛИКА ЛИБЕРИЯ

LR

ЛИВАН

ЛИВАНСКАЯ РЕСПУБЛИКА

LB

ЛИВИЯ

ЛИВИЯ

LY

ЛИТВА

ЛИТОВСКАЯ РЕСПУБЛИКА

LT

ЛИХТЕНШТЕЙН

КНЯЖЕСТВО ЛИХТЕНШТЕЙН

LI

ЛЮКСЕМБУРГ

ВЕЛИКОЕ ГЕРЦОГСТВО ЛЮКСЕМБУРГ

LU

МАВРИКИЙ

РЕСПУБЛИКА МАВРИКИЙ

MU

МАВРИТАНИЯ

ИСЛАМСКАЯ РЕСПУБЛИКА МАВРИТАНИЯ

MR

МАДАГАСКАР

ДЕМОКРАТИЧЕСКАЯ РЕСПУБЛИКА МАДАГАСКАР

MG

МАЙОТТА

МАЙОТТА

YT

МАКАО

СПЕЦИАЛЬНЫЙ АДМИНИСТРАТИВНЫЙ РЕГИОН КИТАЯ МАКАО

MO

МАКЕДОНИЯ

РЕСПУБЛИКА МАКЕДОНИЯ

MK

МАЛАВИ

РЕСПУБЛИКА МАЛАВИ

MW

МАЛАЙЗИЯ

МАЛАЙЗИЯ

MY

МАЛИ

РЕСПУБЛИКА МАЛИ

ML

МАЛЫЕ ТИХООКЕАНСКИЕ ОСТРОВА (США)

МАЛЫЕ ТИХООКЕАНСКИЕ ОТДАЛЕННЫЕ ОСТРОВА (США)

UM

МАЛЬДИВЫ

МАЛЬДИВСКАЯ РЕСПУБЛИКА

MV

МАЛЬТА

РЕСПУБЛИКА МАЛЬТА

MT

МАРИАНСКИЕ ОСТРОВА

СОДРУЖЕСТВО СЕВЕРНЫХ МАРИАНСКИХ ОСТРОВОВ

MP

МАРОККО

КОРОЛЕВСТВО МАРОККО

MA

МАРТИНИКА

МАРТИНИКА (ФР.)

MQ

МАРШАЛЛОВЫ ОСТРОВА

РЕСПУБЛИКА МАРШАЛЛОВЫ ОСТРОВА

MН

МЕКСИКА

МЕКСИКАНСКИЕ СОЕДИНЕННЫЕ ШТАТЫ

MX

МИКРОНЕЗИЯ

ФЕДЕРАТИВНЫЕ ШТАТЫ МИКРОНЕЗИИ

FM

МОЗАМБИК

РЕСПУБЛИКА МОЗАМБИК

MZ

МОЛДОВА

РЕСПУБЛИКА МОЛДОВА

MD

МОНАКО

КНЯЖЕСТВО МОНАКО

MC

МОНГОЛИЯ

МОНГОЛИЯ

MN

МОНТСЕРРАТ

МОНТСЕРРАТ (БРИТ.)

MS

МЬЯНМА

СОЮЗ МЬЯНМА

MM

НАМИБИЯ

РЕСПУБЛИКА НАМИБИЯ

NA

НАУРУ

РЕСПУБЛИКА НАУРУ

NR

НЕПАЛ

КОРОЛЕВСТВО НЕПАЛ

NP

НИГЕР

РЕСПУБЛИКА НИГЕР

NE

НИГЕРИЯ

ФЕДЕРАТИВНАЯ РЕСПУБЛИКА НИГЕРИЯ

NG

НИДЕРЛАНДСКИЕ АНТИЛЫ

НИДЕРЛАНДСКИЕ АНТИЛЫ

AN

НИДЕРЛАНДЫ

КОРОЛЕВСТВО НИДЕРЛАНДЫ

NL

НИКАРАГУА

РЕСПУБЛИКА НИКАРАГУА

NI

НИУЭ (Н.ЗЕЛ.)

РЕСПУБЛИКА НИУЭ

NU

НОВАЯ ЗЕЛАНДИЯ

НОВАЯ ЗЕЛАНДИЯ

NZ

НОВАЯ КАЛЕДОНИЯ (ФР.)

НОВАЯ КАЛЕДОНИЯ (ФР)

NC

НОРВЕГИЯ

КОРОЛЕВСТВО НОРВЕГИЯ

NO

НОРМАНДСКИЕ ОСТРОВА

НОРМАНДСКИЕ ОСТРОВА, КРОМЕ ОСТРОВОВ ГЕРНСИ И ДЖЕРСИ

-

НОРФОЛК

ОСТРОВ НОРФОЛК

NF

ОБЪЕД. АРАБСКИЕ ЭМИРАТЫ

ОБЪЕДИНЕННЫЕ АРАБСКИЕ ЭМИРАТЫ

AE

ОСТРОВ МЭН

ОСТРОВ МЭН

IM

ОСТРОВ РОЖДЕСТВА

ОСТРОВ РОЖДЕСТВА (АВСТРАЛ.)

CX

ОСТРОВА КУКА

ОСТРОВА КУКА (Н. ЗЕЛ.)

СК

ОМАН

СУЛТАНАТ ОМАН

OM

ПАКИСТАН

ИСЛАМСКАЯ РЕСПУБЛИКА ПАКИСТАН

PK

ПАЛАУ

РЕСПУБЛИКА ПАЛАУ

PW

ПАЛЕСТИНА

ПАЛЕСТИНА, ГОСУДАРСТВО

PS

ПАНАМА

РЕСПУБЛИКА ПАНАМА

PA

ПАПУА — НОВАЯ ГВИНЕЯ

ПАПУА — НОВАЯ ГВИНЕЯ

PG

ПАРАГВАЙ

РЕСПУБЛИКА ПАРАГВАЙ

PY

ПЕРУ

РЕСПУБЛИКА ПЕРУ

PE

ПИТКЭРН

ПИТКЭРН (БРИТ.)

PN

ПОЛЬША

РЕСПУБЛИКА ПОЛЬША

PL

ПОРТУГАЛИЯ

ПОРТУГАЛЬСКАЯ РЕСПУБЛИКА

PT

ПУЭРТО-РИКО (США)

ПУЭРТО-РИКО

PR

РЕЮНЬОН

РЕЮНЬОН

RE

РОССИЯ

РОССИЙСКАЯ ФЕДЕРАЦИЯ

RU

РУАНДА

РУАНДИЙСКАЯ РЕСПУБЛИКА

RW

РУМЫНИЯ

РУМЫНИЯ

RO

САЛЬВАДОР

РЕСПУБЛИКА САЛЬВАДОР

SV

САМОА

НЕЗАВИСИМОЕ ГОСУДАРСТВО САМОА

WS

САН-ТОМЕ И ПРИНСИПИ

ДЕМОКРАТИЧЕСКАЯ РЕСПУБЛИКА САН-ТОМЕ И ПРИНСИПИ

ST

САН-МАРИНО

РЕСПУБЛИКА САН-МАРИНО

SM

САУДОВСКАЯ АРАВИЯ

КОРОЛЕВСТВО САУДОВСКАЯ АРАВИЯ

SA

СВАЗИЛЕНД

КОРОЛЕВСТВО СВАЗИЛЕНД

SZ

СВЯТАЯ ЕЛЕНА

ОСТРОВ СВЯТОЙ ЕЛЕНЫ (БРИТ.)

SН

СЕЙШЕЛЫ

РЕСПУБЛИКА СЕЙШЕЛЫ

SC

СЕН-БАРТЕЛЕМИ

СЕН-БАРТЕЛЕМИ

BL

СЕН-МАРТЕН (НИД.)

СЕН-МАРТЕН (НИД.)

MF

СЕН-МАРТЕН (ФР.)

СЕН-МАРТЕН (ФР.)

MF

СЕН-ПЬЕР И МИКЕЛОН

СЕН-ПЬЕР И МИКЕЛОН (ФР.)

PM

СЕНЕГАЛ

РЕСПУБЛИКА СЕНЕГАЛ

SN

СЕНТ-ВИНСЕНТ И ГРЕНАДИНЫ

СЕНТ-ВИНСЕНТ И ГРЕНАДИНЫ

VC

СЕНТ-КИТС И НЕВИС

ФЕДЕРАЦИЯ СЕНТ-КИТС (СЕНТ-КРИСТОФЕР) И НЕВИС

KN

СЕНТ-ЛЮСИЯ

СЕНТ-ЛЮСИЯ

LC

СЕРБИЯ

РЕСПУБЛИКА СЕРБИЯ

RS

СИНГАПУР

РЕСПУБЛИКА СИНГАПУР

SG

СИРИЯ

СИРИЙСКАЯ АРАБСКАЯ РЕСПУБЛИКА

SY

СЛОВАКИЯ

СЛОВАЦКАЯ РЕСПУБЛИКА

SK

СЛОВЕНИЯ

РЕСПУБЛИКА СЛОВЕНИЯ

SI

СОЕДИНЕННОЕ КОРОЛЕВСТВО

СОЕДИНЕННОЕ КОРОЛЕВСТВО ВЕЛИКОБРИТАНИИ И СЕВЕРНОЙ ИРЛАНДИИ

GB

СОЛОМОНОВЫ ОСТРОВА

СОЛОМОНОВЫ ОСТРОВА

SB

СОМАЛИ

СОМАЛИЙСКАЯ РЕСПУБЛИКА

SO

СУДАН

РЕСПУБЛИКА СУДАН

SD

СУРИНАМ

РЕСПУБЛИКА СУРИНАМ

SR

США

СОЕДИНЕННЫЕ ШТАТЫ АМЕРИКИ

US

СЬЕРРА-ЛЕОНЕ

РЕСПУБЛИКА СЬЕРРА-ЛЕОНЕ

SL

ТАДЖИКИСТАН

РЕСПУБЛИКА ТАДЖИКИСТАН

TJ

ТАИЛАНД

КОРОЛЕВСТВО ТАИЛАНД

TН

ТАЙВАНЬ

ТАЙВАНЬ (ПРОВИНЦИЯ КИТАЯ)

TW

ТАНЗАНИЯ

ОБЪЕДИНЕННАЯ РЕСПУБЛИКА ТАНЗАНИЯ (ОРТ)

TZ

ТЕРКС И КАЙКОС

ОСТРОВА ТЕРКС И КАЙКОС (БРИТ.)

TC

ТИМОР-ЛЕСТЕ

ДЕМОКРАТИЧЕСКАЯ РЕСПУБЛИКА ТИМОР-ЛЕСТЕ

TP

ТОГО

ТОГОЛЕЗСКАЯ РЕСПУБЛИКА

TG

ТОКЕЛАУ

ТОКЕЛАУ (ЮНИОН) (Н. ЗЕЛ.)

TK

ТОНГА

КОРОЛЕВСТВО ТОНГА

TO

ТРИНИДАД И ТОБАГО

РЕСПУБЛИКА ТРИНИДАД И ТОБАГО

TT

ТУВАЛУ

ТУВАЛУ

TV

ТУНИС

ТУНИССКАЯ РЕСПУБЛИКА

TN

ТУРКМЕНИЯ

ТУРКМЕНИСТАН

TM

ТУРЦИЯ

ТУРЕЦКАЯ РЕСПУБЛИКА

TR

УГАНДА

РЕСПУБЛИКА УГАНДА

UG

УЗБЕКИСТАН

РЕСПУБЛИКА УЗБЕКИСТАН

UZ

УКРАИНА

УКРАИНА

UA

УОЛЛИС И ФУТУНА

ОСТРОВА УОЛЛИС И ФУТУНА

WF

УРУГВАЙ

ВОСТОЧНАЯ РЕСПУБЛИКАУРУГВАЙ

UY

ФАРЕРСКИЕ ОСТРОВА

ФАРЕРСКИЕ ОСТРОВА (В СОСТАВЕ ДАНИИ)

FO

ФИДЖИ

РЕСПУБЛИКА ОСТРОВОВ ФИДЖИ

FJ

ФИЛИППИНЫ

РЕСПУБЛИКА ФИЛИППИНЫ

PН

ФИНЛЯНДИЯ

ФИНЛЯНДСКАЯ РЕСПУБЛИКА

FI

ФОЛКЛЕНДСКИЕ ОСТРОВА

ФОЛКЛЕНДСКИЕ ОСТРОВА (МАЛЬВИНСКИЕ)

FK

ФР. ЮЖНЫЕ ТЕРРИТОРИИ

ФРАНЦУЗСКИЕ ЮЖНЫЕ ТЕРРИТОРИИ (ФР.)

TF

ФРАНЦИЯ

ФРАНЦУЗСКАЯ РЕСПУБЛИКА

FR

ФРАНЦУЗСКАЯ ГВИАНА (ФР.)

ФРАНЦУЗСКАЯ ГВИАНА (ФР.)

GF

ФРАНЦУЗСКАЯ ПОЛИНЕЗИЯ

ФРАНЦУЗСКАЯ ПОЛИНЕЗИЯ (ФР.)

PF

ХЕРД И МАКДОНАЛЬД

ОСТРОВ ХЕРД И ОСТРОВА МАКДОНАЛЬД

НM

ХОРВАТИЯ

РЕСПУБЛИКА ХОРВАТИЯ

НR

ЦЕНТР. — АФР. РЕСПУБЛИКА

ЦЕНТРАЛЬНО-АФРИКАНСКАЯ РЕСПУБЛИКА (ЦАР)

CF

ЧАД

РЕСПУБЛИКА ЧАД

TD

ЧЕРНОГОРИЯ

РЕСПУБЛИКА ЧЕРНОГОРИЯ

ME

ЧЕХИЯ

ЧЕШСКАЯ РЕСПУБЛИКА

CZ

ЧИЛИ

РЕСПУБЛИКА ЧИЛИ

CL

ШВЕЙЦАРИЯ

ШВЕЙЦАРСКАЯ КОНФЕДЕРАЦИЯ

CН

ШВЕЦИЯ

КОРОЛЕВСТВО ШВЕЦИЯ

SE

ШПИЦБЕРГЕН И ЯН-МАЙЕН

ШПИЦБЕРГЕН И ЯН-МАЙЕН (НОРВ.)

SJ

ШРИ-ЛАНКА

ДЕМОКРАТИЧЕСКАЯ СОЦИАЛИСТИЧЕСКАЯ РЕСПУБЛИКА ШРИ-ЛАНКА

LK

ЭКВАДОР

РЕСПУБЛИКА ЭКВАДОР

EC

ЭКВАТОРИАЛЬНАЯ ГВИНЕЯ

РЕСПУБЛИКА ЭКВАТОРИАЛЬНАЯ ГВИНЕЯ

GQ

ЭРИТРЕЯ

ЭРИТРЕЯ

ER

ЭСТОНИЯ

ЭСТОНСКАЯ РЕСПУБЛИКА

EE

ЭФИОПИЯ

ФЕДЕРАТИВНАЯ ДЕМОКРАТИЧЕСКАЯ РЕСПУБЛИКА ЭФИОПИЯ

ET

ЮЖНАЯ АФРИКА

ЮЖНО-АФРИКАНСКАЯ РЕСПУБЛИКА

ZA

ЮЖНЫЙ СУДАН

ЮЖНЫЙ СУДАН

SS

ЮЖНАЯ ДЖОРДЖИЯ И ЮЖНЫЕ САНДВИЧЕВЫ ОСТРОВА

ЮЖНАЯ ДЖОРДЖИЯ И ЮЖНЫЕ САНДВИЧЕВЫ ОСТРОВА

GS

ЯМАЙКА

ЯМАЙКА

JM

ЯПОНИЯ

ЯПОНИЯ

JP

Вернуться к разделу "Оглавление".

9. Примеры документов

В архиве хранятся:

  1. спецификация,

  2. пример xml-документа,

  3. xsd-схема.

Скачать архив

Вернуться к разделу "Оглавление".

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