Описание True API (Версия 72.0) - часть 4

 

  Главная      Книги - Разные     Описание True API (Версия 72.0)

 

поиск по сайту            правообладателям  

 

   

 

   

 

содержание      ..     2      3      4      5     ..

 

 

 

Описание True API (Версия 72.0) - часть 4

 

 

<Файл ИмяФайла="MTTPS-60_2018-01-31_7715253980_321239e4-c696-4ddd-a6de-6306a177cd51"
ВерсияПрограммы="string">
<Уведомление>
<СведенияОбАгрегации Дата="31.12.2019" Время="21:44:14">
<ИНН>
<!--You have a CHOICE of the next 2 items at this level-->
<!--
<ИННФЛТип>771525398012</ИННФЛТип>-->
<ИННЮЛТип>000000000</ИННЮЛТип>
</ИНН>
<!--1 or more repetitions:-->
<!--
Пачки в блок-->
<ИнформацияОбАгрегировании ТипУпаковки="Потребительская"
КодГрупповойУпаковки="0104606203099597210jagTz!">
<СписокКодовИдентификации>00606203099580F7Vulb6 00606203099580vQ.JVaQ
04606203099580F&lt;CG0a=</СписокКодовИдентификации>
</ИнформацияОбАгрегировании>
<!--
Блок в короб-->
<ИнформацияОбАгрегировании ТипУпаковки="Транспортная"
КодГрупповойУпаковки="0104606203099603222411200320107E22082040">
<СписокКодовИдентификации>0104606203099597210jagTz!
0104606203099597210jagZz!</СписокКодовИдентификации>
</ИнформацияОбАгрегировании>
<!--
Короб в паллету-->
<ИнформацияОбАгрегировании ТипУпаковки="Транспортная"
КодГрупповойУпаковки="00147600887000000010">
<СписокКодовИдентификации>0104606203099603222411200320107E22082040</СписокКодовИдентиф
икации>
</ИнформацияОбАгрегировании>
</СведенияОбАгрегации>
</Уведомление>
</Файл>
Параметры документа в формате * .xml:
Параметр
Тип
Тип
Обяз.
Описание
значения
Уведомление
element
+
Документ уведомление,
предоставленный в информационную
систему
*СведенияОбАгре
element
+
Информация об агрегировании
гации
потребительских упаковок в
групповую упаковку может
передаваться одновременно с
информацией об агрегировании
упаковок в транспортную упаковку
до передачи агрегированной
упаковки следующему участнику
оборота табачной продукции
300
Параметр
Тип
Тип
Обяз.
Описание
значения
**Дата
attribute
string
+
Задаётся в формате ДД.ММ.ГГГГ
(01.01.1900 - 31.12.2099)
**Время
attribute
string
+
Задаётся в формате чч:мм:сс
**ИНН
element
+
ИНН
***ИННЮЛТип
element
string
-
ИНН организации
***ИННФЛТип
element
string
-
ИНН физического лица
**ИнформацияОб
element
+
Описание упаковки маркируемой
Агрегировании
продукции в групповую упаковку,
или транспортную упаковку, или в
АТК. Коды указываются списком с
пробелом в качестве разделителя.
Формирование АТК доступно для
товарных групп "Альтернативная
табачная продукция", "Табачная
продукция"
***ТипУпаковки
attribute
string
+
Тип упаковки: транспортная
(Короб/Палетта)/потребительская (по
умолчанию)/АТК. Формирование
АТК доступно для товарных групп
"Альтернативная табачная
продукция", "Табачная продукция"
***КодГрупповой
attribute
string
+
Код групповой упаковки
Упаковки
***СписокКодов
element
string
+
Список КИ. Разделитель пробел
Идентификации
Пример документа в формате * .json:
301
{
"participantId":"7777777777",
"signInn":"7777777777",
"productionLineId":"123456",
"productionDate":1625127082533,
"productionOrderId":"123456789",
"aggregationUnits":[
{
"aggregatedItemsCount":2,
"aggregationType":"AGGREGATION",
"aggregationUnitCapacity":10,
"sntins":[
"00000046210654vS<Vyzh"
],
"unitSerialNumber":"(01)00000046210654(21)WB4KBn-"
}
]
}
Параметры документа в формате * .json:
Параметр
Тип
Обяз.
Описан
Комментарий
ие
participantId
string
+
ID
ID участника оборота товаров указан
участни
в профиле ЛК ГИС МТ
ка
оборота
товаров
dateDoc
string
+
Дата и
время
формир
ования
докумен
та
productionDate
string
-
Дата
произво
дства
productionLineId
string
+
ID
произво
дственн
ой
линии
aggregationUnits
array[string]
+
Список
формир
уемых
агрегато
в
302
Параметр
Тип
Обяз.
Описан
Комментарий
ие
*aggregationType
string
+
Код
Значение может быть только
типа
"AGGREGATION"
агрегаци
и
*unitSerialNumber
string
+
Код
КИ может содержать от 18 до 74
идентиф
символов включительно: цифры,
икации
буквы латинского алфавита,
агрегата
спецсимволы (A-Z a-z 0-9 % & ' " ( ) *
+ , - _ . / : ; < = > ? !)
*aggregatedItemsC
integer
+
Агрегир
ount
уемое
количес
тво КИ
*aggregationUnitC
integer
+
Ёмкость
apacity
агрегата
(кол-во
вложенн
ых КИ)
*sntins
array[string]
+
Список
Статусы КИ, входящих в состав
КИ,
агрегата, должны быть идентичны
входящ
их в
состав
агрегат
Пример ответа:
1. Код 200. В случае успеха:
{
"id":"string"
}
2. В случае ошибок.
2.1. Код 400: "Документ {0} не прошёл валидацию по XSD схеме".
{
"error_message":"Документ {0} не прошел валидацию по XSD схеме"
}
2.2. Код 400: "Должно быть заполнено одно поле xmlFile или jsonFile".
303
{
"error_message":"Должно быть заполнено одно поле xmlFile или jsonFile"
}
2.3. Код 422: "Ошибка проверки подписи".
{
"error_message":"Ошибка проверки подписи"
}
Параметры ответа:
Параметр
Тип
Обяз.
Описание
Комментарий
id
string
+
ID документа,
прошедшего
проверку
error_messag
string
-
Текст сообщения
Параметр возвращается при наличии
e
об ошибке при
ошибки
обработке запроса
4.2.14. Выбытие (ТГ "Табачная продукция", "Альтернативная табачная
продукция" и "Никотиносодержащая продукция")
Приём сведений в документе выбытия доступен для ТГ "Табачная продукция", "Альтернативная
табачная продукция" и "Никотиносодержащая продукция".
Тип документа:
Тип
Описание
WRITE_OFF
Документ списания. XML
WRITE_OFF
Документ списания. JSON
Тип приватности: приватный
URL: /documents/dropped-out/create
Метод: POST
Пример запроса для документа в формате * .xml:
curl -X POST "<url стенда>/documents/dropped-out/create"
-H "X-Signature: <string>"
-H "Content-Type: multipart/form-data"
-H "accept: application/json"
-H"Authorization: Bearer <Токен>"
--form "xmlFile=@/C:/Users/Desktop/XXX.xml"
304
Пример запроса для документа в формате * .json:
curl -X POST "<url стенда>/documents/dropped-out/create"
-H "X-Signature: <string>"
-H "Content-Type: multipart/form-data"
-H "accept: application/json"
-H "Authorization: Bearer <Токен>"
--form "jsonFile=@/C:/Users/Desktop/XXX.json"
Параметры запроса:
Параметр
Тип
Обяз.
Описание
Комментарий
X-Signature
string
+
Закодированная
откреплённая
подпись в
формате base64
xmlFile
file
-
Параметр тела
Прикреплённый документ подачи
запроса в формате
сведений о списании в формате * .xml
xml
jsonFile
file
-
Параметр тела
Прикреплённый документ подачи
запроса в формате
сведений о списании в формате *. json
json
Примечание: в запросе указывается только один из параметров: "xmlFile" или "jsonFile".
Пример документа в формате * .xml:
305
<Файл ИмяФайла="MTTPS-90_2018-01-31_7715253980_321239e4-c696-4ddd-a6de-6306a177cd51"
ВерсияПрограммы="string">
<Уведомление>
<!--You have a CHOICE of the next 2 items at this level-->
<СведенияОВыбытии ПричинаВыбытия="5. Тестирование продукта"
СтоимостьВыводимойПродукции="1000.0000000000000">
<ИНН>
<ИННЮЛТип>7715253980</ИННЮЛТип>
</ИНН>
<ПервичныйДокумент Наименование="Поставка рекламы" Номер="234234"
Дата="31.12.2019" Время="10:36:28"/>
<АдресПлощадки>
<!--You have a CHOICE of the next 3 items at this level-->
<АдрРФ Индекс="string" КодРегион="st" Район="string" Город="string"
НаселПункт="string" Улица="string" Дом="string" Корпус="string" Кварт="string"/>
<!--
<АдрИнф КодСтр="str" АдрТекст="string"/>-->
<!--
<КодФИАС>8e632d08-2d65-42e2-b1de-38b435243cea</КодФИАС>-->
</АдресПлощадки>
<КодыИдентификации СписыватьВложения="true">
<Список>04606203099580vQ.JVaQ 04606203099580vQ.JVaQ
04606203099580vQ.JVaQ</Список>
</КодыИдентификации>
</СведенияОВыбытии>
</Уведомление>
</Файл>
Параметры документа в формате XML
Параметр
Тип значения
Тип
Обяз.
Описание
Уведомление
element
+
Документ уведомление,
предоставленный в информационную
систему
*СведенияОВыбы
element
+
При выводе табачной продукции из
тии
оборота по основаниям, не
являющимся продажей в розницу,
участник оборота табачной
продукции, осуществляющий вывод
из оборота этой продукции,
представляет в информационную
систему мониторинга уведомление о
выводе табачной продукции из
оборота
306
Параметр
Тип значения
Тип
Обяз.
Описание
**ПричинаВыбыт
attribute
string
+
Причина вывода табачной продукции
ия
из оборота:
"0. Брак";
"1. Истёк срок годности";
"2. Лабораторные образцы";
"3. Отзыв с рынка";
"4. Рекламации";
"5. Тестирование продукта";
"6. Демонстрационные образцы";
"7. Другие причины";
"9. Недостача";
"16. Уничтожение";
"17. Конфискация";
"18. Ликвидация предприятия"
**СтоимостьВыв
attribute
decimal
-
Стоимость в рублях. Число
одимойПродукци
десятичное, содержащее до 17
и
разрядов, два после запятой.
Содержит только цифры. Например
10000,50 десять тысяч рублей
пятьдесят копеек
*ИНН
element
+
ИНН
**ИННЮЛТип
element
string
+
ИНН организации
*ПервичныйДоку
element
+
Информация о первичном документе
мент
**Наименование
attribute
string
+
Наименование первичного документа
о выбытии табачной продукции из
оборота
**Номер
attribute
string
+
Номер первичного документа о
выбытии табачной продукции из
оборота
**Дата
attribute
string
+
Дата первичного документа о
выбытии табачной продукции из
оборота. Задаётся в формате
ДД.ММ.ГГГГ (01.01.1900 -
31.12.2099)
**Время
attribute
string
+
Время первичного документа о
выбытии табачной продукции из
оборота. Задаётся в формате чч:мм:сс
*АдресПлощадки
element
+
Сведения об адресе
**АдрРФ
element
-
Адрес в Российской Федерации
***Индекс
attribute
string
-
Индекс. 6 знаков
***КодРегион
attribute
string
-
Код из Справочника субъекта
Российской Федерации. 2 знака
307
Параметр
Тип значения
Тип
Обяз.
Описание
***Район
attribute
string
-
Район
***Город
attribute
string
-
Город
***НаселПункт
attribute
string
-
Населённый пункт
***Улица
attribute
string
-
Улица
***Дом
attribute
string
-
Дом
***Корпус
attribute
string
-
Корпус
***Кварт
attribute
string
-
Квартира
**АдрИнф
element
-
Адрес за пределами территории
Российской Федерации
***КодСтр
attribute
string
+
Код из Общероссийского
классификатора стран мира. 3 знака
***АдрТекст
attribute
string
+
Адрес
**КодФИАС
element
string
-
Уникальный номер адреса объекта
адресации в государственном
адресном реестре. 36 знаков
*КодыИдентифик
element
+
Коды идентификации табачной
ации
продукции, выводимой из оборота. В
случае кодов упаковок при
необходимости списывания без
вложений, необходимо создать
дополнительный список с атрибутом
СписыватьВложения=false
**СписыватьВло
attribute
boolean
-
Атрибут указывается для кода
жения
идентификации
**Список
element
string
-
Список КИ
Пример документа в формате JSON:
{
"address": "432008 73 Засвияжский Ульяновск Ульяновск Доватора 1 1 1",
"participantId": "780",
"sourceDocNum": "234234",
"sourceDocDate": "yyyy-MM-dd",
"dropoutReason": "string",
"withChild": true,
"sntins": [
"00000046229205cSlT5FdosB2a1636S1hBcjZI"
]
}
Параметры документа в формате JSON
308
Параметр
Тип
Обяз.
Описан
Комментарий
ие
address
string
+
Адрес
Длина значения: (0-256 символов)
participantId
string
+
ИНН
ИНН участника оборота товаров
участни
указан в профиле ЛК ГИС МТ
ка
оборота
товаров
sourceDocNum
string
+
Номер
первичн
ого
докумен
та
sourceDocDate
string
+
Дата
Формат: yyyy-MM-dd
первичн
ого
докумен
та
dropoutReason
string
+
Причин
Возможные значения:
а
списани
DEFECT - повреждение/брак;
я
EXPIRY - истечение срока;
QA_SAMPLES - лабораторные
образцы;
PRODUCT_RECALL - отзыв с рынка;
COMPLAINTS - рекламации;
PRODUCT_TESTING - тестовые
образцы;
DEMO_SAMPLES -
демонстрационные образцы;
DAMAGE_LOSS - утрата;
DESTRUCTION - уничтожение;
LIQUIDATION - ликвидация
предприятия;
CONFISCATION - конфискация;
OTHER - иная причина
withChild
boolean
+
Списани
е с
дочерни
ми
докумен
тами
sntins
array[string]
+
Списыв
аемые
КИ
Пример ответа:
309
1.Код 200 в случае успеха:
{
"id": "string"
}
2.В случае ошибок:
2.1. Код 400: "Документ {0} не прошел валидацию по XSD схеме"
{
"error_message": "Документ {0} не прошел валидацию по XSD схеме"
}
2.2. Код 400: "Должно быть заполнено одно поле xmlFile или jsonFile"
{
"error_message": "Должно быть заполнено одно поле xmlFile или jsonFile"
}
2.3. Код 422: "Ошибка проверки подписи"
{
"error_message": "Ошибка проверки подписи"
}
2.4. Код 500: "Произошла внутренняя ошибка"
{
"error_message": "Произошла внутренняя ошибка"
}
Параметры ответа:
Параметр
Тип
Обяз.
Описание
Комментарий
id
string
+
ID документа,
прошедшего
проверку
error_messag
string
-
Текст сообщения
Параметр возвращается при наличии
e
об ошибке при
ошибки
обработке запроса
310
5. Методы получения сведений о КИ и
маркированных товарах
При необходимости выгрузки сведений больших объёмов необходимо использовать методы
сервиса выгрузок, описанные в разделе "Методы формирования выгрузок данных из ГИС МТ"
5.1. Получение данных о КИ
5.1.1. Метод получения краткой информации о списке КИ по заданному фильтру
Метод недоступен для товарных групп "Альтернативная табачная продукция",
"Никотиносодержащая продукция", "Табачная продукция".
URL: /cises/listV2
Тип приватности: приватный
Метод: GET
Пример запроса:
curl -X GET '<url стенда v3>/cises/listV2"
-H "accept: application/json"
-H "Authorization: Bearer <ТОКЕН>"
Параметры запроса:
Параметр
Тип
Обяз.
Описание
Комментарий
cis
string
-
КИ ГИС МТ
cisStatus
string
-
Код статуса КИ
См. "Справочник "Статусы КИ""
gtin
string
-
Код товара
Если код товара менее 14
символов, то он дополняется
лидирующими нулями
sn
string
-
Серийный номер
кода
идентификации
tnVed10
string
-
10-ти значный код
ТН ВЭД
emissionDateFrom
string
-
Дата эмиссии от
Формат: yyyy-MM-
(date-
ddTHH:mm:ss.SSS’Z. Не
time)
допускается указание даты,
превышающей текущую
311
Параметр
Тип
Обяз.
Описание
Комментарий
emissionDateTo
string
-
Дата эмиссии до
Формат: yyyy-MM-
(date-
ddTHH:mm:ss.SSS’Z. При
time)
установке выборе дат
"emissionDateFrom" ("Дата
эмиссии от") и "emissionDateTo"
("Дата эмиссии до") больше
текущей, выводится пустой
список. Запрос обрабатывается
успешно при выборе будущего
значения даты "emissionDateTo"
("Дата эмиссии до")
emissionType
string
-
Код типа
Тип эмиссии:
производства
LOCAL - производство РФ;
FOREIGN - ввезён в РФ;
REMAINS - маркировка
остатков;
CROSSBORDER - ввезён из
стран ЕАЭС
См."Справочник "Типы эмиссии
КИ""
312
Параметр
Тип
Обяз.
Описание
Комментарий
withdrawReason
string
-
Причина вывода
Возможные значения:
из оборота
KM_SPOILED - испорчен;
KM_LOST - утерян;
KM_DESTROYED - уничтожен;
DESCRIPTION_ERRORS -
выявлены ошибки описания
товара;
RETAIL - розничная
реализация;
EEC_EXPORT - экспорт в
страны ЕАЭС;
BEYOND_EEC_EXPORT -
экспорт за пределы стран ЕАЭС;
RETURN - возврат физическому
лицу;
REMOTE_SALE - продажа по
образцам, дистанционный
способ продажи;
DAMAGE_LOSS - утрата или
повреждение;
DESTRUCTION - утилизация
или уничтожение;
CONFISCATION - конфискация;
LIQUIDATION - ликвидация
предприятия;
DONATION - безвозмездная
передача;
STATE_ENTERPRISE -
приобретение государственным
предприятием;
NO_RETAIL_USE -
использование для собственных
нужд покупателем;
ENTERPRISE_USE -
использование для собственных
нужд предприятия;
KM_SPOILED_OR_LOST -
испорчен либо утерян СИ с КИ;
KM_CANCELLATION -
аннулирование не
преобразованных в СИ с КИ по
истечении срока;
KM_CANCELLATION_BY_TER
M - аннулирование не
преобразованных в СИ с КИ по
истечении срока;
RETAIL_RETURN - возврат
товаров с повреждённым СИ/без
СИ при розничной реализации;
REMOTE_SALE_RETURN -
возврат товаров с
повреждённым СИ/без СИ при
313
Параметр
Тип
Обяз.
Описание
Комментарий
packs
string
-
Фильтрация по
Возможные значения:
единичным
ALL - товары и упаковки;
товарным
UNIT - только товары (UNIT,
упаковкам
BUNDLE, SET);
PACK - только упаковки
(LEVEL1, LEVEL2, LEVEL3,
LEVEL4, LEVEL5, ATK)
См. "Справочник "Типы
упаковки""
remarkHistory
string
-
Фильтрация по
Возможные значения:
истории
ALL (вся история) - выводятся
перемаркировки
предыдущие и новые КИ,
КИ
связанные с КИ, указанным в
параметре "cis" ("КИ ГИС МТ");
ENTERED (указанный) -
выводится только КИ,
указанный в параметре "cis"
("КИ ГИС МТ");
ENTERED_AND_LAST
(указанный и последний) -
выводится только КИ,
указанный в параметре "cis"
("КИ ГИС МТ"), и последний в
истории перемаркировки КИ
cisAggregationState
string
-
Состояние КИ
Возможные значения:
PACKED - в агрегате
(агрегирован);
NOT_PACKED - не в агрегате
(дезагрегирован);
ANY - любое состояние
pg
string
-
Товарная группа
Параметр обязательно указывать
для товарных групп:
milk - Молочная продукция;
water - Упакованная вода
order
string
-
Направление
Возможные значения:
сортировки
ASC - по возрастанию;
DESC - по убыванию
producerInn
string
-
ИНН Российского
производителя в
МОТП
314
Параметр
Тип
Обяз.
Описание
Комментарий
uit
string
-
Уникальный
"Точка отсчёта" (запись, с
идентификатор
которой начнётся выборка), по
товара (УИТ)
которому сортируются записи.
Использовать только совместно
с параметром
"orderedColumnValue"
("Значение столбца")
orderedColumnValue
string
-
Значение столбца
Значение столбца, "Точки
отсчёта" (запись, с которой
начинается выборка), по
которому сортируются записи.
Использовать только совместно
с параметром "uit"
("Уникальный идентификатор
товара (УИТ)")
orderColumn
string
-
Название столбца,
Допустимое значение - emd
по которому будет
(Дата эмиссии)
производиться
сортировка
limit
integer
-
Максимальное
Максимальное количество
количество
записей, которое вернётся в
записей
качестве ответа, не более 10000
записей (по умолчанию 10
записей)
pageDir
[string]
-
Выбор
Возможные значения:
направления
PREV - Предыдущий раздел;
NEXT - Следующий раздел
Пример ответа:
315
{
"results":[
{
"cis":"string",
"gtin":"string",
"tnVedEaesCode":0,
"tnVedEaesGroup":0,
"productName":"string",
"emissionDate":"2020-04-16T09:29:01.120Z",
"receiptDate":"2020-04-16T09:29:01.120Z",
"ownerInn":"string",
"ownerName":"string",
"status":"string",
"emissionType":"string",
"countChildren":0,
"cisChildren":[
"string"
],
"packType":"string",
"parent":"string",
"prevCis":[
"string"
],
"productGroup":"string",
"expireDate":"2020-01-23T16:17:48Z",
"agentName":"string"
}
],
"total":0
}
Параметры ответа:
Параметр
Тип
Обяз.
Описание
total
integer (int64)
+
Общее количество значений, подходящие
под параметры фильтрации
results
+
*cis
string
-
КИ товара
*countChildren
integer (int32)
-
Количество дочерних КИ
*cisChildren
[string]
-
Список дочерних КИ
*emissionDate
string (date-
-
Дата эмиссии. Возвращается в формате
time)
yyyy-MM-ddTHH:mm:ss.SSS’Z
*gtin
string
-
Код товара
*ownerInn
string
-
ИНН владельца товара
*ownerName
string
-
Наименование владельца товара
316
Параметр
Тип
Обяз.
Описание
*packType
string
-
Тип упаковки (см. "Справочник "Типы
упаковки"")
*parent
string
-
Код идентификации упаковки, в которую
агрегирован товар
*productName
string
-
Название продукта
*status
enum
-
Статус товара/КИ:
EMITTED - эмитирован. Выпущен;
APPLIED - эмитирован. Получен;
INTRODUCED - в обороте;
WRITTEN_OFF - КИ списан;
RETIRED - выбыл;
DISAGGREGATION - расформирован
(только для упаковок)
*emissionType
string
-
Тип эмиссии:
LOCAL - производство РФ;
FOREIGN - ввезён в РФ;
REMAINS - маркировка остатков;
CROSSBORDER - ввезён из стран ЕАЭС
См."Справочник "Типы эмиссии КИ""
*prevCises
[string]
-
Массив предыдущих КИ в случае
перемаркировки товара
*receiptDate
string (date-
-
Дата вывода из оборота. Возвращается в
time)
формате yyyy-MM-ddTHH:mm:ss.SSS’Z
*tnVedEaesCode
string
-
Код товарной номенклатуры (10 знаков)
*tnVedEaesGroup
string
-
Код товарной позиции ТН ВЭД ЕАЭС
товара
*productGroup
string
-
Товарная группа
*expireDate
string (date-
-
Дата истечения срока годности.
time)
Возвращается в формате yyyy-MM-
ddTHH:mm:ss.SSS’Z (обязательный для
товарной группы "Молочная продукция")
*agentName
string
-
Наименование текущего владельца товара
(обязательный для товарной группы
"Молочная продукция")
5.1.2. Метод получения подробной информации о списке КИ товаров по заданному
фильтру
Не используется ТГ "Табачная продукция" и "Альтернативная табачная продукция".
Метод возвращает список товаров с подробной информацией, которые доступны в данный
момент времени участнику оборота товаров (ИНН организации содержится в токене), согласно
заданному фильтру.
317
Тип приватности: приватный
URL: /products/listV2
Метод: GET
Пример запроса:
curl -X GET "<url
стенда>/products/listV2?cache=string&cis=string&cisAggregationState=string&cisPackageT
ype=string&cisStatus=string"
-H "accept: application/json"
-H "Authorization: Bearer <Токен>"
Параметры запроса:
Параметр
Тип
Обяз.
Описание
childrenPage
number
-
Номер страницы вложений в агрегат
первого слоя. Значение по умолчанию: 1.
Не используется товарной группой
"Табачная продукция"
childrenLimit
number
-
Размер страницы вложений в агрегат
первого слоя. Значение по умолчанию: 50.
Не используется товарной группой
"Табачная продукция"
pg
array
-
Товарная группа:
параметр обязательно указывать для
товарных групп:
milk - Молочная продукция;
water - Упакованная вода
cache
boolean
-
Флаг использование кэша. При
включенном флаге участни оборота
товаров получает в ответ не более
установленного лимита кода
идентификации 1524
cis
string
-
Код идентификации, используемый для
фильтрации по списку КИ
cisMatchMode
string
-
Режим фильтрации по КИ:
EQ - полностью равен;
LIKE
- содержит в себе. Является
устаревшим и в дальнейшем будет удалён.
Рекомендуется
использовать
"START_WITH" ("Начинается с");
START_WITH - начинается с
emissionDateFrom
string (date-
-
Дата эмиссии, от. Задается в формате
time)
yyyy-MM-ddTHH:mm:ss.SSS’Z
318
Параметр
Тип
Обяз.
Описание
emissionDateTo
string (date-
-
Дата эмиссии, до. Задается в формате
time)
yyyy-MM-ddTHH:mm:ss.SSS’Z
gtin
string
-
Код товара
producerInn
string
-
ИНН производителя
sn
string
-
Серийный номер кода идентификации
ownerInn
string
-
ИНН владельца
cisPackageType
enum
-
Тип упаковки. см. "Справочник "Типы
упаковки""
tnVed10
string
-
Код товарной номенклатуры (10 знаков)
emissionType
string
-
Тип эмиссии:
LOCAL - производство РФ;
FOREIGN - ввезен в РФ;
REMAINS - маркировка остатков;
CROSSBORDER - ввезен из стран ЕАЭС.
См."Справочник "Типы эмиссии КИ""
pageDir
string
-
Выбор направления:
PREV - предыдущий раздел;
NEXT - следующий раздел
uit
string
-
Значение КИ, "точки отсчета"(запись, с
которой начнется выборка), по которому
сортируются записи. Использовать только
совместно с параметром
orderedColumnValue
order
string
-
Направление сортировки:
ASC - по возрастанию;
DESC - по убыванию
orderColumn
string
-
Название столбца, по которому будет
производиться сортировка. Допустимое
значение emd - дата эмиссии
orderedColumnValue
string
-
Значение столбца, "точки отсчета"
(запись, с которой начинается выборка),
по которому сортируются записи.
Использовать только совместно с
параметром uit
limit
integer(int64)
-
Значение устанавливает количество
записей в ответе, не более 10000 записей
(по умолчанию 10 записей)
packageTypes
string
-
Фильтр по типам упаковок
319
Параметр
Тип
Обяз.
Описание
cisAggregationState
enum
-
Состояние КИ:
PACKED- в агрегате (агрегирован);
NOT_PACKED
- не в агрегате
(дезагрегирован);
ANY - любое состояние
packs
string
-
Фильтрация по единичным товарным
упаковкам. Возможные значения:
ALL - товары и упаковки;
UNIT - только товары (UNIT, BUNDLE);
PACK - только упаковки (LEVEL1,
LEVEL2, LEVEL3, LEVEL4, LEVEL5,
ATK, SET). См. "Справочник "Типы
упаковки"".
aggregation
boolean
-
Показывать товары и товарные упаковки
только в одном статусе для агрегации
countChildren
integer(int32)
-
Количество единиц товаров в упаковке
tree
string
-
Способ вывода дерева списка КИ/КИТУ:
NO_TREE - Не возвращать вложенные
КИ;
ONE_LEVEL
- Возвращать только
первый уровень вложенности;
ALL_TREE - Возвращать все дерево
uituStatus
string
-
Статус КИТУ
prVetDocument
string
-
Производственный ветеринарный
сопроводительный документ
(обязательный для ТГ "Молочная
продукция")
docType
string
-
см. Справочник "Типы документов""
statusExt
enum
-
Дополнительный статус товара:
WAIT_SHIPMENT
-
ожидает
подтверждения приёмки;
WAIT_TRANSFER_TO_OWNER
-
ожидает
передачу
владельцу
(производство по контракту);
WAIT_REMARK
- КИ списан после
нанесения на товар (товар ожидает
перемаркировку);
WITHDRAW - вывод из оборота;
REMARK_RETIRED - перемаркирован
cisStatus
string
-
Статус товара/КИ:
INTRODUCED - в обороте;
RETIRED - выбыл
320
Параметр
Тип
Обяз.
Описание
registryType
string
-
Тип реестра
agentInn
string
-
ИНН текущего владельца
previousAgentInn
string
-
ИНН предыдущего владельца
turnoverType
enum
-
Вид товарооборота:
SELLING - продажа;
COMMISSION - комиссия;
AGENT - агент
Пример ответа:
{
"results": [
{
"agentInn": "string",
"agentName": "string",
"children": [
{
"brand": "string",
"children": [
"string"
],
"childrenMap": [
null
],
"cis": "string",
"countChildren": 0,
"emissionDate": "2020-01-23T16:17:48Z",
"expireDate": "2020-01-23T16:17:48Z",
"exporterName": "string",
"exporterTaxpayerId": "string",
"sgtin": "string",
"introducedDate": "2020-01-23T16:17:48Z",
"lastDocId": "string",
"nextCises": [
"string"
],
"ownerInn": "string",
"ownerName": "string",
"packageType": "string",
"parent": "string",
"prVetDocument": "string",
"prevCises": [
"string"
],
"producedDate": "2020-01-23T16:17:48Z",
321
"producerName": "string",
"productName": "string",
"status": "string",
"statusEx": "string"
}
],
"cis": "string",
"countChildren": 0,
"dateChange": "2020-01-23T16:17:48Z",
"emissionDate": "2020-01-23T16:17:48Z",
"emissionType": "string",
"expireDate": "2020-01-23T16:17:48Z",
"exporterName": "string",
"exporterTaxpayerId": "string",
"gtin": "string",
"introducedDate": "2020-01-23T16:17:48Z",
"lastDocId": "string",
"nextCises": [
"string"
],
"ownerInn": "string",
"ownerName": "string",
"packType": "string",
"parent": "string",
"participantInn": "string",
"participantName": "string",
"prVetDocument": "string",
"prevCises": [
"string"
],
"producedDate": "2020-01-23T16:17:48Z",
"productName": "string",
"receiptDate": "2020-01-23T16:17:48Z",
"sgtin": "string",
"status": "string",
"statusEx": "string",
"tnVedEaes": "string",
"tnVedEaesGroup": "string",
"uit": "string",
"uitu": "string",
"withdrawReason": "string"
}
]
}
Параметры ответа:
Параметр
Тип
Обяз.
Описание
results:
+
322
Параметр
Тип
Обяз.
Описание
*agentInn
string
-
ИНН агента или комиссионера
*agentName
string
-
Наименование агента или комиссионера
*children:
-
КИ в агрегате
**brand
string
-
Бренд
**children:
[string]
-
Все Дочерние КИ. В формате массива
JSON
**childrenMap
[string]
-
Краткая информация о дочерних КИ
**cis
string
+
КИ товара
**countChildren
integer (int32)
-
Количество дочерних КИ
**emissionDate
string (date-
+
Дата эмиссии. Возвращается в формате
time)
yyyy-MM-ddTHH:mm:ss.SSS’Z
**expireDate
string (date-
-
Дата истечения срока годности.
time)
Возвращается в формате yyyy-MM-
ddTHH:mm:ss.SSS’Z (обязательный для
ТГ "Молочная продукция")
**exporterName
string
-
Наименование экспортера
**exporterTaxpayerId
string
-
Уникальный идентификатор экспортера в
национальной системе учета
налогоплательщиков
**sgtin
string
-
Индивидуальный идентификационный
код потребительской упаковки для
прослеживаемости в (код товара +
индивидуальный серийный номер
вторичной (потребительской) упаковки
или первичной упаковки, в случае
отсутствия вторичной)
**introducedDate
string (date-
-
Дата ввода в оборот. Возвращается в
time)
формате yyyy-MM-ddTHH:mm:ss.SSS’Z
**lastDocId
string
-
Последний регистрационный номер
документа, зафиксированный в ГИС МТ
по этому КИ
**nextCises
[string]
-
Следующие номера КИ. В случае
перемаркировки товара
**ownerInn
string
-
ИНН владельца товара
**ownerName
string
-
Наименование владельца товара
**packType
string
+
Тип упаковки. "Справочник "Типы
упаковки""
**parent
string
-
Код идентификации упаковки, в которую
агрегирован товар
323
Параметр
Тип
Обяз.
Описание
**prVetDocument
string
-
Производственный ветеринарный
сопроводительный документ
(обязательный для ТГ "Молочная
продукция")
**prevCises
[string]
-
Предыдущие КИ. В случае
перемаркировки товара
**producedDate
string (date-
-
Дата производства. Возвращается в
time)
формате yyyy-MM-ddTHH:mm:ss.SSS’Z
**producerName
string
-
Производитель товара
**productName
string
-
Название продукта
**status
enum
+
Статус КИ:
EMITTED - эмитирован. Выпущен;
APPLIED - эмитирован. Получен;
INTRODUCED - в обороте;
WRITTEN_OFF - списан;
RETIRED - выбыл;
DISAGGREGATION - расформирован
(только для упаковок)
Для перемаркированного КИ возможное
значение "WRITTEN_OFF" (Списан)
**statusEx
enum
-
Актуальные особые состояния КИ см.
"Справочник "Статусы КИ""
cis
string
+
Код идентификации, используемый для
фильтрации по списку КИ
countChildren
integer (int32)
-
Количество дочерних КИ
dateChange
string (date-
-
Дата внесения изменений в КИТУ. В
time)
формате yyyy-MM-ddTHH:mm:ss.SSS’Z
emissionDate
string (date-
+
Дата эмиссии КИ. Возвращается в
time)
формате yyyy-MM-ddTHH:mm:ss.SSS’Z
emissionType
string
+
Тип эмиссии:
LOCAL - производство РФ;
FOREIGN - ввезен в РФ;
REMAINS - маркировка остатков;
CROSSBORDER - ввезен из стран ЕАЭС.
См."Справочник "Типы эмиссии КИ""
expireDate
string (date-
-
Дата истечения срока годности.
time)
Возвращается в формате yyyy-MM-
ddTHH:mm:ss.SSS’Z (обязательный для
ТГ "Молочная продукция")
exporterName
string
-
Наименование экспортера
324
Параметр
Тип
Обяз.
Описание
exporterTaxpayerId
string
-
Уникальный идентификатор экспортера в
национальной системе учета
налогоплательщиков
gtin
string
-
Код товара
introducedDate
string (date-
-
Дата ввода в оборот с КИ в оборот.
time)
Возвращается в формате yyyy-MM-
ddTHH:mm:ss.SSS’Z
lastDocId
string
-
Последний регистрационный номер
документа, зафиксированный в ГИС МТ
по этому КИ
nextCises
[string]
-
Следующие номера КИ при
перемаркировке
ownerInn
string
-
ИНН владельца товара
ownerName
string
-
Наименование владельца товара
packageType
string
+
Тип упаковки. см. "Справочник "Типы
упаковки""
parent
string
-
КИТУ вышестоящего уровня
participantInn
string
-
ИНН участника, осуществившего
эмиссию КИ
participantName
string
-
Наименование участника оборота товаров
prVetDocument
string
-
Производственный ветеринарный
сопроводительный документ
(обязательный для ТГ "Молочная
продукция")
prevCises
string
-
Предыдущие номера КИ. В случае
перемаркировки товара
producedDate
string (date-
-
Дата производства. Возвращается в
time)
формате yyyy-MM-ddTHH:mm:ss.SSS’Z
productName
string
-
Наименование товара на этикетке
productGroup
string
-
Товарная группа. См. "Справочник
"Список поддерживаемых товарных
групп""
receiptDate
string (date-
-
Дата вывода из оборота. Возвращается в
time)
формате yyyy-MM-ddTHH:mm:ss.SSS’Z
sgtin
string
-
Код товара и Серийный номер КИ
325
Параметр
Тип
Обяз.
Описание
status
enum
+
Статус товара/КИ:
EMITTED - эмитирован. Выпущен;
APPLIED - эмитирован. Получен;
INTRODUCED - в обороте;
WRITTEN_OFF - КИ списан;
RETIRED - выбыл;
DISAGGREGATION
- расформирован
(только для упаковок)
statusEx
enum
-
Актуальные особые состояния КИ см.
"Справочник "Статусы КИ""
tnVedEaes
string
-
Код товарной номенклатуры (10 знаков)
tnVedEaesGroup
string
-
Код товарной позиции ТН ВЭД ЕАС
товара
uit
string
-
КИ, Обязательный, если не указан uitu
uitu
string
-
КИТУ, Обязательный, если не указан uit
total
integer
-
Общее количество значений, подходящие
под параметры фильтрации. Параметр
является устаревшим, планируется
удалить из метода.
5.1.3. Метод получения общедоступной информации о КИ по списку
Метод возвращает подробную информацию о запрашиваемом списке кодов идентификации
товара: в одном запросе указывается как один КИ, так и несколько КИ (не более 1000 КИ). Коды
товарной группы "Табачная продукция" и "Альтернативная табачная продукция" по блокам
можно указывать в запросах как со скобками, так и без скобок. В ответе код всегда будет со
скобками.
Тип приватности: c токеном авторизации
Общедоступная информация:
• информация о КИ;
• данные о производителе;
• дата и время производства;
• текущий статус в обороте;
• текущий владелец.
URL: /cises/info
Метод: POST
Пример строки запроса:
326
curl -X POST "<url стенда>/cises/info?pg=lp"
-H "accept: application/json"
-H "Content-Type: application/json"
Параметры строки запроса:
Параметр
Тип
Обяз.
Описание
Комментарий
pg
string
-
Товарная группа
Пример тела запроса:
[
"010460000000000021LLLLLLLLLLLLL"
]
Параметры тела запроса:
Параметр
Тип
Обяз.
Описание
Комментарий
cis
array[stri
+
Массив КИ
Не более 1000 КИ в массиве
ng]
Пример ответа:
1. В случае успеха:
327
[
{
"cisInfo":{
"requestedCis":"010461111111111121FFFFFFFFFFFFF",
"cis":"010461111111111121FFFFFFFFFFFFF",
"gtin":"0104611111111111",
"tnVedEaesGroup":"6403",
"productName":"Alessio Nesca / Сапоги",
"productGroupId":2,
"productGroup":"shoes",
"brand":"Alessio Nesca",
"emissionDate":"2020-12-30T07:37:49.293Z",
"emissionType":"LOCAL",
"packageType":"UNIT",
"ownerInn":"7777777777",
"ownerName":"ООО \"ХХХ\"",
"status":"INTRODUCED",
"statusEx":"EMPTY",
"producerInn":"5555555555",
"producerName":"ООО \"ХХХХХ\"",
"markWithdraw":false,
"certDoc":[
{
"type":"CONFORMITY_DECLARATION",
"number":"123",
"date":"2021-07-01T00:00:00.000Z"
},
{
"type":"STATE_REGISTRATION_CERTIFICATE",
"number":"456",
"date":"2021-07-02T00:00:00.000Z"
}
]
}
}
]
2. В случае ошибок:
2.1. Код 404 при неизвестных КИ:
328
[
{
"cisInfo": {
"cis": "<КИ из запроса>",
"gtin": "<GTIN>"
//если есть GTIN
},
"errorMessage1": "КИ не найден",
"errorCode1": "<код ошибки>"
},
{
"cisInfo": {
"cis": "<КИ из запроса>",
"gtin": ""
//если нет GTIN
},
"errorMessageN": "КИ не найден",
"errorCodeN": "<код ошибки>"
}
]
2.2. Код 404 при указании в запросе несуществующих КИ:
[
{
"cisInfo":{
"cis":"<КИ из запроса>",
"gtin":"<GTINi>"
},
"errorMessage1":"КИ не найден",
"errorCode1":"<код ошибки>"
},
{
"cisInfo":{
"cis":"<КИ из запроса>",
"gtin":""
},
"errorMessageN":"КИ не найден",
"errorCodeN":"<код ошибки>"
}
]
2.3. Код 404 при указании в запросе кодов без кодов товара и кодов транспортных упаковок,
не найденных в товарной группе:
329
[
{
"cisInfo":{
"cis":"<КИ из запроса>",
"gtin":"GTIN не найден"
},
"errorMessage1":"КИ не найден",
"errorCode1":"<код ошибки>"
},
{
"cisInfo":{
"cis":"<КИ из запроса>",
"gtin":""
},
"errorMessageN":"КИ не найден",
"errorCodeN":"<код ошибки>"
}
]
2.4. Код 400 при пустом списке КИ в теле запроса:
{
"error_message":"В запросе не указан ни один КМ"
}
2.5. Код 400 при отсутствии тела запроса:
{
"error_message":"Required request body is missing: public
org.springframework.http.ResponseEntity
ru.crpt.trueapi.controller.motp.CisesController.getCisesInfoByCodeList(java.util.Li
st<java.lang.string>)"
}
2.6. Код 400 при неверной структуре 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]"
}
2.7. Код 403 при не подписанном договоре, если на КИ и агрегаты вернулась ошибка 403:
330
{
"error_message":"отсутствует действующий договор по ТГ"
}
2.8. Код 401: авторизация не пройдена, если указан токен, но он не валиден:
{
"error_message":"Авторизация не пройдена"
}
2.9. Код 422 по КИ не может быть возвращена информация, т.к. отсутствует согласие от
текущего владельца КИ
{
"error_message":"Отсутствует доступ к сведениям"
}
2.10. Код 504 в запросе несколько КИ или агрегатов - по всем КИ и агрегатам ошибка, что
сервис не вернул ответ
{
"error_message":"Отсутствует ответ системы"
}
2.11. Код 200 возвращается, если в запросе несколько КИ или агрегатов и на хотя бы один из
них вернулся успешный ответ от системы с получением сведений по КИ или агрегату или на
все КИ и агрегаты вернулись разные ошибки.
При этом, в теле ответа для каждого КИ и агрегата выводится информация с кодом ошибки в
соответствии с причинами возникновения ошибки.
331
[
{
"cisInfo1":{
"cis":"<КИ1 из запроса>",
"gtin":"<GTINi>"
},
"errorMessage1":"КИ не найден",
"errorCode1":"404"
},
{
"cisInfo2":{
"cis":"<КИ2 из запроса>",
"gtin":"<GTINi>"
},
"errorMessage1":"Отсутствует ответ системы",
"errorCode1":"504"
}
]
Параметры ответа:
Параметр
Тип
Обяз.
Описание
Комментарий
cisInfo
array
-
Список КИ
*requestedCis
string
+
КИ из запроса
При наличии параметра в ответе
*cis
string
-
КИ из ответа
Параметр не возвращается для
агрегатов со статусом
"DISAGGREGATION"
("Расформирован")
*gtin
string
-
Код товара
Если код товара менее 14 символов,
то дополняется ведущими нулями
*tnVedEaes
string
-
10-значный код
ТН ВЭД
*tnVedEaesGroup
string
-
4-значный код ТН
ВЭД
*productName
string
-
Наименование
продукции
*productGroupId
number
-
Идентификатор
товарной группы
*productGroup
string
-
Наименование
товарной группы
*brand
string
-
Бренд
332
Параметр
Тип
Обяз.
Описание
Комментарий
*producedDate
string
-
Дата ввода товара
Возвращается в формате yyyy-MM-
(date-
в оборот (дата
ddTHH:mm:ss.SSS’Z
time)
нанесения для
товарных групп
"Табачная
продукция" и
"Альтернативная
табачная
продукция")
*emissionDate
string
-
Дата эмиссии
Возвращается в формате yyyy-MM-
(date-
ddTHH:mm:ss.SSS’Z
time)
*emissionType
string
-
Тип эмиссии
Возможные значения:
LOCAL - производство РФ;
FOREIGN - ввезён в РФ;
REMAINS - маркировка остатков;
CROSSBORDER - ввезён из стран
ЕАЭС
*packageType
string
+
Код типа
См. "Справочник "Типы упаковки""
упаковки
*ownerInn
string
-
ИНН владельца
товара
*ownerName
string
-
Наименование
владельца товара
*status
string
+
Код статуса КИ
См. "Справочник "Статусы КИ""
*statusEx
string
-
Актуальное
Cм. "Справочник "Статусы КИ"".
особое состояние
КИ
*producerInn
string
-
ИНН
производителя
*producerName
string
-
Наименование
Для КИТУ данная информация
производителя
отображается только для товарных
групп "Альтернативная табачная
продукция", "Никотиносодержащая
продукция", "Табачная продукция"
*markWithdraw
boolean
-
Зафиксирована
Для КИТУ данная информация
розничная
отображается только для товарных
продажа по чеку
групп "Альтернативная табачная
от невладельца
продукция", "Никотиносодержащая
КИ
продукция", "Табачная продукция"
*certDoc
string
-
Документ
обязательной
сертификации
333
Параметр
Тип
Обяз.
Описание
Комментарий
*type
string
-
Вид документа
Возможные значения:
обязательной
сертификации
CONFORMITY_CERTIFICATE -
сертификат соответствия;
CONFORMITY_DECLARATION -
декларация о соответствии;
STATE_REGISTRATION_CERTIFIC
ATE - свидетельство государственной
регистрации
*number
string
-
Номер документа
обязательной
сертификации
*date
string(da
-
Дата выдачи
Формат: yyyy.MM.dd
te)
документа
обязательной
сертификации
*wellNumber
string
-
Номер скважины
Указывается только для товарной
группы "Упакованная вода"
*child
array
-
Дочерний КИ в
[string]
агрегате при
наличии (только 1
слой)
*parent
string
-
Родительский КИ
*maxRetailPrice
number
-
Максимальная
Возвращается для товарных групп
цена розничной
"Табачная продукция",
продажи
"Альтернативная табачная
продукция" и "Никотиносодержащая
продукция" только для пачки или
блока. Если у блока или пачки
отсутствует МРЦ, то параметр не
возвращается. Для блока значение =
maxRetailPrice*количество штук в
блоке. При отсутствии информации в
БД выводится значение "NULL"
*producerInn
string
-
ИНН
Возвращается только для КИТУ
производителя РФ
товарных групп "Табачная
для товарных
продукция", "Альтернативная
групп "Табачная
табачная продукция", для остальных
продукция",
товарных групп не возвращается вне
"Альтернативная
зависимости от статуса КИТУ и типа
табачная
приватности метода
продукция"
334
Параметр
Тип
Обяз.
Описание
Комментарий
*producerName
string
-
Наименование
Возвращается только для КИТУ
производителя РФ
товарных групп "Табачная
продукция", "Альтернативная
табачная продукция", для остальных
товарных групп не возвращается вне
зависимости от статуса КИТУ и типа
приватности метода
*agentInn
string
-
ИНН агента
Возвращается только если участник -
агент или КИ принадлежат агенту.
Временное решение до реализации
агентско-комиссионной схемы в УПД
*prVetDocument
string
-
ID
Обязательный параметр для товарной
производственног
группы "Молочная продукция"
о ВСД (для
продукции,
произведённой в
РФ) или ID
транспортного
ВСД (для
продукции,
произведённой
вне РФ)
*exporterName
string
-
Наименование
экспортёра
*expirationDate
string
-
Дата срока
Возвращается только для товарной
(date-
годности
группы "Молочная продукция"
time)
*partialSaleInfo
object
-
Объект
Возвращается для товарных групп
параметров
"Альтернативная табачная
частичного
продукция" (количество в шт) и
выбытия
"Духи и туалетная вода" (наливная
продукция, объём в мл)
**innerUnitCount
number
-
Общее
Значением параметра является
количество
количество/объём товара в
(объём) товара в
потребительской упаковке/единице
потребительской
товара
упаковке
**soldUnitCount
number
-
Количество
Значением параметра является число
(объём)
выбывших, в том числе от
выведенного из
невладельцев, из оборота единиц
оборота товара по
употребления из всех чеков.
КИ
Участнику оборота товаров
отображается информация только по
собственным чекам. ФОИВ доступна
информация по всем чекам
335
Параметр
Тип
Обяз.
Описание
Комментарий
**rest
number
-
Количество
Значением параметра является
(объём) товара,
расчётное количество/объём
доступного к
оставшихся в потребительской
выводу из
упаковке/единице товара единиц
оборота по КИ
употребления/мл товара после
продажи всеми участниками оборота
товаров. Участнику оборота товаров
отображается информация только по
собственным чекам. ФОИВ доступна
информация по всем чекам
**correctRest
boolean
-
Корректность
Показатель корректности остатка
остатка товара
товара после вывода товара из
оборота:
false - продано или возвращено
больше допустимого
количества/объёма товара;
true - продано или возвращено в
пределах допустимого
количества/объёма товара.
Для товарной группы "Духи и
туалетная вода" (наливная
продукция) продажа товара в объёме,
превышающем заявленный, а также
превышение остатка товара более
чем на 8 % считаются
некорректными
errorMessage
string
-
Сообщение об
См. "Справочник "Статусы ответов"".
ошибке
Параметр возвращается при наличии
ошибки
errorCode
string
-
Код ошибки
Параметр возвращается при наличии
ошибки
336
Параметр
Тип
Обяз.
Описание
Комментарий
withdrawReason
string
-
Причина вывода
Возможные значения:
из оборота
KM_SPOILED - испорчен КМ;
KM_LOST - утерян КМ;
KM_DESTROYED - уничтожен КМ;
DESCRIPTION_ERRORS - выявлены
ошибки описания товара;
RETAIL - розничная реализация;
EEC_EXPORT - экспорт в страны
ЕАЭС;
BEYOND_EEC_EXPORT - экспорт за
пределы ЕАЭС;
RETURN - возврат от физ.лица;
REMOTE_SALE - продажа по
образцам, дистанционный способ
продажи;
DAMAGE_LOSS - утрата или
повреждение;
DESTRUCTION - утилизация или
уничтожение;
CONFISCATION - конфискация;
LIQUIDATION - ликвидация;
DONATION - безвозмездная
передача;
STATE_ENTERPRISE - приобретение
гос.предприятием;
NO_RETAIL_USE - использование
для собственных нужд покупателем;
ENTERPRISE_USE - использование
для собственных нужд предприятия;
KM_SPOILED_OR_LOST -
испорчено либо утеряно СИ с КМ;
KM_CANCELLATION -
аннулирование не преобразованных в
СИ с КИ по истечении срока;
RETAIL_RETURN - возврат от
розничного покупателя;
REMOTE_SALE_RETURN - возврат
в случае дистанционной продажи;
KMCANCELATION - списание при
трансформации;
OTHER - другая причина, если
"withdrawReason" = "OTHER", то
причина возвращается в
дополнительном параметре
"withdrawReasonOther"
withdrawReasonOt
string
-
Введенная
Возвращается, если "withdrawReason"
her
вручную причина
= "OTHER"
вывода из оборота
337
5.1.4. Метод получения общедоступной информации о КИ по списку (упрощённый
атрибутивный состав)
Метод предназначен для отгрузки/приёмки товара всех товарных групп, используя информацию
только из "cis" ("Массив КИ").
Тип приватности: публичный
URL: /cises/short/list
Метод: POST
Пример строки запроса:
curl -X POST "<url стенда>/cises/short/list"
-H "accept: */*"
-H "Content-Type: application/json"
Параметры строки запроса:
Параметр
Тип
Обяз.
Описание
Комментарий
pg
string
-
Товарная группа
См. "Справочник "Список
поддерживаемых товарных групп""
Пример тела запроса:
["010460000000000021AAAAAAAAA"]
Параметры тела запроса:
Параметр
Тип
Обяз.
Описание
Комментарий
cis
array[stri
+
Массив КИ
Не более 1000 КИ в массиве
ng]
Пример ответа:
1. В случае успеха:
[
{
"result":{
"requestedCis":"(01)00000020200000(21)AAAa0aA",
"cis":"(01)00000020200000(21)AAAa0aA",
"gtin":"00000000000001",
"producerInn":"0000000001",
"status":"RETIRED",
"emissionDate":"2020-07-16T18:51:27.000Z",
"applicationDate":"2020-07-16T18:51:39.000Z",
"parent":"testParent",
338
"packageType":"LEVEL1",
"ownerInn":"0000000002",
"children":[
"00000020200000AA1116",
"000000202000014XXxlXX",
"00000020200001YYYyYYf",
"00000020200001Ll7LlLL",
"00000020200001ffrfcFj",
"00000020200001TTtt4tT",
"00000020200001ZZz1oZ7",
"00000020200001ZrRrrrR",
"00000020200001BBoBBvv",
"00000020200001nnNn0Nn"
],
"tnVedEaesGroup":"1111",
"tnVedEaes":"2222222222",
"receiptDate":"2020-07-16T18:51:28.000Z",
"emissionType":"LOCAL",
"specialAttributes":{
"maxRetailPrice":100,
"agentInn":"0000000003",
"introducedDate":"2020-07-16T18:51:27.000Z",
"nextCis":[
"testCis"
],
"prevCis":[
"00000000007000000%OnqBYWh0)klp"
],
"turnoverType":"COMMISSION",
"retType":"1",
"expNum":444444444444,
"expName":"TestExporter",
"remainsImport":"testRemainsImport",
"ftsDecisionCode":"testftsDC",
"quantityInPack":"111",
"soldCount":"4",
"eliminationReasonOther":"testelrOther",
"approvementDocument":{
"certDoc":[
{
"type":"CONFORMITY_CERTIFICATE",
"number":"20202077",
"date":"2023-01-01T00:00:00Z"
},
{
"type":"CONFORMITY_DECLARATION",
"number":"20202fddfsfs077",
"date":"2023-01-01T00:00:00Z"
},
{
"type":"CONFORMITY_CERTIFICATE",
339
"number":"10999030/110820/0000414",
"date":"2020-08-11T00:00:00Z"
}
],
"declarationDate":"11.08.2020",
"declarationRegNumber":"10000000/000000/0000000",
"declarationId":"00cf0000-b000-0ab0-b000-c00e00f0e00f"
}
},
"statusEx":"FTS_RESPOND_NOT_OK",
"productGroup":"tobacco",
"productGroupId":3,
"extendedPackageType":"1",
"withdrawReason":"KM_SPOILED"
}
}
]
2. В случае ошибок:
2.1. Код 400 при неверной структуре * .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]",
"error_description":"JSON некорректный"
}
2.2. Код 400 при отсутствии тела запроса:
{
"error_message":"Required request body is missing: public
org.springframework.http.ResponseEntity
ru.crpt.trueapi.controller.motp.CisesController.getCisesInfoByCodeList(java.util.Li
st<java.lang.string>)"
}
2.3. Код 400 при пустом списке КИ в теле запроса:
{
"error_message":"В запросе не указан ни один КИ"
}
2.4. Код 400 при запросе свыше 1000 КИ:
340
{
"error_message":"Слишком много КИ в запросе. Количество не должно превышать
1000"
}
2.5. Код 401 авторизация не пройдена, если указан токен, но он не валиден:
{
"error_message":"Для доступа к этому ресурсу требуется полная аутентификация.
Проверьте токен"
}
2.6. Код 403 при не подписанном договоре, если на КИ и агрегаты вернулась ошибка 403:
{
"error_message":"отсутствует действующий договор по <pg>"
}
2.7. Код 404 при запросе не найденных кодов в подписанной товарной группе:
{
"result":{
"requestedCis":"010460000000000021AAAAAAAAA",
"gtin":"04600000000000"
},
"errorMessage":"КИ не найден",
"errorCode":"404"
}
Параметры ответа:
Параметр
Обяз.
Тип
Описание
Комментарий
result
+
cis
+
string
КИ
потребительских/
групповых/трансп
ортных упаковок
requestedCis
+
string
КИ
запрашиваемых
потребительских/
групповых/трансп
ортных упаковок
341
Параметр
Обяз.
Тип
Описание
Комментарий
applicationDate
-
string
Дата нанесения
Возвращается в формате yyyy-MM-
(date-
ddTHH:mm:ss.SSS’Z
time)
children
-
array[stri
Список дочерних
Возвращается список КИ только
ng]
КИ в агрегате
верхнего уровня
emissionDate
-
string(da
Дата эмиссии
Возвращается в формате yyyy-MM-
te-time)
ddTHH:mm:ss.SSS’Z
emissionType
-
string
Тип эмиссии
Возможные значения:
LOCAL - производство РФ;
FOREIGN - ввезён в РФ;
REMAINS - маркировка остатков;
CROSSBORDER - ввезён из стран
ЕАЭС
gtin
+
string
Код товара
Если код товара менее 14 символов,
то он дополняется ведущими нулями
ownerInn
-
string
ИНН
Параметр возвращается только
собственника
владельцу товара, ФОИВ и
товара
Оператору-ЦРПТ
packageType
+
string
Уровень упаковки
extendedPackageT
+
string
Тип упаковки
См. "Справочник "Типы упаковки""
ype
parent
-
string
Родительский КИ
producerInn
-
string
ИНН
Параметр не возвращается для
производителя
агрегатов товарных групп
"Велосипеды и велосипедные рамы",
"Духи и туалетная вода", "Кресла-
коляски", "Молочная продукция",
"Обувные товары", "Пиво, напитки,
изготавливаемые на основе пива,
слабоалкогольные напитки",
"Предметы одежды, бельё
постельное, столовое, туалетное и
кухонное", "Упакованная вода",
"Фотокамеры (кроме кинокамер),
фотовспышки и лампы-вспышки",
"Шины и покрышки пневматические
резиновые новые"
productGroup
-
string
Товарная группа
См. "Справочник "Список
поддерживаемых товарных групп""
productGroupId
-
string
ID товарной
группы
receiptDate
-
string(da
Дата вывода из
Возвращается для КИ, КИН, КИГУ,
te-time)
оборота
КИК в формате yyyy-MM-
ddTHH:mm:ss.SSS’Z
342
Параметр
Обяз.
Тип
Описание
Комментарий
status
+
string
Статус КИ
См. "Справочник "Статусы КИ""
statusEx
-
string
Расширенный
статус КИ, КИН,
КИГУ
tnVedEaes
-
string
10-значный код
КИ, КИН, КИГУ
ТН ВЭД
tnVedEaesGroup
-
string
4-значный код ТН
КИ, КИН, КИГУ
ВЭД
withdrawReason
-
boolean
Причина вывода
из оборота
errorMessage
-
string
Сообщение об
См. "Справочник "Статусы ответов"".
ошибке
Возвращается при наличии ошибки
errorCode
-
string
Код ошибки
Возвращается при наличии ошибки
specialAttributes
-
specialA
Дополнительные атрибуты "cis" ("КИ
ttributes
потребительских/групповых/транспо
Dto
ртных упаковок")
*maxRetailPrice
-
number
Максимальная
Возвращается только для пачки и
цена розничной
блока (расформированные агрегаты -
продажи
для блоков товарной группы
"Табачная продукция")
*expirationDate
-
string(da
Срок годности
Возвращается только для товарной
te-time)
группы "Молочная продукция"
*agentInn
-
string
ИНН владельца
Заполняется на основании значения
параметра "receiver_inn" ("ИНН
получателя") документа "Приёмка"
(LP_ACCEPT_GOODS)
*prVetDocument
-
string
Производственны
Обязательный параметр для товарной
й ветеринарный
группы "Молочная продукция"
сопроводительны
й документ,
транспортный
ВСД в случае
импортной
продукции
*introducedDate
-
string(da
Дата ввода товара
Возвращается в формате yyyy-MM-
te-time)
в оборот или
ddTHH:mm:ss.SSS’Z для КИ, КИГУ,
формирования
КИК, КИТУ
агрегата
*capacity
-
string
Объём
Возвращается только для товарной
группы "Молочная продукция"
343
Параметр
Обяз.
Тип
Описание
Комментарий
*nextCis
-
string
Следующие КМ,
после
перемаркировки
*prevCis
-
string
Предыдущие КМ,
до
перемаркировки
*turnoverType
-
string
Вид
Возможные значения:
товарооборота
SELLING - продажа;
COMMISSION - комиссия;
AGENT - агент
*retType
-
string
Тип возврата в
оборот
*expNum
-
string
ИНН/УНБ
экспортёра
*expName
-
string
Наименование
экспортёра
*remainsImport
-
string
Признак
импортного
товара,
ввезённого в РФ
после 01.07.2020
*ftsDecisionCode
-
string
Код принятого
решения из ДТ
*quantityInPack
-
string
Количество
единиц
употребления в
потребительской
упаковке/заявлен
ный объём
*soldCount
-
string
Счётчик
проданного и
возвращённого
товара
участниками
оборота товаров
*eliminationReaso
-
string
Описание другой
nOther
причины вывода
из оборота
*approvementDocu
-
array
Сведения о
ment
сертификатах и
декларациях
**declarationDate
-
string
Дата ДТ
344
Параметр
Обяз.
Тип
Описание
Комментарий
**declarationId
-
string
Регистрационный
номер ДТ
**declarationRegN
-
string
ID ДТ
umber
**certDoc
-
array
Сертификаты/дек
ларации
соответствия
***type
-
string
Дата сертификата
Формат: yyyy-MM-
ddTHH:mm:ss.SSS’Z. Возможные
значения:
CONFORMITY_CERTIFICATE -
сертификат соответствия;
CONFORMITY_DECLARATION -
декларация о соответствии;
STATE_REGISTRATION_CERTIFIC
ATE - свидетельство о
государственной регистрации
***number
-
string
Номер
сертификата
***date
-
string
Тип сертификата
***wellNumber
string
-
Номер скважины
Указывается только для товарной
группы "Упакованная вода"
5.1.5. Метод получения краткой общедоступной информации о КИ по списку
Метод возвращает информацию о списке запрашиваемых КИ: в одном запросе можно указать
несколько КИ. КИ для ТГ "Табачная продукция" и "Альтернативная табачная продукция" по
блокам можно указывать в запросах как со скобками, так и без скобок. В ответе код всегда будет
возвращаться со скобками. Запятая не является разделителем для параметров запроса, а
считается частью самого параметра.
Тип приватности:
1. по токену авторизации
Общедоступная информация:
• информация о КИ;
• данные о производителе;
• дата и время производства;
• текущий статус в обороте;
• текущий владелец - показ только владельцу, ФОИВ, Оператору-ЦРПТ и Администратору.
URL: /cises/list
Метод: POST
345
Пример запроса для публичного типа приватности
curl -X POST <url стенда
v3>/cises/list?values=000000462106549OOv1s0XzlzIFDjtcXJjz5cB&values=00000046210654QuHC
UeP
-H "accept: */*"
-H "Authorization: Bearer <ТОКЕН>"
Параметры запроса:
Параметр
Тип
Обяз.
Описание
Комментарий
values
array[stri
+
Список КИ
В списке может быть от 1 до 35
ng]
(демонстрационный стенд) - 50
(промышленный стенд) КИ/КИТУ.
Список перечисления КИ имеет
формат:
<URL>?values=<cis1>[&values=<cisN
>]
Пример ответа:
1.В случае успеха:
346
[
{
"requestedCis": "string",
"cis": "string",
"status": "string",
"statusEx": "string",
"gtin": "string",
"productName": "string",
"productGroup": "string",
"productGroupId": 0,
"producedDate": "2021-03-29T19:37:56.693Z",
"packageType": "string",
"producerInn": "string",
"producerName": "string",
"emissionDate": "2021-03-29T19:37:56.693Z",
"emissionType": "string",
"ownerInn": "string",
"ownerName": "string",
"tnVedEaes": "string",
"tnVedEaesGroup": "string",
"parent": "string",
"agentInn": "string",
"child": [
"string"
],
"maxRetailPrice": 0,
"partialSaleInfo": {
"soldUnitCount": 0,
"rest": 0,
"correctRest": true,
"innerUnitCount": 0
},
"withdrawReason": "string",
"withdrawReasonOther": "string"
}
]
2 В случае ошибок:
2.1. Код 404 Если указанный КИ не найден:
{
"error_message": "КИ не найдены"
}
2.2. Код 400 При отсутствии обязательного параметра:
347
{
"error_message": "Отсутствует обязательный параметр: values"
}
Параметры ответа:
Параметр
Тип
Обяз.
Описание
Комментарий
requestedCis
string
-
КИ из запроса
При наличии параметра в ответе
cis
string
+
КИ
status
string
+
Код статуса КИ
См. "Справочник "Статусы КИ""
gtin
string
-
Код товара
Если код товара менее 14 символов,
то он дополняется ведущими нулями
tnVedEaes
string
-
10-значный код
ТН ВЭД
tnVedEaesGroup
string
-
Код товарной
позиции ТН ВЭД
ЕАЭС товара
productName
string
-
Наименование
продукции
producedDate
string
-
Дата ввода товара
Возвращается в формате yyyy-MM-
(date-
в оборот
ddTHH:mm:ss.SSS’Z
time)
emissionDate
string
+
Дата эмиссии КИ
Возвращается в формате yyyy-MM-
(date-
ddTHH:mm:ss.SSS’Z
time)
emissionType
string
-
Тип эмиссии
См."Справочник "Типы эмиссии
КИ""
packageType
string
+
Код типа
См. "Справочник "Типы упаковки""
упаковки
producerInn
string
-
ИНН Российского
Возвращается только для агрегатов
производителя
товарных групп "Альтернативная
табачная продукция",
"Никотиносодержащая продукция" и
"Табачная продукция"
producerName
string
-
Наименование
Возвращается только для агрегатов
производителя
товарных групп "Альтернативная
табачная продукция",
"Никотиносодержащая продукция" и
"Табачная продукция"
348
Параметр
Тип
Обяз.
Описание
Комментарий
ownerInn
string
-
ИНН владельца
Данный параметр возвращается
товара
только владельцу продукции, ФОИВ
и Оператору. Отображение данных о
владельце настраивается параметром
конфигурации.
ownerName
string
-
Наименование
Данный параметр возвращается
владельца товара
только владельцу продукции, ФОИВ
и Оператору. Отображение данных о
владельце настраивается параметром
конфигурации.
parent
string
-
Родительский КИ
agentInn
string
-
ИНН агента
Возвращается только если участник -
агент или КИ принадлежат агенту.
Временное решение до реализации
агентско-комиссионной схемы в УПД
child
array
-
Список дочерних
[string]
КИ в агрегате
productGroupId
integer
-
Идентификатор
См. "Справочник "Список
товарной группы
поддерживаемых товарных групп""
productGroup
string
-
Наименование
См. "Справочник "Список
товарной группы
поддерживаемых товарных групп""
*maxRetailPrice
number
-
Максимальная
Возвращается для ТГ "Табачная
цена розничной
продукция", "Альтернативная
продажи
табачная продукция" и
"Никотиносодержащая продукция"
только для пачки или блока. Если у
блока или пачки отсутствует МРЦ, то
параметр не возвращается. Для блока
значение =
maxRetailPrice*количество штук в
блоке. При отсутствии информации в
БД выводится значение NULL
partialSaleInfo
object
-
Объект
Возвращается для ТГ
параметров
"Альтернативная табачная
частичного
продукция" (количество в шт) и
выбытия
"Духи и туалетная вода" (наливная
продукция, объем в мл)
*innerUnitCount
number
-
Общее
Значением параметра является
количество
количество/объём товара в
(объем) товара в
потребительской упаковке/единице
потребительской
товара
упаковке
349
Параметр
Тип
Обяз.
Описание
Комментарий
*soldUnitCount
number
-
Количество
Значением параметра является число
(объем)
выбывших, в том числе от
выведенного из
невладельцев, из оборота единиц
оборота товара по
употребления из всех чеков. УОТ
КИ
отображается информация только по
собственным чекам. ФОИВ доступна
информация по всем чекам
*rest
number
-
Количество
Значением параметра является
(объем) товара,
расчётное количество/объём
доступного к
оставшихся в потребительской
выводу из
упаковке/единице товара единиц
оборота по КИ
употребления/мл товара после
продажи всеми УОТ. УОТ
отображается информация только по
собственным чекам. ФОИВ доступна
информация по всем чекам
*correctRest
boolean
-
Корректность
Показатель корректности остатка
остатка товара
товара после вывода товара из
оборота: false - продано или
возвращено больше допустимого
количества/объема товара; true -
продано или возвращено в пределах
допустимого количества/объема
товара. Для товарной группы "Духи и
туалетная вода" (наливная
продукция) продажа товара в объеме,
превышающем заявленный, а также
превышение остатка товара более
чем на 8% считаются некорректными
350
Параметр
Тип
Обяз.
Описание
Комментарий
withdrawReason
string
-
Причина вывода
Возможные значения:
из оборота
KM_SPOILED - испорчен КМ;
KM_LOST - утерян КМ;
KM_DESTROYED - уничтожен КМ;
DESCRIPTION_ERRORS - выявлены
ошибки описания товара;
RETAIL - розничная реализация;
EEC_EXPORT - экспорт в страны
ЕАЭС;
BEYOND_EEC_EXPORT - экспорт за
пределы ЕАЭС;
RETURN - возврат от физ.лица;
REMOTE_SALE - продажа по
образцам, дистанционный способ
продажи;
DAMAGE_LOSS - утрата или
повреждение;
DESTRUCTION - утилизация или
уничтожение;
CONFISCATION - конфискация;
LIQUIDATION - ликвидация;
DONATION - безвозмездная
передача;
STATE_ENTERPRISE - приобретение
гос.предприятием;
NO_RETAIL_USE - использование
для собственных нужд покупателем;
ENTERPRISE_USE - использование
для собственных нужд предприятия;
KM_SPOILED_OR_LOST -
испорчено либо утеряно СИ с КМ;
KM_CANCELLATION -
аннулирование не преобразованных в
СИ с КИ по истечении срока;
RETAIL_RETURN - возврат от
розничного покупателя;
REMOTE_SALE_RETURN - возврат
в случае дистанционной продажи;
KMCANCELATION - списание при
трансформации;
OTHER - другая причина, если
"withdrawReason" = "OTHER", то
причина возвращается в
дополнительном параметре
"withdrawReasonOther"
withdrawReasonOt
string
-
Введенная
Возвращается, если "withdrawReason"
her
вручную причина
= "OTHER"
вывода из оборота
351
Параметр
Тип
Обяз.
Описание
Комментарий
statusEx
string
-
Расширенный
Не возвращается для товарной
статус КИ
группы "Табачная продукция"
5.1.6. Метод запроса подлинности КМ
Метод предназначен для проверки валидности КМ, выпущенных Операторами государств-
членов ЕАЭС:
• Республика Беларусь - товарные группы "Молочная продукция", "Обувные товары",
"Предметы одежды, бельё постельное, столовое, туалетное и кухонное" (с 1 марта 2022),
"Шины и покрышки пневматические резиновые новые";
• Республика Казахстан - товарная группа "Обувные товары".
URL: /cises/eaes/info
Тип приватности: приватный
Метод: POST
Пример строки запроса:
curl -X POST "<url стенда>/cises/eaes/info?country=112"
-H "Content-Type: application/json"
-H "Authorization: Bearer<ТОКЕН>"
Параметры строки запроса:
Параметр
Тип
Обяз.
Описание
Комментарий
country
integer
+
Числовой код
Возможные значения:
страны по ОКСМ
112 - Республика Беларусь;
398 - Республика Казахстан.
При указании значения "398"
(Республика Казахстан), в параметре
"pg" может быть указано только
значение "shoes" ("Обувные товары").
Все коды маркировки, указанные в
теле запроса в параметре "cis",
проходят валидацию на соответствие
шаблону кодов маркировки страны,
указанной в параметре "country"
352
Параметр
Тип
Обяз.
Описание
Комментарий
pg
string
-
Товарная группа
По дате реализации взаимного
признания КМ:
lp - "Предметы одежды, бельё
постельное, столовое, туалетное и
кухонное";
milk - "Молочная продукция";
shoes - "Обувные товары";
tires - "Шины и покрышки
пневматические резиновые новые".
При указании значения "shoes", в
параметре "country" может быть
указано только значение "398"
(Республика Казахстан).
При запросе КМ из товарной группы
"Предметы одежды, бельё
постельное, столовое, туалетное и
кухонное", выпущенного Оператором
Республики Беларусь до 1 марта 2022
года (дата начала действия взаимного
признания КМ), данный КМ в ГИС
МТ найден не будет
Пример тела запроса:
{
"cis":"0104655555555555212FFFFFFFFFFFF\u001D91LlLl\u001D9212345TtTtT12345TtTtT12345TtT
tT12345TtTtTtTt="
}
Параметры тела запроса:
353
Параметр
Тип
Обяз.
Описание
Комментарий
cis
string
+
КМ
Указывается полный КМ с ключом
проверки. Cимвол GS (по таблице
ASCII
- код
029) в составе КМ
необходимо экранировать с помощью
\u001d.
Допускается
указание
КМ,
эмитированных:
• на
территории
Республики
Беларусь для товарных групп
"Молочная продукция", "Обувные
товары", "Предметы одежды,
бельё постельное, столовое,
туалетное и кухонное", "Шины и
покрышки
пневматические
резиновые новые";
• на
территории
Республики
Казахстан для товарной группы
"Обувные товары".
Все указанные КМ проходят
валидацию на соответствие шаблону
КМ страны, указанной в параметре
"country"
Ответ может содержать параметры, специфичные только для товарной группы "Молочная
продукция". Полный список возможных параметров см. в справочнике "Дополнительные
параметры для ТГ "Молочная продукция"".
Пример ответа:
1. Код 200. КМ подлинный:
354
{
"cis":"string",
"authenticity":true,
"cisStatusId":"1",
"cisStatusName":"в обороте в стране ЕАЭС",
"gtin":"04655555555555",
"productName":"Шина",
"brand":"Бренд",
"tnvedGroup":"0000",
"expireDate":"2021-10-10",
"registered":true,
"cisStatus":"INTRODUCED",
"emissionType":"CROSSBORDER",
"statusEx":"WAIT_SHIPMENT"
}
2. Код 200. КМ неподлинный:
{
"cis":"string",
"authenticity":false
}
3. Код 200. КМ подлинный, но не найден в ГИС МТ:
{
"cis":"string",
"authenticity":true,
"cisStatusId":"1",
"cisStatusName":"в обороте в стране ЕАЭС",
"registered":false
}
4. Код 401. Для доступа к ресурсу требуется полная аутентификация:
{
"error_message":"Для доступа к этому ресурсу требуется полная аутентификация"
}
5. Код 401. Ошибка при выполнении запроса:
{
"error":"string",
"error_description":"string"
}
355
Параметры ответа:
Параметр
Тип
Обяз.
Описание
Комментарий
cis
string
+
КМ
КМ из запроса
authenticity
boolean
+
Признак
Признак подлинности КМ на
подлинности КМ
территории государства-члена ЕАЭС.
Возможные значения:
"true" - получен положительный
ответ о подлинности КМ;
"false" - получен отрицательный
ответ о подлинности КМ
cisStatusId
string
-
Код статуса КМ
Идентификатор статуса КМ на
территории государства-члена ЕАЭС.
Возвращается в ответе, только если
"authenticity" ("Признак подлинности
КМ") = "true". Возможные значения:
"00" - не определён;
"1" - в обороте на территории
государства-члена ЕАЭС;
"2" - не в обороте на территории
государства-члена ЕАЭС
cisStatusName
string
-
Название статуса
Наименование статуса КМ на
КМ
территории государства-члена ЕАЭС.
Возвращается в ответе, только если
"authenticity" ("Признак подлинности
КМ") = "true". Если значение
отсутствует, то указывается "Не
определён"
expireDate
string(da
-
Дата истечения
Возвращается в ответе только для
te)
срока годности
товарной группы "Молочная
продукция". Формат: yyyy-MM-dd
registered
boolean
-
Признак наличия
Возвращается в ответе, только если
КМ в ГИС МТ
"authenticity" ("Признак подлинности
КМ") = "true". Возможные значения:
"true" - КМ зарегистрирован в БД
ГИС МТ;
"false" - КМ в БД ГИС МТ не найден
cisStatus
string
-
Статус КМ в ГИС
Возвращается в ответе, только если
МТ
"authenticity" ("Признак подлинности
КМ") = "true". См. справочник
"Актуальные статусы"
356
Параметр
Тип
Обяз.
Описание
Комментарий
emissionType
string
-
Тип эмиссии КМ
Возвращается в ответе, только если
в ГИС МТ
"authenticity" ("Признак подлинности
КМ") = "true". См. "Справочник
"Типы эмиссии КИ""
statusEx
string
-
Дополнительный
Возвращается в ответе, только если
статус товара в
"authenticity" ("Признак подлинности
ГИС МТ
КМ") = "true". См. справочник
"Актуальные особые состояния"
gtin
string
-
Код товара
Возвращается в ответе, только если
"authenticity" ("Признак подлинности
КМ") = "true"
productName
string
-
Наименование
Возвращается в ответе, только если
товара
"authenticity" ("Признак подлинности
КМ") = "true"
brand
string
-
Бренд
Возвращается в ответе, только если
"authenticity" ("Признак подлинности
КМ") = "true"
tnvedGroup
string
-
Код товарной
Возвращается в ответе, только если
позиции ТН ВЭД
"authenticity" ("Признак подлинности
ЕАЭС товара
КМ") = "true"
(первые 4 цифры)
babyFoodProduct
string
-
Продукция для
Возвращается в ответе только для
детского питания
товарной группы "Молочная
продукция" и если "authenticity"
("Признак подлинности КМ") = "true"
milkProductType
string
-
Тип продукта
Возвращается в ответе только для
товарной группы "Молочная
продукция" и если "authenticity"
("Признак подлинности КМ") = "true"
rawOrigin
string
-
Происхождение
Возвращается в ответе только для
сырья
товарной группы "Молочная
продукция" и если "authenticity"
("Признак подлинности КМ") = "true"
structure
string
-
Состав
Возвращается в ответе только для
товарной группы "Молочная
продукция" и если "authenticity"
("Признак подлинности КМ") = "true"
vetisId
string
-
Идентификатор
Возвращается в ответе только для
товара в ФГИС
товарной группы "Молочная
"ВетИС"
продукция" и если "authenticity"
("Признак подлинности КМ") = "true"
357
Параметр
Тип
Обяз.
Описание
Комментарий
volumeWeight
string
-
Заявленный
Возвращается в ответе только для
объём/вес нетто
товарной группы "Молочная
продукция" и если "authenticity"
("Признак подлинности КМ") = "true"
fat
string
-
Жирность, %
Возвращается в ответе только для
товарной группы "Молочная
продукция" и если "authenticity"
("Признак подлинности КМ") = "true"
Специфичные параметры в ответе возвращаются только для товарной группы "Молочная
продукция". Специфичные параметры для товарных групп "Обувные товары", "Предметы
одежды, бельё постельное, столовое, туалетное и кухонное", "Шины и покрышки
пневматические резиновые новые" в ответе не возвращаются.
5.2. Метод получения истории движения КИ
Метод возвращает информацию о движении (истории) запрашиваемых КИ (в одном запросе
указывается один КИ) по событиям, в которых участник оборота товаров принимал участие, чей
токен используется при выполнении запроса.
Каждый участник оборота товаров видит производителя продукции, своего продавца и текущего
владельца. Если данных УОТ, сформировавшего запрос, нет в цепочке движения, то
возвращается только производитель и текущий владелец. Если КИ выведен из оборота, то
вместо текущего владельца возвращается соответствующая информация.
Тип приватности:
1. Приватный;
2. Для производителей продукции;
3. Для покупателей продукции;
4. Для Оператора;
5. Для ФОИВ;
6. Для Администратора.
URL: /cises/history
Метод: POST
Пример запроса:
curl -X POST "<url стенда>/cises/history?cis=0104600266012258215n4Jh5D"
-H "accept: */*"
-H "Authorization: Bearer <ТОКЕН>"
Параметры запроса:
358
Параметр
Тип
Обяз.
Описание
cis
string
+
Код идентификации
Пример ответа:
1. В случае успеха:
[
{
"cis":"string",
"gtin":"string",
"packageType":"string",
"ownerInn":"string",
"status":"string",
"maxRetailPrice":0,
"child":[
"string"
],
"parent":"string",
"producerInn":"string",
"timestamp":"2020-09-28T17:17:45.389Z",
"operationDate":"2020-09-28T17:17:45.389Z",
"emissionDate":"2020-09-28T17:17:45.389Z",
"lastDocId":"string",
"productGroup":"string",
"turnoverType":"string",
"partialSaleInfo":"string"
{
"innerUnitCount":0,
"soldUnitCount":0,
"rest":0,
"correctRest":true
}
}
]
Параметры ответа:
Параметр
Тип
Обяз.
Описание
Комментарий
cis
string
+
КИ ГИС МТ
gtin
string
+
Код товара
Если код товара менее 14 символов,
то он дополняется ведущими нулями
packageType
string
+
Код типа
Тип упаковки. см. "Справочник
упаковки
"Типы упаковки""
ownerInn
string
-
ИНН
собственника
товара
359
Параметр
Тип
Обяз.
Описание
Комментарий
status
string
+
Код статуса КИ
см. "Справочник "Статусы КИ""
maxRetailPrice
number
-
Максимальная
только для пачки и блока. Для блока
цена розничной
значение =
продажи
maxRetailPrice*количество штук в
блоке
child
array
-
Список дочерних
[string]
КИ в агрегате
parent
string
-
Родительский КИ
producerInn
string
-
ИНН Российского
производителя в
МОТП
timestamp
string
-
Отметка времени
Возвращается в формате yyyy-MM-
(date-
ddTHH:mm:ss.SSS’Z
time)
emissionDate
string
-
Дата эмиссии
Возвращается в формате yyyy-MM-
(date-
ddTHH:mm:ss.SSS’Z
time)
operationDate
string
-
Дата создания
Возвращается в формате yyyy-MM-
(date-
документа, по
ddTHH:mm:ss.SSS’Z
time)
которому в
последний раз
менялся статус
КИ
lastDocId
string
-
Номер документа,
Для ТГ "Табачная продукция" =
по которому в
"docId", для остальных ТГ =
последний раз
"lastDocId"
менялся статус
КИ
partialSaleInfo
object
-
Набор параметров
Возвращается для ТГ
частичного
"Альтернативная табачная
выбытия
продукция" и "Духи и туалетная
вода"
*innerUnitCount
number
-
Общее
количество или
объём товара в
потребительской
упаковке, шт
*soldUnitCount
number
-
Количество или
объём
выведенного из
оборота товара по
КИ, шт
360
Параметр
Тип
Обяз.
Описание
Комментарий
*rest
number
-
Количество или
объём товара,
доступного к
выводу из
оборота по КИ,
шт
*correctRest
boolean
-
Корректность
остатка товара
(показатель
корректности
остатка товара
после вывода
товара из
оборота)
productGroup
string
+
Товарная группа
См. "Справочник "Список
поддерживаемых товарных групп""
docId
string
-
Номер документа,
Для ТГ "Табачная продукция" =
по которому в
"docId", для остальных ТГ =
последний раз
"lastDocId"
менялся статус
КИ
turnoverType
string
-
Код типа отгрузки
Возможные значения:
SELLING - продажа;
COMMISSION - комиссия;
AGENT - агент
Если какой-либо параметр не возвращается или приходит пустым, в параметре отображается
значение "null".
2.В случае ошибок:
2.1 Код 401 В случае, когда указан устаревший токен:
<InvalidTokenException>
<error>invalid_token</error>
<error_description>Access token expired:
eyJhbGciOi...zSPUg</error_description>
</InvalidTokenException>
2.2 Код 404 Если указанный КИ не найден:
{
"error_message": "КМ не найдены"
}
2.3 Код 400 При неправильном формате КИ в URL:
361
{
"error_message": "Неверный формат КМ"
}
2.4 Код 400 Если используется КИ из другой ТГ
{
"error_message": "КМ принадлежит ТГ отличной от МОТП"
}
5.2.1. Метод получения карточки товара по КИ
Метод возвращает информацию о запрашиваемом товаре (в одном запросе указывается "cis"
("КИ") одной единицы товара). КИ должен быть в статусе INTRODUCED. Cпецсимволы КИ,
указанных в параметрах тела запроса, необходимо экранировать.
Тип приватности:
1. публичный;
2. без токена (для ТГ "Табачная продукция" и "Альтернативная табачная продукция" в связи с
расширением общедоступной информации).
URL: /products/info
Метод: GET
curl -X GET "<url стенда>/products/info?cis=%2801%2900000046075710%2821%29aaqlpoz"
-H "accept: application/json"
-H "Authorization: Bearer <ТОКЕН>"
Параметры запроса:
Параметр
Тип
Обяз.
Описание
Комментарий
cis
string
+
КИ
childrenPage
number
-
Номер страницы
Значение по умолчанию: 1. Не
вложений в
используется товарной группой
агрегат первого
"Табачная продукция"
слоя
childrenLimit
number
-
Размер страницы
Значение по умолчанию: 50. Не
вложений в
используется товарной группой
агрегат первого
"Табачная продукция"
слоя
Пример ответа:
1. В случае успеха:
362
1.1. Товарные группы "Табачная продукция" и "Альтернативная табачная продукция":
{
"results": [
{
"id": 4,
"name": "Сигареты с фильтром \"X\" mrp v2",
"gtin": "00000046075710",
"packageType": "PA",
"innerUnitCount": 20,
"inn": "1234567890",
"productGroup": 3
}
],
"total": 1
}
1.2. Другие товарные группы:
{
"cis": "string",
"gtin": "string",
"sgtin": "string",
"tnvd": "string",
"tnvedGroup": "string",
"productName": "string",
"producerName": "string",
"producerInn": "string",
"ownerName": "string",
"ownerInn": "string",
"agentName": "string",
"agentInn": "string",
"previousAgentName": "string",
"previousAgentInn": "string",
"turnoverType": "SELLING",
"statusEx": "EMPTY",
"docNum": "string",
"emissionDate": 0,
"producedDate": 0,
"introducedDate": 0,
"emissionType": "string",
"prodOrderType": "SELF_MADE",
"lastDocId": "string",
"name": "string",
"brand": "string",
"model": "string",
"certDoc": {
"type": "string",
"number": "string",
"date": "string"
363
},
"prevCises": [
"string"
],
"nextCises": [
"string"
],
"status": "EMITTED",
"remarks": [
{
"curr": "string",
"prev": "string",
"date": "string"
}
],
"cisChildren": [
"string"
],
"children": [
{
"cis": "string",
"gtin": "string",
"producerName": "string",
"status": "EMITTED",
"emissionDate": 0,
"producedDate": 0,
"packageType": "UNIT",
"ownerName": "string",
"ownerInn": "string",
"productName": "string",
"brand": "string",
"prevCises": [
"string"
],
"nextCises": [
"string"
],
"statusEx": "EMPTY",
"children": [
"string"
],
"childrenMap": {},
"countChildren": 0,
"parent": "string",
"lastDocId": "string",
"expireDate": 0,
"prVetDocument": "string",
"introducedDate": 0,
"exporterName": "string",
"exporterTaxpayerId": "string",
"agentName": "string",
364
"agentInn": "string",
"lastStatusChangeDate": 0,
"turnoverType": "SELLING",
"productGroup": "string"
}
],
"childrenDetails": [
null
],
"countChildren": 0,
"uitu": "string",
"parent": "string",
"packType": "UNIT",
"withdrawReason": "string",
"receiptDate": 0,
"expireDate": 0,
"prVetDocument": "string",
"exporterName": "string",
"exporterTaxpayerId": "string",
"certificateType": "CONFORMITY_CERTIFICATE",
"certificateNumber": "string",
"certificateDate": "string",
"productGroup": "string"
}
2.В случае ошибок:
2.1. Код 404, если не найден товар с указанным КИ:
{
"error_message":"Продукт не найден"
}
2.2 Код 400 при некорректном формате КИ в URL:
{
"error_message":"Неизвестный GTIN"
}
Параметры ответа для товарных групп "Табачная продукция" и "Альтернативная
табачная продукция":
Параметр
Тип
Обяз.
Описание
Комментарий
results
array
+
Результат запроса
*id
number
+
Идентификатор
*name
string
-
Наименование
товара
365
Параметр
Тип
Обяз.
Описание
Комментарий
*gtin
string
+
Код товара
*packageType
string
+
Тип упаковки
См. "Справочник "Типы упаковки""
*innerUnitCount
number
+
Число
экземпляров
товара
*inn
string
-
ИНН
*productGroup
integer
-
Товарная группа
См. "Справочник "Список
поддерживаемых товарных групп""
total
number
+
Количество
найденных
товаров
errorCode
string
-
Код ошибки
Параметр указывается при наличии
ошибки
Параметры ответа для других товарных групп:
Параметр
Тип
Обяз.
Описание
cis
string
+
Код идентификации, используемый для
фильтрации по списку КИ
gtin
string
-
Код товара
sgtin
string
-
Индивидуальный идентификационный код
потребительской упаковки для
прослеживаемости в (код товара +
индивидуальный серийный номер вторичной
(потребительской) упаковки или первичной
упаковки, в случае отсутствия вторичной)
tnvd
string
-
Код товарной номенклатуры (10 знаков)
tnvedGroup
string
-
Код товарной позиции ТН ВЭД ЕАЭС товара
(первые 4 символа)
producerName
string
-
Производитель товара
productName
string
-
Название продукта
producerInn
string
-
ИНН производителя/импортёра товара
ownerInn
string
-
ИНН владельца товара
ownerName
string
-
Наименование владельца товара
agentInn
string
-
ИНН текущего владельца товара
agentName
string
-
Наименование текущего владельца товара
previousAgentInn
string
-
ИНН предыдущего владельца товара
previousAgentName
string
-
Наименование предыдущего владельца товара
366
Параметр
Тип
Обяз.
Описание
turnoverType
enum
-
Вид товарооборота:
SELLING - продажа;
COMMISSION - комиссия;
AGENT - агент
statusEx
enum
-
Актуальные особые состояния КИ см.
"Справочник "Статусы КИ""
docNum
string
-
Регистрационный номер документа
emissionDate
string
+
Дата эмиссии КИ. Возвращается в формате
(date-
yyyy-MM-ddTHH:mm:ss.SSS’Z
time)
producedDate
string
-
Дата нанесения. Возвращается в формате yyyy-
(date-
MM-ddTHH:mm:ss.SSS’Z
time)
introducedDate
string
-
Дата ввода в оборот. Возвращается в формате
(date-
yyyy-MM-ddTHH:mm:ss.SSS’Z
time)
emissionType
string
-
Тип эмиссии:
LOCAL - производство РФ;
FOREIGN - ввезен в РФ;
REMAINS - маркировка остатков;
CROSSBORDER - ввезен из стран ЕАЭС.
См."Справочник "Типы эмиссии КИ""
prodOrderType
enum
-
Тип производственного заказа:
SELF_MADE - собственное производство;
OPERATOR
- производство товара по
договору
lastDocId
string
-
Последний регистрационный номер документа,
зафиксированный в ГИС МТ по этому КИ
name
string
-
Наименование товара
brand
string
-
Бренд
model
string
-
Модель
certDoc
-
Сертификат
*date
string
-
Дата сертификата. Задается в формате yyyy-
MM-ddTHH:mm:ss.SSS’Z
*number
string
-
Номер сертификата
*type
string
-
Тип сертификата
*wellNumber
string
-
Номер скважины. Указывается только для
товарной группы "Упакованная вода"
prevCises
[string]
-
Предыдущие номера КИ при перемаркировке
367
Параметр
Тип
Обяз.
Описание
nextCises
[string]
-
Следующие номера КИ при перемаркировке
status
enum
+
Статус КИ. Возможные значения:
EMITTED - эмитирован. Выпущен;
APPLIED - эмитирован. Получен;
INTRODUCED - в обороте;
WRITTEN_OFF - списан;
RETIRED - выбыл;
DISAGGREGATION - расформирован (только
для упаковок);
WITHDRAWN - выбыл, только для ТГ
"Табачная продукция
Для перемаркированного КИ возможное
значение "WRITTEN_OFF" (Списан)
remarks
-
Список перемаркировок данного товара
*curr
string
-
Текущий КИ товара
*date
string
-
Дата перемаркировки. Задается в формате
yyyy-MM-ddTHH:mm:ss.SSS’Z
*prev
string
-
Предыдущие КИ товара
cisChildren
[string]
-
Список дочерних КИ
children:
array
-
КИ в агрегате
*cis
string
+
КИ товара
*gtin
string
-
Код товара
*producerName
string
-
Производитель товара
*status
enum
+
Статус товара/КИ:
EMITTED - эмитирован. Выпущен;
APPLIED - эмитирован. Получен;
INTRODUCED - в обороте;
WRITTEN_OFF - КИ списан;
RETIRED - выбыл;
DISAGGREGATION - расформирован (только
для упаковок);
WITHDRAWN
- выбыл, только для ТГ
"Табачная продукция
*emissionDate
string
+
Дата эмиссии. Возвращается в формате yyyy-
(date-
MM-ddTHH:mm:ss.SSS’Z
time)
*producedDate
string
-
Дата ввода товара с КИ в оборот. Возвращается
(date-
в формате yyyy-MM-ddTHH:mm:ss.SSS’Z
time)
*packageType
string
+
Тип упаковки. "Справочник "Типы упаковки""
368
Параметр
Тип
Обяз.
Описание
*ownerInn
string
-
ИНН владельца товара
*ownerName
string
-
Наименование владельца товара
*productName
string
-
Наименование товара на этикетке
*brand
string
-
Бренд
*nextCises
[string]
-
Следующие номера КИ при перемаркировке
*prevCises
string
-
Предыдущие номера КИ
*statusEx
enum
-
Актуальные особые состояния КИ см.
"Справочник "Статусы КИ""
*children:
[string]
-
Все КИ в агрегате. В формате массива JSON
*childrenMap
[string]
-
Краткая информация о дочерних КИ
*countChildren
integer
-
Количество дочерних КИ
*parent
string
-
Код идентификации упаковки, в которую
агрегирован товар
*lastDocId
string
-
Последний регистрационный номер документа,
зафиксированный в ГИС МТ по этому КИ
*expireDate
string
-
Дата истечения срока годности. Возвращается
(date-
в формате yyyy-MM-ddTHH:mm:ss.SSS’Z
time)
(обязательный для ТГ "Молочная продукция")
*prVetDocument
string
-
Производственный ветеринарный
сопроводительный документ (обязательный
для ТГ "Молочная продукция")
*introducedDate
string
-
Дата ввода в оборот с КИ в оборот.
(date-
Возвращается в формате yyyy-MM-
time)
ddTHH:mm:ss.SSS’Z
*exporterName
string
-
Наименование экспортера
*exporterTaxpayerId
string
-
Уникальный идентификатор экспортера в
национальной системе учета
налогоплательщиков
*agentName
string
-
ИНН текущего владельца товара
*agentInn
string
-
Наименование текущего владельца товара
*lastStatusChangeDate
string
+
Дата последнего изменения статуса.
(date-
Возвращается в формате yyyy-MM-
time)
ddTHH:mm:ss.SSS’Z
*turnoverType
string
-
Код типа отгрузки:
SELLING - продажа;
COMMISSION - комиссия;
AGENT - агент
369
Параметр
Тип
Обяз.
Описание
*productGroup
string
+
Товарная группа. см. "Справочник "Список
поддерживаемых товарных групп""
childrenDetails
[array]
-
Маркированный товар
countChildren
integer
-
Количество дочерних КИ
(int32)
uitu
string
-
КИТУ вышестоящего уровня
parent
string
-
Код идентификации упаковки, в которую
агрегирован товар
packType
string
+
Тип упаковки. "Справочник "Типы упаковки""
370
Параметр
Тип
Обяз.
Описание
withdrawReason
string
-
Причина вывода из оборота:
KM_SPOILED - испорчен;
KM_LOST - утерян;
KM_DESTROYED - уничтожен;
DESCRIPTION_ERRORS - выявлены ошибки
описания товара;
RETAIL - розничная реализация;
EEC_EXPORT - экспорт в страны ЕАЭС;
BEYOND_EEC_EXPORT - экспорт за пределы
стран ЕАЭС;
RETURN - возврат физическому лицу;
REMOTE_SALE
- продажа по образцам,
дистанционный способ продажи;
DAMAGE_LOSS - утрата или повреждение;
DESTRUCTION
-
утилизация
или
уничтожение;
CONFISCATION - конфискация;
LIQUIDATION - ликвидация предприятия;
DONATION - безвозмездная передача;
STATE_ENTERPRISE
-
приобретение
государственным предприятием;
NO_RETAIL_USE
- использование для
собственных нужд покупателем;
ENTERPRISE_USE
- использование для
собственных нужд предприятия;
KM_SPOILED_OR_LOST
- испорчен либо
утерян СИ с КИ;
KM_CANCELLATION
- аннулирование не
преобразованных в СИ с КИ по истечении
срока;
KM_CANCELLATION_BY_TERM
-
аннулирование не преобразованных в СИ с КИ
по истечении срока;
RETAIL_RETURN
- возврат товаров с
поврежденным СИ/без СИ при розничной
реализации;
REMOTE_SALE_RETURN - возврат товаров с
поврежденным СИ/без СИ при дистанционном
способе продажи
receiptDate
string
-
Дата вывода из оборота. Возвращается в
(date-
формате yyyy-MM-ddTHH:mm:ss.SSS’Z
time)
expireDate
string
-
Дата истечения срока годности. Возвращается
(date-
в формате yyyy-MM-ddTHH:mm:ss.SSS’Z
time)
(обязательный для ТГ "Молочная продукция")
prVetDocument
string
-
Производственный ветеринарный
сопроводительный документ (обязательный
для ТГ "Молочная продукция")
371
Параметр
Тип
Обяз.
Описание
exporterName
string
-
Наименование экспортера
exporterTaxpayerId
string
-
Уникальный идентификатор экспортера в
национальной системе учета
налогоплательщиков
certificateType
string
-
Вид
документа,
подтверждающего
соответствие:
CONFORMITY_CERTIFICATE
- сертификат
соответствия;
CONFORMITY_DECLARATION - декларация
соответствия;
CONFORMITY_CERTIFICATE_OR_DECLAR
ATION
-
сертификат или декларация
соответствия
certificateNumber
string
-
Номер документа, подтверждающего
соответствие
certificateDate
string
-
Дата документа, подтверждающего
(date-
соответствие. Возвращается в формате yyyy-
time)
MM-ddTHH:mm:ss.SSS’Z
productGroup
string
+
Товарная группа. см. "Справочник "Список
поддерживаемых товарных групп""
color
string
-
Цвет. Обязателен для ТГ "Обувные товары"
productSize
string
-
Размер. Обязателен для ТГ "Обувные товары"
5.2.2. Получение вложенной структуры агрегированных КИ
5.2.2.1. Запрос списка агрегированных КИ (GET)
Метод возвращает дочерние КИ первого слоя агрегата. В одном запросе можно указать
несколько КИ. КИ для блоков (ТГ "Табачная продукция") можно указывать в запросе как со
скобками, так и без скобок. В ответе КИ всегда будет возвращаться со скобками. Запятая не
интерпретируется как разделитель для параметров запроса, а считается частью самого
параметра. Метод возвращает все слои для агрегата ТГ "Табачная продукция". Для блока (ТГ
"Табачная продукция") метод возвращает все пачки, для коробки - все блоки.
Тип приватности: публичный
Общедоступная информация:
• информация о КИ;
• данные о производителе;
• дата и время производства;
• текущий статус в обороте;
• текущий владелец
- информация доступна только владельцу, ФОИВ, Оператору и
Администратору.
372
URL: /cises/aggregated/list
Метод: GET
Пример запроса:
curl -X GET "<url
стенда>/cises/aggregated/list?childrenPage=2&childrenLimit=5&pg=3&codes=%2801%29000000
46075710%2821%29XZXxNKE&codes=%2801%2900000046075710%2821%29abaivho&codes=%2801%290000
0046075710%2821%29abjhtjg"
-H "accept: */*"
-H "Content-Type: application/json"
-H "Authorization: Bearer <ТОКЕН>"
Параметры запроса:
Параметр
Тип
Обяз.
Описание
Комментарий
codes
[string]
+
Массив КИ
Длина массива - от 1 до 1000 КИ
(без/с криптохвостом, криптохвост
перед обработкой удаляется) КИ в
списке перечисляются в формате
<URL>?codes=<КМ1>[&codes=<КМ
N>]
pg
string
-
Товарная группа
Параметр обязательно указывать для
товарных групп:
milk - "Молочная продукция";
water - "Упакованная вода"
Параметры ответа:
Параметр
Тип
Обяз.
Описание
cis
[string]
+
Список массивов КИ в агрегате при наличии
агрегата
Пример ответа:
1. В случае успеха:
373
{
"(01)00000046075710(21)abjhtjg": {
"00000046075710zpaptvb": [],
"00000046075710pwegzwm": [],
"00000046075710ildnswl": [],
"00000046075710ytqzpvf": [],
"00000046075710szrzjdf": [],
"00000046075710medhjjj": [],
"00000046075710qgmkhml": [],
"00000046075710cuebkgo": [],
"00000046075710xzjlkei": [],
"00000046075710wissylh": []
},
"(01)00000046075710(21)XZXxNKE": {
"000000460757109z5bdlp": [],
"00000046075710KhDTqgx": [],
"00000046075710hW89Sii": [],
"00000046075710hD4pw2D": [],
"00000046075710K0K7g2l": [],
"000000460757102lhyRic": [],
"00000046075710XLthjth": [],
"00000046075710vMsHRrU": [],
"0000004607571059Y7HHI": [],
"00000046075710yjACGvT": []
},
"(01)00000046075710(21)abaivho": {
"00000046075710gpxxads": [],
"00000046075710cgujmiu": [],
"00000046075710zwultyq": [],
"00000046075710osrfrdy": [],
"00000046075710lhttiwo": [],
"00000046075710hzsihcu": [],
"00000046075710qttrevg": [],
"00000046075710dvpuxvh": [],
"00000046075710fufsrkq": [],
"00000046075710jhigpty": []
}
}
2.В случае ошибок:
2.1. Код 401, если не указан токен:
<UnauthorizedException>
<error>unauthorized</error>
<error_description>Full authentication is required to access this
resource</error_description>
</UnauthorizedException>
374
2.2. Код 404 при неизвестных КИ:
{
"error_message":"КМ не найдены"
}
2.3. Код 400, если не указан обязательный параметр "codes":
{
"error_message":"Отсутствует обязательный параметр: codes"
}
2.4. Код 403 при не подписанном договоре:
{
"error_message":"отсутствует действующий договор по ТГ"
}
5.2.2.2. Запрос списка агрегированных КИ (POST)
Метод возвращает дочерние КИ первого слоя агрегата. В одном запросе можно указать
несколько КИ. КИ для блоков (ТГ "Табачная продукция") можно указывать в запросе как со
скобками, так и без скобок. В ответе КИ всегда будет возвращаться со скобками. Запятая не
интерпретируется как разделитель для параметров запроса, а считается частью самого
параметра. Метод возвращает все слои для агрегата ТГ "Табачная продукция". Для блока (ТГ
"Табачная продукция") метод возвращает все пачки, для коробки - все блоки.
Тип приватности: публичный
Общедоступная информация:
• информация о КИ;
• данные о производителе;
• дата и время производства;
• текущий статус в обороте;
• текущий владелец - показ только владельцу, ФОИВ, Оператору-ЦРПТ и Администратору.
URL: /cises/aggregated/list
Получение дочерних КИ возможно следующими запросами:
Метод: POST
Пример запроса:
375
curl -X POST "<url стенда>/cises/aggregated/list?childrenPage=2&childrenLimit=5&pg=3"
-H "Authorization: Bearer <ТОКЕН>"
-H "accept: */*"
-H "Content-Type: application/json"
Параметры запроса:
Параметр
Тип
Обяз.
Описание
Комментарий
pg
string
-
Товарная группа
Параметр обязательно указывать для
товарных групп:
milk - "Молочная продукция";
water - "Упакованная вода"
Параметры ответа:
Параметр
Тип
Обяз.
Описание
cis
[string]
+
Список массивов КИ в агрегате при наличии
агрегата
Примечание: При отсутствии вложений в агрегате, в ответе возвращается пустой массив КИ в
квадратных скобках "[]".
Пример ответа:
1.В случае успеха:
376
{
"(01)00000046075710(21)abjhtjg": {
"00000046075710zpaptvb": [],
"00000046075710pwegzwm": [],
"00000046075710ildnswl": [],
"00000046075710ytqzpvf": [],
"00000046075710szrzjdf": [],
"00000046075710medhjjj": [],
"00000046075710qgmkhml": [],
"00000046075710cuebkgo": [],
"00000046075710xzjlkei": [],
"00000046075710wissylh": []
},
"(01)00000046075710(21)XZXxNKE": {
"000000460757109z5bdlp": [],
"00000046075710KhDTqgx": [],
"00000046075710hW89Sii": [],
"00000046075710hD4pw2D": [],
"00000046075710K0K7g2l": [],
"000000460757102lhyRic": [],
"00000046075710XLthjth": [],
"00000046075710vMsHRrU": [],
"0000004607571059Y7HHI": [],
"00000046075710yjACGvT": []
},
"(01)00000046075710(21)abaivho": {
"00000046075710gpxxads": [],
"00000046075710cgujmiu": [],
"00000046075710zwultyq": [],
"00000046075710osrfrdy": [],
"00000046075710lhttiwo": [],
"00000046075710hzsihcu": [],
"00000046075710qttrevg": [],
"00000046075710dvpuxvh": [],
"00000046075710fufsrkq": [],
"00000046075710jhigpty": []
}
}
2.В случае ошибок:
2.1. Код 401, если не указан токен:
<UnauthorizedException>
<error>unauthorized</error>
<error_description>Full authentication is required to access this
resource</error_description>
</UnauthorizedException>
377
2.2. Код 404 при неизвестных КИ:
{
"error_message":"КМ не найдены"
}
2.3. Код 400 при пустом списке КИ в теле запроса:
{
"error_message":"В запросе не указан ни один КИ"
}
2.4. Код 400 при отсутствии тела запроса:
{
"error_message":"Required request body is missing: public
org.springframework.http.ResponseEntity
ru.crpt.trueapi.controller.motp.CisesController.getCisesInfoByCodeList(java.util.List<
java.lang.string>)"
}
2.5. Код 400 при некорректной структуре 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]"
}
2.6. Код 403 при не подписанном договоре:
{
"error_message":"отсутствует действующий договор по ТГ"
}
5.3. Метод истории агрегирования кода идентификации
Метод предназначен для получения истории дезагрегации агрегатов по КИ всех товарных групп.
Ограничение по количеству указываемых в запросе КИ: 1.
Проверка принадлежности по владельцу КИ, агрегатов не осуществляется. В ответе
возвращается только прямой КИ агрегата, без вложенности второго, третьего уровня.
Вложенность по агрегированным КИ не выводится.
378
Тип приватности: общедоступный, только по авторизованному токену
URL: /cises/history/list
Метод: POST
Пример строки запроса:
curl -X POST "<url стенда>/cises/history/list"
-H "accept: */*"
-H "Authorization: Bearer <ТОКЕН>"
-H "Content-Type: application/json"
Пример тела запроса:
{
"cis": "(01)00000011111111(21)NN88nNN"
}
Параметры тела запроса:
Параметр
Тип
Обяз.
Описание
Комментарий
cis
string
+
КИ
Не более 1 КИ единицы товара,
групповой упаковки, комплекта,
набора, агрегата, АТК
Пример ответа:
{
"cisAggregation": [
{
"cis": "(01)00000011111111(21)NN88nNN",
"operationType": "AGGREGATION",
"packageType": LEVEL1,
"parent": "00000046212102vvVvv66VVvvvvVVV66vvvVvv"
},
{
"cis": "(01)00000011111111(21)NN88nNN",
"operationType": "AUTODISAGGREGATION",
"operationDate": "2021-08-10T10:11:01.000Z",
"packageType": LEVEL1,
"parent": "00000046212102vvVvv66VVvvvvVVV66vvvVvv"
}
]
}
Параметры ответа:
379
Параметр
Обяз.
Тип
Описание
Комментарий
cisAggregation
+
array
Список,
содержащий
историю
агрегации КИ
*cis
+
string
КИ
*operationType
+
int
Тип операции
Возможные значения:
AGGREGATION - сформирован;
DISAGGREGATION -
расформирован;
AUTODISAGGREGATED -
автоматически расформирован
*operationDate
+
string
Дата и время
Возвращается в формате yyyy-MM-dd
операции
HH:mm:ss
*packageType
-
string
Тип упаковки
См. "Справочник "Типы упаковки""
*extendedPackage
-
string
Тип агрегата
См. "Справочник "Типы упаковки""
Type
*parent
+
string
КИ агрегата, в
который
агрегирован
данный КИ
5.4. Метод получения списка десятизначных кодов ТН ВЭД
Не используется ТГ "Табачная продукция" и "Альтернативная табачная продукция".
В результате успешного выполнения запроса на получение списка кодов ТН ВЭД с указанием
массива префиксов ТН ВЭД и параметров пагинации в ответе возвращается массив информации
об удовлетворяющих запросу кодах ТН ВЭД и общее число элементов данного массива.
URL: /facade/tnved/search
Метод: GET
Тип приватности: приватный
Пример запроса:
curl -X GET "<url
стенда>/facade/tnved/search?prefix=2401%2C%202402%2C%202403&limit=20&offset=0"
-H "Authorization: Bearer <ТОКЕН>"
-H "accept: application/json"
Параметры запроса:
380
Параметр
Тип
Обяз.
Описание
prefix
string
+
Список товарных позиций, с одного из
которых должны начинаться искомые
коды ТН ВЭД. Используется для
фильтрации товарной группы
limit
integer
+
Значение устанавливает количество
записей в ответе (не более 10000 записей)
offset
string
+
Смещение относительно начала списка.
Значение по умолчанию = 0. При значении
"offset" = 0 метод возвращает корректный
ответ
Пример ответа:
{
"records":[
{
"code":"1234567890",
"description":"ТАБАК И ПРОМЫШЛЕННЫЕ ЗАМЕНИТЕЛИ ТАБАКА. ТАБАЧНОЕ СЫРЬЕ;
ТАБАЧНЫЕ ОТХОДЫ. - - светлый табак теневой сушки"
}
],
"total":1
}
Параметры ответа:
Параметр
Тип
Обяз.
Описание
records
[array]
+
Описание кода ТН ВЭД
*code
string
+
10-ти значный код ТН ВЭД
*description
string
+
Текстовое описание кода ТН ВЭД
total
integer (int64)
+
Общее количество кодов ТН ВЭД,
подходящие под параметры фильтрации
5.5. Получение информации о карточках товара УОТ
5.5.1. Метод получения информации о товаре по GTIN товара
В результате успешного выполнения запроса по списку кодов товаров в ответе возвращается
массив с информацией о товарах по запрошенным КИ. В результирующем * .json также может
содержаться набор полей, специфичных для товара конкретной товарной группы (см.
"Справочник "Дополнительные параметры в ответе в зависимости от товарных групп"").
Тип приватности: приватный
URL: /product/info
381
Метод: GET
Пример запроса:
curl -X GET "<url стенда
v3>/product/info?gtins=00000000000001,00000000000002&includeSubaccount=true"
-H "accept: application/json"
-H "Authorization: Bearer <ТОКЕН>"
Параметры запроса:
Параметр
Тип
Обяз.
Описание
Комментарий
gtins
[string]
+
Массив кодов
Формат кода товара: 14 цифр (с
товаров
лидирующими нулями). Количество
указываемых кодов товаров ограничено
длиной URL
includeSubac
boolean
-
Признак
Если значение = true, то в ответе
count
субаккаунта
возвращаются данные по всем кодам
товаров и принадлежащим участнику и
предоставленным ему через суббакаунт.
Если значение = false, то в ответе
возвращаются данные только по кодам
товаров, принадлежащим участнику.
Значение по умолчанию = false
pg
string
-
Товарная группа
Параметр обязательно указывать для
товарных групп:
milk - "Молочная продукция";
water - "Упакованная вода"
Пример ответа:
1. В случае успеха:
{
"results": [
{
"id": 0,
"name": "string",
"gtin": "string",
"brand": "string",
"packageType": "string",
"innerUnitCount": 0,
"model": "string",
"publicationDate": "2021-08-13T11:41:15.809Z",
"inn": "string",
"permittedInns": [
"string"
],
"productGroupId": 0,
382
"productGroup": "string",
"goodSignedFlag": true,
"goodMarkFlag": true,
"goodTurnFlag": true,
"excisableGoodsType": "string",
"declarations": [
{
"regulationNumber": "string",
"name": "string",
"declarant": "string",
"declarationScheme": "string",
"registrationAuthority": "string",
"number": "string",
"issueDate": "string",
"validityDate": "string",
"status": "string"
}
],
"fa": "string",
"tnved": "string",
"tnved10": "string",
"okpd2": "string",
"isKit": true,
"isTechGtin": true,
"isSet": true,
"level": "string",
"mainGtin": "string",
"multiplier": 0,
"isDeleted": true,
"goodStatus": "string",
"isGtinSubaccount": true,
"setGtin": [
{
"gtin": "string",
"quantity": 0
}
]
}
],
"total": 0,
"errorCode": "string"
}
Параметры ответа:
Параметр
Тип
Обяз.
Описание
Комментарий
results
array
+
Массив с
информацией о
товарах по
запрошенным КИ
383
Параметр
Тип
Обяз.
Описание
Комментарий
*id
integer
+
ID товара
*name
string
+
Наименование
товара
*gtin
string
+
Код товара, по
Формат кода товара: 14 цифр (с
которому
лидирующими нулями). Количество
выполняется
возвращаемых кодов товаров в ответе не
запрос
может быть больше числа запрошенных
*isGtinSubac
boolean
-
Признак
Если значение = true - субаккаунту был
count
принадлежности
предоставлен доступ к этому коду товара.
кода товара
Если значение = false - код товара
субаккаунту
собственный
*brand
string
+
Бренд
*packageType
string
+
Тип упаковки
В ответе возвращаются виды упаковок,
которые приведены в справочнике "Типы
упаковок" (См. "Справочник "Типы
упаковки""), так же в ответе могут
возвращаться типы упаковок из карточки
товара НК
*innerUnitCo
integer
+
Количество
unt
товара в упаковке
*publicationD
string
-
Дата публикации
Формат: yyyy-MM-ddTHH:mm:ss.SSS’Z
ate
(date-
кода товара
time)
*level
string
-
Уровень упаковки
Значения:
trade-unit - единица товара; inner-pack -
групповая упаковка
*multiplier
integer
-
Количество
вложений в
упаковку
*inn
string
-
ИНН
производителя
*permittedInn
[string]
-
Массив ИНН
Возвращается в ответе при условии
s
компаний-
указания сведений в карточке товара в НК.
субаккаунтов,
Параметр возвращается для владельца
которым владелец
кода товара и для Оператора
GTIN
предоставил
возможность
использовать
данный GTIN для
заказа КМ
384
Параметр
Тип
Обяз.
Описание
Комментарий
*exporter
object
-
Заявитель
маркируемого и
вводимого в
оборот товара
**id
integer
-
ID заявителя
Возвращается в ответе при условии
указания сведений в карточке товара в НК.
Возвращается обязательно при возврате
объекта "exporter" ("Заявитель
маркируемого и вводимого в оборот
товара")
**ncId
integer
-
Идентификатор
Возвращается в ответе при условии
заявителя в НК по
указания сведений в карточке товара в НК
импортным
товарам с
глобальным GTIN
**exporterNa
string
-
Наименование
Возвращается в ответе при условии
me
заявителя-
указания сведений в карточке товара в НК.
экспортёра
Возвращается обязательно при возврате
объекта "exporter" ("Заявитель
маркируемого и вводимого в оборот
товара")
**exporterTa
string
-
ИНН заявителя
Возвращается в ответе при условии
xpayerId
или его аналог
указания сведений в карточке товара в НК.
(налоговый
Возвращается обязательно при возврате
идентификатор)
объекта "exporter" ("Заявитель
маркируемого и вводимого в оборот
товара")
**kpp
string
-
КПП или его
Возвращается в ответе при условии
аналог
указания сведений в карточке товара в НК
**gcp
string
-
Глобальный
Возвращается в ответе при условии
идентификатор
указания сведений в карточке товара в НК.
компании в GS1
Возвращается обязательно при возврате
объекта "exporter" ("Заявитель
маркируемого и вводимого в оборот
товара")
**gln
string
-
Глобальный
Возвращается в ответе при условии
идентификатор
указания сведений в карточке товара в НК.
места нахождения
Возвращается обязательно при возврате
объекта "exporter" ("Заявитель
маркируемого и вводимого в оборот
товара")
385
Параметр
Тип
Обяз.
Описание
Комментарий
**manufactur
string
-
Адрес
Возвращается в ответе при условии
eAddress
производственной
указания сведений в карточке товара в НК.
площадки
Возвращается обязательно при возврате
объекта "exporter" ("Заявитель
маркируемого и вводимого в оборот
товара")
**importerAc
string
-
Ссылка на
Возвращается в ответе при условии
count
аккаунт
указания сведений в карточке товара в НК
импортёра
*foreignProdu
object
-
Объект с данными
Возвращается в ответе при условии
cer
о производителе
указания сведений в карточке товара в НК
**name
string
-
Наименование
Возвращается в ответе при условии
производителя
указания сведений в карточке товара в НК.
Возвращается обязательно при возврате
объекта "foreignProducer" ("Объект с
данными о производителе")
**inn
string
-
ИНН
Возвращается в ответе при условии
производителя
указания сведений в карточке товара в НК
или его аналог
*tnVed
string
-
Группа ТН ВЭД
Возвращается в ответе при условии
указания сведений в карточке товара в НК
**gcp
string
-
Глобальный
Возвращается в ответе при условии
идентификатор
указания сведений в карточке товара в НК
компании
производителя в
GS1
**gln
string
-
Глобальный
Возвращается в ответе при условии
идентификатор
указания сведений в карточке товара в НК
места нахождения
производителя
**address
array[stri
-
Массив адресов
Возвращается в ответе при условии
ng]
производителя
указания сведений в карточке товара в НК
*productGrou
integer
+
Идентификатор
См. "Справочник "Список
pId
товарной группы
поддерживаемых товарных групп""
*productGrou
string
-
Код товарной
См. "Справочник "Список
p
группы
поддерживаемых товарных групп""
*tnved
string
-
Группа ТН ВЭД (4
Возвращается в ответе при условии
знака)
указания сведений в карточке товара в НК
tnVed10
string
-
Код ТН ВЭД (10
Возвращается в ответе при условии
знаков)
указания сведений в карточке товара в НК
fullName
string
-
Полное
Возвращается в ответе при условии
наименование
указания сведений в карточке товара в НК
товара
386
Параметр
Тип
Обяз.
Описание
Комментарий
*goodSigned
boolean
-
Признак
Возвращается в ответе при условии
Flag
подписания
указания сведений в карточке товара в НК
карточки товара в
НК
*goodMarkFl
boolean
-
Признак
Возвращается в ответе при условии
ag
готовности к
указания сведений в карточке товара в НК
маркировке
*goodTurnFla
boolean
-
Признак
Индикатор заполнения второго слоя и
g
готовности товара
подписания карточки товара в НК. Для
к обороту
карточек товара, описанного по короткому
атрибутивному составу и карточек,
созданных по API, подпись для признака
"goodTurnFlag" не проверяется, поскольку
данные карточки товара не
подписываются. Если значение параметра
равно true, то доступен заказ КМ и ввод
товара в оборот.
Возвращается в ответе при условии
указания сведений в карточке товара в НК
*isKit
boolean
-
Признак
Возвращается в ответе при условии
"Комплект" в
указания сведений в карточке товара в НК.
карточке товара
Если в НК атрибут не заполнен, то в
ответе возвращается null
*isTechGtin
boolean
-
Признак
Возвращается в ответе при условии
"Технологический
указания сведений в карточке товара в НК.
" по карточке
Если в НК атрибут не заполнен, то в
товара
ответе возвращается null
*isSet
boolean
-
Признак "Набор"
Возвращается в ответе при условии
по карточке
указания сведений в карточке товара в НК.
товара в НК
Если в НК атрибут не заполнен, то в
ответе возвращается null
*country
string
-
Страна
Возвращается в ответе при условии
производства
указания сведений в карточке товара в НК
*fts
object
-
Данные
Возвращается в ответе при условии
полученные ГИС
указания сведений в карточке товара в НК
МТ в ответе от
ФТС при вводе
товара в оборот
**rds
array[obj
-
Массив данных
Возвращается в ответе при условии
ect]
по РД
указания сведений в карточке товара в НК
***authDocD
string
-
Дата
Возвращается в ответе при условии
ate
разрешительного
указания сведений в карточке товара в НК
документа
387
Параметр
Тип
Обяз.
Описание
Комментарий
***authDocN
string
-
Номер
Возвращается в ответе при условии
umber
разрешительного
указания сведений в карточке товара в НК
документа
**countries
array[stri
-
Массив стран
Возвращается в ответе при условии
ng]
производства
указания сведений в карточке товара в НК
**tnved10
array
-
Массив кодов ТН
Возвращается в ответе при условии
ВЭД (10 знаков)
указания сведений в карточке товара в НК
*colors
array[stri
-
Массив
Возвращается в ответе при условии
ng]
уникальных
указания сведений в карточке товара в НК
значений цветов
изделия
*setDescriptio
string
-
Описание набора
Возвращается описание товара в составе
n
набора, содержащее параметры,
специфичные для конкретного товара.
Данный параметр вернётся в том случае,
если он заполнен в карточке НК (см.
"Справочник "Дополнительные
параметры в ответе в зависимости от
товарных групп"")
*setGtin
array[obj
-
Массив кодов
Возвращается в ответе, если "isSet" = true
ect]
товара, входящих
при условии указания сведений в карточке
в состав набора
товара в НК
**gtin
string
+
Код товара
Возвращается в ответе при условии
указания сведений в карточке товара в НК
**quantity
integer
+
Количество кодов
Возвращается в ответе при условии
товаров
указания сведений в карточке товара в НК
*mainGtin
integer
-
Код товара
Возвращается в ответе при условии
вложения в
указания сведений в карточке товара в НК
упаковку (GTIN
потребительской
упаковки).
Параметр
является
обязательным,
если значение
параметра "level"
("Уровень
упаковки") не
равно "trade-unit"
("Единица
товара")
388
Параметр
Тип
Обяз.
Описание
Комментарий
*goodStatus
string
-
Cтатус карточки
Возвращается в ответе при условии
товара в НК
указания сведений в карточке товара в НК.
Если карточка товара выводится из GS1,
то параметр не возвращается.
Возможные значения:
draft - карточка товара в разных статусах в
НК: "Черновик", "На модерации",
"Требует изменений", "Ожидает
подписания";
published - опубликованная карточка
товара;
archived - карточка товара в архиве
*fullName
string
-
Полное
Возвращается в ответе при условии
наименование
указания сведений в карточке товара в НК
товара
total
integer
+
Количество
найденных
товаров
errorCode
string
+
Код ошибки
*goodStatus
string
-
Статус карточки
Возможные значения:
товара в НК
draft - черновик, На модерации, Требует
изменений, Ожидает подписания;
published - опубликована;
archived - в архиве
5.5.2. Метод получения списка кодов товаров (GTIN) УОТ по ИНН
Метод возвращает список кодов товаров с возможностью указания параметров фильтрации в
запросе. Для товарной группы "Альтернативная табачная продукция" в ответе отсутствует
информация по кодам товаров, добавленным с помощью пользовательского интерфейса или
через "Метод создания и обновления товаров" раздела "Методы Национального каталога".
Тип приватности: приватный
URL: /product/gtin
Метод: GET
Пример строки запроса:
curl -X GET "<url стенда
v4>/product/gtin?includeSubaccount=false&limit=2&page=0&pg=tobacco"
-H "accept: application/json"
-H "Authorization: Bearer <ТОКЕН>"
389
Параметры запроса:
Параметр
Тип
Обяз.
Описание
Комментарий
limit
integer($
-
Максимальное
Не более 10000 записей (по умолчанию 10
int32)
количество
записей)
заказов КМ в
ответе
page
integer($
-
Номер страницы
int32)
ответа, начальное
значение - "0"
pg
string
+
Наименование
См. "Справочник "Список
товарной группы
поддерживаемых товарных групп""
includeSubac
boolean
-
Субаккаунт
Если значение = true, то в ответе
count
возвращаются данные по всем кодам
товаров: принадлежащих участнику
оборота товаров и предоставленных ему
через суббакаунт. Если значение = false, то
в ответе возвращаются данные только по
коду товара, принадлежащему участнику
оборота товаров. Значение по умолчанию
= false
inn
string
-
ИНН участника
оборота товаров
Параметры ответа:
Параметр
Тип
Обяз.
Описание
Комментарий
results
array of
+
В ответе возвращается по тем "gtin",
object
по которым найдены сведения, и
которые удовлетворяют условиям
поиска
*goodStatus
string
-
Статус карточки
Возможные значения: draft -
товара в НК
черновик, На модерации, Требует
изменений, Ожидает подписания;
published - опубликована; archived - в
архиве
*gtin
string
+
Код товара
*isGtinSubaccount
boolean
+
Признак
Если значение = true - субаккаунту
принадлежности
был предоставлен доступ к этому
кода товара
коду товара. Если значение = false -
субаккаунту
код товара собственный
*isKit
boolean
+
Признак
Возвращается в ответе при условии
"Комплект" в
указания сведений в карточке товара
карточке товара
в НК
390
Параметр
Тип
Обяз.
Описание
Комментарий
*isSet
boolean
+
Признак "Набор"
Возвращается в ответе при условии
по карточке
указания сведений в карточке товара
товара в НК
в НК
*permittedInns
array of
-
Массив ИНН
Возвращается в ответе при условии
string
компаний-
указания сведений в карточке товара
субаккаунтов,
в НК и только владельцу кода товара
которым владелец
кода товара
предоставил
возможность
использовать
данный код
товара для заказа
КМ
*setDescription
string
-
Описание состава
набора
*setGtin
array of
-
Массив кодов
object
товаров,
входящих в набор
**gtin
string
-
Код товара
**quantity
integer
-
Количество кодов
(int64)
товаров
total
number
+
Количество
найденных
товаров
errorCode
string
-
Код ошибки
Параметр указывается при наличии
ошибки
Пример ответа:
1.В случае успеха:
{
"results": [
{
"gtin": "04650117240408",
"isKit": false,
"isSet": false,
"isGtinSubaccount": false
}
],
"total": 1
}
2.В случае ошибок:
391
2.1. Код 401 В случае, если не указан токен:
<UnauthorizedException>
<error>unauthorized</error>
<error_description>Full authentication is required to access this
resource</error_description>
</UnauthorizedException>
2.2. Код 400 При неверном значении товарной группы в параметре pg:
{
"error_message": "Could not determine product group by name 'shoe'"
}
5.6. Метод получения кода товарной группы по КИ товара
(GTIN)
Метод возвращает информацию о товарных группах для запрашиваемых кодов товаров (в одном
запросе указываются несколько кодов товаров).
Тип приватности:
1. Публичный (для ТГ ∈ [ЛП; МОТП], в МОТП сохранён данный тип приватности для
обратной совместимости с предыдущими релизами True API).
2. Без токена (для ТГ "Табачная продукция" и "Альтернативная табачная продукция" в связи с
расширением общедоступной информации в МОТП).
URL: /product/route/gtin
Метод: POST
Content-Type: application/json
Параметры тела запроса:
Параметр
Тип
Обяз.
Описание
data
array
+
Список кодов товаров
gtin
string
+
Код товара
Параметры ответа:
Параметр
Тип
Обяз.
Описание
Комментарий
data
string
+
Код товара
392
Параметр
Тип
Обяз.
Описание
Комментарий
tg-id
string
+
Идентификатор
См. "Справочник "Список
товарной группы
поддерживаемых товарных групп""
Параметр указывается в случае
успешного выполнения запроса
tg-name
string
+
Наименование
товарной группы
error-msg
string
-
Сообщение об
См. "Справочник "Статусы ответов""
ошибке при
обработке кода
товара. Параметр
указывается при
наличии ошибки
в обработке кода
товара при
успешном
выполнении
запроса
error-code
string
-
Код ошибки при
обработке кода
товара
Пример запроса:
Для публичного типа приватности
curl -X POST "<url стенда>/product/route/gtin"
-H "accept: application/json"
-H "Content-Type: application/json"
-H "Authorization: Bearer <ТОКЕН>"
--data-raw {"data": ["00000046210654", "04630034070029"]}
Пример ответа:
1. В случае успеха:
1.1. При успешной обработке всех кодов товара из запроса:
393
[
{
"data": "00000046210654",
"tg-id": "3",
"tg-name": "tobacco"
},
{
"data": "04630034070029",
"tg-id": "2",
"tg-name": "shoes"
}
]
1.2. При успешной обработке части кодов товара из запроса:
[
{
"data": "00000046210654",
"tg-id": "3",
"tg-name": "tobacco"
},
{
"data": "04630034070012",
"error-code": "401",
"error-msg": "Для доступа к этому ресурсу требуется полная аутентификация"
}
]
+ 2. В случае ошибок:
2.1. Код 400 При неверной структуре в теле запроса:
{
"error_message": "JSON parse error: Cannot deserialize instance of
`java.util.ArrayList` out of VALUE_STRING token; nested exception is
com.fasterxml.jackson.databind.exc.MismatchedInputException: Cannot
deserialize instance of `java.util.ArrayList` out of VALUE_STRING
token\n at [Source: (PushbackInputStream); line: 1, column: 10] (through
reference chain: ru.crpt.trueapi.dto.common.GtinInfoRequest[\"data\"])"
}
2.2 Код 404 при отсутствии кода товара ("gtin") в базе ГИС МТ
394
{
"data": "00000046210654",
"error-code": 404,
"error-msg": "Not Found"
}
5.7. Работа с согласием о предоставлении информации
участникам оборота товаров ГИС МТ
Методы позволяют участнику оборота товаров запросить сведения о КИ, находящихся в
собственности его контрагента. Со стороны ГИС МТ при этом осуществляется проверка
наличия действующего согласие о предоставлении информации о КИ, выданное участнику
оборота товаров, запрашивающего информацию ок КИ. В ответ участник оборота товаров
получает запрашиваемую информацию, либо отказ в предоставлении запрашиваемой
информации.
5.7.1. Метод создания документа согласия о предоставлении сведений о КИ
Метод формирует черновик, который подписывается УКЭП генерального директора в личном
кабинете ГИС МТ. В ГИС МТ может находиться только один действующий документ согласия о
предоставлении сведений.
Тип приватности: приватный.
URL: /agreement-registry/agreement
Метод: POST
Пример строки запроса:
curl -X POST "<url стенда>/agreement-registry/agreement"
-H "accept: application/json"
-H "Content-Type: application/json"
-H "Authorization: Bearer <ТОКЕН>"
--data-raw
"{\"trustedInns\":[\"string\"],\"everyonePermitted\":true,\"expirationDate\":yyyy-MM-
ddTHH:mm:ss.SSS'Z}"
Пример тела запроса:
{
"trustedInns": [
"string"
],
"everyonePermitted": true,
"expirationDate": "string"
}
395
Параметры запроса
Параметр
Тип
Обяз.
Описание
Комментарий
trustedInns
[string]
-
Список
доверенных ИНН
контрагентов
everyonePermitted
boolean
-
Признак
При необходимости подписания
предоставления
согласия для всех контрагентов
согласия для всех
значение параметра должно быть
контрагентов
"true", при этом параметр "trustedInn"
должен быть пустым. Заполнение
обоих параметров одновременно
недопустимо. При передаче списка
ИНН доверенных контрагентов в
параметре "trustedInn" параметр
"everyonePermitted" должен быть
либо пустым, либо иметь значение
"false". Параметр "everyonePermitted"
автоматически принимает значение
"false" при передаче пустого значения
expirationDate
string
+
Дата окончания
Формат: yyyy-MM-
(date-
срока действия
ddTHH:mm:ss.SS’Z. Значение не
time)
согласия
может превышать дату окончания
срока действия используемой УКЭП.
Значение устанавливаемой даты не
может быть меньше текущей даты
создания документа согласия о
предоставлении сведений
Пример ответа:
1.В случае успеха 201 "Документ успешно создан".
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
2.В случае ошибки 400 (документ не прошёл валидацию);
396
[
{
"message":"Для опубликованной ревизии согласия существует документ аннулирования
в статусе 'На подготовке'",
"object":[
]
},
{
"message":"Срок действия документа не должен заканчиваться позже даты окончания
действия сертификата",
"object":[
]
},
{
"message":"ИНН не зарегистрированы в системе",
"object":[
"string"
]
},
{
"message":"ИНН организации, создающей документ согласия, не может находиться в
списке доверенных ИНН",
"object":[
"string"
]
},
{
"message":"Срок действия документа не должен заканчиваться раньше текущей даты",
"object":[
"string"
]
},
{
"message":"У УОТа уже есть актуальная ревизия согласия",
"object":[
"string"
]
},
{
"message":"Список доверенных ИНН пустой",
"object":[
"string"
]
}
]
Параметры ответа:
397
Параметр
Тип
Обяз.
Описание
Комментарий
id
string
+
ID документа
согласия о
предоставлении
информации
message
string
-
Сообщение об
Возвращается только в случае
ошибке
ошибки
5.7.2. Метод получения информации о КИ по списку КИ при наличии согласия о
предоставлении информации
Данный метод используется для запроса информации о КИ, владельцем которого является
другой участник оборота товаров при наличии согласия о предоставлении информации.
Тип приватности:
1. Приватный.
2. Оператор.
URL: /km-owner-api/cises
Метод: POST
Пример строки запроса:
curl -X POST "<url стенда>/km-owner-api/cises"
-H "accept: application/json"
-H "Content-Type: application/json"
-H "Authorization: Bearer <ТОКЕН>"
--data-raw "{\"ownerInn\":\"string\",\"cises\":[\"string\"]}"
Пример запроса в формате JSON:
{
"ownerInn": "string",
"cises": [
"string"
]
}
Параметры запроса
Параметр
Тип
Обяз.
Описание
Комментарий
ownerInn
string
+
ИНН
предполагаемого
владельца КИ
398
Параметр
Тип
Обяз.
Описание
Комментарий
cises
[string]
+
Список КИ, по
которым
запрашивается
информация
Пример ответа:
1.В случае успеха 200.
{
"responses": [
{
"cis": "string",
"owner": true,
"gtin": "string",
"productGroup": "string",
"producerInn": "string",
"status": "string",
"parent": "string",
"childs": [
null
],
"partialSaleInfo": {
"innerUnitCount": 20,
"soldUnitCount": 10,
"rest": 10,
"correctRest": true
}
}
],
"errors": [
{
"cises": [
"string"
]
}
]
}
2.В случае ошибки 403 "Не найден подписанный документ согласия для ИНН или ваша
организация отсутствует в списке доверенных контрагентов".
{
"message": "Не найден подписанный документ согласия для ИНН или ваша организация
отсутствует в списке доверенных контрагентов"
}
399

 

 

 

 

 

 

 

содержание      ..     2      3      4      5     ..