|
|
содержание .. 4 5 6 7 ..
создания нового задания на выгрузку". В ответе на запрос возвращается текущий статус задания
на выгрузку ("currentStatus"). Возможные значения:
• PREPARATION - подготовка;
• COMPLETED - выполнено;
• CANCELED - отменено;
• ARCHIVE - архив;
• FAILED - ошибка.
URL: dispenser/tasks/{taskId}
Тип приватности: публичный
Метод: GET
Пример запроса:
curl -X GET "<url стенда>/dispenser/tasks/11aaa1a1-11a1-1111-a1a1-aa11a11a11a1?pg=2"
-H 'Authorization: Bearer <ТОКЕН>'
Параметры запроса:
Параметр
Тип
Обяз.
Описание
taskId
string
+
Идентификатор формируемой выгрузки
(идентификатор, который вернулся в
ответе на запрос о формировании
выгрузки)
pg
string
+
Кодовое значение товарной группы (см.
"Справочник "Список поддерживаемых
товарных групп""). Указанное значение
должно совпадать с "productGroupCode",
сформированных ранее заданий
Пример ответа:
500
{
"id": "string",
"name": "string",
"createDate": "string",
"currentStatus": "string",
"orgInn": "string",
"productGroupCode": 0,
"downloadingStorageDays": 0,
"productGroups": [
{
"id": "string",
"name": "string"
}
],
"timeoutSecs": 0
}
В ответе возвращается информация, необходимая пользователю для дальнейшей работы.
Параметры ответа:
Параметр
Тип
Обяз.
Описание
id
string
+
Идентификатор задания на выгрузку
name
string
+
Наименование выгрузки
createDate
string (date-
+
Дата создания. Возвращается в формате
time)
yyyy-MM-ddTHH:mm:ss.SSS
currentStatus
string
-
Текущий Статус:
PREPARATION - подготовка;
COMPLETED - выполнено;
CANCELED - отменено;
ARCHIVE - архив;
FAILED - ошибка
orgInn
string
+
ИНН организации
productGroupCode
integer
-
Указывается цифровой код товарной
группы (см. "Справочник "Список
поддерживаемых товарных групп"")
downloadingStorageDay
integer
-
Время хранения выгрузки в днях
s
productGroups
object
-
Доступные товарные группы для текущего
типа задач
*id
integer
+
Идентификатор текущей задачи
*name
string
+
Наименование товарной группы
501
Параметр
Тип
Обяз.
Описание
timeoutSecs
integer
-
Таймаут в сек., при наступлении которого
диспетчер считает, что выгрузка по
данному заданию не выполнена
8.3. Метод получения статусов заданий на выгрузку
URL: dispenser/tasks
Тип приватности: приватный
Метод: GET
Пример запроса:
curl -X GET "<url стенда>/dispenser/tasks?page=0&size=4&pg=2"
-H "accept: application/json"
Параметры запроса:
Параметр
Тип
Обяз.
Описание
page
string
+
Номер страницы (отсчёт с 0)
size
string
+
Количество записей на странице
pg
integer
+
Кодовое значение товарной группы (см.
"Справочник "Список поддерживаемых
товарных групп""). Указанное значение
должно совпадать с "productGroupCode"
("Цифровой код товарной группы"),
сформированных ранее заданий
Пример ответа:
502
{
"list":[
{
"id":"string",
"name":"string",
"createDate":"string",
"currentStatus":"string",
"dataStartDate":"string",
"dataEndDate":"string",
"orgInn":"string",
"period":"string",
"periodicity":"string",
"productGroups":[
{
"id":"string",
"name":"string"
}
],
"timeoutSecs":0
}
]
}
Параметры ответа:
Параметр
Тип
Обяз.
Описание
Комментарий
list
object
+
Результат запроса
*id
string
+
Идентификатор задания на
выгрузку
*name
string
+
Наименование выгрузки
*createDate
string
+
Дата создания
Возвращается в формате
yyyy-MM-
ddTHH:mm:ss.SSS
*currentStatus
string
+
Текущий статус
Возможные значения:
PREPARATION -
подготовка;
COMPLETED - выполнено;
CANCELED - отменено;
ARCHIVE - архив;
FAILED - ошибка
*dataStartDate
string
-
Дата начала периода, по
Возвращается в формате
которому сформирована
yyyy-MM-dd
выгрузка
*dataEndDate
string
-
Дата и время окончания
Возвращается в формате
периода, по которому
yyyy-MM-
сформирована выгрузка
ddTHH:mm:ss.SSS’Z
503
Параметр
Тип
Обяз.
Описание
Комментарий
*orgInn
string
+
ИНН организации
*period
string
-
Периодичность регулярной
Только при "periodicity"
выгрузки
("Вид периодичности") =
REGULAR (регулярная).
Возможные значения:
HALF_MIN - полминуты;
TEN_MINUTES - 10 минут;
DAY - день;
WEEK - неделя;
MONTH - месяц;
QUARTER - квартал;
YEAR - год
*periodicity
string
+
Вид периодичности
Возможные значения:
SINGLE - однократная;
REGULAR - регулярная
*productGroups
object
-
Доступные товарные
группы для текущего типа
задач
*timeoutSecs
integer
-
Таймаут в секундах, при
наступлении которого
сервис выгрузок считает,
что выгрузка по данному
заданию не выполнена
8.4. Метод получения результирующих ID выгрузок данных
В ответе на данный метод возвращается список заданий с указанием результирующего ID.
Результирующий ID используется в последующем запросе сформированного файла выгрузки.
URL: dispenser/results
Тип приватности: публичный
Метод: GET
Пример запроса:
curl -X GET "<url стенда>/results?page=1&pg=1&size=12"
-H "Authorization: Bearer <ТОКЕН>"
Параметры запроса:
Параметр
Тип
Обяз.
Описание
page
string
+
Номер страницы (отсчёт с 0)
size
string
+
Количество записей на странице
504
Параметр
Тип
Обяз.
Описание
pg
integer
-
Кодовое значение товарной группы
Справочник "Список поддерживаемых
товарных групп". Указанное значение
должно совпадать с "productGroupCode"
("Цифровой код товарной группы"),
сформированных ранее заданий
task_ids
array [string]
-
Список ID задач
Пример ответа:
{
"list": [
{
"id": "string",
"archiveSize": 0,
"available": "string",
"dataStartDate": "string",
"dataEndDate": "string",
"downloadStatus": "string",
"downloadingTime": 0,
"errorMessage": "string",
"fullErrorMessage": "string",
"fileDeleteDate": "string",
"generationStartDate": "string",
"generationEndDate": "string",
"notEditable": true,
"taskId": "string"
}
]
}
Параметры ответа:
Параметр
Тип
Обяз.
Описание
Комментарий
list
object
+
Результат запроса
*archiveSize
integer
-
Размер архива выгрузки в
байтах
*available
string
-
Доступность загрузки
файла:
AVAILABLE - доступен;
NOT_AVAILABLE -
недоступен
505
Параметр
Тип
Обяз.
Описание
Комментарий
*dataStartDate
string
-
Дата-время начала периода,
(date-
по которому сформирована
time)
выгрузка. Возвращается в
формате yyyy-MM-
ddTHH:mm:ss.SSS’Z
*dataEndDate
string
-
Дата-время окончания
(date-
периода, по которому
time)
сформирована выгрузка.
Возвращается в формате
yyyy-MM-
ddTHH:mm:ss.SSS’Z
*downloadStatus
string
-
Статус:
SUCCESS - успешно;
PREPARATION - в
обработке;
FAILED - неуспешно
*downloadingTime
integer
-
Длительность выполнения
выгрузки в секундах
*errorMessage
string
-
Сообщение об ошибке.
Параметр указывается при
наличии ошибки
*fileDeleteDate
string
-
Дата-время
(date-
запланированного удаления
time)
файла выгрузки с сервера.
Возвращается в формате
yyyy-MM-
ddTHH:mm:ss.SSS’Z
*generationStartDate
string
-
Дата-время начала
(date-
генерации выгрузки.
time)
Возвращается в формате
yyyy-MM-
ddTHH:mm:ss.SSS’Z
*generationEndDate
string
-
Дата-время окончания
(date-
генерации выгрузки.
time)
Возвращается в формате
yyyy-MM-
ddTHH:mm:ss.SSS’Z
*notEditable
boolean
-
Признак, указывающий на
возможность удаления или
продления выгрузки
*taskId
string
-
Идентификатор задания
8.5. Метод получения ZIP файла выгрузки
Пользователю доступно скачивание выгрузки в текущем статусе "Выполнено" (currentStatus =
506
COMPLETED), полученном в ответе на запрос "Метода получения статуса задания на выгрузку
по ID выгрузки".
Для получения ZIP файла выгрузки со сведениями по КИ и агрегатам используется "Метод
получения CSV по КИ и агрегатам". Для получения ZIP файла ошибок используется "Метод
получения CSV ошибок по результатам обработки документов".
URL: dispenser/results/{resultId}/file
Тип приватности: публичный
Метод: GET
Пример запроса:
curl -X GET "<url стенда>dispenser/results/11d65d37-3138-4b78-804d-
226589e46381/file?pg=3/file"
-H "accept: */*"
-H "Authorization: Bearer <ТОКЕН>"
Параметры запроса:
Параметр
Тип
Обяз.
Описание
result_id
string
+
ID выгрузки
pg
integer
-
Кодовое значение товарной группы
Справочник "Список поддерживаемых
товарных групп". Указанное значение
должно совпадать с "productGroupCode"
("Цифровой код товарной группы"),
сформированных ранее заданий
8.5.1. Метод получения CSV ошибок по результатам обработки документов
В ответ возвращается ZIP файл с выгрузкой из запроса в формате CSV. Для агрегатов выводится
список вложенных КИ первого слоя. Сформированный архив будет доступен для скачивания в
течение 30 дней.
Пример структуры выгрузки ошибок:
<id УД в ГИС>
№ <Порядковый номер УД> от <Дата УД>
Отправитель <Наименование Отправителя УД>, <ИНН Отправителя УД>
Получатель <Наименование Получателя УД>, <ИНН Получателя УД>
<Код типа ошибки1>: <описание ошибки1>
"<КИ/КИТУ/КИГУ1 1>"
"<КИ/КИТУ/КИГУ1 2>"
Пример ответа CSV для сформированной выгрузки ошибок по документам ЭДО:
507
"document_id","status","document_number","document_date","sender_inn","receiver_inn","
cis","error_code","error_text"
"7f4c6249-976e-43d5-b25f-afccc9e8cf42","IN_PROGRESS","7f4c6249-976e-43d5-b25f-
afccc9e8cf42",,,,,,
"ON_NSCHFDOP_Test_prng-777-300342343243","IN_PROGRESS","7202323234433",,,,,,
"7a2fba8a-4d14-45ad-a10b-9b53c7003cf5","CHECKED_NOT_OK","7a2fba8a-4d14-45ad-a10b-
9b53c7003cf5","2020-09-02 15:24:10.947","7724211288",,,,"Не пройдена проверка подписи"
"1efce0ec-09f6-4987-b4b1-f9d056c44e7b","CHECKED_NOT_OK","1efce0ec-09f6-4987-b4b1-
f9d056c44e7b","2020-09-11 08:45:46.463","7724211288",,,"INTRO_ERROR","41:
Недостаточное описание товара, указанного в документе ""Ввод в оборот""
cI046902297902"
"8032b556-cd82-4e05-876b-da0a5cbfcb34","CHECKED_NOT_OK","8032b556-cd82-4e05-876b-
da0a5cbfcb34","2020-09-09 14:44:57.619","7724211288",,,"INTRO_ERROR","07: Недопустимое
количество символов в значении поля ""КИ"" ""010463003407001221BM(__Рѕ__)G0E3""
в документе ""Ввод в оборот""."
"09252711-e901-482d-963a-544ad4fe4a29","CHECKED_NOT_OK","09252711-e901-482d-963a-
544ad4fe4a29","2020-09-07 20:13:16.729","7724211288",,,"INTRO_ERROR","06: Значение
поля ""КИТУ"" ""214623467234823423"" в документе ""Ввод в оборот"" не найдено в базе
данных."
"e2a942c6-252e-4114-8d89-49b04f4f5ddb","PARSE_ERROR","e2a942c6-252e-4114-8d89-
49b04f4f5ddb","2020-07-20 13:11:18.056","7724211288",,"20.07.2020
04:11",,"REM_ERR","28: Передаваемый файл XML не соответствует XSD-схеме."
Коды ошибок общих проверок для УД:
Код типа ошибки
Описание ошибки
Комментарий
4
Проверка отсутствия регистрации УД
Документ зарегистрирован ранее в
ГИС МТ
13
Проверка регистрации
Участник <ИНН Продавца УД> или
Продавца/Покупателя УД в ГИС МТ
<ИНН Покупателя> не
при отсутствии ИГК
зарегистрирован в ГИС МТ
(Проверка регистрации <ИНН
Покупателя> не осуществляется при
отгрузках для собственных нужд или
в рамках государственного
контракта).
Дополнительно: для всех товарных
групп (исключение составляет
товарная группа "Табачная
продукция") проверяется наличие
подписанного договора на
взаимодействие с товарной группой
508
Код типа ошибки
Описание ошибки
Комментарий
16
Проверка отсутствия дублирования
В ГИС МТ ранее был успешно
УКД/УКД(и) в ГИС
обработан УКД/УКД(и) с такими же
№ и датой УКД, <ИНН Получателя>
и <ИНН Отправителя>, № и датой
исправления (если был направлен на
обработку УКД(и)), как у текущего
направленного УКД или УКД(и),
либо в ГИС МТ ранее был успешно
обработан УКД(и) с более поздней
датой корректировки
46
Проверка имени файла и титулов УД
Имя файла не корректно или
структура XML не прошла проверку
по схеме XSD
49
Проверка совпадения значения
Параметр имеет различное значение
параметра "turnover_type" в
в документах на приёмку и отгрузку
документе на отгрузку и в документе
на приёмку
54
Проверка заполненной даты
Дата Исправления УПД(и) имеет
исправления
пустое значение или имеет неверный
формат
63
Проверка отсутствия дублирования
В ГИС МТ ранее был успешно
УПД в ГИС МТ
обработан УПД с такими же № и
датой УПД, <ИНН Получателя> и
<ИНН Отправителя>, как у текущего
направленного УПД, либо в ГИС МТ
был успешно обработан УПД(и) с
более поздней датой исправления
64
Проверка в ГИС корректности
В ГИС МТ ранее был успешно
последовательности УПД(и) в
обработан УПД(и) с № и датой УПД,
цепочке УД текущего УПД(и)
<ИНН Получателя> и <ИНН
МОТП/ЛП
Отправителя>, с № и датой
исправления позднее, чем у текущего
направленного УПД(и)
69
Проверка кода итога приёмки товаров
Поле «КодИтога» Титула Покупателя
(работ, услуг, прав)
(при условии его указании)
заполнено не корректным значением
71
Проверка наличия сведений о
В документе нет сведений о КИ
маркированных товарах в УД.
маркированного товара
Проверка валидности УД
82
Проверка отсутствия дублирования
В ГИС МТ ранее был успешно
УПД(и) в ГИС МТ
обработан УПД(и) с такими же № и
датой УПД, <ИНН Получателя> и
<ИНН Отправителя>, № и датой
исправления, как у текущего
направленного УПД(и)
509
Коды и текст ошибок для УД:
Код типа ошибки
Описание ошибки
Комментарий
22
Не найдены КИ
Указанные в документе КИ не
найдены в ГИС МТ
23
У участника нет полномочий на
При обработке документа Поставщик
выполнение операции с КИ
не является владельцем указанного
КИ.
При обработке исправлений:
• при возврате на Поставщика КИ
Покупатель
не
является
владельцем кода по данным ГИС
МТ;
• при добавлении к перемещению
на Покупателя КИ Поставщик не
является владельцем кода по
данным ГИС МТ
24
Статус КИ/агрегатов не соответствует
Статус КИ или их состояние
выполняемой операции
("ожидают приёмку", "ожидают
перемаркировку") не соответствуют
выполняемой операции
27
Для УД не найдены истории КИ
При обработке возвратов по КИ
проверяется наличие истории
перемещения КИ между
Поставщиком и Покупателем
68
КИ не оплачен
По КИ, указанным в документе, не
произведена оплата
75
КИ имеет некорректный тип эмиссии
По КИ с типом эмиссии «Импорт»,
указанным в документе, не
произведена оплата
79
КИ имеют длину менее 18 символов
КИ имеют не корректную длину либо
либо содержат недопустимые
содержат недопустимые символы
символы
81
КИ отсутствует в цепочке
При обработке корректировок.
универсальных документов
При возврате на Поставщика КИ
Покупатель не является владельцем
кода по данным ГИС МТ
510
Код типа ошибки
Описание ошибки
Комментарий
83
Некорректная последовательность
Проверка истории перемещения КИ
УД для КИ
при обработке корректировок:
• указанные без изменений КИ в
документе по данным ГИС МТ
были ранее перемещены с
Поставщика на Покупателя;
• для
возвращаемых
на
Поставщика КИ владельцем
является Покупатель;
• для добавленных к перемещению
на Покупателя КИ владельцем
является Отправитель
Коды ошибок для документов прямой подачи:
0
Success
Обработка документа прошла
успешно
10
VendorNotExists
Продавец не идентифицирован (не
зарегистрирован)
100
DatabaseLoadingError
Ошибка при загрузке из базы данных
101
SkippedDocumentError
Обработка документа прервана
12
CustomerNotExists
Покупатель не идентифицирован (не
зарегистрирован)
13
ParticipantNotExists
Участник не идентифицирован (не
зарегистрирован)
14
DuplicateTransferDocument
УПД для счёт-фактуры
зарегистрирован ранее
18
CisEditedByAnotherDoc
КИ был изменен более поздним
документом
19
CisHistoryNotExists
Отсутствуют записи в истории по КИ
20
CisHistoryNotValid
Последняя запись в истории КИ не
соответствует изменению по
документу. ИД документа не указан
21
CisIncorrectAggregation
КИ с "родителем" нельзя
агрегировать
25
InvalidAggregationHistory
Последняя запись в истории имеет
тип операции, не соответствующий
агрегации
26
ParticipantDissolved
Участник не зарегистрирован в
ЕГРИП/ЕГРЮЛ как действующее
лицо
511
0
Success
Обработка документа прошла
успешно
31
InsufficientRightsGroup
У участника нет полномочий на
выполнение операций с групповой
упаковкой и КИ
33
IncorrectDisaggregationLevel
Групповая упаковка вложена в
групповую упаковку. Для
дезагрегации используйте
идентификатор верхней групповой
упаковки
44
XsdValidationError
Ошибка валидации документа по
XSD схеме
55
Дата документа $docId меньше, чем
дата эмиссии или нанесения в коде
$cis
56
InvalidAggregationParentType
Тип упаковки для агрегата - пачка
57
ParticipantAlreadyExists
Участник уже существует
58
ParticipantNotExistsInEGRUL
Участник не зарегистрирован в
ЕГРИП/ЕГРЮЛ
59
OfdNotExists
Оператор фискальных данных с ИНН
не найден
60
ProductNotExists
Продукция с GTIN не найдена
61
ProductInsufficientRights
У участника нет полномочий на
выполнение операций с продукцией,
имеющей GTIN
62
InvalidAggregationChildType
Тип упаковки нельзя поместить в
упаковку
65
ApiError
Ошибка во время обращения к
66
NotEmptyAggregatorError
Агрегат не пустой
67
InvalidAggregationDate
Дата эмиссии новой групповой
упаковки меньше даты эмиссии
старой, либо даты эмиссии
отсутствуют
7
IncorrectUDHistory
Последний успешный УД не найден
для счёт-фактуры №, дата
70
DocumentDataFieldsError
Содержание документа некорректно.
Отсутствуют
72
InvalidDocumentType
Некорректный тип документа
73
WrongEmissionType
Некорректный тип эмиссии
512
0
Success
Обработка документа прошла
успешно
74
DifferentChildrenStatus
3014 - статусы приведённых в
документе «Агрегация товаров»
транспортных упаковок либо товаров
не совпадают
76
Документ с ID $id не найден
102
MultiCodes
Документ содержит мультитоварные
Коды Маркировки
103
CodesIsEmpty
Документ не содержит Кодов
Маркировки
8.5.2. Метод получения CSV по КИ и агрегатам
В ответе формируется ZIP файл с выгрузкой из запроса в формате * .csv. Для агрегатов
выводится список вложенных КИ первого слоя. Сформированный архив будет доступен для
скачивания в течение 30 дней.
Пример ответа:
"requestCis; parent; child; status; packageType; gtin; tg-id; tg-name; productName;
tnved_code; producedDate; emissionDate; emissionType; producerInn; producerName;
ownerInn; ownerName; maxRetailPrice; pVSD; expirationDate; In_gray_zone;
gray_quantity; error "
"1111; ; 1211, 1311; applied; level3; ; 3; tobacco; ; ; ; ; ; ; ; 3664069397; BAT; ; ;
; true; 2"
"2111; 5555; 2211, 2311, 2411; applied; level2; 04605025000880; 3; tobacco; kamel
light; ; 01.01.2020; 05.01.2020; local; 3664069397; BAT; 3664069397; BAT; 80,00; 0987;
; true; 1"
"3111; 6666; ; ; applied; level1; 04605025000880; 3; tobacco; kamel light; 24;
01.01.2020; 05.01.2020; local; 3664069397; BAT; 3664069397; BAT; 80,00; 0987;
01.01.2022 ; false"
"5555, 6666, 7777, 8888; ; ; ; ; ; ; ; ; ; ; ; ; ; ; ; ; ; ; ; ; ;not_found"
"9999; ; ; ; ; ; ; ; ; ; ; ; ; ; ; ; ; ; ; ; ; ; invalid_format"
Параметры ответа CSV для получения сведений по КИ и агрегатам:
Параметр
Тип
Обяз.
Описание
Комментарий
requestCis
string
+
Запрашиваемый
Отсутствует, если выводится из
КИ (агрегат или
вложенной иерархии
КИ) из запроса
parent
string
+
КИ или агрегат
Выводится, если есть "родительский"
"родителя"
КИ
status
integer
+
Статус кода или
см. Справочник "Статусы КИ"
агрегата
513
Параметр
Тип
Обяз.
Описание
Комментарий
packageType
integer
+
Уровень упаковки
см. Справочник "Типы упаковки"
агрегата или КИ
gtin
string
-
Код товара
Выводится для КИГУ и КИ
tg-id
integer
+
Код товарной
см. Справочник "Список
группы
поддерживаемых товарных групп"
tg-name
string
+
Наименование
см. Справочник "Список
товарной группы
поддерживаемых товарных групп"
productName
string
-
Наименование
Не выводится для КИТУ
товара
tnved_code
string
-
10 значный код
Выводится для КИ (штука, комплект)
ТН ВЭД
producedDate
string
-
Дата ввода в
Отсутствует, если КИ в статусе
(date-
оборот или
"Эмитирован". Не выводится для
time)
формирования
КИТУ, кроме товарной группы
агрегата
"Табачная продукция". Возвращается
в формате yyyy-MM-
ddTHH:mm:ss.SSS’Z
emissionDate
string
-
Дата эмиссии
Не выводится для КИТУ.
(date-
Возвращается в формате yyyy-MM-
time)
ddTHH:mm:ss.SSS’Z
emissionType
integer
-
Тип производства
LOCAL - производство РФ;
FOREIG - ввезен в РФ. Не выводится
для КИТУ
producerInn
string
-
ИНН
Только для товара, произведённого на
производителя
территории РФ. Не выводится для
КИТУ и наборов, кроме товарной
группы "Табачная продукция"
producerName
string
-
Наименование
Не выводится для КИТУ и наборов,
производителя
кроме товарной группы "Табачная
продукция"
ownerInn
string
+
Владелец КИ или
В случае передачи идентификатора
агрегата
по агентской, комиссионной схеме -
отражается агент, комиссионер,
который реализует данный
идентификатор
ownerName
string
+
Наименование
В случае передачи идентификатора
владельца КИ или
по агентской, комиссионной схеме
агрегата
отражается агент, комиссионер,
который реализует данный
идентификатор
514
Параметр
Тип
Обяз.
Описание
Комментарий
maxRetailPrice
string
-
Максимальная
Только для товарной группы
цена розничной
"Табачная продукция" (пачка, блок).
продажи
Для блока значение = количество
штук в блоке, умноженное на МРЦ
пачки
pVSD
string
-
ID
ID производственного ВСД,
производственног
сопровождающего партию. Только
о ВСД
для товарной группы "Молочная
продукция"
expirationDate
string
-
Дата срока
Минимальный срок годности, если
(date-
годности
задаётся период. Возвращается
time)
только для товарной группы
"Молочная продукция" в формате
yyyy-MM-ddTHH:mm:ss.SSS’Z
in_gray_zone
integer
+
Признак наличия
Признак наличия кода в серой зоне
в Серой зоне
или наличия в агрегате Серой зоны.
Возвращается только для товарной
группы "Табачная продукция"
gray_quanity
integer
-
Количество кодов
Количество кодов в Серой зоне в
в Серой зоне
агрегате. Возвращается только для
товарной группы "Табачная
продукция"
statusEx
enum
-
Актуальные
особые состояния
КИ см.
Справочник
"Статусы КИ"
mark_withdraw
integer
-
Признак выбытия
Признак выбытия КИ от не владельца
КИ от не
владельца
child
array
+
Массив кодов
Не выводится для КИ
вложений первого
уровня без
детализации
cis
string
+
Код
идентификации
или агрегата,
вложенного в
уровень выше
8.5.3. Метод получения CSV по списку КИ участника оборота товаров по заданному
фильтру
В ответе формируется ZIP файл с выгрузкой из запроса в формате CSV со сведениями о КИ,
которые находятся на балансе у участника оборота товаров. Вывод сведений о КИ
осуществляется с учётом установленных фильтров. Сформированный архив будет доступен для
515
скачивания в течение 30 дней.
Пример ответа:
"Filter(participantInn=0000000000, productGroup=TOBACCO, packageType=[LEVEL1],
status=EMITTED, includeGtin=[], excludeGtin=[], appliedPeriod=null,
emissionPeriod=null)"
"requestedCis","gtin","tnVedEaes","tnVedEaesGroup","mrp","parent","producerInn","owner
Inn","prVetDocument","productName","brand","ownerName","producerName","introducedDate"
,"receiptDate","status","statusEx","emissionType","withdrawReason","packageType","prod
uctGroup","applicationDate","emissionDate","expirationDate","child"
"(01)000000000000000(21)N8JY6Hl","000000000000205","1","1","12500","00000046229205K6RK
YlY5jNnQa1IIJn1mTxtr","0000000000",,,,,,"АО ""БАТ-
СПБ""","","","APPLIED",,"LOCAL",,"LEVEL1","TOBACCO","2020-06-09T16:29:51Z","2020-06-
09T16:29:34Z","2020-06-09T16:29:34Z"
"(01)000000000000000(21)1x5n1eh","000000000000205",,,"",,"0000000000",,,,,,"АО ""БАТ-
СПБ""","","","APPLIED",,"LOCAL",,"LEVEL1","TOBACCO","2019-12-04T08:42:33Z","2019-12-
04T08:42:22Z",
Параметр
Тип
Обяз.
Описание
Комментарий
requestedCis
string
+
КИ
При наличии параметра в ответе
потребительских/
(если найдены КИ по запросу)
групповых/трансп
ортных упаковок
gtin
string
+
Код товара
Если код товара менее 14 символов,
то дополняется ведущими нулями
tnVedEaes
string
-
10 значный код
ТН ВЭД
tnVedEaesGroup
string
-
4 значный код ТН
ВЭД
maxRetailPrice
number
-
Максимальная
В текущей реализации возможно
розничная цена в
выведение параметра "mrp", который
копейках
в последующих версиях будет
заменён на "maxRetailPrice"
parent
string
-
Родительский КИ
producerInn
string
-
ИНН
Не возвращается для агрегатов,
производителя
кроме товарных групп "Табачная
продукция" и "Альтернативная
табачная продукция"
ownerInn
string
-
ИНН
Данный параметр возвращается
собственника
только владельцу продукции, ФОИВ
товара
и Оператору. Возвращение данных о
владельце настраивается параметром
конфигурации. Параметр не
возвращается для товарной группы
"Табачная продукция"
516
Параметр
Тип
Обяз.
Описание
Комментарий
prVetDocument
string
-
Производственны
й ветеринарный
сопроводительны
й документ,
транспортный
ВСД для
импортируемой
продукции
(обязательный
параметр для
товарной группы
"Молочная
продукция")
productName
string
-
Наименование
продукции
ownerName
string
-
Наименование
Данный параметр возвращается
собственника
только владельцу продукции, ФОИВ
товара
и Оператору. Отображение данных о
владельце настраивается параметром
конфигурации. Параметр не
возвращается для товарной группы
"Табачная продукция"
producerName
string
-
Наименование
Не возвращается для агрегатов,
производителя
кроме товарных групп "Табачная
продукция" и "Альтернативная
табачная продукция"
introducedDate
string
-
Дата ввода товара
Возвращается в формате yyyy-MM-
(date-
в оборот или
ddTHH:mm:ss.SSS’Z
time)
формирование
агрегата
emissionDate
string
-
Дата эмиссии
Возвращается в формате yyyy-MM-
(date-
ddTHH:mm:ss.SSS’Z
time)
emissionType
string
-
Тип эмиссии
maxRetailPrice
number
-
Максимальная
Только для пачки и блока
цена розничной
продажи
applicationDate
string
-
Дата нанесения
Возвращается в формате yyyy-MM-
(date-
ddTHH:mm:ss.SSS’Z
time)
receiptDate
string
-
Дата вывода из
Возвращается в формате yyyy-MM-
(date-
оборота
ddTHH:mm:ss.SSS’Z
time)
withdrawReason
string
-
Причина вывода
См. "Справочник "Причины вывода
из оборота
из оборота""
517
Параметр
Тип
Обяз.
Описание
Комментарий
packageType
string
+
Тип упаковки
child
array
-
Список дочерних
[string]
КИ в агрегате
brand
string
-
Бренд
expirationDate
string
+
Срок годности
(date-
(для товарной
time)
группы
"Молочная
продукция")
productGroup
string
-
Товарная группа
См. "Справочник "Список
поддерживаемых товарных групп""
status
string
+
Статус КИ
Cм. "Справочник "Статусы КИ""
statusEx
string
-
Актуальный
См. cправочник "Актуальные
расширенный
статусы"
статус КИ
setGtin
array
-
Список и
Возвращается только с типом
количество "gtin",
упаковки "Набор" (SET)
входящих в
справочный
состав набора
setDesription
string
-
Текстовое
Возвращается только с типом
описание состава
упаковки "Набор" (SET)
набора
introducedDate
string
+
Дата ввода товара
Возвращается в формате yyyy-MM-
(date-
в оборот или
ddTHH:mm:ss.SSS’Z. Параметр
time)
формирования
может возвращаться с пустым
агрегата
значением. Данные выводятся только
для продукции, произведённой с
января 2021 года
receiptDate
string
+
Дата вывода из
Возвращается в формате yyyy-MM-
(date-
оборота
ddTHH:mm:ss.SSS’Z только для
time)
выгрузки FILTERED_CIS_REPORT.
Параметр может возвращаться с
пустым значением
9. Взаимодействие с провайдером ЭДО Lite
9.1. Публичный метод получения идентификатора абонента
в ЭДО Lite
Метод предназначен для получения идентификатора абонента в ЭДО Lite: в одном запросе
указывается ИНН одного участника оборота товаров.
Тип приватности:
518
1. публичный;
2. без токена.
Принцип формирования ответа метода:
1. если участник оборота товаров не зарегистрирован в ЭДО Lite, то возвращается текст
сообщения об ошибке: "Организация не зарегистрирована";
2. если участник оборота товаров зарегистрирован в ЭДО Lite, но в качестве основного ЭДО
провайдера указан не ЭДО LITE, то возвращается текст сообщения об ошибке: "УОТ
использует другого оператора ЭДО";
3. если участник оборота товаров зарегистрирован в ЭДО Lite и в качестве основного ЭДО
провайдера указан ЭДО Lite, то возвращается ID участник оборота товаров вместе с
префиксом "2LT-" формата "2LT-<ID участника обмена ЭДО Lite>" (например: 2LT-
572279911).
Рекомендуется использовать версию v4, версия v3 в дальнейшем будет снята с поддержки.
Описание версии v3 приведено после описания версии v4.
9.1.1. Версия v4
URL: /edo/inn/{inn}
Метод: GET
Пример запроса с токеном:
curl -X GET "<url стенда v4>/edo/inn/7777777777"
-H "accept: application/json"
-H "Authorization: Bearer <ТОКЕН>"
Пример запроса без токена:
curl -X GET "<url стенда v4>/edo/inn/7777777777"
-H "accept: application/json"
Параметры запроса:
Параметр
Тип
Обяз.
Описание
Комментарий
inn
string
+
ИНН участника
оборота товаров
Пример ответа:
1.В случае успеха:
519
{
"inn": "7777777777",
"id": "2LT-572279988",
"name": "ООО",
"hub": true
}
2.В случае ошибок:
2.1. Код 400, если запрос в сервис организации вернул пустой ответ:
{
"error_message": "Организация не зарегистрирована"
}
2.2. Код 400, если в ответе от сервиса ЭДО для запрашиваемого ID участника обмена нет
информации по операторам ЭДО, или ни один из найденных операторов ЭДО не является
основным, или наименование у найденного основного оператора ЭДО не равно "ЭДО Lite"
(нечувствительная к регистру проверка наименования):
{
"error_message": "УОТ использует другого оператора ЭДО"
}
Параметры ответа:
Параметр
Тип
Обяз.
Описание
Комментарий
inn
string
-
ИНН
Параметр возвращается только при
запрашиваемой
выполнении п. 3 "Принципа
организации
формирования ответа метода" в
описании настоящего метода
id
string
-
ID участника
Параметр возвращается только при
обмена ЭДО Lite
выполнении п. 3 "Принципа
формирования ответа метода" в
описании настоящего метода
name
string
-
Наименование
Параметр возвращается только при
организации или
выполнении п. 3 "Принципа
ФИО
формирования ответа метода" в
индивидуального
описании настоящего метода
предпринимателя
520
Параметр
Тип
Обяз.
Описание
Комментарий
hub
boolean
-
Признак
Возможные значения:
использования
организацией 1С
Хаб
true - организация использует 1С
Хаб;
false - Организация не использует 1С
Хаб
Параметр возвращается только при
выполнении п. 3 "Принципа
формирования ответа метода" в
описании настоящего метода
9.1.2. Версия v3
URL: /edo/inn/{inn}
Метод: GET
Пример запроса с токеном:
curl -X GET "<url стенда v3>/edo/inn/7777777777"
Authorization: Bearer <ТОКЕН>
Пример запроса без токена:
curl -X GET "<url стенда>/edo/inn/7777777777"
Параметры запроса:
Параметр
Тип
Обяз.
Описание
Комментарий
inn
string
+
ИНН участника
оборота товаров
(участника
обмена ЭДО Lite)
Пример ответа:
1.В случае успеха:
{
"id": "2LT-572279988"
}
2.В случае ошибок:
2.1. Код 400, если запрос в сервис организаций вернул пустой ответ, если в ответе от сервиса
521
ЭДО для запрашиваемого ID участника обмена нет информации по операторам ЭДО, если ни
один из найденных операторов ЭДО не является основным или если наименование у найденного
основного oператора ЭДО не равно "ЭДО Lite" (нечувствительная к регистру проверка
наименования):
{
"error_message":"string"
}
2.2. Код 401, если для доступа к этому ресурсу требуется полная аутентификация:
{
"error":"string",
"error_description":"string"
}
2.3. Код 500, если ошибка при выполнении запроса:
{
"error_message":"string"
}
Параметры ответа:
Параметр
Тип
Обяз.
Описание
Комментарий
id
string
-
ID участника
При выполнении п. 3 блока
оборота товаров
"Принцип формирования ответа
(участника
метода" в описании настоящего
обмена ЭДО Lite)
метода
9.2. Метод получения ZIP-архива документа ЭДО с
подписями и квитанциями из ЭДО Lite
Метод предназначен для получения ZIP-архива входящих либо исходящих документов ЭДО
(УПД, УПД(и), УКД, УКД(и)) с подписями и квитанциями обмена с подписями.
Тип приватности: приватный.
URL:
Тип документов
URL
Для исходящих документов
/elk/outgoing-documents/{documentId}
Для входящих документов
/elk/incoming-documents/{documentId}
Метод: GET
522
Параметры запроса:
Параметр
Тип
Обяз.
Описание
documentId
string
+
Идентификатор документа в системе ЭДО
оператора
Параметры ответа:
ZIP-архив с документом, подписью и квитанциями с подписями, если это УПД или УКД.
Пример запроса:
curl -X GET "<url стенда>/elk/outgoing-documents/5b7f19e8-db96-463a-9735-2ef1a73abf9b"
-H "accept: application/json"
-H "Authorization: Bearer <ТОКЕН>"
Пример ответа:
1 В случае успеха:
ZIP-архив
2 В случае ошибок:
2.1 Код 401 В случае, если не указан токен:
<UnauthorizedException>
<error>unauthorized</error>
<error_description>Full authentication is required to access this
resource</error_description>
</UnauthorizedException>
2.2 Код 401 В случае, если указан невалидный токен:
<InvalidTokenException>
<error>invalid_token</error>
<error_description>Cannot convert access token to
JSON</error_description>
</InvalidTokenException>
2.3 Код 404 В случае, если указан невалидный {documentId} в параметре URL запроса:
{
"error_message": "Документ не найден"
}
523
10. Методы Национального каталога
Вызов методов "Национального каталога" возможен с использованием авторизации, доступной
одним из следующих способов:
• через параметр "apikey", указываемому в параметрах URL запроса. Данный параметр
предоставляется системой "Национального каталога" по индивидуальной заявке. Заявку
можно оставить по ссылке Национальный каталог. Параметр является обязательным, если в
заголовке запроса не указан аутентификационный токен API ГИС МТ.
• по токену, полученному в результате вызова метода получения аутентификационного токена
API ГИС МТ (см. Единая аутентификация) и передаваемому в заголовке запроса (параметр
"Authorization: Bearer <token>"). Параметр является обязательным, если не указан "apikey" в
параметрах URL запроса.
10.1. Универсальные параметры запроса
Параметр
Обяз.
Значение по
Описание
умолчанию
apikey
-
Параметр, необходимый для
авторизации и совершения запросов
API. Предоставляется системой.
Параметр является обязательным,
если в заголовке запроса не указан
аутентификационный токен API ГИС
МТ.
format
-
Формат вывода
Принимаемые значения:
ответа
• XML;
• JSON
10.2. Метод получения списка атрибутов как публичных, так
и приватных для запрашивающего аккаунта
Метод возвращает перечень атрибутов для создания карточки товара с указанным кодом ТН ВЭД
или идентификатором категории. Если не указан код ТН ВЭД или идентификатор категории,
возвращается полный список атрибутов доступных для запрашивающего аккаунта.
Тип приватности: публичный
URL: /nk/attributes
Метод: GET
Пример запроса с использованием идентификатора категории:
524
curl -X GET "<url стенда>/nk/attributes?cat_id=30933&attr_type=m"
-H "accept: application/json"
-H "Authorization: Bearer <ТОКЕН>"
Пример запроса с использованием кода ТН ВЭД:
curl -X GET "<url стенда>/nk/attributes?tnved=3033&attr_type=m"
-H "accept: application/json"
-H "Authorization: Bearer <ТОКЕН>"
Параметры запроса:
Параметр
Тип
Обяз.
Описание
Комментарий
apikey
string
-
Параметр,
Предоставляется по запросу службой
необходимый для
технической поддержки.
авторизации и
совершения
Параметр обязательный, если в
запросов API
заголовке запроса не указан "token"
("Токен аутентификации") (см.
Единая аутентификация)
attr_type
string
-
Тип атрибута
Возможные значения:
"a" - вернуть все атрибуты
(значение по умолчанию);
"m" - вернуть только обязательные
атрибуты;
"r" - вернуть только рекомендуемые
атрибуты;
"o" - вернуть только опциональные
атрибуты
cat_id
string
-
Идентификатор
Параметр является обязательным,
любой из
если указан параметр "attr_type"
категорий
("Тип атрибута") и не указан
товаров, к
параметр "tnved" ("Код ТН ВЭД (10
которой относятся
знаков) или группы ТН ВЭД (4
атрибуты
знака), для которого запрашивается
набор атрибутов")
tnved
string
-
Код ТНВ ЭД (10
Параметр обязателен, если указан
знаков) или
параметр "attr_type" ("Тип атрибута")
группы ТН ВЭД
и не указан "cat_id" ("Идентификатор
(4 знака), для
любой из категорий товаров, к
которого
которой относятся атрибуты")
запрашивается
набор атрибутов
525
Параметр
Тип
Обяз.
Описание
Комментарий
is_set
boolean
-
Признак карточки
Используется для получения
товара типа
атрибутивного состава набора.
"Набор"
Возможные значения 1/0 (true/false).
По умолчанию = 0
Пример ответа:
1. В случае успеха:
1.1. Для формата * .json:
{
"apiversion":3,
"result":[
{
"attr_group_name":"Состав",
"attr_field_type":"text",
"attr_value_type":[
],
"attr_group_id":26,
"attr_name":"Комплектация",
"attr_id":28,
"second_layer":false,
"attr_type":"r",
"attr_preset":[
]
},
{
"attr_group_id":26,
"attr_name":"Тип материала, %",
"attr_id":741,
"second_layer":false,
"attr_type":"r",
"attr_preset":[
"АКРИЛ",
"АУТЛАСТ",
"БАМБУК",
"БАМБУКОВОЕ ВОЛОКНО",
"БУМАГА",
"ВИНИЛ",
"ВИСКОЗА",
"ИСКУССТВЕННЫЙ ЛЕН",
"ИСКУССТВЕННЫЙ МЕХ",
"ИСКУССТВЕННЫЙ ШЕЛК",
"КОМБИНАЦИЯ",
"ЛЕН",
"ПВХ",
526
"ПОЛИАМИД",
"ПОЛИЭСТЕР",
"ПОЛИУРЕТАН",
"ПОЛИЭФИР",
"РЕЗИНА",
"СИНТЕТИЧЕСКОЕ ВОЛОКНО",
"ХЛОПОК",
"ЦЕЛЛЮЛОЗА",
"ШЕЛК",
"ШЕРСТЬ",
"ЭВКАЛИПТОВОЕ ВОЛОКНО",
"ЭКОФАЙБЕР",
"НЕ КЛАССИФИЦИРОВАНО",
"НЕ ОПРЕДЕЛЕНО"
]
},
{
"attr_group_name":"Потребительские свойства",
"attr_field_type":"text",
"attr_value_type":[
],
"attr_group_id":103,
"attr_name":"Возраст потребителя",
"attr_id":557,
"second_layer":true,
"attr_type":"m",
"attr_preset":[
"ВЗРОСЛЫЙ",
"ДЕТСКИЙ",
"ЛЮБОЙ ВОЗРАСТ",
"НЕ КЛАССИФИЦИРОВАНО",
"НЕ ОПРЕДЕЛЕНО"
]
},
"..."
]
}
1.2. Для формата * .xml:
<?xml version="1.0" encoding="UTF-8"?>
<root>
<apiversion>3</apiversion>
<result>
<item>
<attr_group_name>Рекомендации производителя</attr_group_name>
<attr_field_type>text</attr_field_type>
<attr_value_type/>
<attr_group_id>69</attr_group_id>
527
<attr_name>Меры предосторожности</attr_name>
<attr_id>4003</attr_id>
<second_layer></second_layer>
<attr_type>r</attr_type>
<attr_preset>
<item>Недоступное для детей место</item>
<item>Недоступное для детей и животных место</item>
<item>Вдали от отопительных приборов</item>
<item>Вдали от легковоспламеняющихся предметов</item>
<item>Вдали от легковоспламеняющихся предметов, недоступное для
детей место</item>
<item>Вдали от отопительных приборов, недоступное для детей
место</item>
<item>Огнеопасно! Не использовать вблизи открытого огня</item>
<item>Огнеопасно! Не использовать вблизи открытого огня, хранить в
недоступном для детей месте</item>
<item>Не допускать попадания в глаза, хранить в недоступном для
детей месте</item>
<item>Огнеопасно! Хранить в недоступном для детей месте</item>
<item>Огнеопасно! Хранить в недоступном для детей месте. Избегать
попадания на кожу и в глаза. Не
смешивать с другими чистящими средствами
</item>
<item>Не смешивать с другими чистящими средствами. Избегать
попадания на кожу и в глаза. Хранить в
недоступном для детей месте
</item>
<item>Огнеопасно! Хранить вдали от источников тепла и открытого
огня. Избегать попадания в глаза</item>
<item>Избегать попадания в глаза</item>
<item>Избегать попадания на кожу и в глаза</item>
<item>Не держать у открытого огня</item>
<item>Избегать попадания на кожу и в глаза. хранить в недоступном
для детей месте</item>
<item>Хранить отдельно от пищевых продуктов в недоступном для детей
месте, избегать попадания в глаза
</item>
<item>Хранить вдали от источников тепла и открытого огня,
недоступное для детей место</item>
<item>Хранить вдали от источников тепла и огня, избегать попадания
на кожу</item>
</attr_preset>
</item>
<item>
<attr_group_name>Характеристики товара в состоянии
использования</attr_group_name>
<attr_field_type>text</attr_field_type>
<attr_value_type>
<item>см</item>
<item>мм</item>
<item>м</item>
528
</attr_value_type>
<attr_group_id>107</attr_group_id>
<attr_name>Высота изделия</attr_name>
<attr_id>13896</attr_id>
<second_layer></second_layer>
<attr_type>r</attr_type>
<attr_preset/>
</item>
<item>
<attr_group_name>Эксплуатация и условия хранения</attr_group_name>
<attr_field_type>text</attr_field_type>
<attr_value_type/>
<attr_group_id>7</attr_group_id>
<attr_name>Особые условия хранения</attr_name>
<attr_id>13884</attr_id>
<second_layer></second_layer>
<attr_type>r</attr_type>
<attr_preset/>
</item>
</result>
</root>
2. В случае ошибок:
2.1. Код 400, если одновременно указан и "apikey" в URL запроса, и аутентификационный
токен API ГИС МТ в заголовке запроса (параметр "Authorization: Bearer <token>"):
{
"error_message": "Недопустимо использование apikey вместе с <token>"
}
2.2. Код 400, если "apikey" в URL запроса и аутентификационный токен API ГИС МТ в
заголовке запроса (параметр "Authorization: Bearer <token>") одновременно не заполнены:
{
"error_message": "Отсутствует необходимый для аутентификации параметр"
}
2.3. Код 400 при ошибках в параметрах запроса:
{
"error_message":"Ошибка в параметрах запроса"
}
2.4. Код 401, если в заголовке запроса (параметр "Authorization: Bearer <token>") указан
неактуальный для аккаунта аутентификационный токен API ГИС МТ:
529
{
"error_message": "Указан неактуальный для аккаунта <token>"
}
2.5. Код 401, если истекло время действия аутентификационного токена API ГИС МТ,
указанного в заголовке запроса (параметр "Authorization: Bearer <token>"):
{
"error_message": "Время действия <token> истекло"
}
2.6. Код 403, если указан неправильный ключ API:
{
"error_message":"Отсутствует доступ к ресурсу"
}
2.7. Код 404, если не найдены атрибуты для указанной категории:
{
"error_message":"Данные не найдены"
}
2.8. Код 424, если ИНН токена не совпадает со значением ИНН аккаунта, найденного в
"Национальном каталоге":
{
"error_message": "ИНН токена не совпадает со значением ИНН найденного в НК
аккаунта"
}
Параметры ответа:
Параметр
Тип
Обяз.
Описание
Комментарий
apiversion
number
+
Номер версии API
метода
result
array
-
Результат
При наличии ответа
*attr_id
number
+
Идентификатор
атрибута
*attr_name
string
+
Наименование
атрибута
530
Параметр
Тип
Обяз.
Описание
Комментарий
*attr_group_name
string
+
Наименование
группы, к которой
относится атрибут
*attr_group_id
number
+
Идентификатор
группы, к которой
относится атрибут
*attr_value_type
array[stri
+
Массив
ng]
возможных
значений типа
атрибута
*attr_field_type
string
+
Тип значения
Возможные значения:
атрибута
"number";
"text"
*second_layer
boolean
+
Признак
Параметр обязательный, если в
принадлежности
параметрах запроса указаны
атрибута ко
параметры "attr_type" ("Тип
второму слою
атрибута"), "cat_id" ("Идентификатор
атрибутов
любой из категорий товаров, к
(атрибуты,
которой относятся атрибуты"),
необходимые для
"tnved" ("Код ТН ВЭД (10 знаков) или
ввода товаров в
группы ТН ВЭД (4 знака), для
оборот)
которого запрашивается набор
атрибутов")
*attr_preset
array[stri
+
Массив
ng]
возможных
значений атрибута
*attr_type
string
-
Тип атрибута
При наличии "cat_id"
("Идентификатор любой из категорий
товаров, к которой относятся
атрибуты") в запросе
10.3. Метод получения списка торговых марок
Метод предназначен для получения списка торговых марок. При отправке ID торговой сети в
ответе возвращаются данные о брендах.
Тип приватности: публичный
URL: /nk/brands
Метод: GET
Пример запроса:
531
curl -X GET "<url стенда>/nk/brands"
-H "accept: application/json"
-H "Authorization: Bearer <ТОКЕН>"
Параметры запроса:
Параметр
Тип
Обяз.
Описание
Комментарий
apikey
string
-
Параметр,
Предоставляется по запросу службой
необходимый для
технической поддержки. Параметр
авторизации и
обязательный, если в заголовке
совершения
запроса не указан "token" ("Токен
запросов API
аутентификации") (см. Единая
аутентификация)
name
string
-
Полное или
частичное
наименование
товарного знака
limit
number
-
Количество
Максимально допустимое значение -
записей в ответе
10000, минимально допустимое
значение - 1
offset
number
-
Смещение
Минимально допустимое значение -
относительно
0
начала выдачи
Пример ответа:
1. В случае успеха:
1.1. Для формата json:
532
{
"apiversion": 3,
"result": [
{
"brand_id": 29096,
"brand_name": "Bercatti"
},
{
"brand_id": 28964,
"brand_name": "OUTEMER"
},
{
"brand_id": 7105,
"brand_name": "Roshen"
},
{
"brand_id": 28900,
"brand_name": "PIONEER"
},
{
"brand_id": 28879,
"brand_name": "Smile of Milady"
}
]
}
1.2. Для формата xml:
533
<root>
<apiversion>3</apiversion>
<result>
<item>
<brand_id>8117</brand_id>
<brand_name>1 Сентября</brand_name>
</item>
<item>
<brand_id>6262</brand_id>
<brand_name>Nike</brand_name>
</item>
<item>
<party_brand_id>12345</party_brand_id>
<brand_id>7105</brand_id>
<brand_name>Roshen</brand_name>
</item>
<item>
<brand_id>6035</brand_id>
<brand_name>1000 секретов</brand_name>
</item>
</result>
</root>
2. В случае ошибок:
2.1. Код 400, если одновременно указан и "apikey" в URL запроса, и аутентификационный
токен API ГИС МТ в заголовке запроса (параметр "Authorization: Bearer <token>"):
{
"error_message": "Недопустимо использование apikey вместе с <token>"
}
2.2. Код 400, если "apikey" в URL запроса и аутентификационный токен API ГИС МТ в
заголовке запроса (параметр "Authorization: Bearer <token>") одновременно не заполнены:
{
"error_message": "Отсутствует необходимый для аутентификации параметр"
}
2.3. Код 401, если в заголовке запроса (параметр "Authorization: Bearer <token>") указан
неактуальный для аккаунта аутентификационный токен API ГИС МТ:
{
"error_message": "Указан неактуальный для аккаунта <token>"
}
534
2.4. Код 401, если истекло время действия аутентификационного токена API ГИС МТ,
указанного в заголовке запроса (параметр "Authorization: Bearer <token>"):
{
"error_message": "Время действия <token> истекло"
}
2.5. Код 403, если указан неправильный ключ API:
{
"error_message":"Отсутствует доступ к ресурсу"
}
2.6. Код 424, если ИНН токена не совпадает со значением ИНН аккаунта, найденного в
"Национальном каталоге":
{
"error_message": "ИНН токена не совпадает со значением ИНН найденного в НК
аккаунта"
}
Параметры ответа:
Параметр
Тип
Обяз.
Описание
Комментарий
apiversion
number
+
Номер версии API
метода
result
array
-
Результат
При наличии ответа
*brand_id
number
+
Идентификатор
товарного знака
*brand_name
string
+
Наименование
бренда
10.4. Метод получения списка субаккаунтов компании
Тип приватности: приватный
URL: /nk/linked-accounts
Метод: POST
Пример запроса:
535
curl -X POST "<url стенда>/nk/linked-accounts?format=json"
-H "accept: application/json"
-H "Authorization: Bearer <ТОКЕН>"
1. В случае успеха:
Пример ответа в формате JSON:
{
"apiversion": 3,
"result": {
"linked_accounts": [
{
"account_inn": "0000000001",
"account_name": "Общество с ограниченной ответственностью \"Ромашка\""
},
{
"account_inn": "0000000002",
"account_name": "ОБЩЕСТВО С ОГРАНИЧЕННОЙ ОТВЕТСТВЕННОСТЬЮ \"Ромашка 2\""
}
]
}
}
Пример ответа в формате JSON при отсутствии субаккаунтов:
{
"apiversion":3,
"result":{
"linked_accounts":[
]
}
}
Параметры ответа:
Параметр
Тип
Обяз.
Описание
Комментарий
apiversion
number
+
Версия API
result
object
+
Результат
При наличии ответа
*linked_acco
[array]
+
Массив
Если субаккаунты отсутствуют,
unts
субаккаунтов
возвращается пустой массив
компании
**account_in
string
+
ИНН субаккаунта
n
536
Параметр
Тип
Обяз.
Описание
Комментарий
**account_na
string
+
Наименование
me
субаккаунта
Пример ответа в формате XML:
<?xml version="1.0" encoding="UTF-8"?>
<root>
<apiversion>3</apiversion>
<result>
<linked_accounts>
<item>
<account_inn>0000000001</account_inn>
<account_name>ООО"</account_name>
</item>
<item>
<account_inn>0000000002</account_inn>
<account_name>ООО"</account_name>
</item>
</linked_accounts>
</result>
</root>
2. В случае ошибок:
2.1. Код 400, если одновременно указан и "apikey" в URL запроса, и аутентификационный
токен API ГИС МТ в заголовке запроса (параметр "Authorization: Bearer <token>"):
{
"error_message": "Недопустимо использование apikey вместе с <token>"
}
2.2. Код 400, если "apikey" в URL запроса и аутентификационный токен API ГИС МТ в
заголовке запроса (параметр "Authorization: Bearer <token>") одновременно не заполнены:
{
"error_message": "Отсутствует необходимый для аутентификации параметр"
}
2.3. Код 401, если в заголовке запроса (параметр "Authorization: Bearer <token>") указан
неактуальный для аккаунта аутентификационный токен API ГИС МТ:
{
"error_message": "Указан неактуальный для аккаунта <token>"
}
537
2.4. Код 401, если истекло время действия аутентификационного токена API ГИС МТ,
указанного в заголовке запроса (параметр "Authorization: Bearer <token>"):
{
"error_message": "Время действия <token> истекло"
}
2.5. Код 403, если указан неправильный ключ API:
{
"error_message":"Отсутствует доступ к ресурсу"
}
2.6. Код 424, если ИНН токена не совпадает со значением ИНН аккаунта, найденного в
"Национальном каталоге":
{
"error_message": "ИНН токена не совпадает со значением ИНН найденного в НК
аккаунта"
}
10.5. Метод подписи предоставления или отзыва разрешения
на использование КИ
Метод предназначен для подписи (с помощью сертификата в формате PKCS#7) предоставления
или отзыва разрешения субаккаунту на использование своих кодов товара для эмиссии КМ и
ввода товаров в оборот товара. Данные кодируются в BASE64.
Максимальное количество позиций в запросе: 100.
Тип приватности: приватный
URL: /nk/linked-accounts-sign
Метод: POST
Пример запроса:
curl -X POST "<url стенда>nk/linked-accounts-sign?format=json"
-H "accept: application/json"
-H "Content-Type: application/json"
-H "Authorization: Bearer <ТОКЕН>"
--data-raw
"[{\"linked_account_inn\":0,\"base64_xml\":\"string\",\"signature\":\"string\"}]"
Пример тела запроса:
538
[
{
"linked_account_inn": 000000001,
"base64_xml":"string",
"signature":"string"
}
]
Параметры запроса:
Параметр
Тип
Обяз.
Описание
Комментарий
apikey
string
-
Параметр,
Предоставляется по запросу службой
необходимый для
технической поддержки.
авторизации и
совершения
Параметр обязательный, если в заголовке
запросов API
запроса не указан "token" ("Токен
аутентификации") (см. Единая
аутентификация)
linked_accou
integer
+
ИНН субаккаунта
nt_inn
(int64)
base64Xml
string
+
Закодированный в
BASE64 файл в
формате XML с
формой
предоставления/о
тзыва доступа
signature
string
+
Открепленная
подпись,
закодированная в
BASE64,
соответствующая
типу CAdES в
формате PKCS7
Пример ответа:
1. В случае успеха:
539
{
"signed":[
{
"linked_account_inn":"0000000001",
"access":"allowed"
},
{
"linked_account_inn":"0000000002",
"access":"deleted"
}
],
"errors":[
{
"linked_account_inn":"0000000003",
"message":"text",
"code":"11"
}
]
}
Параметры ответа:
Параметр
Тип
Обяз.
Описание
Комментарий
signed
array[nu
+
Массив
mber]
числовых
идентификаторов
товаров, для
которых прошла
валидация и
проверка
карточки товара,
товар переведен
в статус
"Опубликован"
*linked_acco
string
+
ИНН субаккаунта
unt_inn
*access
string
+
Флаг
Возможные значения:
предоставления
allowed - предоставление доступа;
или отзыва
deleted - отзыв доступа
доступа
540
Параметр
Тип
Обяз.
Описание
Комментарий
errors
array[str
-
Массив объектов,
ing]
содержащих
идентификаторы
товара и текст
ошибки,
возникшей при
обработке
переданных XML
(закодированных
в BASE64)
*linked_acco
string
+
ИНН субаккаунта
unt_inn
*message
string
+
Текст ошибки
Возвращается в случае ошибки
*code
string
+
Код ошибки
Возвращается в случае ошибки
2. В случае ошибок:
2.1. Код 400, если одновременно указан и "apikey" в URL запроса, и аутентификационный
токен API ГИС МТ в заголовке запроса (параметр "Authorization: Bearer <token>"):
{
"error_message": "Недопустимо использование apikey вместе с <token>"
}
2.2. Код 400, если "apikey" в URL запроса и аутентификационный токен API ГИС МТ в
заголовке запроса (параметр "Authorization: Bearer <token>") одновременно не заполнены:
{
"error_message": "Отсутствует необходимый для аутентификации параметр"
}
2.3. Код 401, если в заголовке запроса (параметр "Authorization: Bearer <token>") указан
неактуальный для аккаунта аутентификационный токен API ГИС МТ:
{
"error_message": "Указан неактуальный для аккаунта <token>"
}
2.4. Код 401, если истекло время действия аутентификационного токена API ГИС МТ,
указанного в заголовке запроса (параметр "Authorization: Bearer <token>"):
{
"error_message": "Время действия <token> истекло"
}
541
2.5. Код 403, если указан неправильный ключ API:
{
"error_message":"Отсутствует доступ к ресурсу"
}
2.6. Код 424, если ИНН токена не совпадает со значением ИНН аккаунта, найденного в
"Национальном каталоге":
{
"error_message": "ИНН токена не совпадает со значением ИНН найденного в НК
аккаунта"
}
10.6. Метод получения файла в формате XML для
управления доступами субаккаунтов
Метод возвращает файл в формате XML, необходимый для управления доступами субаккаунтов.
Полученный файл необходимо подписать: то есть предоставить или отозвать доступ для
субакканута.
Тип приватности: приватный
URL: /nk/linked-accounts-documents
Метод: POST
Пример запроса:
curl -X POST "<url стенда>/nk/linked-accounts-documents?format=json"
-H "accept: application/json"
-H "Content-Type: application/json"
-H "Authorization: Bearer <ТОКЕН>"
--data-raw "[{\"linked_account_inn\":\"string\",\"is_access_allowed\":true}]"
Пример запроса в формате JSON:
542
[
{
"linked_account_inn":"6310000012",
"linked_goods":[
"04600000000001",
"04600000000002"
],
"is_access_allowed":true
}
]
Пример запроса в формате XML:
<?xml version="1.0" encoding="UTF-8"?>
<account>
<schemaVersion>6.0</schemaVersion>
<mainAccountInn>0000000001</mainAccountInn>
<linkedAccountInn>0000000002</linkedAccountInn>
<isAccessAllowed value=“1”>Я разрешаю 0000000002 использовать свои коды товара для
заказа кодов маркировки и ввода товаров в оборот</isAccessAllowed>
</account>
</xml>
Параметры запроса:
Параметр
Тип
Обяз.
Описание
Комментарий
apikey
string
-
Параметр,
Предоставляется по запросу службой
необходимый для
технической поддержки.
авторизации и
совершения
Параметр обязательный, если в заголовке
запросов API
запроса не указан "token" ("Токен
аутентификации") (см. Единая
аутентификация)
linked_accou
string
+
ИНН субаккаунта
nt_inn
is_access_allo
boolean
+
Признак
Возможные значения:
wed
отзыва/предостав
false - отзыв разрешения у субаккаунта на
ления разрешения
использование своих кодов товара для
заказа кодов маркировки и ввода товаров в
оборот;
true - предоставление разрешения
субаккаунту использовать свои коды
товара для заказа кодов маркировки и
ввода товаров в оборот
543
Параметр
Тип
Обяз.
Описание
Комментарий
mainAccountI
string
+
ИНН
nn
родительского
аккаунта
linkedAccoun
string
+
ИНН субаккаунта
tInn
isAccessAllo
string
+
Код согласия и
Возможные значения:
wed
текст кода
Value[0] - Я отзываю разрешение ИНН
использовать свои коды товара для заказа
кодов маркировки и ввода товаров в
оборот;
Value[1] - Я разрешаю ИНН использовать
свои коды товара для заказа кодов
маркировки и ввода товаров в оборот
Пример ответа в формате JSON в случае успеха:
{
"result":{
"xmls":[
{
"linked_account_inn":"0000000001",
"xml":"<?xml version=\"1.0\" encoding=\"UTF-
8\"?>\n<account><schemaVersion>6.0</schemaVersion><mainAccountInn>0000000002</mainAcco
untInn><linkedAccountInn>7731369928</linkedAccountInn><isAccessAllowed value=\"1\">Я
разрешаю 0000000001 использовать свои коды товара для заказа кодов маркировки и ввода
товаров в оборот</isAccessAllowed></account>\n"
}
]
}
}
Пример ответа в формате JSON в случае ошибки:
{
"result": {
"xmls": [],
"errors": [
{
"linked_account_inn": "0000000003",
"message": "Для ИНН:0000000003 еще не был предоставлен доступ ко всем Кодам
Товаров.",
"code": 99
}
]
}
}
544
Пример ответа в формате XML:
<?xml version="1.0" encoding="UTF-8"?>
<root>
<apiversion>3</apiversion>
<result>
<xmls>
<item>
<linked_account_inn>0000000001</linked_account_inn>
<xml><?xml version="1.0" encoding="UTF-8"?>
<account><schemaVersion>6.0</schemaVersion><mainAccountInn>0000000002</mainAccountInn>
<linkedAccountInn>0000000001</linkedAccountInn><isAccessAllowed value="1">Я разрешаю
0000000001 использовать свои коды товара для заказа кодов маркировки и ввода товаров в
оборот</isAccessAllowed></account>
</xml>
</item>
</xmls>
</result>
</root>
Параметры ответа:
Параметр
Тип
Обяз.
Описание
Комментарий
result
object
+
При наличии
ответа
*xmls
array
+
Массив объектов
Параметр возвращается только в случае
успешного запроса (найден хотя бы один
массив объектов)
*errors
array[stri
-
Массив ошибок,
ng]
обнаруженных
при валидации
контента
**linked_acc
string
+
ИНН субаккаунта
ount_inn
**message
string
+
Текст ошибки
Возвращается в случае ошибки
**code
string
+
Числовой код
ошибки
Возможные ошибки:
1. Код 400, если одновременно указан и "apikey" в URL запроса, и аутентификационный токен
API ГИС МТ в заголовке запроса (параметр "Authorization: Bearer <token>"):
{
"error_message": "Недопустимо использование apikey вместе с <token>"
}
545
2.
Код 400, если "apikey" в URL запроса и аутентификационный токен API ГИС МТ в заголовке
запроса (параметр "Authorization: Bearer <token>") одновременно не заполнены:
{
"error_message": "Отсутствует необходимый для аутентификации параметр"
}
3.
Код 401, если в заголовке запроса (параметр "Authorization: Bearer <token>") указан
неактуальный для аккаунта аутентификационный токен API ГИС МТ:
{
"error_message": "Указан неактуальный для аккаунта <token>"
}
4.
Код 401, если истекло время действия аутентификационного токена API ГИС МТ, указанного
в заголовке запроса (параметр "Authorization: Bearer <token>"):
{
"error_message": "Время действия <token> истекло"
}
5.
Код 403, если указан неправильный ключ API:
{
"error_message":"Отсутствует доступ к ресурсу"
}
6.
Код 424, если ИНН токена не совпадает со значением ИНН аккаунта, найденного в
"Национальном каталоге":
{
"error_message": "ИНН токена не совпадает со значением ИНН найденного в НК
аккаунта"
}
10.7. Метод получения дерева категорий (корень дерева не
возвращается)
Метод предназначен для получения дерева категорий без корня дерева. В ответе возвращается
список данных о каждом элементе дерева категорий.
Тип приватности: публичный
URL: /nk/categories
546
Метод: GET
Пример запроса:
curl -X GET "<url стенда>/nk/categories"
-H "accept: application/json"
-H "Authorization: Bearer <ТОКЕН>"
Параметры запроса:
Параметр
Тип
Обяз.
Описание
Комментарий
apikey
string
-
Параметр,
Предоставляется по запросу службой
необходимый для
технической поддержки. Параметр
авторизации и
обязательный, если в заголовке
совершения
запроса не указан "token" ("Токен
запросов API
аутентификации") (см. Единая
аутентификация)
cat_id
number
-
Идентификатор
категории
Пример ответа:
1. В случае успеха:
1.1 Для формата * .json:
{
"apiversion":3,
"result":[
{
"cat_id":14001,
"cat_name":"Продукты питания",
"cat_parent_id":14000,
"cat_level":"1"
},
{
"cat_id":14002,
"cat_name":"Напитки",
"cat_parent_id":14001,
"cat_level":2
}
]
}
1.2 Для формата * .xml:
547
<?xml version="1.0" encoding="UTF-8"?>
<root>
<apiversion>3</apiversion>
<result>
<item>
<cat_id>14002</cat_id>
<cat_name>Напитки</cat_name>
<cat_parent_id>14000</cat_parent_id>
<cat_level>2</cat_level>
</item>
<item>
<cat_id>14001</cat_id>
<cat_name>Питание</cat_name>
<cat_parent_id>14000</cat_parent_id>
<cat_level>2</cat_level>
</item>
</result>
</root>
2. В случае ошибок:
2.1. Код 400, если одновременно указан и "apikey" в URL запроса, и аутентификационный
токен API ГИС МТ в заголовке запроса (параметр "Authorization: Bearer <token>"):
{
"error_message": "Недопустимо использование apikey вместе с <token>"
}
2.2. Код 400, если "apikey" в URL запроса и аутентификационный токен API ГИС МТ в
заголовке запроса (параметр "Authorization: Bearer <token>") одновременно не заполнены:
{
"error_message": "Отсутствует необходимый для аутентификации параметр"
}
2.3. Код 401, если в заголовке запроса (параметр "Authorization: Bearer <token>") указан
неактуальный для аккаунта аутентификационный токен API ГИС МТ:
{
"error_message": "Указан неактуальный для аккаунта <token>"
}
2.4. Код 401, если истекло время действия аутентификационного токена API ГИС МТ,
указанного в заголовке запроса (параметр "Authorization: Bearer <token>"):
548
{
"error_message": "Время действия <token> истекло"
}
2.5. Код 403, если указан неправильный ключ API:
{
"error_message":"Отсутствует доступ к ресурсу"
}
2.6. Код 424, если ИНН токена не совпадает со значением ИНН аккаунта, найденного в
"Национальном каталоге":
{
"error_message": "ИНН токена не совпадает со значением ИНН найденного в НК
аккаунта"
}
Параметры ответа:
Параметр
Тип
Обяз.
Описание
Комментарий
apiversion
number
+
Версия API
result
array
-
Результат
При наличии ответа
*cat_id
number
+
Идентификатор
любой из
категорий товаров
*cat_name
string
+
Наименование
категории
*cat_parent_id
number
+
Идентификатор
родительской
категории
*cat_level
string
+
Уровень в дереве
категорий
*category_active
boolean
-
Признак
Принимает значения 1/0 (true/false)
активности
категории
549
Параметр
Тип
Обяз.
Описание
Комментарий
*gismt_codes
array
-
Код маркируемой
При наличии зависимости
товарной группы
возможные варианты:
1 - предметы одежды, бельё
постельное, столовое, туалетное и
кухонное;
2 - обувные товары;
3 - табачная продукция;
4 - духи и туалетная вода;
5 - шины и покрышки
пневматические резиновые новые;
6 - фотокамеры (кроме кинокамер),
фотовспышки и лампы-вспышки;
8 - молочная продукция;
9 - велосипеды и велосипедные
рамы;
10 - кресла-коляски;
12 - альтернативная табачная
продукция;
13 - упакованная вода
10.8. Метод получения полной информации о товаре
Метод возвращает краткую или полную информацию о продукте (товаре). Требует обязательного
указания одного из следующих параметров: идентификатор товара или код товара (штрих-код)
товара.
Если указан один из параметров gtin или good_id и один из параметров gtins или good_ids, то
возвращается ошибка 400.
Если указаны оба обязательных параметра, то возвращается результат выборки,
соответствующий параметру good_id. Если карточка товара с данным идентификатором не
обнаружена, то возвращается ошибка 404 независимо от указания кода товара в запросе.
Тип приватности: публичный
URL: /nk/product
Метод: GET
Пример запроса:
curl -X GET "<url стенда>/nk/product?gtin=0000000000000"
-H "accept: application/json"
-H "Authorization: Bearer <ТОКЕН>"
Параметры запроса:
550
Параметр
Тип
Обяз.
Описание
Комментарий
apikey
string
-
Параметр,
Предоставляется по запросу службой
необходимый для
технической поддержки.
авторизации и
совершения
Параметр обязательный, если в
запросов API
заголовке запроса не указан "token"
("Токен аутентификации") (см.
Единая аутентификация)
good_id
string
-
идентификатор
Обязательно, если не указан gtin
товара в каталоге
gtin
string
-
Глобальный код
Обязательно, если не указан good_id
товара (штрих-
код)
product_name
string
-
Название
Используется при запросе на поиск
продукта
отсутствующего товара
cat_id
string
-
Идентификатор
Используется при запросе на поиск
любой из
отсутствующего товара
категорий товаров
gtins
string
-
Список кодов
Обязательно, если не указаны
товара в каталоге
good_id, good_ids, gtin
с разделителем в
виде ";"
good_ids
string
-
список
Обязательно, если не указаны gtin,
идентификаторов
good_id, gtins
товара в каталоге
с разделителем в
виде ";"
Параметры ответа:
Параметр
Тип
Обяз.
Описание
Комментарий
apiversion
number
+
Номер версии API
метода
result
[array]
+
Результат
При наличии ответа
*identified_by
[array]
+
массив
содержащий
информацию о
штрих-кодах
**value
string
+
штрих-код или
локальный
идентификатор
551
Параметр
Тип
Обяз.
Описание
Комментарий
**type
string
+
Тип
Возможные значения:
идентификатора
"gtin"
- глобальный код товара
(штрих-код);
"barcode"
- штрих-код Barcode
(штрихкод
с
неправильной
контрольной цифрой)
**party_id
string
-
Идентификатор
возвращается только при условии,
торговой сети
что параметр type имеет значение
barcode.
**multiplier
number
+
Количество
Значение по умолчанию = 1
товаров в
упаковке
**level
string
+
Тип упаковки
Возможные значения:
(уровень
"trade-unit" - штука;
упаковки)
"box" - коробка;
"layer" - слой на палете;
"pallet" - палета;
"metro-unit" - метро-юнит;
"show-pack" - шоу-пак;
"inner-pack" - спайка
*good_id
number
+
Идентификатор
товара
*good_name
string
+
Наименование
товара
*good_img
string
+
Изображение
товара
*categories
[array]
+
Массив категорий
**cat_id
number
+
Идентификатор
любой из
категорий
товаров, в
которой
расположен товар,
исключая
родителей этой
категории
**cat_name
string
+
Наименование
категории, в
которой
расположен товар
и/или
552
Параметр
Тип
Обяз.
Описание
Комментарий
**party_cat_id
number
+
Идентификатор
Только для владельца сети, если
категории
указан party_id в запросе
торговой сети, в
которой
расположен товар
**party_cat_name
string
+
Наименование
категории
торговой сети, в
которой
расположен товар
*party_brand_id
string
-
Идентификатор
Только для владельца сети, если
бренда для
указан party_id в запросе
торговой сети
*brand_id
number
+
Идентификатор
товарного знака
*brand_name
string
+
Наименование
бренда
*good_rating
number
+
Рейтинг товара
*good_images
array
+
Массив с
изображениями
**photo_type
string
+
тип фотографии
Возможные значения:
"default"
-
фотография
по
умолчанию (вид спереди);
"facing"
- crop-фотография для
планограмм (обрезанная по контуру
товара);
"left" - фотография товара слева;
"right" - фотография товара справа;
"back" - фотография товара сзади;
"3ds" - 3D серия;
"marketing"
-
коммерческая
фотография товара;
"ecommerce" - e-commerce фото;
"undef" - single shot, фотография
товара с не предопределенного
ракурса;
"cubi" - фотография измерения ВГХ
**photo_date
string
+
дата создания
UTC yyyy-MM-ddTHH:mm:ss.SSS’Z
(date-
фотографии
time)
**photo_url
[string]
+
ссылка на med
(medium) размер
фотографии
553
Параметр
Тип
Обяз.
Описание
Комментарий
**barcode
string
-
штрихкод или
артикул товара,
для которого
сделана
фотография
*good_attrs
array
-
Массив атрибутов
Приватные атрибуты отдаются только
те, которые принадлежат аккаунту
apikey
**attr_id
number
+
Идентификатор
атрибута
**attr_name
string
+
Наименование
атрибута
**attr_value_id
string
-
Идентификатор
значения атрибута
**attr_value
string
+
Значение
атрибута
**value_id
number
+
Идентификатор
значения атрибута
**attr_value_type
array[stri
+
Массив
ng]
возможных
значений типа
атрибута
**attr_group_id
number
+
Идентификатор
группы, к которой
относится атрибут
**attr_group_name
string
+
Наименование
группы, к которой
относится атрибут
**measure_date
string
-
Дата измерения
UTC. yyyy-MM-ddTHH:mm:ss.SSS’Z
(date-
атрибута
time)
**published_date
string
-
Дата публикации
UTC.yyyy-MM-ddTHH:mm:ss.SSS’Z
(date-
атрибута
time)
**effective_date
string
-
Дата, с которой
UTC. yyyy-MM-ddTHH:mm:ss.SSS’Z
(date-
действительно
time)
значение
атрибута
**expired_date
string
-
Дата, с которой
UTC. yyyy-MM-ddTHH:mm:ss.SSS’Z
(date-
недействительно
time)
значение
атрибута
554
Параметр
Тип
Обяз.
Описание
Комментарий
**location_id
string
-
Идентификатор
локации, в
которой было
проведено
измерение
**party_location_i
string
-
Внутренний
Отображается только компании,
d
идентификатор
которой принадлежит локация
локации для
компании, в
которой было
проведено
измерение
**level
string
-
Уровень упаковки
**gtin
string
-
код товара
(Штрих-код)
**multiplier
number
-
Мультипликатор
**certificate_numb
string
-
номер
Только у атрибутов из группы
er
сертификата
"Сертификаты"
**certificate_issue
string
-
Дата начала срока
yyyy-MM-ddTHH:mm:ss.SSS’Z
d_date
(date-
действия
time)
**certificate_valid
string
-
Дата окончания
yyyy-MM-ddTHH:mm:ss.SSS’Z
_until_date
(date-
срока действия
time)
**certificate_appli
string
-
Заявитель
cant
**certificate_manu
string
-
Изготовитель
facturer
**certificate_produ
string
-
Продукция
ct_description
*good_reviews
array
+
Массив с
отзывами
**review_id
number
+
идентификатор
отзыва
**review_author
string
+
автор (имя,
фамилия,
псевдоним)
**review_rating
number
+
рейтинг отзыва
**review_text
string
+
текст отзыва
555
Параметр
Тип
Обяз.
Описание
Комментарий
**review_date
string
+
дата создания
UTC. yyyy-MM-ddTHH:mm:ss.SSS’Z
(date-
отзыва
time)
**review_author_i
string
+
ссылка на
mg
фотографию
автора
**review_replies
array
-
Массив с
Если отзыв имеет ответы (т.е. отзывы
отзывами
с review_parent_id = review_id
данного/родительского отзыва)
*good_reviews_co
number
+
Количество
unt
отзывов
*good_url
string
+
Ссылка на
страницу товара
*good_prices
array
+
Массив цен на
товар по
торговым сетям
данного аккаунта
**party_id
number
+
Идентификатор
торговой сети
**address
array
+
Местонахождение
***country
string
+
Название страны
ISO 3166-2
***city
string
+
Название города
***street
string
+
Название улицы,
дом
***location
array
+
Координаты
* ***lat
string
+
Географическая
широта
* ***lon
string
+
Географическая
долгота
Пример ответа:
1. В случае успеха:
1.1. Для формата json:
{
"kit": true,
"good_id": 0,
"identified_by": [
{
"value": "string",
"type": "string",
556
"multiplier": 0,
"level": "string"
}
],
"good_name": "string",
"is_kit": true,
"good_url": "string",
"good_img": "string",
"categories": [
{
"cat_id": 0,
"cat_name": "string"
}
],
"brand_id": 0,
"brand_name": "string",
"good_rating": 0,
"good_images": [
{
"photo_type": "string",
"photo_date": "string",
"photo_url": {},
"barcode": "string"
}
],
"good_attrs": [
{
"attr_id": 0,
"attr_name": "string",
"attr_value": "string",
"value_id": 0,
"attr_value_type": "string",
"attr_group_id": 0,
"attr_group_name": "string",
"level": "string",
"gtin": "string",
"multiplier": 0
}
],
"good_reviews": [
{
"review_id": 0,
"review_author": "string",
"review_rating": 0,
"review_text": "string",
"review_date": "string",
"review_author_img": "string",
"review_replies": [
"string"
]
}
557
],
"good_reviews_count": 0,
"good_prices": [
{
"party_id": 0,
"address": {
"country": "string",
"city": "string",
"street": "string",
"location": {
"lat": "string",
"lon": "string"
}
}
}
]
}
1.2. Для формата xml:
<?xml version="1.0" encoding="UTF-8"?>
<root>
<apiversion>3</apiversion>
<result>
<item>
<good_id>672136</good_id>
<identified_by>
<item>
<value>11033</value>
<type>gtin</type>
<multiplier>1</multiplier>
<good_id>672136</good_id>
<level>trade-unit</level>
</item>
<item>
<value>24823002000164</value>
<type>gtin</type>
<multiplier>12</multiplier>
<good_id>672136</good_id>
<level>box</level>
</item>
</identified_by>
<good_name>Gala стиральный порошoк авт. 1,5кг. Горная
лаванда</good_name>
poroshok-avt-15kg-svizhist-girskoi-lavandi</good_url>
f86b-65a0e37da584.jpg</good_img>
<categories>
<item>
558
<cat_id>14786</cat_id>
<cat_name>Порошки</cat_name>
</item>
<item>
<party_cat_id>241000</party_cat_id>
<party_cat_name>Порошки</party_cat_name>
</item>
</categories>
<brand_id></brand_id>
<brand_name></brand_name>
<good_rating>4,33333</good_rating>
<good_images>
<item>
<photo_type>default</photo_type>
<photo_date>2016-07-20T16:26:30+00:00</photo_date>
db33-f86b-65a0e37da584.jpg</photo_url>
<barcode>6437005056338</barcode>
</item>
<item>
<photo_type>3ds</photo_type>
<photo_date>2016-07-20T16:26:30+00:00</photo_date>
<photo_url>
b0be-db33-f86b-65a0e37da584.3d.0.jpg</item>
b0be-db33-f86b-65a0e37da584.3d.1.jpg</item>
b0be-db33-f86b-65a0e37da584.3d.2.jpg</item>
b0be-db33-f86b-65a0e37da584.3d.3.jpg</item>
b0be-db33-f86b-65a0e37da584.3d.4.jpg</item>
b0be-db33-f86b-65a0e37da584.3d.5.jpg</item>
b0be-db33-f86b-65a0e37da584.3d.6.jpg</item>
b0be-db33-f86b-65a0e37da584.3d.7.jpg</item>
b0be-db33-f86b-65a0e37da584.3d.8.jpg</item>
b0be-db33-f86b-65a0e37da584.3d.9.jpg</item>
b0be-db33-f86b-65a0e37da584.3d.10.jpg</item>
b0be-db33-f86b-65a0e37da584.3d.11.jpg</item>
b0be-db33-f86b-65a0e37da584.3d.12.jpg</item>
b0be-db33-f86b-65a0e37da584.3d.13.jpg</item>
559
b0be-db33-f86b-65a0e37da584.3d.14.jpg</item>
b0be-db33-f86b-65a0e37da584.3d.15.jpg</item>
b0be-db33-f86b-65a0e37da584.3d.16.jpg</item>
b0be-db33-f86b-65a0e37da584.3d.17.jpg</item>
b0be-db33-f86b-65a0e37da584.3d.18.jpg</item>
b0be-db33-f86b-65a0e37da584.3d.19.jpg</item>
b0be-db33-f86b-65a0e37da584.3d.20.jpg</item>
b0be-db33-f86b-65a0e37da584.3d.21.jpg</item>
b0be-db33-f86b-65a0e37da584.3d.22.jpg</item>
b0be-db33-f86b-65a0e37da584.3d.23.jpg</item>
</photo_url>
<barcode>6437005056338</barcode>
</item>
<item>
<photo_type>left</photo_type>
<photo_date>2016-07-20T16:26:30+00:00</photo_date>
db33-f86b-65a0e37da584.6.jpg</photo_url>
<barcode>6437005056338</barcode>
</item>
<item>
<photo_type>right</photo_type>
<photo_date>2016-07-20T16:26:30+00:00</photo_date>
db33-f86b-65a0e37da584.18.jpg</photo_url>
<barcode>6437005056338</barcode>
</item>
<item>
<photo_type>back</photo_type>
<photo_date>2016-07-20T16:26:30+00:00</photo_date>
db33-f86b-65a0e37da584.12.jpg</photo_url>
<barcode>6437005056338</barcode>
</item>
</good_images>
<good_attrs>
<item>
<attr_id>18</attr_id>
<attr_name>Вес брутто</attr_name>
<attr_value>1.506</attr_value>
<value_id>7824938</value_id>
560
<attr_value_type>кг</attr_value_type>
<attr_group_id>19</attr_group_id>
<attr_group_name>Cubiscan-атрибуты</attr_group_name>
<measure_date>2018-02-01T16:39:04+00:00</measure_date>
<published_date>2018-02-03T13:22:11+00:00</published_date>
<effective_date>2018-02-05T16:39:04+00:00</effective_date>
<expired_date>2018-08-05T16:39:04+00:00</expired_date>
<location_id>532</location_id>
<party_location_id>Store #53</party_location_id>
<level>trade-unit</level>
<gtin>4011200255905</gtin>
<multiplier>1.00</multiplier>
</item>
<item>
<attr_id>19</attr_id>
<attr_name>Высота</attr_name>
<attr_value>29.2</attr_value>
<value_id>8214928</value_id>
<attr_value_type>см</attr_value_type>
<attr_group_id>19</attr_group_id>
<attr_group_name>Cubiscan-атрибуты</attr_group_name>
<measure_date>2018-02-01T16:39:04+00:00</measure_date>
<published_date>2018-02-03T13:22:11+00:00</published_date>
<effective_date>2018-02-05T16:39:04+00:00</effective_date>
<expired_date>2018-08-05T16:39:04+00:00</expired_date>
<location_id>532</location_id>
<party_location_id>Store #53</party_location_id>
<level>trade-unit</level>
<gtin>4011200255905</gtin>
<multiplier>1.00</multiplier>
</item>
<item>
<attr_id>20</attr_id>
<attr_name>Глубина</attr_name>
<attr_value></attr_value>
<value_id>5325635</value_id>
<attr_value_type>см</attr_value_type>
<attr_group_id>19</attr_group_id>
<attr_group_name>Cubiscan-атрибуты</attr_group_name>
<measure_date>2018-02-01T16:39:04+00:00</measure_date>
<published_date>2018-02-03T13:22:11+00:00</published_date>
<effective_date>2018-02-05T16:39:04+00:00</effective_date>
<expired_date>2018-08-05T16:39:04+00:00</expired_date>
<location_id>532</location_id>
<party_location_id>Store #53</party_location_id>
<level>trade-unit</level>
<gtin>4011200255905</gtin>
<multiplier>1.00</multiplier>
</item>
<item>
<attr_id>21</attr_id>
561
<attr_name>Ширина</attr_name>
<attr_value>20.7</attr_value>
<value_id>1224735</value_id>
<attr_value_type>см</attr_value_type>
<attr_group_id>19</attr_group_id>
<attr_group_name>Cubiscan-атрибуты</attr_group_name>
<measure_date>2018-02-01T16:39:04+00:00</measure_date>
<published_date>2018-02-03T13:22:11+00:00</published_date>
<effective_date>2018-02-05T16:39:04+00:00</effective_date>
<expired_date>2018-08-05T16:39:04+00:00</expired_date>
<location_id>532</location_id>
<party_location_id>Store #53</party_location_id>
<level>trade-unit</level>
<gtin>4011200255905</gtin>
<multiplier>1.00</multiplier>
</item>
<item>
<attr_id>2503</attr_id>
<attr_name>Производитель</attr_name>
<attr_value_id>3408</attr_value>
<value_id>7812631</value_id>
<attr_value>ООО ООО</attr_value>
<attr_value_type></attr_value_type>
<attr_group_id>25</attr_group_id>
<attr_group_name>Стороны</attr_group_name>
<published_date>2017-12-10 15:35:08</published_date>
<location_id>532</location_id>
<party_location_id>Store #53</party_location_id>
</item>
<item>
<attr_id>2813</attr_id>
<attr_name>Единый реестр сертификатов соответствия</attr_name>
<attr_value>https://национальный-
каталог.рф/certificates/86F13A2714824C4B93545560F7D1CCC1</attr_value>
<value_id>1624735</value_id>
<attr_group_id>41</attr_group_id>
<attr_group_name>Сертификаты</attr_group_name>
<published_date>2017-12-15 17:14:01</published_date>
<location_id>532</location_id>
<party_location_id>Store #53</party_location_id>
<certificate_number>С-RU.АЮ64.В.01026</certificate_number>
<certificate_issued_date>24.07.2017</certificate_issued_date>
<certificate_valid_until_date>23.07.2022</certificate_valid_until_date>
<certificate_applicant>Общество с ограниченной ответственностью
"Производственная компания "Севкабель"</certificate_applicant>
<certificate_manufacturer>Общество с ограниченной
ответственностью "Производственная компания "Севкабель"</certificate_manufacturer>
<certificate_product_description>Кабель судовой безгалогенный,
не распространяющий горение...</certificate_product_description>
</item>
562
</good_attrs>
<good_reviews>
<item>
<review_id>286</review_id>
<review_author>Evgeniy</review_author>
<review_rating>4</review_rating>
<review_text>Отлично!</review_text>
<review_date>2016-11-28T09:31:54+00:00</review_date>
<review_author_img>https://lh5.googleusercontent.com/-
F0rhYj_uC6o/AAAAAAAAAAI/AAAAAAAAFUs/_nuL7XLXK88/photo.jpg?sz=50</review_author_img>
<review_replies>
<item>
<review_id>288</review_id>
<review_author>Maxim</review_author>
<review_rating>4</review_rating>
<review_text>Perfect!!!</review_text>
<review_date>2016-11-28T09:49:39+00:00</review_date>
<review_author_img>https://lh5.googleusercontent.com/-
F0rhYj_uC6o/AAAAAAAAAAI/AAAAAAAAFUs/_nuL7XLXK88/photo.jpg?sz=50</review_author_img>
</item>
</review_replies>
</item>
<item>
<review_id>282</review_id>
<review_author>Maria Moryakina</review_author>
<review_rating>5</review_rating>
<review_text>Вкусно пахнет</review_text>
<review_date>2016-11-17T11:19:48+00:00</review_date>
<review_author_img>https://scontent.xx.fbcdn.net/v/t1.0-
1/c0.17.100.100/p100x100/14102384_286143021757109_2710809744588865430_n.jpg?oh=2eb1
e9f751c01e58c7b9fdc76dc7153b&oe=58F8B7F4</review_author_img>
</item>
</good_reviews>
<good_reviews_count>3</good_reviews_count>
<good_prices/>
</item>
</result>
</root>
2. В случае ошибок:
2.1. Код 400, если одновременно указан и "apikey" в URL запроса, и аутентификационный
токен API ГИС МТ в заголовке запроса (параметр "Authorization: Bearer <token>"):
{
"error_message": "Недопустимо использование apikey вместе с <token>"
}
2.2. Код 400, если "apikey" в URL запроса и аутентификационный токен API ГИС МТ в
заголовке запроса (параметр "Authorization: Bearer <token>") одновременно не заполнены:
563
{
"error_message": "Отсутствует необходимый для аутентификации параметр"
}
2.3. Код 400, если пропущен обязательный параметр или недопустимое значение параметра:
{
"error_message": "Ошибка в параметрах запроса"
}
2.4. Код 401, если в заголовке запроса (параметр "Authorization: Bearer <token>") указан
неактуальный для аккаунта аутентификационный токен API ГИС МТ:
{
"error_message": "Указан неактуальный для аккаунта <token>"
}
2.5. Код 401, если истекло время действия аутентификационного токена API ГИС МТ,
указанного в заголовке запроса (параметр "Authorization: Bearer <token>"):
{
"error_message": "Время действия <token> истекло"
}
2.6. Код 403, если указан неправильный ключ API:
{
"error_message":"Отсутствует доступ к ресурсу"
}
2.7. Код 404, если не найден продукт:
{
"error_message": "Данные не найдены"
}
2.8. Код 424, если ИНН токена не совпадает со значением ИНН аккаунта, найденного в
"Национальном каталоге":
{
"error_message": "ИНН токена не совпадает со значением ИНН найденного в НК
аккаунта"
}
564
10.9. Метод получения краткой информации о товаре
Метод возвращает краткую или полную информацию о продукте (товаре). Требует обязательного
указания одного из следующих параметров: идентификатор товара, код товара (штрих-код) с
указанием идентификатора торговой сети, который относится к запрашиваемому аккаунту.
Если указаны более одного из обязательных параметров, то возвращается результат выборки,
соответствующий данному алгоритму:
good_id - при указании, возвращается товар с соответствующим идентификатором или ошибка
404. При этом код товара (штрих код) игнорируется.
gtin - при указании, возвращается товар с соответствующим кодом товара (штрих код) или
ошибка 404.
gtins и good_ids - при указании, возвращается результат выборки по обоим параметрам.
При указании одного из параметров gtin или good_id и одного из параметров gtins или good_ids,
возвращается ошибка 400.
Тип приватности: публичный
URL: /nk/short-product
Метод: GET
Пример запроса:
curl -X GET "<url стенда>/nk/short-product?gtin=0000000000000"
-H "accept: application/json"
-H "Authorization: Bearer <ТОКЕН>"
Параметры запроса:
Параметр
Тип
Обяз.
Описание
Комментарий
apikey
string
-
Параметр,
Предоставляется по запросу службой
необходимый для
технической поддержки.
авторизации и
совершения
Параметр обязательный, если в
запросов API
заголовке запроса не указан "token"
("Токен аутентификации") (см.
Единая аутентификация)
good_id
string
-
Идентификатор
Обязательно, если не указан gtin
товара в каталоге
gtin
string
-
Глобальный код
Обязательно, если не указан good_id
товара (штрих-
код)
product_name
string
-
Название
Используется при запросе на поиск
продукта
отсутствующего товара
cat_id
string
-
Идентификатор
Используется при запросе на поиск
любой из
отсутствующего товара
категорий товаров
565
Параметр
Тип
Обяз.
Описание
Комментарий
gtins
string
-
Список кодов
Обязательно, если не указаны
товара в каталоге
good_id, good_ids, gtin
с разделителем в
виде ";"
good_ids
string
-
Список
Обязательно, если не указаны gtin,
идентификаторов
good_id, gtins
товара в каталоге
с разделителем в
виде ";"
Параметры ответа:
Параметр
Тип
Обяз.
Описание
Комментарий
apiversion
number
+
Номер версии API
метода
result
[array]
-
Результат
При наличии ответа
*identified_by
[array]
+
массив
содержащий
информацию о
штрих-кодах
**value
string
+
штрих-код или
локальный
идентификатор
**type
string
+
Тип
Возможные значения:
идентификатора
"gtin"
- глобальный код товара
(штрих-код);
"barcode"
- штрих-код Barcode
(штрихкод
с
неправильной
контрольной цифрой)
**party_id
string
-
Идентификатор
возвращается только при условии,
торговой сети
что параметр type имеет значение
barcode.
**multiplier
number
+
Количество
Значение по умолчанию = 1
товаров в
упаковке
**level
string
+
Тип упаковки
Возможные значения:
(уровень
"trade-unit" - штука;
упаковки)
"box" - коробка;
"layer" - слой на палете;
"pallet" - палета;
"metro-unit" - метро-юнит;
"show-pack" - шоу-пак;
"inner-pack" - спайка
566
Параметр
Тип
Обяз.
Описание
Комментарий
*categories
+
Массив категорий
**cat_id
number
+
Идентификатор
любой из
категорий
товаров, в
которой
расположен товар,
исключая
родителей этой
категории
**cat_name
string
+
Наименование
категории, в
которой
расположен товар
и/или
**party_cat_id
number
+
Идентификатор
Только для владельца сети, если
категории
указан party_id в запросе
торговой сети, в
которой
расположен товар
**party_cat_name
string
-
Наименование
категории
торговой сети, в
которой
расположен товар
*good_images
array
+
Массив с
изображениями
**photo_type
string
+
тип фотографии
Принимает значение
- "facing"
-
crop-фотография для планограмм
(обрезанная по контуру товара)
**photo_date
string
+
дата создания
UTC. yyyy-MM-ddTHH:mm:ss.SSS’Z
(date-
фотографии
time)
**photo_url
[string]
+
ссылка на med
(medium) размер
фотографии
**barcode
string
-
штрихкод или
артикул товара,
для которого
сделана
фотография
*good_attrs
array
-
Массив атрибутов
Приватные атрибуты отдаются только
те, которые принадлежат аккаунту
apikey
567
Параметр
Тип
Обяз.
Описание
Комментарий
**attr_id
number
+
Идентификатор
атрибута
**attr_name
string
+
Наименование
атрибута
**attr_value_id
string
-
Идентификатор
значения атрибута
**attr_value
string
+
Значение
атрибута
**value_id
number
-
Идентификатор
значения атрибута
**attr_value_type
array[stri
+
Массив
ng]
возможных
значений типа
атрибута
**attr_group_id
number
+
Идентификатор
группы, к которой
относится атрибут
**attr_group_name
string
+
Наименование
группы, к которой
относится атрибут
**measure_date
string
-
Дата измерения
UTC. yyyy-MM-ddTHH:mm:ss.SSS’Z
(date-
атрибута
time)
**published_date
string
-
Дата публикации
UTC.yyyy-MM-ddTHH:mm:ss.SSS’Z
(date-
атрибута
time)
**effective_date
string
-
Дата, с которой
UTC. yyyy-MM-ddTHH:mm:ss.SSS’Z
(date-
действительно
time)
значение
атрибута
**expired_date
string
-
Дата, с которой
UTC. yyyy-MM-ddTHH:mm:ss.SSS’Z
(date-
недействительно
time)
значение
атрибута
**location_id
string
-
Идентификатор
локации, в
которой было
проведено
измерение
568
Параметр
Тип
Обяз.
Описание
Комментарий
**party_location_i
string
-
Внутренний
Отображается только компании,
d
идентификатор
которой принадлежит локация
локации для
компании, в
которой было
проведено
измерение
**level
string
-
Уровень упаковки
**gtin
string
-
код товара
(Штрих-код)
**multiplier
number
-
Мультипликатор
**certificate_numb
string
-
номер
Только у атрибутов из группы
er
сертификата
"Сертификаты"
**certificate_issue
string
-
Дата начала срока
yyyy-MM-ddTHH:mm:ss.SSS’Z
d_date
(date-
действия
time)
**certificate_valid
string
-
Дата окончания
yyyy-MM-ddTHH:mm:ss.SSS’Z
_until_date
(date-
срока действия
time)
**certificate_appli
string
-
Заявитель
cant
**certificate_manu
string
-
Изготовитель
facturer
**certificate_produ
string
-
Продукция
ct_description
Пример ответа:
1. В случае успеха:
1.1. Для формата json:
{
"apiversion": 3,
"result": [
{
"identified_by": [
{
"value": "11033",
"type": "gtin",
"multiplier": 1,
"level": "trade-unit"
},
{
"value": "24823002000164",
569
"type": "gtin",
"multiplier": 12,
"level": "box"
}
],
"categories": [
{
"cat_id": 14786,
"cat_name": "Порошки"
},
{
"party_cat_id": 241000,
"party_cat_name": "Порошки"
}
],
"good_images": [
{
"photo_type": "facing",
"photo_date": "2016-07-20T16:26:30+00:00",
f86b-65a0e37da584.jpg",
"barcode": "6437005056338"
}
],
"good_attrs": [
{
"attr_id": 18,
"attr_name": "Вес брутто",
"attr_value": "1.506",
"value_id": 7824938,
"attr_value_type": "кг",
"attr_group_id": 19,
"attr_group_name": "Cubiscan-атрибуты",
"measure_date": "2018-02-01T16:39:04+00:00",
"published_date": "2018-02-03T13:22:11+00:00",
"effective_date": "2018-02-05T16:39:04+00:00",
"expired_date": "2018-08-05T16:39:04+00:00",
"location_id": "532",
"party_location_id": "Store #53",
"level": "trade-unit",
"gtin": "4011200255905",
"multiplier": 1.00
},
{
"attr_id": 19,
"attr_name": "Высота",
"attr_value": "29.2",
"value_id": 8214928,
"attr_value_type": "см",
"attr_group_id": 19,
"attr_group_name": "Cubiscan-атрибуты",
570
"measure_date": "2018-02-01T16:39:04+00:00",
"published_date": "2018-02-03T13:22:11+00:00",
"effective_date": "2018-02-05T16:39:04+00:00",
"expired_date": "2018-08-05T16:39:04+00:00",
"location_id": "532",
"party_location_id": "Store #53",
"level": "trade-unit",
"gtin": "4011200255905",
"multiplier": 1.00
},
{
"attr_id": 20,
"attr_name": "Глубина",
"attr_value": "",
"value_id": 5325635,
"attr_value_type": "см",
"attr_group_id": 19,
"attr_group_name": "Cubiscan-атрибуты",
"measure_date": "2018-02-01T16:39:04+00:00",
"published_date": "2018-02-03T13:22:11+00:00",
"effective_date": "2018-02-05T16:39:04+00:00",
"expired_date": "2018-08-05T16:39:04+00:00",
"location_id": "532",
"party_location_id": "Store #53",
"level": "trade-unit",
"gtin": "4011200255905",
"multiplier": 1.00
},
{
"attr_id": 21,
"attr_name": "Ширина",
"attr_value": "20.7",
"value_id": 1224735,
"attr_value_type": "см",
"attr_group_id": 19,
"attr_group_name": "Cubiscan-атрибуты",
"measure_date": "2018-02-01T16:39:04+00:00",
"published_date": "2018-02-03T13:22:11+00:00",
"effective_date": "2018-02-05T16:39:04+00:00",
"expired_date": "2018-08-05T16:39:04+00:00",
"location_id": "532",
"party_location_id": "Store #53",
"level": "trade-unit",
"gtin": "4011200255905",
"multiplier": 1.00
},
{
"attr_id": 2503,
"attr_name": "Производитель",
"attr_value_id": 3408,
"value_id": 7812631,
571
"attr_value": "ООО "ООО"",
"attr_value_type": "",
"attr_group_id": 25,
"attr_group_name": "Стороны",
"published_date": "2017-12-10 15:35:08",
"location_id": "532",
"party_location_id": "Store #53"
},
{
"attr_id": 2813,
"attr_name": "Единый реестр сертификатов соответствия",
"attr_value": "https://национальный-
каталог.рф/certificates/86F13A2714824C4B93545560F7D1CCC1",
"value_id": 1624735,
"attr_group_id": 41,
"attr_group_name": "Сертификаты",
"published_date": "2017-12-15 17:14:01",
"location_id": "532",
"party_location_id": "Store #53",
"certificate_number": "С-RU.АЮ64.В.01026",
"certificate_issued_date": "24.07.2017",
"certificate_valid_until_date": "23.07.2022",
"certificate_applicant": "Общество с ограниченной ответственностью
"Производственная компания "Севкабель",
"certificate_manufacturer": "Общество с ограниченной ответственностью
"Производственная компания "Севкабель",
"certificate_product_description": "Кабель судовой безгалогенный ..."
}
]
}
]
}
1.2. Для формата xml:
<?xml version="1.0" encoding="UTF-8"?>
<root>
<apiversion>3</apiversion>
<result>
<item>
<identified_by>
<item>
<value>11033</value>
<type>gtin</type>
<multiplier>1</multiplier>
<good_id>672136</good_id>
<level>trade-unit</level>
</item>
<item>
<value>24823002000164</value>
572
<type>gtin</type>
<multiplier>12</multiplier>
<good_id>672136</good_id>
<level>box</level>
</item>
</identified_by>
<categories>
<item>
<cat_id>14786</cat_id>
<cat_name>Порошки</cat_name>
</item>
<item>
<party_cat_id>241000</party_cat_id>
<party_cat_name>Порошки</party_cat_name>
</item>
</categories>
<good_images>
<item>
<photo_type>facing</photo_type>
<photo_date>2016-07-20T16:26:30+00:00</photo_date>
db33-f86b-65a0e37da584.jpg</photo_url>
<barcode>6437005056338</barcode>
</item>
</good_images>
<good_attrs>
<item>
<attr_id>18</attr_id>
<attr_name>Вес брутто</attr_name>
<attr_value>1.506</attr_value>
<value_id>7824938</value_id>
<attr_value_type>кг</attr_value_type>
<attr_group_id>19</attr_group_id>
<attr_group_name>Cubiscan-атрибуты</attr_group_name>
<measure_date>2018-02-01T16:39:04+00:00</measure_date>
<published_date>2018-02-03T13:22:11+00:00</published_date>
<effective_date>2018-02-05T16:39:04+00:00</effective_date>
<expired_date>2018-08-05T16:39:04+00:00</expired_date>
<location_id>532</location_id>
<party_location_id>Store #53</party_location_id>
<level>trade-unit</level>
<gtin>4011200255905</gtin>
<multiplier>1.00</multiplier>
</item>
<item>
<attr_id>19</attr_id>
<attr_name>Высота</attr_name>
<attr_value>29.2</attr_value>
<value_id>8214928</value_id>
<attr_value_type>см</attr_value_type>
<attr_group_id>19</attr_group_id>
573
<attr_group_name>Cubiscan-атрибуты</attr_group_name>
<measure_date>2018-02-01T16:39:04+00:00</measure_date>
<published_date>2018-02-03T13:22:11+00:00</published_date>
<effective_date>2018-02-05T16:39:04+00:00</effective_date>
<expired_date>2018-08-05T16:39:04+00:00</expired_date>
<location_id>532</location_id>
<party_location_id>Store #53</party_location_id>
<level>trade-unit</level>
<gtin>4011200255905</gtin>
<multiplier>1.00</multiplier>
</item>
<item>
<attr_id>20</attr_id>
<attr_name>Глубина</attr_name>
<attr_value></attr_value>
<value_id>5325635</value_id>
<attr_value_type>см</attr_value_type>
<attr_group_id>19</attr_group_id>
<attr_group_name>Cubiscan-атрибуты</attr_group_name>
<measure_date>2018-02-01T16:39:04+00:00</measure_date>
<published_date>2018-02-03T13:22:11+00:00</published_date>
<effective_date>2018-02-05T16:39:04+00:00</effective_date>
<expired_date>2018-08-05T16:39:04+00:00</expired_date>
<location_id>532</location_id>
<party_location_id>Store #53</party_location_id>
<level>trade-unit</level>
<gtin>4011200255905</gtin>
<multiplier>1.00</multiplier>
</item>
<item>
<attr_id>21</attr_id>
<attr_name>Ширина</attr_name>
<attr_value>20.7</attr_value>
<value_id>1224735</value_id>
<attr_value_type>см</attr_value_type>
<attr_group_id>19</attr_group_id>
<attr_group_name>Cubiscan-атрибуты</attr_group_name>
<measure_date>2018-02-01T16:39:04+00:00</measure_date>
<published_date>2018-02-03T13:22:11+00:00</published_date>
<effective_date>2018-02-05T16:39:04+00:00</effective_date>
<expired_date>2018-08-05T16:39:04+00:00</expired_date>
<location_id>532</location_id>
<party_location_id>Store #53</party_location_id>
<level>trade-unit</level>
<gtin>4011200255905</gtin>
<multiplier>1.00</multiplier>
</item>
<item>
<attr_id>2503</attr_id>
<attr_name>Производитель</attr_name>
<attr_value_id>3408</attr_value>
574
<value_id>7812631</value_id>
<attr_value>ООО ООО</attr_value>
<attr_value_type></attr_value_type>
<attr_group_id>25</attr_group_id>
<attr_group_name>Стороны</attr_group_name>
<published_date>2017-12-10 15:35:08</published_date>
<location_id>532</location_id>
<party_location_id>Store #53</party_location_id>
</item>
<item>
<attr_id>2813</attr_id>
<attr_name>Единый реестр сертификатов соответствия</attr_name>
<attr_value>https://национальный-
каталог.рф/certificates/86F13A2714824C4B93545560F7D1CCC1</attr_value>
<value_id>1624735</value_id>
<attr_group_id>41</attr_group_id>
<attr_group_name>Сертификаты</attr_group_name>
<published_date>2017-12-15 17:14:01</published_date>
<location_id>532</location_id>
<party_location_id>Store #53</party_location_id>
<certificate_number>С-RU.АЮ64.В.01026</certificate_number>
<certificate_issued_date>24.07.2017</certificate_issued_date>
<certificate_valid_until_date>23.07.2022</certificate_valid_until_date>
<certificate_applicant>Общество с ограниченной ответственностью
"Производственная компания "Севкабель"</certificate_applicant>
<certificate_manufacturer>Общество с ограниченной
ответственностью "Производственная компания "Севкабель"</certificate_manufacturer>
<certificate_product_description>Кабель судовой безгалогенный,
не распространяющий горение...</certificate_product_description>
</item>
</good_attrs>
</item>
</result>
</root>
2. В случае ошибок:
2.1. Код 400, если одновременно указан и "apikey" в URL запроса, и аутентификационный
токен API ГИС МТ в заголовке запроса (параметр "Authorization: Bearer <token>"):
{
"error_message": "Недопустимо использование apikey вместе с <token>"
}
2.2. Код 400, если "apikey" в URL запроса и аутентификационный токен API ГИС МТ в
заголовке запроса (параметр "Authorization: Bearer <token>") одновременно не заполнены:
575
{
"error_message": "Отсутствует необходимый для аутентификации параметр"
}
2.3. Код 401, если в заголовке запроса (параметр "Authorization: Bearer <token>") указан
неактуальный для аккаунта аутентификационный токен API ГИС МТ:
{
"error_message": "Указан неактуальный для аккаунта <token>"
}
2.4. Код 401, если истекло время действия аутентификационного токена API ГИС МТ,
указанного в заголовке запроса (параметр "Authorization: Bearer <token>"):
{
"error_message": "Время действия <token> истекло"
}
2.5. Код 403, если указан неправильный ключ API:
{
"error_message":"Отсутствует доступ к ресурсу"
}
2.6. Код 404, если не найден продукт:
{
"error_message": "Данные не найдены"
}
2.7. Код 424, если ИНН токена не совпадает со значением ИНН аккаунта, найденного в
"Национальном каталоге":
{
"error_message": "ИНН токена не совпадает со значением ИНН найденного в НК
аккаунта"
}
10.10. Метод получения карточки товара, в том числе
неопубликованной карточки
Метод возвращает всю имеющуюся информацию о продукте, то есть все заполненные атрибуты
карточки товара независимо от статуса самой карточки, в отличие от метода product, который
576
возвращает информацию только по опубликованным карточкам. Требует обязательного указания
следующих параметров: идентификатор товара (goodId), код товара (штрих-код) и указание
apikey владельца товара.
Если указаны оба обязательных параметра, то возвращается результат выборки по good_id. При
этом код товара игнорируется.
Если указан один из параметров gtin или good_id и один из параметров gtins или good_ids, то
возвращается ошибка 400.
Тип приватности: публичный
URL: /nk/feed-product
Метод: GET
Пример запроса:
curl -X GET "<url стенда>/nk/feed-product?gtin=0000000000000&format=xml"
-H "accept: application/json"
-H "Authorization: Bearer <ТОКЕН>"
Параметры запроса:
Параметр
Тип
Обяз.
Описание
Комментарий
apikey
string
-
Параметр,
Предоставляется по запросу службой
необходимый для
технической поддержки.
авторизации и
совершения
Параметр обязательный, если в
запросов API
заголовке запроса не указан "token"
("Токен аутентификации") (см.
Единая аутентификация)
good_id
string
-
ID товара в
Обязательно, если не указан gtin
каталоге
gtin
string
-
Код товара
Обязательно, если не указан good_id
gtins
string
-
Список кодов
Обязательно, если не указаны
товара в каталоге
good_id, good_ids, gtin
с разделителем в
виде ";"
good_ids
string
-
Список
Обязательно, если не указаны gtin,
идентификаторов
good_id, gtins
товара в каталоге
с разделителем в
виде ";"
Параметры ответа:
577
Параметр
Тип
Обяз.
Описание
Комментарий
apiversion
number
+
Номер версии API
метода
result
[array]
-
Результат
При наличии ответа
*identified_by
[array]
+
массив
содержащий
информацию о
штрих-кодах
**value
string
+
штрих-код или
локальный
идентификатор
**type
string
+
Тип
Возможные значения:
идентификатора
"gtin"
- глобальный код товара
(штрих-код);
"barcode"
- штрих-код Barcode
(штрихкод
с
неправильной
контрольной цифрой)
**party_id
string
-
Идентификатор
возвращается только при условии,
торговой сети
что параметр type имеет значение
barcode.
**multiplier
number
+
Количество
Значение по умолчанию = 1
товаров в
упаковке
**level
string
+
Тип упаковки
Возможные значения:
(уровень
"trade-unit" - штука;
упаковки)
"box" - коробка;
"layer" - слой на палете;
"pallet" - палета;
"metro-unit" - метро-юнит;
"show-pack" - шоу-пак;
"inner-pack" - спайка
*good_id
number
+
Идентификатор
товара
*good_name
string
+
Наименование
товара
*good_img
string
+
Изображение
товара
*good_status
string
+
Статус карточки
товара
*categories
[array]
+
Массив категорий
578
Параметр
Тип
Обяз.
Описание
Комментарий
**cat_id
number
+
Идентификатор
любой из
категорий
товаров, в
которой
расположен товар,
исключая
родителей этой
категории
**cat_name
string
+
Наименование
категории, в
которой
расположен товар
и/или
**party_cat_id
number
+
Идентификатор
Только для владельца сети, если
категории
указан party_id в запросе
торговой сети, в
которой
расположен товар
**party_cat_name
string
+
Наименование
категории
торговой сети, в
которой
расположен товар
*party_brand_id
string
-
Идентификатор
Только для владельца сети, если
бренда для
указан party_id в запросе
торговой сети
*brand_id
number
+
Идентификатор
товарного знака
*brand_name
string
+
Наименование
бренда
*good_rating
number
+
Рейтинг товара
*good_images
array
+
Массив с
изображениями
579
Параметр
Тип
Обяз.
Описание
Комментарий
**photo_type
string
+
тип фотографии
Возможные значения:
"default"
-
фотография
по
умолчанию (вид спереди);
"facing"
- crop-фотография для
планограмм (обрезанная по контуру
товара);
"left" - фотография товара слева;
"right" - фотография товара справа;
"back" - фотография товара сзади;
"3ds" - 3D серия;
"marketing"
-
коммерческая
фотография товара;
"ecommerce" - e-commerce фото;
"undef" - single shot, фотография
товара с не предопределенного
ракурса;
"cubi" - фотография измерения ВГХ
**photo_date
string
+
дата создания
UTC. yyyy-MM-ddTHH:mm:ss.SSS’Z
(date-
фотографии
time)
**photo_url
[string]
+
ссылка на med
(medium) размер
фотографии
**barcode
string
-
штрихкод или
артикул товара,
для которого
сделана
фотография
*good_attrs
array
-
Массив атрибутов
Приватные атрибуты отдаются только
те, которые принадлежат аккаунту
apikey
**attr_id
number
+
Идентификатор
атрибута
**attr_name
string
+
Наименование
атрибута
**attr_value_id
string
-
Идентификатор
значения атрибута
**attr_value
string
+
Значение
атрибута
**value_id
number
-
Идентификатор
значения атрибута
580
Параметр
Тип
Обяз.
Описание
Комментарий
**attr_value_type
array[stri
+
Массив
ng]
возможных
значений типа
атрибута
**attr_group_id
number
+
Идентификатор
группы, к которой
относится атрибут
**attr_group_name
string
+
Наименование
группы, к которой
относится атрибут
**measure_date
string
-
Дата измерения
UTC. yyyy-MM-ddTHH:mm:ss.SSS’Z
(date-
атрибута
time)
**published_date
string
-
Дата публикации
UTC.yyyy-MM-ddTHH:mm:ss.SSS’Z
(date-
атрибута
time)
**effective_date
string
-
Дата, с которой
UTC. yyyy-MM-ddTHH:mm:ss.SSS’Z
(date-
действительно
time)
значение
атрибута
**expired_date
string
-
Дата, с которой
UTC. yyyy-MM-ddTHH:mm:ss.SSS’Z
(date-
недействительно
time)
значение
атрибута
**location_id
string
-
Идентификатор
локации, в
которой было
проведено
измерение
**party_location_i
string
-
Внутренний
Отображается только компании,
d
идентификатор
которой принадлежит локация
локации для
компании, в
которой было
проведено
измерение
**level
string
-
Уровень упаковки
**gtin
string
-
код товара
(Штрих-код)
**multiplier
number
-
Мультипликатор
**certificate_numb
string
-
номер
Только у атрибутов из группы
er
сертификата
"Сертификаты"
581
Параметр
Тип
Обяз.
Описание
Комментарий
**certificate_issue
string
-
Дата начала срока
yyyy-MM-ddTHH:mm:ss.SSS’Z
d_date
(date-
действия
time)
**certificate_valid
string
-
Дата окончания
yyyy-MM-ddTHH:mm:ss.SSS’Z
_until_date
(date-
срока действия
time)
**certificate_appli
string
-
Заявитель
cant
**certificate_manu
string
-
Изготовитель
facturer
**certificate_produ
string
-
Продукция
ct_description
*good_reviews
array
+
Массив с
отзывами
**review_id
number
+
идентификатор
отзыва
**review_author
string
+
автор (имя,
фамилия,
псевдоним)
**review_rating
number
+
рейтинг отзыва
при наличии
**review_text
string
+
текст отзыва
**review_date
string
+
дата создания
UTC. yyyy-MM-ddTHH:mm:ss.SSS’Z
(date-
отзыва
time)
**review_author_i
string
+
ссылка на
mg
фотографию
автора
**review_replies
array
-
Массив с
Если отзыв имеет ответы (т.е. отзывы
отзывами
с review_parent_id = review_id
данного/родительского отзыва)
***review_id
number
+
идентификатор
отзыва-ответа
***review_author
string
+
автор (имя,
фамилия,
псевдоним)
***review_rating
number
+
рейтинг отзыва-
ответа
***review_text
string
+
текст отзыва-
ответа
582
Параметр
Тип
Обяз.
Описание
Комментарий
***review_date
string
+
дата создания
UTC. yyyy-MM-ddTHH:mm:ss.SSS’Z
(date-
отзыва
time)
***review_author_
string
+
ссылка на
img
фотографию
автора
*good_reviews_co
number
+
Количество
unt
отзывов
*good_url
string
+
Ссылка на
страницу товара
*good_prices
array
+
Массив цен на
товар по
торговым сетям
данного аккаунта
**party_id
number
+
Идентификатор
торговой сети
**address
array
+
Местонахождение
***country
string
+
Название страны
ISO 3166-2
***city
string
+
Название города
***street
string
+
Название улицы,
дом
***location
array
+
Координаты
* ***lat
string
+
Географическая
широта
* ***lon
string
+
Географическая
долгота
Пример ответа:
1. В случае успеха:
1.1. Для формата json:
{
"apiversion":3,
"result":[
{
"good_id":720679,
"identified_by":[
{
"value":"4600494523007",
"type":"gtin",
"multiplier":1,
583
"level":"trade-unit"
},
{
"value":"4600494523007",
"type":"gtin",
"multiplier":1,
"level":"trade-unit"
}
],
"good_name":"Чешки детские",
cheshki-detskie",
"good_img":null,
"good_status":"draft",
"good_signed":false,
"good_mark_flag":false,
"good_turn_flag":false,
"producer_inn":null,
"producer_name":null,
"categories":[
{
"cat_id":30717,
"cat_name":"Обувь домашняя"
}
],
"brand_id":null,
"brand_name":null,
"good_rating":null,
"good_images":[
],
"good_attrs":[
{
"attr_id":2478,
"attr_name":"Полное наименование товара",
"attr_value":"Чешки детские",
"attr_value_type":null,
"attr_group_id":0,
"attr_group_name":null,
"value_id":0,
"gtin":null,
"multiplier":null,
"level":""
},
{
"attr_id":3793,
"attr_name":"Базовая единица измерения",
"attr_value":"ШТ",
"attr_value_type":null,
"attr_group_id":0,
"attr_group_name":null,
584
"value_id":0,
"gtin":null,
"multiplier":null,
"level":""
},
{
"attr_id":2630,
"attr_name":"Страна производства",
"attr_value":"RU",
"attr_value_type":null,
"attr_group_id":0,
"attr_group_name":null,
"value_id":0,
"gtin":null,
"multiplier":null,
"level":""
},
{
"attr_id":13876,
"attr_name":"Бренд ORIGINAL",
"attr_value":"Котофей",
"attr_value_type":null,
"attr_group_id":0,
"attr_group_name":null,
"value_id":0,
"gtin":null,
"multiplier":null,
"level":""
},
{
"attr_id":13898,
"attr_name":"Материал верха, %",
"attr_value":"ИСКУССТВЕННАЯ КОЖА",
"attr_value_type":"100",
"attr_group_id":0,
"attr_group_name":null,
"value_id":0,
"gtin":null,
"multiplier":null,
"level":""
},
{
"attr_id":13901,
"attr_name":"Материал подкладки, %",
"attr_value":"ТКАНЬ",
"attr_value_type":"100",
"attr_group_id":0,
"attr_group_name":null,
"value_id":0,
"gtin":null,
"multiplier":null,
585
"level":""
},
{
"attr_id":13904,
"attr_name":"Материал стельки,%",
"attr_value":"ТКАНЬ",
"attr_value_type":"100",
"attr_group_id":0,
"attr_group_name":null,
"value_id":0,
"gtin":null,
"multiplier":null,
"level":""
},
{
"attr_id":13902,
"attr_name":"Материал низа/подошвы, %",
"attr_value":"КОЖА (БАРАНЬЯ)",
"attr_value_type":"100",
"attr_group_id":0,
"attr_group_name":null,
"value_id":0,
"gtin":null,
"multiplier":null,
"level":""
},
{
"attr_id":13905,
"attr_name":"Вид обуви",
"attr_value":"Чешки",
"attr_value_type":null,
"attr_group_id":0,
"attr_group_name":null,
"value_id":0,
"gtin":null,
"multiplier":null,
"level":""
},
{
"attr_id":13886,
"attr_name":"Размер в штихмассовой системе",
"attr_value":"26",
"attr_value_type":null,
"attr_group_id":0,
"attr_group_name":null,
"value_id":0,
"gtin":null,
"multiplier":null,
"level":""
},
{
586
"attr_id":36,
"attr_name":"Цвет",
"attr_value":"БЕЛЫЙ",
"attr_value_type":null,
"attr_group_id":0,
"attr_group_name":null,
"value_id":0,
"gtin":null,
"multiplier":null,
"level":""
},
{
"attr_id":3959,
"attr_name":"Группа ТНВЭД",
"attr_value":"6402",
"attr_value_type":null,
"attr_group_id":0,
"attr_group_name":null,
"value_id":0,
"gtin":null,
"multiplier":null,
"level":""
},
{
"attr_id":13933,
"attr_name":"Код ТНВЭД",
"attr_value":"11.11",
"attr_value_type":null,
"attr_group_id":0,
"attr_group_name":null,
"value_id":0,
"gtin":null,
"multiplier":null,
"level":""
},
{
"attr_id":3961,
"attr_name":"Группа ОКПД2",
"attr_value":"15.20.14",
"attr_value_type":null,
"attr_group_id":0,
"attr_group_name":null,
"value_id":0,
"gtin":null,
"multiplier":null,
"level":""
},
{
"attr_id":2439,
"attr_name":"Ширина",
"attr_value":"10",
587
"attr_value_type":"см",
"attr_group_id":0,
"attr_group_name":null,
"value_id":0,
"gtin":"4600494523007",
"multiplier":null,
"level":"trade-unit"
},
{
"attr_id":2438,
"attr_name":"Глубина",
"attr_value":"35",
"attr_value_type":"см",
"attr_group_id":0,
"attr_group_name":null,
"value_id":0,
"gtin":"4600494523007",
"multiplier":null,
"level":"trade-unit"
},
{
"attr_id":2437,
"attr_name":"Высота",
"attr_value":"5",
"attr_value_type":"кг",
"attr_group_id":0,
"attr_group_name":null,
"value_id":0,
"gtin":"4600494523007",
"multiplier":null,
"level":"trade-unit"
},
{
"attr_id":2440,
"attr_name":"Вес брутто",
"attr_value":"0.15",
"attr_value_type":"см",
"attr_group_id":0,
"attr_group_name":null,
"value_id":0,
"gtin":"4600494523007",
"multiplier":null,
"level":"trade-unit"
},
{
"attr_id":13756,
"attr_name":"Расчетный объем",
"attr_value":"1750",
"attr_value_type":"",
"attr_group_id":0,
"attr_group_name":null,
588
"value_id":0,
"gtin":"4600494523007",
"multiplier":null,
"level":"trade-unit"
},
{
"attr_id":4424,
"attr_name":"Краткое наименование товара",
"attr_value":"Чешки детские",
"attr_value_type":"",
"attr_group_id":0,
"attr_group_name":null,
"value_id":0,
"gtin":"4600494523007",
"multiplier":null,
"level":"trade-unit"
}
],
"good_reviews":[
],
"good_reviews_count":0,
"good_prices":[
]
}
]
}
1.2. Для формата xml:
<?xml version="1.0" encoding="UTF-8"?>
<root>
<apiversion>3</apiversion>
<result>
<item>
<identified_by>
<item>
<value>11033</value>
<type>gtin</type>
<multiplier>1</multiplier>
<good_id>672136</good_id>
<level>trade-unit</level>
</item>
<item>
<value>24823002000164</value>
<type>gtin</type>
<multiplier>12</multiplier>
<good_id>672136</good_id>
<level>box</level>
589
</item>
</identified_by>
<categories>
<item>
<cat_id>14786</cat_id>
<cat_name>Порошки</cat_name>
</item>
<item>
<party_cat_id>241000</party_cat_id>
<party_cat_name>Порошки</party_cat_name>
</item>
</categories>
<good_images>
<item>
<photo_type>facing</photo_type>
<photo_date>2016-07-20T16:26:30+00:00</photo_date>
db33-f86b-65a0e37da584.jpg</photo_url>
<barcode>6437005056338</barcode>
</item>
</good_images>
<good_attrs>
<item>
<attr_id>18</attr_id>
<attr_name>Вес брутто</attr_name>
<attr_value>1.506</attr_value>
<value_id>7824938</value_id>
<attr_value_type>кг</attr_value_type>
<attr_group_id>19</attr_group_id>
<attr_group_name>Cubiscan-атрибуты</attr_group_name>
<measure_date>2018-02-01T16:39:04+00:00</measure_date>
<published_date>2018-02-03T13:22:11+00:00</published_date>
<effective_date>2018-02-05T16:39:04+00:00</effective_date>
<expired_date>2018-08-05T16:39:04+00:00</expired_date>
<location_id>532</location_id>
<party_location_id>Store #53</party_location_id>
<level>trade-unit</level>
<gtin>4011200255905</gtin>
<multiplier>1.00</multiplier>
</item>
<item>
<attr_id>19</attr_id>
<attr_name>Высота</attr_name>
<attr_value>29.2</attr_value>
<value_id>8214928</value_id>
<attr_value_type>см</attr_value_type>
<attr_group_id>19</attr_group_id>
<attr_group_name>Cubiscan-атрибуты</attr_group_name>
<measure_date>2018-02-01T16:39:04+00:00</measure_date>
<published_date>2018-02-03T13:22:11+00:00</published_date>
<effective_date>2018-02-05T16:39:04+00:00</effective_date>
590
<expired_date>2018-08-05T16:39:04+00:00</expired_date>
<location_id>532</location_id>
<party_location_id>Store #53</party_location_id>
<level>trade-unit</level>
<gtin>4011200255905</gtin>
<multiplier>1.00</multiplier>
</item>
<item>
<attr_id>20</attr_id>
<attr_name>Глубина</attr_name>
<attr_value></attr_value>
<value_id>5325635</value_id>
<attr_value_type>см</attr_value_type>
<attr_group_id>19</attr_group_id>
<attr_group_name>Cubiscan-атрибуты</attr_group_name>
<measure_date>2018-02-01T16:39:04+00:00</measure_date>
<published_date>2018-02-03T13:22:11+00:00</published_date>
<effective_date>2018-02-05T16:39:04+00:00</effective_date>
<expired_date>2018-08-05T16:39:04+00:00</expired_date>
<location_id>532</location_id>
<party_location_id>Store #53</party_location_id>
<level>trade-unit</level>
<gtin>4011200255905</gtin>
<multiplier>1.00</multiplier>
</item>
<item>
<attr_id>21</attr_id>
<attr_name>Ширина</attr_name>
<attr_value>20.7</attr_value>
<value_id>1224735</value_id>
<attr_value_type>см</attr_value_type>
<attr_group_id>19</attr_group_id>
<attr_group_name>Cubiscan-атрибуты</attr_group_name>
<measure_date>2018-02-01T16:39:04+00:00</measure_date>
<published_date>2018-02-03T13:22:11+00:00</published_date>
<effective_date>2018-02-05T16:39:04+00:00</effective_date>
<expired_date>2018-08-05T16:39:04+00:00</expired_date>
<location_id>532</location_id>
<party_location_id>Store #53</party_location_id>
<level>trade-unit</level>
<gtin>4011200255905</gtin>
<multiplier>1.00</multiplier>
</item>
<item>
<attr_id>2503</attr_id>
<attr_name>Производитель</attr_name>
<attr_value_id>3408</attr_value>
<value_id>7812631</value_id>
<attr_value>ООО ООО</attr_value>
<attr_value_type></attr_value_type>
<attr_group_id>25</attr_group_id>
591
<attr_group_name>Стороны</attr_group_name>
<published_date>2017-12-10 15:35:08</published_date>
<location_id>532</location_id>
<party_location_id>Store #53</party_location_id>
</item>
<item>
<attr_id>2813</attr_id>
<attr_name>Единый реестр сертификатов соответствия</attr_name>
<attr_value>https://национальный-
каталог.рф/certificates/86F13A2714824C4B93545560F7D1CCC1</attr_value>
<value_id>1624735</value_id>
<attr_group_id>41</attr_group_id>
<attr_group_name>Сертификаты</attr_group_name>
<published_date>2017-12-15 17:14:01</published_date>
<location_id>532</location_id>
<party_location_id>Store #53</party_location_id>
<certificate_number>С-RU.АЮ64.В.01026</certificate_number>
<certificate_issued_date>24.07.2017</certificate_issued_date>
<certificate_valid_until_date>23.07.2022</certificate_valid_until_date>
<certificate_applicant>Общество с ограниченной ответственностью
«Производственная компания «Севкабель»</certificate_applicant>
<certificate_manufacturer>Общество с ограниченной
ответственностью «Производственная компания «Севкабель»</certificate_manufacturer>
<certificate_product_description>Кабель судовой безгалогенный,
не распространяющий горение...</certificate_product_description>
</item>
</good_attrs>
</item>
</result>
</root>
2. В случае ошибок:
2.1. Код 400, если одновременно указан и "apikey" в URL запроса, и аутентификационный
токен API ГИС МТ в заголовке запроса (параметр "Authorization: Bearer <token>"):
{
"error_message": "Недопустимо использование apikey вместе с <token>"
}
2.2. Код 400, если "apikey" в URL запроса и аутентификационный токен API ГИС МТ в
заголовке запроса (параметр "Authorization: Bearer <token>") одновременно не заполнены:
{
"error_message": "Отсутствует необходимый для аутентификации параметр"
}
2.3. Код 401, если в заголовке запроса (параметр "Authorization: Bearer <token>") указан
592
неактуальный для аккаунта аутентификационный токен API ГИС МТ:
{
"error_message": "Указан неактуальный для аккаунта <token>"
}
2.4. Код 401, если истекло время действия аутентификационного токена API ГИС МТ,
указанного в заголовке запроса (параметр "Authorization: Bearer <token>"):
{
"error_message": "Время действия <token> истекло"
}
2.5. Код 403, если указан неправильный ключ API:
{
"error_message":"Отсутствует доступ к ресурсу"
}
2.6. Код 424, если ИНН токена не совпадает со значением ИНН аккаунта, найденного в
"Национальном каталоге":
{
"error_message": "ИНН токена не совпадает со значением ИНН найденного в НК
аккаунта"
}
10.11. Метод подписи карточки товара
Метод предназначен для подписи карточки товара или нескольких карточек с помощью
сертификата в формате PKCS#7. Отличается от метода "Метода получения массива ID
прошедших валидацию товаров" (/nk/feed-product-sign) тем, что из содержимого карточки товара
в формате XML исключается подпись, которая при использовании текущего метода передается
отдельным параметром в запросе. Данные кодируются в BASE64.
Тип приватности: приватный
URL: /nk/feed-product-sign-pkcs
Метод: POST
Пример строки запроса:
593
curl -X POST "<url стенда>/nk/feed-product-sign-pkcs?format=xml"
-H "accept: application/json"
-H "Content-Type: application/json"
-H "Authorization: Bearer <ТОКЕН>"
--data-raw "[{\"goodId\":0,\"base64Xml\":\"string\",\"signature\":\"string\"}]"
Пример тела запроса:
[
{
"goodId":3,
"base64Xml":"...",
"signature":"..."
},
{
"goodId":3119690,
"base64Xml":"...",
"signature":"..."
},
{
"goodId":521,
"base64Xml":"...",
"signature":"..."
}
]
Параметры запроса:
Параметр
Тип
Обяз.
Описание
Комментарий
apikey
string
-
Параметр,
Предоставляется по запросу службой
необходимый для
технической поддержки.
авторизации и
совершения
Параметр обязательный, если в заголовке
запросов API
запроса не указан "token" ("Токен
аутентификации") (см. Единая
аутентификация)
goodId
integer
+
Идентификатор
(int64)
товара в
"Национальный
каталог"
base64Xml
string
+
Карточка товара в
формате XML,
закодированная в
BASE64
594
Параметр
Тип
Обяз.
Описание
Комментарий
signature
string
+
Открепленная
подпись,
закодированная в
BASE64,
соответствующая
типу CAdES в
формате PKCS#7
Пример ответа:
{
"signed": [
0
],
"errors": [
{
"code": 0,
"description": "string",
"cis": "string"
}
]
}
Параметры ответа:
Параметр
Тип
Обяз.
Описание
Комментарий
*signed
array[nu
-
Массив числовых
mber]
идентификаторов
товаров, для
которых прошла
валидация
карточки товара,
товар переведен в
статус
"Опубликован"
*errors
array[stri
-
Массив объектов,
Параметр возвращается при наличии
ng]
содержащих
ошибки
идентификаторы
товара и текст
ошибки,
возникшей при
обработке
переданных XML
(закодированных
в BASE64)
Примечание: ответе возвращается до 25 объектов.
595
Возможные ошибки:
1. Код 400, если одновременно указан и "apikey" в URL запроса, и аутентификационный токен
API ГИС МТ в заголовке запроса (параметр "Authorization: Bearer <token>"):
{
"error_message": "Недопустимо использование apikey вместе с <token>"
}
2. Код 400, если "apikey" в URL запроса и аутентификационный токен API ГИС МТ в заголовке
запроса (параметр "Authorization: Bearer <token>") одновременно не заполнены:
{
"error_message": "Отсутствует необходимый для аутентификации параметр"
}
3. Код 401, если в заголовке запроса (параметр "Authorization: Bearer <token>") указан
неактуальный для аккаунта аутентификационный токен API ГИС МТ:
{
"error_message": "Указан неактуальный для аккаунта <token>"
}
4. Код 401, если истекло время действия аутентификационного токена API ГИС МТ, указанного
в заголовке запроса (параметр "Authorization: Bearer <token>"):
{
"error_message": "Время действия <token> истекло"
}
5. Код 403, если указан неправильный ключ API:
{
"error_message":"Отсутствует доступ к ресурсу"
}
6. Код 424, если ИНН токена не совпадает со значением ИНН аккаунта, найденного в
"Национальном каталоге":
{
"error_message": "ИНН токена не совпадает со значением ИНН найденного в НК
аккаунта"
}
596
10.12. Метод получения XML товаров по массиву ID товаров
или коду товара
Метод предназначен для получения XML товаров для подписи по goodId или коду товара. При
отправке массива ID товаров либо массива строк кодов товаров в ответе возвращается массив
XML товаров для подписания и (при наличии) массив объектов с информацией об ошибках при
отсутствии товаров по ID/коду товара.
Ограничения:
• Количество товаров в запросе - не более 25.
Тип приватности: публичный
URL: /nk/feed-product-document
Метод: POST
Параметры тела запроса:
Параметр
Тип
Обяз.
Описание
Комментарий
goodIds
array[nu
-
Массив ID
Обязательно, если не указан gtins
mber]
товаров
gtins
array[stri
-
Массив строк
Обязательно, если не указан goodIds
ng]
кодов товаров
publicationAgreem
boolean
-
Согласие на
true/1 - согласны, false/0 - не
ent
публикацию
согласны. При отсутствии данного
товаров на сайте
параметра будет выставлено значение
национальный-
по умолчанию - "Не согласен".
каталог.рф
Параметры ответа:
Параметр
Тип
Обяз.
Описание
Комментарий
apiversion
number
+
Номер версии API
метода
result
array
-
Результат
При наличии ответа
*xmls
array
+
Массив XML
товаров для
подписания
**goodId
number
+
Идентификатор
товара в
"Национальном
каталоге"
**xml
string
+
XML товара для
подписания
597
Параметр
Тип
Обяз.
Описание
Комментарий
*errors
array
+
Массив ошибок
по каждому
товару
**goodId
number
+
Идентификатор
товара в
"Национальном
каталоге"
*gtin
string
+
Код товара
*message
string
+
Текст ошибки
Также при не нахождении товара по
коду товара
Пример запроса:
curl -X POST "<url стенда>/nk/feed-product-document?apikey=XXX"
-H "accept: application/json"
-H "Content-Type: application/json; charset=utf-8"
--data-raw "{
"goodIds": [
123, 234, 345
],
"gtins": [
"4612312312312", "123123123123"
],
"publicationAgreement": false
}"
Пример ответа:
1 В случае успеха:
598
{
"apiversion": 3,
"result": [
{
"xmls": [
{
"goodId": 123,
"xml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>..."
},
{
"goodId": 234,
"xml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>..."
}
],
"errors": [
{
"goodId": 345,
"message": "Информация о товаре ... устарела или скомпрометирована.
Попробуйте еще раз."
},
{
"GTIN": "123123123123",
"message": "Не удалось получить товар по GTIN"
}
]
}
]
}
2 В случае ошибок:
2.1. Код 403 Если указан неправильный ключ API:
{
"error_message": "Отсутствует доступ к ресурсу"
}
2.2. Код 413 Если больше 25 запрашиваемых идентификаторов в теле запроса:
{
"error_message": "Слишком большой запрос"
}
10.13. Метод получения массива ID прошедших валидацию
товаров
Метод принимает массив объектов, в объектах содержатся good_id товара и подписанный XML
599
содержание .. 4 5 6 7 ..
|
||
|
|
|