|
|
содержание .. 1 2 3 ..
{
"results": [
{
"cis":"010000000000000000jIHZ-XWKbQF5n",
"gtin":"04444444444444",
"sgtin":"jIHZ-XWKbQF5n",
"productName":"Творог 9%",
"producerName":"ООО \"\"",
"producerInn":"7777777777",
"ownerName":"ООО \"\"",
"ownerInn":"7777777777",
"statusEx":null,
"emissionDate":"2021-12-28T11:42:32.098Z",
"emissionType":"LOCAL",
"name":"Творог 9%",
"brand":"brand",
"certDoc":{},
"prevCises":[],
"nextCises":[],
"status":"INTRODUCED",
"countChildren":0,
"packType":"UNIT",
"expireDate": 0,
"expirationDate": "2021-11-05T00:00:00.000Z",
"productGroup":"milk",
"markWithdraw":false,
"productWeightGr":"999999",
"milkProductType":"ТВОРОГ",
"isSet":false,
"level":"trade-unit",
"multiplier":1,
"isVarQuantity":true,
"veterinaryControl":"НЕТ",
"fullName":"Творог 9%",
"volumeWeight":"300.0 г",
"babyFoodProduct":"НЕТ",
"structure":"Молоко коровье непастеризованное",
"isKit":false,
"isTechGtin":false,
"goodStatus":"published",
"paymentGroup":1,
"fat":"9",
"rawOrigin":"КОРОВА"
}
],
"total":0,
"nextPage":true
}
Пример ответа для прочих товарных групп:
100
{
"results": [
{
"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"
},
"prevCises": [
"string"
],
"nextCises": [
"string"
],
"status": "INTRODUCED",
"remarks": [
{
"curr": "string",
"prev": "string",
"date": "string"
}
],
"cisChildren": [
"string"
101
],
"children": [
{
"cis": "string",
"gtin": "string",
"producerName": "string",
"status": "INTRODUCED",
"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",
"introducedDate": 0,
"exporterName": "string",
"exporterTaxpayerId": "string",
"agentName": "string",
"agentInn": "string",
"lastStatusChangeDate": 0,
"turnoverType": "SELLING",
"productGroup": "string",
"tnVed10": "string",
"markWithdraw": "TRUE"
}
],
"childrenDetails": [
null
],
"countChildren": 0,
"uitu": "string",
"parent": "string",
"packType": "UNIT",
"withdrawReason": "string",
"receiptDate": "2021-05-07T00:00:00.000Z",
"exporterName": "string",
"exporterTaxpayerId": "string",
102
"certificateType": "CONFORMITY_CERT",
"certificateNumber": "string",
"certificateDate": "string",
"productGroup": "string"
}
],
"total": 0,
"nextPage": true,
"docErrors": [
]
}
Параметры ответа:
Параметр
Тип
Обяз.
Описание
Комментарий
results
object
+
Результат запроса
*cis
string
+
Код
идентификации,
используемый для
фильтрации по
списку КИ
*gtin
string
-
Код товара
*sgtin
string
-
Код товара и
серийный номер
КИ
*tnvd
string
-
Код товарной
номенклатуры (10
знаков)
*tnvedGroup
string
-
Код товарной
позиции ТН ВЭД
ЕАС товара
(первые 4
символа)
*producerNa
string
-
Производитель
me
товара
*productNam
string
-
Наименование
e
продукта
*producerInn
string
-
ИНН
производителя/им
портёра товара
*ownerName
string
-
Наименование
собственника
товара
103
Параметр
Тип
Обяз.
Описание
Комментарий
*ownerInn
string
-
ИНН
собственника
товара
*agentName
string
-
Наименование
текущего
владельца товара
*agentInn
string
-
ИНН текущего
владельца товара
*previousAge
string
-
Наименование
ntName
предыдущего
владельца товара
*previousAge
string
-
ИНН
ntInn
предыдущего
владельца товара
*turnoverTyp
enum
-
Вид
Возможные значения:
e
товарооборота
"SELLING" - продажа;
"COMMISSION"
(COMMISSIONAIRE_SALE - устар.) -
комиссия;
"AGENT" - агент;
"CONTRACT" - передача по АКС;
"CONTRACT_RETURN" - возврат по АКС
*statusExt
enum
-
Дополнительный
Возможные значения:
статус товара
"WAIT_SHIPMENT" - "Ожидает
подтверждения приёмки";
"WAIT_TRANSFER_TO_OWNER" -
"Ожидает передачу собственнику
(контрактное производство)";
"WAIT_REMARK" - "Товар ожидает
перемаркировку или КИ списан после
нанесения на товар";
"WITHDRAW" - "Вывод из оборота";
"REMARK_RETIRED" - "Выведен из
оборота при перемаркировке"
*docNum
string
-
Регистрационный
номер документа
*emissionDat
string
+
Дата эмиссии КИ
Возвращается в формате yyyy-MM-
e
(date-
ddTHH:mm:ss.SSS’Z
time)
*producedDat
string
-
Дата
Возвращается в формате yyyy-MM-
e
(date-
производства
ddTHH:mm:ss.SSS’Z. Параметр не
time)
возвращается для КИГУ, КИН
104
Параметр
Тип
Обяз.
Описание
Комментарий
*introducedD
string
-
Дата ввода в
Возвращается в формате yyyy-MM-
ate
(date-
оборот
ddTHH:mm:ss.SSS’Z
time)
*emissionTyp
string
-
Тип эмиссии
См. "Справочник "Типы эмиссии КИ""
e
*prodOrderTy
enum
-
Тип
Возможные значения:
pe
производственног
"SELF_MADE" - "Собственное
о заказа
производство";
"OPERATOR" - "Производство товара по
договору"
*lastDocId
string
-
Последний
регистрационный
номер документа,
зафиксированный
в ГИС МТ по
этому КИ
*name
string
-
Наименование
товара
*brand
string
-
Бренд
*model
string
-
Модель товара
*certDoc
string
-
Сертификат
**date
string
-
Дата сертификата
Возвращается в одном из форматов:
dd.MM.yyyy, yyyy-MM-dd, yyyy-MM-
dd’T’HH:mm:ss.SSS’Z’, yyyy-MM-
dd’T’HH:mm:ss’Z’, dd.MM.yyyy HH:mm
**number
string
-
Номер
сертификата
**type
string
-
Тип сертификата
*prevCises
[string]
-
Предыдущие КИ
в случае
перемаркировки
товара
*nextCises
[string]
-
Следующие
номера КИ в
случае
перемаркировки
товара
105
Параметр
Тип
Обяз.
Описание
Комментарий
*status
enum
+
Статус КИ
Возможные значения:
"INTRODUCED" - "В обороте";
"RETIRED" - "Выбыл"
Для перемаркированного КИ возможное
значение "RETIRED" (Выбыл)
*remarks
-
Список
перемаркировок
данного товара
**curr
string
-
Текущий КИ
товара
**date
string
-
Дата
Возвращается в формате yyyy-MM-
перемаркировки
ddTHH:mm:ss.SSS’Z
**prev
string
-
Предыдущие КИ
товара
*cisChildren
[string]
-
Список дочерних
КИ
*children
[array]
-
КИ в агрегате
**cis
string
+
КИ товара
**gtin
string
-
Код товара
**producerNa
string
-
Производитель
me
товара
**status
enum
+
Статус товара/КИ
Возможные значения:
"INTRODUCED" - "В обороте";
"RETIRED" - "Выбыл"
**emissionDa
string
+
Дата эмиссии
Задаётся в формате yyyy-MM-
te
(date-
ddTHH:mm:ss.SSS’Z
time)
**producedD
string
-
Дата
Возвращается в формате yyyy-MM-
ate
(date-
производства
ddTHH:mm:ss.SSS’Z. Параметр не
time)
возвращается для КИГУ, КИН
**packageTy
string
+
Тип упаковки
См. "Справочник "Типы упаковки""
pe
**ownerInn
string
-
ИНН
собственника
товара
**ownerNam
string
-
Наименование
e
собственника
товара
106
Параметр
Тип
Обяз.
Описание
Комментарий
**productNa
string
-
Наименование
me
товара на этикетке
**brand
string
-
Бренд
**nextCises
[string]
-
Следующие
номера КИ в
случае
перемаркировки
товара
**prevCises
[string]
-
Предыдущие
номера КИ в
случае
перемаркировки
товара
**statusEx
enum
-
Актуальные
См. "Справочник "Статусы КИ""
особые состояния
КИ
**children
[string]
-
Все КИ в агрегате
Возвращается в формате JSON-массива
**childrenMa
[string]
-
Краткая
p
информация о
дочерних КИ
**countChildr
integer
-
Количество
en
дочерних КИ
**parent
string
-
Код
идентификации
упаковки, в
которую
агрегирован товар
**lastDocId
string
-
Последний
регистрационный
номер документа,
зафиксированный
в ГИС МТ по
этому КИ
**expireDate
long
-
Дата истечения
Дата и время в формате Unix.
срока годности
Обязательный для товарной группы
"Молочная продукция"
**expirationD
string
-
Дата истечения
Возвращается в формате yyyy-MM-
ate
(date-
срока годности
ddTHH:mm:ss.SSS’Z. Обязательный для
time)
товарной группы "Молочная продукция"
107
Параметр
Тип
Обяз.
Описание
Комментарий
**prVetDocu
string
-
ID
Обязательный параметр для товарной
ment
производственног
группы "Молочная продукция". Данный
о ВСД (для
параметр используется вместо
продукции,
устаревшего "prVetDoc"
произведённой в
РФ) или ID
транспортного
ВСД (для
продукции,
произведённой
вне РФ)
**introduced
string
-
Дата ввода КИ в
Возвращается в формате yyyy-MM-
Date
(date-
оборот
ddTHH:mm:ss.SSS’Z
time)
**exporterNa
string
-
Наименование
me
экспортёра
**exporterTa
string
-
Уникальный
xpayerId
идентификатор
экспортёра в
национальной
системе учёта
налогоплательщи
ков
**agentName
string
-
ИНН текущего
владельца товара
**agentInn
string
-
Наименование
текущего
владельца товара
**lastStatusC
string
+
Дата последнего
Возвращается в формате yyyy-MM-
hangeDate
(date-
изменения статуса
ddTHH:mm:ss.SSS’Z
time)
**turnoverTy
enum
-
Вид
Возможные значения:
pe
товарооборота
"SELLING" - продажа;
"COMMISSION"
(COMMISSIONAIRE_SALE - устар.) -
комиссия;
"AGENT" - агент;
"CONTRACT" - передача по АКС;
"CONTRACT_RETURN" - возврат по АКС
**productGro
string
+
Товарная группа
См. "Справочник "Список
up
поддерживаемых товарных групп""
**tnVed10
string
-
Код ТН ВЭД (10
знаков)
108
Параметр
Тип
Обяз.
Описание
Комментарий
**veterinaryC
boolean
-
Признак
Возвращается только для товарной группы
ontrol
подконтрольности
"Молочная продукция"
ВСД, означающий
необходимость
проверки ВСД в
ФГИС "ВетИС"
**markWithd
boolean
-
Зафиксирована
raw
розничная
продажа по чеку
от невладельца
КИ
**productWei
integer
-
Вес выпущенной
Возвращается только для товарной группы
ghtGr
продукции
"Молочная продукция" в граммах, первые
три цифры - значение кг, последние три
цифры - десятые, сотые и тысячные.
Например: "productWeightGr": "001234"
означает 1234 грамма или 1.234 кг
**isVarQuant
boolean
-
Признак
Возвращается только для товарной группы
ity
переменного веса
"Молочная продукция"
*childrenDeta
[array]
-
Маркированный
ils
товар
*countChildre
integer
-
Количество
n
дочерних КИ
*uitu
string
-
КИТУ
вышестоящего
уровня
*parent
string
-
Код
идентификации
упаковки, в
которую
агрегирован товар
*packType
string
+
Тип упаковки
См. "Справочник "Типы упаковки""
*withdrawRe
string
-
Причина выбытия
См. "Справочник "Причины выбытия""
ason
*receiptDate
string
-
Дата вывода из
Возвращается в формате yyyy-MM-
оборота
ddTHH:mm:ss.SSS’Z
*expireDate
string
-
Дата истечения
Обязательный для товарной группы
(date-
срока годности
"Молочная продукция"
time)
*expirationDa
string
-
Дата истечения
Возвращается в формате yyyy-MM-
te
(date-
срока годности
ddTHH:mm:ss.SSS’Z. Обязательный для
time)
товарной группы "Молочная продукция"
109
Параметр
Тип
Обяз.
Описание
Комментарий
*prVetDocum
string
-
ID
Обязательный параметр для товарной
ent
производственног
группы "Молочная продукция". Данный
о ВСД (для
параметр используется вместо
продукции,
устаревшего "prVetDoc"
произведённой в
РФ) или ID
транспортного
ВСД (для
продукции,
произведённой
вне РФ)
*exporterNam
string
-
Наименование
e
экспортёра
*exporterTax
string
-
Уникальный
payerId
идентификатор
экспортёра в
национальной
системе учёта
налогоплательщи
ков
*certificateTy
string
-
Вид документа,
Возможные значения:
pe
подтверждающего
соответствие
"CONFORMITY_CERTIFICATE" -
"Сертификат соответствия";
"CONFORMITY_DECLARATION" -
"Декларация о соответствии";
"CONFORMITY_CERTIFICATE_OR_DEC
LARATION" - "Сертификат или
декларация о соответствии"
*certificateNu
string
-
Номер документа,
mber
подтверждающего
соответствие
*certificateDa
string
-
Дата документа,
te
подтверждающего
соответствие
*productGrou
string
+
Товарная группа
Cм. "Справочник "Список
p
поддерживаемых товарных групп""
*productWeig
integer
-
Вес выпущенной
Возвращается только для товарной группы
htGr
продукции
"Молочная продукция" в граммах, первые
три цифры - значение кг, последние три
цифры - десятые, сотые и тысячные.
Например: "productWeightGr": "001234"
означает 1234 грамма или 1.234 кг
*isVarQuantit
boolean
-
Признак
Возвращается только для товарной группы
y
переменного веса
"Молочная продукция"
110
Параметр
Тип
Обяз.
Описание
Комментарий
*color
string
-
Цвет
Возвращается для товарной группы
"Обувные товары"
*productSize
string
-
Размер
Возвращается для товарной группы
"Обувные товары"
total
string
+
Количество
вернувшихся
ответов
docErrors
[string]
-
Список ошибок
Возвращается в случае ошибки
обработки
документа
nextPage
boolean
+
Признак наличия
Возможные значения:
следующей
true - имеется следующая страница;
страницы
false - следующая страница отсутствует
*expirations
array
-
Массив сроков
Возвращается только для товарной группы
годности
"Молочная продукция", если в карточке
товара в НКМТ и в отчёте о нанесении
КМ в СУЗ указано несколько сроков
годности
**expirationS
string
-
Дата срока
Возвращается только для товарной группы
torageDate
годности
"Молочная продукция", если в отчёте о
нанесении в СУЗ указано несколько
сроков годности. Формат: yyyy-MM-
ddTHH:mm:ssZ
**storageCon
integer
-
Идентификатор
Возвращается только для товарной группы
ditionId
условия хранения
"Молочная продукция", если в карточке
товара в НКМТ указан идентификатор
условия хранения
**storageCon
string
-
Описание
Возвращается только для товарной группы
ditionName
условий хранения
"Молочная продукция", если в карточке
товара в НКМТ указано описание условий
хранения. Формат значения соответствует
указанному в НКМТ с учётом
расширенной информации, указанной в
соответствии с этикеткой на упаковке.
Пример значения: "120 суток при
температуре хранения °C и относительной
влажности воздуха от 80% до 85%
включительно"
2.4. Метод получения краткой информации о КИ/списке КИ
(общедоступный)
Метод является устаревшим и будет удалён из описания. Использовать "Метод получения списка
КИ по идентификатору" /cis/cis_list (POST).
111
URL: /facade/cis/cis_list
Метод: GET
Пример запроса:
curl -X GET
"<url стенда>/facade/cis/cis_list?cis=00000000000000000001&cis=00000000000000000002"
-H 'content-type: application/json' -H 'Authorization: Bearer <ТОКЕН>'
Параметры запроса:
Параметр
Тип
Обяз.
Описание
Комментарий
childrenPagin
boolean
+
Флаг,
При включённом значении возвращает
g
включающий
постранично агрегаты только первого слоя
пагинацию
через указанные ниже параметры.
агрегатов
Значение по умолчанию: false
childrenPage
number
-
Число страниц
Значение по умолчанию: 1
вложений
агрегата первого
слоя
childrenLimit
number
-
Количество
Значение по умолчанию: 50
вложений на
странице агрегата
первого слоя
cis
string
+
Код
идентификации
pg
string
-
Товарная группа
Параметр обязательно указывать для
товарных групп:
milk - "Молочная продукция";
water - "Упакованная вода"
Параметры заголовка запроса: Authorization: Bearer <token>
Пример ответа для товарной группы "Молочная продукция":
112
{
"010464004346948621jIHZ-XWKbQF5n": {
"cis": "000000000000000000jIHZ-XWKbQF5n",
"gtin": "04444444444444",
"producerName": "ООО \"\"",
"producerInn": "7777777777",
"status": "INTRODUCED",
"emissionDate": "2021-12-28T11:42:32.098Z",
"emissionType": "LOCAL",
"packType": "UNIT",
"ownerName": "ООО \"\"",
"ownerInn": "7777777777",
"productName": "Творог 9%",
"brand": "brand",
"prevCises": [],
"nextCises": [],
"countChildren": 0,
"agentName": "",
"productGroup": "milk",
"markWithdraw": false,
"productWeightGr": "999999",
"isVarQuantity": true
}
}
Пример ответа для прочих товарных групп:
{
"0000000000000000000=8xv7rzu't%_": {
"cis": "000000000000000000=8xv7rzu't%_",
"gtin": "0111111111111",
"producerName": "ООО \"X\"",
"producerInn": "7777777777",
"status": "INTRODUCED",
"emissionDate": "2021-09-17T07:23:54.282Z",
"emissionType": "LOCAL",
"producedDate": "2021-09-23T00:00:00.000Z",
"packType": "UNIT",
"ownerName": "ООО \"X\"",
"ownerInn": "7777777777",
"productName": "string",
"brand": "X",
"prevCises": [],
"nextCises": [],
"countChildren": 0,
"lastDocId": "string",
"introducedDate": "2021-09-23T13:28:47.615Z",
"agentName": "",
"lastStatusChangeDate": "2021-09-23T13:28:47.615Z",
113
"productGroup": "string",
"tnVed10": "string",
"markWithdraw": false,
"certDoc": [
{
"type": "CONFORMITY_CERTIFICATE",
"number": "12343434234234",
"date": "2021-02-03"
},
{
"type": "CONFORMITY_DECLARATION",
"number": "12343434234234",
"date": "2021-02-03"
},
{
"type": "STATE_REGISTRATION_CERTIFICATE",
"number": "12343434234234",
"date": "2021-02-03",
"wellNumber": "111114"
},
{
"type": "STATE_REGISTRATION_CERTIFICATE",
"number": "12343434234234",
"date": "2021-02-03",
"wellNumber": "46246799"
}
],
"licences": [
{
"licenceNumber": "12345",
"licenceDate": "2021-09-06"
}
]
}
}
Параметры ответа:
Параметр
Тип
Обяз.
Описание
*cis
string
+
Код идентификации, используемый для
фильтрации по списку КИ
*gtin
string
-
Код товара
*producerName
string
-
Производитель товара
*producerInn
string
-
ИНН производителя товара
114
Параметр
Тип
Обяз.
Описание
*status
enum
+
Статус товара / КИ:
EMITTED - Эмитирован. Выпущен;
APPLIED - Эмитирован. Получен;
INTRODUCED - В обороте;
WRITTEN_OFF - КИ списан;
RETIRED - Выбыл;
DISAGGREGATION - Расформирован (только
для упаковок)
*emissionDate
string
+
Дата выпуска КИ. Возвращается в формате
(date-
yyyy-MM-ddTHH:mm:ss.SSS’Z
time)
*emissionType
string
-
Тип эмиссии (см. "Справочник "Типы эмиссии
КИ"")
*producedDate
string
-
Дата производства. Возвращается в формате
(date-
yyyy-MM-ddTHH:mm:ss.SSS’Z. Параметр не
time)
возвращается для КИТУ, АТК (кроме товарных
групп "Альтернативная табачная продукция",
"Никотиносодержащая продукция", "Табачная
продукция")
*packType
string
+
Тип упаковки (см. "Справочник "Типы
упаковки"")
*ownerName
string
-
Наименование собственника товара
*ownerInn
string
-
ИНН собственника товара
*productName
string
-
Название продукта
*brand
string
-
Бренд
*prevCises
[string]
-
Предыдущие номера КИ. В случае
перемаркировки товара
*nextCises
[string]
-
Следующие номера КИ. В случае
перемаркировки товара
*statusEx
enum
-
Актуальные особые состояния КИ (см.
"Справочник "Статусы КИ"")
*children
[string]
-
КИ в агрегате
*childrenMap
[string]
-
Краткая информация о дочерних КИ
*emissionDate
string
+
Дата эмиссии. Возвращается в формате yyyy-
(date-
MM-ddTHH:mm:ss.SSS’Z
time)
*emissionType
string
-
Тип эмиссии. См. Справочник "Типы эмиссии
КИ"
*countChildren
integer
-
Количество дочерних КИ
(int32)
115
Параметр
Тип
Обяз.
Описание
*expireDate
string
-
Дата истечения срока годности. Возвращается
(date-
в формате yyyy-MM-ddTHH:mm:ss.SSS’Z
time)
(обязательный для ТГ "Молочная продукция")
*exporterName
string
-
Наименование экспортёра
*exporterTaxpayerId
string
-
Уникальный идентификатор экспортёра в
национальной системе учета
налогоплательщиков
*sgtin
string
-
Код товара и серийный номер КИ
*introducedDate
string
-
Дата ввода в оборот. Возвращается в формате
(date-
yyyy-MM-ddTHH:mm:ss.SSS’Z
time)
*applicationDate
string
-
Дата нанесения. Возвращается в формате yyyy-
(date-
MM-ddTHH:mm:ss.SSS’Z. Параметр не
time)
возвращается для КИГУ, КИН
*lastDocId
string
-
Последний регистрационный номер документа,
зафиксированный в ГИС МТ по этому КИ
*parent
string
-
КИТУ вышестоящего уровня
*prVetDocument
string
-
ID производственного ВСД (для продукции,
произведённой в РФ) или ID транспортного
ВСД (для продукции, произведённой вне РФ).
Обязательный параметр для ТГ "Молочная
продукция". Данный параметр используется
вместо устаревшего "prVetDoc"
*producedDate
string
-
Дата производства. Возвращается в формате
(date-
yyyy-MM-ddTHH:mm:ss.SSS’Z. Параметр не
time)
возвращается для КИГУ
*turnoverType
enum
-
Вид товарооборота:
SELLING - продажа;
COMMISSION - комиссия;
AGENT - агент;
CONTRACT - передача по АКС;
CONTRACT_RETURN - возврат по АКС
*productGroup
string
+
Товарная группа (см. "Справочник "Список
поддерживаемых товарных групп"")
*tnVed10
string
-
Код ТН ВЭД (10 знаков)
*agentInn
string
-
ИНН текущего владельца товара
*agentName
string
-
Наименование текущего владельца товара
*lastStatusChangeDate
string
+
Дата последнего изменения статуса.
(date-
Возвращается в формате yyyy-MM-
time)
ddTHH:mm:ss.SSS’Z
116
Параметр
Тип
Обяз.
Описание
*markWithdraw
boolean
-
Зафиксирована розничная продажа по чеку от
невладельца КИ
*productWeightGr
integer
-
Вес выпущенной продукции. Возвращается
только для товарной группы "Молочная
продукция" в граммах, первые три цифры -
значение кг, последние три цифры - десятые,
сотые и тысячные. Например:
"productWeightGr": "001234" означает 1234
грамма или 1.234 кг
*isVarQuantity
boolean
-
Признак переменного веса. Возвращается
только для товарной группы "Молочная
продукция"
*certDoc
string
-
Документ обязательной сертификации
**type
string
-
Вид документа обязательной сертификации.
Возможные значения:
CONFORMITY_CERTIFICATE - сертификат
соответствия;
CONFORMITY_DECLARATION - декларация
о соответствии;
STATE_REGISTRATION_CERTIFICATE -
свидетельство государственной регистрации
**number
string
-
Номер документа обязательной сертификации
**date
string(da
-
Дата выдачи документа обязательной
te)
сертификации. Формат: yyyy.MM.dd
*expirations
array
-
Массив сроков годности. Возвращается только
для товарной группы "Молочная продукция",
если в карточке товара в НКМТ и в отчёте о
нанесении КМ в СУЗ указано несколько сроков
годности
**expirationStorageDate
string
-
Дата срока годности. Возвращается только для
товарной группы "Молочная продукция", если
в отчёте о нанесении в СУЗ указано несколько
сроков годности. Формат: yyyy-MM-
ddTHH:mm:ssZ
**storageConditionId
integer
-
Идентификатор условия хранения.
Возвращается только для товарной группы
"Молочная продукция", если в карточке товара
в НКМТ указан идентификатор условия
хранения
117
Параметр
Тип
Обяз.
Описание
**storageConditionName
string
-
Описание условий хранения. Возвращается
только для товарной группы "Молочная
продукция", если в карточке товара в НКМТ
указано описание условий хранения. Формат
значения соответствует указанному в НКМТ с
учётом расширенной информации, указанной в
соответствии с этикеткой на упаковке. Пример
значения: "120 суток при температуре
хранения 0°C и относительной влажности
воздуха от 80% до 85% включительно"
**wellNumber
string
-
Номер скважины. Возвращается для товарной
группы "Упакованная вода"
*licences
array of
-
Массив лицензий на пользование недрами.
string
Значение параметра возвращается для
товарной группы "Упакованная вода"
**licenceNumber
string
-
Номер лицензии на пользование недрами.
Возвращается для товарной группы
"Упакованная вода"
**licenceDate
string
-
Дата выдачи лицензии. Возвращается для
date
товарной группы "Упакованная вода" в
формате:
* yyyy-MM-dd; * yyyy-MM-
ddTHH:mm:ss.SSSZ; * yyyy-MM-
ddTHH:mm:ssZ
Примечание: Для невладельца ответ зависит от статуса КИ:
• Если КИ "Эмитирован. Получен" или "В обороте", возвращаются все сведения;
• Если КИ "Выбыл", возвращаются сведения по КИ, без информации об участнику оборота
товаров, от которого КИ выбыл;
• Если сформированный агрегат, возвращаются все сведения и список КИ в агрегате первого
уровня;
• Если расформированный агрегат, возвращается статус агрегата и список КИ в агрегате
первого уровня.
2.5. Метод получения списка КИ по идентификатору
Для получения списка КИ по идентификатору рекомендуется использовать данную версию
(версию 4), поскольку версия 3 является устаревшей.
Информацию по указанию параметров в строке запроса при работе с большими агрегатами см. в
разделе "Указание параметров в строке запроса при работе с большими агрегатами".
Метод: POST
Пример строки запроса:
118
curl -X POST "<url стенда
v4>/facade/cis/cis_list?childrenPaging=true&childrenPage=1&childrenLimit=50"
-H 'Authorization: Bearer <ТОКЕН>' -H 'content-type: application/json'
-d "{"cises":["0000000000000000000000000000000"]}"
Параметры строки запроса:
Параметр
Тип
Обяз.
Описание
Комментарий
childrenPagin
boolean
+
Флаг,
При включённом значении возвращает
g
включающий
постранично агрегаты только первого слоя
пагинацию
через указанные ниже параметры.
агрегатов
Значение по умолчанию: false
childrenPage
number
-
Число страниц
Значение по умолчанию: 1
вложений
агрегата первого
слоя
childrenLimit
number
-
Количество
Значение по умолчанию: 50
вложений на
странице агрегата
первого слоя
pg
string
-
Товарная группа
Параметр обязателен для товарных групп:
milk - "Молочная продукция";
water - "Упакованная вода"
Пример тела запроса:
{
"cises":[
"0000000000000000000000000000000"
]
}
Параметры тела запроса:
Параметр
Тип
Обяз.
Описание
Комментарий
cises
string
-
Список
уникальных
идентификаторов
товара (КИ)
Для невладельца ответ зависит от статуса КИ:
• если КИ в статусе "Эмитирован. Получен" или "В обороте", то возвращаются все сведения;
• если КИ выбыл, то возвращаются сведения по КИ без информации об участнике оборота
товаров, от которого КИ выбыл;
119
• если агрегат сформирован, то возвращаются все сведения и список КИ в агрегате первого
уровня;
• если агрегат расформирован, то возвращается статус агрегата и список КИ в агрегате первого
уровня.
Пример ответа для товарной группы "Молочная продукция":
{
"010000000000000000jIHZ-XWKbQF5n":{
"cis":"010000000000000000jIHZ-XWKbQF5n",
"gtin":"04444444444444",
"producerName":"ООО \"\"",
"producerInn":"7777777777",
"status":"INTRODUCED",
"emissionDate":"2021-12-28T11:42:32.098Z",
"emissionType":"LOCAL",
"packType":"UNIT",
"ownerName":"ООО \"\"",
"ownerInn":"7777777777",
"productName":"Творог 9%",
"brand":"CAR SHOE",
"prevCises":[],
"nextCises":[],
"countChildren":0,
"expireDate": "2021-11-05T00:00:00.000Z",
"agentName":"",
"productGroup":"milk",
"markWithdraw":false,
"productWeightGr":"999999",
"isVarQuantity":true
}
}
Пример ответа для прочих товарных групп:
{
"0000000000000000000=8xv7rzu't%_":{
"cis":"string",
"gtin":"string",
"producerName":"ООО \"X\"",
"producerInn":"777777777",
"status":"INTRODUCED",
"emissionDate":"2021-09-17T07:23:54.282Z",
"emissionType":"LOCAL",
"producedDate":"2021-09-23T00:00:00.000Z",
"packType":"UNIT",
"ownerName":"ООО \"X\"",
"ownerInn":"string",
"productName":"string",
120
"brand":"string",
"prevCises":[
],
"nextCises":[
],
"licences":[
{
"licenceNumber":"12345",
"licenceDate":"2021-09-06"
}
],
"countChildren":0,
"lastDocId":"string",
"introducedDate":"2021-09-23T13:28:47.615Z",
"agentName":"",
"lastStatusChangeDate":"2021-09-23T13:28:47.615Z",
"productGroup":"string",
"tnVed10":"string",
"markWithdraw":false,
"certDoc":[
{
"type":"CONFORMITY_CERTIFICATE",
"number":"12343434234234",
"date":"2021-02-03"
},
{
"type":"CONFORMITY_DECLARATION",
"number":"12343434234234",
"date":"2021-02-03"
},
{
"type":"STATE_REGISTRATION_CERTIFICATE",
"number":"12343434234234",
"date":"2021-02-03",
"wellNumber":"111114"
},
{
"type":"STATE_REGISTRATION_CERTIFICATE",
"number":"12343434234234",
"date":"2021-02-03"
}
]
}
}
Параметры ответа:
121
Параметр
Тип
Обяз.
Описание
Комментарий
*cis
string
+
Код
идентификации,
используемый для
фильтрации по
списку КИ
*gtin
string
-
Код товара
*producerNa
string
-
Производитель
me
товара
*producerInn
string
-
ИНН
производителя
товара
*status
enum
+
Статус КИ
Возможные значения:
"EMITTED" - "Эмитирован. Выпущен";
"APPLIED" - "Эмитирован. Получен";
"INTRODUCED" - "В обороте";
"WRITTEN_OFF" - "КИ списан";
"RETIRED" - "Выбыл";
"DISAGGREGATION" - "Расформирован
(только для упаковок)"
*emissionDat
string
+
Дата выпуска КИ
Возвращается в формате yyyy-MM-
e
(date-
ddTHH:mm:ss.SSS’Z
time)
*emissionTyp
string
-
Тип эмиссии (см.
e
"Справочник
"Типы эмиссии
КИ"")
*producedDat
string
-
Дата
Возвращается в формате yyyy-MM-
e
(date-
производства
ddTHH:mm:ss.SSS’Z. Параметр не
time)
возвращается для КИТУ, АТК (кроме
товарных групп "Альтернативная табачная
продукция", "Никотиносодержащая
продукция", "Табачная продукция")
*packType
string
+
Тип упаковки
Cм. "Справочник "Типы упаковки""
*ownerName
string
-
Наименование
собственника
товара
*ownerInn
string
-
ИНН
собственника
товара
*productNam
string
-
Название
e
продукта
*brand
string
-
Бренд
122
Параметр
Тип
Обяз.
Описание
Комментарий
*prevCises
[string]
-
Предыдущие
В случае перемаркировки товара
номера КИ
*nextCises
[string]
-
Следующие
В случае перемаркировки товара
номера КИ
*statusEx
enum
-
Актуальные
См. "Справочник "Статусы КИ""
особые состояния
КИ
*children
[string]
-
КИ в агрегате
*countChildre
integer
-
Количество
n
(int32)
дочерних КИ
*parent
string
-
КИТУ
вышестоящего
уровня
*lastDocId
string
-
Последний
регистрационный
номер документа,
зафиксированный
в ГИС МТ по
этому КИ
*expireDate
string
-
Дата истечения
Возвращается в формате yyyy-MM-
(date-
срока годности
ddTHH:mm:ss.SSS’Z (обязательный для
time)
товарной группы "Молочная продукция")
*applicationD
string
-
Дата нанесения
Возвращается в формате yyyy-MM-
ate
(date-
ddTHH:mm:ss.SSS’Z. Параметр не
time)
возвращается для КИТУ, АТК
*prVetDocum
string
-
ID
Возвращается для товарной группы
ent
производственног
"Молочная продукция" вместо
о ВСД (для
устаревшего "prVetDoc"
продукции,
произведённой в
РФ) или ID
транспортного
ВСД (для
продукции,
произведённой
вне РФ)
*introducedD
string
-
Дата ввода в
Возвращается в формате yyyy-MM-
ate
(date-
оборот с КИ в
ddTHH:mm:ss.SSS’Z
time)
оборот
*exporterNam
string
-
Наименование
e
экспортёра
123
Параметр
Тип
Обяз.
Описание
Комментарий
*exporterTax
string
-
Уникальный
payerId
идентификатор
экспортёра в
национальной
системе учёта
налогоплательщи
ков
*agentInn
string
-
ИНН текущего
владельца товара
*agentName
string
-
Наименование
текущего
владельца товара
*turnoverTyp
enum
-
Вид
Возможные значения:
e
товарооборота
"SELLING" - "Продажа / передача товара";
"COMMISSION" - "Комиссия";
"AGENT" - "Агент";
"CONTRACT" - "Передача товара агенту /
комиссионеру";
"CONTRACT_RETURN" - "Возврат
товара от агента / комиссионера"
*productGrou
string
+
Товарная группа
См. "Справочник "Список
p
поддерживаемых товарных групп""
*tnVed10
string
-
Код ТН ВЭД (10
знаков)
*markWithdr
boolean
-
Зафиксирована
aw
розничная
продажа по чеку
от невладельца
КИ
*withdrawRe
string
-
Причина выбытия
См. "Справочник "Причины выбытия""
ason
*withdrawRe
string
-
Введённая
Возвращается, если "withdrawReason" =
asonOther
вручную причина
"OTHER"
выбытия
*productWeig
integer
-
Вес выпущенной
Возвращается только для товарной группы
htGr
продукции
"Молочная продукция" в граммах, первые
три цифры - значение кг, последние три
цифры - десятые, сотые и тысячные.
Например: "productWeightGr": "001234"
означает 1234 грамма или 1.234 кг
*isVarQuantit
boolean
-
Признак
Возвращается только для товарной группы
y
переменного веса
"Молочная продукция"
124
Параметр
Тип
Обяз.
Описание
Комментарий
*certDoc
string
-
Документ
обязательной
сертификации
**date
string
-
Дата сертификата
Возвращается в формате yyyy-MM-
ddTHH:mm:ss.SSS’Z
**lastStatusC
string
-
Дата последнего
Возвращается в формате yyyy-MM-
hangeDate
(date-
изменения статуса
ddTHH:mm:ss.SSS’Z
time)
*type
string
-
Вид документа
Возможные значения:
обязательной
сертификации
"CONFORMITY_CERTIFICATE" -
сертификат соответствия;
"CONFORMITY_DECLARATION" -
декларация о соответствии;
"STATE_REGISTRATION_CERTIFICATE"
- свидетельство государственной
регистрации
"CONFORMITY_CERTIFICATE_OR_DEC
LARATION" - сертификат или декларация
о соответствии
**number
string
-
Номер документа
обязательной
сертификации
**date
string(da
-
Дата выдачи
Формат: yyyy.MM.dd
te)
документа
обязательной
сертификации
*expirations
array
-
Массив сроков
Возвращается только для товарной группы
годности
"Молочная продукция", если в карточке
товара в НКМТ и в отчёте о нанесении
КМ в СУЗ указано несколько сроков
годности
**expirationS
string
-
Дата срока
Возвращается только для товарной группы
torageDate
годности
"Молочная продукция", если в отчёте о
нанесении в СУЗ указано несколько
сроков годности. Формат: yyyy-MM-
ddTHH:mm:ssZ
**storageCon
integer
-
Идентификатор
Возвращается только для товарной группы
ditionId
условия хранения
"Молочная продукция", если в карточке
товара в НКМТ указан идентификатор
условия хранения
125
Параметр
Тип
Обяз.
Описание
Комментарий
**storageCon
string
-
Описание
Возвращается только для товарной группы
ditionName
условий хранения
"Молочная продукция", если в карточке
товара в НКМТ указано описание условий
хранения. Формат значения соответствует
указанному в НКМТ, с учётом
расширенной информации, указанной в
соответствии с этикеткой на упаковке.
Пример значения: "120 суток при
температуре хранения 0°C и
относительной влажности воздуха от 80%
до 85% включительно"
**wellNumbe
string
-
Номер скважины
Возвращается для товарной группы
r
"Упакованная вода"
*licences
array of
-
Массив лицензий
Значение параметра возвращается для
string
на пользование
товарной группы "Упакованная вода"
недрами
**licenceNu
string
-
Номер лицензии
Возвращается для товарной группы
mber
на пользование
"Упакованная вода"
недрами
**licenceDate
string
-
Дата выдачи
Возвращается для товарной группы
date
лицензии
"Упакованная вода" в формате:
* yyyy-MM-dd; * yyyy-MM-
ddTHH:mm:ss.SSSZ; * yyyy-MM-
ddTHH:mm:ssZ
2.6. Метод получения информации о товаре по GTIN товара
В результате успешного выполнения запроса по списку кодов товаров в ответе возвращается
массив с информацией о товарах по запрошенным КИ. В результирующем JSON также может
содержаться набор полей, специфичных для товара конкретной товарной группы (см.
"Справочник "Дополнительные параметры в ответе в зависимости от товарных групп""). Вместо
данного метода рекомендуется использовать "Метод получения информации о товаре по GTIN
товара" в True API. Планируемая дата отключения версии 3 данного метода - ноябрь 2021 года.
URL: /product/info
Метод: GET
Пример запроса:
curl -X GET "<url стенда v3>/product/info?gtins=04600000000000&includeSubaccount=true"
-H "accept: */*"
Параметры запроса:
126
Параметр
Тип
Обяз.
Описание
Комментарий
gtins
[string]
+
Массив кодов
товаров
includeSubac
boolean
-
Признак
Если значение = true, то в ответе
count
субаккаунта
возвращаются данные по всем GTIN,
принадлежащим участнику оборота
товаров и предоставленным ему через
суббакаунт. Если значение = false, то в
ответе возвращаются данные только по
GTIN, принадлежащим участнику оборота
товаров. Значение по умолчанию = false
Пример ответа:
{
"results": [
{
"id": 111111,
"name": "Товар1",
"gtin": "04650128985350",
"brand": "brand",
"packageType": "UNDEFINED",
"innerUnitCount": 55,
"inn": "0000000000",
"productGroupId": 3,
"goodSignedFlag": true,
"goodMarkFlag": true,
"goodTurnFlag": true,
"isKit": false,
"isTechGtin": false,
"isSet": false,
"level": "trade-unit",
"multiplier": 1,
"goodStatus": "published",
"productGroup": 3,
"exciseProductCode": "460",
"tnVedCode10": "2402209000",
"okpd2Group": "12.00.11.140",
"fullName": "Полное наименование",
"tnVedCode": "2402"
}
],
"total": 1,
"errorCode": null
}
Параметры ответа:
127
Параметр
Тип
Обяз.
Описание
Комментарий
results
array
+
Массив с
информацией о
товарах по
запрошенным КИ
*id
integer
+
ID товара
*name
string
+
Наименование
товара
*gtin
string
+
Код товара, по
которому
выполняется
запрос
*brand
string
+
Бренд
*packageType
string
+
Тип упаковки
См. "Справочник "Типы упаковки""
*innerUnitCo
integer
+
Количество
unt
товара в упаковке
*publicationD
string
-
Дата публикации
Формат: yyyy-MM-ddTHH:mm:ss.SSS’Z
ate
(date-
кода товара
time)
*inn
string
-
ИНН
производителя
*exporter
object
-
Заявитель
маркируемого и
вводимого в
оборот товара
**id
integer(i
-
ID заявителя
Возвращается в ответе при условии
nt64)
указания сведений в карточке товара в НК.
Возвращается обязательно при возврате
объекта "exporter" ("Заявитель
маркируемого и вводимого в оборот
товара")
**ncId
integer(i
-
Идентификатор
Возвращается в ответе при условии
nt64)
заявителя в НК по
указания сведений в карточке товара в НК.
импортным
Возвращается обязательно при возврате
товарам с
объекта "exporter" ("Заявитель
глобальным GTIN
маркируемого и вводимого в оборот
товара")
**exporterNa
string
-
Наименование
Возвращается в ответе при условии
me
заявителя-
указания сведений в карточке товара в НК.
экспортёра
Возвращается обязательно при возврате
объекта "exporter" ("Заявитель
маркируемого и вводимого в оборот
товара")
128
Параметр
Тип
Обяз.
Описание
Комментарий
**exporterTa
string
-
ИНН заявителя
Возвращается в ответе при условии
xpayerId
или его аналог
указания сведений в карточке товара в НК.
(налоговый
Возвращается обязательно при возврате
идентификатор)
объекта "exporter" ("Заявитель
маркируемого и вводимого в оборот
товара")
**kpp
string
-
КПП или его
Возвращается в ответе при условии
аналог
указания сведений в карточке товара в НК
**gcp
string
-
Глобальный
Возвращается в ответе при условии
идентификатор
указания сведений в карточке товара в НК.
компании в GS1
Возвращается обязательно при возврате
объекта "exporter" ("Заявитель
маркируемого и вводимого в оборот
товара")
**gln
string
-
Глобальный
Возвращается в ответе при условии
идентификатор
указания сведений в карточке товара в НК.
места нахождения
Возвращается обязательно при возврате
объекта "exporter" ("Заявитель
маркируемого и вводимого в оборот
товара")
**manufactur
string
-
Адрес
Возвращается в ответе при условии
eAddress
производственной
указания сведений в карточке товара в НК.
площадки
Возвращается обязательно при возврате
объекта "exporter" ("Заявитель
маркируемого и вводимого в оборот
товара")
**importerAc
string
-
Ссылка на
Возвращается в ответе при условии
count
аккаунт
указания сведений в карточке товара в НК
импортёра
*permittedInn
[string]
-
Массив ИНН
Возвращается в ответе при условии
s
компаний-
указания сведений в карточке товара в НК.
субаккаунтов,
Параметр возвращается для владельца
которым владелец
кода товара и для Оператора
кода товара
предоставил
возможность
использовать
данный код
товара для заказа
КМ
*productGrou
integer(i
+
Идентификатор
См. "Справочник "Список
pId
nt64)
товарной группы
поддерживаемых товарных групп"".
Возвращается в ответе при условии
указания сведений в карточке товара в НК
*productGrou
string
-
Наименование
Возвращается в ответе при условии
p
товарной группы
указания сведений в карточке товара в НК
129
Параметр
Тип
Обяз.
Описание
Комментарий
*tnVedCode1
string
-
Код ТН ВЭД (10
Возвращается в ответе при условии
0
знаков)
указания сведений в карточке товара в НК
*tnVedCode
string
-
Код ТН ВЭД
Возвращается в ответе при условии
указания сведений в карточке товара в НК
*foreignProdu
object
-
Объект с данными
Возвращается в ответе при условии
cer
о производителе
указания сведений в карточке товара в НК
**name
string
+
Наименование
Возвращается в ответе при условии
производителя
указания сведений в карточке товара в НК.
Возвращается обязательно при возврате
объекта "foreignProducer" ("Объект с
данными о производителе")
**inn
string
-
ИНН
Возвращается в ответе при условии
производителя
указания сведений в карточке товара в НК
или его аналог
**kpp
string
-
КПП
Возвращается в ответе при условии
производителя
указания сведений в карточке товара в НК
или его аналог
**gcp
string
-
GCP
Возвращается в ответе при условии
производителя
указания сведений в карточке товара в НК
**gln
string
-
GLN
Возвращается в ответе при условии
производителя
указания сведений в карточке товара в НК
**address
array[stri
-
Массив адресов
Возвращается в ответе при условии
ng]
производителя
указания сведений в карточке товара в НК
*goodSigned
boolean
-
Признак
Возвращается в ответе при условии
Flag
подписания
указания сведений в карточке товара в НК.
карточки товара в
Если в НК атрибут не заполнен, то в
НК
ответе возвращается null
*goodMarkFl
boolean
-
Признак
Возвращается в ответе при условии
ag
готовности к
указания сведений в карточке товара в НК.
маркировке
Если в НК атрибут не заполнен, то в
ответе возвращается null
130
Параметр
Тип
Обяз.
Описание
Комментарий
*goodTurnFla
boolean
-
Признак
Индикатор заполнения второго слоя и
g
готовности к
подписания карточки товара в НК. Для
обороту
карточек коротких остатков и карточек,
созданных по API НК СУЗ, подпись для
признака goodTurnFlag не проверяется,
поскольку данные карточки не
подписываются.
Если значение = true, то можно заказать
КМ и ввести товар в оборот.
Возвращается в ответе при условии
указания сведений в карточке товара в НК.
Если в НК атрибут не заполнен, то в
ответе возвращается null
*isKit
boolean
-
Признак
Возвращается в ответе при условии
"Комплект" в
указания сведений в карточке товара в НК.
карточке товара
Если в НК атрибут не заполнен, то в
ответе возвращается null
*isTechGtin
boolean
-
Признак
Возвращается в ответе при условии
"Технологический
указания сведений в карточке товара в НК.
" по карточке
Если в НК атрибут не заполнен, то в
товара
ответе возвращается null
*setDescriptio
string
-
Описание набора
Возвращается описание товара в составе
n
набора, содержащее параметры,
специфичные для конкретного товара.
Данный параметр вернётся в том случае,
если он заполнен в карточке НК (см.
"Справочник "Дополнительные
параметры в ответе в зависимости от
товарных групп"").
*isSet
boolean
-
Признак "Набор"
Возвращается в ответе при условии
по карточке
указания сведений в карточке товара в НК.
товара в НК
Если в НК атрибут не заполнен, то в
ответе возвращается null
*country
string
-
Страна
Возвращается в ответе при условии
производства
указания сведений в карточке товара в НК
*fts
object
-
Данные
Возвращается в ответе при условии
полученные ГИС
указания сведений в карточке товара в НК
МТ в ответе от
ФТС при вводе
товара в оборот
**rds
array[obj
-
Массив данных
Возвращается в ответе при условии
ect]
по РД
указания сведений в карточке товара в НК
***authDocD
string
-
Дата
Возвращается в ответе при условии
ate
разрешительного
указания сведений в карточке товара в НК
документа
131
Параметр
Тип
Обяз.
Описание
Комментарий
***authDocN
string
-
Номер
Возвращается в ответе при условии
umber
разрешительного
указания сведений в карточке товара в НК
документа
**countries
array[stri
-
Массив стран
Возвращается в ответе при условии
ng]
производства
указания сведений в карточке товара в НК
**tnVedCode
array[stri
-
Массив кодов ТН
Возвращается в ответе при условии
10
ng]
ВЭД (10 знаков)
указания сведений в карточке товара в НК
*colors
array[stri
-
Массив
Возвращается в ответе при условии
ng]
уникальных
указания сведений в карточке товара в НК
значений цветов
изделия
*setGtin
array[obj
-
Массив кодов
Возвращается в ответе, если "isSet" = true,
ect]
товара, входящих
при условии указания сведений в карточке
в состав набора
товара в НК
**gtin
string
+
Код товара,
Возвращается в ответе при условии
входящего в
указания сведений в карточке товара в НК
набор
**quantity
integer(i
+
Количество
Возвращается в ответе при условии
nt32)
указания сведений в карточке товара в НК
*level
string
-
Уровень упаковки
Возможные значения:
trade-unit - единица товара;
inner-pack - групповая упаковка.
Возвращается в ответе при условии
указания сведений в карточке товара в НК
*multiplier
integer
-
Количество
вложений в
упаковку
*mainGtin
string
-
Код товара,
Обязательный, если значение параметра
вложенного в
"level" ("Уровень упаковки") не равно
потребительскую
"trade-unit" ("Единица товара").
упаковку
Возвращается в ответе при условии
указания сведений в карточке товара в НК
132
Параметр
Тип
Обяз.
Описание
Комментарий
*goodStatus
string
-
Cтатус карточки
Возвращается в ответе при условии
товара в НК
указания сведений в карточке товара в НК.
Если карточка товара выводится из GS1,
то параметр не возвращается.
Возможные значения:
draft - карточка товара в разных статусах в
ЛК НК: "Черновик", "На модерации",
"Требует изменений", "Ожидает
подписания";
published - опубликованная карточка
товара;
archived - карточка товара в архиве
*declNumber
string
-
Номер
Возвращается в ответе при условии
декларации о
указания сведений в карточке товара в НК
соответствии
*certNumber
string
-
Номер
Возвращается в ответе при условии
сертификата
указания сведений в карточке товара в НК
соответствия
*regNumber
string
-
Номер
Возвращается в ответе при условии
свидетельства о
указания сведений в карточке товара в НК
государственной
регистрации
*authDocNu
string
-
Номер
Возвращается в ответе при условии
mber
разрешительного
указания сведений в карточке товара в НК
документа
*shortName
string
-
Краткое
Возвращается в ответе при условии
наименование
указания сведений в карточке товара в НК
товара
*basicUnit
string
-
Базовая единица
Возвращается в ответе при условии
измерения
указания сведений в карточке товара в НК
*fullName
string
-
Полное
Возвращается в ответе при условии
наименование
указания сведений в карточке товара в НК
товара
total
integer(i
+
Количество
nt64)
найденных
товаров
errorCode
string
-
Код ошибки
Возвращается при наличии ошибки
2.7. Метод получения списка загруженных документов в
ГИС МТ
URL: /facade/doc/listV2
Метод: GET
133
Примера запроса:
curl '<url
стенда>/facade/doc/listV2?limit=10&order=DESC&orderColumn=receivedAt&did=623136d3-
7a9b-40c9-8ce3-8091e41f83aa&orderedColumnValue=2019-01-28T09:30:40.136Z&pageDir=NEXT'
-H 'content-type: application/json' -H 'Authorization: Bearer <ТОКЕН>'
Параметры запроса:
Параметр
Тип
Обяз.
Описание
dateFrom
string
-
Дата документа, от. Задается в формате yyyy-
(date-
MM-ddTHH:mm:ss.SSS’ZTHH:mm:ss.SSS’Z,
time)
пример 2019-01-01T03:00:00.000Z
dateTo
string
-
Дата документа, до. Задается в формате yyyy-
(date-
MM-ddTHH:mm:ss.SSS’ZTHH:mm:ss.SSS’Z,
time)
пример 2019-01-01T03:00:00.000Z
senderInn
string
-
ИНН отправителя документа.
Недопустимо указывать совместно с
параметром "receiverInn" ("ИНН получателя
документа")
receiverInn
string
-
ИНН получателя документа.
Недопустимо указывать совместно с
параметром "senderInn" ("ИНН отправителя
документа")
did
string
-
Значение номера документа, "точки отсчёта"
(запись с которой начнётся выборка), по
которому сортируются записи. Использовать
только совместно с параметром
"orderedColumnValue".
При указании данного параметра необходимо
указать параметр "pg" ("Товарная группа")
documentFormat
string
-
Тип документа:
"MANUAL" - формат JSON;
"UPD" - ЭДО;
"XML" - формат XML;
"CSV" - формат CSV
documentStatus
enum
-
Статус документа (см. "Справочник "Статусы
документов"")
documentType
array[stri
-
Тип документа (см. "Справочник "Типы
ng]
документов"")
inputFormat
boolean
-
Входящий (true) / исходящий (false) документ
134
Параметр
Тип
Обяз.
Описание
limit
integer
-
Значение устанавливает количество записей в
ответе, не более 10000 записей. (По умолчанию
10 записей). При указании параметра "limit",
параметр "pg" ("Товарная группа") становится
обязательным
number
string
-
Номер документа.
При указании параметра "number" в запросе,
параметр "did" ("Значение номера документа")
в пагинации будет игнорироваться
order
enum
-
Направление сортировки:
"ASC" - по возрастанию;
"DESC" - по убыванию
orderColumn
string
-
Название столбца, по которому будет
производиться сортировка. Допустимое
значение: "receivedAt" ("Дата эмиссии")
orderedColumnValue
string
-
Значение столбца, "точки отсчёта" (запись, с
которой начнётся выборка), по которому
сортируются записи. Использовать только
совместно с параметром "did".
Если параметр задан для ТГ "Альтернативная
табачная продукция", "Никотиносодержащая
продукция", "Табачная продукция", то
параметр "pageDir" ("Выбор направления")
также становится обязательным
pageDir
enum
-
Выбор направления:
"PREV" - Предыдущий раздел;
"NEXT" - Следующий раздел .
Параметр обязателен для ТГ "Альтернативная
табачная продукция", "Никотиносодержащая
продукция", "Табачная продукция" при
указании параметров "orderedColumnValue"
("Вначение столбца, по которому сортируются
записи") и "did" ("Значение номера документа,
по которому сортируются записи")
participantInn
string
-
ИНН участника оборота товара
135
Параметр
Тип
Обяз.
Описание
pg
string
-
Товарная группа (см. Справочник "Список
поддерживаемых товарных групп").
Параметр обязательно указывать для товарных
групп:
"milk" - "Молочная продукция";
"water" - "Упакованная вода".
В параметре "pg" ("Товарная группа") также
доступно
указание
значения
"empty"
("Неопределённая товарная группа"). Данное
значение указывается с целью выявления
документов, для которых товарная группа не
была определена.
Для получения в ответе документа,
содержащего данные по нескольким товарным
группам, необходимо, чтобы значение
параметра
"pg"
("Товарная
группа")
соответствовало одному из значений товарной
группы, указанной в документе
page
integer
-
Номер страницы
Параметры заголовка запроса: Authorization: Bearer <token>
Пример ответа:
{
"results": [
{
"number": "string",
"docDate": 0,
"receivedAt": 0,
"type": "UNKNOWN",
"status": "IN_PROGRESS",
"externalId": "string",
"senderName": "string",
"receiverName": "string",
"invoiceNumber": "string",
"invoiceDate": 0,
"total": 0,
"vat": 0,
"downloadStatus": "string",
"downloadDesc": "string",
"cisTotal": 0,
"body": {
"additionalProp1": {},
"additionalProp2": {},
"additionalProp3": {}
136
},
"content": "string",
"input": true,
"pdfFile": "string",
"errors": [
"string"
],
"docErrors": [
{
"additionalProp1": {},
"additionalProp2": {},
"additionalProp3": {}
}
],
"atk": "string",
"sender": {
"name": "string",
"address": "string",
"inn": "string",
"kpp": "string"
},
"receiver": {
"name": "string",
"address": "string",
"inn": "string",
"kpp": "string"
}
}
],
"total": 0,
"docErrors": [
{
"additionalProp1": {},
"additionalProp2": {},
"additionalProp3": {}
}
]
}
Параметры ответа:
Параметр
Тип
Обяз.
Описание
Комментарий
results
+
*number
string
-
Номер документа
*docDate
string
+
Дата документа
Возвращается в формате yyyy-MM-
(date-
ddTHH:mm:ss.SSS’ZTHH:mm:ss.SSS’Z
time)
137
Параметр
Тип
Обяз.
Описание
Комментарий
*receivedAt
string
-
Дата и время
Возвращается в формате yyyy-MM-
(date-
получения
ddTHH:mm:ss.SSS’ZTHH:mm:ss.SSS’Z
time)
документа
*type
string
+
Тип документа
См. "Справочник "Типы документов""
*status
string
+
Статус обработки
См. "Справочник "Статусы документов""
документа
*externalId
string
-
Id документа во
внешней системе
ЭДО
*senderName
string
+
Наименование
отправителя
документа
*receiverNam
string
-
Наименование
e
получателя
документа
*invoiceNum
string
-
Номер счёта-
ber
фактуры, УКД
*invoiceDate
string
-
Дата счёта-
Возвращается в формате yyyy-MM-
(date-
фактуры, УКД
ddTHH:mm:ss.SSS’Z
time)
*total
Number
-
Общая сумма
документа
*vat
Number
-
Сумма НДС
документа
*downloadSta
string
-
Статус загрузки
См. "Справочник "Статусы документов""
tus
документа
*downloadDe
string
-
Описание
При наличии ошибки в загрузке
sc
загрузки
документа
документа
*cisTotal
integer
-
Количество КИ в
составе
документа
*body
Object
+
Контент
Тело отправленного документа в JSON
документа
формате
additionalPro
Object
+
Контент
Тело документа из метода "Метод
p
документа
получения содержимого загруженного
документа по идентификатору"
*content
string
+
Контент
Оригинальное содержимое документа
документа
138
Параметр
Тип
Обяз.
Описание
Комментарий
*input
Boolean
+
Признак того, что
Возможные значения:
документ
true - входящий;
является
false - исходящий
входящим/исходя
щим
*docErrors
[string]
-
Список ошибок
обработки
документа.
Возвращается в
случае ошибки
additionalPro
string
-
Список ошибок
Структура данных, состоящая из перечня
p
обработки
ошибок обработки документа.
документа
Возвращается в случае ошибки
*pdfFile
string
-
Ссылка на PDF-
файл
*errors
[string]
-
Ошибки.
Параметр
возвращается при
наличии ошибки.
*atk
string
-
агрегированный
таможенный код
*sender
string
-
Отправитель
**name
string
-
Наименование
**address
string
-
Адрес
**inn
string
-
ИНН
**kpp
string
-
КПП
Код причины постановки на учет
*receiver
string
-
Отправитель
**name
string
-
Наименование
**address
string
-
Адрес
**inn
string
-
ИНН
**kpp
string
-
КПП
Код причины постановки на учет
total
integer
+
Количество вернувшихся документов в
ответе
docErrors
[string]
-
Список ошибок
обработки
документа.
Возвращается в
случае ошибки
139
Параметр
Тип
Обяз.
Описание
Комментарий
additionalPro
string
-
Список ошибок
Структура данных, состоящая из перечня
p
обработки
ошибок обработки документа.
документа
Возвращается в случае ошибки
2.8. Метод поиска чека по идентификатору
URL: /facade/receipt/{receiptId}
Метод: GET
Пример запроса:
curl -X GET
"<url стенда>/facade/receipt/{receiptId}"
-H "accept: */*" -H "Authorization: Bearer <ТОКЕН>"
Параметры запроса:
Параметр
Тип
Обяз.
Описание
receiptId
string
+
Идентификатор чека
pg
string
-
Товарная группа.
Параметр обязательно указывать для товарных
групп:
milk - Молочная продукция;
water - Вода
Параметры заголовка запроса: Authorization: Bearer <token>
Пример ответа:
140
{
"number": "string",
"docDate": 0,
"receivedAt": 0,
"type": "UNKNOWN",
"status": "IN_PROGRESS",
"externalId": "string",
"senderName": "string",
"receiverName": "string",
"invoiceNumber": "string",
"invoiceDate": 0,
"total": 0,
"vat": 0,
"downloadStatus": "string",
"downloadDesc": "string",
"body": {
"additionalProp1": {},
"additionalProp2": {},
"additionalProp3": {}
},
"content": "string",
"input": true,
"pdfFile": "string",
"errors": [
"string"
],
"docErrors": [
{
"additionalProp1": {},
"additionalProp2": {},
"additionalProp3": {}
}
],
"atk": "string",
"sender": {
"name": "string",
"address": "string",
"inn": "string",
"kpp": "string"
},
"receiver": {
"name": "string",
"address": "string",
"inn": "string",
"kpp": "string"
},
"contractId": "string",
"eliminationReason": "KM_SPOILED"
}
141
Параметры ответа:
Параметр
Тип
Обяз.
Описание
Комментарий
number
string
-
Номер документа
docDate
string
+
Дата документа.
Возвращается в формате yyyy-MM-
(date-
ddTHH:mm:ss.SSS’ZTHH:mm:ss.SSS’Z
time)
receivedAt
string
-
Дата и время
Возвращается в формате yyyy-MM-
(date-
получения
ddTHH:mm:ss.SSS’ZTHH:mm:ss.SSS’Z.
time)
документа
Пример 2019-01-01T03:00:00.000Z
type
string
+
Тип документа
См. "Справочник "Типы документов""
status
string
+
Статус обработки
См. "Справочник "Статусы документов""
документа
externalId
string
-
Id документа во
внешней системе
ЭДО
senderName
string
+
Наименование
отправителя
документа
receiverName
string
-
Наименование
получателя
документа
buyer
string
-
Наименование
покупателя
buyerInn
string
-
ИНН покупателя
invoiceNumb
string
-
Номер счёта-
er
фактуры, УКД
invoiceDate
string
-
Дата счёта-
Возвращается в формате yyyy-MM-
(date-
фактуры, УКД
ddTHH:mm:ss.SSS’Z.
time)
total
Number
-
Общая сумма
документа в
копейках
vat
Number
-
Сумма НДС
документа в
копейках
downloadStat
string
-
Статус загрузки
См. "Справочник "Статусы документов""
us
документа
downloadDes
string
-
Описание
При наличии ошибки в загрузке
c
загрузки
документа
документа
142
Параметр
Тип
Обяз.
Описание
Комментарий
body
Object
-
Контент
Тело отправленного документа в JSON
документа
формате
additionalPro
Object
-
Контент
Тело документа из метода "Метод
p
документа
получения содержимого загруженного
документа по идентификатору"
content
string
-
Контент
Оригинальное содержимое документа
документа
input
boolean
-
Признак того, что
Возможные значения:
документ
true - входящий;
является
false - исходящий
входящим/исходя
щим
pdfFile
string
-
Ссылка на PDF-
файл
errors
[string]
-
Ошибки.
Параметр
возвращается при
наличии ошибки.
docErrors
[string]
-
Список ошибок
обработки
документа.
Возвращается в
случае ошибки
additionalPro
string
-
Список ошибок
Структура данных, состоящая из перечня
p
обработки
ошибок обработки документа.
документа
Возвращается в случае ошибки
sender
string
-
Отправитель
*name
string
-
Наименование
*address
string
-
Адрес
*inn
string
-
ИНН
*kpp
string
-
КПП
Код причины постановки на учет
receiver
string
-
Получатель
*name
string
-
Наименование
*address
string
-
Адрес
*inn
string
-
ИНН
*kpp
string
-
КПП
Код причины постановки на учет
contractId
string
-
Идентификатор
гос. контракта
143
Параметр
Тип
Обяз.
Описание
Комментарий
eliminationRe
string
-
Причина выбытия
См. "Справочник "Причины выбытия""
ason
2.9. Метод поиска тела чека по идентификатору
URL: /facade/receipt/{receiptId}/body
Метод: GET
Пример запроса:
curl -X GET
"<url
стенда>/facade/receipt/{receiptId}/body?paging=true&offset=0&limit=0&orderedColumnValu
e=string&pageDir=PREV&pg=string&content=true&body=true"
-H "accept: */*" -H "Authorization: Bearer <ТОКЕН>'
Параметры запроса:
Параметр
Тип
Обяз.
Описание
receiptId
string
+
Идентификатор чека
filter
array
+
Фильтр запроса (может передаваться пустым)
*limit
integer
-
Значение устанавливает количество записей в
ответе, не более 10000 записей. (По умолчанию
10 записей)
*pageDir
enum
-
Выбор направления:
PREV - Предыдущий раздел;
NEXT - Следующий раздел
*orderedColumnValue
string
-
Значение столбца, "точки отсчета" (запись, с
которой начинается выборка), по которому
сортируются записи
*pg
string
-
Товарная группа:
параметр обязательно указывать для товарных
групп:
milk - "Молочная продукция";
water - "Упакованная вода"
144
Параметр
Тип
Обяз.
Описание
paging
boolean
-
Пагинация. Возможные значения:
true - новая;
false - старая (по умолчанию)
Если значение = true, то применять параметры
"offset" ("Смещение по КИ в теле документа")
и "limit" ("Количество записей в ответе"). Если
значение = false, то применять параметры
"orderedColumnValue" ("Значение столбца,
"точки отсчёта" (запись, с которой начинается
выборка), по которому сортируются записи"),
"pageDir" ("Выбор направления пагинации") и
"limit" ("Количество записей в ответе")
offset
integer
-
Смещение по КИ в теле документа
content
boolean
-
Запрос контента чека.
Возможные значения:
true - да (по умолчанию);
false - нет
body
boolean
-
Запрос тела чека.
Возможные значения:
true - да (по умолчанию);
false - нет
Параметры заголовка запроса: Authorization: Bearer <token>
Пример ответа:
145
{
"number": "string",
"docDate": 0,
"receivedAt": 0,
"type": "UNKNOWN",
"status": "IN_PROGRESS",
"externalId": "string",
"senderName": "string",
"receiverName": "string",
"invoiceNumber": "string",
"invoiceDate": 0,
"total": 0,
"vat": 0,
"downloadStatus": "string",
"downloadDesc": "string",
"body": {
"additionalProp1": {},
"additionalProp2": {},
"additionalProp3": {}
},
"content": "string",
"input": true,
"pdfFile": "string",
"errors": [
"string"
],
"docErrors": [
{
"additionalProp1": {},
"additionalProp2": {},
"additionalProp3": {}
}
],
"atk": "string",
"sender": {
"name": "string",
"address": "string",
"inn": "string",
"kpp": "string"
},
"receiver": {
"name": "string",
"address": "string",
"inn": "string",
"kpp": "string"
},
"contractId": "string",
"eliminationReason": "KM_SPOILED"
}
146
Параметры ответа:
Параметр
Тип
Обяз.
Описание
Комментарий
number
string
-
Номер документа
docDate
string
+
Дата документа.
Возвращается в формате yyyy-MM-
(date-
ddTHH:mm:ss.SSS’ZTHH:mm:ss.SSS’Z
time)
receivedAt
string
-
Дата и время
Возвращается в формате yyyy-MM-
(date-
получения
ddTHH:mm:ss.SSS’ZTHH:mm:ss.SSS’Z.
time)
документа
Пример 2019-01-01T03:00:00.000Z
type
string
+
Тип документа
См. "Справочник "Типы документов""
status
string
+
Статус обработки
См. "Справочник "Статусы документов""
документа
externalId
string
-
Id документа во
внешней системе
ЭДО
senderName
string
+
Наименование
отправителя
документа
receiverName
string
-
Наименование
получателя
документа
buyer
string
-
Наименование
покупателя
buyerInn
string
-
ИНН покупателя
invoiceNumb
string
-
Номер счёта-
er
фактуры, УКД
invoiceDate
string
-
Дата счёта-
Возвращается в формате yyyy-MM-
(date-
фактуры, УКД
ddTHH:mm:ss.SSS’Z.
time)
total
Number
-
Общая сумма
документа в
копейках
vat
Number
-
Сумма НДС
документа в
копейках
downloadStat
string
-
Статус загрузки
См. "Справочник "Статусы документов""
us
документа
downloadDes
string
-
Описание
При наличии ошибки в загрузке
c
загрузки
документа
документа
147
Параметр
Тип
Обяз.
Описание
Комментарий
body
Object
+
Контент
Тело отправленного документа в JSON
документа
формате от ОФД
additionalPro
Object
+
Контент
Тело документа из метода "Метод
p
документа
получения содержимого загруженного
документа по идентификатору"
content
string
+
Контент
Оригинальное содержимое документа
документа
input
Boolean
+
Признак того, что
Возможные значения:
документ
true - входящий;
является
false - исходящий
входящим/исходя
щим
pdfFile
string
-
Ссылка на PDF-
файл
errors
[string]
-
Ошибки.
Параметр
возвращается при
наличии ошибки.
docErrors
[string]
-
Список ошибок
обработки
документа.
Возвращается в
случае ошибки
additionalPro
string
-
Список ошибок
Структура данных, состоящая из перечня
p
обработки
ошибок обработки документа.
документа
Возвращается в случае ошибки
sender
string
-
Отправитель
*name
string
-
Наименование
*address
string
-
Адрес
*inn
string
-
ИНН
*kpp
string
-
КПП
Код причины постановки на учет
receiver
string
-
Получатель
*name
string
-
Наименование
*address
string
-
Адрес
*inn
string
-
ИНН
*kpp
string
-
КПП
Код причины постановки на учет
contractId
string
-
Идентификатор
гос. контракта
148
Параметр
Тип
Обяз.
Описание
Комментарий
eliminationRe
string
-
Причина выбытия
См. "Справочник "Причины выбытия""
ason
2.10. Метод получения списка загруженных чеков в ГИС МТ
URL: /facade/receipt/listV2
Метод: GET
Пример запроса:
curl -X GET
"<url стенда>/facade/receipt/listV2?number=string&dateFrom=2020-04-
04T07%3A43%3A27.237Z&dateTo=2020-04-
04T07%3A43%3A27.237Z&participantInn=string&\documentType=UNKNOWN&documentStatus=IN_PRO
GRESS&documentFormat=MANUAL&inputFormat=true&pageDir=PREV&did=string&orderColumn=strin
g&order=ASC&orderedColumnValue=string&limit=0&pg=string"
-H "accept: */*" -H "Authorization: Bearer <ТОКЕН>'
Параметры запроса:
Параметр
Тип
Обяз.
Описание
number
string
-
Номер документа
dateFrom
string
-
Дата документа, от. Формат: yyyy-MM-
(date-
ddTHH:mm:ss.SSS’ZTHH:mm:ss.SSS’Z, пример
time)
2019-01-01T03:00:00.000Z
dateTo
string
-
Дата документа, до. Формат: yyyy-MM-
(date-
ddTHH:mm:ss.SSS’ZTHH:mm:ss.SSS’Z, пример
time)
2019-01-01T03:00:00.000Z
participantInn
string
-
ИНН участника оборота товара
documentType
array[stri
-
Тип документа:
ng]
"RECEIPT" - Чек;
"RECEIPT_RETURN" - Чек возврата
documentStatus
enum
-
Статус документа (см. "Справочник "Статусы
документов"")
documentFormat
string
-
Тип документа:
"MANUAL" - формат * .json;
"UPD" - ЭДО;
"XML" - формат * .xml;
"CSV" - формат * .csv
inputFormat
boolean
-
Входящий (true) / исходящий (false) документ
149
Параметр
Тип
Обяз.
Описание
did
string
-
Значение номера документа, "точки отсчёта"
(запись с которой начнётся выборка), по
которому сортируются записи. Использовать
только совместно с параметром
"orderedColumnValue" ("Название столбца, по
которому будет производиться сортировка").
При указании данного параметра необходимо
указать параметр "pg" ("Товарная группа")
limit
integer
-
Значение устанавливает количество записей в
ответе, не более 10000 записей. (По умолчанию
10 записей).
При указании данного параметра необходимо
указать параметр "pg" ("Товарная группа")
pageDir
enum
-
Выбор направления:
"PREV" - Предыдущий раздел;
"NEXT" - Следующий раздел .
Параметр обязателен для ТГ "Альтернативная
табачная продукция", "Никотиносодержащая
продукция", "Табачная продукция" при
указании параметров "orderedColumnValue"
("Вначение столбца, по которому сортируются
записи") и "did" ("Значение номера документа,
по которому сортируются записи")
order
enum
-
Направление сортировки:
"ASC" - по возрастанию;
"DESC" - по убыванию
orderColumn
string
-
Название столбца, по которому будет
производиться сортировка. Допустимое
значение: "receivedAt" ("Дата получения
документа")
orderedColumnValue
string
-
Значение столбца, "точки отсчёта" (запись, с
которой начнётся выборка), по которому
сортируются записи. Использовать только
совместно с параметром "did" ("Значение
номера документа").
Если параметр задан для ТГ "Альтернативная
табачная продукция", "Никотиносодержащая
продукция", "Табачная продукция", то
параметр "pageDir" ("Выбор направления")
также становится обязательным
150
Параметр
Тип
Обяз.
Описание
pg
string
-
Товарная группа.
Параметр обязательно указывать для товарных
групп:
"milk" - "Молочная продукция";
"water" - "Упакованная вода"
page
integer
-
Номер страницы
Пример ответа:
{
"results": [
{
"number": "string",
"docDate": 0,
"receivedAt": 0,
"type": "UNKNOWN",
"status": "IN_PROGRESS",
"externalId": "string",
"senderName": "string",
"receiverName": "string",
"invoiceNumber": "string",
"invoiceDate": 0,
"total": 0,
"vat": 0,
"downloadStatus": "string",
"downloadDesc": "string",
"body": {
"additionalProp1": {},
"additionalProp2": {},
"additionalProp3": {}
},
"content": "string",
"input": true,
"pdfFile": "string",
"errors": [
"string"
],
"docErrors": [
{
"additionalProp1": {},
"additionalProp2": {},
"additionalProp3": {}
}
],
"atk": "string",
"sender": {
"name": "string",
151
"address": "string",
"inn": "string",
"kpp": "string"
},
"receiver": {
"name": "string",
"address": "string",
"inn": "string",
"kpp": "string"
}
}
],
"total": 0,
"docErrors": [
{
"additionalProp1": {},
"additionalProp2": {},
"additionalProp3": {}
}
]
}
Параметры ответа:
Параметр
Тип
Обяз.
Описание
Комментарий
results
+
number
string
-
Номер документа
docDate
string
+
Дата документа
Возвращается в формате yyyy-MM-
(date-
ddTHH:mm:ss.SSS’ZTHH:mm:ss.SSS’Z
time)
receivedAt
string
-
Дата и время
Возвращается в формате yyyy-MM-
(date-
получения
ddTHH:mm:ss.SSS’ZTHH:mm:ss.SSS’Z.
time)
документа
Пример 2019-01-01T03:00:00.000Z
type
string
+
Тип документа
Тип документа:
RECEIPT - Чек;
RECEIPT_RETURN - Чек возврата
status
string
+
Статус обработки
См. "Справочник "Статусы документов""
документа
externalId
string
-
Id документа во
внешней системе
ЭДО
senderName
string
+
Наименование
отправителя
документа
152
Параметр
Тип
Обяз.
Описание
Комментарий
receiverName
string
-
Наименование
получателя
документа
invoiceNumb
string
-
Номер счёта-
er
фактуры, УКД
invoiceDate
string
-
Дата счёта-
Возвращается в формате yyyy-MM-
(date-
фактуры, УКД
ddTHH:mm:ss.SSS’Z
time)
total
Number
-
Общая сумма
документа
vat
Number
-
Сумма НДС
документа
downloadStat
string
-
Статус загрузки
См. "Справочник "Статусы документов""
us
документа
downloadDes
string
-
Описание
При наличии ошибки в загрузке
c
загрузки
документа
документа
body
Object
+
Контент
Тело отправленного документа в * .json
документа
формате
additionalPro
Object
+
Контент
Тело документа из метода "Метод
p
документа
получения содержимого загруженного
документа по идентификатору"
content
string
+
Контент
Оригинальное содержимое документа
документа
input
Boolean
+
Признак того, что
Возможные значения:
документ
true - входящий;
является
false - исходящий
входящим/исходя
щим
pdfFile
string
-
Ссылка на PDF-
файл
errors
[string]
-
Ошибки.
Параметр
возвращается при
наличии ошибки
docErrors
[string]
-
Список ошибок
обработки
документа.
Возвращается в
случае ошибки
153
Параметр
Тип
Обяз.
Описание
Комментарий
additionalPro
string
-
Список ошибок
Структура данных, состоящая из перечня
p
обработки
ошибок обработки документа.
документа
Возвращается в случае ошибки
atk
string
-
Агрегированный
таможенный код
sender
string
-
Отправитель
*name
string
-
Наименование
*address
string
-
Адрес
*inn
string
-
ИНН
*kpp
string
-
КПП
Код причины постановки на учёт
receiver
string
-
Получатель
*name
string
-
Наименование
*address
string
-
Адрес
*inn
string
-
ИНН
*kpp
string
-
КПП
Код причины постановки на учёт
total
string
+
Количество
вернувшихся
ответов
docErrors
[string]
-
Список ошибок
обработки
документа.
Возвращается в
случае ошибки
additionalPro
string
-
Список ошибок
Структура данных, состоящая из перечня
p
обработки
ошибок обработки документа.
документа
Возвращается в случае ошибки
2.11. Метод получения содержимого загруженного документа
по идентификатору
Метод недоступен для товарных групп "Альтернативная табачная продукция" и "Табачная
продукция". Метод возвращает общую информацию о запрашиваемом документе, включая
статус обработки документа. В одном запросе можно запросить информацию по одному
документу (см. "Справочник "Типы документов""). Получение информации о документе
возможно только в том случае, если участник оборота товаров, запрашивающий информацию о
документе, является подписантом данного документа.
Для получения содержимого документа "Ввод в оборот. Импорт с ФТС" или "Ввод в оборот.
Производство вне ЕАЭС" (см. "Справочник "Типы документов"") в параметре запроса "docId"
указывается уникальный идентификатор документа. В параметре ответа "did" содержится номер
ДТ, указанный при подаче документа.
154
Для документа с типом LP_FTS_INTRODUCE_RESPONSE (см. "Справочник "Типы
документов"") получение содержимого (заполненного поля "body") на данный момент возможно
только для организаций с типом IS_MP_OPERATOR (Оператор ГИС МТ) и OGV (Орган
государственной власти), см. "Справочник "Типы организаций"".
Для
получения
содержимого
(параметр
"body")
документа
с
типом
LP_FTS_INTRODUCE_RESPONSE (см. "Справочник "Типы документов"") в параметре запроса
"docId" указывается номер ДТ. В параметре ответа "did" содержится уникальный идентификатор
документа "Ввод в оборот. Импорт с ФТС" или "Ввод в оборот. Производство вне ЕАЭС".
Реализованная версия метода (v4/facade/doc/{docId}/body) позволяет получить в ответе КИ в
теле документа c отражением количества вложенных КИ: параметр "children" в ответе в теле
документа ("body") остаётся скрытым. Данный принцип работы метода действует для всех типов
документов всех товарных групп.
Далее приведён пример ответа при запросе содержимого документа "Отгрузка", при котором в
ответе возвращаются только КИ агрегата, указанные в теле документа ("uitu_code") без указания
вложений.
Дополнительную информацию также см. в разделе "Указание параметров в строке запроса при
работе с большими агрегатами".
URL: v3/facade/doc/{docId}/body является устаревшим и в дальнейшем будет отключён.
Рекомендуется использовать новую версию метода v4/facade/doc/{docId}/body.
Метод: GET
Пример строки запроса:
curl -X GET
'<url стенда>/facade/doc/a11a1a11-a1aa-1111-11a1-
1aa11a1a1a11/body?paging=true&offset=0&limit=0&orderedColumnValue=string&pageDir=PREV&
pg=string&content=true&body=true'
-H "accept: */*' -H 'Authorization: Bearer <ТОКЕН>'
При необходимости получения информации о более 10 000 КИ необходимо повторить запрос.
Пример нескольких запросов:
Первый запрос:
/v4/facade/doc/a11a1a11-a1aa-1111-11a1-
1aa11a1a1a11/body?pg=shoes&order=ASC&orderColumn=emd&pageDir=NEXT&limit={Лимит}&cache=
false
Второй и последующие запросы:
/v4/facade/doc/a11a1a11-a1aa-1111-11a1-
1aa11a1a1a11/body?pg=shoes&order=ASC&orderColumn=emd&pageDir=NEXT&limit={Лимит}&ordere
dColumnValue={КИ}
155
Пример запроса для получения информации по первым нескольким КИ из документа:
/v4/facade/doc/a11a1a11-a1aa-1111-11a1-
1aa11a1a1a11/body?pg=lp&paging=true&offset=0&content=false&body=false&limit=5
Пример запроса для получения информации по следующим 50 КИ из документа:
/v4/facade/doc/a11a1a11-a1aa-1111-11a1-
1aa11a1a1a11/body?pg=lp&paging=true&offset=50&content=true&body=true
Пример запроса для получения информации по следующим 10 КИ из документа:
/v4/facade/doc/a11a1a11-a1aa-1111-11a1-
1aa11a1a1a11/body?pg=lp&paging=true&offset=10&limit=10&content=true&body=true
Параметры строки запроса:
Параметр
Тип
Обяз.
Описание
Комментарий
docId
string
+
Уникальный
идентификатор
документа
limit
integer
-
Количество
Значение устанавливает количество
записей в ответе
записей в ответе. Не более 10000 записей
(по умолчанию 50 записей)
orderedColum
string
-
Значение столбца,
nValue
"точки отсчёта"
(запись, с которой
начинается
выборка), по
которому
сортируются
записи
pageDir
string
-
Выбор
Возможные значения:
направления
PREV - предыдущий раздел;
пагинации
NEXT - следующий раздел
pg
string
-
Товарная группа
Параметр обязательно указывать для
товарных групп:
milk - "Молочная продукция";
water - "Упакованная вода"
См."Справочник "Список
поддерживаемых товарных групп""
156
Параметр
Тип
Обяз.
Описание
Комментарий
paging
boolean
-
Пагинация
Возможные значения:
true - новая;
false - старая (по умолчанию)
Если значение = true, то применять
параметры "offset" ("Смещение по КИ в
теле документа") и "limit" ("Количество
записей в ответе"). Если значение = false,
то применять параметры
"orderedColumnValue" ("Значение столбца,
"точки отсчёта" (запись, с которой
начинается выборка), по которому
сортируются записи"), "pageDir" ("Выбор
направления пагинации") и "limit"
("Количество записей в ответе")
offset
integer
-
Смещение по КИ
При запросе по следующим нескольким
в теле документа
КИ из документа значение параметра
меняется с каждым следующим запросом:
при первом запросе "offset" ("Смещение
по КИ в теле документа") = 0, при
дальнейших запросах: "offset"
("Смещение по КИ в теле документа") =
"offset" ("Смещение по КИ в теле
документа") + limit" ("Количество записей
в ответе")
content
boolean
-
Запрос контента
Возможные значения:
документа
true - да (по умолчанию);
false - нет
body
boolean
-
Запрос тела
Возможные значения:
документа
true - да (по умолчанию);
false - нет
Пример ответа:
{
"number":"string",
"docDate":"0000-00-00T00:00:00.000Z",
"receivedAt":"0000-00-00T00:00:00.000Z",
"type":"LP_SHIP_GOODS",
"status":"CHECKED_OK",
"externalId":"string",
"senderName":"string",
"receiverName":"string",
"invoiceNumber":"string",
"invoiceDate":"string",
"total":0,
"vat":0,
"downloadStatus":"CHECKED_OK",
157
"downloadDesc":"string",
"body":{
"sale":true,
"turnover_type":"SELLING",
"sender_inn":"7777777777",
"document_num":"460",
"document_date":"0000-00-00T00:00:00Z",
"withdrawal_from_turnover":false,
"transfer_date":"0000-00-00T00:00:00Z",
"receiver_inn":"111111111",
"to_not_participant":false,
"products":[
{
"uitu_code":"222222222222222222",
"count_children": 0
}
],
"content":"string",
"input":true,
"pdfFile":"string",
"errors":[
"string"
],
"docErrors":[
{
"additionalProp1":{
},
"additionalProp2":{
},
"additionalProp3":{
}
}
],
"documentDataDto":{
"sum":0,
"did":"string",
"t":0,
"contract_sum":0,
"receipts":[
"string"
],
"e":[
"string"
],
"ost":"string",
"trn":0,
"pc":0,
"vetis":"string",
158
"errors":"string",
"violations":[
"string"
],
"signingDate":0,
"signRecipientFio":"string",
"edoRecipient":"string",
"k_offset":0,
"k_partition":0,
"codes":[
"string"
],
"atkList":[
"string"
],
"exporter":"string",
"exporterId":"string",
"rett":0,
"elr":0,
"receiptId":[
"string"
],
"ext":{
"additionalProp1":{
},
"additionalProp2":{
},
"additionalProp3":{
}
}
},
"atk":"string",
"sender":{
"name":"string",
"address":"string",
"inn":"string",
"kpp":"string"
},
"receiver":{
"name":"string",
"address":"string",
"inn":"string",
"kpp":"string"
},
"contractId":"444444444444444444444",
"eliminationReason":"KM_SPOILED"
}
}
159
Параметры ответа:
Примечание: параметры, выделенные курсивом, возвращаются в ответе в зависимости от типа
документа (см. "Справочник "Типы документов"").
Параметр
Тип
Обяз.
Описание
Комментарий
number
string
+
Номер документа
docDate
string
+
Дата документа
Возвращается в формате yyyy-MM-
ddTHH:mm:ss.SSS’ZTHH:mm:ss.SSS’Z.
Пример 2021-09-01T03:00:00.000Z
receivedAt
string
-
Время получения
Возвращается в формате yyyy-MM-
документа
ddTHH:mm:ss.SSS’ZTHH:mm:ss.SSS’Z.
Пример 2021-09-01T03:00:00.000Z
type
string
+
Тип документа
См. "Справочник "Типы документов""
status
string
+
Статус обработки
См. "Справочник "Статусы документов""
документа
externalId
string
-
ID документа во
внешней системе
ЭДО
senderName
string
+
Наименование
отправителя
документа
receiverName
string
-
Наименование
получателя
документа
invoiceNumb
string
-
Номер счёта-
er
фактуры, УКД
invoiceDate
string
-
Дата счёта-
Возвращается в формате yyyy-MM-
(date-
фактуры, УКД
ddTHH:mm:ss.SSS’Z
time)
total
number
-
Общая сумма в
документе
vat
number
-
Сумма НДС в
документе
downloadStat
string
-
Статус загрузки
См. "Справочник "Статусы документов""
us
документа
downloadDes
string
-
Описание
c
загрузки
документа
body
object
+
Тело документа
Содержимое отправленного документа в
формате * .json с набором полей,
специфичных для каждого типа
документа. См. "Справочник "Типы
документов""
160
Параметр
Тип
Обяз.
Описание
Комментарий
**count_child
integer
+
Кол-во
Возвращается в составе документа
ren
вложенных КИ
*productGrou
string
+
Идентификатор
См. "Справочник "Список
p
товарной группы
поддерживаемых товарных групп""
*sntin
string
-
Серийный номер
КИ
*name
string
+
Наименование
Для документов "Агрегация"
товара
(AGGREGATION_DOCUMENT) "Ввод в
оборот. Импорт с ФТС"
(LP_FTS_INTRODUCE), "Вывод из
оборота" (LK_RECEIPT), "Отгрузка с
выводом из оборота"
(LP_SHIP_RECEIPT), "Отгрузка"
(LP_SHIP_GOODS),"Перемаркировка"
(LK_REMARK), "Приёмка"
("LP_ACCEPT_GOODS"), "Приёмка
отгрузки в ЕАЭС с признанием КИ
(экспорт)"
(EAS_CROSSBORDER_EXPORT_ACCEP
TANCE), "Трансформация"
(REAGGREGATION_DOCUMENT) не
возвращается для типов упаковки "BOX"
("коробка"), "LEVEL2" ("Упаковка 2-го
уровня"), "LEVEL3" ("Упаковка 3-го
уровня"), "ATK" ("Агрегированный
таможенный код")
*count
integer
+
Количество
дочерних единиц
*emissionTyp
string
-
Тип эмиссии
Возможные значения (см. "Справочник
e
"Типы эмиссии КИ"")
*type
string
+
Тип упаковки
Возможные значения:
UNIT - единица товара;
BUNDLE - комплект;
SET - набор
*uit_code
string
+
Уникальный
идентификатор
кода
*status
string
+
Статус
См. "Актуальные статусы"
*uitus
[string]
-
Состав КИТУ
В состав массива входят также атрибуты,
выделенные выше курсивом
**sntin
string
-
КИ, входящий в
агрегат
161
Параметр
Тип
Обяз.
Описание
Комментарий
*gtin
string
-
Код товара
Не возвращается для типов документов
"Агрегация"
(AGGREGATION_DOCUMENT), "Ввод в
оборот. Импорт с ФТС"
(LP_FTS_INTRODUCE), "Отгрузка с
выводом из оборота"
(LP_SHIP_RECEIPT), "Трансформация"
(REAGGREGATION_DOCUMENT). Для
типов документов "Вывод из оборота"
(LK_RECEIPT), "Отгрузка"
(LP_SHIP_GOODS), "Перемаркировка"
(LK_REMARK), "Приёмка"
("LP_ACCEPT_GOODS"), "Приёмка
отгрузки в ЕАЭС с признанием КИ
(экспорт)"
(EAS_CROSSBORDER_EXPORT_ACCEP
TANCE) не возвращается для типов
упаковки "BOX" ("коробка"), "LEVEL2"
("Упаковка 2-го уровня"), "LEVEL3"
("Упаковка 3-го уровня"), "ATK"
("Агрегированный таможенный код")
*country
string
-
Страна
производства
*color
string
-
Цвет
*size
string
-
Размер
content
string
+
Содержимое
документа
input
boolean
+
Признак того, что
Возможные значения:
документ
true - входящий;
является
false - исходящий
входящим/исходя
щим
pdfFile
string
-
Ссылка на PDF-
файл
errors
[string]
-
Ошибки
Параметр возвращается при наличии
ошибки
docErrors
[string]
-
Список ошибок
Возвращается при наличии ошибки
обработки
документа
additionalPro
string
-
Список ошибок
Структура данных, состоящая из перечня
p
обработки
ошибок обработки документа.
документа
Возвращается в случае ошибки
*sum
integer
-
Внутренний
параметр системы
162
Параметр
Тип
Обяз.
Описание
Комментарий
*did
string
-
Идентификатор
документа
*t
integer
-
Внутренний
параметр системы
*contract_su
integer
-
Сумма договора
Внутренний параметр системы
m
*receipts
[string]
-
Чеки
*e
string
-
Внутренний
параметр системы
*ost
string
-
Внутренний
параметр системы
*trn
integer
-
Внутренний
параметр системы
*pc
integer
-
Внутренний
параметр системы
*vetis
string
-
Признак ВетИС
Внутренний параметр системы
*errors
string
-
Ошибки
обработки
документа
(возвращается
только в случае
ошибки)
*violations
[string]
-
Нарушения
*signingDate
integer
-
Дата подписания
*signRecipien
string
-
ФИО получателя
tFio
*edoRecipient
string
-
Получатель
документа ЭДО
*k_offset
integer
-
Внутренний
параметр системы
*k_partition
integer
-
Внутренний
параметр системы
*codes
[string]
-
Коды
*atkList
[string]
-
Список номеров
сформированного
АТК
*exporter
string
-
Экспортёр
*exporterId
string
-
Идентификатор
экспортёра
163
Параметр
Тип
Обяз.
Описание
Комментарий
*rett
integer
-
Внутренний
параметр системы
*elr
integer
-
Внутренний
параметр системы
*receiptId
[string]
-
Идентификатор
получателя
*ext
string
-
Внутренний
параметр системы
additionalPro
string
-
Внутренний
Структура данных, состоящая из
p
параметр системы
внутреннего параметра системы
atk
string
-
Агрегированный
таможенный код
sender
string
-
Отправитель
*name
string
-
Наименование
*address
string
-
Адрес
*inn
string
-
ИНН
*kpp
string
-
КПП
Код причины постановки на учёт
receiver
string
-
Получатель
*name
string
-
Наименование
*address
string
-
Адрес
*inn
string
-
ИНН
*kpp
string
-
КПП
Код причины постановки на учёт
atk
string
-
Агрегированный
таможенный код
contractId
string
-
Идентификатор
государственного
контракта
eliminationRe
string
-
Причина выбытия
См. "Справочник "Причины выбытия""
ason
cancelled_by_
string
-
Идентификатор
Идентификатор документа, послужившего
did
документа
основанием для аннулирования.
аннулирования
Заполняется только для документов в
статусе "CANCELLED" (Аннулирован),
см. "Справочник "Статусы документов""
164
Параметр
Тип
Обяз.
Описание
Комментарий
cancelled_did
string
-
Идентификатор
Возвращается только для документов:
аннулированного
"UNIVERSAL_CANCEL_DOCUMENT"
документа
(Универсальный документ отмены);
"LP_CANCEL_SHIPMENT" (Отмена
отгрузки);
"LP_CANCEL_SHIPMENT_CROSSBORD
ER" (Отмена отгрузки при
трансграничной торговле)
fts_response
string
-
Код решения по
Параметр возвращается только для
товару,
документа "Ввод в оборот. Импорт с
указанному в ДТ
ФТС". ФТС осуществляет проверку по
каждому КИ (построчно), если код
решения ФТС по ДТ = 00, иначе решение
принимается по всей ДТ. Код решения по
КИ имеет более высокий приоритет
(исключения составляет отсутствие
решения на уровне всех КИ). Возможные
значения:
FTS_RESPONSE_OK - положительное
решение ФТС;
FTS_RESPONSE_NOT_OK -
отрицательное решение ФТС;
NULL - решение отсутствует
2.12. Метод получения списка товаров по номеру документа
Метод доступен только для УПД.
URL: /facade/doc/{docId}/products
Метод: GET
Пример запроса:
curl -X GET
'<url стенда>/facade/doc/2BM-7731369928-773101001/products'
-H 'content-type: application/json' -H 'Authorization: Bearer <ТОКЕН>'
Параметры запроса:
Параметр
Тип
Обяз.
Описание
docId
string
+
Возможные
значения:
Уникальный
идентификатор
документа в ГИС МТ,
указывается для ГИС документов;
Идентификатор
юридически
значимого
документа
165
Параметр
Тип
Обяз.
Описание
column
string
-
columnValue
string
-
orderColumn
string
-
Название столбца, по которому будет
производиться сортировка.
orderDir
string
-
Направление сортировки:
ASC - по возрастанию;
DESC - по убыванию
cis
string
-
Код идентификации
name
string
-
Наименование товара
page
integer
-
Количество страниц
pg
string
-
Товарная группа.
Параметр обязательно указывать для товарных
групп:
milk - "Молочная продукция";
water - "Упакованная вода"
limit
integer
-
Значение устанавливает количество записей в
ответе, не более 10000 записей. (По умолчанию
10 записей)
cost_from
integer
-
Цена от
cost_to
integer
-
Цена до
cost_with_tax_from
integer
-
Цена с налогом от
cost_with_tax_to
integer
-
Цена с налогом до
tax_from
integer
-
Налог от
tax_to
integer
-
Налог до
Параметры заголовка запроса: Authorization: Bearer <token>
Пример ответа:
166
{
"results": [
{
"name": "string",
"measure": "string",
"measure_before": "string",
"measure_after": "string",
"cost": 0,
"cost_before": 0,
"cost_after": 0,
"cost_with_tax": 0,
"tax": "string",
"tax_before": "string",
"tax_after": "string",
"tax_sum": 0,
"tax_sum_before": 0,
"tax_sum_after": 0,
"product_cost_without_tax": 0,
"excise": 0,
"no": 0,
"children": [
{
"cis": "string",
"gtin": "string",
"name": "string"
}
],
"products_number": 0,
"products_number_before": 0,
"products_number_after": 0,
"add_info": "string"
}
],
"total": 0,
"docErrors": [
{
"additionalProp1": {},
"additionalProp2": {},
"additionalProp3": {}
}
]
}
Параметры ответа:
Параметр
Тип
Обяз.
Описание
Комментарий
results
array
-
Результат ответа
167
Параметр
Тип
Обяз.
Описание
Комментарий
*name
string
-
Наименование
товара
*measure
string
-
Единица
измерения
*measure_bef
string
-
Единица
ore
измерения до
*measure_aft
string
-
Единица
er
измерения после
*cost
number
-
Цена
*cost_before
number
-
Цена до
*cost_after
number
-
Цена после
*cost_with_ta
number
-
Цена с налогом
x
*tax
string
-
Налог
*tax_before
string
-
Налог до
*tax_after
string
-
Налог после
*tax_sum
number
-
Сумма налога
*tax_sum_bef
number
-
Сумма налога до
ore
*tax_sum_aft
number
-
Сумма налога
er
после
*product_cost
number
-
Цена продукта без
_without_tax
учета налога
*excise
number
-
Акциз
*no
integer
-
*children
array
-
Вложенный КИ
**cis
string
-
Код
идентификации
**gtin
string
-
Код товара
**name
string
-
Название товара
*products_nu
number
-
Номер продукта
mber
*products_nu
number
-
Номер продукта
mber_before
до
*products_nu
number
-
Номер продукта
mber_after
после
168
Параметр
Тип
Обяз.
Описание
Комментарий
*add_info
string
-
Дополнительная
информация
total
integer
+
Количество
вернувшихся
ответов
docErrors
[string]
+
Список ошибок
обработки
документа. Только
в случае ошибки
additionalPro
string
+
Список ошибок
Структура данных, состоящая из перечня
p
обработки
ошибок обработки документа.
документа
Возвращается в случае ошибки
2.13. Метод получения списка 10-ти значных кодов ТН ВЭД
В результате успешного выполнения запроса на получение списка кодов ТН ВЭД с указанием
массива префиксов ТН ВЭД и параметров пагинации в ответе возвращается массив информации
об удовлетворяющих запросу кодах ТН ВЭД и общее число элементов данного массива.
URL: /facade/tnved/search
Метод: GET
Пример запроса:
curl -X GET
'<url
стенда>/facade/tnved/search?validRequest=true&page=0&limit=0&sort=CODE&direction=ASC&p
refix=string&pg=string&code=string
-H 'Authorization: Bearer <ТОКЕН>'
Параметры запроса:
Параметр
Тип
Обяз.
Описание
validRequest
boolean
-
Корректность запроса. Запрос корректный
("validRequest") = true, если указаны все
параметры "page", "limit", "sort", "direction" или
не указан ни один из параметров
code
string
-
Код ТН ВЭД (10 знаков)
limit
integer
-
Значение устанавливает количество записей в
ответе, не более 10000 записей. Обязательный,
если указан один из параметров: "page", "sort",
"direction"
169
Параметр
Тип
Обяз.
Описание
page
integer
-
Номер страницы ответа, начальное значение 0.
(int32)
Обязательный, если указан один из
параметров: "limit", "sort", "direction"
pg
string
-
Товарная группа, может быть указано только
одно значение.
Параметр обязательно указывать для товарных
групп:
milk - "Молочная продукция";
water - "Упакованная вода"
prefix
string
-
Первые цифры кода ТН ВЭД. Используется для
фильтрации товарной группы. Пример
'6401,6402,6403,6404,6405'. Может быть
указано только одно значение
sort
string
-
Обязательный, если указан один из
параметров: "page", "limit", "direction".
Сортировка по:
CODE - коду;
NAME - описание
direction
string
-
Обязательный, если указан один из
параметров: "page", "limit", "sort".
Направление сортировки:
ASC - по возрастанию;
DESC - по убыванию
Пример ответа:
{
"records": [
{
"code": "string" ,
"description": "string"
}
] ,
"total": 0
}
Максимальный размер документа, передаваемого в теле ответа, не должен превышать
5
мегабайт.
Параметры ответа:
170
Параметр
Тип
Обяз.
Описание
records
+
Описание кода ТН ВЭД
*code
string
+
10-ти значный код ТН ВЭД
*description
string
+
Текстовое описание кода ТН ВЭД
total
integer
+
Общее количество кодов ТН ВЭД, подходящие
(int64)
под параметры фильтрации
2.14. Метод получения информации о маркированном товаре
URL: /facade/marked_products/info
Метод: GET
Информацию по указанию параметров в строке запроса при работе с большими агрегатами см. в
разделе "Указание параметров в строке запроса при работе с большими агрегатами".
Пример запроса:
curl -X GET "<url
стенда>/facade/marked_products/info?cis=010460000000000021FFFFFFFFFFFFF&pg=lp"
-H "accept: */*"
-H "Authorization: Bearer<ТОКЕН>
Параметры запроса:
Параметр
Тип
Обяз.
Описание
Комментарий
childrenPagin
boolean
+
Флаг,
При включённом значении возвращает
g
включающий
постранично агрегаты только первого слоя
пагинацию
через указанные ниже параметры.
агрегатов
Значение по умолчанию: false
childrenPage
number
-
Число страниц
Значение по умолчанию: 1
вложений
агрегата первого
слоя
childrenLimit
number
-
Количество
Значение по умолчанию: 50
вложений на
странице агрегата
первого слоя
pg
string
-
Товарная группа
Параметр обязательно указывается в
строке запроса для товарных групп:
milk - "Молочная продукция";
water - "Упакованная вода"
cis
string
+
КИ
Пример ответа:
171
{
"cis": "0000000000000000000a0000DRW.000",
"gtin": "00000000000000",
"sgtin": "0a0000DRW.000",
"tnvd": "0000000000",
"productName": "string",
"producerName": "string",
"producerInn": "7777777777",
"ownerName": "string",
"ownerInn": "7777777777",
"statusEx": "WAIT_SHIPMENT",
"emissionDate": "2021-09-03T07:18:13.461Z",
"producedDate": "2021-09-07T00:00:00.000Z",
"introducedDate": "2021-09-07T17:58:41.819Z",
"emissionType": "LOCAL",
"lastDocId": "6a0db3f1-ed1c-4e95-bcc6-a28db740f04b",
"name": "Вода питьевая негазированная, 2 л",
"brand": "Честный знак",
"certDoc": {
"type": "CONFORMITY_DECLARATION",
"number": "123",
"date": "2021-07-01T00:00:00.000Z"
},
"certDocList": [
{
"type": "CONFORMITY_DECLARATION",
"number": "123",
"date": "2021-07-01T00:00:00.000Z",
"wellNumber": "46246794, 46246795, 46246796, 46246797, 55-Т"
},
{
"type": "STATE_REGISTRATION_CERTIFICATE",
"number": "456",
"date": "2021-07-02T00:00:00.000Z",
"wellNumber": "46246798"
}
],
"prevCises": [],
"nextCises": [],
"status": "INTRODUCED",
"countChildren": 0,
"packType": "UNIT",
"certificateType": "CONFORMITY_DECLARATION",
"certificateNumber": "123",
"certificateDate": "2021-09-06T00:00:00.000Z",
"productGroup": "water",
"markWithdraw": false,
"isSet": false,
"level": "trade-unit",
"multiplier": 1,
172
"fullName": "string",
"babyFoodProduct": "НЕТ",
"structure": "string",
"packMaterial": "string",
"volume": "string",
"isKit": false,
"isTechGtin": false,
"mineralization": "2 г/л",
"goodStatus": "published",
"carbonationMethod": "string",
"productType": "string",
"licences": [
{
"licenceNumber": "12345",
"licenceDate": "2021-09-06"
}
]
}
Параметры ответа:
Параметр
Тип
Обяз.
Описание
Комментарий
cis
string
+
КИ,
используемый для
фильтрации по
списку КИ
gtin
string
-
Код товара
sgtin
string
-
Код товара и
серийный номер
КИ
tnvd
string
-
Код товарной
номенклатуры (10
знаков)
tnvedGroup
string
-
Код товарной
позиции ТН ВЭД
ЕАС товара
(первые 4
символа)
producerNam
string
-
Производитель
e
товара
productName
string
-
Название
продукта
producerInn
string
-
ИНН
производителя/им
портёра товара
173
Параметр
Тип
Обяз.
Описание
Комментарий
ownerInn
string
-
ИНН
собственника
товара
ownerName
string
-
Наименование
собственника
товара
agentInn
string
-
ИНН текущего
владельца товара
agentName
string
-
Наименование
текущего
владельца товара
previousAgen
string
-
ИНН
tInn
предыдущего
владельца товара
previousAgen
string
-
Наименование
tName
предыдущего
владельца товара
turnoverType
enum
-
Вид
Возможные значения:
товарооборота
SELLING - продажа;
COMMISSION - комиссия;
AGENT - агент;
CONTRACT - передача по АКС;
CONTRACT_RETURN - возврат по АКС
statusEx
enum
-
Актуальные
См. "Справочник "Статусы КИ""
особые состояния
КИ
docNum
string
-
Регистрационный
номер документа
emissionDate
string
+
Дата эмиссии КИ
Возвращается в формате yyyy-MM-
(date-
ddTHH:mm:ss.SSS’Z
time)
producedDate
string
-
Дата
Возвращается в формате yyyy-MM-
(date-
производства
ddTHH:mm:ss.SSS’Z. Параметр не
time)
возвращается для КИГУ
introducedDat
string
-
Дата ввода в
Возвращается в формате yyyy-MM-
e
(date-
оборот
ddTHH:mm:ss.SSS’Z
time)
emissionType
string
-
Тип эмиссии
См. "Справочник "Типы эмиссии КИ""
174
Параметр
Тип
Обяз.
Описание
Комментарий
prodOrderTyp
enum
-
Тип
Возможные значения:
e
производственног
о заказа
SELF_MADE - Собственное
производство;
OPERATOR - Производство товара по
договору
lastDocId
string
-
Последний
регистрационный
номер документа,
зафиксированный
в ГИС МТ по
этому КИ
name
string
-
Наименование
товара
brand
string
-
Бренд
model
string
-
Производитель
товара
certDoc
string
-
Сертификат
*date
string
-
Дата сертификата
Возвращается в формате yyyy-MM-
ddTHH:mm:ss.SSS’Z
*number
string
-
Номер
сертификата
*type
string
-
Тип сертификата
certDocList
array of
-
Массив,
objects
содержащий
данные
документов,
подтверждающих
соответствие
*type
string
-
Вид документа
Возможные значения:
разрешительной
документации
CONFORMITY_CERTIFICATE -
сертификат соответствия;
CONFORMITY_DECLARATION -
декларация о соответствии;
STATE_REGISTRATION_CERTIFICATE -
свидетельство о государственной
регистрации (возможное значение для
товарных групп "Биологически активные
добавки к пище", "Молочная продукция",
"Упакованная вода")
*number
string
-
Номер документа
разрешительной
документации
175
Параметр
Тип
Обяз.
Описание
Комментарий
*date
string
-
Дата документа
Возвращается в формате yyyy-MM-
разрешительной
ddTHH:mm:ss.SSS’Z
документации
*wellNumber
string
-
Номер скважины
Возвращается для товарной группы
"Упакованная вода"
prevCises
[string]
-
Предыдущие КИ
в случае
перемаркировки
товара
nextCises
[string]
-
Следующие
номера КИ в
случае
перемаркировки
товара
status
enum
+
Статус КИ
См. "Справочник "Статусы КИ"". Для
перемаркированного КИ возможное
значение "WRITTEN_OFF" (Списан)
remarks
-
Список
перемаркировок
данного товара
*curr
string
-
Текущий КИ
товара
*date
string
-
Дата
Возвращается в формате yyyy-MM-
перемаркировки
ddTHH:mm:ss.SSS’Z
*prev
string
-
предыдущие КИ
товара
cisChildren
[string]
-
Список дочерних
КИ
children
-
КИ в агрегате
*cis
string
+
КИ товара
*gtin
string
-
Код товара
*producerNa
string
-
Производитель
me
товара
*status
enum
+
Статус товара/КИ
См. "Справочник "Статусы КИ""
*emissionDat
string
+
Дата эмиссии
Возвращается в формате yyyy-MM-
e
(date-
ddTHH:mm:ss.SSS’Z
time)
*producedDat
string
-
Дата
Возвращается в формате yyyy-MM-
e
(date-
производства
ddTHH:mm:ss.SSS’Z. Параметр не
time)
возвращается для КИГУ, КИН
*packageType
string
+
Тип упаковки
См. "Справочник "Типы упаковки""
176
Параметр
Тип
Обяз.
Описание
Комментарий
*packageTyp
string
+
Описание типа
Возможные значения:
eDescription
упаковки
PACK - товарная упаковка;
GROUP - групповая упаковка;
BOX - транспортная упаковка;
ATK - агрегированный таможенный код;
KIT - комплект;
PRODUCT_SET - набор
*ownerInn
string
-
ИНН
собственника
товара
*ownerName
string
-
Наименование
собственника
товара
*productNam
string
-
Наименование
e
товара на этикетке
*brand
string
-
Бренд
*nextCises
[string]
-
Следующие
номера КИ в
случае
перемаркировки
товара
*prevCises
[string]
-
Предыдущие
номера КИ в
случае
перемаркировки
товара
*statusEx
enum
-
Актуальные
Cм. "Справочник "Статусы КИ""
особые состояния
КИ
*children:
[string]
-
Все КИ в агрегате
Возвращается в формате JSON-массива
*childrenMap
[string]
-
Краткая
информация о
дочерних КИ
*countChildre
integer
-
Количество
n
дочерних КИ
*parent
string
-
Код
идентификации
упаковки, в
которую
агрегирован товар
177
Параметр
Тип
Обяз.
Описание
Комментарий
*lastDocId
string
-
Последний
регистрационный
номер документа,
зафиксированный
в ГИС МТ по
этому КИ
*expireDate
string
-
Дата истечения
Возвращается в формате yyyy-MM-
(date-
срока годности
ddTHH:mm:ss.SSS’Z (обязательный для
time)
ТГ "Молочная продукция")
*expirationDa
string
-
Дата истечения
Возвращается в формате yyyy-MM-
te
(date-
срока годности
dd’T’HH:mm:ss.SSS’Z' (обязательный для
time)
ТГ "Молочная продукция")
*prVetDocum
string
-
ID
Обязательный параметр для ТГ
ent
производственног
"Молочная продукция". Данный параметр
о ВСД (для
используется вместо устаревшего
продукции,
"prVetDoc"
произведённой в
РФ) или ID
транспортного
ВСД (для
продукции,
произведённой
вне РФ)
*introducedD
string
-
Дата ввода в
Возвращается в формате yyyy-MM-
ate
(date-
оборот с КИ в
ddTHH:mm:ss.SSS’Z
time)
оборот
*exporterNam
string
-
Наименование
e
экспортёра
*exporterTax
string
-
Уникальный
payerId
идентификатор
экспортера в
национальной
системе учёта
налогоплательщи
ков
*agentName
string
-
ИНН текущего
владельца товара
*agentInn
string
-
Наименование
текущего
владельца товара
*lastStatusCh
string
+
Дата последнего
Возвращается в формате yyyy-MM-
angeDate
(date-
изменения статуса
ddTHH:mm:ss.SSS’Z
time)
178
Параметр
Тип
Обяз.
Описание
Комментарий
*turnoverTyp
enum
-
Вид
Возможные значения:
e
товарооборота
SELLING - продажа;
COMMISSION -
(COMMISSIONAIRE_SALE - устар.)
комиссия;
AGENT - агент;
CONTRACT - передача по АКС;
CONTRACT_RETURN - возврат по АКС
*productGrou
string
+
Товарная группа
См. "Справочник "Список
p
поддерживаемых товарных групп""
*tnVed10
string
-
Код ТН ВЭД (10
знаков)
*veterinaryCo
boolean
-
Признак
Возвращается только для ТГ "Молочная
ntrol
подконтрольности
продукция"
ВСД, означающий
необходимость
проверки ВСД в
"ВетИС"
*markWithdr
boolean
-
Зафиксирована
aw
розничная
продажа по чеку
от невладельца
КИ
*withdrawRe
string(1-
-
Причина выбытия
Обязательное поле с описанием причины
asonOther
225)
(другое)
вывода из оборота при значении "Причина
выбытия" ("withdrawReason") = "Другое"
(OTHER)
*productWeig
integer
-
Вес выпущенной
Возвращается только для товарной группы
htGr
продукции
"Молочная продукция" в граммах, первые
три цифры - значение кг, последние три
цифры - десятые, сотые и тысячные.
Например: "productWeightGr": "001234"
означает 1234 грамма или 1.234 кг
*isVarQuantit
boolean
-
Признак
Возвращается только для товарной группы
y
переменного веса
"Молочная продукция"
childrenDetail
[array]
-
Маркированный
s
товар
countChildren
integer
-
Количество
(int32)
дочерних КИ
uitu
string
-
КИТУ
вышестоящего
уровня
179
Параметр
Тип
Обяз.
Описание
Комментарий
parent
string
-
Код
идентификации
упаковки, в
которую
агрегирован товар
packType
string
+
Тип упаковки
См. "Справочник "Типы упаковки""
withdrawReas
string
-
Причина выбытия
См. "Справочник "Причины выбытия""
on
withdrawal_ty
string(1-
-
Другая причина
Параметр обязательный при
pe_other
255)
"withdrawReason" ("Причина выбытия") =
OTHER ("Другое"). В случае указания
иных причин данный параметр
недоступен
receiptDateTi
string
-
Дата вывода из
Возвращается в формате yyyy-MM-
me
оборота
ddTHH:mm:ss.SSS’Z. Поле "receiptDate"
является устаревшим
expireDate
string
-
Дата истечения
Возвращается в формате yyyy-MM-
(date-
срока годности
ddTHH:mm:ss.SSS’Z (обязательный для
time)
ТГ "Молочная продукция")
expirationDat
string
-
Дата истечения
Возвращается в формате yyyy-MM-
e
(date-
срока годности
dd’T’HH:mm:ss.SSS’Z' (обязательный для
time)
ТГ "Молочная продукция")
prVetDocume
string
-
ID
Обязательный параметр для ТГ
nt
производственног
"Молочная продукция". Данный параметр
о ВСД (для
используется вместо устаревшего
продукции,
"prVetDoc"
произведённой в
РФ) или ID
транспортного
ВСД (для
продукции,
произведённой
вне РФ)
veterinaryCon
boolean
-
Признак
Возвращается только для ТГ "Молочная
trol
подконтрольности
продукция"
ВСД, означающий
необходимость
проверки ВСД в
"ВетИС"
exporterName
string
-
Наименование
экспортёра
180
Параметр
Тип
Обяз.
Описание
Комментарий
exporterTaxp
string
-
Уникальный
ayerId
идентификатор
экспортёра в
национальной
системе учета
налогоплательщи
ков
certificateTyp
string
-
Вид документа,
Возможные значения:
e
подтверждающего
CONFORMITY_CERTIFICATE -
соответствие
сертификат соответствия;
CONFORMITY_DECLARATION -
декларация о соответствии;
CONFORMITY_CERTIFICATE_OR_DEC
LARATION - сертификат или декларация
о соответствии
certificateNu
string
-
Номер документа,
mber
подтверждающего
соответствие
certificateDat
string
-
Дата документа,
Возвращается в формате yyyy-MM-
e
подтверждающего
ddTHH:mm:ss.SSS’Z
соответствие
productGroup
string
+
Товарная группа
Cм. "Справочник "Список
поддерживаемых товарных групп""
color
string
-
Цвет
Возвращается для ТГ "Обувные товары"
productSize
string
-
Размер
Возвращается для ТГ "Обувные товары"
productWeigh
integer
-
Вес выпущенной
Возвращается только для товарной группы
tGr
продукции
"Молочная продукция" в граммах, первые
три цифры - значение кг, последние три
цифры - десятые, сотые и тысячные.
Например: "productWeightGr": "001234"
означает 1234 грамма или 1.234 кг
isVarQuantity
boolean
-
Признак
Возвращается только для товарной группы
переменного веса
"Молочная продукция"
*licences
array of
-
Массив лицензий
Значение параметра возвращается для
string
на пользование
товарной группы "Упакованная вода"
недрами
**licenceNu
string
-
Номер лицензии
Возвращается для товарной группы
mber
на пользование
"Упакованная вода"
недрами
181
Параметр
Тип
Обяз.
Описание
Комментарий
**licenceDate
string
-
Дата выдачи
Возвращается для товарной группы
date
лицензии
"Упакованная вода" в формате:
* yyyy-MM-dd; * yyyy-MM-
ddTHH:mm:ss.SSSZ; * yyyy-MM-
ddTHH:mm:ssZ
2.15. Метод получения информации о маркированном товаре
по началу КИ
URL: /facade/marked_products/start_with
Метод: POST
Информацию по указанию параметров в строке запроса при работе с большими агрегатами см. в
разделе "Указание параметров в строке запроса при работе с большими агрегатами".
Пример строки запроса:
curl -X POST "<url стенда>/facade/marked_products/start_with
-H "accept: */*"
-H "Authorization: Bearer<ТОКЕН>
-H "Content-Type: application/json"
-d "{"uit":"010460000000000021FFFFFFFFFFFFF"}"
Параметры строки запроса:
Параметр
Тип
Обяз.
Описание
Комментарий
childrenPagin
boolean
+
Флаг,
При включённом значении возвращает
g
включающий
постранично агрегаты только первого слоя
пагинацию
через указанные ниже параметры.
агрегатов
Значение по умолчанию: false
childrenPage
number
-
Число страниц
Значение по умолчанию: 1
вложений
агрегата первого
слоя
childrenLimit
number
-
Количество
Значение по умолчанию: 50
вложений на
странице агрегата
первого слоя
pg
string
-
Товарная группа
Параметр обязательно указывается в
строке запроса для товарных групп:
milk - "Молочная продукция";
water - "Упакованная вода"
182
Параметр
Тип
Обяз.
Описание
Комментарий
full_cis
boolean
-
Флаг,
Возможные значения:
включающий
поиск по полному
true - полное совпадение значения;
значению КИ
false - совпадение по началу КИ (значение
по умолчанию)
Пример тела запроса:
{
"uit":"010460000000000021FFFFFFFFFFFFF"
}
Параметры тела запроса:
Параметр
Тип
Обяз.
Описание
Комментарий
uit
string
+
КИ
Пример ответа для товарной группы "Молочная продукция":
{
"cis":"010000000000000000jIHZ-XWKbQF5n",
"gtin":"04444444444444",
"sgtin":"jIHZ-XWKbQF5n",
"productName":"Творог 9%",
"producerName":"ООО \"\"",
"producerInn":"7777777777",
"ownerName":"ООО \"\"",
"ownerInn":"7777777777",
"statusEx":null,
"emissionDate":"2021-12-28T11:42:32.098Z",
"emissionType":"LOCAL",
"name":"Творог 9%",
"brand":"Brand",
"certDoc":{},
"prevCises":[],
"nextCises":[],
"status":"INTRODUCED",
"countChildren":0,
"packType":"UNIT",
"expireDate":1633313671000,
"expirationDate":"2021-10-04T02:14:31.000Z",
"prVetDocument":"string",
"productGroup":"milk",
"markWithdraw":false,
"productWeightGr":"999999",
"milkProductType":"ТВОРОГ",
"isSet":false,
183
"level":"trade-unit",
"multiplier":1,
"isVarQuantity":true,
"veterinaryControl":"НЕТ",
"fullName":"Творог 9%",
"volumeWeight":"300.0 г",
"babyFoodProduct":"НЕТ",
"structure":"Молоко коровье непастеризованное",
"isKit":false,
"isTechGtin":false,
"goodStatus":"published",
"paymentGroup":1,
"fat":"9",
"rawOrigin":"КОРОВА",
"expirations": [
{
"expirationStorageDate": "2021-12-25T00:00:00.000Z",
"storageConditionId": 1,
"storageConditionName": "При температуре 20-25"
},
{
"expirationStorageDate": "2021-12-26T00:00:00.000Z",
"storageConditionId": 2,
"storageConditionName": "При температуре 5-20"
},
{
"expirationStorageDate": "2021-12-27T00:00:00.000Z",
"storageConditionId": 3,
"storageConditionName": "При температуре 0-5"
}
],
"applicationDate": "2021-12-28T11:42:32.098Z"
}
Пример ответа для прочих товарных групп:
184
{
"cis":"010460000000000021FFFFFFFFFFFFF",
"gtin":"04600000000000",
"sgtin":"FFFFFFFFFFFFF",
"tnvd":"6201129000",
"productName":"Пальто",
"producerName":"ООО \"ХХХ\"",
"producerInn":"7777777777",
"ownerName":"ООО \"ХХХ\"",
"ownerInn":"7777777777",
"turnoverType":"SALE",
"statusEx":"EMPTY",
"emissionDate":"2021-10-04T02:14:31.000Z",
"producedDate":"2021-10-04T02:14:31.000Z",
"emissionType":"LOCAL",
"name":"Пальто",
"brand":"string",
"certDoc":{
},
"prevCises":[
],
"nextCises":[
],
"status":"APPLIED",
"countChildren":0,
"packType":"string",
"receiptDate":"2021-10-04T00:00:00.000Z",
"productGroup":"string",
"markWithdraw":false,
"explain":"Не заполнены обязательные атрибуты и карточка товара не подписана",
"standardNumber":"ТР ТС 007/2011 \"О безопасности продукции, предназначенной для
детей и подростков\"",
"gender":"ЖЕНСКИЙ",
"color":"БЕЖЕВЫЙ",
"isSet":false,
"level":"trade-unit",
"multiplier":1,
"fullName":"Пальто",
"structure":"хлопок 100%",
"productKind":"ПАЛЬТО",
"isKit":false,
"isTechGtin":false,
"goodStatus":"draft",
"size":"42 РОССИЯ",
"applicationDate": "2021-12-28T11:42:32.098Z"
}
185
Параметры ответа:
Параметр
Тип
Обяз.
Описание
Комментарий
applicationDa
string
-
Дата нанесения
Возвращается в формате yyyy-MM-
te
(date-
ddTHH:mm:ss.SSS’Z. Параметр не
time)
возвращается для КИТУ, АТК
cis
string
+
КИ,
используемый для
фильтрации по
списку КИ
gtin
string
-
Код товара
sgtin
string
-
Код товара и
серийный номер
КИ
tnvd
string
-
Код товарной
номенклатуры (10
знаков)
tnvedGroup
string
-
Код товарной
позиции ТН ВЭД
ЕАС товара
(первые 4
символа)
producerNam
string
-
Производитель
e
товара
productName
string
-
Название
продукта
producerInn
string
-
ИНН
производителя/им
портёра товара
ownerInn
string
-
ИНН
собственника
товара
ownerName
string
-
Наименование
собственника
товара
agentInn
string
-
ИНН текущего
владельца товара
agentName
string
-
Наименование
текущего
владельца товара
previousAgen
string
-
ИНН
tInn
предыдущего
владельца товара
186
Параметр
Тип
Обяз.
Описание
Комментарий
previousAgen
string
-
Наименование
tName
предыдущего
владельца товара
turnoverType
enum
-
Вид
Возможные значения:
товарооборота
"SELLING" - "Продажа";
"COMMISSION
(COMMISSIONAIRE_SALE - устар.)" -
"Комиссия";
"AGENT" - "Агент"
statusEx
enum
-
Актуальные
См. "Справочник "Статусы КИ""
особые состояния
КИ
docNum
string
-
Регистрационный
номер документа
emissionDate
string
+
Дата эмиссии КИ
Возвращается в формате yyyy-MM-
(date-
ddTHH:mm:ss.SSS’Z
time)
producedDate
string
-
Дата нанесения
Возвращается в формате yyyy-MM-
(date-
ddTHH:mm:ss.SSS’Z
time)
introducedDat
string
-
Дата ввода в
Возвращается в формате yyyy-MM-
e
(date-
оборот
ddTHH:mm:ss.SSS’Z
time)
emissionType
string
-
Тип эмиссии
См. "Справочник "Типы эмиссии КИ""
prodOrderTyp
enum
-
Тип
Возможные значения:
e
производственног
"SELF_MADE" - "Собственное
о заказа
производство";
"OPERATOR" - "Производство товара по
договору"
lastDocId
string
-
Последний
регистрационный
номер документа,
зафиксированный
в ГИС МТ по
этому КИ
name
string
-
Наименование
товара
brand
string
-
Бренд
model
string
-
Производитель
товара
certDoc
string
-
Сертификат
187
Параметр
Тип
Обяз.
Описание
Комментарий
*date
string
-
Дата сертификата
Возвращается в формате yyyy-MM-
ddTHH:mm:ss.SSS’Z
*number
string
-
Номер
сертификата
*type
string
-
Тип сертификата
certDocList
array of
-
Сведения о
objects
разрешительной
документации
*permitDocT
enum
-
Вид документа
Возможные значения:
ype
обязательной
"CONFORMITY_CERTIFICATE" -
сертификации
"Сертификат соответствия";
"CONFORMITY_DECLARATION"-
"Декларация соответствия";
"CONFORMITY_CERTIFICATE_OR_DEC
LARATION" - "Сертификат или
декларация соответствия";
"STATE_REGISTRATION_CERTIFICATE"
- "Свидетельство государственной
регистрации"
*permitDocN
string
-
Номер документа
umber
*permitDocD
string
-
Дата документа
Возвращается в формате YYYY-MM-DD
ate
prevCises
[string]
-
Предыдущие КИ
в случае
перемаркировки
товара
nextCises
[string]
-
Следующие
номера КИ в
случае
перемаркировки
товара
status
enum
+
Статус КИ
См. "Справочник "Статусы КИ"". Для
перемаркированного КИ возможное
значение "WRITTEN_OFF" (Списан)
remarks
-
Список
перемаркировок
данного товара
*curr
string
-
Текущий КИ
товара
*date
string
-
Дата
Возвращается в формате yyyy-MM-
перемаркировки
ddTHH:mm:ss.SSS’Z
188
Параметр
Тип
Обяз.
Описание
Комментарий
*prev
string
-
Предыдущие КИ
товара
cisChildren
[string]
-
Список дочерних
КИ
children
-
КИ в агрегате
*cis
string
+
КИ товара
*gtin
string
-
Код товара
*producerNa
string
-
Производитель
me
товара
*status
enum
+
Статус товара/КИ
См. "Справочник "Статусы КИ""
*emissionDat
string
+
Дата эмиссии
Возвращается в формате yyyy-MM-
e
(date-
ddTHH:mm:ss.SSS’Z
time)
*producedDat
string
-
Дата ввода товара
Возвращается в формате yyyy-MM-
e
(date-
с КИ в оборот
ddTHH:mm:ss.SSS’Z
time)
*packageType
string
+
Тип упаковки
См. "Справочник "Типы упаковки""
*ownerInn
string
-
ИНН
собственника
товара
*ownerName
string
-
Наименование
собственника
товара
*productNam
string
-
Наименование
e
товара на этикетке
*brand
string
-
Бренд
*nextCises
[string]
-
Следующие
номера КИ в
случае
перемаркировки
товара
*prevCises
[string]
-
Предыдущие
номера КИ в
случае
перемаркировки
товара
*statusEx
enum
-
Актуальные
Cм. "Справочник "Статусы КИ""
особые состояния
КИ
*children
[string]
-
Все КИ в агрегате
Возвращается в формате JSON-массива
189
Параметр
Тип
Обяз.
Описание
Комментарий
*childrenMap
[string]
-
Краткая
информация о
дочерних КИ
*countChildre
integer
-
Количество
n
дочерних КИ
*parent
string
-
Код
идентификации
упаковки, в
которую
агрегирован товар
*lastDocId
string
-
Последний
регистрационный
номер документа,
зафиксированный
в ГИС МТ по
этому КИ
*expireDate
long
-
Дата истечения
Дата и время в формате Unix
срока годности
(обязательный для товарной группы
"Молочная продукция")
*expirationDa
string
-
Дата истечения
Возвращается в формате yyyy-MM-
te
(date-
срока годности
dd’T’HH:mm:ss.SSS’Z' (обязательный для
time)
товарной группы "Молочная продукция")
*prVetDocum
string
-
ID
Обязательный параметр для товарной
ent
производственног
группы "Молочная продукция". Данный
о ВСД (для
параметр используется вместо
продукции,
устаревшего "prVetDoc"
произведённой в
РФ) или ID
транспортного
ВСД (для
продукции,
произведённой
вне РФ)
*introducedD
string
-
Дата ввода в
Возвращается в формате yyyy-MM-
ate
(date-
оборот с КИ в
ddTHH:mm:ss.SSS’Z
time)
оборот
*exporterNam
string
-
Наименование
e
экспортёра
*exporterTax
string
-
Уникальный
payerId
идентификатор
экспортёра в
национальной
системе учёта
налогоплательщи
ков
190
Параметр
Тип
Обяз.
Описание
Комментарий
*agentName
string
-
ИНН текущего
владельца товара
*agentInn
string
-
Наименование
текущего
владельца товара
*lastStatusCh
string
+
Дата последнего
Возвращается в формате yyyy-MM-
angeDate
(date-
изменения статуса
ddTHH:mm:ss.SSS’Z
time)
*turnoverTyp
enum
-
Вид
Возможные значения:
e
товарооборота
"SELLING" - "Продажа";
"COMMISSION
(COMMISSIONAIRE_SALE - устар.)" -
"Комиссия";
"AGENT" - "Агент"
*productGrou
string
+
Товарная группа
См. "Справочник "Список
p
поддерживаемых товарных групп""
*tnVed10
string
-
Код ТН ВЭД (10
знаков)
*veterinaryCo
boolean
-
Признак
Возвращается только для товарной группы
ntrol
подконтрольности
"Молочная продукция"
ВСД, означающий
необходимость
проверки ВСД в
ФГИС "ВетИС"
*markWithdr
boolean
-
Признак выбытия
aw
по чеку ККТ от
невладельца
*productWeig
integer
-
Вес выпущенной
Возвращается только для товарной группы
htGr
продукции
"Молочная продукция" в граммах, первые
три цифры - значение кг, последние три
цифры - десятые, сотые и тысячные.
Например: "productWeightGr": "001234"
означает 1234 грамма или 1.234 кг
*isVarQuantit
boolean
-
Признак
Возвращается только для товарной группы
y
переменного веса
"Молочная продукция"
childrenDetail
[array]
-
Маркированный
s
товар
countChildren
integer
-
Количество
(int32)
дочерних КИ
uitu
string
-
КИТУ
вышестоящего
уровня
191
Параметр
Тип
Обяз.
Описание
Комментарий
parent
string
-
Код
идентификации
упаковки, в
которую
агрегирован товар
packType
string
+
Тип упаковки
См. "Справочник "Типы упаковки""
withdrawReas
string
-
Причина выбытия
См. "Справочник "Причины выбытия""
on
receiptDateTi
string
-
Дата вывода из
Возвращается в формате yyyy-MM-
me
оборота
ddTHH:mm:ss.SSS’Z. Поле "receiptDate"
является устаревшим
expireDate
string
-
Дата истечения
Возвращается в формате yyyy-MM-
(date-
срока годности
ddTHH:mm:ss.SSS’Z (обязательный для
time)
товарной группы "Молочная продукция")
prVetDocume
string
-
ID
Обязательный параметр для товарной
nt
производственног
группы "Молочная продукция". Данный
о ВСД (для
параметр используется вместо
продукции,
устаревшего "prVetDoc"
произведённой в
РФ) или ID
транспортного
ВСД (для
продукции,
произведённой
вне РФ)
exporterName
string
-
Наименование
экспортёра
exporterTaxp
string
-
Уникальный
ayerId
идентификатор
экспортёра в
национальной
системе учета
налогоплательщи
ков
certificateTyp
string
-
Вид документа,
Возможные значения:
e
подтверждающего
соответствие
"CONFORMITY_CERTIFICATE" -
"Сертификат соответствия";
"CONFORMITY_DECLARATION" -
"Декларация о соответствии";
"CONFORMITY_CERTIFICATE_OR_DEC
LARATION" - "Сертификат или
декларация о соответствии";
"STATE_REGISTRATION_CERTIFICATE"
- "Свидетельство о государственной
регистрации"
192
Параметр
Тип
Обяз.
Описание
Комментарий
certificateNu
string
-
Номер документа,
mber
подтверждающего
соответствие
certificateDat
string
-
Дата документа,
Возвращается в формате YYYY-MM-DD
e
подтверждающего
соответствие
productGroup
string
+
Товарная группа
См. Справочник "Список
поддерживаемых товарных групп"
color
string
-
Цвет
Возвращается для товарной группы
"Обувные товары"
productSize
string
-
Размер
Возвращается для товарной группы
"Обувные товары"
productWeigh
integer
-
Вес выпущенной
Возвращается только для товарной группы
tGr
продукции
"Молочная продукция" в граммах, первые
три цифры - значение кг, последние три
цифры - десятые, сотые и тысячные.
Например: "productWeightGr": "001234"
означает 1234 грамма или 1.234 кг
isVarQuantity
boolean
-
Признак
Возвращается только для товарной группы
переменного веса
"Молочная продукция"
*expirations
array
-
Массив сроков
Возвращается только для товарной группы
годности
"Молочная продукция", если в карточке
товара в НКМТ и в отчёте о нанесении
КМ в СУЗ указано несколько сроков
годности
*expirationSt
string
-
Дата срока
Возвращается только для товарной группы
orageDate
годности
"Молочная продукция", если в отчёте о
нанесении КМ указано несколько сроков
годности. Формат: yyyy-MM-
ddTHH:mm:ssZ
*storageCond
integer
-
Идентификатор
Возвращается только для товарной группы
itionId
условия хранения
"Молочная продукция", если в карточке
товара в НКМТ указан идентификатор
условия хранения
*storageCond
string
-
Описание
Возвращается только для товарной группы
itionName
условий хранения
"Молочная продукция", если в карточке
товара в НКМТ указано описание условий
хранения. Формат значения соответствует
указанному в НКМТ с учётом
расширенной информации, указанной в
соответствии с этикеткой на упаковке.
Пример значения: "120 суток при
температуре хранения 0°C и
относительной влажности воздуха от 80%
до 85% включительно"
193
2.16. Метод получения списка полученных КИ с
возможностью фильтрации
URL: facade/agent/received/list
Метод: GET
Информацию по указанию параметров в строке запроса при работе с большими агрегатами см. в
разделе "Указание параметров в строке запроса при работе с большими агрегатами".
Пример строки запроса:
curl -X GET "<url
стенда>/facade/agent/received/list?cis=string&cisMatchMode=EQ&producerInn=string&agent
=string&prevAgent=string&emissionType=INVALID_VALUE&emissionDateFrom=0&emissionDateTo=
0>in=string&sn=string&turnoverType=SELLING&cisAggregationState=PACKED&statusExt=WAIT
_SHIPMENT&cisStatus=INTRODUCED&limit=0&page=0&pg=string"
-H "accept: */*" -H "Authorization: Bearer <Токен>"
Пример объекта "filter" запроса в формате JSON
194
{
"cis": "string",
"cisMatchMode": "EQ",
"producerInn": "string",
"agent": "string",
"prevAgent": "string",
"emissionType": "INVALID_VALUE",
"emissionDateFrom": 0,
"emissionDateTo": 0,
"gtin": "string",
"sn": "string",
"turnoverType": "SELLING",
"cisAggregationState": "PACKED",
"statusExt": "WAIT_SHIPMENT",
"cisStatus": [
"INTRODUCED"
],
"limit": 0,
"page": 0,
"pg": [
"string"
],
"withdrawReason": "string",
"withdrawReasons": [
"REMOTE_SALE",
"DISTANCE",
"BY_SAMPLES"
],
"aggregation": true,
"packageTypes": [
"GROUP"
],
"remarkHistory": "ALL"
}
Параметры запроса:
Параметр
Тип
Обяз.
Описание
Комментарий
childrenPaging
boolean
+
Флаг, включающий пагинацию
При включённом
агрегатов
значении
возвращает
постранично
агрегаты только
первого слоя
через указанные
ниже параметры.
Значение по
умолчанию: false
195
Параметр
Тип
Обяз.
Описание
Комментарий
childrenPage
number
-
Число страниц вложений
Значение по
агрегата первого слоя
умолчанию: 1
childrenLimit
number
-
Количество вложений на
Значение по
странице агрегата первого слоя
умолчанию: 50
cis
string
-
Код идентификации
cisMatchMode
string
-
Режим фильтрации по КИ
Возможные
значения:
EQ - полностью
равен;
LIKE - содержит в
себе. Является
устаревшим и в
дальнейшем будет
удалён.
Рекомендуется
использовать
"START_WITH"
("Начинается с");
START_WITH -
начинается с
producerInn
string
-
ИНН производителя
agent
string
-
ИНН текущего владельца товара
prevAgent
string
-
ИНН предыдущего владельца
товара
emissionType
string
-
Тип эмиссии
Возможные
значения:
LOCAL -
Производство РФ;
FOREIGN -
Ввезен в РФ;
REMAINS -
Маркировка
остатков;
CROSSBORDER
- Ввезен из стран
ЕАЭС
emissionDateFrom
date-
-
Дата эмиссии, от
Задаётся в
time
формате yyyy-
MM-
ddTHH:mm:ss.SSS
’Z. Пример 2019-
01-
01T03:00:00.000Z
196
Параметр
Тип
Обяз.
Описание
Комментарий
emissionDateTo
date-
-
Дата эмиссии, до
Задаётся в
time
формате yyyy-
MM-
ddTHH:mm:ss.SSS
’Z. Пример 2019-
01-
01T03:00:00.000Z
gtin
string
-
Код товара
sn
string
-
Серийный номер
turnoverType
enum
-
Вид товарооборота
Возможные
значения:
SELLING
- продажа;
COMMISSION -
комиссия;
AGENT - агент
cisAggregationState
enum
-
Состояние КИ
Возможные
значения:
PACKED- в
агрегате
(агрегирован);
NOT_PACKED -
не в агрегате
(дезагрегирован);
ANY - любое
состояние
statusExt
enum
-
Дополнительный статус товара
WITHDRAW -
вывод из оборота;
WAIT_SHIPMEN
T - ожидает
подтверждения
приемки;
WAIT_TRANSFE
R_TO_OWNER -
ожидает передачу
собственнику
(производство по
контракту);
REMARK_RETIR
ED -
перемаркирован;
WAIT_REMARK
- КИ списан
после нанесения
на товар (товар
ожидает
перемаркировку)
197
Параметр
Тип
Обяз.
Описание
Комментарий
cisStatus
string
-
Текущий статус КИ
См. справочник
"Актуальные
статусы"
limit
string
-
Значение устанавливает
количество записей в ответе, не
более 10000 записей (по
умолчанию 10 записей)
page
string
-
Номер страницы ответа,
начальное значение 0
pg
string
-
Товарная группа
Параметр
обязательно
указывать для
товарных групп:
milk - Молочная
продукция;
water - Вода
withdrawReason
string
-
Причина выбытия
См. "Справочник
"Причины
выбытия""
withdrawReasons
array of
-
Массив причин вывода из
Параметр имеет
string
оборота
более высокий
приоритет перед
значением
параметра
"withdrawReason"
("Причина
выбытия")
aggregation
boolean
-
Показывать товары и товарные
упаковки только в одном статусе
для агрегации
packageTypes
string
-
Типы упаковок
См. "Справочник
"Типы упаковки"
198
Параметр
Тип
Обяз.
Описание
Комментарий
remarkHistory
string
-
Фильтрация по истории
Возможные
перемаркировки КИ
значения:
ALL - (вся
история) -
выводятся
предыдущие и
новые КИ,
связанные с КИ,
указанным в
параметре "cis";
ENTERED -
(указанный) -
выводится только
указанный в
параметре "cis"
КИ;
ENTERED_AND_
LAST (указанный
и последний) -
выводится только
указанный в
параметре "cis"
КИ и последний в
истории
перемаркировки
КИ
Пример ответа:
{
"results": [
{
"cis": "string",
"gtin": "string",
"sgtin": "string",
"productName": "string",
"tnVed": "string",
"producerName": "string",
"producerInn": "string",
"ownerName": "string",
"ownerInn": "string",
"agentName": "string",
"agentInn": "string",
"previousAgentName": "string",
"previousAgentInn": "string",
"turnoverType": "SELLING",
"status": "EMITTED",
"emissionDate": 0,
"emissionType": "INVALID_VALUE",
199
содержание ..
1
2
3 .. |
||
|
|
|