Главная Книги - Разные Описание API Государственной информационной системы мониторинга и движения лекарственных препаратов (версия 4.69.0)
поиск по сайту правообладателям
|
|
содержание .. 4 5 6 7 ..
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
sscc
SSCC
String
1
number_sgtins
Состав короба
SgtinNumberIn
1
fo
Структура объекта SgtinNumberInfo:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
batch
Серия
String
0
count_sgtins
Количество
Number
0
SGTIN в серии
exp_date
Срок годности
Date
0
Структура объекта FailedSgtinsNumberInfo:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
sscc
SSCC
String
SSCC
1
error_code
Код ошибки*
Number
1
error_desc
Описание
String
1
ошибки
* Значения кодов:
Код
Значение
2
Запрашиваемые данные не найдены.
10.9.4. Выгрузка общедоступной информации по SGTIN
Тип задачи: public_sgtins
Необходимые права доступа: REESTR_ALL, REESTR_SGTIN
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
10.9.4.1. Параметры фильтрации
500
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
sgtins
Массив SGTIN
Array of Strings
SGTIN
1
Максимальное количество элементов в списке запрашиваемых SGTIN: 100
10.9.4.2. Формат результата выгрузки
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
total
Общее
Number
1
количество
запрошенных
записей
failed
Количество не
Number
1
найденных
записей и
записей, не
прошедших
проверку
entries
Записи из
Array of
PublicSgtins
0
реестра
Objects
failed_entries
Массив КИЗ,
Array of
FailedPublicSgt
0
по которым
Objects
ins
поиск
завершился с
ошибкой
Структура объекта PublicSgtins:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
sgtin
SGTIN
String
SGTIN
1
gtin
GTIN
String
GTIN
1
status
Статус
String
1
sscc
Идентификаци
String
SSCC
0
онный код
третичной
упаковки
501
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
status_date
Дата
String
DateTime
1
последней
смены статуса
last_tracing_op
Дата
String
DateTime
0
_date
последней
операции
branch_id
Идентификато
String
SysID или
1
р МД
BranchID
текущего
местонахожде
ния ЛП
batch
Номер
String
BatchNumber
0
производствен
ной серии
emission_type
Тип эмиссии
Number
{1,2,3,4,5}
0
См. Типы
эмиссии
rzn_decision_d
Дата подачи
String
DateTime
0
ate
сведений в
АИС РЗН
expiration_date
Срок годности
String
DateTime
0
vzn_drug
Признак,
Boolean
1
(Устарел)
отображающи
й, относится
ли ЛП к
списку 7ВЗН
gnvlp (
Признак
Boolean
1
Устарел)
наличия в
ЖНВЛП
prod_name
Торговаямарка
String
0
(бренд)
sell_name
Торговое
String
0
наименование
full_prod_name
Полное
String
0
наименование
товара
pack1_desc
Полное
String
0
наименование
товара
prod_form_nam
Лекарственная
String
0
e
форма
502
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
prod_d_name
Количество
String
0
единиц
измерения
дозировки
лекарственног
о препарата
reg_holder
Держатель
String
0
регистрационн
ого
удостоверения
reg_date
Дата
String
DateTime
0
государственн
ой
регистрации
reg_number
Номер
String
0
регистрационн
ого
удостоверения
drug_code
Внутренний
String
0
уникальный
идентификатор
лекарственног
о препарата в
реестре
ЕСКЛП
halt_doc_date
Дата решения
String
DateTime
0
о
приостановке
halt_doc_num
Номер
String
0
решения о
приостановке
halt_id
Идентификато
String
UUID
0
р решения о
приостановке
withdrawal_typ
Тип вывода из
Number
{1, 2, 3, 4, 5, 6}
0
e
оборота
via_device
Способ
Number
{1, 2, 3, 4}
0
выбытия
Структура объекта FailedPublicSgtins:
503
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
sgtin
SGTIN
String
SGTIN
1
error_code
Код ошибки*
Number
1
error_desc
Описание
String
1
ошибки
* Значения кодов:
Код
Значение
2
Запрашиваемые данные не найдены.
10.9.5. Выгрузка отчёта "Мой виртуальный склад" (Устарел)
Тип задачи: remaining_medicines_branches
Данный тип задачи является устаревшим. Необходимо использовать новые
ВАЖНО
методы, приведённые в разделе Аналитические данные по отчётам
Необходимые права доступа: VIEW_BALANCE_ON_BP_REPORT
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
10.9.5.1. Параметры фильтрации
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
branch_id
Идентификато
String
0*
р места
деятельности
warehouse_id
Идентификато
String
0*
р места
ответственног
о хранения
gtin
GTIN
String
0**
* - Обязателен, если не указан GTIN
** - Обязателен, если не указан идентификатор места деятельности или идентификатор
ответственного хранения
10.9.5.2. Доступные поля выгрузки
504
Наименование
Описание
Примечания
branch_id
Идентификатор места
деятельности или
идентификатор места
ответственного хранения
gtin
GTIN
batch
Серия
exp_date
Срок годности
prod_name
МНН (стандартизованное
значение)
prod_sell_name
Торговое наименование
cnt
Количество упаковок ЛП
cnt_not_on_my_balance
Количество SGTIN, которое
было отгружено отправителем
update_date
Дата обновления данных в
отчете
10.9.6. Выгрузка из реестра серий
Тип задачи: batches_registry
Необходимые права доступа: VIEW_BATCHES_REGISTRY
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
10.9.6.1. Параметры фильтрации
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
gtin
GTIN
String
0
batch
Номер
String
0
производствен
ной серии
emission_type
Тип эмиссии
Number
{1,2,3,4,5}
0
См. Типы
эмиссии
product_sell_na
Торговое
String
0
me
наименование
10.9.6.2. Доступные поля выгрузки
505
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
sell_name
Торговое
String
0
наименование
gtin
GTIN
String
GTIN
0
Идентификаци
онный номер
для
идентификаци
и товаров
batch
Серия
String
0
emission_type
Тип эмиссии
String
0
См. Типы
эмиссии
count_sgtin
Количество
Number
0
SGTIN
vzn
ВЗН
Boolean
0
false - Нет;
true - Да
gnvlp
ЖНВЛП
Boolean
0
false - Нет;
true - Да
in_circulation_c
Количество
Number
0
ount
SGTIN
введенных в
оборот
not_in_circulati
Количество
Number
0
on_count
SGTIN не
введенных в
оборот
sent_to_rzn
Отправлено в
Boolean
0
Параметр
(Устарел)
РЗН
заполняется
только для
резидентов
false - Не
принято;
true - Принят
о;
null - для
нерезидентов
506
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
status_from_rzn
Статус от РЗН
String
0
Заполняется
только для
резидентов.
Для
нерезидентов
- null.
Возможные
значения:
Нет ответа;
Принято;
Не принято
expiration_date
Срок годности
String
Date
0
container_id
Идентификато
String
UUID
0
р контейнера
10.9.7. Выгрузка общедоступной информации по SGTIN из архива
Тип задачи: public_sgtins_archive
Необходимые права доступа: REESTR_ALL, REESTR_SGTIN
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
10.9.7.1. Параметры фильтрации
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
sgtins
Массив SGTIN
Array of Strings
SGTIN
1
Максимальное количество элементов в списке запрашиваемых SGTIN: 100
10.9.7.2. Доступные поля выгрузки
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
total
Общее
Number
1
количество
запрошенных
записей
507
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
failed
Количество не
Number
1
найденных
записей и
записей, не
прошедших
проверку
entries
Записи из
Array of
PublicSgtinsAr
0
реестра
Objects
chive
failed_entries
Массив КИЗ,
Array of
FailedPublicSgt
0
по которым
Objects
insArchive
поиск
завершился с
ошибкой
Структура объекта PublicSgtinsArchive:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
sgtin
SGTIN
String
SGTIN
1
gtin
GTIN
String
GTIN
1
status
Статус
String
1
sscc
Идентификаци
String
SSCC
0
онный код
третичной
упаковки
status_date
Дата
String
DateTime
1
последней
смены статуса
last_tracing_op
Дата
String
DateTime
0
_date
последней
операции
branch_id
Идентификато
String
SysID или
1
р МД
BranchID
текущего
местонахожде
ния ЛП
batch
Номер
String
BatchNumber
0
производствен
ной серии
508
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
emission_type
Тип эмиссии
Number
{1,2,3,4,5}
0
См. Типы
эмиссии
rzn_decision_d
Дата подачи
String
DateTime
0
ate
сведений в
АИС РЗН
expiration_date
Срок годности
String
DateTime
0
vzn_drug
Признак,
Boolean
1
(Устарел)
отображающи
й, относится
ли ЛП к
списку 7ВЗН
gnvlp (
Признак
Boolean
1
Устарел)
наличия в
ЖНВЛП
prod_name
Торговаямарка
String
0
(бренд)
sell_name
Торговое
String
0
наименование
full_prod_name
Полное
String
0
наименование
товара
pack1_desc
Полное
String
0
наименование
товара
prod_form_nam
Лекарственная
String
0
e
форма
prod_d_name
Количество
String
0
единиц
измерения
дозировки
лекарственног
о препарата
reg_holder
Держатель
String
0
регистрационн
ого
удостоверения
reg_date
Дата
String
DateTime
0
государственн
ой
регистрации
509
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
reg_number
Номер
String
0
регистрационн
ого
удостоверения
drug_code
Внутренний
String
0
уникальный
идентификатор
лекарственног
о препарата в
реестре
ЕСКЛП
halt_doc_date
Дата решения
String
DateTime
0
о
приостановке
halt_doc_num
Номер
String
0
решения о
приостановке
halt_id
Идентификато
String
UUID
0
р решения о
приостановке
withdrawal_typ
Тип вывода из
Number
{1, 2, 3, 4, 5}
0
e
оборота
via_device
Способ
Number
{1, 2, 3, 4}
0
выбытия
Структура объекта FailedPublicSgtinsArchive:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
sgtin
SGTIN
String
SGTIN
1
error_code
Код ошибки*
Number
1
error_desc
Описание
String
1
ошибки
* Значения кодов:
Код
Значение
2
Запрашиваемые данные не найдены.
510
10.9.8. Выгрузка списка успешно обработанных SGTIN по id исходного XML-
документа
Тип задачи: sgtins_by_doc_id
Необходимые права доступа: MANAGE_EXPORT_TASKS
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
10.9.8.1. Параметры фильтрации
Имя
Описание
Тип данных
Ограничения
Обязательны
Примечания
реквизита в
реквизита
JSON
й
формате
JSON
document_id
Уникальный
String
UUID
1
идентификатор
документа
10.9.8.2. Доступные поля выгрузки
Наименование
Описание
Примечания
sgtin
SGTIN
Выходная информация
По результатам выполнения клиент получает следующую информацию:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
id
Идентификато
String
UUID
1
р созданной
задачи
В случае ошибки клиент получает следующую информацию:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
error_code
Код ошибки
String
1
См. Список
возможных
кодов ошибок
error_descriptio
Описание
String
1
n
ошибки
Пример использования метода
511
Запрос:
POST api/v1/export/tasks/sgtins_by_doc_id
Host: api.sb.mdlp.crpt.ru
Accept: application/json
Content-Type: application/json
Authorization: token 13b5b046-0cd7-4e1c-8409-da9541986d1c
{
"task_filter":
{
"filters":
{
"document_id":"ff919606-f792-4c72-95f6-461037528632"
},
"fields": ["sgtin"]
}
}
Получение результата:
{
"id": "cc7890a8-39ac-4ba9-ae9a-b20f406a781c"
}
10.9.9. Выгрузка остатков SGTIN на МД
Тип задачи: md_sgtins
Необходимые
права
доступа:
MANAGE_EXPORT_TASKS
и
BRANCH_REMAINS_VERIFICATION
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Ограничение на получение данных по одному месту деятельности:
• максимальный объём выгрузки - 1 000 000 записей;
• одна успешная выгрузка в течение 24 часов.
При превышении лимита возникнут соответствующие ошибки:
• Превышено максимальное количество записей в выгрузке. Допустимое количество: 1 000
000. Уточните параметры фильтрации;
• Превышено максимальное количество выгрузок на место деятельности. Допустимое
количество запросов - 1. Лимит на выгрузку обновляется раз в 168 часов.
Время предоставления выгрузки после формирования запроса - до 24 часов.
512
10.9.9.1. Параметры фильтрации
Имя
Описание
Тип данных
Ограничения
Обязательны
Примечания
реквизита в
реквизита
JSON
й
формате
JSON
branch_id
Идентификато
String
BranchId
1
р места
деятельности
(МД)
10.9.9.2. Доступные поля выгрузки
Наименование
Описание
Примечания
sgtin
SGTIN
SGTIN
status
Статус
sscc
Идентификационный код
SSCC
третичной упаковки
batch
Номер производственной
BatchNumber
серии
exp_date
Срок годности
DateTime
op_exec_date
Дата выполнения последней
DateTime
операции в ядре
Выходная информация
По результатам выполнения клиент получает следующую информацию:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
id
Идентификато
String
UUID
1
р созданной
задачи
В случае ошибки клиент получает следующую информацию:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
error_code
Код ошибки
String
1
См. Список
возможных
кодов ошибок
513
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
error_descriptio
Описание
String
1
n
ошибки
Пример использования метода
Запрос:
POST api/v1/export/tasks/md_sgtins
Host: api.sb.mdlp.crpt.ru
Accept: application/json
Content-Type: application/json
Authorization: token 11b1b011-0cd1-1e1c-1101-da1111111d1c
{
"task_filter": {
"filters": {
"branch_id": "00000000100110"
}
}
}
Получение результата:
{
"id": "cc1110a1-11ac-1ba1-ae1a-b10f111a111c"
}
10.9.10. Выгрузка списка нарушений при продаже товара без проверки КМ
Тип задачи: allow_mode_violations
Необходимые права доступа: ALLOW_MODE_CHECK_VIOLATIONS
Ограничение на получение данных по всем местам деятельности:
• одна успешная выгрузка в течение 24 часов;
• одна выгрузка содержит данные максимум за 92 дня.
10.9.10.1. Параметры фильтрации
514
Имя
Описание
Тип данных
Ограничения
Обязательны
Примечания
реквизита в
реквизита
JSON
й
формате
JSON
violation_date_
дата начала
String
Date
1
Атрибут может
from
периода
содержать
поиска
значение не
нарушения
ранее 92 дней
от
violation_date_t
o
violation_date_t
дата конца
String
Date
1
Атрибут может
o
периода
содержать
поиска
значение не
нарушения
позднее 92
дней от
violation_date_
from
federal_subject
код субъекта
String
8 символов
0
_code
РФ
sys_ids
id места
Array of String
строка - 14
0
если
деятельности
символов;
идентификатор
участника
массив - до
места
100 строк в
деятельности
массиве
отличается от
(включительно
формата 14
)
символов - при
запросе будет
получена
ошибка 400
fiscal_drive_nu
номер
String
16 символов
0
mber
фискального
накопителя
sgtin
SGTIN
String
SGTIN - 27
0
символов
gtin
GTIN
String
GTIN - 14
0
символов
xml_document_
id xml-
String
uuid - 36
0
id
документа
символов
10511, по
которому
зафиксировано
нарушение
10.9.10.2. Доступные поля выгрузки
515
Имя
Описание
Тип данных
Ограничения
Обязательны
Примечания
реквизита в
реквизита
JSON
й
формате
JSON
op_date
дата и время
String
1
регистрации
отклонения
federal_subject
наименование
String
1
_name
субъекта РФ
address
адрес МД, где
String
1
зафиксировано
отклонение
xml_document_
id xml-
String
uuid
1
id
документа
sgtin
sgtin
String
1
gtin
gtin
String
1
houseguid
код ФИАС
String
uuid
1
sys_id
id МД
string
14 символов /
1
uuid
fiscal_drive_nu
номер
String
1
mber
фискального
накопителя
Выходная информация
По результатам выполнения клиент получает следующую информацию:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
id
Идентификато
String
UUID
1
р созданной
задачи
В случае ошибки клиент получает следующую информацию:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
error_code
Код ошибки
String
1
См. Список
возможных
кодов ошибок
516
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
error_descriptio
Описание
String
1
n
ошибки
Пример использования метода
Запрос:
POST api/v1/export/tasks/allow_mode_violations
Host: api.sb.mdlp.crpt.ru
Accept: application/json
Content-Type: application/json
Authorization: token 11b1b011-0cd1-1e1c-1101-da1111111d1c
{
"task_filter": {
"filters": {
"violation_date_from": "2025-05-23",
"violation_date_to": "2025-05-30",
"federal_subject_code": "78",
"sys_ids": [
"00000000002220"
],
"xml_document_id": "34e9ae08-b3f7-4e0d-8eef-23fc6a7c6a1b",
"sgtin": "04650081980324AUTOvXU1NSMBE",
"gtin": "04650081980324"
},
"fields": [
"op_date",
"federal_subject_name",
"address",
"sys_id",
"houseguid",
"xml_document_id",
"sgtin",
"gtin",
"fiscal_drive_number"
]
}
}
Получение результата:
{
"id": "c4b5cb01-d58b-48ba-9885-9cff9e5822a6"
517
}
518
11. Аналитические данные по отчётам
В данном разделе описана функциональность создания однократных заданий на выгрузки
больших объемов и скачивания результатов в формате *.csv.
Ограничения
1. Максимальное количество созданных заданий в сутки для организации - 10.
a. Создание заданий на выгрузку доступно по API и в ЛК ФГИС МДЛП, лимит на создание
заданий общий.
b. При достижении указанного лимита создание новых заданий на выгрузку будет
недоступно.
2. К каждому сформированному заданию на выгрузку формируется файл отчёта.
a. Файл отчета будет удален автоматически через 10 дней.
b. Задание на выгрузку будет автоматически удалено через 30 дней.
3. Создание задания, скачивание / удаление файла выгрузки доступно пользователю, у которого
присутствует право на данный тип задания.
a. Список созданных заданий доступен всем пользователям в разрезе организации.
4. Часовые пояса:
a. Учёт лимита на запросы происходит по дате, соответствующей дате в часовом поясе
UTC;
b. Агрегация в отчётах для каждого события происходит с учетом того часового пояса,
который указан в полученном документе от участника.
Последовательность формирования выгрузок больших объемов
1. Создание нового задания на выгрузку (Метод создания нового задания на выгрузку) и
получение идентификатора задания на выгрузку, используемого на последующих шагах
работы с выгрузкой.
2. Проверка статуса готовности задания на выгрузку по идентификатору задания на выгрузку
(Метод получения статуса задания на выгрузку и Метод получения статусов заданий на
выгрузку).
3. Получение результирующего идентификатора для задания на выгрузку в статусе
"COMPLETED"
("Выполнено") (Метод получения результирующих идентификаторов
выгрузок данных).
4. Получение сформированного файла выгрузки данных по полученному результирующему
идентификатору выгрузки (Метод получения выгрузки). Если выгрузка перемещена в архив,
необходимо сформировать выгрузку повторно.
11.1. Метод создания нового задания на выгрузку
Метод предназначен для создания нового задания на выгрузку и получение идентификатора
задания на выгрузку, который необходим для работы с другими методами сервиса выгрузок.
Endpoint: POST <endpoint>/<version>/data/export/tasks
Необходимые
права
доступа:
GENERAL_PRICING_REPORT
/
519
GENERAL_REPORT_ON_MOVEMENT
/
GENERAL_REPORT_ON_REMAINING_ITEMS
/
GENERAL_REPORT_ON_DISPOSAL / VIRTUAL_WAREHOUSE_REPORT (в зависимости от
типа задания на выгрузку)
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
Входной информацией являются следующие данные:
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
report_id
Тип задания на
String
1
Cм. Список типов
выгрузку
заданий на получение
аналитических данных
по отчётам
params
Параметры
Object
0
Формат зависит от типа
создаваемого
задания. См.
задания
Параметры фильтрации
и описание доступных
полей для выгрузок
Выходная информация
По результатам выполнения клиент получает следующую информацию:
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
task_id
Идентификатор
String
UUID
1
созданной
задачи
create_date
Дата создания
String
DateTime
1
задания
Пример использования метода
Запрос:
POST api/v1/data/export/tasks HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Content-Type: application/json
Authorization: token fc15b313-0a97-40cd-9700-7e1b2b468c42
{
"report_id":"GENERAL_REPORT_ON_REMAINING_ITEMS",
"params":{
520
"1156_IC_Product_MDLP_general_gtin":"08027864050035"
}
}
Получение результата:
{
"task_id": "8ef694e2-1332-4590-a79d-3a98a06c2ac1",
"create_date": "2022-09-09T12:02:21.27"
}
11.2. Метод получения статуса задания на выгрузку
Метод предназначен для получения статуса задания на выгрузку по идентификатору задания,
полученному в Метод создания нового задания на выгрузку.
Endpoint: GET <endpoint>/<version>/data/export/tasks/{task_id}
Необходимые права доступа: авторизованный пользователь
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
Входной информацией являются следующие данные:
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
task_id
Идентификатор
String
UUID
1
созданного
задания
Выходная информация
По результатам выполнения клиент получает следующую информацию:
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
task_id
Идентификатор
String
UUID
1
созданного
задания
521
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
current_status
Статус задачи
String
1
Возможные значения:
"PREPARATION" - "
Подготовка";
"COMPLETED" - "Вы
полнено";
"FAILED" - "Не
успешно"
report_id
Тип задания на
String
1
Cм. Список типов
выгрузку
заданий на получение
аналитических данных
по отчётам
create_date
Дата создания
String
DateTime
1
задачи
params
Параметры
Object
0
задания в
формате * .json
creator
Создатель
Object
UserViewDto
1
задания
task_type
Время хранения
Object
TaskType
1
выгрузки в днях
Формат объекта UserViewDto:
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
full_name
ФИО создателя
String
1
задания
Формат объекта TaskType:
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
downloading_stor
Время хранения
Number
1
age_days
выгрузки в днях
Пример использования метода
Запрос:
GET /api/v1/data/export/tasks/aa1f5f59-063e-4b4c-9477-b276732aaaf9 HTTP/1.1
Host: api.sb.mdlp.crpt.ru
522
Authorization: token fc15b313-0a97-40cd-9700-7e1b2b468c42
Получение результата:
{
"task_id":"aa1f5f59-063e-4b4c-9477-b276732aaaf9",
"current_status":"COMPLETED",
"report_id":"GENERAL_REPORT_ON_REMAINING_ITEMS",
"create_date":"2022-09-09T12:05:21.27",
"creator":{
"full_name":"Иванов Дмитрий Иванович"
},
"task_type":{
"downloading_storage_days":10
}
}
11.3. Метод получения статусов заданий на выгрузку
Метод предназначен для получения информации по всем заданиям на выгрузку
Endpoint: POST <endpoint>/<version>/data/export/tasks/search
Необходимые права доступа: авторизованный пользователь
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
Входной информацией являются следующие данные:
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
pagination
Пагинация
Object
Pagination
1
current_statuses
Текущий статус
String
0
Возможные значения:
задания
"PREPARATION" - "
Подготовка";
"COMPLETED" - "Вы
полнено";
"FAILED" - "Не
успешно".
Можно передавать
несколько значений в
строке, например:
"PREPARATION,COM
PLETED,FAILED"
523
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
report_ids
Наименования
Array of
0
Cм. Список типов
типов задания
Strings
заданий на получение
аналитических данных
по отчётам
task_ids
Идентификатор
Array of
0
ы созданных
Strings
заданий
create_dates_fro
Дата создания
String
DateTime
0
m
(с)
create_dates_to
Дата создания
String
DateTime
0
(по)
Формат объекта Pagination:
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
page
Страница
Number
0
Для получения списка
пагинации
заданий на выгрузку с
первой записи
необходимо указать 0
size
Размер значений
Number
0
Не может превышать
пагинации
1000
Выходная информация
По результатам выполнения клиент получает следующую информацию:
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
list
Список
Array of
1
результатов
Objects
фильтрации
total_count
Количество
Number
1
задач,
соответствующи
х запросу
Формат элемента массива list:
524
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
task_id
Идентификатор
String
UUID
1
созданного
задания
create_date
Дата создания
String
DateTime
1
задания
params
Строка
String
0
параметров
задания в
формате * .json
current_status
Текущий статус
String
1
Возможные значения:
задания
"PREPARATION" - "
Подготовка";
"COMPLETED" - "Вы
полнено";
"FAILED" - "Не
успешно"
report_id
Тип задания
String
1
Cм. Список типов
заданий на получение
аналитических данных
по отчётам
creator
Создатель
Object
UserViewDto
1
задания
task_type
Время хранения
Object
TaskType
1
выгрузки в днях
Формат объекта UserViewDto:
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
full_name
ФИО создателя
String
1
задания
Формат объекта TaskType:
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
downloading_stor
Время хранения
Number
1
age_days
выгрузки в днях
Пример использования метода
525
Запрос:
POST /api/v1/data/export/tasks/search HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Content-Type: application/json
Authorization: token fc15b313-0a97-40cd-9700-7e1b2b468c42
{
"pagination": {
"page": 1,
"size": 100
},
"report_ids": ["GENERAL_PRICING_REPORT","GENERAL_REPORT_ON_DISPOSAL"]
}
Получение результата:
{
"list":[
{
"task_id":"8ef694e2-1332-4590-a79d-3a98a06c2ac1",
"current_status":"COMPLETED",
"report_id":"GENERAL_PRICING_REPORT",
"create_date":"2022-09-09T12:02:21.27",
"creator":{
"full_name":"Иванов Дмитрий Иванович"
},
"task_type":{
"downloading_storage_days":10
}
},
{
"task_id":"83aca9f8-de09-42b2-8ff9-1b1dbb5d5285",
"current_status":"COMPLETED",
"report_id":"GENERAL_REPORT_ON_DISPOSAL",
"create_date":"2022-09-22T12:02:21.27",
"creator":{
"full_name":"Сидоров Сергей Михайлович"
},
"task_type":{
"downloading_storage_days":10
}
}
],
"total_count":2
}
526
11.4. Метод получения результирующих идентификаторов
выгрузок данных
Метод предназначен для получения идентификаторов для выгрузки данных.
Endpoint: GET <endpoint>/<version>/data/export/results
Необходимые права доступа: авторизованный пользователь
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
Входной информацией являются следующие данные:
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
task_ids
Список
Array of
UUID
0
Если значение
идентификаторо
Strings
отсутствует, то
в заданий, по
вернется список всех
которым
выгрузок с учетом
необходимо
пагинации.
отобразить
выгрузки
Параметр пути (path
param)
page
Страница
Number
1
Для получения списка
пагинации
выгрузок с первой
записи необходимо
указать 0.
Параметр пути (path
param)
size
Размер значений
Number
1
Не может превышать
пагинации
1000.
Параметр пути (path
param)
Выходная информация
По результатам выполнения клиент получает следующую информацию:
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
list
Список
Array of
Result
1
результатов
Objects
фильтрации
527
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
total_count
Количество
Number
1
задач,
соответствующи
х запросу
Формат объекта Result:
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
task_id
Идентификатор
String
UUID
1
созданного
задания
result_id
Идентификатор
String
UUID
0
Заполнено, если
результирующей
значение параметра
выгрузки
"download_status"
("Статус выгрузки")
равно "SUCCESS"
("Успешно")
available
Возможность
String
1
Возможные значения:
скачивания
выгрузки
"AVAILABLE" - "Дос
тупна";
"NOT_AVAILABLE"
- "Недоступна"
file_size
Размер CSV
Number
1
выгрузки в
архиве
file_delete_date
Дата и время
String
DateTime
1
запланированно
го удаления
выгрузки
download_status
Статус выгрузки
String
1
Возможные значения:
"SUCCESS" - "Успеш
но";
"PREPARATION" - "
Подготовка";
"FAILED" - "Не
успешно"
528
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
error_message
Сообщение об
String
0
Параметр возвращается
ошибке
при наличии ошибки,
когда значение
параметра
"download_status"
("Статус выгрузки")
равно "FAILED" ("Не
успешно").
Техническая
особенность
формирования
выгрузки: параметр
может возвращаться,
если значение
параметра "available"
("Возможность
скачивания выгрузки")
равно "AVAILABLE"
("Доступна"). При
принятии решения о
доступности выгрузки
необходимо
ориентироваться на
значение параметра
"available"
("Возможность
скачивания выгрузки")
Пример использования метода
Запрос:
GET /api/v1/data/export/results?page=1&size=12&task_ids=4780df3c-c1d7-4e76-83f7-
cea7dcefada0&task_ids=aa1f5f59-063e-4b4c-9477-b276732aaaf9 HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Authorization: token fc15b313-0a97-40cd-9700-7e1b2b468c42
Получение результата:
{
"list":[
{
"task_id":"4780df3c-c1d7-4e76-83f7-cea7dcefada0",
"result_id":"54a85f64-5717-4562-b3fc-2c963f66afa6",
"file_delete_date":"2021-01-25T10:11:13.305Z",
529
"file_size":1024,
"download_status":"SUCCESS",
"available":"AVAILABLE"
},
{
"task_id":"aa1f5f59-063e-4b4c-9477-b276732aaaf9",
"result_id":"5f9fffb9-1c22-49dc-b10d-dfbc0acfcc42",
"file_delete_date":"2021-01-27T12:13:15.305Z",
"file_size":600,
"download_status":"PREPARATION",
"available":"NOT_AVAILABLE"
}
],
"total_count":2
}
11.5. Метод получения выгрузки
Метод предназначен для получения результата задания на выгрузку только в том случае, когда
параметры "download_status" ("Статус выгрузки") и "available" ("Возможность скачивания
выгрузки"), возвращаемые в "Метод получения результирующих идентификаторов выгрузок
данных", имеют значения "SUCCESS"
("Успешно") и "AVAILABLE"
("Доступна"),
соответственно.
Endpoint: GET <endpoint>/<version>/data/export/results/{result_id}/file
Необходимые
права
доступа:
GENERAL_PRICING_REPORT
/
GENERAL_REPORT_ON_MOVEMENT
/
GENERAL_REPORT_ON_REMAINING_ITEMS
/
GENERAL_REPORT_ON_DISPOSAL / VIRTUAL_WAREHOUSE_REPORT (в зависимости от
типа задания на выгрузку)
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
Входной информацией являются следующие данные:
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
result_id
Идентификатор
String
UUID
1
выгрузки
Выходная информация
По результатам успешного выполнения метода клиент получает zip-архив. Время загруженного
CSV файла указано в формате UTC+0.
В случае ошибки клиент получает следующую информацию:
530
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
error_code
Код ошибки
String
1
error_descriptio
Описание
String
1
n
ошибки
Пример использования метода
Запрос:
GET /api/v1/data/export/results/54b7e985-a438-4644-a506-bd53a4841621/file HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Authorization: token fc15b313-0a97-40cd-9700-7e1b2b468c42
Accept: */*
Получение результата:
Файл a2668930-22ec-4258-ad2d-699484813dfb.zip
11.6. Метод удаления файла выгрузки
Метод предназначен для удаления файла выгрузки. После вызова метода выгрузка будет удалена
через три минуты.
Endpoint: DELETE <endpoint>/<version>/data/export/results/{result_id}
Необходимые
права
доступа:
GENERAL_PRICING_REPORT
/
GENERAL_REPORT_ON_MOVEMENT
/
GENERAL_REPORT_ON_REMAINING_ITEMS
/
GENERAL_REPORT_ON_DISPOSAL / VIRTUAL_WAREHOUSE_REPORT (в зависимости от
типа задания на выгрузку)
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
Входной информацией являются следующие данные:
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
result_id
Идентификатор
String
UUID
1
выгрузки
Выходная информация
По результатам выполнения клиент получает следующую информацию:
531
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
result_id
Идентификатор
String
UUID
1
выгрузки
task_id
Идентификатор
String
UUID
1
созданного
задания
file_delete_date
Дата и время
String
DateTime
1
запланированно
го удаления
выгрузки
Пример использования метода
Запрос:
DELETE /api/v1/data/export/results/54b7e985-a438-4644-a506-bd53a4841621 HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Authorization: token fc15b313-0a97-40cd-9700-7e1b2b468c42
Получение результата:
{
"result_id":"54b7e985-a438-4644-a506-bd53a4841621",
"task_id":"aa1f5f59-063e-4b4c-9477-b276732aaaf9",
"file_delete_date":"2022-12-29T15:03:49.577171"
}
11.7. Параметры фильтрации и описание доступных полей
для выгрузок
11.7.1. Общий отчёт по ценам
Тип задания: GENERAL_PRICING_REPORT
Необходимые права доступа: GENERAL_PRICING_REPORT
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
11.7.1.1. Параметры фильтрации
532
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
1026_IC_Period_
Тип
String
1
Допустимые значения:
Type_WM
периода
"IC_Period_Month" - Месяц
;
"IC_Period_Week" - Неделя
533
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
1028_IC_Period_
Неделя
String
0*
Указать период выгрузки в
Week
виде порядкового номера
недели при отсчёте с
1
января 1970 года. В этом
параметре
недоступно
указание двух последних
недель. Если требуется
получить данные за одну из
последних двух недель,
воспользуйтесь
параметрами
"0616_IC_Operation_MDLP_
period_all"
("Получить
данные за последние две
недели")
и
"1031_IC_Period_Week_all"
("Неделя (включая две
последние недели)").
Формула для расчёта:
(год_выгрузки
-
1970)
*
52,1786
+
номер_недели_в_году_выгр
узки.
Полученное при расчёте
число всегда округляется до
целого в меньшую сторону.
Например, для задания
периода
выгрузки
"7.11.2022
- 13.11.2022"
(45
неделя
2022 года)
вычисление производится
следующим образом:
(2022 - 1970) * 52,1786 + 45
= 2758,2872
При округлении получается
"2758".
Полученное
значение
заключается в кавычки в
запросе метода, т.к. формат
параметра - string, пример:
{
"1028_IC_Period_Week":
"2758"
534
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
1027_IC_Period_
Месяц
String
0**
Указать период выгрузки в
Month_11_2019
виде порядкового номера
месяца. Для включения в
выгрузку данных за две
последние недели текущего
месяца укажите в параметре
"0616_IC_Operation_MDLP_
period_all"
("Получить
данные за последние две
недели") значение "true".
Формула для расчёта:
текущий_год
*
12
+
номер_месяца_в_году_выгр
узки.
Например, для задания
периода выгрузки "Ноябрь
2022"
(11-й месяц
2022
года)
вычисление
производится
следующим
образом: 2022 * 12 + 11 =
24275
Полученное
значение
заключается в кавычки в
запросе метода, т.к. формат
параметра - string, пример:
{
"1027_IC_Period_Month_
11_2019": "24275"
}
1158_IC_Agg_1
Тип
String
0
Допустимые значения:
15_type_realiz
агрегации
Agg_General_one___
1026 -
агрегация по GTIN
(значение по умолчанию)
Agg_General_two___
1026 -
агрегация по GTIN + серия
1156_IC_Product
GTIN
Array of
GTIN
0
_MDLP_general_
Strings
gtin
1157_IC_Product
Серия
Array of
0
_MDLP_general_
Strings
batch
535
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
0312_IC_Source
Источник
Array of
0
Допустимые значения:
_type
финансиро
Strings
вания
"собственный бюджет";
"федеральный бюджет";
"региональный бюджет";
"средства бюджетов
внебюджетных фондов";
"смешанные средства
бюджетов"
536
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
0616_IC_Operati
Получить
String
0
Допустимые значения:
on_MDLP_perio
данные за
"true" - получить данные за
d_all
последние
недели
последние две недели;
"false" - не
получать
данные за последние две
недели.
Если указано значение
"true",
и
тип
периода - неделя, то:
• номер
недели
указывается в параметре
"1031_IC_Period_Week_
all"
("Неделя (включая
две последние недели)");
• последней
неделей,
доступной в отчёте,
будет текущая, которая
на
момент
формирования
отчёта
может быть неполной;
• можно запросить любые
предшествующие
(полные) недели.
Пример: отчёт формируется
3
апреля
(среда),
в
параметре
"1031_IC_Period_Week_all"
("Неделя (включая две
последние
недели)"
выбраны
текущая
(неполная)
неделя
и
предыдущая
(полная)
неделя, тогда в отчёт
попадут:
• текущая
(неполная)
неделя
до
даты,
предшествующей
сегодняшней
(1 - 2
апреля,
понедельник - вторник)
;
• предыдущая
(полная)
неделя
(25 - 31 марта,
537
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
Если указано значение
"true",
тип
периода - месяц,
и
в
параметре
"1027_IC_Period_Month_11_
2019"
указан
номер
текущего месяца,
то в
выгрузке будут данные за
текущий месяц, включая
данные за последние две
недели.
Если указано значение
"false", то отчёт может
показать только любые
недели, предшествующие
предыдущей неделе. То есть
если отчёт формируется
3
апреля
(среда),
то
последней
неделей,
доступной в параметре
"1028_IC_Period_Week"
("Неделя"), будет
18 - 24
марта, а следующая неделя
(25 - 31
марта)
будет
недоступна.
Значение заключается в
кавычки в запросе метода,
т.к.
формат
параметра - string, пример:
{
"0616_IC_Operation_MDL
P_period_all": "true"
}
538
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
1031_IC_Period_
Неделя
String
0***
Указать период выгрузки в
Week_all
(включая
виде порядкового номера
две
недели при отсчёте с
1
последние
января 1970 года. Параметр
недели)
может быть заполнен, если
в
параметре
"0616_IC_Operation_MDLP_
period_all"
("Получить
данные за последние две
недели") указано значение
"true". В данном параметре
можно указать как номер
одной из двух последних
недель, так и номер любой
другой недели.
Формула для расчёта:
(год_выгрузки
-
1970)
*
52,1786
+
номер_недели_в_году_выгр
узки.
Полученное при расчёте
число всегда округляется до
целого в меньшую сторону.
Например, для задания
периода
выгрузки
"7.11.2022
- 13.11.2022"
(45
неделя
2022 года)
вычисление производится
следующим образом:
(2022 - 1970) * 52,1786 + 45
= 2758,2872
При округлении получается
"2758".
Полученное
значение
заключается в кавычки в
запросе метода, т.к. формат
параметра - string, пример:
{
"1028_IC_Period_Week":
"2758"
}
* - Обязателен, если не указано значение параметра "1027_IC_Period_Month_11_2019"
539
("Месяц") или если в параметре "0616_IC_Operation_MDLP_period_all" ("Получить данные за
последние две недели") указано значение, отличное от "true"
** - Обязателен, если не указано значение параметра "1028_IC_Period_Week" ("Неделя") или
параметра "1031_IC_Period_Week_all" ("Неделя (включая две последние недели)")
*** - Обязателен, если не указано значение параметра "1028_IC_Period_Week" ("Неделя") или
параметра "1027_IC_Period_Month_11_2019" ("Месяц")
11.7.1.2. Доступные поля выгрузки
Наименования доступных полей выгрузки (соответствуют наименованиям в выгрузке в формате
* .csv):
Наименование
Примечание
GTIN
ИНН участника
ИНН эмитента
Код субъекта РФ
Количество точек продаж
МНН
Наименование участника
Наименование эмитента
Объем продаж, уп.
Серия
Значение в выгрузке заполнено, если в запросе параметр
"1158_IC_Agg_115_type_realiz" ("Тип агрегации") имеет
значение "Agg_General_two___
1026" (агрегация по GTIN
+ серия).
Средневзвешенная цена, руб.
Субъект РФ
Торговое наименование
Источник финансирования
Возможные значения:
"собственный бюджет";
"федеральный бюджет";
"региональный бюджет";
"средства бюджетов внебюджетных фондов";
"смешанные средства бюджетов"
Дата обновления данных
11.7.2. Общий отчёт по выбытию ЛП
Тип задания: GENERAL_REPORT_ON_DISPOSAL
Необходимые права доступа: GENERAL_REPORT_ON_DISPOSAL
540
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
11.7.2.1. Параметры фильтрации
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
1026_IC_Period_
Тип
String
1
Допустимые значения:
Type_WM
периода
"IC_Period_Month" - Месяц
;
"IC_Period_Week" - Неделя
1028_IC_Period_
Неделя
String
0*
Указать период выгрузки в
Week
виде порядкового номера
недели при отсчёте с
1
января 1970 года.
Формула для расчёта:
(год_выгрузки
-
1970)
*
52,1786
+
номер_недели_в_году_выгр
узки.
Полученное при расчёте
число всегда округляется до
целого в меньшую сторону.
Например, для задания
периода
выгрузки
"7.11.2022
- 13.11.2022"
(45
неделя
2022 года)
вычисление производится
следующим образом:
(2022 - 1970) * 52,1786 + 45
= 2758,2872
При округлении получается
"2758".
Полученное
значение
заключается в кавычки в
запросе метода, т.к. формат
параметра - string, пример:
{
"1028_IC_Period_Week":
"2758"
}
541
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
1027_IC_Period_
Месяц
String
0**
Указать период выгрузки в
Month_11_2019
виде порядкового номера
месяца.
Формула для расчёта:
текущий_год
*
12
+
номер_месяца_в_году_выгр
узки.
Например, для задания
периода выгрузки "Ноябрь
2022"
(11-й месяц
2022
года)
вычисление
производится
следующим
образом: 2022 * 12 + 11 =
24275
Полученное
значение
заключается в кавычки в
запросе метода, т.к. формат
параметра - string, пример:
{
"1027_IC_Period_Month_
11_2019": "24275"
}
1156_IC_Product
GTIN
Array of
GTIN
0
_MDLP_general_
Strings
gtin
1157_IC_Product
Серия
Array of
0
_MDLP_general_
Strings
batch
0312_IC_Source
Источник
Array of
0
Допустимые значения:
_type
финансиро
Strings
вания
"собственный бюджет";
"федеральный бюджет";
"региональный бюджет";
"средства бюджетов
внебюджетных фондов";
"смешанные средства
бюджетов"
542
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
0616_IC_Operati
Получить
String
0
Допустимые значения:
on_MDLP_perio
данные за
"true" - получить данные за
d_all
последние
недели
последние две недели;
"false" - не
получать
данные за последние две
недели.
Если указано значение
"true",
и
тип
периода - неделя, то:
• номер
недели
указывается в параметре
"1031_IC_Period_Week_
all"
("Неделя (включая
две последние недели)");
• последней
неделей,
доступной в отчёте,
будет текущая, которая
на
момент
формирования
отчёта
может быть неполной;
• можно запросить любые
предшествующие
(полные) недели.
Пример: отчёт формируется
3
апреля
(среда),
в
параметре
"1031_IC_Period_Week_all"
("Неделя (включая две
последние
недели)"
выбраны
текущая
(неполная)
неделя
и
предыдущая
(полная)
неделя, тогда в отчёт
попадут:
• текущая
(неполная)
неделя
до
даты,
предшествующей
сегодняшней
(1 - 2
апреля,
понедельник - вторник)
;
• предыдущая
(полная)
неделя
(25 - 31 марта,
543
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
Если указано значение
"true",
тип
периода - месяц,
и
в
параметре
"1027_IC_Period_Month_11_
2019"
указан
номер
текущего месяца,
то в
выгрузке будут данные за
текущий месяц, включая
данные за последние две
недели.
Если указано значение
"false", то отчёт может
показать только любые
недели, предшествующие
предыдущей неделе. То есть
если отчёт формируется
3
апреля
(среда),
то
последней
неделей,
доступной в параметре
"1028_IC_Period_Week"
("Неделя"), будет
18 - 24
марта, а следующая неделя
(25 - 31
марта)
будет
недоступна.
Значение заключается в
кавычки в запросе метода,
т.к.
формат
параметра - string, пример:
{
"0616_IC_Operation_MDL
P_period_all": "true"
}
544
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
1031_IC_Period_
Неделя
String
0***
Указать период выгрузки в
Week_all
(включая
виде порядкового номера
две
недели при отсчёте с
1
последние
января 1970 года. Параметр
недели)
может быть заполнен, если
в
параметре
"0616_IC_Operation_MDLP_
period_all"
("Получить
данные за последние две
недели") указано значение
"true". В данном параметре
можно указать как номер
одной из двух последних
недель, так и номер любой
другой недели.
Формула для расчёта:
(год_выгрузки
-
1970)
*
52,1786
+
номер_недели_в_году_выгр
узки.
Полученное при расчёте
число всегда округляется до
целого в меньшую сторону.
Например, для задания
периода
выгрузки
"7.11.2022
- 13.11.2022"
(45
неделя
2022 года)
вычисление производится
следующим образом:
(2022 - 1970) * 52,1786 + 45
= 2758,2872
При округлении получается
"2758".
Полученное
значение
заключается в кавычки в
запросе метода, т.к. формат
параметра - string, пример:
{
"1028_IC_Period_Week":
"2758"
}
* - Обязателен, если не указано значение параметра "1027_IC_Period_Month_11_2019"
545
("Месяц") или если в параметре "0616_IC_Operation_MDLP_period_all" ("Получить данные за
последние две недели") указано значение, отличное от "true"
** - Обязателен, если не указано значение параметра "1028_IC_Period_Week" ("Неделя") или
параметра "1031_IC_Period_Week_all" ("Неделя (включая две последние недели)")
*** - Обязателен, если не указано значение параметра "1028_IC_Period_Week" ("Неделя") или
параметра "1027_IC_Period_Month_11_2019" ("Месяц")
11.7.2.2. Доступные поля выгрузки
Наименования доступных полей выгрузки (соответствуют наименованиям в выгрузке в формате
* .csv):
Наименование
Примечания
Дата выбытия
ИНН эмитента
Наименование эмитента
Код субъекта РФ
Субъект РФ
Населенный пункт
Район
ИНН участника
Наименование участника
Идентификатор МД участника
Адрес
МНН
Торговое наименование
GTIN
Серия
Срок годности
Тип выбытия
Cм. Типы выбытия
Объем выбытий, уп.
Источник финансирования
Возможные значения:
"собственный бюджет";
"федеральный бюджет";
"региональный бюджет";
"средства бюджетов внебюджетных фондов";
"смешанные средства бюджетов"
Дата обновления данных
546
Наименование
Примечания
Тип экспорта
Возможные значения:
"-" (отсутствие значения);
"Экспорт в Узбекистан";
"Экспорт в третьи страны";
"Отгрузка ЛП в ЕАЭС"
11.7.3. Общий отчёт по движению ЛП
Тип задания: GENERAL_REPORT_ON_MOVEMENT
Необходимые права доступа: GENERAL_REPORT_ON_MOVEMENT
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
11.7.3.1. Параметры фильтрации
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
1026_IC_Period_
Тип
String
1
Допустимые значения:
Type_WM
периода
"IC_Period_Month" - Месяц
;
"IC_Period_Week" - Неделя
547
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
1029_IC_Period_
Неделя
String
0*
Указать период выгрузки в
Week_now
виде порядкового номера
недели при отсчёте с
1
января 1970 года.
Формула для расчёта:
(год_выгрузки
-
1970)
*
52,1786
+
номер_недели_в_году_выгр
узки.
Полученное при расчёте
число всегда округляется до
целого в меньшую сторону.
Например, для задания
периода
выгрузки
"7.11.2022
- 13.11.2022"
(45
неделя
2022 года)
вычисление производится
следующим образом:
(2022 - 1970) * 52,1786 + 45
= 2758,2872
При округлении получается
"2758".
Полученное
значение
заключается в кавычки в
запросе метода, т.к. формат
параметра - string, пример:
{
"1029_IC_Period_Week_n
ow": "2758"
}
548
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
1027_IC_Period_
Месяц
String
0**
Указать период выгрузки в
Month_11_2019
виде порядкового номера
месяца.
Формула для расчёта:
текущий_год
*
12
+
номер_месяца_в_году_выгр
узки.
Например, для задания
периода выгрузки "Ноябрь
2022"
(11-й месяц
2022
года)
вычисление
производится
следующим
образом: 2022 * 12 + 11 =
24275
Полученное
значение
заключается в кавычки в
запросе метода, т.к. формат
параметра - string, пример:
{
"1027_IC_Period_Month_
11_2019": "24275"
}
1156_IC_Product
GTIN
Array of
GTIN
0
_MDLP_general_
Strings
gtin
1157_IC_Product
Серия
Array of
0
_MDLP_general_
Strings
batch
0312_IC_Source
Источник
Array of
0
Допустимые значения:
_type
финансиро
Strings
вания
"собственный бюджет";
"федеральный бюджет";
"региональный бюджет";
"средства бюджетов
внебюджетных фондов";
"смешанные средства
бюджетов"
* - Обязателен,
если не указано значение параметра "1027_IC_Period_Month_11_2019"
("Месяц")
** - Обязателен, если не указано значение параметра "1029_IC_Period_Week_now" ("Неделя")
549
11.7.3.2. Доступные поля выгрузки
Наименования доступных полей выгрузки (соответствуют наименованиям в выгрузке в формате
* .csv):
Наименование
Примечания
Дата операции
Операция агрегируется по дате операции, полученной в
документе движения, который направляет участник
ИНН эмитента
Наименование эмитента
МНН
Торговое наименование
GTIN
Серия
Номер операции
ИНН отправителя
Наименование отправителя
Идентификатор МД отправителя
ИНН получателя
Наименование получателя
Идентификатор МД получателя
Количество, уп.
Источник финансирования
Возможные значения:
"собственный бюджет";
"федеральный бюджет";
"региональный бюджет";
"средства бюджетов внебюджетных фондов";
"смешанные средства бюджетов"
Дата обновления данных
11.7.4. Общий отчёт по остаткам ЛП
Тип задания: GENERAL_REPORT_ON_REMAINING_ITEMS
Необходимые права доступа: GENERAL_REPORT_ON_REMAINING_ITEMS
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
11.7.4.1. Параметры фильтрации
550
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
1156_IC_Product
GTIN
Array of
GTIN
0
Если значения параметров
_MDLP_general_
Strings
"1156_IC_Product_MDLP_ge
gtin
neral_gtin" ("GTIN") и
"1157_IC_Product_MDLP_ge
neral_batch" ("Серия") не
1157_IC_Product
Серия
Array of
0
указаны, то осуществляется
_MDLP_general_
Strings
выгрузка данных по всем
batch
GTIN + Серия, доступным
данному участнику
0312_IC_Source
Источник
Array of
0
Допустимые значения:
_type
финансиро
Strings
вания
"собственный бюджет";
"федеральный бюджет";
"региональный бюджет";
"средства бюджетов
внебюджетных фондов";
"смешанные средства
бюджетов"
11.7.4.2. Доступные поля выгрузки
Наименования доступных полей выгрузки (соответствуют наименованиям в выгрузке в формате
* .csv):
Наименование
Примечания
ИНН эмитента
Наименование эмитента
Код субъекта РФ
Субъект РФ
Населенный пункт
Район
ИНН участника
Наименование участника
Идентификатор МД участника
Учитываются только активные места деятельности
Адрес
МНН
Торговое наименование
GTIN
Серия
551
Наименование
Примечания
Срок годности
Остатки на рынке, уп.
Остатки до ввода в ГО, уп.
Общие остатки, уп.
Источник финансирования
Возможные значения:
"собственный бюджет";
"федеральный бюджет";
"региональный бюджет";
"средства бюджетов внебюджетных фондов";
"смешанные средства бюджетов"
Дата обновления данных
Остатки на рынке без учета 705, уп
Отгружено
Возможные значения:
"Отгружено";
"На балансе участника"
11.7.5. Мой виртуальный склад (новый)
Тип задания: VIRTUAL_WAREHOUSE_REPORT
Необходимые права доступа: VIRTUAL_WAREHOUSE_REPORT
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
11.7.5.1. Параметры фильтрации
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
1512_IC_id_mo_
Идентифик
String
BranchID
1
mox
атор МД /
МОХ
1246_IC_Product
GTIN
Array of
GTIN
0
_gtin
Strings
1247_IC_Product
Серия
Array of
0
_batch
Strings
1257_IC_Product
Статус ЛП
String
0
Возможные значения:
_MDLP_stat_lp
ЛП отгружено новому
владельцу;
На балансе текущего
владельца (значение по
умолчанию)
552
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
1173_IC_Product
Тип срока
Array of
0
Возможные значения:
_MDLP_expirati
годности
Strings
on_lp
"Просрочено";
"Остаток срока годности до
14 дней";
"Остаток срока годности до
месяца";
"Остаток срока годности до
2х месяцев";
"Остаток срока годности до
3х месяцев";
"Остаток срока годности
больше 3х месяцев"
0238_IC_Date_St
Начало
String
Date
0
Значение по умолчанию:
art_period_8
периода
текущая дата минус 2 года
окончания
срока
годности
0239_IC_Date_Fi
Завершение
String
Date
0
Значение по умолчанию:
nish_period_8
периода
текущая дата плюс 2 года
окончания
срока
годности
11.7.5.2. Доступные поля выгрузки
Наименования доступных полей выгрузки (соответствуют наименованиям в выгрузке в формате
* .csv):
Наименование
Примечание
Адрес / Идентификатор МД / МОХ
МНН
Торговое наименование
GTIN
Серия
Тип срока годности
Возможные значения:
Просрочено;
Остаток срока годности до 14 дней;
Остаток срока годности до месяца;
Остаток срока годности до 2х месяцев;
Остаток срока годности до 3х месяцев;
Остаток срока годности больше 3х месяцев
553
Наименование
Примечание
Дата окончания срока годности
Количество упаковок
Количество упаковок по 705 схеме
Дата обновления информации
ЛП в карантине
Возможные значения:
"-" (отсутствие значения);
"В карантине"
554
12. Получение событий, связанных с выбытием
КИЗ
12.1. Общие правила работы
1. События добавляются в очередь с момента активации соответствующей подписки.
2. После получения порции данных по подписке данные из очереди выдачи участнику будут
удалены.
3. Период хранения данных в очереди участника по подписке в случае, если участник не
получает эти данные, равна 3 дням.
4. В выдаче данные отсортированы по дате добавления в очередь участника по возрастанию (от
наиболее старой даты к новой дате).
12.2. Список доступных типов событий вывода из оборота
(WithdrawalEventType)
Таблица 69. Список доступных типов событий вывода из оборота (WithdrawalEventType)
Наименование типа
Описание
SGTIN_AWAITING_WITHDRAWAL_KKT
Формирование события в подписку по SGTIN,
для которого поступила информация о
выбытии, поместившая SGTIN в реестр
ожиданий вывода из оборота (ККТ или
документ).
Событие формируется при наличии подписки
для следующих участников оборота товаров:
• для участника, осуществившего вывод ЛП
из оборота;
• для текущего владельца SGTIN в ЛК (в
случае отсутствия сведений о приемке со
стороны участника, осуществившего вывод
ЛП из оборота).
Событие формируется при получении схем:
• 511;
• 10511;
• 512;
•
10522
555
Наименование типа
Описание
SGTIN_AWAITING_WITHDRAWAL_DEVICE
Формирование события в подписку по SGTIN,
для которого поступила информация о
выбытии, поместившая SGTIN в реестр
ожиданий вывода из оборота (РВ или
документ).
Событие формируется при наличии подписки
для следующих участников оборота товаров:
• для участника, осуществившего вывод ЛП
из оборота;
• для текущего владельца SGTIN в ЛК (в
случае отсутствия сведений о приемке со
стороны участника, осуществившего вывод
ЛП из оборота).
Событие формируется при получении схем:
• 521;
• 10521;
• 10523;
• 531;
• 10531;
•
10532
556
Наименование типа
Описание
SGTIN_WITHDRAWN
Формирование события в подписку по SGTIN
при смене статуса (для SGTIN, находившихся в
реестре ожиданий, по факту выхода из реестра
ожиданий).
Событие формируется при наличии подписки
для
участника
оборота
товаров,
осуществившего вывод ЛП из оборота.
Событие формируется при получении схем:
• 335 - для типов custom_procedure_code:
◦ 10 (экспорт);
◦ 93 (уничтожение);
◦ 94 (отказ в пользу государства).
• 461:
◦ 511:
▪ 10511;
▪ 512;
▪ 521;
▪ 10521;
▪ 10522;
▪ 10523;
▪ 531;
▪ 10531;
▪
10532.
◦
552 - все типы
12.3. Создание подписки на получение событий, связанных с
выбытием КИЗ
Endpoint: POST <endpoint>/<version>/withdrawal_events/subscribe
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
Входной информацией являются следующие данные:
557
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
event_types
Массив типов
Array of Strings
WithdrawalEve
1
См. Список
событий
ntType;
доступных
Минимальный
типов событий
размер:
1;
вывода из
Максимальны
оборота
й размер: 3;
(WithdrawalEv
entType).
branch_ids
Массив
Array of Strings
Branch;
1
идентификато
Минимальный
ров МД
размер:
1;
Максимальны
й
размер:
2000;
Выходная информация
По результатам выполнения клиент получает следующую информацию:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
subscription_id
Идентификато
String
UUID
1
р подписки
Пример использования метода
Запрос:
POST api/v1/withdrawal_events/subscribe HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Accept: application/json
Content-Type: application/json
Authorization: token 13b5b046-0cd7-4e1c-8409-da9541986d1c
{
"event_types": [
"SGTIN_AWAITING_WITHDRAWAL_KKT",
"SGTIN_WITHDRAWN",
],
"branch_ids": [
"00000000100930"
]
}
558
Получение результата:
{
"subscription_id": "3c2bf2c2-cea2-489d-a282-ddcf79b315b4"
}
12.4. Получение списка подписок
Endpoint:
GET
<endpoint>/<version>/withdrawal_events/subscriptions?start_from={start_from}&count=
{count}
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
Входной информацией являются следующие данные:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
start_from
Индекс первой
Number
Минимальное
1
Параметр
записи
значение: 0
запроса (query
parameter)
count
Максимальное
Number
Минимальное
1
Параметр
количество
значение:
1;
запроса (query
записей
Максимальное
parameter)
значение: 500;
Выходная информация
По результатам выполнения клиент получает следующую информацию:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
total
Общее
Number
1
количество
записей по
запросу
subscriptions
Массив с
Array of
WithdrawalEve
1
См. Формат
информацией
Objects
ntsSubscription
объекта
о подписках
WithdrawalEve
ntsSubscription.
Таблица 70. Формат объекта WithdrawalEventsSubscription
559
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
subscription_id
Идентификато
String
UUID
1
р подписки
event_types
Массив типов
Array of Strings
WithdrawalEve
1
См. Список
событий
ntType
доступных
типов событий
вывода из
оборота
(WithdrawalEv
entType).
branch_ids
Массив
Array of Strings
Branch
1
идентификато
ров МД
Пример использования метода
Запрос:
GET api/v1/withdrawal_events/subscriptions?start_from=0&count=1 HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Authorization: token 13b5b046-0cd7-4e1c-8409-da9541986d1c
Получение результата:
{
"total": 1,
"subscriptions": [
{
"subscription_id": "3c2bf2c2-cea2-489d-a282-ddcf79b315b4",
"event_types": [
"SGTIN_AWAITING_WITHDRAWAL_KKT",
"SGTIN_WITHDRAWN"
],
"branch_ids": [
"00000000100930"
]
}
]
}
12.5. Изменение подписки на получение событий, связанных
с выбытием КИЗ
Endpoint: PUT <endpoint>/<version>/withdrawal_events/subscriptions/{subscription_id}
560
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
Входной информацией являются следующие данные:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
subscription_id
Идентификато
String
UUID
1
Параметр пути
р подписки
(path param)
event_types
Массив типов
Array of Strings
WithdrawalEve
1
См. Список
событий
ntType;
доступных
Минимальный
типов событий
размер:
1;
вывода из
Максимальны
оборота
й размер: 3;
(WithdrawalEv
entType).
branch_ids
Массив
Array of Strings
Branch;
1
идентификато
Минимальный
ров МД
размер:
1;
Максимальны
й
размер:
2000;
Выходная информация
По результатам выполнения клиент получает ответ с кодом 200 и пустым телом.
Пример использования метода
Запрос:
PUT api/v1/withdrawal_events/subscriptions/{subscription_id} HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Accept: application/json
Content-Type: application/json
Authorization: token 13b5b046-0cd7-4e1c-8409-da9541986d1c
{
"event_types": [
"SGTIN_AWAITING_WITHDRAWAL_KKT",
"SGTIN_WITHDRAWN",
],
"branch_ids": [
"00000000100930"
]
}
561
12.6. Получение событий, связанных с выбытием КИЗ
Endpoint:
GET
<endpoint>/<version>/withdrawal_events?subscription_id={subscription_id}&count={cou
nt}
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Фиксация событий вывода КИЗ из оборота начинается после создания подписки.
Соответственно, события, произошедшие до создания подписки не будут отражены в результате
метода.
События, полученные в результате метода считаются обработанными и повторное их получение
невозможно. При последующем вызове будут возвращены следующие по очереди события.
Параметры метода
Входной информацией являются следующие данные:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
subscription_id
Идентификато
String
UUID
1
Параметр
р подписки
запроса (query
parameter)
count
Максимальное
Number
Минимальное
1
Параметр
количество
значение:
1;
запроса (query
записей
Максимальное
parameter)
значение: 500;
Выходная информация
По результатам выполнения клиент получает следующую информацию:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
events
Массив с
Array of
WithdrawalEve
1
См. Формат
информацией
Objects
nt
объекта
о событиях
WithdrawalEve
выбытия КИЗ
nt
count
Общее
Number
1
количество
записей
Таблица 71. Формат объекта WithdrawalEvent
562
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
event_type
Тип события
String
WithdrawalEve
1
См. Список
ntType
доступных
типов событий
вывода из
оборота
(WithdrawalEv
entType)
branch_id
Идентификато
String
Branch
1
р МД
sgtin
SGTIN (КИЗ)
String
SGTIN
1
gtin
GTIN
String
GTIN
1
status
Статус
String
1
batch
Номер
String
BatchNumber
1
производствен
ной серии
withdrawal_typ
Тип вывода из
Number
{1,2,3,4,5,6}
0
e
оборота
via_device
Способ
Number
{1,2,3,4}
0
выбытия
status_date
Дата
String
DateTime
1
последней
смены статуса
last_tracing_op
Дата
String
DateTime
0
_date
последней
операции
expiration_date
Срок годности
String
DateTime
0
Пример использования метода
Запрос:
GET api/v1/withdrawal_events?subscription_id=3c2bf2c2-cea2-489d-a282-
ddcf79b315b4&count=1 HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Authorization: token 13b5b046-0cd7-4e1c-8409-da9541986d1c
Получение результата:
{
"events": [
563
{
"event_type": "SGTIN_WITHDRAWN",
"branch_id": "00000000100930",
"sgtin": "046040600024394KibV4AEbwD7L",
"gtin": "04604060002439",
"status": "disposed",
"batch": "1122",
"withdrawal_type": 4,
"via_device": 2,
"status_date": "2022-02-15T14:34:55",
"last_tracing_op_date": "2022-02-14T12:11:07",
"expiration_date": "2025-03-01T00:00:00"
}
],
"count": 1
}
12.7. Отписка от получения событий, связанных с выбытием
КИЗ
Endpoint: POST <endpoint>/<version>/withdrawal_events/unsubscribe
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
Входной информацией являются следующие данные:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
subscription_id
Идентификато
String
UUID
1
р подписки
Выходная информация
По результатам выполнения клиент получает ответ с кодом 200 и пустым телом.
Пример использования метода
Запрос:
POST api/v1/withdrawal_events/unsubscribe HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Accept: application/json
Content-Type: application/json
Authorization: token 13b5b046-0cd7-4e1c-8409-da9541986d1c
{
564
"subscription_id": "3c2bf2c2-cea2-489d-a282-ddcf79b315b4"
}
12.8. Формат ответа в случае ошибки
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
error_code
Код ошибки
String
1
error_descriptio
Описание
String
1
n
ошибки
12.9. Список возможных кодов ошибок
Наименование
Описание
core.error.6001
Участник не является владельцем указанных
мест деятельности
core.error.6002
Места деятельности уже указаны для другой
подписки
core.error.6003
Указанный subscription_id отсутствует в
системе
565
13. Часто задаваемые вопросы
1.
Для чего нужна учетная система (УС)?
Учетная система используется только для авторизации пользователей в API (получение
токена авторизации). Каждая учетная система привязана только к одному участнику (одной
организации) с конкретным sys_id (идентификатором субъекта обращения в «ИС
"Маркировка". МДЛП»). У организации может быть зарегистрировано в API несколько
учетных систем, с реквизитами которых можно авторизовать пользователей.
Никакой дополнительной функциональной нагрузки зарегистрированная учетная система на
данный момент не несет и не имеет связи с пользователями участника. Она не используется в
фильтрации списка исходящих/входящих документов, она не используется в фильтрации
поиска пользователей, групп прав, других учетных систем - единственным критерием
фильтрации в поиске является sys_id зарегистрированного пользователя, чей
авторизационный токен используется в запросах.
Для подключения с использованием одной обезличенной УКЭП есть ограничение на
максимальное количество сессий - 200. Права и методы, доступные пользователям с
обезличенной УКЭП, см. в разделе "Список прав и методов, доступных пользователям с
обезличенной УКЭП".
2.
Не могли бы вы привести пример кода на языке X / платформе Y, как можно реализовать
вызов метода Z?
Нет, таких примеров мы не даем.
3.
Какие данные мне использовать, чтобы получить доступ тестовому стенду API?
Данные для подключения приведены в документации по API. Рекомендуется, используя
учетные записи тестовых пользователей, создавать учетные записи для своих пользователей
и учетных систем.
4.
Как получить доступ к справочнику ГС1 (GS1)?
ГС1 - закрытый (платный) реестр, в публичном открытом АПИ он не предусмотрен. Запросы
к данному реестру должны выполняться отдельно на стороне разработчиков учетных систем.
5.
Для чего может понадобиться метод "Получение списка исходящих документов"?
Метод может использоваться для просмотра истории отправленных документов.
6.
Как долго хранится информация об исходящих документах?
Информация об отправленных документах хранится постоянно и не удаляется.
7.
Помечается ли документ как прочитанный и возможно ли его скачивать несколько раз?
Документ никогда не помечается прочитанным. Если имеется входящий документ для
данного участника, то он всегда будет присутствовать в его списке входящих документов.
8.
Все ли документы возвращаются методом "Получение списка входящих документов"?
Данный метод возвращает информацию по всем входящим документам, за исключением
квитанций об обработке документов (схемы документов 200, 201 и 211).
9.
Каким образом можно получить квитанции об обработке документов, если они
отсутствуют в ответе метода "Получение списка входящих документов"?
Квитанции об обработке документов можно получить, используя метод "Получение списка
документов по идентификатору запроса".
10.
Можно ли использовать один request_id для нескольких отправок документов?
Нет, вернется ошибка. Уникальность request_id контролируется.
566
11.
На тестовом стенде (судя по тестовым данным в конце описания API) можно
авторизоваться только с паролем (test_non_resident). Если хочется проверить авторизацию
резидента, нужно подключаться к песочнице?
Используя тестовую учетную запись test_non_resident, вы можете создавать своих
пользователей и осваивать работу с API на них. Подключаться к "Песочнице" рекомендуется
уже после того, как работа с API освоена на максимальном количестве методов на тестовом
стенде.
12.
При уже полученном токене какая будет реакция системы на попытку повторной
авторизации?
При повторной отправке запроса на токен с тем же кодом система вернет ошибку.
13.
Существует ли какой-то рекомендованный механизм проверки связи и общей
работоспособности API?
На данный момент единого механизма не существует.
14.
Если мы авторизуемся как нерезидент, дальше система нам даст возможность
отправлять подписанные документы?
Пользователи участника-нерезидента авторизуются по логину/паролю, поэтому они могут
отправлять только неподписанные документы.
15.
Метод "Завершение отправки документа" должен выполняться только после отправки
документа большого размера или для всех типов документов?
Метод "Завершение отправки документа" необходимо вызывать только для документов
большого размера.
16.
Что именно является размером документа: размер содержимого документа, документа в
BASE64 или всего запроса в формате JSON?
Размером является весь запрос в JSON: документ, подпись в BASE64 и т.д.
17.
Отмена отправки документа может выполняться только для документов большого
размера или для всех типов документов?
Отмена может быть выполнена только для больших документов до вызова метода
"Завершение отправки документа".
18.
Сколько времени даётся на загрузку документа большого объёма?
Ссылка на загрузку документа становится недействительной через 2 часа.
19.
Требуется ли клиентский сертификат для установки TLS-соединения?
Клиентский сертификат для TLS соединения не требуется. Требуется установить корневой
сертификат в список доверенных сертификатов с сайта КриптоПро.
20.
Можно ли через одно TLS-соединение посылать данные разных клиентов?
Можно.
21.
Можно ли использовать сертифицированное ПО без аппаратных токенов?
Можно.
22.
После успешной авторизации на любой вызов метода по HTTPS приходит ответ с HTTP
кодом 307. В чем может быть причина?
HTTP коды 3xx сигнализируют о необходимости выполнять запрос по другому URL. Новый
URL указывается в HTTP заголовке ответа Location и большинство HTTP клиентов умеют в
автоматическом режиме перенаправлять такие запросы по указанному в URL, прозрачно для
пользователя.
23.
Попытались получить квитанцию по ссылке, которую уже однажды использовали, но
запрос завершился неудачно. Ссылка недействительна?
567
Время жизни ссылки - 2 часа. Для скачивания документа необходимо получать новую
ссылку каждый раз, когда старая становиться недействительной.
24. Как определить, что отправленный ранее документ был обработан системой?
Документ, обработанный системой, имеет статус PROCESSED_DOCUMENT или
FAILED_RESULT_READY в зависимости от статуса обработки. Более подробную информацию о
статусе обработки документа можно узнать из его квитанции.
568
История изменений
Дата
Версия
Описание изменений
изменений
19.06.2025
4.69.0
•
В таблице "Структура данных EsklpFilter" метода "Фильтрация по
реестру ЕСКЛП" изменено описание параметра "REG_STATUS" со
"Статус действия регистрационного удостоверения" на "Статус кода
ЕСКЛП (Drug Code)";
•
В таблице "Доступные поля выгрузки" раздела "Выгрузка из
реестра серий" параметр "7vzn" и описание "7ВЗН" изменены на
"vzn" и "ВЗН" соответственно
17.06.2025
4.68.0
•
В методы "Создание задачи" и "Получение результата задачи"
добавлен тип задачи "allow_mode_violations" ("Выгрузка списка
нарушений при продаже товара без проверки КМ");
•
В таблицы "Список типов задач на получение аналитических
данных (TaskType)" и "Список типов задач для фильтрации
аналитических данных (TaskType)" добавлен тип задачи
"allow_mode_violations" ("Выгрузка списка нарушений при продаже
товара без проверки КМ")
09.06.2025
4.68.0
•
В таблицу "Типы эмиссии" добавлено новое значение параметра
"emission_type" - "Взаимное признание";
•
Новое значение "Взаимное признание" для параметра
"emission_type" поддержано в выгрузках: Выгрузка общедоступной
информации по SGTIN, Выгрузка из реестра серий и Выгрузка
общедоступной информации по SGTIN из архива;
•
В таблицу "Типы исходящих документов для параметра doc_type"
добавлено новое значение типа исходящих документов - "Ввоз ЛП
в рамках взаимного признания"
25.04.2025
4.68.0
•
Добавлены методы "Метод получения информации по операциям
для существующего SSCC" и "Метод получения информации по
операциям для архивного SSCC";
•
В раздел "Доступ к методам интерфейса «ИС "Маркировка".
МДЛП»" добавлена информация об использовании завершающих
слешей (trailing slash) в конце URL методов;
•
В разделе "Получение результата задачи" обновлена информация
для типов задач "md_sgtins" и "batches_registry";
•
Для метода "Подтверждение верификации на конкретную дату"
добавлена выходная информация, которая содержит параметры:
"success" ("Статус верификации") и "message" ("Информационное
сообщение");
•
В разделе "Общие требования по использованию методов" для
метода "Метод поиска по реестрам КИЗ всех записей со статусом
'Оборот приостановлен'" увеличен интервал между вызовами;
•
Для типа задания "Выгрузка остатков SGTIN на МД" увеличен
лимит на выгрузку, а также добавлена информация о времени
предоставления выгрузки
569
Дата
Версия
Описание изменений
изменений
25.03.2025
4.67.0
•
В методы "Создание задачи" и "Получение результата задачи"
добавлен тип задачи "md_sgtins" ("Выгрузка остатков SGTIN на
МД");
•
В таблицу "Список прав пользователей учетной системы
(RightsEnum)"
добавлено
право
"BRANCH_REMAINS_VERIFICATION"
("Верификация остатков
МД");
•
В таблицы "Список типов задач на получение аналитических
данных (TaskType)" и "Список типов задач для фильтрации
аналитических данных (TaskType)" добавлен тип задачи "md_sgtins"
("Выгрузка остатков SGTIN на МД");
•
Добавлен метод "Подтверждение верификации на конкретную дату"
11.03.2025
4.67.0
•
Для типа задания VIRTUAL_WAREHOUSE_REPORT
("Мой
виртуальный склад (новый)") добавлено поле выгрузки "ЛП в
карантине";
•
Для типа задания GENERAL_REPORT_ON_REMAINING_ITEMS
("Общий отчёт по остаткам ЛП") добавлено поле выгрузки
"Отгружено";
•
В методах "Метод для получения информации из реестра
производимых
организацией
ЛП"
(POST
api/v1/reestr/med_products/current), "Метод для поиска публичной
информации
в
реестре
производимых
ЛП"
(POST
api/v1/reestr/med_products/public/filter)
скорректирована
координальность выходного параметра "is_pku"
("Признак
"Предметно-количественного учета" (ПКУ)")
570
Дата
Версия
Описание изменений
изменений
29.01.2025
4.66.0
•
Из раздела "Список прав пользователей учетной системы
(RightsEnum)" удалено описание прав, устаревших 2021-05-05;
•
Для типа задания GENERAL_REPORT_ON_DISPOSAL ("Общий
отчёт по выбытию ЛП") добавлено поле выгрузки "Тип экспорта";
•
Выходной параметр "manufacturer" ("Производитель, указанный на
упаковке лекарственного препарата") добавлен в методы:
◦ "Метод для получения детальной информации о производимом
организацией ЛП" (GET api/v1/reestr/med_products/{gtin});
◦ "Метод для получения информации из реестра производимых
организацией ЛП" (POST api/v1/reestr/med_products/current).
•
В разделе "Формат объекта SgtinExtended" параметр "is_pku"
("Признак "Предметно-количественного учета" (ПКУ)") отмечен
как устаревший;
•
В разделе "Формат объекта SGTIN" параметры "vzn_drug"
("Признак, отображающий, относится ли ЛП к списку 7ВЗН"),
"gnvlp" ("Признак наличия в ЖНВЛП"), "is_narcotic" ("Признак,
является ли ЛП наркотическим или психотропным") отмечены как
устаревшие;
•
В выгрузках "Выгрузка общедоступной информации по SGTIN",
"Выгрузка общедоступной информации по SGTIN из архива"
параметры "vzn_drug" ("Признак, отображающий, относится ли ЛП
к списку 7ВЗН"), "gnvlp" ("Признак наличия в ЖНВЛП") отмечены
как устаревшие;
•
Выходной
параметр
"is_pku"
("Признак
"Предметно-
количественного учета" (ПКУ)") добавлен в методы:
◦ "Метод для получения детальной информации о производимом
организацией ЛП" (GET api/v1/reestr/med_products/{gtin});
◦ "Метод для получения публичной информации о производимом
ЛП" (GET api/v1/reestr/med_products/public/{gtin})
19.11.2024
4.65.0
•
Добавлен метод "Метод проверки доверенных контрагентов";
•
В разделе "Общие требования по использованию методов" таблица
с интервалами между вызовами методов API пополнена методом
проверки доверенных контрагентов;
•
В разделе "Список прав и методов, доступных пользователям с
обезличенной УКЭП" актуализированы доступные методы для
права "VIEW_TRUSTED_PARTNERS"
("Просмотр доверенных
контрагентов")
571
Дата
Версия
Описание изменений
изменений
09.10.2024
4.64.0
•
Выгрузка отчёта "Мой виртуальный склад" помечена как
устаревшая;
•
Тип задачи "REMAINING_MEDICINES_BRANCHES" ("Выгрузка
отчёта "Мой виртуальный склад") объявлен устаревшим;
•
Право "VIEW_BALANCE_ON_BP_REPORT" ("Мой виртуальный
склад") объявлено устаревшим;
•
В раздел "Аналитические данные по отчётам":
◦ для типов заданий GENERAL_REPORT_ON_DISPOSAL
("Общий
отчёт
по
выбытию
ЛП"),
GENERAL_REPORT_ON_REMAINING_ITEM ("Общий отчёт
по остаткам ЛП"), GENERAL_REPORT_ON_MOVEMENT
("Общий
отчёт
по
движению
ЛП"),
GENERAL_PRICING_REPORT
("Общий отчёт по ценам")
добавлено поле выгрузки "Дата обновления данных";
◦ для типа задания GENERAL_REPORT_ON_REMAINING_ITEM
("Общий отчёт по остаткам ЛП") добавлено поле выгрузки
"Остатки на рынке без учета 705, уп".
•
Выходной параметр "object _type" ("Тип объекта") добавлен в:
◦ "Получение информации о лицензиях на фарм. деятельность";
◦ "Метод фильтрации лицензий на фарм. деятельность";
◦ "Метод для поиска информации о местах осуществления
деятельности по фильтру".
•
Удалено описание устаревших выгрузок:
◦ "Выгрузка отчёта по движению ЛП, введённых в оборот";
◦ "Выгрузка отчёта по ценам";
◦ "Выгрузка отчёта по выбытию ЛП";
◦ "Выгрузка отчёта по остаткам ЛП"
572
Дата
Версия
Описание изменений
изменений
29.08.2024
4.63.0
•
В разделе "Мой виртуальный склад (новый)":
◦ удалён параметр фильтрации "0611_IC_Agg_MDLP_shipped"
("Учесть отгруженные ЛП");
◦ добавлены поля выгрузки "Количество упаковок по 705 схеме" и
"Дата обновления информации".
•
Выходные параметры "vzn_drug"
("Признак, отображающий,
относится ли ЛП к списку 7ВЗН"), "gnvlp" ("Признак наличия в
ЖНВЛП"), "is_narcotic" ("Признак, является ли ЛП наркотическим
или
психотропным"),
"is_pku"
("Признак
"Предметно-
количественного учета" (ПКУ)") помечены устаревшими в методах:
◦ "Метод поиска по реестрам КИЗ";
◦ "Метод поиска по реестрам КИЗ по списку значений";
◦ "Метод для получения из реестров КИЗ детальной информации
о КИЗ и связанным с ним ЛП";
◦ "Метод для получения детальной информации о КИЗ в
архивном хранилище и связанным с ним ЛП";
◦ "Метод поиска по реестрам КИЗ всех записей со статусом
'Оборот приостановлен'".
•
Входной параметр "is_narcotic"
("Признак, является ли ЛП
наркотическим или психотропным") добавлен в методах:
◦ "Метод для получения информации из реестра производимых
организацией ЛП";
◦ "Метод для поиска публичной информации в реестре
производимых ЛП".
•
В выходных параметрах "is_narcotic" ("Признак, является ли ЛП
наркотическим или психотропным"), "is_pku"
("Признак
"Предметно-количественного учета" (ПКУ)") в результате всегда
будет возвращаться "false" в методах:
◦ "Метод поиска по реестрам КИЗ";
◦ "Метод поиска по реестрам КИЗ по списку значений";
◦ "Метод для получения из реестров КИЗ детальной информации
о КИЗ и связанным с ним ЛП";
◦ "Метод для получения детальной информации о КИЗ в
архивном хранилище и связанным с ним ЛП";
◦ "Метод поиска по реестрам КИЗ всех записей со статусом
'Оборот приостановлен'".
573
Дата
Версия
Описание изменений
изменений
• Выходные параметры "prodDOkeiName"
("Название единицы
ОКЕИ для потребительской единицы лекарственного препарата") и
"massVolumeSize"
("Количество массы/объёма вещества в
первичной упаковке") добавлены в методах:
◦ "Метод для получения информации из реестра производимых
организацией ЛП";
◦ "Метод для получения детальной информации о производимом
организацией ЛП";
◦ "Метод для поиска публичной информации в реестре
производимых ЛП";
◦ "Метод для получения публичной информации о производимом
ЛП"
16.07.2024
4.62.0
• Добавлен метод "Метод по получению информации о SSCC для
принятия решения о принятии на баланс";
• В разделе "Мой виртуальный склад (новый)" фильтр
"0611_IC_Agg_MDLP_shipped"
("Учесть отгруженные ЛП")
объявлен устаревшим с версии 4.63.0
03.06.2024
4.61.0
В разделе "Общие требования по использованию методов" для метода
"Метод для актуализации данных текущего участника из реестра
лицензий на фарм. деятельность" (POST //reestr/pharm_licenses/resync)
скорректирован интервал между вызовами
08.04.2024
4.60.0
• в разделе "Метод передачи контейнера на модерацию"
скорректирована выходная информация и добавлено примечание о
необходимости использования Header: Accept-Language;
• в разделах "Общий отчёт по ценам", "Общий отчёт по выбытию
ЛП"
скорректировано
описание
параметра
"0616_IC_Operation_MDLP_period_all"
("Получить данные за
последние недели")
22.02.2024
4.59.0
• в методе "Запуск обработки группы документов" к входному
параметру "document_ids"
("Идентификаторы документов")
добавлено примечание о максимальном количестве его значений;
• в разделе "Выгрузка из реестра серий" для поля выгрузки
"status_from_rzn"
("Статус от РЗН") добавлены возможные
значения;
• в разделе "Общий отчёт по ценам" добавлен параметр фильтрации
"1158_IC_Agg_115_type_realiz" ("Тип агрегации")
02.02.2024
4.58.0
В разделе "Отправка документа" указано, что максимальный размер
загружаемого файла - 2 Мб
574
Дата
Версия
Описание изменений
изменений
25.01.2024
4.58.0
• добавлен
параметр
"is_pku"
("Признак
"Предметно-
количественного учета" (ПКУ)") в разделы:
◦ "Формат объекта SgtinExtended";
◦ "Формат объекта MedProductsFilter";
◦ "Метод поиска по реестрам КИЗ по списку значений";
◦ "Метод для получения информации из реестра производимых
организацией ЛП";
◦ "Метод для поиска публичной информации в реестре
производимых ЛП".
• добавлен раздел "Список прав и методов, доступных пользователям
с обезличенной УКЭП"
10.01.2024
4.57.0
В раздел "Аналитические данные по отчётам" добавлены:
• параметры фильтрации:
◦ "0312_IC_Source_type"
("Источник финансирования") - для
типов заданий GENERAL_PRICING_REPORT ("Общий отчёт
по ценам"), GENERAL_REPORT_ON_DISPOSAL
("Общий
отчёт
по
выбытию
ЛП"),
GENERAL_REPORT_ON_MOVEMENT
("Общий отчёт по
движению ЛП"), GENERAL_REPORT_ON_REMAINING_ITEM
("Общий отчёт по остаткам ЛП");
◦ "1031_IC_Period_Week_all" ("Неделя (включая две последние
недели)") - для типов заданий GENERAL_PRICING_REPORT
("Общий
отчёт
по
ценам"),
GENERAL_REPORT_ON_DISPOSAL
("Общий отчёт по
выбытию ЛП");
◦ "0616_IC_Operation_MDLP_period_all"
("Получить данные за
последние
две
недели") - для
типов
заданий
GENERAL_PRICING_REPORT
("Общий отчёт по ценам"),
GENERAL_REPORT_ON_DISPOSAL
("Общий отчёт по
выбытию ЛП").
• поле выгрузки "Источник финансирования" - для типов заданий
GENERAL_PRICING_REPORT
("Общий отчёт по ценам"),
GENERAL_REPORT_ON_DISPOSAL ("Общий отчёт по выбытию
ЛП"), GENERAL_REPORT_ON_MOVEMENT ("Общий отчёт по
движению ЛП"), GENERAL_REPORT_ON_REMAINING_ITEM
("Общий отчёт по остаткам ЛП")
575
Дата
Версия
Описание изменений
изменений
23.11.2023
4.57.0
•
в разделах "Формат объекта LicenseEntry" и "Формат объекта
LicenseApiFilter" добавлены возможные значения параметра
"l_status" ("Статус лицензии");
•
в выходную информацию методов "Получение информации о
лицензиях на производство" и "Получение информации о
лицензиях на фарм. деятельность" добавлены возможные значения
параметра "L_STATUS" ("Статус лицензии");
•
в таблицу "Список прав пользователей учетной системы
(RightsEnum)"
добавлено
новое
право - VIRTUAL_WAREHOUSE_REPORT
("Доступ к отчёту
"Мой виртуальный склад (новый)");
•
в таблицу "Список типов заданий на получение аналитических
данных
по
отчётам"
добавлен
новый
тип
задания - VIRTUAL_WAREHOUSE_REPORT ("Мой виртуальный
склад (новый)");
•
в раздел "Аналитические данные по отчётам" добавлено описание
параметров фильтрации и доступных полей выгрузки для типа
задания - VIRTUAL_WAREHOUSE_REPORT ("Мой виртуальный
склад (новый)");
•
в разделе "Метод передачи контейнера на модерацию" в пример
запроса метода добавлен заголовок Accept-Language
10.10.2023
4.56.0
•
в разделе "Установка защищенного соединения к API по TLS
(HTTPS)" обновлены протоколы, которые можно использовать для
соединения;
•
в раздел "Загрузка документов" добавлено описание метода
"Скачивание документа по идентификатору";
•
в разделах "Метод для получения информации из реестра
производимых организацией ЛП", "Метод для получения детальной
информации о производимом организацией ЛП", "Метод для
поиска публичной информации в реестре производимых ЛП" и
"Метод для получения публичной информации о производимом
ЛП" в выходную информацию добавлено описание параметра
"prod_pack_1_desc" ("Описание первичной упаковки ЛП");
•
в разделе "Метод фильтрации по субъектам обращения" в выходной
информации скорректировано описание параметра "entity_type"
("Тип участника");
•
в разделе "Работа с инструкциями и изображениями упаковок
лекарственных препаратов" добавлено примечание о том, какие
контейнеры можно редактировать;
•
в разделе "Требования к инструкции в JSON" дополнено описание
структуры инструкции в формате * .json
576
Дата
Версия
Описание изменений
изменений
17.08.2023
4.55.0
•
добавлен раздел "Работа с инструкциями и изображениями
упаковок лекарственных препаратов";
•
в разделе "Формат объекта MedProductsFilter" добавлено описание
параметра "extended" ("Расширенный выходной формат");
•
в разделах "Метод для получения информации из реестра
производимых организацией ЛП" и "Метод для получения
детальной информации о производимом организацией ЛП" в
выходную информацию добавлено описание параметров:
◦ "container_id" ("Идентификатор контейнера");
◦ "autopropagate"
("Признак автоматической установки связи
между контейнером и сериями").
•
в раздел "Выгрузка из реестра серий" добавлено описание нового
поля, доступного для выгрузки: "container_id" ("Идентификатор
контейнера");
•
добавлен раздел "Список типов задач для фильтрации
аналитических данных (TaskType)";
•
в методе "Просмотр списка задач пользователя" для параметра
метода "task_type" ("Тип задачи") скорректировано примечание;
•
в разделе "Типы выбытия" скорректировано описание для значения
"7" - "Агентская продажа, в том числе дистанционная торговля";
•
в разделе "Выгрузка отчёта по выбытию ЛП (Устарел)" в
параметре фильтрации "exit_type"
("Тип вывода из оборота")
скорректировано описание значения "7"
05.07.2023
4.54.0
•
в рамках релиза 4.54.0 изменений не было
05.07.2023
4.53.0
•
в разделе "Формат объекта SGTIN" для параметра "prod_name"
описание реквизита изменено на "Международное непатентованное
наименование (стандартизованное значение)"
577
Дата
Версия
Описание изменений
изменений
18.05.2023
4.53.0
•
в разделе "Общие требования по использованию методов"
скорректирована информация по лимитам, к наименованиям
методов добавлены url;
•
добавлен раздел "Метод для редактирования параметров МД для
аптек";
•
в разделах "Метод для получения публичной информации о
производимом ЛП" и "Метод для получения детальной информации
о производимом организацией ЛП" в выходную информацию
добавлено описание параметров:
◦ "reg_status" ("Статус рег. Удостоверения");
◦ "type_form" ("Лекарственная форма");
◦ "gnvlp" ("Признак наличия в списке ЖНВЛП");
◦ "vzn_drug"
("Признак, отображающий, относится ли ЛП к
списку 7ВЗН");
◦ "prod_desc" ("Наименование товара на этикетке");
◦ "is_narcotic" ("Признак, является ли ЛП наркотическим или
психотропным");
•
в разделе "Получение событий, связанных с выбытием КИЗ":
◦ добавлен раздел "Общие правила работы";
◦ скорректировано описание типов событий вывода из оборота
(WithdrawalEventType) в разделе "Список доступных типов
событий вывода из оборота (WithdrawalEventType)"
03.05.2023
4.52.0
•
в разделе "Общий отчёт по движению ЛП" параметр
"1028_IC_Period_Week"
("Неделя")
заменён
на
"1029_IC_Period_Week_now" ("Неделя")
29.03.2023
4.52.0
•
в разделе "Общие требования по использованию методов"
актуализирован интервал между вызовами метода "Метод поиска по
общедоступному реестру КИЗ в архивном хранилище по списку
значений" (/reestr/sgtin/public/archive/sgtins-by-list)
13.03.2023
4.52.0
•
в рамках релиза 4.52.0 изменений не было
01.03.2023
4.51.0
•
в раздел "Метод для поиска информации о местах осуществления
деятельности по фильтру" добавлено описание новых входных и
выходных параметров
03.02.2023
4.51.0
•
в разделе "Аналитические данные по отчётам" скорректировано
описание параметров фильтрации "1028_IC_Period_Week"
("Неделя") и "1027_IC_Period_Month_11_2019" ("Месяц")
31.01.2023
4.51.0
•
в разделе "Ограничения на форматы полей данных"
скорректировано описание для ограничения "DateTime"
578
Дата
Версия
Описание изменений
изменений
24.01.2023
4.51.0
•
во входные и выходные параметры метода "Фильтрация по реестру
решений о вводе лекарственных препаратов в гражданский оборот"
добавлены:
◦ "prod_sell_name" ("Торговое наименование");
◦ "reg_num" ("Номер регистрационного удостоверения")
•
добавлено описание методов:
◦ "Фильтрация по реестру деклараций (импортные ЛП)";
◦ "Фильтрация по реестру партий, ввозимых из ЕАЭС".
•
в таблицу "Формат объекта GroupedUser" добавлены параметры
"inn_ind"
("ИНН физического лица") и "poa_number"
("Номер
доверенности")
•
в разделе "Выгрузка из реестра серий" добавлен новый параметр
фильтрации "product_sell_name" ("Торговое наименование");
•
в разделе "Метод получения выгрузки" скорректирован пример
запроса метода
30.12.2022
4.50.0
•
в следующих методах скорректированы примеры использования:
◦ "Метод создания нового задания на выгрузку";
◦ "Метод получения статуса задания на выгрузку";
◦ "Метод получения статусов заданий на выгрузку";
◦ "Метод получения результирующих идентификаторов выгрузок
данных";
◦ "Метод получения выгрузки";
◦ "Метод удаления файла выгрузки"
579
Дата
Версия
Описание изменений
изменений
20.12.2022
4.50.0
•
в таблицу "Список прав пользователей учетной системы
(RightsEnum)" добавлены новые права:
◦ GENERAL_PRICING_REPORT ("Доступ к общему отчету по
ценам");
◦ GENERAL_REPORT_ON_MOVEMENT
("Доступ к общему
отчету по движению ЛП");
◦ GENERAL_REPORT_ON_REMAINING_ITEMS
("Доступ к
общему отчету по остаткам ЛП");
◦ GENERAL_REPORT_ON_DISPOSAL ("Доступ к общему отчету
по выбытию ЛП").
•
добавлен раздел "Аналитические данные по отчётам" с описанием
новых методов:
◦ "Метод создания нового задания на выгрузку";
◦ "Метод получения статуса задания на выгрузку";
◦ "Метод получения статусов заданий на выгрузку";
◦ "Метод получения результирующих идентификаторов выгрузок
данных";
◦ "Метод получения выгрузки";
◦ "Метод удаления файла выгрузки".
•
объявлены
устаревшими
права
VIEW_BATCH_REPORT
("Просмотр отчётов по ЛП") и VIEW_PRICING_REPORT
("Просмотр отчёта по ценам");
•
объявлены устаревшими следующие типы задач на получение
аналитических данных:
◦ remaining_medicines ("Выгрузка отчёта по остаткам ЛП");
◦ medicine_disposal ("Выгрузка отчёта по выбытию ЛП");
◦ pricing_report ("Выгрузка отчёта по ценам");
◦ lp_movement_circulation ("Выгрузка отчёта по движению ЛП,
введённых в оборот");
◦ import_movement
("Выгрузка
отчёта
по
остаткам
импортированных ЛП до ввода в ГО").
•
в разделе "Метод для получения информации о регистрации в
организации для текущего пользователя" для выходного параметра
"kpp" ("КПП") объекта Member скорректирована кардинальность
580
Дата
Версия
Описание изменений
изменений
29.11.2022
4.50.0
•
в разделе "Ограничения на форматы полей данных"
скорректировано выражение для параметра "ACTION_ID";
•
в таблице "Формат объекта SGTIN" для параметра "source_type"
("Источник финансирования") расширен диапазон значений;
•
добавлены разделы "Типы входящих документов для параметра
doc_type" и "Типы исходящих документов для параметра doc_type";
•
удалён раздел "Примеры авторизации на тестовых участниках";
•
в метод "Получение перечня мест осуществления деятельности в
системе" во входную и выходную информацию добавлены
параметры:
◦ "has_pharm_license"
("Лицензия
на
фармацевтическую
деятельность");
◦ "has_prod_license"
("Лицензия
на
производственную
деятельность");
◦ "has_med_license" ("Лицензия на медицинскую деятельность");
◦ "has_narcotic_license" ("Лицензия на деятельность по обороту
наркотических средств, психотропных веществ и их
прекурсоров, культивированию наркосодержащих растений")
21.10.2022
4.49.0
•
в разделе "Примеры авторизации на тестовых участниках" удалена
информация, что для работы в API необходимо зарегистрировать
своих пользователей, используя тестовых пользователей,
приведённых в этом разделе
20.10.2022
4.49.0
•
добавлены разделы "Список типов задач на получение
аналитических данных (TaskType)", "Список статусов обработки
задачи на получение аналитических данных (TaskStatus)" и "Формат
объекта Task";
•
в таблицу "Список типов задач на получение аналитических
данных (TaskType)" добавлен тип задачи "sgtins_by_doc_id"
(Выгрузка списка успешно обработанных SGTIN по id исходного
XML-документа)
12.10.2022
4.49.0
•
добавлены разделы "Получение аналитических данных" и
"Получение событий, связанных с выбытием КИЗ";
•
в методы "Создание задачи" и "Получение результата задачи"
добавлена информация о поддержке нового task_type
-
"SGTINS_BY_DOC_ID" ("позволяет выгрузить список успешно
обработанных SGTIN, по id исходного XML-документа")
581
Дата
Версия
Описание изменений
изменений
10.10.2022
4.49.0
•
в разделе "Фильтрация по реестру регистраторов эмиссии" в
таблицы "Структура данных EmissionDeviceFilter" и "Формат
объекта EmissionDeviceInfoEntry" для параметра "status" ("Статус")
актуализирована информация о поддерживаемых статусах для
регистратора эмиссии;
•
в разделе "Фильтрация по реестру регистраторов выбытия" тип
данных для выходного параметра "status" ("Статус") изменен на
"Number";
•
метод "Фильтрация по реестру виртуального склада" (/reestr/virtual-
storage/filter)
удалён, право REESTR_VIRTUAL_STORAGE
удалено;
•
в разделе "Метод для поиска зарегистрированных пользователей по
фильтру"
(<endpoint>/<version>/users/filter) в таблицу "Формат
объекта UserFilter" добавлен параметр "user_id" ("Идентификатор
пользователя");
•
в метод "Фильтрация по субъектам обращения" в таблицу "Формат
объекта RegistrationEntry" добавлено примечание для параметра
"entity_type" ("Тип участника")
29.08.2022
4.48.0
•
метод "Фильтрация по реестру виртуального склада" (/reestr/virtual-
storage/filter) отмечен как устаревший и подлежащий удалению.
Вместо него рекомендуется использовать метод "Выгрузка отчёта
"Мой виртуальный склад"". Право REESTR_VIRTUAL_STORAGE
объявлено устаревшим;
•
в разделе "Выгрузка отчёта "Мой виртуальный склад"" в таблицу
"Доступные
поля
выгрузки"
добавлен
параметр
"cnt_not_on_my_balance"
("Количество SGTIN, которое было
отгружено отправителем");
•
во входные параметры метода "Создание задачи" (export/tasks/) типа
задачи "Выгрузка отчёта по ценам" (PRICING_REPORT) добавлен
параметр выгрузки "gtin"
("GTIN"), актуализирован пример
запроса;
•
в разделе "Выгрузка отчёта по выбытию ЛП" для типа задачи
"medicine_disposal" ("Выгрузка отчёта по выбытию ЛП") добавлено
значение параметра "exit_type" ("Тип вывода из оборота") "7 -
"Дистанционная продажа"";
•
в разделе "Выгрузка отчёта по ценам" скорректирован пример
запроса;
•
описание формата объекта "GroupFilter" перенесено в раздел
"Общие структуры данных, ограничения и коды завершения
операций"
19.08.2022
4.47.0
•
В разделе "Установка защищенного соединения к API по TLS
(HTTPS)" обновлены ссылки для продуктового контура, для
тестового контура "Песочница", для корневых и промежуточных
сертификатов
582
Дата
Версия
Описание изменений
изменений
25.07.2022
4.47.0
•
в разделе "Общие требования по использованию методов" в
таблицу "Интервал между вызовами методов API" добавлены
ограничения для "Метода добавления ЭП пользователя для самого
себя",
"Метода для получения информации о своих
зарегистрированных сертификатах пользователя", "Метода для
поиска списка собственных групп прав по фильтру", "Метода для
получения информации о вариантах собственных прав";
•
в таблице "Формат объекта SGTIN" добавлены параметры
"not_on_my_balance"
("Признак отсутствия препарата у
отправителя"), "is_narcotic" (Признак, является ли ЛП
наркотическим или психотропным);
•
в
разделе
"Метод
для
получения
информации
о
зарегистрированных сертификатах текущего
пользователя"
в
таблицу "Формат объекта UserCert" добавлены параметры
"create_date" ("Дата создания записи"), "author_full_name" ("ФИО
пользователя,
внесшего
изменения"),
"author_id"
("ИД
пользователя, внесшего изменения"), добавлена таблица "Формат
объекта UserCertsFilter";
•
в
разделе
"Метод
для
получения
информации
о
зарегистрированных сертификатах пользователя" добавлен
параметр входной информации "filter"
("Фильтрация по
параметрам");
•
добавлены разделы:
◦ "Метод добавления ЭП пользователя для самого себя";
◦ "Метод
для
получения
информации
о
своих
зарегистрированных сертификатах пользователя";
◦ "Метод для поиска списка собственных групп прав по фильтру";
◦ "Метод для получения информации о вариантах собственных
прав".
•
в разделе "Фильтрация по реестру ЕСКЛП" в таблицу "Структура
данных InfoEsklp" добавлен параметр "is_narcotic"
("Признак,
является ли ЛП наркотическим или психотропным"),
актуализирован пример ответа;
•
в разделе "Метод для поиска информации о местах осуществления
деятельности по фильтру" в таблицу "Структура данных
BranchFilter" добавлен параметр "phone_number"
("Номер
телефона"), в таблицу "Структура данных BranchEntry" добавлены
параметры "phone_number"
("Номер телефона"), "brand_name"
(Брендированное наименование), актуализирован пример запроса;
•
в разделе "Метод поиска по реестрам КИЗ", "Метод для получения
информации о КИЗ в третичной упаковке" актуализирован пример
ответа;
583
Дата
Версия
Описание изменений
изменений
•
в разделах "Метод поиска по реестрам КИЗ по списку" в таблицу
"Формат объекта OwnedSgtin", "Метод поиска по реестрам КИЗ по
списку значений" в таблицу "Формат объекта OwnedSgtin" добавлен
параметр is_narcotic (Признак, является ли ЛП наркотическим или
психотропным), актуализирован пример ответа;
•
в разделах "Метод для получения из реестров КИЗ детальной
информации о КИЗ и связанным с ним ЛП", "Метод для получения
детальной информации о КИЗ в архивном хранилище и связанным
с ним ЛП" актуализирован пример запроса;
•
в разделах "Метод для получения информации из реестра
производимых организацией ЛП" в таблицу "Формат объекта
MedProduct", "Метод для поиска публичной информации в реестре
производимых ЛП" в таблицу "Формат объекта MedProductPublic"
добавлены параметры "is_narcotic" ("Признак, является ли ЛП
наркотическим или психотропным"), "mass_volume_name"
("Наименование единиц измерения массы/объема в первичной
упаковке"), актуализированы примеры ответов;
•
в разделе "Метод для получения детальной информации о
производимом организацией ЛП" добавлены параметры выходной
информации "is_narcotic"
("Признак, является ли ЛП
наркотическим или психотропным"), "mass_volume_name"
("Наименование единиц измерения массы/объема в первичной
упаковке"), актуализирован пример ответа;
•
в разделе Выгрузка отчёта по ценам добавлено необходимое для
доступа к отчёту право "VIEW_PRICING_REPORT" ("Отчет по
ценам");
•
в разделе "Выгрузка отчёта по выбытию ЛП" актуализирована
кардинальность параметров "exit_date_start" ("Дата начала периода
выбытия"), "exit_date_end" ("Дата окончания периода выбытия")
17.06.2022
4.46.0
•
В разделе "Создание задачи" актуализировано ограничение для
организации по количеству задач
•
В разделах "Выгрузка отчёта по остаткам ЛП", "Выгрузка отчёта по
выбытию ЛП", "Выгрузка отчёта по остаткам импортированных ЛП
до ввода в ГО" в таблицы "Доступные поля выгрузки" добавлен
параметр "branch_id" ("Идентификатор МД")
•
В разделе "Выгрузка отчёта по движению ЛП, введённых в оборот"
в таблицу "Доступные поля выгрузки" добавлены параметры
"current_branch_id"
("Идентификатор
МД
отправителя"),
"next_branch_id" ("Идентификатор МД получателя")
•
В разделе "Выгрузка отчёта по выбытию ЛП" в таблицах
"Параметры фильтрации", "Доступные поля выгрузки" изменена
дата устаревания параметра "packing_inn" ("ИНН производителя")
на 2022-02-28
584
Дата
Версия
Описание изменений
изменений
07.06.2022
4.46.0
•
В разделе "Используемые обозначения" добавлена аббревиатура
"ГАР"
•
В таблице "Список прав пользователей учетной системы
(RightsEnum)" право "REESTR_FIAS"
("Реестр
ФИАС")
переименовано в ("Реестр ГАР/ФИАС")
•
В разделе "Список типов задач на получение аналитических
данных (TaskType)" добавлен новый тип задач "pricing_report"
("Выгрузка отчёта по ценам")
•
В таблице "Формат объекта Address" переименованы параметры
"aoguid" ("Уникальный идентификатор адресного объекта (ФИАС)")
в ("Уникальный идентификатор адресного объекта (ГАР/ФИАС)"),
houseguid
("Уникальный идентификатор дома (ФИАС)") в
("Уникальный идентификатор дома (ГАР/ФИАС)")
•
В таблице "Формат объекта LicenseEntry" переименован параметр
invalid_fias_code ("Признак невалидности кода ФИАС") в ("Признак
невалидности кода ГАР/ФИАС")
•
В таблице "Формат объекта Task" добавлено примечание для
параметра "reason" ("Причина ошибки")
•
В разделе "Метод для получения информации о существующих
правах" актуализирован пример ответа
•
Переименованы разделы:
◦ "Получение информации из реестра ФИАС" в "Получение
информации из реестра ГАР/ФИАС"
◦ "Получение текстового адреса по идентификаторам ФИАС" в
"Получение текстового адреса по идентификаторам ГАР/ФИАС"
•
В разделе "Получение текстового адреса по идентификаторам
ГАР/ФИАС" переименованы входных параметры "aoguid"
("Уникальный идентификатор адресного объекта (ФИАС)") в
("Уникальный идентификатор адресного объекта (ГАР/ФИАС)"),
houseguid
("Уникальный идентификатор дома (ФИАС)") в
("Уникальный идентификатор дома (ГАР/ФИАС)")
•
В разделе "Фильтрация по реестру ЕСКЛП" в таблице "Структура
данных InfoEsklp" переименованы параметры:
◦ "ADDRESS_FIAS (Устарел)" ("Адрес фасовщика/упаковщика во
вторичную/третичную упаковку (по ФИАС для резидентов
РФ)")
в
("Адрес
фасовщика/упаковщика
во
вторичную/третичную упаковку (по ГАР/ФИАС для резидентов
РФ)")
◦ "QA_ADDRESS_FIAS (Устарел)" ("Адрес стадии выпускающий
контроль качества (по ФИАС для резидентов РФ)") в ("Адрес
стадии выпускающий контроль качества (по ГАР/ФИАС для
резидентов РФ)")
585
Дата
Версия
Описание изменений
изменений
•
В разделе "Фильтрация по реестру" актуализирован пример ответа
•
В разделе "Метод фильтрации по субъектам обращения" в таблице
"Формат объекта ResolvedFiasAddress" переименован параметр
"address_fias" ("Адрес ФИАС") в ("Адрес ГАР/ФИАС"), в таблице
"Формат объекта AddressFias" переименованы параметры "aoguid"
("Уникальный идентификатор адресного объекта (ФИАС)") в
("Уникальный идентификатор адресного объекта (ГАР/ФИАС)"),
"houseguid" ("Адрес установки (код ФИАС") в ("Адрес установки
(код ГАР/ФИАС"), в таблице "Формат объекта AddressResolved"
актуализировано примечание для параметра "code"
("Код
выполнения операции")
•
В разделе "Фильтрация по реестру регистраторов эмиссии" в
таблице "Формат объекта EmissionDeviceInfoEntry" переименован
параметр "houseguid" ("Адрес установки (код ФИАС)") в ("Адрес
установки (код ГАР/ФИАС)")
•
В разделе "Фильтрация по реестру решений о приостановке КИЗ" в
таблице "Формат объекта PausedCirculationDecision" переименован
параметр "owner_address (Устарел)" ("Адрес места деятельности
(ФИАС)") в ("Адрес места деятельности (ГАР/ФИАС)")
•
В разделе "Выгрузка детализированной информации по движению
ЛП (временно приостановлен)" в таблице "Формат элемента
массива items" переименован параметр "address_houseguid" ("Адрес
ФИАС") в ("Адрес ГАР/ФИАС"), актуализировано примечание
•
В разделе "Выгрузка из реестра серий" в таблице "Доступные поля
выгрузки" параметр "sent_to_rzn" ("Отправлено в РЗН") отмечен
как устаревший
•
В разделе "Метод для поиска по реестру КИЗ записей для вывода из
оборота по чеку от контрольно-кассовой техники (ККТ)" в таблицу
"Структура данных SgtinKktAwaitingWithdrawalFilter" добавлен
входной параметр "has_violations"
("Наличие нарушений"),
актуализирован пример запроса
•
Добавлен раздел "Выгрузка отчёта по ценам"
586
Дата
Версия
Описание изменений
изменений
16.05.2022
4.45.1
•
В разделе "Фильтрация по реестру регистраторов выбытия" в
таблицах "Формат объекта WithdrawalDeviceFilter", "Формат
объекта WithdrawalDeviceInfoEntry" актуализированы тип данных,
ограничения и примечания для параметра "status"
("Статус"),
добавлены параметры "activation_start_date" ("Начало временного
диапазона для даты активации РВ"), "activation_end_date" ("Конец
временного
диапазона
для
даты
активации
РВ"),
"update_responsible_start_date" ("Начало временного диапазона для
даты
обновления
контакта,
ответственного
за
РВ"),
"update_responsible_end_date" ("Конец временного диапазона для
даты обновления контакта, ответственного за РВ"), в таблицу
"Формат объекта WithdrawalDeviceInfoEntry" добавлены параметры
"activation_date"
("Дата
активации
РВ"),
"responsible_person_contacts"
("Контакты
сотрудника,
ответственного за получение РВ и его эксплуатацию"),
"update_responsible_date"
("Дата
обновления
контакта,
ответственного за РВ"), "branch_house_guid" ("Код ФИАС МД"),
"branch_address" ("Адрес МД"), актуализирован пример ответа
29.04.2022
4.45.1
•
Изменена версия на 4.45.1 в соответствии с версией ФГИС МДЛП
24.04.2022
4.45.0
•
В разделе "Общие требования по использованию методов" в
таблице "Интервал между вызовами методов API" актуализировано
ограничение для метода "Создание задачи"
•
В разделе "Фильтрация по реестру регистраторов выбытия" в
таблице "Формат объекта WithdrawalDeviceInfoEntry" удалены
параметры
"activation_date"
("Дата
активации
РВ"),
"responsible_person_contacts"
("Контакты
сотрудника,
ответственного за получение РВ и его эксплуатацию"),
"update_responsible_date"
("Дата
обновления
контакта,
ответственного за РВ"), "branch_house_guid"
("Код ГАР/ФИАС
МД"), "branch_address"
("Адрес МД"), актуализирован пример
ответа (будет добавлено в 4.45.1)
•
В разделе "Создание задачи" добавлено ограничение для
организации по количеству задач
•
В разделе "Просмотр списка установленных ограничений на
количество задач" изменён тип данных параметра выходной
информации "max_task_count_per_user" ("Ограничение, количества
задач на пользователя"), добавлен параметр выходной информации
"max_task_count_per_member" (Ограничение количества задач на
организацию), актуализирован пример ответа
•
В разделе "Список возможных кодов ошибок" добавлен
"MEMBER_TASKS_LIMIT_EXCEEDED" ("Достигнут лимит задач
на организацию"), "TASKS_LIMIT_EXCEEDED"
("Достигнут
лимит задач") переименован в "USER_TASKS_LIMIT_EXCEEDED"
("Достигнут лимит задач на пользователя")
587
Дата
Версия
Описание изменений
изменений
14.04.2022
4.45.0
•
В разделе "Фильтрация по реестру ЕСКЛП" в таблицу "Структура
данных EsklpFilter" добавлен параметр "drug_codes"
("Список
внутренних
уникальных
идентификаторов
лекарственных
препаратов в реестре ЕСКЛП")
•
В разделе "Фильтрация по реестру регистраторов выбытия" в
таблицу "Формат объекта WithdrawalDeviceInfoEntry" добавлены
параметры
"activation_date"
("Дата
активации
РВ"),
"responsible_person_contacts"
("Контакты
сотрудника,
ответственного за получение РВ и его эксплуатацию"),
"update_responsible_date"
("Дата
обновления
контакта,
ответственного за РВ"), "branch_house_guid"
("Код ГАР/ФИАС
МД"), "branch_address"
("Адрес МД"), актуализирован пример
ответа
•
В разделе "Выгрузка отчёта по выбытию ЛП" в таблице
"Параметры фильтрации" изменены ограничение и примечание для
параметра "exit_type" ("Тип вывода из оборота")
28.02.2022
4.44.0
•
В таблице "Список типов задач на получение аналитических
данных (TaskType)" тип задачи "remaining_medicines_branches"
("Выгрузка отчёта по остаткам на МД/МОХ") переименован в "Мой
виртуальный склад"
•
В таблицу "Формат объекта SGTIN" добавлен параметр "verified"
("Признак прохождения кодом проверки на СЭ")
•
В таблицу "Формат объекта SgtinExtended" добавлен параметр
"verified"
("Признак прохождения кодом криптографической
проверки")
•
В таблице "Формат объекта PublicSgtin" изменена кардинальность
параметра "via_device" ("Способ выбытия")
•
В таблицу "Способы выбытия" добавлены "ККТ" и "РВ"
•
Для метода "Отмена задачи" актуализирован пример ответа
•
Для метода "Удаление задачи" актуализирован пример ответа
•
В разделе "Выгрузка отчёта по выбытию ЛП" в таблицу
"Параметры фильтрации" добавлен параметр "emitent_inn" (ИНН
производителя), параметр "packing_inn (Устарел)"
("ИНН
производителя"), в таблицу "Доступные поля выгрузки" добавлен
параметр "emitent_inn" (ИНН производителя), параметр
"packing_inn (Устарел)"
("ИНН производителя") отмечен как
устаревший
•
"Выгрузка отчёта по остаткам на МД/МОХ" переименована в "Мой
виртуальный склад"
•
В разделе "Выгрузка общедоступной информации по SGTIN из
архива" в таблице "Структура объекта PublicSgtinsArchive"
изменена кардинальность параметра "via_device"
("Способ
выбытия")
588
Дата
Версия
Описание изменений
изменений
10.02.2022
4.43.0
• В таблицу "Интервал между вызовами методов API" раздела
"Общие требования по использованию методов" добавлены
ограничения для "Метод валидации кода маркировки", "Метод
верификации кода маркировки и криптохвоста"
• В таблице "Список прав пользователей учетной системы
(RightsEnum)" добавлено новое право "SGTINS_VERIFICATION"
(Верификация кода маркировки с криптохвостом)
• Добавлен "Метод верификации кода маркировки и криптохвоста"
589
Дата
Версия
Описание изменений
изменений
12.01.2022
4.43.0
•
В таблице "Список типов задач на получение аналитических
данных
(TaskType)"
добавлен
новый
тип
задач
"public_sgtins_archive" (Выгрузка общедоступной информации по
SGTIN из архива)
•
В таблицу "Формат объекта SgtinExtended" добавлен параметр
"marketplace" (ИНН организаций, осуществивших продажу
(дистанционные площадки)), параметр "marketplace_inn (Устарел)"
(ИНН организации, осуществившей продажу (дистанционной
площадки)) отмечен как устаревший
•
Параметр "prod_pack1_ed_name (Устарел)" (Количество (мера, ед.
измерения) массы/объема в первичной упаковке) отмечен как
устаревший. Вместо него необходимо ориентироваться на параметр
"prod_pack_1_2"
(Количество
первичной
упаковки
в
потребительской упаковке):
◦ В таблице "Формат объекта GtinInfo"
◦ "Метод для получения информации из реестра производимых
организацией ЛП" в таблице "Формат объекта MedProduct"
◦ "Метод для получения детальной информации о производимом
организацией ЛП"
◦ "Метод для поиска публичной информации в реестре
производимых
ЛП"
в
таблице
"Формат
объекта
MedProductPublic"
◦ "Метод для получения публичной информации о производимом
ЛП"
•
Параметр "prod_pack_1_ed (Устарел)" (Количество массы/объема в
первичной упаковке) отмечен как устаревший. Вместо него
необходимо ориентироваться на параметр "prod_pack_1_size"
(Масса/объем в первичной упаковке):
◦ В таблице "Формат объекта GtinInfo"
◦ "Фильтрация по реестру ЕСКЛП" в таблице "Структура данных
InfoEsklp"
◦ "Метод для получения информации из реестра производимых
организацией ЛП" в таблице "Формат объекта MedProduct"
◦ "Метод для поиска публичной информации в реестре
производимых
ЛП"
в
таблице
"Формат
объекта
MedProductPublic"
◦ "Метод для получения публичной информации о производимом
ЛП"
◦ "Метод для получения детальной информации о производимом
организацией ЛП"
590
Дата
Версия
Описание изменений
изменений
•
Добавлен "Формат объекта SgtinMarketplaceInformation"
•
В разделе "Метод поиска по реестрам КИЗ" добавлено описание,
актуализирован пример ответа
•
Актуализирован пример ответа в методах:
◦ "Метод поиска по реестрам КИЗ по списку значений"
◦ "Метод для получения из реестров КИЗ детальной информации
о КИЗ и связанным с ним ЛП"
◦ "Метод для получения детальной информации о КИЗ в
архивном хранилище и связанным с ним ЛП"
•
В разделе "Метод поиска по реестрам КИЗ всех записей со статусом
'Оборот приостановлен'" добавлено описание, параметр "inn
(Устарел)" (ИНН владельца) отмечен как устаревший
•
В разделе "Получение результата задачи" актуализирован тип
задачи
•
Добавлена "Выгрузка общедоступной информации по SGTIN из
архива"
•
В разделах "Выгрузка отчёта по остаткам ЛП", "Выгрузка отчёта по
выбытию ЛП" в таблицу "Доступные поля выгрузки" добавлен
параметр "exp_date" (Срок годности)
•
В разделе "Выгрузка отчёта по остаткам на МД/МОХ" в таблицу
"Доступные поля выгрузки" добавлены параметры "exp_date" (Срок
годности), "batch" (Серия)
24.11.2021
4.42.0
•
В разделе "Выгрузка отчёта по движению ЛП, введённых в оборот"
в
таблице
"Доступные
поля
выгрузки"
удалены
next_sgtin_state_number
(Номер
следующей
операции),
sgtin_state_op_date (Дата следующей операции)
591
Дата
Версия
Описание изменений
изменений
09.11.2021
4.42.0
•
Добавлены "Метод активации и блокирования МД", "Метод
активации и блокирования МОХ", "Выгрузка информации о
количестве SGTIN и их сериях в SSCC", "Выгрузка отчёта по
движению ЛП, введённых в оборот", "Выгрузка отчёта по остаткам
импортированных ЛП до ввода в ГО"
•
Добавлены новые права "EDIT_BRANCH_STATE" (Смена статуса
МД), "EDIT_WAREHOUSE_STATE" (Смена статуса МОХ),
"VIEW_LP_MOVEMENT_CIRCULATION_REPORT"
(Просмотр
отчета по движению ЛП, введённых в оборот) в "Список прав
пользователей учетной системы (RightsEnum)"
•
В таблицу "Список типов задач на получение аналитических
данных
(TaskType)"
добавлены
новые
типы
задач
"lp_movement_circulation" (Выгрузка отчёта по движению ЛП,
введённых
в
оборот),
"import_movement"
(Остатки
импортированных ЛП до ввода в ГО), "number_sgtins_in_batches"
(Выгрузка информации о количестве SGTIN и их сериях в SSCC)
•
В таблицу "Список возможных статусов КИЗ" добавлен новый
статус "in_partial_ooc" (Частично выведен из оборота)
•
Добавлен параметр "total_withdrawal_part" (Суммарно списанная
доля):
◦ В таблицу "Формат объекта SgtinExtended"
◦ В таблицу "Формат объекта PublicSgtin"
◦ "Метод поиска по реестрам КИЗ по списку значений" в
структуру данных OwnedSgtin"
•
В таблицы "Формат объекта SgtinExtended", "Формат объекта
PublicSgtin"
добавлен параметр "marketplace_inn" (ИНН
организации, осуществившей продажу (дистанционной площадки))
•
В таблицу "Типы вывода из оборота" добавлен новый тип "6 -
Продан через дистанционную торговлю"
592
Дата
Версия
Описание изменений
изменений
•
Добавлен параметр "l_status" (Действует на основании лицензии),
актуализированы примеры запроса и ответа в следующих методах:
◦ "Метод для поиска информации о местах осуществления
деятельности по фильтру" в структуру данных BranchFilter
◦ "Получение перечня мест осуществления деятельности в
системе" в структуры данных PublicBranchFilter и
PublicBranchEntry
◦ "Метод для поиска информации о местах ответственного
хранения по фильтру" в структуры данных WarehouseFilter и
WarehouseEntry
◦ "Получение перечня мест ответственного хранения в системе" в
структуру данных WarehousePublicFilter и WarehousePublicEntry
•
Актуализирован пример ответа:
◦ "Метод поиска по реестрам КИЗ"
◦ "Метод поиска по общедоступным реестрам КИЗ по списку
значений"
◦ "Метод поиска по общедоступному реестру КИЗ в архивном
хранилище по списку значений"
◦ "Метод поиска по реестрам КИЗ по списку значений"
◦ "Метод для получения из реестров КИЗ детальной информации
о КИЗ и связанным с ним ЛП"
◦ "Метод для получения детальной информации о КИЗ в
архивном хранилище и связанным с ним ЛП"
◦ "Метод поиска по реестрам КИЗ всех записей со статусом
'Оборот приостановлен'"
•
В разделе "Выгрузка общедоступной информации по SGTIN" в
структуре данных PublicSgtins изменена кардинальность параметра
"batch" (Номер производственной серии)
•
В таблице "Формат объекта DocFilter" удалено описание
параметров "request_ids" (Список уникальных идентификаторов
запроса"), "sender_ids" (Список уникальных идентификаторов
отправителя), "receiver_ids" (Список уникальных идентификаторов
получателя)
593
Дата
Версия
Описание изменений
изменений
• Актуализировано примечание для параметра "status" (Статус):
◦ Метод для поиска информации о местах осуществления
деятельности по фильтру в структурах данных BranchFilter и
BranchEntry;
◦ Получение перечня мест осуществления деятельности в системе
в структурах данных PublicBranchFilter и PublicBranchEntry
◦ Метод для поиска информации о местах ответственного
хранения по фильтру в структурах данных WarehouseFilter и
WarehouseEntry
◦ Получение перечня мест ответственного хранения в системе в
структурах
данных
WarehousePublicFilter
и
WarehousePublicEntry
13.10.2021
4.41.1
• В разделе "Выгрузка отчёта по остаткам ЛП" изменена
кардинальность параметра "utilization_date_end" (Дата окончания
периода нанесения)
• В разделе "Выгрузка отчёта по выбытию ЛП" изменена
кардинальность параметра "exit_date_end" (Дата окончания периода
выбытия)
01.10.2021
4.41.0
• В разделах "Выгрузка отчёта по остаткам на МД/МОХ", "Выгрузка
отчёта по остаткам ЛП", "Выгрузка отчёта по выбытию ЛП" в
таблице "Доступные поля выгрузки" параметр "generation_date"
(Дата построения отчета) заменён на параметр "update_date" (Дата
обновления данных в отчёте)
594
Дата
Версия
Описание изменений
изменений
21.09.2021
4.41.0
•
Добавлен Формат объекта ExtendedGroupInfo
•
В таблице "Список прав пользователей учетной системы
(RightsEnum)"
право
"VIEW_BALANCE_ON_BP_REPORT"
(Просмотр отчёта по остаткам на МД) переименовано в (Просмотр
отчёта по остаткам на МД/МОХ), актуализирована расшифровка
права
•
В таблице "Список типов задач на получение аналитических
данных (TaskType)" тип задач "remaining_medicines_branches"
(Выгрузка отчёта по остаткам на МД) переименован в (Выгрузка
отчёта по остаткам на МД/МОХ)
•
В таблицу "Интервал между вызовами методов API" раздела
"Общие требования по использованию методов" добавлены
ограничения на вызовы метода "Получение перечня мест
ответственного хранения в системе"
•
В таблице "Формат объекта Group" параметр "users (Устарел)"
(Пользователи, состоящие в данной группе) отмечен как
устаревший. Дата устаревания 2021-10-02
•
В таблицу "Формат объекта SgtinExtended" добавлен параметр
"total_cost" (Суммарная стоимость)
•
В разделе "Метод для изменения группы прав пользователей"
актуализированы ограничение для параметра выходной
информации "group" (Объект типа Group) и пример ответа
•
Актуализированы ограничение для параметра выходной
информации "group" (Объект типа Group) в разделах "Метод для
изменения группы прав пользователей", "Метод для получения
информации о группе прав пользователей"
•
Актуализированы примеры ответа в разделах "Метод поиска по
реестрам КИЗ", "Метод для получения из реестров КИЗ детальной
информации о КИЗ и связанным с ним ЛП", Метод для получения
детальной информации о КИЗ в архивном хранилище и связанным
с ним ЛП, "Метод поиска по реестрам КИЗ всех записей со
статусом 'Оборот приостановлен'"
•
В разделе "Метод поиска по реестрам КИЗ по списку значений" в
таблицу "Формат объекта OwnedSgtin" добавлен параметр
"total_cost" (Суммарная стоимость), актуализирован пример ответа
•
В разделе "Метод для получения информации из реестра
производимых организацией ЛП" в таблице "Формат объекта
MedProduct" удален параметр "id" (Уникальный идентификатор),
добавлен параметр "cost_limit_date" (Дата изменения ПОЦ),
актуализирован пример ответа
•
В разделе "Получение результата задачи" добавлены пример
запроса и ответа
595
Дата
Версия
Описание изменений
изменений
• В разделе "Установка защищенного соединения к API по TLS
(HTTPS)" актуализировано описание настроек для продуктового
контура
• Раздел "Выгрузка отчёта по остаткам на МД" переименован в
"Выгрузка отчёта по остаткам на МД/МОХ", добавлен параметр
фильтрации "warehouse_id" (Идентификатор места ответственного
хранения), в таблицу "Доступные поля выгрузки" добавлен
параметр "generation_date" (Дата построения отчета)
• В разделах "Выгрузка отчёта по остаткам ЛП", "Выгрузка отчёта по
выбытию ЛП", в таблицу "Доступные поля выгрузки" добавлен
параметр "generation_date" (Дата построения отчета)
• В разделе "Метод поиска по общедоступным реестрам КИЗ по
списку значений" добавлено уточнение по поиску КИЗ
596
Дата
Версия
Описание изменений
изменений
17.08.2021
4.40.0
•
Добавлено новое право "VIEW_BATCHES_REGISTRY" (Просмотр
реестра серий) в "Список прав пользователей учетной системы
(RightsEnum)"
•
В таблице "Список типов задач на получение аналитических
данных (TaskType)" добавлен новый тип задач "batches_registry"
(Выгрузка из реестра серий)
•
В таблице "Формат объекта OutcomeDocument" добавлен параметр
"cancel_document_id" (Уникальный идентификатор документа
отмены)
•
В таблице "Формат объекта DocFilter" добавлены параметры
"request_ids" (Список уникальных идентификаторов запроса"),
"sender_ids" (Список уникальных идентификаторов отправителя),
"receiver_ids" (Список уникальных идентификаторов получателя)
•
Добавлен "Формат объекта DocOutcomeShowcaseFilter"
•
В таблице "Формат объекта SGTIN" параметр "release_date
(Устарел)" отмечен как устаревший
•
Для метода "Получение списка исходящих документов" добавлено
примечание для параметра входной информации "filter" (Фильтр
списка документов)
•
Для метода "Получение списка исходящих документов из витрины
документов" добавлено ограничение и актуализировано
примечание для параметра входной информации "filter" (Фильтр
списка документов)
•
В разделе "Метод для получения информации об иерархии
вложенности третичной упаковки" в таблице "Формат объекта
SsccInfo" параметр "release_date" (Дата и время совершения
операции упаковки (Устарел)) отмечен как устаревший
•
В разделе "Метод для получения информации о лицевых счетах" в
таблице "Формат объекта BillingAccount" добавлен параметр
"min_balance_threshold" (Пороговое значение баланса ЛС, в коп.),
актуализирован пример использования метода
•
В разделе "Выгрузка отчёта по выбытию ЛП" актуализированы
примечание для параметра фильтрации "exit_type" (Тип вывода из
оборота),
обязательность
для
параметров
"batches"
(Производственная серия), "exit_date_start" (Дата начала периода
выбытия), "exit_date_end" (Дата окончания периода выбытия)
•
В раздел "Получение аналитических данных" добавлен подраздел
"Выгрузка из реестра серий"
•
В разделе "Метод для получения информации об иерархии
вложенности третичной упаковки" в таблице "Объект SsccInfo"
параметр "release_date" (Дата и время совершения операции
упаковки (Устарел)) отмечен как устаревший
597
Дата
Версия
Описание изменений
изменений
• В таблице "Формат объекта DocFilter" добавлено примечание для
параметров "end_date" (Дата окончания периода фильтрации) и
"processed_date_to" (Дата обработки документа: окончание периода)
• В таблице "Формат объекта DocOutcomeShowcaseFilter" добавлено
примечание для параметров "end_date" (Дата окончания периода
фильтрации) и "processed_date_to" (Дата обработки документа:
окончание периода)
• В разделе "Фильтрация по реестру решений о приостановке КИЗ" в
таблице "Формат объекта PausedCirculationDecision" параметр
"owner_address (Устарел)" (Адрес места деятельности (ФИАС))
отмечен как устаревший
09.08.2021
4.39.2
Изменение версии приложения на 4.39.2
30.07.2021
4.39.1
Удалено сокращение "МОД" ("Место осуществления деятельности").
Вместо него используется "МД" ("Место деятельности")
598
Дата
Версия
Описание изменений
изменений
22.06.2021
4.39.0
•
"Формат Формат объекта SgtinPaymentInformation" отмечен как
устаревший
•
Добавлены новые методы:
◦ "Метод для получения сведений по маркированным и
ввезенным товарам"
◦ "Метод для получения информации о существующем SSCC"
•
В раздел "Получение аналитических данных" добавлены
подразделы
◦ "Выгрузка общедоступной информации по SGTIN"
◦ "Выгрузка отчёта по остаткам на МД"
•
В таблицу "Интервал между вызовами методов API" раздела
"Общие требования по использованию методов" добавлены
ограничения для "Метод для получения сведений по
маркированным и ввезенным товарам" и "Метод для получения
информации о существующем SSCC", актуализированы
ограничения на вызовы методов:
◦ " Метод для получения кода аутентификации"
◦ " Метод для получения ключа сессии"
◦ " Метод для выхода из системы"
•
Добавлены ограничения постраничного вывода для "Метод для
получения сведений по маркированным и ввезенным товарам"
•
В таблице "Список прав пользователей учетной системы
(RightsEnum)" удалено право "REESTR_DUES" (Реестр налоговой
задолженности), добавлены новые права:
◦ "SSCC_CHECK" (Получение информации о существующем
SSCC)
◦ "REESTR_SGTIN_DOCUMENTS"
(Получение
перечня
документов по идентификатору КИЗ)
◦ "VIEW_BALANCE_ON_BP_REPORT" (Просмотр отчёта по
остаткам на МД)
◦ "VIEW_BATCH_REPORT" (Просмотр отчётов по ЛП)
•
В таблице "Список типов задач на получение аналитических
данных (TaskType)" добавлены новые типы задач "public_sgtins"
(Выгрузка
общедоступной
информации
по
SGTIN),
"remaining_medicines_branches"(Выгрузка отчёта по остаткам на
МД)
599
содержание .. 4 5 6 7 ..
|
||
|
|
|