|
|
содержание .. 1 2 3 ..
{
"0000000000000000000=8xv7rzu't%_": {
"cis": "0104669318392182215=8xv7rzu't%_",
"gtin": "04669318392182",
"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": "7731376812",
"productName": "Вода тестович",
"brand": "Рамзес",
"prevCises": [],
"nextCises": [],
"countChildren": 0,
"lastDocId": "10f1511f-7253-4e34-9235-48acaf930b9b",
"introducedDate": "2021-09-23T13:28:47.615Z",
"agentName": "",
"lastStatusChangeDate": "2021-09-23T13:28:47.615Z",
"productGroup": "water",
"tnVed10": "2201101100",
"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"
}
]
}
}
101
Параметры ответа:
Параметр
Тип
Обяз.
Описание
Комментарий
cis
string
+
Код
идентификации,
используемый для
фильтрации по
списку КИ
gtin
string
-
Код товара
producerNam
string
-
Производитель
e
товара
producerInn
string
-
ИНН
производителя
товара
status
enum
+
Статус КИ
Возможные значения:
EMITTED - Эмитирован. Выпущен;
APPLIED - Эмитирован. Получен;
INTRODUCED - В обороте;
WRITTEN_OFF - КИ списан;
RETIRED - Выбыл;
DISAGGREGATION - Расформирован
(только для упаковок)
emissionDate
string
+
Дата выпуска КИ
Возвращается в формате yyyy-MM-
(date-
ddTHH:mm:ss.SSS’Z
time)
producedDate
string
-
Дата нанесения
Возвращается в формате yyyy-MM-
(date-
ddTHH:mm:ss.SSS’Z
time)
packType
string
+
Тип упаковки
Cм. "Справочник "Типы упаковки""
ownerName
string
-
Наименование
собственника
товара
ownerInn
string
-
ИНН
собственника
товара
productName
string
-
Название
продукта
brand
string
-
Бренд
prevCises
[string]
-
Предыдущие
В случае перемаркировки товара
номера КИ
nextCises
[string]
-
Следующие
В случае перемаркировки товара
номера КИ
102
Параметр
Тип
Обяз.
Описание
Комментарий
statusEx
enum
-
Актуальные
См. "Справочник "Статусы КИ""
особые состояния
КИ
children
[string]
-
КИ в агрегате
countChildren
integer
-
Количество
(int32)
дочерних КИ
parent
string
-
КИТУ
вышестоящего
уровня
lastDocId
string
-
Последний
регистрационный
номер документа,
зафиксированный
в ГИС МТ по
этому КИ
expireDate
string
-
Дата истечения
Возвращается в формате yyyy-MM-
(date-
срока годности
ddTHH:mm:ss.SSS’Z (обязательный для
time)
ТГ "Молочная продукция")
prVetDocume
string
-
ID
Возвращается для товарной группы
nt
производственног
"Молочная продукция" вместо
о ВСД (для
устаревшего "prVetDoc"
продукции,
произведённой в
РФ) или ID
транспортного
ВСД (для
продукции,
произведённой
вне РФ)
introducedDat
string
-
Дата ввода в
Возвращается в формате yyyy-MM-
e
(date-
оборот с КИ в
ddTHH:mm:ss.SSS’Z
time)
оборот
exporterName
string
-
Наименование
экспортёра
exporterTaxp
string
-
Уникальный
ayerId
идентификатор
экспортёра в
национальной
системе учёта
налогоплательщи
ков
agentInn
string
-
ИНН текущего
владельца товара
103
Параметр
Тип
Обяз.
Описание
Комментарий
agentName
string
-
Наименование
текущего
владельца товара
lastStatusCha
string
+
Дата последнего
Возвращается в формате yyyy-MM-
ngeDate
(date-
изменения статуса
ddTHH:mm:ss.SSS’Z
time)
turnoverType
enum
-
Вид
Возможные значения:
товарооборота
SELLING - продажа;
COMMISSION - комиссия;
AGENT - агент
productGroup
string
+
Товарная группа
См. "Справочник "Список
поддерживаемых товарных групп""
tnVed10
string
-
Код ТН ВЭД (10
знаков)
markWithdra
boolean
-
Зафиксирована
w
розничная
продажа по чеку
от невладельца
КИ
certDoc
string
-
Сертификат
*date
string
-
Дата сертификата
Возвращается в формате yyyy-MM-
ddTHH:mm:ss.SSS’Z
*number
string
-
Номер
сертификата
*type
string
-
Тип сертификата
withdrawReas
string
-
Причина вывода
on
из оборота
withdrawReas
string
-
Введенная
Возвращается, если "withdrawReason" =
onOther
вручную причина
"OTHER"
вывода из оборота
*certDoc
string
-
Документ
обязательной
сертификации
**type
string
-
Вид документа
Возможные значения:
обязательной
сертификации
CONFORMITY_CERTIFICATE -
сертификат соответствия;
CONFORMITY_DECLARATION -
декларация о соответствии;
STATE_REGISTRATION_CERTIFICATE -
свидетельство государственной
регистрации
104
Параметр
Тип
Обяз.
Описание
Комментарий
**number
string
-
Номер документа
обязательной
сертификации
**date
string(da
-
Дата выдачи
Формат: yyyy.MM.dd
te)
документа
обязательной
сертификации
**wellNumbe
string
-
Номер скважины
Возвращается только для товарной группы
r
"Упакованная вода"
2.6. Метод получения информации о товаре по GTIN товара
В результате успешного выполнения запроса по списку кодов товаров в ответе возвращается
массив с информацией о товарах по запрошенным КИ. В результирующем JSON также может
содержаться набор полей, специфичных для товара конкретной товарной группы (см.
"Справочник "Дополнительные параметры в ответе в зависимости от товарных групп""). Вместо
данного метода рекомендуется использовать "Метод получения информации о товаре по GTIN
товара" в True API (подробнее см. в "Описание True API"). Планируемая дата отключения версии
3 данного метода - ноябрь 2021 года.
URL: /product/info
Метод: GET
Пример запроса:
curl -X GET "<url стенда v3>/product/info?gtins=04600000000000&includeSubaccount=true"
-H "accept: */*"
Параметры запроса:
Параметр
Тип
Обяз.
Описание
Комментарий
gtins
[string]
+
Массив кодов
товаров
includeSubac
boolean
-
Признак
Если значение = true, то в ответе
count
субаккаунта
возвращаются данные по всем GTIN,
принадлежащим участнику оборота
товаров и предоставленным ему через
суббакаунт. Если значение = false, то в
ответе возвращаются данные только по
GTIN, принадлежащим участнику оборота
товаров. Значение по умолчанию = false
Пример ответа:
105
{
"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
}
Параметры ответа:
Параметр
Тип
Обяз.
Описание
Комментарий
results
array
+
Массив с
информацией о
товарах по
запрошенным КИ
*id
integer
+
ID товара
*name
string
+
Наименование
товара
*gtin
string
+
Код товара, по
которому
выполняется
запрос
*brand
string
+
Бренд
106
Параметр
Тип
Обяз.
Описание
Комментарий
*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" ("Заявитель
маркируемого и вводимого в оборот
товара")
**exporterTa
string
-
ИНН заявителя
Возвращается в ответе при условии
xpayerId
или его аналог
указания сведений в карточке товара в НК.
(налоговый
Возвращается обязательно при возврате
идентификатор)
объекта "exporter" ("Заявитель
маркируемого и вводимого в оборот
товара")
**kpp
string
-
КПП или его
Возвращается в ответе при условии
аналог
указания сведений в карточке товара в НК
**gcp
string
-
Глобальный
Возвращается в ответе при условии
идентификатор
указания сведений в карточке товара в НК.
компании в GS1
Возвращается обязательно при возврате
объекта "exporter" ("Заявитель
маркируемого и вводимого в оборот
товара")
107
Параметр
Тип
Обяз.
Описание
Комментарий
**gln
string
-
Глобальный
Возвращается в ответе при условии
идентификатор
указания сведений в карточке товара в НК.
места нахождения
Возвращается обязательно при возврате
объекта "exporter" ("Заявитель
маркируемого и вводимого в оборот
товара")
**manufactur
string
-
Адрес
Возвращается в ответе при условии
eAddress
производственной
указания сведений в карточке товара в НК.
площадки
Возвращается обязательно при возврате
объекта "exporter" ("Заявитель
маркируемого и вводимого в оборот
товара")
**importerAc
string
-
Ссылка на
Возвращается в ответе при условии
count
аккаунт
указания сведений в карточке товара в НК
импортёра
*permittedInn
[string]
-
Массив ИНН
Возвращается в ответе при условии
s
компаний-
указания сведений в карточке товара в НК.
субаккаунтов,
Параметр возвращается для владельца
которым владелец
кода товара и для Оператора
кода товара
предоставил
возможность
использовать
данный код
товара для заказа
КМ
*productGrou
integer(i
+
Идентификатор
См. "Справочник "Список
pId
nt64)
товарной группы
поддерживаемых товарных групп"".
Возвращается в ответе при условии
указания сведений в карточке товара в НК
*productGrou
string
-
Наименование
Возвращается в ответе при условии
p
товарной группы
указания сведений в карточке товара в НК
*tnved
string
-
Группа ТН ВЭД
Возвращается в ответе при условии
указания сведений в карточке товара в НК
tnVedCode10
string
-
Код ТН ВЭД (10
Возвращается в ответе при условии
знаков)
указания сведений в карточке товара в НК
tnVedCode
string
-
Код ТН ВЭД
Возвращается в ответе при условии
указания сведений в карточке товара в НК
*foreignProdu
object
-
Объект с данными
Возвращается в ответе при условии
cer
о производителе
указания сведений в карточке товара в НК
**name
string
+
Наименование
Возвращается в ответе при условии
производителя
указания сведений в карточке товара в НК.
Возвращается обязательно при возврате
объекта "foreignProducer" ("Объект с
данными о производителе")
108
Параметр
Тип
Обяз.
Описание
Комментарий
**inn
string
-
ИНН
Возвращается в ответе при условии
производителя
указания сведений в карточке товара в НК
или его аналог
**kpp
string
-
КПП
Возвращается в ответе при условии
производителя
указания сведений в карточке товара в НК
или его аналог
**gcp
string
-
GCP
Возвращается в ответе при условии
производителя
указания сведений в карточке товара в НК
**gln
string
-
GLN
Возвращается в ответе при условии
производителя
указания сведений в карточке товара в НК
**address
array[stri
-
Массив адресов
Возвращается в ответе при условии
ng]
производителя
указания сведений в карточке товара в НК
*goodSigned
boolean
-
Признак
Возвращается в ответе при условии
Flag
подписания
указания сведений в карточке товара в НК.
карточки товара в
Если в НК атрибут не заполнен, то в
НК
ответе возвращается null
*goodMarkFl
boolean
-
Признак
Возвращается в ответе при условии
ag
готовности к
указания сведений в карточке товара в НК.
маркировке
Если в НК атрибут не заполнен, то в
ответе возвращается null
*goodTurnFla
boolean
-
Признак
Индикатор заполнения второго слоя и
g
готовности к
подписания карточки товара в НК. Для
обороту
карточек коротких остатков и карточек,
созданных по API НК СУЗ, подпись для
признака goodTurnFlag не проверяется,
поскольку данные карточки не
подписываются.
Если значение = true, то можно заказать
КМ и ввести товар в оборот.
Возвращается в ответе при условии
указания сведений в карточке товара в НК.
Если в НК атрибут не заполнен, то в
ответе возвращается null
*isKit
boolean
-
Признак
Возвращается в ответе при условии
"Комплект" в
указания сведений в карточке товара в НК.
карточке товара
Если в НК атрибут не заполнен, то в
ответе возвращается null
*isTechGtin
boolean
-
Признак
Возвращается в ответе при условии
"Технологический
указания сведений в карточке товара в НК.
" по карточке
Если в НК атрибут не заполнен, то в
товара
ответе возвращается null
109
Параметр
Тип
Обяз.
Описание
Комментарий
*setDescriptio
string
-
Описание набора
Возвращается описание товара в составе
n
набора, содержащее параметры,
специфичные для конкретного товара.
Данный параметр вернётся в том случае,
если он заполнен в карточке НК (см.
"Справочник "Дополнительные
параметры в ответе в зависимости от
товарных групп"").
*isSet
boolean
-
Признак "Набор"
Возвращается в ответе при условии
по карточке
указания сведений в карточке товара в НК.
товара в НК
Если в НК атрибут не заполнен, то в
ответе возвращается null
*country
string
-
Страна
Возвращается в ответе при условии
производства
указания сведений в карточке товара в НК
*fts
object
-
Данные
Возвращается в ответе при условии
полученные ГИС
указания сведений в карточке товара в НК
МТ в ответе от
ФТС при вводе
товара в оборот
**rds
array[obj
-
Массив данных
Возвращается в ответе при условии
ect]
по РД
указания сведений в карточке товара в НК
***authDocD
string
-
Дата
Возвращается в ответе при условии
ate
разрешительного
указания сведений в карточке товара в НК
документа
***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)
указания сведений в карточке товара в НК
110
Параметр
Тип
Обяз.
Описание
Комментарий
*level
string
-
Уровень упаковки
Возможные значения:
trade-unit - единица товара;
inner-pack - групповая упаковка.
Возвращается в ответе при условии
указания сведений в карточке товара в НК
*multiplier
integer
-
Количество
вложений в
упаковку
*mainGtin
string
-
Код товара,
Обязательный, если значение параметра
вложенного в
"level" ("Уровень упаковки") не равно
потребительскую
"trade-unit" ("Единица товара").
упаковку
Возвращается в ответе при условии
указания сведений в карточке товара в НК
*goodStatus
string
-
Cтатус карточки
Возвращается в ответе при условии
товара в НК
указания сведений в карточке товара в НК.
Если карточка товара выводится из GS1,
то параметр не возвращается.
Возможные значения:
draft - карточка товара в разных статусах в
ЛК НК: "Черновик", "На модерации",
"Требует изменений", "Ожидает
подписания";
published - опубликованная карточка
товара;
archived - карточка товара в архиве
*declNumber
string
-
Номер
Возвращается в ответе при условии
декларации о
указания сведений в карточке товара в НК
соответствии
*certNumber
string
-
Номер
Возвращается в ответе при условии
сертификата
указания сведений в карточке товара в НК
соответствия
*regNumber
string
-
Номер
Возвращается в ответе при условии
свидетельства о
указания сведений в карточке товара в НК
государственной
регистрации
*authDocNu
string
-
Номер
Возвращается в ответе при условии
mber
разрешительного
указания сведений в карточке товара в НК
документа
*shortName
string
-
Краткое
Возвращается в ответе при условии
наименование
указания сведений в карточке товара в НК
товара
*basicUnit
string
-
Базовая единица
Возвращается в ответе при условии
измерения
указания сведений в карточке товара в НК
111
Параметр
Тип
Обяз.
Описание
Комментарий
*fullName
string
-
Полное
Возвращается в ответе при условии
наименование
указания сведений в карточке товара в НК
товара
total
integer(i
+
Количество
nt64)
найденных
товаров
errorCode
string
-
Код ошибки
Возвращается при наличии ошибки
2.7. Метод получения списка загруженных документов в
ГИС МТ
URL: /facade/doc/listV2
Метод: GET
Примера запроса:
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" ("ИНН отправителя
документа")
112
Параметр
Тип
Обяз.
Описание
did
string
-
Значение номера документа, "точки отсчёта"
(запись с которой начнётся выборка), по
которому сортируются записи. Использовать
только совместно с параметром
"orderedColumnValue".
При указании данного параметра необходимо
указать параметр "pg" ("Товарная группа")
documentFormat
string
-
Тип документа:
"MANUAL" - формат JSON;
"UPD" - ЭДО;
"XML" - формат XML;
"CSV" - формат CSV
documentStatus
enum
-
Статус документа (см. "Справочник "Статусы
документов"")
documentType
array[stri
-
Тип документа (см. "Справочник "Типы
ng]
документов"")
inputFormat
boolean
-
Входящий (true) / исходящий (false) документ
limit
integer
-
Значение устанавливает количество записей в
ответе, не более 10000 записей. (По умолчанию
10 записей). При указании параметра "limit",
параметр "pg" ("Товарная группа") становится
обязательным
number
string
-
Номер документа.
При указании параметра "number" в запросе,
параметр "did" ("Значение номера документа")
в пагинации будет игнорироваться
order
enum
-
Направление сортировки:
"ASC" - по возрастанию;
"DESC" - по убыванию
orderColumn
string
-
Название столбца, по которому будет
производиться сортировка. Допустимое
значение: "receivedAt" ("Дата эмиссии")
orderedColumnValue
string
-
Значение столбца, "точки отсчёта" (запись, с
которой начнётся выборка), по которому
сортируются записи. Использовать только
совместно с параметром "did".
Если параметр задан для ТГ "Альтернативная
табачная продукция", "Никотиносодержащая
продукция", "Табачная продукция", то
параметр "pageDir" ("Выбор направления")
также становится обязательным
113
Параметр
Тип
Обяз.
Описание
pageDir
enum
-
Выбор направления:
"PREV" - Предыдущий раздел;
"NEXT" - Следующий раздел .
Параметр обязателен для ТГ "Альтернативная
табачная продукция", "Никотиносодержащая
продукция", "Табачная продукция" при
указании параметров "orderedColumnValue"
("Вначение столбца, по которому сортируются
записи") и "did" ("Значение номера документа,
по которому сортируются записи")
participantInn
string
-
ИНН участника оборота товара
pg
string
-
Товарная группа (см. Справочник "Список
поддерживаемых товарных групп").
Параметр обязательно указывать для товарных
групп:
"milk" - "Молочная продукция";
"water" - "Упакованная вода".
В параметре "pg" также доступно указание
значения "empty" ("Неопределённая товарная
группа"). Данное значение указывается с
целью выявления документов, для которых
товарная группа не была определена
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",
114
"downloadDesc": "string",
"cisTotal": 0,
"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"
}
}
],
"total": 0,
"docErrors": [
{
"additionalProp1": {},
"additionalProp2": {},
"additionalProp3": {}
}
]
}
Параметры ответа:
Параметр
Тип
Обяз.
Описание
Комментарий
results
+
115
Параметр
Тип
Обяз.
Описание
Комментарий
*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)
документа
*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
документа
получения содержимого загруженного
документа по идентификатору"
116
Параметр
Тип
Обяз.
Описание
Комментарий
*content
string
+
Контент
Оригинальное содержимое документа
документа
*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]
-
Список ошибок
обработки
документа.
Возвращается в
случае ошибки
117
Параметр
Тип
Обяз.
Описание
Комментарий
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>
Пример ответа:
118
{
"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"
}
119
Параметры ответа:
Параметр
Тип
Обяз.
Описание
Комментарий
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
загрузки
документа
документа
120
Параметр
Тип
Обяз.
Описание
Комментарий
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
-
Идентификатор
гос. контракта
121
Параметр
Тип
Обяз.
Описание
Комментарий
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 - "Упакованная вода"
paging
boolean
-
Пагинация
122
Параметр
Тип
Обяз.
Описание
Возможные значения:
offset
integer
-
true - новая;
false - старая (по
умолчанию)
Если значение = true, то
применять параметры
"offset" ("Смещение по КИ
в теле документа") и "limit"
("Количество записей в
ответе"). Если значение =
false, то применять
параметры
"orderedColumnValue"
("Значение столбца, "точки
отсчёта" (запись, с которой
начинается выборка), по
которому сортируются
записи"), "pageDir" ("Выбор
направления пагинации") и
"limit" ("Количество
записей в ответе")
Смещение по КИ в теле
content
boolean
документа
-
Запрос
body
boolean
контент
а чека.
Возмож
ные
значени
я:
true - да
(по
умолчан
ию);
false -
нет
Параметры заголовка запроса: Authorization: Bearer <token>
Пример ответа:
123
{
"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"
}
124
Параметры ответа:
Параметр
Тип
Обяз.
Описание
Комментарий
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
загрузки
документа
документа
125
Параметр
Тип
Обяз.
Описание
Комментарий
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
-
Идентификатор
гос. контракта
126
Параметр
Тип
Обяз.
Описание
Комментарий
eliminationRe
string
-
Причина вывода
Возможные значения:
ason
KM_SPOILED - Испорчен;
KM_SPOILED_OR_LOST - Испорчен
либо утерян СИ с КИ;
KM_LOST - Утерян;
KM_DESTROYED - Уничтожен;
DESCRIPTION_ERRORS - Выявлены
ошибки описания товара;
RETAIL - Розничная продажа;
EEC_EXPORT - Экспорт в страны ЕАЭС;
BEYOND_EEC_EXPORT - Экспорт за
пределы стран ЕАЭС;
RETURN - Возврат физическому лицу;
REMOTE_SALE - Продажа по образцам,
дистанционный способ продажи;
DAMAGE_LOSS - Утрата или
повреждение;
DESTRUCTION - Уничтожение;
CONFISCATION - Конфискация;
LIQUIDATION - Ликвидация
предприятия;
INSTALMENT - Договор рассрочки;
DONATION - Безвозмездная передача;
STATE_ENTERPRISE - Приобретение
гос.предприятием;
NO_RETAIL_USE - Использование для
собственных нужд покупателем;
ENTERPRISE_USE - Использование для
собственных нужд предприятия;
KM_CANCELLATION - Аннулирование
не преобразованных в СИ с КИ по
истечении срока;
KM_CANCELLATION_BY_TERM -
Аннулирование не преобразованных в СИ
с КИ по истечении срока;
RETAIL_RETURN - Возврат товаров с
поврежденным СИ/без СИ при розничной
реализации;
REMOTE_SALE_RETURN - Возврат
товаров с поврежденным СИ/без СИ при
дистанционном способе продажи
2.10. Метод получения списка загруженных чеков в ГИС МТ
URL: /facade/receipt/listV2
Метод: GET
Пример запроса:
127
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) документ
did
string
-
Значение номера документа, "точки отсчёта"
(запись с которой начнётся выборка), по
которому сортируются записи. Использовать
только совместно с параметром
"orderedColumnValue" ("Название столбца, по
которому будет производиться сортировка").
При указании данного параметра необходимо
указать параметр "pg" ("Товарная группа")
128
Параметр
Тип
Обяз.
Описание
limit
integer
-
Значение устанавливает количество записей в
ответе, не более 10000 записей. (По умолчанию
10 записей).
При указании данного параметра необходимо
указать параметр "pg" ("Товарная группа")
pageDir
enum
-
Выбор направления:
"PREV" - Предыдущий раздел;
"NEXT" - Следующий раздел .
Параметр обязателен для ТГ "Альтернативная
табачная продукция", "Никотиносодержащая
продукция", "Табачная продукция" при
указании параметров "orderedColumnValue"
("Вначение столбца, по которому сортируются
записи") и "did" ("Значение номера документа,
по которому сортируются записи")
order
enum
-
Направление сортировки:
"ASC" - по возрастанию;
"DESC" - по убыванию
orderColumn
string
-
Название столбца, по которому будет
производиться сортировка. Допустимое
значение: "receivedAt" ("Дата получения
документа")
orderedColumnValue
string
-
Значение столбца, "точки отсчёта" (запись, с
которой начнётся выборка), по которому
сортируются записи. Использовать только
совместно с параметром "did" ("Значение
номера документа").
Если параметр задан для ТГ "Альтернативная
табачная продукция", "Никотиносодержащая
продукция", "Табачная продукция", то
параметр "pageDir" ("Выбор направления")
также становится обязательным
pg
string
-
Товарная группа.
Параметр обязательно указывать для товарных
групп:
"milk" - "Молочная продукция";
"water" - "Упакованная вода"
page
integer
-
Номер страницы
Пример ответа:
129
{
"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",
"address": "string",
"inn": "string",
"kpp": "string"
},
"receiver": {
"name": "string",
"address": "string",
"inn": "string",
"kpp": "string"
}
}
],
"total": 0,
130
"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
+
Наименование
отправителя
документа
receiverName
string
-
Наименование
получателя
документа
invoiceNumb
string
-
Номер счёта-
er
фактуры, УКД
invoiceDate
string
-
Дата счёта-
Возвращается в формате yyyy-MM-
(date-
фактуры, УКД
ddTHH:mm:ss.SSS’Z
time)
total
Number
-
Общая сумма
документа
vat
Number
-
Сумма НДС
документа
131
Параметр
Тип
Обяз.
Описание
Комментарий
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]
-
Список ошибок
обработки
документа.
Возвращается в
случае ошибки
additionalPro
string
-
Список ошибок
Структура данных, состоящая из перечня
p
обработки
ошибок обработки документа.
документа
Возвращается в случае ошибки
atk
string
-
Агрегированный
таможенный код
sender
string
-
Отправитель
*name
string
-
Наименование
*address
string
-
Адрес
*inn
string
-
ИНН
*kpp
string
-
КПП
Код причины постановки на учёт
receiver
string
-
Получатель
*name
string
-
Наименование
132
Параметр
Тип
Обяз.
Описание
Комментарий
*address
string
-
Адрес
*inn
string
-
ИНН
*kpp
string
-
КПП
Код причины постановки на учёт
total
string
+
Количество
вернувшихся
ответов
docErrors
[string]
-
Список ошибок
обработки
документа.
Возвращается в
случае ошибки
additionalPro
string
-
Список ошибок
Структура данных, состоящая из перечня
p
обработки
ошибок обработки документа.
документа
Возвращается в случае ошибки
2.11. Метод получения содержимого загруженного документа
по идентификатору
Метод недоступен для товарных групп "Альтернативная табачная продукция" и "Табачная
продукция". Метод возвращает общую информацию о запрашиваемом документе, включая
статус обработки документа. В одном запросе можно запросить информацию по одному
документу (см. "Справочник "Типы документов""). Получение информации о документе
возможно только в том случае, если участник оборота товаров, запрашивающий информацию о
документе, является подписантом данного документа.
Для получения содержимого документа "Ввод в оборот. Импорт с ФТС" или "Ввод в оборот.
Производство вне ЕАЭС" (см. "Справочник "Типы документов"") в параметре запроса "docId"
указывается уникальный идентификатор документа. В параметре ответа "did" содержится номер
ДТ, указанный при подаче документа.
Для документа с типом 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") без указания
вложений.
133
Дополнительную информацию также см. в разделе "Указание параметров в строке запроса при
работе с большими агрегатами".
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={КИ}
Пример запроса для получения информации по первым нескольким КИ из документа:
/v4/facade/doc/a11a1a11-a1aa-1111-11a1-
1aa11a1a1a11/body?pg=lp&paging=true&offset=0&content=false&body=false&limit=5
Пример запроса для получения информации по следующим нескольким КИ из документа:
/v4/facade/doc/a11a1a11-a1aa-1111-11a1-
1aa11a1a1a11/body?pg=lp&paging=true&offset=5&content=false&body=false&limit=5
Параметры строки запроса:
134
Параметр
Тип
Обяз.
Описание
Комментарий
docId
string
+
Уникальный
идентификатор
документа
limit
integer
-
Количество
Значение устанавливает количество
записей в ответе
записей в ответе. Не более 10000 записей
(по умолчанию 10 записей)
orderedColum
string
-
Значение столбца,
nValue
"точки отсчёта"
(запись, с которой
начинается
выборка), по
которому
сортируются
записи
pageDir
string
-
Выбор
Возможные значения:
направления
PREV - предыдущий раздел;
пагинации
NEXT - следующий раздел
pg
string
-
Товарная группа
Параметр обязательно указывать для
товарных групп:
milk - "Молочная продукция";
water - "Упакованная вода"
См."Справочник "Список
поддерживаемых товарных групп""
paging
boolean
-
Пагинация
Возможные значения:
true - новая;
false - старая (по умолчанию)
Если значение = true, то применять
параметры "offset" ("Смещение по КИ в
теле документа") и "limit" ("Количество
записей в ответе"). Если значение = false,
то применять параметры
"orderedColumnValue" ("Значение столбца,
"точки отсчёта" (запись, с которой
начинается выборка), по которому
сортируются записи"), "pageDir" ("Выбор
направления пагинации") и "limit"
("Количество записей в ответе")
offset
integer
-
Смещение по КИ
в теле документа
content
boolean
-
Запрос контента
Возможные значения:
документа
true - да (по умолчанию);
false - нет
135
Параметр
Тип
Обяз.
Описание
Комментарий
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",
"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":{
136
},
"additionalProp3":{
}
}
],
"documentDataDto":{
"sum":0,
"did":"string",
"t":0,
"contract_sum":0,
"receipts":[
"string"
],
"e":[
"string"
],
"ost":"string",
"trn":0,
"pc":0,
"vetis":"string",
"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":{
},
137
"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"
}
}
Параметры ответа:
Примечание: параметры, выделенные курсивом, возвращаются в ответе в зависимости от типа
документа (см. "Справочник "Типы документов"").
Параметр
Тип
Обяз.
Описание
Комментарий
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
+
Наименование
отправителя
документа
138
Параметр
Тип
Обяз.
Описание
Комментарий
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 с набором полей,
специфичных для каждого типа
документа. См. "Справочник "Типы
документов""
**count_child
integer
+
Кол-во
Возвращается в составе тела документа
ren
вложенных КИ
*productGrou
string
+
Идентификатор
См. "Справочник "Список
p
товарной группы
поддерживаемых товарных групп""
*sntin
string
-
Серийный номер
КИ
*name
string
+
Наименование
товара
*count
integer
+
Количество
дочерних единиц
*emissionTyp
string
-
Тип эмиссии
Возможные значения (см. "Справочник
e
"Типы эмиссии КИ"")
*type
string
+
Тип упаковки
Возможные значения:
UNIT - единица товара;
BUNDLE - комплект;
SET - набор
*uit_code
string
+
Уникальный
идентификатор
кода
139
Параметр
Тип
Обяз.
Описание
Комментарий
*status
string
+
Статус
См. "Актуальные статусы"
*uitus
[string]
-
Состав КИТУ
В состав массива входят также атрибуты,
выделенные выше курсивом
**sntin
string
-
КИ, входящий в
агрегат
*gtin
string
-
Код товара
*country
string
-
Страна
производства
*color
string
-
Цвет
*size
string
-
Размер
content
string
+
Содержимое
документа
input
boolean
+
Признак того, что
Возможные значения:
документ
true - входящий;
является
false - исходящий
входящим/исходя
щим
pdfFile
string
-
Ссылка на PDF-
файл
errors
[string]
-
Ошибки
Параметр возвращается при наличии
ошибки
docErrors
[string]
-
Список ошибок
Возвращается при наличии ошибки
обработки
документа
additionalPro
string
-
Список ошибок
Структура данных, состоящая из перечня
p
обработки
ошибок обработки документа.
документа
Возвращается в случае ошибки
*sum
integer
-
Внутренний
параметр системы
*did
string
-
Идентификатор
документа
*t
integer
-
Внутренний
параметр системы
*contract_su
integer
-
Сумма договора
Внутренний параметр системы
m
*receipts
[string]
-
Чеки
*e
string
-
Внутренний
параметр системы
*ost
string
-
Внутренний
параметр системы
140
Параметр
Тип
Обяз.
Описание
Комментарий
*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
-
Идентификатор
экспортёра
*rett
integer
-
Внутренний
параметр системы
*elr
integer
-
Внутренний
параметр системы
*receiptId
[string]
-
Идентификатор
получателя
*ext
string
-
Внутренний
параметр системы
additionalPro
string
-
Внутренний
Структура данных, состоящая из
p
параметр системы
внутреннего параметра системы
atk
string
-
Агрегированный
таможенный код
141
Параметр
Тип
Обяз.
Описание
Комментарий
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" (Аннулирован),
см. "Справочник "Статусы документов""
cancelled_did
string
-
Идентификатор
Возвращается только для документов:
аннулированного
"UNIVERSAL_CANCEL_DOCUMENT"
документа
(Универсальный документ отмены);
"LP_CANCEL_SHIPMENT" (Отмена
отгрузки);
"LP_CANCEL_SHIPMENT_CROSSBORD
ER" (Отмена отгрузки при
трансграничной торговле)
142
Параметр
Тип
Обяз.
Описание
Комментарий
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
+
Возможные
значения:
Уникальный
идентификатор
документа в ГИС МТ,
указывается для ГИС документов;
Идентификатор
юридически
значимого
документа
column
string
-
columnValue
string
-
orderColumn
string
-
Название столбца, по которому будет
производиться сортировка.
orderDir
string
-
Направление сортировки:
ASC - по возрастанию;
DESC - по убыванию
143
Параметр
Тип
Обяз.
Описание
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>
Пример ответа:
144
{
"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
-
Результат ответа
145
Параметр
Тип
Обяз.
Описание
Комментарий
*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
после
146
Параметр
Тип
Обяз.
Описание
Комментарий
*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"
147
Параметр
Тип
Обяз.
Описание
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
мегабайт.
Параметры ответа:
148
Параметр
Тип
Обяз.
Описание
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
+
КИ
Пример ответа:
149
{
"cis":"string",
"gtin":"string",
"sgtin":"string",
"tnvd":"string",
"productName":"string",
"producerName":"string",
"producerInn":"string",
"ownerName":"string",
"ownerInn":"string",
"emissionDate":"2021-07-14T11:17:37.934Z",
"producedDate":"2021-07-01T00:00:00.000Z",
"introducedDate":"2021-07-27T14:34:50.609Z",
"emissionType":"string",
"lastDocId":"string",
"name":"string",
"brand":"string",
"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"
},
{
"type":"STATE_REGISTRATION_CERTIFICATE",
"number":"456",
"date":"2021-07-02T00:00:00.000Z"
}
],
"prevCises":[
],
"nextCises":[
],
"status":"INTRODUCED",
"countChildren":0,
"packType":"UNIT",
"expireDate":1638489600000,
"expirationDate":"2021-12-03T00:00:00.000Z",
"prVetDocument":"0f0000f0-00ff-0000-f000-00f0f0ffbfbb",
"certificateType":"CONFORMITY_DECLARATION",
"certificateNumber":"123",
"certificateDate":"2021-07-01T00:00:00.000Z",
"productGroup":"string",
150
"markWithdraw":false,
"milkProductType":"string",
"isSet":false,
"level":"string",
"multiplier":1,
"veterinaryControl":"ДА",
"okpd2Group":"10.51.52.211",
"fullName":"string",
"babyFoodProduct":"НЕТ",
"volumeWeight":"0,5 кг",
"basicUnit":"КГ",
"structure":"string",
"isSpecializedFoodProduct":"НЕТ",
"packMaterial":"БИОПЛАСТИК",
"isShelfLife40Days":"НЕТ",
"isKit":false,
"isTechGtin":false,
"goodStatus":"published",
"paymentGroup":2,
"fat":"15,5",
"rawOrigin":"string"
}
Параметры ответа:
Параметр
Тип
Обяз.
Описание
Комментарий
cis
string
+
КИ,
используемый для
фильтрации по
списку КИ
gtin
string
-
Код товара
sgtin
string
-
Код товара и
серийный номер
КИ
tnvd
string
-
Код товарной
номенклатуры (10
знаков)
tnvedGroup
string
-
Код товарной
позиции ТН ВЭД
ЕАС товара
(первые 4
символа)
producerNam
string
-
Производитель
e
товара
productName
string
-
Название
продукта
151
Параметр
Тип
Обяз.
Описание
Комментарий
producerInn
string
-
ИНН
производителя/им
портёра товара
ownerInn
string
-
ИНН
собственника
товара
ownerName
string
-
Наименование
собственника
товара
agentInn
string
-
ИНН текущего
владельца товара
agentName
string
-
Наименование
текущего
владельца товара
previousAgen
string
-
ИНН
tInn
предыдущего
владельца товара
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
-
Тип эмиссии
См. "Справочник "Типы эмиссии КИ""
152
Параметр
Тип
Обяз.
Описание
Комментарий
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
-
Номер документа
разрешительной
документации
153
Параметр
Тип
Обяз.
Описание
Комментарий
*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
+
Тип упаковки
См. "Справочник "Типы упаковки""
154
Параметр
Тип
Обяз.
Описание
Комментарий
*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
-
Код
идентификации
упаковки, в
которую
агрегирован товар
155
Параметр
Тип
Обяз.
Описание
Комментарий
*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)
156
Параметр
Тип
Обяз.
Описание
Комментарий
*turnoverTyp
enum
-
Вид
Возможные значения:
e
товарооборота
SELLING - продажа;
COMMISSION -
(COMMISSIONAIRE_SALE - устар.)
комиссия;
AGENT - агент
*productGrou
string
+
Товарная группа
См. "Справочник "Список
p
поддерживаемых товарных групп""
*tnVed10
string
-
Код ТН ВЭД (10
знаков)
*veterinaryCo
boolean
-
Признак
Возвращается только для ТГ "Молочная
ntrol
подконтрольности
продукция"
ВСД, означающий
необходимость
проверки ВСД в
"ВетИС"
*markWithdr
boolean
-
Зафиксирована
aw
розничная
продажа по чеку
от невладельца
КИ
*withdrawRe
string(1-
-
Причина выбытия
Обязательное поле с описанием причины
asonOther
225)
(другое)
вывода из оборота при значении "Причина
выбытия" ("withdrawReason") = "Другое"
(OTHER)
childrenDetail
[array]
-
Маркированный
s
товар
countChildren
integer
-
Количество
(int32)
дочерних КИ
uitu
string
-
КИТУ
вышестоящего
уровня
parent
string
-
Код
идентификации
упаковки, в
которую
агрегирован товар
packType
string
+
Тип упаковки
См. "Справочник "Типы упаковки""
withdrawReas
string
-
Причина вывода
on
из оборота
157
Параметр
Тип
Обяз.
Описание
Комментарий
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)
ТГ "Молочная продукция")
prVetDocume
string
-
ID
Обязательный параметр для ТГ
nt
производственног
"Молочная продукция". Данный параметр
о ВСД (для
используется вместо устаревшего
продукции,
"prVetDoc"
произведённой в
РФ) или ID
транспортного
ВСД (для
продукции,
произведённой
вне РФ)
exporterName
string
-
Наименование
экспортёра
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
соответствие
158
Параметр
Тип
Обяз.
Описание
Комментарий
productGroup
string
+
Товарная группа
Cм. "Справочник "Список
поддерживаемых товарных групп""
color
string
-
Цвет
Возвращается для ТГ "Обувные товары"
productSize
string
-
Размер
Возвращается для ТГ "Обувные товары"
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
Параметры строки запроса:
Параметр
Тип
Обяз.
Описание
Комментарий
childrenPagin
boolean
+
Флаг,
При включённом значении возвращает
g
включающий
постранично агрегаты только первого слоя
пагинацию
через указанные ниже параметры.
агрегатов
Значение по умолчанию: false
childrenPage
number
-
Число страниц
Значение по умолчанию: 1
вложений
агрегата первого
слоя
childrenLimit
number
-
Количество
Значение по умолчанию: 50
вложений на
странице агрегата
первого слоя
pg
string
-
Товарная группа
Параметр обязательно указывается в
строке запроса для товарных групп:
milk - "Молочная продукция";
water - "Упакованная вода"
159
Параметр
Тип
Обяз.
Описание
Комментарий
full_cis
boolean
-
Флаг,
Возможные значения:
включающий
поиск по полному
true - полное совпадение значения;
значению КИ
false - совпадение по началу КИ (значение
по умолчанию)
Пример тела запроса:
{
"uit":"010460000000000021FFFFFFFFFFFFF"
}
Параметры тела запроса:
Параметр
Тип
Обяз.
Описание
Комментарий
uit
string
+
КИ
Пример ответа:
{
"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,
160
"packType":"string",
"receiptDate":"2021-10-04T00:00:00.000Z",
"expireDate":1633313671000,
"expirationDate":"2021-10-04T02:14:31.000Z",
"prVetDocument":"string",
"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 РОССИЯ"
}
Параметры ответа:
Параметр
Тип
Обяз.
Описание
Комментарий
cis
string
+
КИ,
используемый для
фильтрации по
списку КИ
gtin
string
-
Код товара
sgtin
string
-
Код товара и
серийный номер
КИ
tnvd
string
-
Код товарной
номенклатуры (10
знаков)
tnvedGroup
string
-
Код товарной
позиции ТН ВЭД
ЕАС товара
(первые 4
символа)
producerNam
string
-
Производитель
e
товара
productName
string
-
Название
продукта
161
Параметр
Тип
Обяз.
Описание
Комментарий
producerInn
string
-
ИНН
производителя/им
портёра товара
ownerInn
string
-
ИНН
собственника
товара
ownerName
string
-
Наименование
собственника
товара
agentInn
string
-
ИНН текущего
владельца товара
agentName
string
-
Наименование
текущего
владельца товара
previousAgen
string
-
ИНН
tInn
предыдущего
владельца товара
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
-
Тип эмиссии
См. "Справочник "Типы эмиссии КИ""
162
Параметр
Тип
Обяз.
Описание
Комментарий
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
-
Тип сертификата
prevCises
[string]
-
Предыдущие КИ
в случае
перемаркировки
товара
nextCises
[string]
-
Следующие
номера КИ в
случае
перемаркировки
товара
status
enum
+
Статус КИ
См. "Справочник "Статусы КИ"". Для
перемаркированного КИ возможное
значение "WRITTEN_OFF" (Списан)
remarks
-
Список
перемаркировок
данного товара
*curr
string
-
Текущий КИ
товара
*date
string
-
Дата
Возвращается в формате yyyy-MM-
перемаркировки
ddTHH:mm:ss.SSS’Z
163
Параметр
Тип
Обяз.
Описание
Комментарий
*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-массива
164
Параметр
Тип
Обяз.
Описание
Комментарий
*childrenMap
[string]
-
Краткая
информация о
дочерних КИ
*countChildre
integer
-
Количество
n
дочерних КИ
*parent
string
-
Код
идентификации
упаковки, в
которую
агрегирован товар
*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
идентификатор
экспортёра в
национальной
системе учёта
налогоплательщи
ков
165
Параметр
Тип
Обяз.
Описание
Комментарий
*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
по чеку ККТ от
невладельца
childrenDetail
[array]
-
Маркированный
s
товар
countChildren
integer
-
Количество
(int32)
дочерних КИ
uitu
string
-
КИТУ
вышестоящего
уровня
parent
string
-
Код
идентификации
упаковки, в
которую
агрегирован товар
packType
string
+
Тип упаковки
См. "Справочник "Типы упаковки""
withdrawReas
string
-
Причина вывода
on
из оборота
166
Параметр
Тип
Обяз.
Описание
Комментарий
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 - сертификат или декларация
о соответствии
certificateNu
string
-
Номер документа,
mber
подтверждающего
соответствие
certificateDat
string
-
Дата документа,
Возвращается в формате yyyy-MM-
e
подтверждающего
ddTHH:mm:ss.SSS’Z
соответствие
productGroup
string
+
Товарная группа
См. Справочник "Список
поддерживаемых товарных групп"
color
string
-
Цвет
Возвращается для товарной группы
"Обувные товары"
167
Параметр
Тип
Обяз.
Описание
Комментарий
productSize
string
-
Размер
Возвращается для товарной группы
"Обувные товары"
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
168
{
"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",
"aggregation": true,
"packageTypes": [
"GROUP"
],
"remarkHistory": "ALL"
}
Параметры запроса:
Параметр
Тип
Обяз.
Описание
Комментарий
childrenPaging
boolean
+
Флаг, включающий пагинацию
При включённом
агрегатов
значении
возвращает
постранично
агрегаты только
первого слоя
через указанные
ниже параметры.
Значение по
умолчанию: false
childrenPage
number
-
Число страниц вложений
Значение по
агрегата первого слоя
умолчанию: 1
childrenLimit
number
-
Количество вложений на
Значение по
странице агрегата первого слоя
умолчанию: 50
cis
string
-
Код идентификации
169
Параметр
Тип
Обяз.
Описание
Комментарий
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
emissionDateTo
date-
-
Дата эмиссии, до
Задаётся в
time
формате yyyy-
MM-
ddTHH:mm:ss.SSS
’Z. Пример 2019-
01-
01T03:00:00.000Z
gtin
string
-
Код товара
170
Параметр
Тип
Обяз.
Описание
Комментарий
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
- КИ списан
после нанесения
на товар (товар
ожидает
перемаркировку)
cisStatus
string
-
Текущий статус КИ
См. справочник
"Актуальные
статусы"
limit
string
-
Значение устанавливает
количество записей в ответе, не
более 10000 записей (по
умолчанию 10 записей)
171
Параметр
Тип
Обяз.
Описание
Комментарий
page
string
-
Номер страницы ответа,
начальное значение 0
pg
string
-
Товарная группа
Параметр
обязательно
указывать для
товарных групп:
milk - Молочная
продукция;
water - Вода
172
Параметр
Тип
Обяз.
Описание
Комментарий
withdrawReason
string
-
Причина вывода из оборота
Возможные
значения:
KM_SPOILED -
испорчен;
KM_LOST -
утерян;
KM_DESTROYE
D - уничтожен;
DESCRIPTION_E
RRORS -
выявлены ошибки
описания товара;
RETAIL -
розничная
продажа;
EEC_EXPORT -
экспорт в страны
ЕАЭС;
BEYOND_EEC_E
XPORT - экспорт
за пределы стран
ЕАЭС;
RETURN -
возврат
физическому
лицу;
REMOTE_SALE -
продажа по
образцам,
дистанционный
способ продажи;
DAMAGE_LOSS
- утрата или
повреждение;
DESTRUCTION -
уничтожение;
CONFISCATION
- конфискация;
LIQUIDATION -
ликвидация
предприятия;
DONATION -
безвозмездная
передача;
STATE_ENTERP
RISE -
приобретение
государственным
предприятием;
NO_RETAIL_USE
- использование
для собственных
173
Параметр
Тип
Обяз.
Описание
Комментарий
aggregation
boolean
-
Показывать товары и товарные
упаковки только в одном статусе
для агрегации
packageTypes
string
-
Типы упаковок
См. "Справочник
"Типы упаковки"
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",
174
"previousAgentName": "string",
"previousAgentInn": "string",
"turnoverType": "SELLING",
"status": "EMITTED",
"emissionDate": 0,
"emissionType": "INVALID_VALUE",
"withdrawReason": "KM_SPOILED",
"packType": "UNIT",
"children": [
{
"cis": "string",
"gtin": "string",
"producerName": "string",
"status": "EMITTED",
"emissionDate": 0,
"emissionType": "string",
"producedDate": 0,
"packageType": "UNIT",
"ownerName": "string",
"ownerInn": "string",
"productName": "string",
"brand": "string",
"prevCises": [
"string"
],
"nextCises": [
"string"
],
"statusEx": "EMPTY",
"children": [
"string"
],
"childrenMap": {},
"countChildren": 0,
"parent": "string",
"lastDocId": "string",
"expireDate": 0,
"prVetDocument": "string",
"introducedDate": 0,
"exporterName": "string",
"exporterTaxpayerId": "string",
"agentName": "string",
"agentInn": "string",
"lastStatusChangeDate": 0,
"turnoverType": "SELLING",
"productGroup": "string",
"tnVed10": "string",
"veterinaryControl": true,
"markWithdraw": "TRUE"
}
],
175
"countChildren": 0,
"prevCises": [
"string"
],
"nextCises": [
"string"
],
"cisChildren": [
"string"
]
}
],
"total": 0,
"nextPage": true,
"docErrors": [
{
"additionalProp1": {},
"additionalProp2": {},
"additionalProp3": {}
}
]
}
Параметры ответа:
Параметр
Тип
Обяз.
Описание
Комментарий
results
object
+
Результат запроса
*cis
string
+
Код идентификации,
используемый для фильтрации
по списку КИ
*gtin
string
-
Код товара
*sgtin
string
-
Код товара и серийный номер
КИ
*productName
string
-
Наименование продукта
*tnVed
string
-
Код товарной номенклатуры
*producerName
string
-
Производитель товара
*producerInn
string
-
ИНН производителя/импортёра
товара
*ownerName
string
-
Наименование собственника
товара
*ownerInn
string
-
ИНН собственника товара
*agentName
string
-
Наименование текущего
владельца товара
*agentInn
string
-
ИНН текущего владельца товара
176
Параметр
Тип
Обяз.
Описание
Комментарий
*previousAgentName
string
-
Наименование предыдущего
владельца товара
*previousAgentInn
string
-
ИНН предыдущего владельца
товара
*turnoverType
enum
-
Вид товарооборота
Возможные
значения:
SELLING
- продажа;
COMMISSION -
комиссия;
AGENT - агент
*status
enum
+
Статус товара/КИ
См. Справочник
"Статусы КИ"
*emissionDate
string
+
Дата эмиссии КИ
Возвращается в
(date-
формате yyyy-
time)
MM-
ddTHH:mm:ss.SSS
’Z
*emissionType
string
-
Тип эмиссии
Возможные
значения:
LOCAL -
Производство РФ;
FOREIGN -
Ввезен в РФ;
REMAINS -
Маркировка
остатков;
CROSSBORDER
- Ввезен из стран
ЕАЭС
177
Параметр
Тип
Обяз.
Описание
Комментарий
*withdrawReason
string
-
Причина вывода из оборота
Возможные
значения:
KM_SPOILED -
испорчен;
KM_LOST -
утерян;
KM_DESTROYE
D - уничтожен;
DESCRIPTION_E
RRORS -
выявлены ошибки
описания товара;
RETAIL -
розничная
продажа;
EEC_EXPORT -
экспорт в страны
ЕАЭС;
BEYOND_EEC_E
XPORT - экспорт
за пределы стран
ЕАЭС;
RETURN -
возврат
физическому
лицу;
REMOTE_SALE -
продажа по
образцам,
дистанционный
способ продажи;
DAMAGE_LOSS
- утрата или
повреждение;
DESTRUCTION -
уничтожение;
CONFISCATION
- конфискация;
LIQUIDATION -
ликвидация
предприятия;
DONATION -
безвозмездная
передача;
STATE_ENTERP
RISE -
приобретение
государственным
предприятием;
NO_RETAIL_USE
- использование
для собственных
178
Параметр
Тип
Обяз.
Описание
Комментарий
*packType
string
+
Тип упаковки
Возможные
значения:
UNIT, BUNDLE,
SET, LEVEL1,
LEVEL2,
LEVEL3, ATK
(См. Справочник
"Типы упаковки")
*children:
[array]
-
КИ в агрегате
**cis
string
+
КИ товара
**gtin
string
-
Код товара
**producerName
string
-
Производитель товара
**status
enum
+
Статус товара/КИ
См. Справочник
"Статусы КИ"
**emissionDate
string
+
Дата эмиссии
Задается в
(date-
формате yyyy-
time)
MM-
ddTHH:mm:ss.SSS
’Z
**producedDate
string
-
Дата ввода товара с КИ в оборот
Возвращается в
(date-
формате yyyy-
time)
MM-
ddTHH:mm:ss.SSS
’Z
**packageType
string
+
Тип упаковки
См. Справочник
"Типы упаковки"
**ownerName
string
-
Наименование собственника
товара
**ownerInn
string
-
ИНН собственника товара
**productName
string
-
Наименование товара на
этикетке
**brand
string
-
Бренд
**prevCises
[string]
-
Предыдущие номера КИ в
случае перемаркировки товара)
**nextCises
[string]
-
Следующие номера КИ в случае
перемаркировки товара)
**statusEx
enum
-
Актуальные особые состояния
См. Справочник
КИ
"Статусы КИ"
**children
[string]
-
Все КИ в агрегате
Возвращается в
формате JSON-
массива
179
Параметр
Тип
Обяз.
Описание
Комментарий
**childrenMap
[string]
-
Краткая информация о дочерних
КИ
**countChildren
integer
-
Количество дочерних КИ
**parent
string
-
Код идентификации упаковки, в
которую агрегирован товар
**lastDocId
string
-
Последний регистрационный
номер
документа,зафиксированный в
ГИС МТ по этому КИ
**expireDate
string
-
Дата истечения срока годности
Возвращается в
(date-
формате yyyy-
time)
MM-
ddTHH:mm:ss.SSS
’Z (обязательный
для ТГ "Молочная
продукция")
**prVetDocument
string
-
ID производственного ВСД (для
Обязательный
продукции, произведённой в
параметр для ТГ
РФ) или ID транспортного ВСД
"Молочная
(для продукции, произведённой
продукция".
вне РФ)
Данный параметр
используется
вместо
устаревшего
"prVetDoc"
**introducedDate
string
-
Дата ввода в оборот с КИ в
Возвращается в
(date-
оборот
формате yyyy-
time)
MM-
ddTHH:mm:ss.SSS
’Z
**exporterName
string
-
Наименование экспортера
**exporterTaxpayerId
string
-
Уникальный идентификатор
экспортёра в национальной
системе учета
налогоплательщиков
**agentName
string
-
ИНН текущего владельца товара
**agentInn
string
-
Наименование текущего
владельца товара
**lastStatusChangeDate
string
+
Дата последнего изменения
Возвращается в
(date-
статуса
формате yyyy-
time)
MM-
ddTHH:mm:ss.SSS
’Z
180
Параметр
Тип
Обяз.
Описание
Комментарий
**turnoverType
enum
-
Вид товарооборота
Возможные
значения:
SELLING
- продажа;
COMMISSION -
комиссия;
AGENT - агент
**productGroup
string
+
Товарная группа
См. Справочник
"Список
поддерживаемых
товарных групп"
**tnVed10
string
-
Код ТН ВЭД (10 знаков)
**veterinaryControl
boolean
-
Признак подконтрольности
Возвращается
ВСД, означающий
только для ТГ
необходимость проверки ВСД в
"Молочная
"ВетИС"
продукция"
**markWithdraw
boolean
-
Признак выбытия от
Возвращается
невладельца
ИНН последнего
продавца. Если
ИНН последнего
продавца = ИНН
из токена, то
признак выбытия
от продавца = 1
иначе 0. Если
запрос без токена,
то параметр в
ответе
отсутствует.
*countChildren
integer
-
Количество дочерних КИ
*prevCises
[string]
-
Предыдущие номера КИ в
случае перемаркировки товара)
*nextCises
[string]
-
Следующие номера КИ в случае
перемаркировки товара)
*cisChildren
[string]
-
Список дочерних КИ
total
string
+
Количество вернувшихся
ответов
nextPage
boolean
+
Признак наличия следующей
Возможные
страницы
значения:
true - имеется
следующая
страница;
false - следующая
страница
отсутствует
181
Параметр
Тип
Обяз.
Описание
Комментарий
docErrors
[string]
-
Список ошибок обработки
Возвращается в
документа
случае ошибки
2.17. Метод получения списка переданных КИ с
возможностью фильтрации
URL: /facade/agent/given/list
Метод: GET
Информацию по указанию параметров в строке запроса при работе с большими агрегатами см. в
разделе "Указание параметров в строке запроса при работе с большими агрегатами".
Пример строки запроса:
curl -X GET "<url
стенда>/facade/agent/given/list?cis=string&cisMatchMode=EQ&producerInn=string&agent=st
ring&prevAgent=string&emissionType=INVALID_VALUE&emissionDateFrom=0&emissionDateTo=0&g
tin=string&sn=string&turnoverType=SELLING&cisAggregationState=PACKED&statusExt=WAIT_SH
IPMENT&cisStatus=INTRODUCED&limit=0&page=0&pg=string"
-H "accept: */*" -H "Authorization: Bearer <Токен>"
Параметры запроса:
Параметр
Тип
Обяз.
Описание
Комментарий
childrenPaging
boolean
+
Флаг, включающий пагинацию
При включённом
агрегатов
значении
возвращает
постранично
агрегаты только
первого слоя
через указанные
ниже параметры.
Значение по
умолчанию: false
childrenPage
number
-
Число страниц вложений
Значение по
агрегата первого слоя
умолчанию: 1
childrenLimit
number
-
Количество вложений на
Значение по
странице агрегата первого слоя
умолчанию: 50
cis
string
-
Код идентификации
182
Параметр
Тип
Обяз.
Описание
Комментарий
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
emissionDateTo
date-
-
Дата эмиссии, до
Задаётся в
time
формате yyyy-
MM-
ddTHH:mm:ss.SSS
’Z. Пример 2019-
01-
01T03:00:00.000Z
gtin
string
-
Код товара
183
Параметр
Тип
Обяз.
Описание
Комментарий
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
- КИ списан
после нанесения
на товар (товар
ожидает
перемаркировку)
cisStatus
string
-
Текущий статус КИ
См. справочник
"Актуальные
статусы"
limit
string
-
Значение устанавливает
количество записей в ответе, не
более 10000 записей (по
умолчанию 10 записей)
184
Параметр
Тип
Обяз.
Описание
Комментарий
page
string
-
Номер страницы ответа,
начальное значение 0
pg
string
-
Товарная группа
Параметр
обязательно
указывать для
товарных групп:
milk - Молочная
продукция;
water - Вода
185
Параметр
Тип
Обяз.
Описание
Комментарий
withdrawReason
string
-
Причина вывода из оборота
Возможные
значения:
KM_SPOILED -
испорчен;
KM_LOST -
утерян;
KM_DESTROYE
D - уничтожен;
DESCRIPTION_E
RRORS -
выявлены ошибки
описания товара;
RETAIL -
розничная
продажа;
EEC_EXPORT -
экспорт в страны
ЕАЭС;
BEYOND_EEC_E
XPORT - экспорт
за пределы стран
ЕАЭС;
RETURN -
возврат
физическому
лицу;
REMOTE_SALE -
продажа по
образцам,
дистанционный
способ продажи;
DAMAGE_LOSS
- утрата или
повреждение;
DESTRUCTION -
уничтожение;
CONFISCATION
- конфискация;
LIQUIDATION -
ликвидация
предприятия;
DONATION -
безвозмездная
передача;
STATE_ENTERP
RISE -
приобретение
государственным
предприятием;
NO_RETAIL_USE
- использование
для собственных
186
Параметр
Тип
Обяз.
Описание
Комментарий
aggregation
boolean
-
Показывать товары и товарные
упаковки только в одном статусе
для агрегации
packageTypes
string
-
Типы упаковок
См. "Справочник
"Типы упаковки"
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",
187
"previousAgentName": "string",
"previousAgentInn": "string",
"turnoverType": "SELLING",
"status": "EMITTED",
"emissionDate": 0,
"emissionType": "INVALID_VALUE",
"packType": "UNIT",
"children": [
{
"cis": "string",
"gtin": "string",
"producerName": "string",
"status": "EMITTED",
"emissionDate": 0,
"producedDate": 0,
"packageType": "UNIT",
"ownerName": "string",
"ownerInn": "string",
"productName": "string",
"brand": "string",
"prevCises": [
"string"
],
"nextCises": [
"string"
],
"statusEx": "EMPTY",
"children": [
"string"
],
"childrenMap": {},
"countChildren": 0,
"parent": "string",
"lastDocId": "string",
"expireDate": 0,
"prVetDocument": "string",
"introducedDate": 0,
"exporterName": "string",
"exporterTaxpayerId": "string",
"agentName": "string",
"agentInn": "string",
"lastStatusChangeDate": 0,
"turnoverType": "SELLING",
"productGroup": "string",
"tnVed10": "string",
"veterinaryControl": true,
"markWithdraw": "TRUE"
}
],
"countChildren": 0,
"prevCises": [
188
"string"
],
"nextCises": [
"string"
],
"cisChildren": [
"string"
]
}
],
"total": 0,
"nextPage": true,
"docErrors": [
{
"additionalProp1": {},
"additionalProp2": {},
"additionalProp3": {}
}
]
}
Параметры ответа:
Параметр
Тип
Обяз.
Описание
Комментарий
results
object
+
Результат запроса
*cis
string
+
Код идентификации,
используемый для фильтрации
по списку КИ
*gtin
string
-
Код товара
*sgtin
string
-
Код товара и серийный номер
КИ
*productName
string
-
Наименование продукта
*tnVed
string
-
Код товарной номенклатуры
*producerName
string
-
Производитель товара
*producerInn
string
-
ИНН производителя/импортёра
товара
*ownerName
string
-
Наименование собственника
товара
*ownerInn
string
-
ИНН собственника товара
*agentName
string
-
Наименование текущего
владельца товара
*agentInn
string
-
ИНН текущего владельца товара
*previousAgentName
string
-
Наименование предыдущего
владельца товара
189
Параметр
Тип
Обяз.
Описание
Комментарий
*previousAgentInn
string
-
ИНН предыдущего владельца
товара
*turnoverType
enum
-
Вид товарооборота
Возможные
значения:
SELLING
- продажа;
COMMISSION -
комиссия;
AGENT - агент
*status
enum
+
Статус товара/КИ
См. Справочник
"Статусы КИ"
*emissionDate
string
+
Дата эмиссии КИ
Возвращается в
(date-
формате yyyy-
time)
MM-
ddTHH:mm:ss.SSS
’Z
*emissionType
string
-
Тип эмиссии
Возможные
значения:
LOCAL -
Производство РФ;
FOREIGN -
Ввезен в РФ;
REMAINS -
Маркировка
остатков;
CROSSBORDER
- Ввезен из стран
ЕАЭС
*packType
string
+
Тип упаковки
См. Справочник
"Типы упаковки"
*children:
[array]
-
КИ в агрегате
**cis
string
+
КИ товара
**gtin
string
-
Код товара
**producerName
string
-
Производитель товара
**status
enum
+
Статус товара/КИ
См. Справочник
"Статусы КИ"
**emissionDate
string
+
Дата эмиссии
Задается в
(date-
формате yyyy-
time)
MM-
ddTHH:mm:ss.SSS
’Z
190
Параметр
Тип
Обяз.
Описание
Комментарий
**producedDate
string
-
Дата ввода товара с КИ в оборот
Возвращается в
(date-
формате yyyy-
time)
MM-
ddTHH:mm:ss.SSS
’Z
**packageType
string
+
Тип упаковки
См. Справочник
"Типы упаковки"
**ownerName
string
-
Наименование собственника
товара
**ownerInn
string
-
ИНН собственника товара
**productName
string
-
Наименование товара на
этикетке
**brand
string
-
Бренд
**prevCises
[string]
-
Предыдущие номера КИ в
случае перемаркировки товара)
**nextCises
[string]
-
Следующие номера КИ в случае
перемаркировки товара)
**statusEx
enum
-
Актуальные особые состояния
См. Справочник
КИ
"Статусы КИ"
**children
[string]
-
Все КИ в агрегате
Возвращается в
формате JSON-
массива
**childrenMap
[string]
-
Краткая информация о дочерних
КИ
**countChildren
integer
-
Количество дочерних КИ
**parent
string
-
Код идентификации упаковки, в
которую агрегирован товар
**lastDocId
string
-
Последний регистрационный
номер
документа,зафиксированный в
ГИС МТ по этому КИ
**expireDate
string
-
Дата истечения срока годности
Возвращается в
(date-
формате yyyy-
time)
MM-
ddTHH:mm:ss.SSS
’Z (обязательный
для ТГ "Молочная
продукция")
191
Параметр
Тип
Обяз.
Описание
Комментарий
**prVetDocument
string
-
ID производственного ВСД (для
Обязательный
продукции, произведённой в
параметр для ТГ
РФ) или ID транспортного ВСД
"Молочная
(для продукции, произведённой
продукция".
вне РФ)
Данный параметр
используется
вместо
устаревшего
"prVetDoc"
**introducedDate
string
-
Дата ввода в оборот с КИ в
Возвращается в
(date-
оборот
формате yyyy-
time)
MM-
ddTHH:mm:ss.SSS
’Z
**exporterName
string
-
Наименование экспортера
**exporterTaxpayerId
string
-
Уникальный идентификатор
экспортёра в национальной
системе учета
налогоплательщиков
**agentName
string
-
ИНН текущего владельца товара
**agentInn
string
-
Наименование текущего
владельца товара
**lastStatusChangeDate
string
+
Дата последнего изменения
Возвращается в
(date-
статуса
формате yyyy-
time)
MM-
ddTHH:mm:ss.SSS
’Z
**turnoverType
enum
-
Вид товарооборота
Возможные
значения:
SELLING
- продажа;
COMMISSION -
комиссия;
AGENT - агент
**productGroup
string
+
Товарная группа
См. Справочник
"Список
поддерживаемых
товарных групп"
**tnVed10
string
-
Код ТН ВЭД (10 знаков)
**veterinaryControl
boolean
-
Признак подконтрольности
Возвращается
ВСД, означающий
только для ТГ
необходимость проверки ВСД в
"Молочная
"ВетИС"
продукция"
192
Параметр
Тип
Обяз.
Описание
Комментарий
**markWithdraw
boolean
-
Признак выбытия от
Возвращается
невладельца
ИНН последнего
продавца. Если
ИНН последнего
продавца = ИНН
из токена, то
признак выбытия
от продавца = 1
иначе 0. Если
запрос без токена,
то параметр в
ответе
отсутствует.
*countChildren
integer
-
Количество дочерних КИ
*prevCises
[string]
-
Предыдущие номера КИ в
случае перемаркировки товара)
*nextCises
[string]
-
Следующие номера КИ в случае
перемаркировки товара)
*cisChildren
[string]
-
Список дочерних КИ
total
string
+
Количество вернувшихся
ответов
nextPage
boolean
+
Признак наличия следующей
Возможные
страницы
значения:
true - имеется
следующая
страница;
false - следующая
страница
отсутствует
docErrors
[string]
-
Список ошибок обработки
Возвращается в
документа
случае ошибки
2.18. Метод получения количества переданных КИ с
возможностью фильтрации
Метод является устаревшим и в дальнейшем будет отключён.
URL: /facade/agent/given/count
Метод: GET
Пример запроса:
193
curl -X GET "<url
стенда>/facade/agent/given/count?cis=string&cisMatchMode=EQ&producerInn=string&agent=s
tring&prevAgent=string&emissionType=INVALID_VALUE&emissionDateFrom=0&emissionDateTo=0&
gtin=string&sn=string&turnoverType=SELLING&cisAggregationState=PACKED&statusExt=WAIT_S
HIPMENT&cisStatus=INTRODUCED&limit=0&page=0&pg=string"
-H "accept: */*" -H "Authorization: Bearer <Токен>"
Параметры запроса:
Параметр
Тип
Обяз.
Описание
cis
string
-
Код идентификации
cisMatchMode
string
-
Режим фильтрации по КИ:
EQ - полностью равен;
LIKE - содержит в себе. Является устаревшим и в
дальнейшем
будет
удалён.
Рекомендуется
использовать "START_WITH"("Начинается с");
START_WITH - начинается с
producerInn
string
-
ИНН производителя
agent
string
-
ИНН текущего владельца товара
prevAgent
string
-
ИНН предыдущего владельца товара
emissionType
string
-
Тип эмиссии:
LOCAL - Производство РФ;
FOREIGN - Ввезен в РФ;
REMAINS - Маркировка остатков;
CROSSBORDER - Ввезен из стран ЕАЭС
emissionDateFrom
date-
-
Дата эмиссии, от. Задается в формате yyyy-MM-
time
ddTHH:mm:ss.SSS’Z. Пример 2019-01-
01T03:00:00.000Z
emissionDateTo
date-
-
Дата эмиссии, до. Задается в формате yyyy-MM-
time
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 - любое состояние
194
Параметр
Тип
Обяз.
Описание
statusExt
enum
-
Дополнительный статус товара:
WITHDRAW - вывод из оборота;
WAIT_SHIPMENT - ожидает подтверждения
приемки;
WAIT_TRANSFER_TO_OWNER - ожидает
передачу собственнику (производство по
контракту);
REMARK_RETIRED - перемаркирован;
WAIT_REMARK - КИ списан после нанесения на
товар (товар ожидает перемаркировку)
cisStatus
string
-
Текущий статус КИ:
APPLIED - Эмитирован. Получен;
EMITTED - Эмитирован. Выпущен;
INTRODUCED - В обороте;
RETIRED - Выбыл;
DISAGGREGATION - расформирован
limit
string
-
Значение устанавливает количество записей в
ответе, не более 10000 записей. (По умолчанию 10
записей)
page
string
-
Номер страницы ответа, начальное значение 0
pg
string
-
Товарная группа:
параметр обязательно указывать для товарных
групп:
milk - Молочная продукция;
water - Вода
195
Параметр
Тип
Обяз.
Описание
withdrawReason
string
-
Причина вывода из оборота:
KM_SPOILED - испорчен;
KM_LOST - утерян;
KM_DESTROYED - уничтожен;
DESCRIPTION_ERRORS - выявлены ошибки
описания товара;
RETAIL - розничная продажа;
EEC_EXPORT - экспорт в страны ЕАЭС;
BEYOND_EEC_EXPORT - экспорт за пределы
стран ЕАЭС;
RETURN - возврат физическому лицу;
REMOTE_SALE - продажа по образцам,
дистанционный способ продажи;
DAMAGE_LOSS - утрата или повреждение;
DESTRUCTION - уничтожение;
CONFISCATION - конфискация;
LIQUIDATION - ликвидация предприятия;
DONATION - безвозмездная передача;
STATE_ENTERPRISE - приобретение
государственным предприятием;
NO_RETAIL_USE - использование для
собственных нужд покупателем;
ENTERPRISE_USE - использование для
собственных нужд предприятия;
KM_SPOILED_OR_LOST - испорчен либо утерян
СИ с КИ;
KM_CANCELLATION - аннулирование не
преобразованных в СИ с КИ по истечении срока;
KM_CANCELLATION_BY_TERM - аннулирование
не преобразованных в СИ с КИ по истечении срока;
RETAIL_RETURN - возврат товаров с
поврежденным СИ/без СИ при розничной
реализации;
REMOTE_SALE_RETURN - возврат товаров с
поврежденным СИ/без СИ при дистанционном
способе продажи
aggregation
boolean
-
Показывать товары и товарные упаковки только в
одном статусе для агрегации
Пример ответа:
{
"count": 0
}
Параметры ответа:
196
Параметр
Тип
Обяз.
Описание
count
integer
+
Количество полученных КИ
2.19. Запрос информации об участнике оборота товаров по
ИНН
В результате успешного выполнения запроса по одному ИНН участника оборота товаров в
ответе возвращается информация о запрашиваемом участнике оборота товаров.
Тип приватности: публичный
URL: /facade/participants/{inn}
Метод: GET
Пример строки запроса:
curl -X GET '<url стенда>/facade/participants/7777777777?pg=lp'
Authorization: Bearer <ТОКЕН>
Параметры запроса:
Параметр
Тип
Обяз.
Описание
Комментарий
inn
array
+
ИНН участника
[string]
оборота товаров
pg
string
-
Товарная группа
См. "Справочник "Список
поддерживаемых товарных групп"".
Параметр обязательно указывать для
товарных групп:
milk - "Молочная продукция";
water - "Упакованная вода"
Пример ответа:
197
{
"id": 0,
"inn": "string",
"name": "string",
"shortName": "string",
"fullName": "string",
"type": "string",
"status": "string",
"kpp": "string",
"ogrn": "string",
"head": [
"string"
],
"legalAddress": "string",
"actualAddress": "string",
"email": "string",
"registrationDate": 0,
"organizationForm": "IP",
"emissionRegistrars": "string",
"dissolved": true,
"roles": [
"string"
],
"phone": "string"
}
Параметры ответа:
Параметр
Тип
Обяз.
Описание
Комментарий
id
integer
-
Идентификатор
inn
string
+
ИНН
name
string
+
Наименование
shortName
string
-
Краткое
наименование
fullName
string
+
Полное
наименование
type
string
-
Тип организации
status
string
-
Статус
REGISTERED - Зарегистрирован;
NOT_REGISTERED - Не зарегистрирован;
REMOVED - Удален;
RESTORED - Восстановлен;
BLOCKED - Заблокирован
kpp
string
-
КПП
ogrn
string
-
ОГРН
198
Параметр
Тип
Обяз.
Описание
Комментарий
head
[string]
-
Руководители
legalAddress
string
-
Юридический
адрес
actualAddress
string
-
Фактический
адрес
email
string
-
Email
registrationDa
integer
-
Регистрация
te
organizationF
string
-
Форма
orm
организации: ЮЛ,
ФЛ, ИП
emissionRegi
string
-
Регистратор
strars
эмиссии
dissolved
boolean
-
Признак
существования
организации
roles
[string]
-
Роли организации
phone
string
-
Телефон
2.20. Метод получения информации о средстве
идентификации по началу КИ
URL: /facade/identifytools/start_with
Метод: POST
Информацию по указанию параметров в строке запроса при работе с большими агрегатами см. в
разделе "Указание параметров в строке запроса при работе с большими агрегатами".
Пример строки запроса:
curl -X POST '<url стенда v4>/facade/identifytools/start_with"
-H 'Authorization: Bearer <ТОКЕН>'
-H "Content-Type: application/json" -d
"{"uit":"010405915570452921HXRNJW15asPkB2406405"}"
Параметры строки запроса:
Параметр
Тип
Обяз.
Описание
Комментарий
childrenPagin
boolean
+
Флаг,
При включённом значении возвращает
g
включающий
постранично агрегаты только первого слоя
пагинацию
через указанные ниже параметры.
агрегатов
Значение по умолчанию: false
199
Параметр
Тип
Обяз.
Описание
Комментарий
childrenPage
number
-
Число страниц
Значение по умолчанию: 1
вложений
агрегата первого
слоя
childrenLimit
number
-
Количество
Значение по умолчанию: 50
вложений на
странице агрегата
первого слоя
pg
string
-
Товарная группа
Параметр обязательно указывается в
строке запроса для товарных групп:
milk - "Молочная продукция";
water - "Упакованная вода"
uit
string
+
Код
идентификации
Параметры заголовка запроса: Authorization: Bearer <token>
Пример ответа:
{
"uit": "string",
"cis": "string",
"gtin": "string",
"sgtin": "string",
"tnVedEaes": "string",
"tnVedEaesGroup": "string",
"productName": "string",
"emissionDate": 0,
"producedDate": 0,
"participantName": "string",
"participantInn": "string",
"producerName": "string",
"producerInn": "string",
"ownerName": "string",
"ownerInn": "string",
"statusEx": "EMPTY",
"lastDocId": "string",
"lastDocType": "UNKNOWN",
"emissionType": "string",
"receiptDate": "2021-05-07T00:00:00.000Z",
"withdrawReason": "string",
"prevCises": [
"string"
],
"nextCises": [
"string"
],
"status": "EMITTED",
200
"packType": "UNIT",
"children": [
null
],
"countChildren": 0,
"cisChildren": [
"string"
],
"uitu": "string",
"dateChange": 0,
"parent": "string",
"expireDate": 0,
"prVetDocument": "string",
"introducedDate": 0,
"agentName": "string",
"agentInn": "string",
"previousAgentName": "string",
"previousAgentInn": "string",
"exporterName": "string",
"exporterTaxpayerId": "string",
"turnoverType": "SELLING",
"lastStatusChangeDate": 0,
"productGroup": "string",
"setGtin": [
{
"gtin": "string",
"productName": "string",
"quantity": 0
}
],
"setDescription": "string",
"veterinaryControl": true
}
Параметры ответа:
Параметр
Тип
Обяз.
Описание
Комментарий
uit
string
-
КИ
Обязательный параметр, если не указан
"uitu"
cis
string
+
Код
идентификации,
используемый для
фильтрации по
списку КИ
gtin
string
-
Код товара
sgtin
string
-
Код товара и
серийный номер
КИ
201
содержание ..
1
2
3 .. |
||
|
|
|