|
|
содержание .. 5 6 7
для этого товара.
Ограничения:
• Количество товаров в запросе - не более 25.
Тип приватности: публичный
URL: /nk/feed-product-sign
Метод: POST Пример запроса:
curl -X POST "<url стенда>/nk/feed-product-sign"
-H "accept: application/json"
-H "Content-Type: application/json; charset=utf-8"
-H "Authorization: Bearer <ТОКЕН>"
--data-raw "[
{
"goodId": 5000,
"xml": "<?xml version="1.0" encoding="UTF-8"?>..."
},
{
"goodId": 3,
"xml": "<?xml version="1.0" encoding="UTF-8"?>..."
},
{
"goodId": 5,
"xml": "<?xml version="1.0" encoding="UTF-8"?>..."
}
]"
Параметры тела запроса:
Параметр
Тип
Обяз.
Описание
Комментарий
apikey
string
-
Параметр,
Предоставляется по запросу службой
необходимый для
технической поддержки.
авторизации и
совершения
Параметр обязательный, если в
запросов API
заголовке запроса не указан "token"
("Токен аутентификации") (см.
Единая аутентификация)
goodId
number
+
Идентификатор
товара в
"Национальном
каталоге", для
которого
передаётся XML
600
Параметр
Тип
Обяз.
Описание
Комментарий
xml
string
+
Подписанный с
помощью
прикрепленной
подписи XML
товара
Параметры ответа:
Параметр
Тип
Обяз.
Описание
Комментарий
*signed
array[nu
+
Массив ID
При наличии успешно
mber]
товаров, XML для
провалидированных товаров
которых прошли
валидацию, были
сохранены, и
товар переведен в
статус
"Опубликован"
*errors
array
+
Массив объектов,
Параметр возвращается при наличии
содержащих
ошибки
идентификаторы
товара и текст
ошибки,
возникшей при
обработке
переданных XML
Пример ответа:
1. В случае успеха:
{
"apiversion": 3,
"result": {
"signed": [
5000,
3
],
"errors": [
{
"goodId": 5,
"message": "Информация о товаре ... устарела или скомпрометирована.
Попробуйте еще раз. "
}
]
}
}
601
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> истекло"
}
2.5. Код 403, если указан неправильный ключ API:
{
"error_message":"Отсутствует доступ к ресурсу"
}
2.6. Код 424, если ИНН токена не совпадает со значением ИНН аккаунта, найденного в
"Национальном каталоге":
{
"error_message": "ИНН токена не совпадает со значением ИНН найденного в НК
аккаунта"
}
602
10.14. Метод получения списка всех принадлежащих одному
владельцу товаров
Метод возвращает список всех товаров, принадлежащих определенному владельцу, вместе с
хешем содержания страницы. Предназначен для получения списка хешей, сравнения с
локальным хранилищем и обновления информации по товарам (см. "Метод получения полной
информации о товаре") для которых хеш изменился (есть новые данные). Таким образом
возможно выявить товары, в карточки которых были внесены изменения. Метод возвращает
список товаров и их хеши по заданным фильтрам. Если не указан ни один из необязательных
параметров, в ответе будут возвращаться записи из всего списка товаров.
Тип приватности: приватный
URL: /nk/etagslist
Метод: GET
Пример запроса:
curl -X GET "<url
стенда>/nk/etagslist?format=json&brand_id="string"&owner_id="string"&cat_id="string"&o
ffset=1"
-H "accept: application/json"
-H "Authorization: Bearer <ТОКЕН>"
Параметры запроса:
Параметр
Тип
Обяз.
Описание
Комментарий
apikey
string
-
Параметр,
Предоставляется по запросу службой
необходимый для
технической поддержки.
авторизации и
совершения
Параметр обязательный, если в заголовке
запросов API
запроса не указан "token" ("Токен
аутентификации") (см. Единая
аутентификация)
brand_id
string
-
Идентификатор
товарного знака
owner_id
string
-
Идентификатор
аккаунта
владельца товаров
cat_id
string
-
Идентификатор
любой из
категорий товаров
offset
integer
-
Смещение
относительно
начала списка
выдачи
603
Примечание: должен быть указан минимум один параметр запроса.
Параметры ответа:
Параметр
Тип
Обяз.
Описание
Комментарий
apiversion
number
+
Номер версии API
метода
result
object
+
Результат
При наличии ответа
goods_count
integer
+
Число товаров в
(int64)
текущем ответе
offset
integer
+
Смещение
(int64)
относительно
начала списка
выдачи
last_product_
integer
+
Номер последнего
number
(int64)
показанного
товара
относительно
начала списка
выдачи
goods
array
+
Массив товаров и
В одном ответе может содержаться не
их хешей
более 100 товаров
*good_id
integer
+
Идентификатор
(int64)
товара
*etag
string
+
Хеш
Пример ответа:
1. В случае успеха:
1.1. Для формата json:
604
{
"apiversion":3,
"result":{
"goods_count":100,
"offset":0,
"last_product_number":100,
"goods":[
{
"good_id":3,
"etag":"32b3502ff24f7c30"
},
{
"good_id":4,
"etag":"8529021f8808aaa9"
},
{
"good_id":5,
"etag":"4c23e42d0384a622"
}
]
}
}
1.2. Для формата xml:
<?xml version="1.0" encoding="UTF-8"?>
<root>
<apiversion>3</apiversion>
<result>
<goods_count>100</goods_count>
<offset>0</offset>
<last_product_number>100</last_product_number>
<goods>
<item>
<good_id>3</good_id>
<etag>32b3502ff24f7c30</etag>
</item>
<item>
<good_id>4</good_id>
<etag>8529021f8808aaa9</etag>
</item>
<item>
<good_id>5</good_id>
<etag>4c23e42d0384a622</etag>
</item>
</goods>
</result>
</root>
605
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> истекло"
}
2.5. Код 403, если указан неправильный ключ API:
{
"error_message":"Отсутствует доступ к ресурсу"
}
2.6. Код 424, если ИНН токена не совпадает со значением ИНН аккаунта, найденного в
"Национальном каталоге":
{
"error_message": "ИНН токена не совпадает со значением ИНН найденного в НК
аккаунта"
}
606
10.15. Метод изменения размера изображения с заполнением
недостающих полей белым цветом
Метод предназначен для пропорционального изменения размера изображения с заполнением
недостающих полей белым цветом. При отправке данных об изображении в ответе возвращается
JPEG изменённого изображения.
Тип приватности: публичный
URL: /nk/image
Метод: GET
Пример запроса:
curl -X GET "<url стенда>/nk/image?name=https://национальный-
каталог.рф/i/300x200/5a7eb614-13d3-69ed-caf7-420624d1bdd3.jpg&width=300&height=400"
-H "accept: image/jpeg"
-H "Authorization: Bearer <ТОКЕН>"
Параметры запроса:
Параметр
Тип
Обяз.
Описание
Комментарий
apikey
string
-
Параметр,
Предоставляется по запросу службой
необходимый для
технической поддержки.
авторизации и
совершения
Параметр обязательный, если в
запросов API
заголовке запроса не указан "token"
("Токен аутентификации") (см.
Единая аутентификация)
name
string
-
Полный URI
изображения
width
string
-
Ширина рисунка
Должен быть в границах [100,
на выходе в
1000](результирующая ширина в
пикселях
пикселях)
height
string
-
Высота рисунка
Должен быть в границах [100,
на выходе в
1000](результирующая высота в
пикселях
пикселях)
no-background
string
-
Параметр
Возможные значения:
добавления
"1" - фон не добавлять;
белого фона к
"0" - фон добавлять (значение по
рисунку для
умолчанию)
соблюдения
размеров
Параметры ответа:
Изображение изменённого размера.
607
Пример ответа:
1.
В случае успеха:
Изображение изменённого размера.
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> истекло"
}
2.5. Код 403, если указан неправильный ключ API:
{
"error_message":"Отсутствует доступ к ресурсу"
}
2.6. Код 424, если ИНН токена не совпадает со значением ИНН аккаунта, найденного в
"Национальном каталоге":
608
{
"error_message": "ИНН токена не совпадает со значением ИНН найденного в НК
аккаунта"
}
10.16. Метод генерации черновиков кодов товаров
Метод предназначен для генерации и получения списка черновиков кодов товаров. При отправке
числа новых кодов товаров и (при необходимости) ключа поставщика/производителя товаров в
ответе возвращается число доступных в течение месяца для генерации кодов товаров, число уже
сгенерированных кодов товаров, список новых кодов товаров.
Тип приватности: публичный
URL: /nk/generate-gtins
Метод: GET
Пример запроса генерации новых черновиков gtin:
curl -X GET "<url стенда>/nk/generate-gtins?quantity=3"
-H "accept: application/json"
-H "Authorization: Bearer <ТОКЕН>"
Пример запроса генерации новых черновиков gtin от имени поставщика контента или
лаборатории:
curl -X GET "<url стенда>/nk/generate-gtins?quantity=3&supplier_key=YYY"
-H "accept: application/json"
-H "Authorization: Bearer <ТОКЕН>"
Пример запроса, возвращающий уже имеющиеся черновики gtin:
curl -X GET "<url стенда>/nk/generate-gtins?exist=1"
-H "accept: application/json"
-H "Authorization: Bearer <ТОКЕН>"
Параметры запроса:
609
Параметр
Тип
Обяз.
Описание
Комментарий
apikey
string
-
Параметр,
Предоставляется по запросу службой
необходимый для
технической поддержки.
авторизации и
совершения
Параметр обязательный, если в
запросов API
заголовке запроса не указан "token"
("Токен аутентификации") (см.
Единая аутентификация)
quantity
string
+
Количество новых
обязателен при запросе генерации
черновиков кодов
новых черновиков gtin
товаров, которые
нужно
сгенерировать
exist
boolean
-
признак,
принимает значения 1/0 (true/false)
обозначающий
запрос уже
сгенерированных
и имеющихся в
базе пользователя
gtin
supplier_key
string
-
"api-key"
При выставлении данного параметра
поставщика или
генерируется карточка товара
производителя
поставщика/производителя товаров
товаров
(GTIN) в НК. При этом используется
GCP\GLN организации
поставщика\производителя товаров
Параметры ответа:
Параметр
Тип
Обяз.
Описание
Комментарий
apiversion
number
+
Номер версии API
метода
result
array
-
Результат
При наличии ответа
*monthly-limit
object
+
Ежемесячное
ограничение
**limit
number
+
Общее
количество
черновиков кодов
товаров,
доступных для
генерации в
течение одного
месяца
610
Параметр
Тип
Обяз.
Описание
Комментарий
**usage
number
+
Количество
черновиков кодов
товаров, которые
уже были
сгенерированы в
течение этого
месяца
*drafts
array
+
Список
При наличии сгенерированных
черновиков
черновиков
**gtin
string
+
Код товара,
который был
сгенерированы
Пример ответа:
1. В случае успеха:
1.1. Пример ответа json
{
"apiversion": 3,
"result": {
"monthly-limit": {
"limit": 100,
"usage": 6
},
"drafts": [
{
"gtin": "4600002575689"
},
{
"gtin": "4600002575696"
},
{
"gtin": "4600002575702"
}
]
}
}
1.2. Пример ответа xml
611
<root>
<apiversion>3</apiversion>
<result>
<monthly-limit>
<limit>100</limit>
<usage>6</usage>
</monthly-limit>
<drafts>
<gtin>4600002575689</gtin>
<gtin>4600002575696</gtin>
<gtin>4600002575702</gtin>
</drafts>
</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>"):
{
"error_message": "Время действия <token> истекло"
}
2.5. Код 403, если указан неправильный ключ API:
612
{
"error_message":"Отсутствует доступ к ресурсу"
}
2.6. Код 424, если ИНН токена не совпадает со значением ИНН аккаунта, найденного в
"Национальном каталоге":
{
"error_message": "ИНН токена не совпадает со значением ИНН найденного в НК
аккаунта"
}
10.17. Метод создания и обновления товаров
Метод предназначен для получения идентификатора фида созданных/обновлённых товаров с
указанием json/xml формата фида. При отправке массива данных о товарах, которые нужно
создать либо обновить (указывается ID товаров) с возможностью указать ключ
поставщика/производителя товара, в ответе возвращается ID фида созданных/обновлённых
товаров либо сообщение об ошибке (при наличии).
Ограничения:
• Размер фида - 25 МБ;
• Количество товаров в фиде - 5000.
Тип приватности: публичный
URL: /nk/feed
Метод: POST
"Content-Type: application/xml", если фид в формате xml;
"Content-Type: application/json", если фид в формате json.
Параметры запроса:
Параметр
Тип
Обяз.
Описание
Комментарий
apikey
string
-
Параметр,
Предоставляется по запросу службой
необходимый для
технической поддержки.
авторизации и
совершения
Параметр обязательный, если в
запросов API
заголовке запроса не указан "token"
("Токен аутентификации") (см.
Единая аутентификация)
supplier_key
string
-
Ключ поставщика
"api-key" поставщика или
или
производителя товаров
производителя
товаров
613
Примечание - Для изменения существующего товара должно быть передано значение его
идентификатора good_id. Если параметра good_id нет, товар определяется как новый. Для нового
товара обязательным является параметр good_name и gtin.
Параметры тела запроса:
Параметр
Тип
Обяз.
Описание
Комментарий
@id
string
-
Идентификатор
entry, который
лаборатория
может задать для
более конкретной
идентификации
ответа
good_id
number
-
Идентификатор
Обязательно при обновлении товара
товара
gtin
string
-
Идентификатор в
обязательный для нового товара
Национальном
каталоге товаров,
код товара
is_tech_gtin
boolean
-
Признак создания
Принимает значения 1/0 (true/false).
карточки товара с
Обязателен при создании карточки
техническим
товара с техническим кодом товара, в
кодом товара
этом случае код товара в энтри не
указывается
is_kit
boolean
-
признак создания
принимает значения 1/0 (true/false).
карточки товара с
Обязателен при создании карточки
техническим
товара с техническим кодом товара, в
кодом товара
этом случае код товара в энтри не
указывается
good_name
string
-
Наименование
Обязательно при создании товара
товара
tnved
string
-
ТН ВЭД
Обязательно для нового товара
brand
string
-
Торговая марка
Обязательно для нового товара
товара
moderation
boolean
-
Признак того, что
Возможные значения:
товар надо
true - требуется модерация;
отправлять на
false - модерация не требуется
модерацию
identified_by
array
-
Массив
Если создаётся карточка товара с
идентификаторов
кодом товара, относящимся к
упаковке типа trade-unit, то массив
идентификаторов обязательно
должен включать, как минимум,
идентификатор данного вида
упаковки
614
Параметр
Тип
Обяз.
Описание
Комментарий
*type
string
+
Тип
Возможные значения:
идентификатора
"gtin"
- глобальный код товара
(штрих-код)
*value
string
+
Значение
идентификатора
*level
string
+
Тип упаковки
Возможные значения:
(уровень
"trade-unit" - штука;
упаковки)
"box" - коробка;
"layer" - слой на палете;
"pallet" - палета;
"metro-unit" - метро-юнит;
"show-pack" - шоу-пак;
"inner-pack" - спайка
**attr_id
number
-
Идентификатор
Обязателен для всех типов упаковки,
атрибута
кроме trade-unit
**attr_value
number
-
Значение
Указывается код упаковки
атрибута
предыдущего уровня Обязателен для
всех типов упаковки, кроме trade-unit
*multiplier
number
+
Количество в
Значение по умолчанию = 1
упаковке
*party_id
string
-
Идентификатор
Необязательно при типе gtin,
торговой сети
обязательно при других типах
*unit
string
-
Тип измерений
Возможные значения:
"кг" - килограмм;
"шт" - штука
categories
array[nu
-
массив
mber]
идентификаторов
категорий
good_attrs
array
-
массив атрибутов
attr_value_id
number
-
Идентификатор
Обязательный для обновления
значения атрибута
существующих атрибутов товара
*attr_id
number
+
Идентификатор
Обязательный при создании товара
атрибута
*attr_value
string
-
Значение
обязательный при создании товара;
атрибута
необязательный при редактировании
и удалении
*attr_value_type
array[stri
-
Массив
ng]
возможных
значений типа
атрибута
615
Параметр
Тип
Обяз.
Описание
Комментарий
*gtin
string
-
код товара
(Штрих-код)
*delete
number
-
Признак удаления
Со значением 1 - удаление атрибута
товара
товара. Доступно только при
редактировании существующего
товара. При передаче данного
параметра обязательно указать
attr_value_id
good_images
array
-
массив
изображений
*photo_type
string
+
тип изображения
Возможные значения:
"default"
-
фотография
по
умолчанию (вид спереди);
"facing"
- crop-фотография для
планограмм (обрезанная по контуру
товара);
"7" - фотография товара слева;
"19" - фотография товара справа;
"13" - фотография товара сзади;
"si1" - фотография товара сверху;
"si2" - фотография товара снизу;
"si3"
- фотография товара в
упаковке;
"si4"
- фотография товара без
упаковки;
"si5" - фотография товара внутри
упаковки;
"3ds" - 3D серия;
"marketing"
-
коммерческая
фотография товара;
"text"
- фотография текста на
товаре;
"ecommerce" - e-commerce фото;
"undef" - single shot, фотография
товара
без
предварительно
определённого ракурса;
"cubi" - фотография измерения ВГХ
photo_url
string
+
URL либо массив
Массив url указывается при
либо
URL
photo_type=3ds
array[stri
ng]
identifier
string
-
Идентификатор
Значение gtin/barcode. Используется
заданного типа
для связи фотографий с
идентификаторами товара
616
Параметр
Тип
Обяз.
Описание
Комментарий
identifier_type
string
-
тип
Обязательно при наличии identifier.
идентификатора
Возможные значения:
"gtin" - глобальный штрих-код кода
товара;
"barcode"
- штрих-код Barcode
(штрихкод
с
неправильной
контрольной цифрой)
identifier_party_id
number
-
идентификатор
Необязательно при
торговой сети
identifier_type=gtin, обязательно при
других типах
Параметры ответа:
Параметр
Тип
Обяз.
Описание
Комментарий
apiversion
number
+
Номер версии API
метода
result
array
-
Результат
При наличии ответа
*feed_id
number
+
Идентификатор
фида
Пример запроса:
curl -X POST "<url стенда>/nk/feed?supplier_key=YYY"
-H "accept: application/json"
-H "Content-Type: application/json"
-H "Authorization: Bearer <ТОКЕН>"
Примеры тела запроса
Создание карточки товара с кодом потребительской упаковки
617
[
{
"gtin": "469518017278",
"tnved": "3303",
"brand": "Nivea Men",
"categories": [30570],
"good_name": "Полное наименование товара",
"identified_by":
[
{
"value": "469518017278",
"type": "gtin",
"multiplier": 1,
"level": "trade-unit",
"unit":"кг"
}
],
"good_attrs": [
{
"attr_id": 2630,
"attr_value": "RU"
},
{
"attr_id": 2501,
"attr_value": "ДА",
"attr_value_type": "кг"
}
]
}
]
Создание карточки товара с кодом упаковок разного уровня (с вложениями)
618
[
{
"gtin": "469518017278",
"tnved": "3303",
"brand": "Nivea Men",
"categories": [30570],
"good_name": "Полное наименование товара",
"identified_by":
[
{
"value": "469518017278",
"type": "gtin",
"multiplier": 1,
"level": "trade-unit",
"unit":"шт"
},
{
"value": "469518017308",
"type": "gtin",
"multiplier": 10,
"level": "box",
"unit":"шт"
},
{
"value": "469518017360",
"type": "gtin",
"multiplier": 100,
"level": "pallet",
"unit":"шт"
}
],
"good_attrs": [
{
"attr_id": 13763,
"attr_type": "gtin",
"attr_value": "469518017308",
"gtin": "469518017360"
},
{
"attr_id": 13763,
"attr_type": "gtin",
"attr_value": "469518017278",
"gtin": "469518017308"
}
]
}
]
Создание карточки товара с техническим кодом товара
619
[
{
"is_tech_gtin": 1,
"tnved": "3303",
"brand": "Nivea Men",
"good_name": "Полное наименование товара",
"good_attrs": [
{
"attr_id": 2630,
"attr_value": "RU"
},
{
"attr_id": 2501,
"attr_value": "ДА",
"attr_value_type": "кг"
}
]
}
]
Создание нового товара JSON
[
{
"@id": "12",
"gtin": "4600000000015",
"tnved": "3303",
"brand": "brand_name",
"categories": [1],
"good_name": "Шоколад с Цельным Миндалём 55% 90г 14шт шоу-бокс",
"identified_by": [
{
"value": "4600000000015",
"type": "gtin",
"multiplier": 1,
"level": "trade-unit",
"unit":"кг"
},
{
"value": "4607065373085",
"type": "gtin",
"multiplier": 10,
"level": "box",
"unit":"кг"
}
],
"good_images": [
{
620
"photo_type": "default",
"photo_url": "https://your-site-name.com/photo.jpg",
"identifier": "4600000000015",
"identifier_type": "gtin",
"identifier_party_id": 2
},
{
"photo_type": "3ds",
"photo_url": [
]
}
],
"good_attrs": [
{
"attr_id": 2630,
"attr_value": "RU",
"gtin":"4607065373089"
},
{
"attr_id": 2501,
"attr_value": "ДА",
"attr_value_type": "кг"
}
]
}
]
Создание нового товара xml
<?xml version="1.0" encoding="UTF-8"?>
<entries>
<entry id="12">
<gtin>4600000000015</gtin>
<tnved>3303</tnved>
<brand>brand_name</brand>
<good_name>Йогурт легкий. Злаки + чернослив</good_name>
<identified_by>
<item>
<value>4600000000015</value>
<type>gtin</type>
<multiplier>1</multiplier>
<level>trade-unit</level>
<unit>кг</unit>
</item>
<item>
<value>4607065373085</value>
<type>gtin</type>
<multiplier>10</multiplier>
621
<level>box</level>
<unit>кг</unit>
</item>
</identified_by>
<categories>
<item>
1
</item>
</categories>
<good_images>
<item>
<photo_type>default</photo_type>
<photo_url>https://your-site-name.com/photo.jpg</photo_url>
<identifier>4600000000015</identifier>
<identifier_type>gtin</identifier_type>
<identifier_party_id>2</identifier_party_id>
</item>
<item>
<photo_type>3ds</photo_type>
<photo_url>
</photo_url>
</item>
</good_images>
<good_attrs>
<item>
<attr_id>2630</attr_id>
<attr_value>RU</attr_value>
<gtin>490122000021</gtin>
</item>
<item>
<attr_id>2501</attr_id>
<attr_value>RU</attr_value>
<attr_value_type>кг</attr_value_type>
</item>
</good_attrs>
</entry>
</entries>
Обновление существующего товара JSON
622
[
{
"@id": "13",
"good_id": 1939447,
"gtin": "4600000000015",
"identified_by": [
{
"value": "4607065373092",
"type": "gtin",
"multiplier": 1,
"level": "trade-unit"
}
],
"good_attrs": [
{
"attr_id": 5,
"attr_value": "46%"
},
{
"attr_id": 4540,
"attr_value": "ДА",
"attr_value_id": 12742580
},
{
"attr_id": 4424,
"attr_value_id": 12183715,
"delete": 1
}
]
}
]
Обновление существующего товара xml
623
<?xml version="1.0" encoding="UTF-8"?>
<entries>
<entry id="13">
<good_id>1939447</good_id>
<gtin>4600000000015</gtin>
<identified_by>
<item>
<value>4607065373092</value>
<type>gtin</type>
<multiplier>1</multiplier>
<level>trade-unit</level>
</item>
</identified_by>
<good_images>
<item>
<photo_type>default</photo_type>
<photo_url>https://your-site-name.com/photo.jpg</photo_url>
</item>
</good_images>
<good_attrs>
<item>
<attr_id>5</attr_id>
<attr_value>46%</attr_value>
</item>
<item>
<attr_id>4540</attr_id>
<attr_value>ДА</attr_value>
<attr_value_id>12742580</attr_value_id>
</item>
<item>
<attr_id>4424</attr_id>
<attr_value_id>12183715</attr_value_id>
<delete>1</delete>
</item>
</good_attrs>
</entry>
</entries>
Пример ответа:
1. В случае успеха:
1.1. Пример ответа json:
624
{
"apiversion": 3,
"result": {
"feed_id": 2131
}
}
1.2. Пример ответа xml:
<?xml version="1.0" encoding="UTF-8"?>
<root>
<apiversion>3</apiversion>
<result>
<feed_id>2131</feed_id>
</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>"):
625
{
"error_message": "Время действия <token> истекло"
}
2.5. Код 403, если указан неправильный ключ API:
{
"error_message":"Отсутствует доступ к ресурсу"
}
2.6. Код 413, если слишком большое тело запроса:
{
"error_message": "Слишком большой запрос"
}
2.7. Код 424, если ИНН токена не совпадает со значением ИНН аккаунта, найденного в
"Национальном каталоге":
{
"error_message": "ИНН токена не совпадает со значением ИНН найденного в НК
аккаунта"
}
10.18. Метод получения статуса фида по ID фида от его
заказчика
Метод предназначен для проверки статуса ранее отправленного пакета обновлений (фида).
Результат возможно получить только для тех фидов, которые были отправлены компанией
(лабораторией).
Примечание: Если пакет обновлений находится в статусе "Processing" более суток, то будет
автоматически переведен в статус "Rejected" и его потребуется направить на обработку
повторно.
Тип приватности: публичный
URL: /nk/feed-status
Метод: GET
Параметры запроса:
626
Параметр
Тип
Обяз.
Описание
Комментарий
apikey
string
-
Параметр,
Предоставляется по запросу службой
необходимый для
технической поддержки. Параметр
авторизации и
обязательный, если в заголовке
совершения
запроса не указан "token" ("Токен
запросов API
аутентификации") (см. Единая
аутентификация)
feed_id
string
+
Идентификатор
фида
verbose
boolean
-
Формат ответа
Возможные значения:
"false" ("отсутствует") - в ответ
выводится стандартный блок ошибок
обработки фида;
"true" - в ответ будет выведен
расширенный ответ по
произошедшим ошибкам обработки
фида
supplier_key
string
-
api_key аккаунта
Предназначен для лабораторий и
владельца товаров
других поставщиков контента,
которые от имени владельца товаров
размещают карточки товаров в его
аккаунте
Параметры ответа:
В запросе был указан параметр "verbose" со значением "true":
Параметр
Тип
Обяз.
Описание
Комментарий
apiversion
number
+
Номер версии API
метода
result
array
-
Результат
При наличии ответа
feed_id
number
+
ID запроса
status
string
+
Текущий статус
Возможные значения: Rejected -
запрос не принят;
Received - запрос получен, данные
на модерации;
Moderated - товары прошли
модерацию;
Signed - одобренные модератором
товары подписаны;
Processing - запрос получен, ожидает
обработки
627
Параметр
Тип
Обяз.
Описание
Комментарий
status_id
number
+
Идентификатор
Возможные значения: 0 - запрос не
статуса фида
принят;
1 - запрос получен, данные на
модерации;
2 - товары прошли модерацию;
3 - одобренные модератором товары
подписаны;
4 - запрос получен, ожидает
обработки
received_at
string
+
Время создания
В формате yyyy-MM-
фида
ddTHH:mm:ss.SSS’Z
status_updated_at
string
+
Время перехода
yyyy-MM-ddTHH:mm:ss.SSS’Z
(date-
фида в текущий
time)
статус
error_details
object
-
Ошибки,
обнаруженные
при валидации
контента
*items
array
-
Массив ошибок в
разрезе кода
товара
**id
number
+
Идентификатор
entry (карточки, в
направленном
пакете
обновлений)
**gtin
string
-
Код товара
**errors
object
-
Ошибки для
указанного кода
товара
***code
int
-
Числовой код
ошибки
***text
string
-
Текст ошибки
***attr_id
string
-
Идентификатор
атрибута, в
котором найдена
ошибка
*commonError
object
-
Ошибка при
разборе
информации, если
она произошла
**code
int
-
Числовой код
ошибки
628
Параметр
Тип
Обяз.
Описание
Комментарий
**text
string
-
Текст ошибки
В запросе был указан параметр "verbose" со значением "false" (или не был указан):
Параметр
Тип
Обяз.
Описание
Комментарий
apiversion
number
+
Номер версии API
метода
result
array
-
Результат
При наличии ответа
feed_id
number
+
ID запроса
status
string
+
Текущий статус
Возможные значения: Rejected -
запрос не принят;
Received - запрос получен, данные
на модерации;
Moderated - товары прошли
модерацию;
Signed - одобренные модератором
товары подписаны;
Processing - запрос получен, ожидает
обработки
status_id
number
+
Идентификатор
Возможные значения: 0 - запрос не
статуса фида
принят;
1 - запрос получен, данные на
модерации;
2 - товары прошли модерацию;
3 - одобренные модератором товары
подписаны;
4 - запрос получен, ожидает
обработки
received_at
string
+
Время создания
В формате yyyy-MM-
фида
ddTHH:mm:ss.SSS’Z
status_updated_at
string
+
Время перехода
(date-
фида в текущий
time)
result
array
-
Ошибки при
Ключами являются порядковые
валидации
номера товаров в переданной
контента
информации
*id
number
+
Идентификатор
Массив, содержащий в себе
entry (карточки, в
информацию об ошибках,
направленном
выявленных при обработке
пакете
информации о карточке товара
обновлений)
указанной в фиде под данным
идентификатором
629
Параметр
Тип
Обяз.
Описание
Комментарий
*totalErrors
string
-
Общее
количество
ошибок
item
array
-
Массив,
содержащий
информацию об
ошибках (может
не передаваться)
*id
number
-
Идентификатор
entry (карточки, в
направленном
пакете
обновлений)
*gtin
string
-
Глобальный
штрих-код к
которому
относится
сообщение
*good_id
int
-
Идентификатор
товара в каталоге
*attribute_id
int
-
Идентификатор
атрибута
*attribute_name
string
-
Наименование
атрибута
*status_code
int
-
Числовой код
ошибки
*status_message
string
-
Текст статуса
*message
string
-
Текст сообщения
Пример запроса:
curl -X GET "<url стенда>/nk/feed-status?feed_id=7126"
-H "accept: application/json"
-H "Authorization: Bearer <ТОКЕН>"
1. Примеры успешных ответов
1.1 Пример ответа успешно разобранной информации JSON:
630
{
"apiversion":3,
"result":{
"feed_id":7126,
"status":"Received",
"status_id":1,
"received_at":"2021-08-13T17:03:40Z",
"status_updated_at":"2021-08-14T12:03:40Z"
}
}
1.2 Пример успешно разобранной информации xml
<?xml version="1.0" encoding="UTF-8"?>
<root>
<apiversion>3</apiversion>
<result>
<feed_id>7126</feed_id>
<status_id>1</status_id>
<status>Received</status>
<received_at>2021-08-13T17:03:40Z</received_at>
<status_updated_at>2021-08-14T12:03:40Z</status_updated_at>
</result>
</root>
1.3 Пример на этапе модерации JSON
{
"apiversion":3,
"result":{
"feed_id":66707,
"status":"Moderated",
"status_id":2,
"received_at":"2021-08-02T13:42:23Z",
"status_updated_at":"2021-08-02T13:51:35Z",
"item":[
{
"id":0,
"gtin":null,
"good_id":null,
"attribute_id":"2716",
"attribute_name":"Заявленный объем",
"status_code":5,
"status_message":"Отменено",
"message":"Неверный объем"
},
{
"id":1,
631
"gtin":"4650065317337",
"good_id":"789817",
"attribute_id":"2716",
"attribute_name":"Заявленный объем",
"status_code":5,
"status_message":"Отменено",
"message":"Неверный объем"
},
{
"id":1,
"gtin":"4650065317337",
"good_id":"789817",
"attribute_id":"2716",
"attribute_name":"Заявленный объем",
"status_code":5,
"status_message":"Отменено",
"message":"Неверный объем"
},
{
"id":3,
"gtin":null,
"good_id":null,
"attribute_id":"13918",
"attribute_name":"Селектив",
"status_code":5,
"status_message":"Отменено",
"message":"Ошибка"
},
{
"id":5,
"gtin":null,
"good_id":null,
"attribute_id":"13918",
"attribute_name":"Селектив",
"status_code":5,
"status_message":"Отменено",
"message":"Ошибка"
}
]
}
}
1.4 Пример на этапе модерации xml
<?xml version="1.0" encoding="UTF-8"?>
<root>
<apiversion>3</apiversion>
<result>
<feed_id>66707</feed_id>
<status>Moderated</status>
632
<status_id>2</status_id>
<received_at>2021-08-02T13:42:23Z</received_at>
<status_updated_at>2021-08-02T13:51:35Z</status_updated_at>
<item>
<item>
<id>0</id>
<gtin/>
<good_id/>
<attribute_id>2716</attribute_id>
<attribute_name>Заявленный объем</attribute_name>
<status_code>5</status_code>
<status_message>Отменено</status_message>
<message>Неверный объем</message>
</item>
<item>
<id>0</id>
<gtin/>
<good_id/>
<attribute_id>2716</attribute_id>
<attribute_name>Заявленный объем</attribute_name>
<status_code>5</status_code>
<status_message>Отменено</status_message>
<message>Неверный объем</message>
</item>
<item>
<id>0</id>
<gtin>4650065317337</gtin>
<good_id>789817</good_id>
<attribute_id>2716</attribute_id>
<attribute_name>Заявленный объем</attribute_name>
<status_code>5</status_code>
<status_message>Отменено</status_message>
<message>Неверный объем</message>
</item>
<item>
<id>0</id>
<gtin>4650065317337</gtin>
<good_id>789817</good_id>
<attribute_id>2716</attribute_id>
<attribute_name>Заявленный объем</attribute_name>
<status_code>5</status_code>
<status_message>Отменено</status_message>
<message>Неверный объем</message>
</item>
<item>
<id>0</id>
<gtin>4650065317337</gtin>
<good_id>789817</good_id>
<attribute_id>2716</attribute_id>
<attribute_name>Заявленный объем</attribute_name>
<status_code>5</status_code>
633
<status_message>Отменено</status_message>
<message>Неверный объем</message>
</item>
<item>
<id>0</id>
<gtin>4650065317337</gtin>
<good_id>789817</good_id>
<attribute_id>2716</attribute_id>
<attribute_name>Заявленный объем</attribute_name>
<status_code>5</status_code>
<status_message>Отменено</status_message>
<message>Неверный объем</message>
</item>
<item>
<id>0</id>
<gtin/>
<good_id/>
<attribute_id>13918</attribute_id>
<attribute_name>Селектив</attribute_name>
<status_code>5</status_code>
<status_message>Отменено</status_message>
<message>Ошибка</message>
</item>
<item>
<id>0</id>
<gtin/>
<good_id/>
<attribute_id>13918</attribute_id>
<attribute_name>Селектив</attribute_name>
<status_code>5</status_code>
<status_message>Отменено</status_message>
<message>Ошибка</message>
</item>
<item>
<id>0</id>
<gtin>4650065317337</gtin>
<good_id>789817</good_id>
<attribute_id>13918</attribute_id>
<attribute_name>Селектив</attribute_name>
<status_code>5</status_code>
<status_message>Отменено</status_message>
<message>Ошибка</message>
</item>
<item>
<id>0</id>
<gtin>4650065317337</gtin>
<good_id>789817</good_id>
<attribute_id>13918</attribute_id>
<attribute_name>Селектив</attribute_name>
<status_code>5</status_code>
<status_message>Отменено</status_message>
634
<message>Ошибка</message>
</item>
<item>
<id>0</id>
<gtin>4650065317337</gtin>
<good_id>789817</good_id>
<attribute_id>13918</attribute_id>
<attribute_name>Селектив</attribute_name>
<status_code>5</status_code>
<status_message>Отменено</status_message>
<message>Ошибка</message>
</item>
</item>
</result>
</root>
1.5 Пример отклоненной информации JSON
{
"apiversion":3,
"result":{
"feed_id":7126,
"status_id":0,
"status":"Rejected",
"received_at":"2021-08-06T13:03:20Z",
"status_updated_at":"2021-08-06T13:03:30Z",
"result":{
"0":[
"GTIN 4600002576143 используется другим товаром"
],
"totalErrors":"1"
}
}
}
1.6 Пример отклоненной информации xml
635
<?xml version="1.0" encoding="UTF-8"?>
<root>
<apiversion>3</apiversion>
<result>
<feed_id>7126</feed_id>
<status_id>0</status_id>
<status>Rejected</status>
<received_at>2018-08-13T17:03:40Z</received_at>
<status_updated_at>2018-08-14T12:03:40Z</status_updated_at>
<result>
<item>GTIN 4600002576075 используется другим товаром</item>
<item>Атрибут #44 недоступен для редактирования</item>
</result>
<totalErrors>2</totalErrors>
</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 при отсутствии параметра feed_id:
{
"error_message": "Отсутствует обязательный параметр: feed_id"
}
2.4. Код 400 при недопустимом значении параметра feed_id:
636
{
"error_message": "Ошибка в параметрах запроса"
}
2.5. Код 401, если в заголовке запроса (параметр "Authorization: Bearer <token>") указан
неактуальный для аккаунта аутентификационный токен API ГИС МТ:
{
"error_message": "Указан неактуальный для аккаунта <token>"
}
2.6. Код 401, если истекло время действия аутентификационного токена API ГИС МТ,
указанного в заголовке запроса (параметр "Authorization: Bearer <token>"):
{
"error_message": "Время действия <token> истекло"
}
2.7. Код 403, если указан неправильный ключ API:
{
"error_message":"Отсутствует доступ к ресурсу"
}
2.8. Код 403 при указании feed_id, не принадлежащего пользователю:
{
"error_message": "Отсутствует доступ к ресурсу"
}
2.9. Код 404, если не найдена карточка продукта:
{
"error_message": "Данные не найдены"
}
2.10. Код 424, если ИНН токена не совпадает со значением ИНН аккаунта, найденного в
"Национальном каталоге" :
{
"error_message": "ИНН токена не совпадает со значением ИНН найденного в НК
аккаунта"
}
637
10.19. Метод отправки на модерацию карточки товаров в
статусе "Черновик"
Метод отправляет на модерацию, для указанных в запросе good_id или код товара+ИНН,
созданные ранее карточки товаров в статусе "Черновик"
Тип приватности: публичный
URL: /nk/feed-moderation
Если указаны более одного из обязательных параметров, то возвращается результат выборки,
соответствующий данному алгоритму:
• good_id - при указании возвращается товар с соответствующим идентификатором или
ошибка 404. При этом код товара+inn игнорируются.
• gtin+inn - при указании возвращается товар с соответствующим кодом товара для inn или
ошибка 404.
Метод: GET
Параметры запроса:
Параметр
Тип
Обяз.
Описание
Комментарий
apikey
string
-
Параметр,
Предоставляется по запросу службой
необходимый для
технической поддержки.
авторизации и
совершения
Параметр обязательный, если в
запросов API
заголовке запроса не указан "token"
("Токен аутентификации") (см.
Единая аутентификация)
good_id
string
-
ID товара в
Обязательно, если не указаны gtin и
каталоге
inn
gtin
string
-
Код товара
Обязательно, если не указан good_id
inn
string
-
ИНН аккаунта
Обязательно, если не указан good_id
Параметры ответа:
Параметр
Тип
Обяз.
Описание
Комментарий
apiversion
number
+
Версия API
result
array
-
Результат
При наличии ответа
*good_draft_id
number
+
ID шаблона
товара в каталоге
*error
string
-
Текст ошибки
Параметр указывается при наличии
ошибки
Пример запроса:
при указании good_id:
638
curl -X GET "<url стенда>/nk/feed-moderation?good_id=7126"
-H "accept: application/json"
-H "Authorization: Bearer <ТОКЕН>"
при указании gtin+inn:
curl -X GET "<url стенда>/nk/feed-moderation?gtin=04640002660886&inn=123455678"
-H "accept: application/json"
-H "Authorization: Bearer <ТОКЕН>"
Пример ответа:
1.
В случае успеха:
{
"apiversion": 3 ,
"result": {
"good_draft_id": 123456 ,
"error": "Черновик GTIN 02XXXXXXXX601050000383 не в том статусе."
}
}
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>"
}
639
2.4. Код 401, если истекло время действия аутентификационного токена API ГИС МТ,
указанного в заголовке запроса (параметр "Authorization: Bearer <token>"):
{
"error_message": "Время действия <token> истекло"
}
2.5. Код 403, если указан неправильный ключ API:
{
"error_message":"Отсутствует доступ к ресурсу"
}
2.6. Код 424, если ИНН токена не совпадает со значением ИНН аккаунта, найденного в
"Национальном каталоге":
{
"error_message": "ИНН токена не совпадает со значением ИНН найденного в НК
аккаунта"
}
10.20. Метод определения кода принадлежности товара к
маркируемым товарным группам
Метод предназначен для определения принадлежности товара с указанными КИ или кодами ТН
ВЭД к маркируемым товарным группам. В одном запросе не может быть суммарно указано
более 100 КИ и кодов ТН ВЭД.
URL: /nk/mark-check
Метод: POST
Тип приватности: приватный
Пример запроса:
curl -X POST "<url стенда>/nk/mark-check?format=json"
-H "accept: application/json"
-H "Content-Type: application/json"
-H "Authorization: Bearer <ТОКЕН>"
--data-raw "{\"gtins\":[\"string\"],\"tnveds\":[\"string\"]}"
Пример тела запроса:
640
{
"gtins":[
"04610043553256",
"04610043553287",
"03331436808029",
"0783320402685",
"3234567890126",
"038000232671",
"04640076801444",
"04640076801352",
"4810978019678",
"02900001633116",
"7891024188279"
],
"tnveds":[
"63",
"0401",
"6302",
"040410",
"0404100200",
"6404",
"9001200000"
]
}
Параметры тела запроса:
Параметр
Тип
Обяз.
Описание
Комментарий
apikey
string
-
Параметр,
Предоставляется по запросу службой
необходимый для
технической поддержки.
авторизации и
совершения
Параметр обязательный, если в заголовке
запросов API
запроса не указан "token" ("Токен
аутентификации") (см. Единая
аутентификация)
gtins
array[stri
-
Массив,
ng]
содержащий коды
товаров
tnveds
array[stri
-
Массив,
При отсутствии товара в системе код ТН
ng]
содержащий коды
ВЭД не указывается
ТН ВЭД, с
которым связан
указанный в
запросе код
товара.
Примеры ответа:
641
1. В случае успеха:
1.1. Пример ответа в формате JSON
{
"apiversion": 3,
"result": {
"gtins": [
{
"gtin": "783320402685",
"tnved": "3303",
"is_marked": "Товар подлежит маркировке",
"is_marked_code": 1
},
{
"gtin": "3234567890126",
"tnved": null,
"is_marked": "Товар не найден",
"is_marked_code": 2
}
],
"tnveds": [
{
"tnved": "63",
"is_marked": "По указанному коду ТНВЭД невозможно установить необходимость
маркировки. Уточните код ТНВЭД товара",
"is_marked_code": 3
},
{
"tnved": "6302",
"is_marked": "Товар с указанным кодом ТНВЭД подлежит маркировке",
"is_marked_code": 1
},
{
"tnved": "040410",
"is_marked": "ТНВЭД не найден",
"is_marked_code": 2
},
{
"tnved": "2008",
"is_marked": "Товар с указанным кодом ТНВЭД не подлежит маркировке",
"is_marked_code": 0
}
]
}
}
Параметры ответа:
642
Параметр
Тип
Обяз.
Описание
Комментарий
apiversion
number
+
Версия API
result
object
+
Результат
При наличии ответа
*gtins
array
-
массив,
содержащий
полученные коды
товаров и коды
ТН ВЭД, к
которым
привязаны коды
товаров
содержится
информация о
маркировке и
коде ответа
**gtin
string
+
КИ, в отношении
которого
проводился
поиск признака
маркируемости
товара
**tnved
string
+
Код ТН ВЭД, с
При отсутствии товара в системе код ТН
которым связан
ВЭД не указывается
указанный в
запросе код
товара
**is_marked
string
+
Текст ответа,
содержащий
информацию о
необходимости
маркировки
товара с
указанным GTIN
**is_marked
integer
+
Коды ответов
Возможные значения:
_code
(int64)
0 - товар не подлежит маркировке;
1 - товар подлежит маркировке;
2 - товар не найден
Возможные значения для товарных
остатков (товары с КИ, начинающимся с
029):
1 - остаток подлежит маркировке;
2 - остаток не найден
643
Параметр
Тип
Обяз.
Описание
Комментарий
*tnveds
array
-
Массив,
содержащий
коды ТН ВЭД
или коды групп
ТН ВЭД
**tnved
string
+
Код ТН ВЭД
**is_marked
string
+
Текст ответа,
содержащий
информацию о
необходимости
маркировки
товара с
указанным кодом
ТН ВЭД
**is_marked
integer
+
Коды ответов
Возможные значения:
_code
(int64)
0 - Товар с указанным кодом ТН ВЭД не
подлежит маркировке;
1 - Товар с указанным кодом ТН ВЭД
подлежит маркировке;
2 - ТН ВЭД не найден;
3 - По указанному коду ТН ВЭД
невозможно установить необходимость
маркировки. Уточните код ТН ВЭД
товара
1.2. Пример ответа xml
644
<?xml version="1.0" encoding="UTF-8"?>
<root>
<apiversion>3</apiversion>
<result>
<gtins>
<item>
<gtin>783320402685</gtin>
<tnved>3303</tnved>
<is_marked>Товар подлежит маркировке</is_marked>
<is_marked_code>1</is_marked_code>
</item>
<item>
<gtin>3234567890126</gtin>
<tnved></tnved>
<is_marked>Товар не найден</is_marked>
<is_marked_code>2</is_marked_code>
</item>
</gtins>
<tnveds>
<item>
<tnved>63</tnved>
<is_marked>По указанному коду ТНВЭД невозможно установить
необходимость маркировки. Уточните код ТНВЭД товара</is_marked>
<is_marked_code>3</is_marked_code>
</item>
<item>
<tnved>6302</tnved>
<is_marked>Товар с указанным кодом ТНВЭД подлежит
маркировке</is_marked>
<is_marked_code>1</is_marked_code>
</item>
<item>
<tnved>040410</tnved>
<is_marked>ТНВЭД не найден</is_marked>
<is_marked_code>2</is_marked_code>
</item>
<item>
<tnved>2008</tnved>
<is_marked>Товар с указанным кодом ТНВЭД не подлежит
маркировке</is_marked>
<is_marked_code>0</is_marked_code>
</item>
</tnveds>
</result>
</root>
2. В случае ошибок:
2.1. Код 400, если одновременно указан и "apikey" в URL запроса, и аутентификационный
токен API ГИС МТ в заголовке запроса (параметр "Authorization: Bearer <token>"):
645
{
"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> истекло"
}
2.5. Код 403, если указан неправильный ключ API:
{
"error_message":"Отсутствует доступ к ресурсу"
}
2.6. Код 424, если ИНН токена не совпадает со значением ИНН аккаунта, найденного в
"Национальном каталоге":
{
"error_message": "ИНН токена не совпадает со значением ИНН найденного в НК
аккаунта"
}
11. Методы "Станции управления заказами"
646
11.1. Метод получения токена аутентификации в СУЗ
Метод используется для получения маркера безопасности (токена аутентификации) в СУЗ. Для
получения токена для СУЗ в строке запроса указывается параметр «omsConnection»
-
уникальный
идентификатор
соединения
(внешнего
подключения),
присвоенный
зарегистрированной установке интеграционного решения.
URL: /auth/simpleSignIn/{omsConnection}
Метод: POST
Пример строки запроса:
curl -X POST "<url стенда>/auth/simpleSignIn/11b1abc9-f4ee-47db-8a20-f80ac83504e8"
-H "accept: application/json"
-H "Content-Type: application/json"
--data-raw "{"uuid":"b223216d-5c43-416a-b2c3-39c79240c08a","data":"<Подписанные
данные в base64>"}"
Параметры строки запроса:
Параметр
Тип
Обяз.
Описание
Комментарий
omsConnection
string
+
Уникальный идентификатор
соединения (внешнего
подключения),
присвоенный
зарегистрированной
установке интеграционного
решения. Выдается при
регистрации установки
интеграционного решения
Примечание: на переходном этапе получение уникального идентификатора соединения
(внешнего подключения - "omsConnection") также будет доступно посредством регистрации в
пользовательском интерфейсе СУЗ клиентского устройства (системы), которое будет
взаимодействовать через API СУЗ.
Пример тела запроса:
{
"uuid":"b223216d-5c43-416a-b2c3-39c79240c08a",
"data":"<Подписанные данные в base64>"
}
Параметры тела запроса:
647
Параметр
Тип
Обяз.
Описание
Комментарий
uuid
string
+
Уникальный идентификатор
сгенерированных
случайных данных
data
string
+
Cлучайные данные в
base64, подписанные УКЭП
участника оборота товаров,
зарегистрированного в ГИС
МТ (присоединённая
электронная подпись)
Пример ответа:
{
"token": "6f9954c5-cbc8-43ff-bc5c-7021418fbef3"
}
Параметры ответа:
Параметр
Тип
Обяз.
Описание
Комментарий
token
string
-
Токен аутентификации.
Токен действителен в
течение 10 часов. Параметр
возвращается в случае
успешного ответа
code
string
-
Код ошибки
error_message
string
-
Сообщение об ошибке
Возвращается в случае
ошибки
description
string
-
Описание ошибки
Возвращается в случае
ошибки
Список сокращений, условных обозначений и
терминов
Сокращение
Описание
API
Application Programming Interface (Интерфейс программирования
приложений)
Base64
Стандарт кодирования двоичных данных при помощи только 64
символов ASCII
CSV
(Comma-Separated Values) текстовый формат, предназначенный для
представления табличных данных
GTIN
Код товара
648
Сокращение
Описание
JSON
JavaScript Object Notation (текстовый формат обмена данными,
основанный на JavaScript)
MIME
Multipurpose Internet Mail Extensions (стандарт, описывающий
передачу различных типов данных по электронной почте)
pdf
Portable Document Format (межплатформенный открытый формат
электронных документов)
RFC
Request for Comments (документ из серии пронумерованных
информационных документов Интернета, содержащих
технические спецификации и стандарты, широко применяемые во
всемирной сети)
SGTIN
Serialized Global Trade Item Number (индивидуальный
идентификационный код потребительской упаковки для
прослеживаемости в (GTIN + индивидуальный серийный номер
вторичной (потребительской) упаковки или первичной упаковки, в
случае отсутствия вторичной)
URL
Uniform Resource Locator (единый указатель ресурса)
UTF-8
Unicode Transformation Format, 8-bit (формат преобразования
Юникода, 8-бит)
UUID
Universally unique identifier. Универсальный уникальный
идентификатор участника оборота товаров. Записывается в виде
последовательности шестнадцатеричных цифр в нижнем регистре,
разделённых знаками минуса на несколько групп, в следующем
порядке: группа из 8 цифр, три группы из 4 цифр и группа из 12
цифр, что в сумме составляет 32 цифры и представляет 128 бит.
Пример UUID: a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11
XML
eXtensible Markup Language (расширяемый язык разметки)
XSD
XML Schema definition (язык описания структуры XML
документа)
АТК
Агрегированный таможенный код
АСУТП
Автоматизированная система управления технологическим
процессом
БД
База данных
ВСД
Ветеринарный сопроводительный документ (транспортный
сопроводительный документ)
ГИС МТ
Государственная информационная система мониторинга за
оборотом товаров
ЕНВД
Единый налог на вменённый доход
ЕСХН
Единый сельскохозяйственный налог
ДИС
Документ об изменении стоимости отгруженных товаров
(выполненных работ, оказанных услуг), переданных
имущественных прав
649
Сокращение
Описание
ДОП
Первичный документ. Например: накладная или акт
ДТ
Декларация на товары
ДС
Декларация о соответствии
ЕАЭС
Евразийский экономический союз
ЕГРИП
Единый государственный реестр индивидуальных
предпринимателей
ЕГРЮЛ
Единый государственный реестр юридических лиц
ИНН
Идентификационный номер налогоплательщика
ИП
Индивидуальный предприниматель
КИ
Код идентификации
КИГУ
Код идентификации групповой упаковки
КИК
Код идентификации комплекта
КИН
Код идентификации набора (указывается по аналогии с КИ)
КИТУ
Код идентификации транспортной упаковки (указывается от 18 до
74 символов включительно: цифры, буквы латинского алфавита,
спецсимволы: A-Z a-z 0-9 % & ' " ( ) * + , - _ . / : ; < = > ? !)
КМ
Код маркировки
КСЧФ
Корректировочная счет-фактура, применяемая при расчетах по
налогу на добавленную стоимость
КСЧФ ДИС
Корректировочная счет-фактура, применяемая при расчетах по
налогу на добавленную стоимость, и документ об изменении
стоимости отгруженных товаров (выполненных работ, оказанных
услуг), переданных имущественных прав
МОД
Места осуществления деятельности
МОТП
Мониторинг оборота табачной продукции
МОД
Место осуществления деятельности
НДС
Налог на добавленную стоимость
НК
Национальный каталог
НМПТ
Наименование места происхождения товара
ОКСМ
Общероссийский классификатор стран мира
ОСН
Общая система налогообложения
РАФП
Реестр аккредитованных филиалов, представительств
иностранных юридических лиц
РБ
Республика Беларусь
РД
Разрешительная документация
650
Сокращение
Описание
РЭ
Регистратор эмиссии
СГР
Свидетельство о государственной регистрации
СКПТ
Код подакцизного товара
СС
Сертификат соответствия
СУЗ
Станция управления заказами
СЧФ
Счёт-фактура
СЧФ ДОП
См. УПД
ТГ
Товарная группа
ТН ВЭД ЕАЭС
Товарная номенклатура внешнеэкономической деятельности
Евразийского экономического союза
ТСР
Технические средства реабилитации
УД
Универсальный документ
УКД
Универсальный корректировочный документ
УКДи
Исправленный универсальный корректировочный документ
УКЭП
Усиленная квалифицированная электронная подпись
УНП
Учётный номер плательщика
УОТ
Участник оборота товара
УПД
Универсальный передаточный документ
УПДи
Исправленный универсальный передаточный документ
УСН
Упрощённая система налогообложения
ФД
Фискальный документ
ФТС
Федеральная таможенная служба
ФОИВ
Федеральные органы исполнительной власти
ФПД
Фискальный признак документа
ФРАП
Федеральная служба по регулированию алкогольного рынка
ЦРПТ
Центр развития перспективных технологий
ЭДО
Электронный документооборот
ЮЛ
Юридическое лицо
651
Приложение 1. Справочники
Справочник "Список поддерживаемых товарных групп"
Код в БД
Наименование
Описание
1
lp
Предметы одежды, бельё постельное, столовое, туалетное и
кухонное
2
shoes
Обувные товары
3
tobacco
Табачная продукция
4
perfumery
Духи и туалетная вода
5
tires
Шины и покрышки пневматические резиновые новые
6
electronics
Фотокамеры (кроме кинокамер), фотовспышки и лампы-
вспышки
8
milk
Молочная продукция
9
bicycle
Велосипеды и велосипедные рамы
10
wheelchairs
Кресла-коляски
12
otp
Альтернативная табачная продукция
13
water
Упакованная вода
14
furs
Товары из натурального меха
15
beer
Пиво, напитки, изготавливаемые на основе пива,
слабоалкогольные напитки
16
ncp
Никотиносодержащая продукция
17
bio
Биологические активные добавки к пище
19
antiseptic
Антисептики
Справочник "Типы документов"
Код
Наименование
Формат
AGGREGATION_DOCUMENT
Агрегация
JSON
AGGREGATION_DOCUMENT_CSV
Агрегация
CSV
AGGREGATION_DOCUMENT_XML
Агрегация
XML
SETS_AGGREGATION
Формирование наборов
JSON
SETS_AGGREGATION_CSV
Формирование наборов
CSV
SETS_AGGREGATION_XML
Формирование наборов
XML
DISAGGREGATION_DOCUMENT
Расформирование агрегата
JSON
DISAGGREGATION_DOCUMENT_CSV
Расформирование агрегата
CSV
DISAGGREGATION_DOCUMENT_XML
Расформирование агрегата
XML
652
Код
Наименование
Формат
REAGGREGATION_DOCUMENT
Трансформация агрегата
JSON
REAGGREGATION_DOCUMENT_XML
Трансформация агрегата
XML
REAGGREGATION_DOCUMENT_CSV
Трансформация агрегата
CSV
LP_INTRODUCE_GOODS
Ввод в оборот. Производство РФ
JSON
LP_INTRODUCE_GOODS_CSV
Ввод в оборот. Производство РФ
CSV
LP_INTRODUCE_GOODS_XML
Ввод в оборот. Производство РФ
XML
LP_SHIP_GOODS
Отгрузка
JSON
LP_SHIP_GOODS_CSV
Отгрузка
CSV
LP_SHIP_GOODS_XML
Отгрузка
XML
LP_SHIP_RECEIPT
Отгрузка с выводом из оборота
JSON
LP_SHIP_RECEIPT_CSV
Отгрузка с выводом из оборота
CSV
LP_SHIP_RECEIPT_XML
Отгрузка с выводом из оборота
XML
LP_SHIP_GOODS_CROSSBORDER
Отгрузка при трансграничной торговле
JSON
EAS_GTIN_CROSSBORDER_EXPORT
Отгрузка в государствах-членах ЕАЭС с
JSON
признанием КИ при объёмно-сортовом
учёте (экспорт)
EAS_GTIN_CROSSBORDER_EXPORT_C
Отгрузка в государствах-членах ЕАЭС с
CSV
SV
признанием КИ при объёмно-сортовом
учёте (экспорт)
EAS_GTIN_CROSSBORDER_IMPORT
Отгрузка из государств-членов ЕАЭС с
JSON
признанием КИ при объёмно-сортовом
учёте (импорт)
EAS_CROSSBORDER
Отгрузка из ЕАЭС с признанием КИ
JSON
LP_ACCEPT_GOODS
Приёмка
JSON
LP_ACCEPT_GOODS_CSV
Приёмка
CSV
LP_ACCEPT_GOODS_XML
Приёмка
XML
LP_ACCEPT_GOODS_CSV
Приёмка
CSV
EAS_GTIN_CROSSBORDER_ACCEPTAN
Приёмка отгрузки из государств-членов
JSON
CE
ЕАЭС с признанием КИ при объёмно-
сортовом учёте
EAS_GTIN_CROSSBORDER_ACCEPTAN
Приёмка отгрузки из государств-членов
CSV
CE_CSV
ЕАЭС с признанием КИ при объёмно-
сортовом учёте
LK_REMARK
Перемаркировка
JSON
LK_REMARK_CSV
Перемаркировка
CSV
LK_REMARK_XML
Перемаркировка
XML
653
Код
Наименование
Формат
LP_GOODS_IMPORT
Ввод в оборот. Производство вне ЕАЭС
JSON
LP_GOODS_IMPORT_CSV
Ввод в оборот. Производство вне ЕАЭС
CSV
LP_GOODS_IMPORT_XML
Ввод в оборот. Производство вне ЕАЭС
XML
LP_CANCEL_SHIPMENT
Отмена отгрузки
JSON
LP_CANCEL_SHIPMENT_CROSSBORDE
Отмена отгрузки при трансграничной
JSON
R
торговле
LK_KM_CANCELLATION
Списание не нанесённых КИ
JSON
LK_KM_CANCELLATION_XML
Списание не нанесённых КИ
XML
LK_KM_CANCELLATION_CSV
Списание не нанесённых КИ
CSV
LK_APPLIED_KM_CANCELLATION
Списание нанесённых КИ
JSON
LK_APPLIED_KM_CANCELLATION_X
Списание нанесённых КИ
XML
ML
LK_APPLIED_KM_CANCELLATION_CS
Списание нанесённых КИ
CSV
V
LK_CONTRACT_COMMISSIONING
Ввод в оборот товара. Контрактное
JSON
производство РФ
LK_CONTRACT_COMMISSIONING_CS
Ввод в оборот товара. Контрактное
CSV
V
производство РФ
LK_CONTRACT_COMMISSIONING_XM
Ввод в оборот товара. Контрактное
XML
L
производство РФ
LK_INDI_COMMISSIONING
Ввод в оборот товара. Полученных от
JSON
физических лиц
LK_INDI_COMMISSIONING_CSV
Ввод в оборот товара. Полученных от
CSV
физических лиц
LK_INDI_COMMISSIONING_XML
Ввод в оборот товара. Полученных от
XML
физических лиц
LP_RETURN
Возврат в оборот
JSON
LP_RETURN_CSV
Возврат в оборот
CSV
LP_RETURN_XML
Возврат в оборот
XML
OST_DESCRIPTION
Описание остатков товара
JSON
OST_DESCRIPTION_CSV
Описание остатков товара
CSV
OST_DESCRIPTION_XML
Описание остатков товара
XML
LP_INTRODUCE_OST
Ввод в оборот. Маркировка остатков
JSON
LP_INTRODUCE_OST_CSV
Ввод в оборот. Маркировка остатков
CSV
LP_INTRODUCE_OST_XML
Ввод в оборот. Маркировка остатков
XML
CROSSBORDER
Ввод в оборот. Трансграничная торговля
JSON
654
Код
Наименование
Формат
CROSSBORDER_CSV
Ввод в оборот. Трансграничная торговля
CSV
CROSSBORDER_XML
Ввод в оборот. Трансграничная торговля
XML
LK_RECEIPT
Вывод из оборота
JSON
LK_RECEIPT_CSV
Вывод из оборота
CSV
LK_RECEIPT_XML
Вывод из оборота
XML
LP_INTRODUCE_GOODS_CROSSBORD
Ввод в оборот. На территории стран ЕАЭС
JSON
ER_CSD
(контрактное производство)
LP_INTRODUCE_GOODS_CROSSBORD
Ввод в оборот. На территории стран ЕАЭС
XML
ER_CSD_XML
(контрактное производство)
LP_INTRODUCE_GOODS_CROSSBORD
Ввод в оборот. На территории стран ЕАЭС
CSV
ER_CSD_CSV
(контрактное производство)
LP_FTS_INTRODUCE
Ввод в оборот. Импорт с ФТС
JSON
LP_FTS_INTRODUCE_XML
Ввод в оборот. Импорт с ФТС
XML
LP_FTS_INTRODUCE_CSV
Ввод в оборот. Импорт с ФТС
CSV
LP_FTS_INTRODUCE_RESPONSE
Декларация на товары
JSON
ATK_AGGREGATION
Формирование АТК
JSON
ATK_AGGREGATION_CSV
Формирование АТК
CSV
ATK_AGGREGATION_XML
Формирование АТК
XML
ATK_TRANSFORMATION
Трансформация АТК
JSON
ATK_TRANSFORMATION_CSV
Трансформация АТК
CSV
ATK_TRANSFORMATION_XML
Трансформация АТК
XML
ATK_DISAGGREGATION
Расформирование АТК
JSON
ATK_DISAGGREGATION_CSV
Расформирование АТК
CSV
ATK_DISAGGREGATION_XML
Расформирование АТК
XML
RECEIPT
Чек
Формир
уется
операто
ром
фискаль
ных
данных
RECEIPT_RETURN
Чек возврата
Формир
уется
операто
ром
фискаль
ных
данных
655
Код
Наименование
Формат
AGGREGATION_DOCUMENT
Документ агрегации (для товарных групп
JSON
"Табачная продукция" и "АТП")
AGGREGATION_DOCUMENT
Документ агрегации (для товарных групп
XML
"Табачная продукция" и "АТП")
WRITE_OFF
Документ списания (для товарных групп
JSON
"Табачная продукция" и "АТП")
WRITE_OFF
Документ списания (для товарных групп
XML
"Табачная продукция" и "АТП")
EAS_CROSSBORDER_EXPORT
Отгрузка в ЕАЭС с признанием КИ
JSON
(экспорт)
EAS_CROSSBORDER_EXPORT_CSV
Отгрузка в ЕАЭС с признанием КИ
CSV
(экспорт)
EAS_CROSSBORDER_EXPORT_ACCEP
Приёмка отгрузки в ЕАЭС с признанием
JSON
TANCE
КИ (экспорт)
Для создания универсальных документов необходимо использовать Описание API ЭДО Lite.
Документы поступают от коммерческого ЭДО.
Наименование универсального документа
Код
УПД ДОП (накладная)
UNIVERSAL_TRANSFER_DOCUMENT
УДП СЧФ (счет-фактура)
UNIVERSAL_TRANSFER_DOCUMENT
УПД СЧФ ДОП (счет-фактура+накладная)
UNIVERSAL_TRANSFER_DOCUMENT
УПД(и) ДОП (на накладную)
UNIVERSAL_TRANSFER_DOCUMENT_FIX
УПД(и) СЧФ (на счет-фактуру)
UNIVERSAL_TRANSFER_DOCUMENT_FIX
УПД(и) СЧФ ДОП
UNIVERSAL_TRANSFER_DOCUMENT_FIX
УКД ДИС (на накладную)
UNIVERSAL_CORRECTION_DOCUMENT
УКД КСЧФ (на счет-фактуру)
UNIVERSAL_CORRECTION_DOCUMENT
УКД КСЧФ ДИС
UNIVERSAL_CORRECTION_DOCUMENT
УКД(и) ДИС (исправление корректировки
UNIVERSAL_CORRECTION_DOCUMENT_FI
накладной)
X
УКД(и) КСЧФ (исправление корректировочной
UNIVERSAL_CORRECTION_DOCUMENT_FI
счет-фактуры)
X
УКД(и) КСЧФ ДИС
UNIVERSAL_CORRECTION_DOCUMENT_FI
X
Универсальный документ отмены
UNIVERSAL_CANCEL_DOCUMENT
Справочник "Статусы проверок УПД"
Код
Наименование
656
VERIFI
Успешно проверен
ED
NOT_V
Ошибка проверок
ALID
NOT_F
Не найден
OUND
IN_PRO
В обработке
GRESS
AWAITI
В ожидании
NG
Справочник "Типы договоров"
Код в
Наименование
БД
-2
Договор о подключении к ГИС МТ
-3
Договор по предоставлению РЭ
-4
Договор на услуги по предоставлению КИ
-5
Договор по предоставлению РВ
-6
Договор ЭДО
-7
Договор безвозмездного пользования движимым имуществом
-8
Договор по предоставлению РЭ УОТ путем УД
-9
Заявка Участника о предоставлении Оборудования РВ
-10
Заявка Участника о предоставлении Оборудования РЭ
-11
Заявка УОТ о предоставлении РЭ путем УД
-12
Акт приема-передачи Оборудования
-13
Акт возврата Оборудования
-14
Акт проверки состояния и условий эксплуатации Оборудования
-15
Акт выполненных работ
-16
Уведомление о предоставлении Участнику права пользования Оборудованием путем
предоставления УД
-17
Дополнительное соглашение
-18
Дополнительное соглашение (нерезидент)
-19
Соглашение об электронном взаимодействии
-20
Письмо об осуществлении оплаты третьей стороной
-21
Договор на оказание возмездных услуг по предоставлению КИ (с нерезидентом)
-22
Договор по предоставлению РЭ (с нерезидентом)
657
-23
Договор по предоставлению РЭ УОТ путем УД (с нерезидентом)
-24
Информационное письмо
-25
Уведомление от Оператора
-26
Заявка Участника о предоставлении Оборудования РЭ (нерезидент)
-27
Заявка Участника о предоставлении РЭ путем УД (нерезидент)
-28
Уведомление Участника о передаче РВ
-29
Акт о невозможности исполнения обязательств
-100
Счет на оплату
-10000
Акт сверки
Справочник "Типы эмиссии КИ"
Код
Описание
LOCAL
Производство РФ
FOREIGN
Ввезён в РФ
REMAINS
Маркировка остатков;
CROSSBORDER
Ввезён из стран ЕАЭС
REMARK
Перемаркировка
COMMISSION
Принят на комиссию от физического лица
Справочник "Статусы КИ"
Актуальные статусы
Код
Описание
EMITTED
Эмитирован. Выпущен
APPLIED
Эмитирован. Получен
INTRODUCED
В обороте
WRITTEN_OFF
Списан
RETIRED
Выбыл
WITHDRAWN
Выбыл (только для ТГ "Табачная продукция" и "Альтернативная табачная
продукция")
INTRODUCED_R
Возвращён в оборот (только для ТГ "Табачная продукция" и
ETURNED
"Альтернативная табачная продукция")
DISAGGREGATI
Расформирован (только для КИТУ, АТК и набора всех ТГ, кроме "Табачная
ON
продукция" и "Альтернативная табачная продукция")
DISAGGREGATE
Расформирован (только для КИТУ и АТК ТГ "Табачная продукция" и
D
"Альтернативная табачная продукция")
658
Актуальные особые состояния
Код
Описание
Актуальный
статус
EMPTY
Значение отсутствует
RESERVED_NOT_USED
Зарезервировано. Не использовать
INTRODUCED
INDIVIDUAL
КиЗ индивидуализирован (только для ТГ
EMITTED,
"Товары из натурального меха")
APPLIED
NON_INDIVIDUAL
КиЗ не индивидуализирован (только для ТГ
EMITTED,
"Товары из натурального меха")
APPLIED
WAIT_SHIPMENT
Ожидает подтверждения приёмки
INTRODUCED
EXPORTED
Используется для документов экспорта
LOAN_RETIRED
Выведен из оборота по договору рассрочки
RETIRED
REMARK_RETIRED
Выведен из оборота при перемаркировке
WRITTEN-OFF
WAIT_TRANSFER_TO_O
Ожидает передачу собственнику (контрактное
INTRODUCED
WNER
производство)
WAIT_REMARK
Товар ожидает перемаркировку или КИ списан
WRITTEN_OFF
после нанесения на товар
RETIRED_CANCELLATIO
Списание
WRITTEN_OFF
N
RETIRED_DONATION
Безвозмездная передача, применяется в
RETIRED
документе "Отгрузка"
RETIRED_STATE_ENTER
Приобретение государственным предприятием,
RETIRED
PRISE
применяется в документе "Отгрузка"
RETIRED_NO_RETAIL_US
Использование для собственных нужд
RETIRED
E
покупателем, применяется в документе
"Отгрузка"
RETIRED_BEYOND_EEC_
Экспорт за пределы стран ЕАЭС, применяется
RETIRED
EXPORT
в документе Вывод из оборота
RETIRED_REMOTE_SALE
Продажа по образцам, дистанционный способ
RETIRED
продажи, применяется в документе "Вывод из
оборота"
RETIRED_EEC_EXPORT
Экспорт в страны ЕАЭС, применяется в
RETIRED
документе "Вывод из оборота"
RETIRED_RETURN
Возврат физическому лицу, применяется в
RETIRED
документе "Вывод из оборота"
RETIRED_DAMAGE_LOSS
Утрата или повреждение, применяется в
RETIRED
документе "Вывод из оборота"
RETIRED_DESTRUCTION
Уничтожение, применяется в документе
RETIRED
"Вывод из оборота"
659
Код
Описание
Актуальный
статус
RETIRED_CONFISCATION
Конфискация, применяется в документе
RETIRED
"Вывод из оборота"
RETIRED_LIQUIDATION
Ликвидация предприятия, применяется в
RETIRED
документе "Вывод из оборота"
RETIRED_ENTERPRISE_U
Использование для собственных нужд
RETIRED
SE
FTS_RESPOND_NOT_OK
Отрицательное решение ФТС
APPLIED
FTS_RESPOND_WAITING
Ожидает подтверждение ФТС
APPLIED
FTS_CONTROL
На контроле ФТС
APPLIED
IN_GRAY_ZONE
Находится в Серой зоне
APPLIED
Справочник "Типы производства"
Код
Описание
LOCAL
Производство РФ
FOREIGN
Ввезен в РФ
Справочник "Типы упаковки"
Код
Описание
Ограничение
Примечание для
Примечание для
использования в
товарных групп
прочих
зависимости от товарной
"Альтернативна
товарных групп
группы
я табачная
продукция",
"Никотиносодер
жащая
продукция",
"Табачная
продукция"
UNIT
Единица товара
Пачка
Потребительская
упаковка
GROUP
Групповая
Используется только для
упаковка
товарных групп "Молочная
продукция", "Упакованная
вода"
LEVEL1
Упаковка 1-го
Блок
уровня
LEVEL2
Упаковка 2-го
Коробка
Транспортная
уровня
упаковка (SSCC)
LEVEL3
Упаковка 3-го
Паллета
уровня
660
Код
Описание
Ограничение
Примечание для
Примечание для
использования в
товарных групп
прочих
зависимости от товарной
"Альтернативна
товарных групп
группы
я табачная
продукция",
"Никотиносодер
жащая
продукция",
"Табачная
продукция"
LEVEL4
Упаковка 4-го
уровня
LEVEL5
Упаковка 5-го
уровня
BUNDL
Комплект
Используется только для
E
товарных групп "Духи и
туалетная вода", "Предметы
одежды, бельё постельное,
столовое, туалетное и
кухонное", "Фотокамеры
(кроме кинокамер),
фотовспышки и лампы-
вспышки"
АТК
Агрегированный
Вложенность
таможенный код
типов КИ зависит
от товарной
группы
SET
Набор
Используется только для
товарных групп "Духи и
туалетная вода", "Молочная
продукция", "Предметы
одежды, бельё постельное,
столовое, туалетное и
кухонное", "Фотокамеры
(кроме кинокамер),
фотовспышки и лампы-
вспышки"
Справочник "Статусы заказов"
Код
Описание
NEW
Зарегистрирован
PRODUCTION
Производство
VALIDATION_FAILED
Ошибка в проверке
IN PROGRESS
Заказ в процессе выполнения
SUCCESS
Заказ выполнен
661
Код
Описание
ERROR
При выполнении заказа возникла ошибка
RESULT_EXPIRED
Заказ устарел
Справочник "Статусы документов"
Код
Описание
Комментарий
IN_PROGRESS
Проверяется
CHECKED_OK
Обработан
CHECKED_NOT_
Обработан с
OK
ошибками
PROCESSING_ER
Техническая
ROR
ошибка
ACCEPTED
Принят
Только для документа "Отгрузка"
CANCELLED
Аннулирован
Только для документа "Отгрузка" и документов ЭДО
WAIT_ACCEPTA
Ожидает приёмку
Только для документа "Отгрузка". Устанавливается при
NCE
успешной обработке документа "Отгрузка"
PARSE_ERROR
Обработан с
ошибками
WAIT_PARTICIP
Ожидает
Только для документа "Отгрузка". Устанавливается при
ANT_REGISTRA
регистрации
успешной обработке документа "Отгрузка товара" в
TION
участника в ГИС
сторону незарегистрированного участника
МТ
WAIT_FOR_CON
Ожидает
TINUATION
продолжения
обработки
документа
Справочник "Причины вывода из оборота"
Код
Описание
RETAIL
Розничная реализация
DAMAGE_LOSS
Утрата
DEFECT
Повреждение / брак
DESTRUCTION
Утилизация или уничтожение
LIQUIDATION
Ликвидация
CONFISCATION
Конфискация
ENTERPRISE_USE
Использование для собственных нужд
DEMO_SAMPLES
Демонстрационные образцы
662
Код
Описание
EXPIRY
Истечение срока
QA_SAMPLES
Лабораторные образцы
PRODUCT_TESTING
Тестовые образцы
PRODUCT_RECALL
Отзыв с рынка
COMPLAINTS
Рекламации
EEC_EXPORT
Экспорт в страны ЕАЭС
BEYOND_EEC_EXPORT
Экспорт за пределы стран ЕАЭС
RETURN
Возврат физическому лицу (значение не используется для
товарной группы "Молочная продукция")
REMOTE_SALE
Продажа по образцам, дистанционный способ продажи
DAMAGE_LOSS
Утрата или повреждение
STATE_SECRET
Продажа по сделке, составляющей гос. тайну
OTHER
Другое
Справочник "Статусы ответов"
Код в
Наименование
Описание
Формат сообщения об ошибке
БД
200
ОК
Статус ответа в случае
-
успеха
201
CREATED
Статус ответа в случае
успеха
202
ACCEPTED
Статус ответа в случае
успеха
663
Код в
Наименование
Описание
Формат сообщения об ошибке
БД
400
ERROR
Ошибка в параметрах
1 Для НК-методов:
Bad Request
запроса (отсутствует
1.1. При отсутствии параметра apikey
обязательный параметр)
или feed:
{ "error_message": "Отсутствует
обязательный
параметр:
<имя
обязательного параметра>" }
1.2. При отсутствии остальных
параметров:
{ "error_message": "Ошибка в
параметрах запроса" }
2 Для всех методов, кроме НК:
{ "error_message": "Отсутствует
обязательный
параметр:
<имя
обязательного параметра>" }
Ошибка в параметрах
1 Для НК-методов:
запроса (неверный тип
параметра)
{ "error_message": "Ошибка в
параметрах запроса" }
2 Для всех методов, кроме НК:
{ "error_message": "Параметр <имя
параметра> требует значение типа
<требуемый тип параметра>" }
401
ERROR
Ошибка авторизации
1 Для всех методов, требующих
токен, кроме НК-методов:
{
"error_message":"
1.1. Указан устаревший токен:
Для доступа к
<InvalidTokenException>
этому
ресурсу
требуется полная
<error>invalid_token</error>
аутентификация"
<error_description>Access
token
expired: <токен></error_description>
}
</InvalidTokenException>
1.2. Не указан токен:
<UnauthorizedException>
<error>unauthorized</error>
<error_description>Full authentication
is
required
to
access
this
resource</error_description>
</UnauthorizedException>
664
Код в
Наименование
Описание
Формат сообщения об ошибке
БД
402
ERROR
Ошибка в атрибутивном
составе тела запроса
403
ERROR
Доступ запрещён
1 Для всех методов, кроме НК:
Forbidden
1.1. Если пользователь (УОТ) не
имеет доступа к конкретному
удаленному сервису:
{ "error_message": "Отсутствует
доступ к ресурсу" }
2 Для всех НК-методов:
2.1. Если указан неправильный ключ
API
{ "error_message": "Отсутствует
доступ к ресурсу" }
404
ERROR
Запрашиваемая
1 Для всех НК-методов:
Not Found
информация не найдена в
ГИС МТ
{ "error_message": Данные не
найдены> не найден"
}
2 Для всех методов, кроме НК:
{
"error_message":
"<Описание
параметра> не найден" }
Ошибка в указании URL
{
"error_message":
"Метод
с
метода
указанным URL не найден" }
409
ERROR
Запрос не может быть
выполнен из-за
конфликтного обращения к
ресурсу
410
ERROR
Ресурс ранее был доступен
по указанному URL, но
сейчас он удалён и
недоступен
414
ERROR
Превышен допустимый
{ "error_message": "Слишком
размер тела запросаa
большой запрос" }
422
ERROR
Ошибка проверки подписи
{ "error_message": "Ошибка проверки
подписи" }
665
Код в
Наименование
Описание
Формат сообщения об ошибке
БД
500
ERROR
Внутренняя ошибка
{ "error_message": "Ошибка при
Internal
server
удалённых систем
выполнении запроса" }
Error
(технически
детализированное описание
не возвращается)
502
ERROR
Сервер временно
Bad gateway
недоступен или
Nginx
заблокирован
503
ERROR
Проблема с доступом к
{
"error_message":
"Удаленная
Service
удалённой системе
система недоступна" }
Unavailable
504
ERROR
Ошибка при получении
{ error_message: "Отсутствует ответ
ответа системы
системы" }
Справочник "Типы организаций"
Код в БД
Код
Описание
1
TRADE_PARTICIPANT
Участник оборота товаров
2
PRODUCER
Производитель товара
3
IMPORTER
Импортер товара
4
WHOLESALER
Оптовая торговля
5
RETAIL
Розничная торговля
6
IS_MP_OPERATOR
Оператор ГИС МТ
8
OGV
Орган государственной власти
9
EMITENT
Эмитент
Справочник "Статусы УОТ"
Код
Описание
REGISTERED
Зарегистрирован
NOT_REGISTERED
Не зарегистрирован
REMOVED
Удален
RESTORED
Восстановлен
BLOCKED
Заблокирован
Справочник "Статусы заявки на регистрацию УОТ"
666
№
Код
Описание
1
IN_PROGRESS
На рассмотрении (проверяется)
2
CHECKED_OK
Оформлен
3
REGISTERED
Документ зарегистрирован (принят системой)
4
CHECKED_NOT_
Ошибка
OK
5
PROSECCING_E
Ошибка при обработке
RROR
6
UNDEFINED
Не определен
Справочник "Статусы документа в жизненном цикле SD"
Код в БД
Описание
10
Новый
20
Согласование
40
Подписание
50
Активация
60
Активен
100
Недействителен
Справочник "Статусная модель"
Для каждого статуса указано, к каким типам документов он применим:
Код в БД
Статусы
Статусы входящих документов
исходящих
документов
0
Черновик
-
11
Ожидается
-
отправка
1
Отправлен
-
2
Доставлен
Подпись не требуется
(подпись не
требуется)
12
Просмотрен
Подпись не требуется (документ просмотрен)
(подпись не
требуется)
3
Доставлен
Требуется подпись
(ожидается
подпись)
667
Код в БД
Статусы
Статусы входящих документов
исходящих
документов
13
Просмотрен
Требуется подпись (документ просмотрен)
(ожидается
подпись)
4
Подписан
Подписан
5
Отклонен
Отклонен
15
Отклонен (запрос
Отклонен (запрос просмотрен)
просмотрен)
6
Отозван
Отозван
16
Запрошено
Ожидается аннулирование
аннулирование
17
Ожидается
Запрошено аннулирование
аннулирование
18
Аннулирован
Аннулирован
19
В аннулировании
В аннулировании отказано
отказано
7
Уточнён
Уточнён
8
Требуется
Ожидается уточнение
уточнение
14
Требуется
Запрос на уточнение просмотрен (ожидается уточнение)
уточнение (запрос
на уточнение
просмотрен)
9
Ошибка в
Ошибка в подписи
подписи
10
Ошибка доставки
Ошибка доставки
Справочник "Дополнительные параметры в ответе в
зависимости от товарных групп"
Дополнительные параметры возвращаются в ответе при условии указания сведений в карточке
описания товара в НК.
Дополнительные параметры для ТГ "Альтернативная табачная продукция" и
"Табачная продукция"
Параметр
Описание
Примечание
tobaсcoType
Тип табачного
продукта
okpd2Group
Код ОКПД2
668
Параметр
Описание
Примечание
okpd2Code
Код ОКПД2
Опционально
exciseProduct
Акцизный товар
exciseProductCode
Код подакцизного
товара (СКПТ)
quantityInPack
Единица
измерения по
атрибуту
"Количество
единиц
употребления в
потребительской
упаковке" (только
"АТП")
weight
Заявленный вес
(АТП)
rawTobaccoWeight
Масса табачного
сырья (только
"АТП")
Дополнительные параметры для ТГ "Обувные товары"
Параметр
Описание
Примечание
productType
Вид обуви
productTypeDesc
Вид обуви
productSize
Размер в
штихмассовой
системе
color
Цвет изделия
materialUpper
Материал верха
materialLining
Материал
подкладки
materialDown
Материал низа /
подошвы
country
Страна
производства
color
Цвет
size
Размер
sizes
Размер
Массив уникальных значений размера в штихмассовой
системе (значения, указанные в НК и полученные из
ГИС МТ)
669
Параметр
Описание
Примечание
model
Модель/артикул
производителя
Дополнительные параметры для ТГ "Предметы одежды, бельё постельное,
столовое, туалетное и кухонное"
Параметр
Описание
Примечание
type
Тип изделия
size
Размер одежды
color
Цвет
textileType
Тип текстиля
structure
Состав
consumerAge
Возраст
потребителя
gender
Целевой пол
country
Страна
производства
structure
Состав изделия
standardNumber
Номер регламента
или стандарта
productKind
Вид товара
productAreaSize
Размер изделия
model
Модель/артикул
производителя
Дополнительные параметры для ТГ "Фотокамеры (кроме кинокамер),
фотовспышки и лампы-вспышки"
Параметр
Описание
Примечание
type
Вид товара
standardNumber
Номер регламента
/ стандарта
country
Страна
производства
standardNumber
Номер регламента
или стандарта
productKind
Вид товара
model
Модель/артикул
производителя
670
Дополнительные параметры для ТГ "Велосипеды и велосипедные рамы"
Параметр
Описание
Примечание
productKind
Вид товара
productionYear
Год производства
engineType
Тип двигателя
enginePower
Мощность
двигателя
electricEnginePow
Мощность
er
электродвигателя,
Вт
frameSize
Размер рамы
weightGross
Конструктивная
масса, кг
frameMaterial
Материал рамы
rimDiameter
Номинальный
посадочный
диаметр обода,
дюйм
sectionWidth
Ширина профиля
шины (камеры),
дюйм
brakeSystemType
Тип тормозной
системы
frontForkType
Тип передней
вилки
country
Страна
производства
rimDiameter
Номинальный
посадочный
диаметр обода,
дюйм
gearType
Тип привода в
движение
codeTSR
Код ТСР
Дополнительные параметры для ТГ "Кресла-коляски"
Параметр
Описание
Примечание
productKind
Вид товара
weightGross
Конструктивная
масса, кг
671
Параметр
Описание
Примечание
maximumLoad
Максимальная
нагрузка, кг
seatDepth
Глубина сиденья
seatWidth
Ширина сиденья
seatHeight
Высота сиденья
backHeight
Высота спинки
country
Страна
производства
productKind
Вид товара
gearType
Тип привода в
движение
codeTSR
Код ТСР
model
Модель/артикул
производителя
weightMaxUnequi
Максимальная
pped
масса изделия без
дополнительного
оснащения, не
более
Дополнительные параметры для ТГ "Духи и туалетная вода"
Параметр
Описание
Примечание
perfumeryType
Тип парфюмерии
volume
Заявленный
объём
packMaterial
Материал
упаковки
country
Страна
производства
standardNumber
Номер регламента
или стандарта
packMaterial
Материал
упаковки
quantityInPack
Единица
измерения по
атрибуту
"Заявленный
объём"
672
Дополнительные параметры для ТГ "Шины и покрышки пневматические
резиновые новые"
Параметр
Описание
Примечание
tireSectionWidth
Ширина профиля
шины (камеры),
мм/дюйм
heightWidthRatio
Номинальное
отношение
высоты профиля
шины к его
ширине, %
frameConstruction
Тип конструкции
Type
каркаса шины
tireLoadIndex
Индекс нагрузки
на шину
speedCategory
Категория
скорости
seasonality
Сезонность
frameSealingType
Тип шины по
способу
герметизации
rimDiameter
Посадочный
диаметр обода,
дюйм
sectionWidth
Ширина профиля,
мм/дюйм
model
Модель/артикул
производителя
Дополнительные параметры для ТГ "Молочная продукция"
Параметр
Описание
Примечание
milkProductType
Тип продукта
rawOrigin
Происхождение
сырья
fat
Жирность, %
volume
Заявленный
объём
volumeWeight
Заявленный
объём / вес нетто
673
Параметр
Описание
Примечание
vetisId
Идентификатор
товара в ФГИС
ВетИС
babyFoodProduct
Продукция для
детского питания
structure
Состав
packMaterial
Материал
упаковки
veterinaryControl
Подлежит
ветеринарному
контролю
(надзору)
isShelfLife40Days
Срок хранения до
40 суток
(включительно)
isSpecializedFoodP
Специализирован
roduct
ная пищевая
продукция
compositionOption
Вариант состава
declNumber
Номер
декларации о
соответствии
regNumber
Номер
свидетельства о
государственной
регистрации
certNumber
Номер
сертификата
соответствия
paymentGroup
Группа платности
в соответствии с
кодом ТН ВЭД
Дополнительные параметры для ТГ "Упакованная вода"
Параметр
Описание
Примечание
productType
Тип продукта
structure
Состав
packMaterial
Материал
упаковки
volume
Заявленный
объём
674
Параметр
Описание
Примечание
babyFoodProduct
Продукция для
детского питания
mineralization
Общая
минерализация
carbonationMethod
Метод
газирования
goodOriginPlace
Наименование
места
происхождения
товара
Дополнительные параметры для ТГ "Товары из натурального меха"
Параметр
Описание
Примечание
isCombinedProduc
Комбинированное
t
меховое изделие
furType
Тип меха
otherFurType
Остальные виды
меха
isDyedFur
Является ди мех
крашеным
size
Размер изделия из
натурального
меха
color
Цвет
Дополнительные параметры для ТГ "Пиво, напитки, изготавливаемые на основе
пива, слабоалкогольные напитки"
Параметр
Описание
Примечание
massСoncentrationSuga
Массовая концентрация сахаров
rs
isPasteurized
Является ли пастеризованным
filtrationType
Тип фильтрации
volumeFractionEthylAlc
Объёмная доля этилового спирта
ohol
alcoholicProductTypeC
Код вида алкогольной продукции
ode
consumerPackageVolu
Объём продукции в единице упаковки
me
shelfLife
Срок годности, дней
675
Параметр
Описание
Примечание
implementationPeriod
Срок реализации, дней
frap
Код ФРАП
Дополнительные параметры для ТГ "Антисептики и дезинфицирующие средства"
Параметр
Описание
Примечание
productPurpose
Назначение
товара
form
Форма /
состояние /
формат
676
Приложение 2. Примеры аутентификации по
УКЭП / Подписание документов
Пример получения токена при авторизации с
прикрепленной подписью / подписание документов с
открепленной подписью на 1С
// sThumbprint - отпечаток сертификата, используемого для подписи; строка,
// представляющая отпечаток в шестнадцатеричном виде
// пример 195934d72dcdf69149901d6632aca4562d8806d8
// ТекстДляПодписи должен быть в Base64
// bDetached - Истина/Ложь - откреплённая(для подписания документов)/прикреплённая(для
получения токена авторизации) подпись
Функция ПодписатьТекст(ТекстДляПодписи, sThumbprint, bDetached)
CADESCOM_BASE64_TO_BINARY = 1; // Входные данные пришли в Base64
CADESCOM_CADES_TYPE = 1; // Тип усовершенствованной подписи
CAPICOM_AUTHENTICATED_ATTRIBUTE_SIGNING_TIME = 0; // Атрибут штампа времени подписи
oSigner = Новый COMОбъект("CAdESCOM.CPSigner");
// Объект, задающий параметры создания и содержащий информацию об усовершенствованной
подписи.
oSigner.Certificate = ПолучитьСертификатПоОтпечатку(sThumbprint);
oSigningTimeAttr = Новый COMОбъект("CAdESCOM.CPAttribute");
oSigningTimeAttr.Name = CAPICOM_AUTHENTICATED_ATTRIBUTE_SIGNING_TIME;
oSigningTimeAttr.Value = ТекущаяДата();
oSigner.AuthenticatedAttributes2.Add(oSigningTimeAttr);
ТекстДляПодписи = СокрЛП(ТекстДляПодписи);
oSignedData = Новый COMОбъект("CAdESCOM.CadesSignedData");
// Объект CadesSignedData предоставляет свойства и методы для работы с
усовершенствованной подписью.
oSignedData.ContentEncoding = CADESCOM_BASE64_TO_BINARY;
SignedData.Content = СокрЛП(ТекстДляПодписи);
EncodingType = 0;
sSignedMessage = oSignedData.SignCades(oSigner, CADESCOM_CADES_TYPE, bDetached,
EncodingType);
// Метод добавляет к сообщению усовершенствованную подпись.
Возврат sSignedMessage; // Подпись в формате Base64
КонецФункции
//Отпечаток - строка HEX
Функция ПолучитьСертификатПоОтпечатку(ОтпечатокСтр)
Рез = Неопределено; // Найденный сертификат (Com-объект)
CAPICOM_CURRENT_USER_STORE = 2;
//2 - Искать сертификат в ветке "Личное" хранилища.
677
CAPICOM_MY_STORE = "My";
// Указываем, что ветку "Личное" берем из хранилища текущего пользователя
CAPICOM_STORE_OPEN_READ_ONLY = 0; // Открыть хранилище только на чтение
oStore = Новый COMОбъект("CAdESCOM.Store"); // Объект описывает хранилище сертификатов
oStore.Open(CAPICOM_CURRENT_USER_STORE, CAPICOM_MY_STORE,
CAPICOM_STORE_OPEN_READ_ONLY); // Открыть хранилище сертификатов
// 1 вариант: поиск сертификата по отпечатку
CAPICOM_CERTIFICATE_FIND_SHA1_HASH = 0;
Certificates = oStore.Certificates.Find(CAPICOM_CERTIFICATE_FIND_SHA1_HASH,
ОтпечатокСтр);
Рез = Certificates.Item(1);
//2 вариант: обходом по коллекции и сравнение с отпечатком
//Для Каждого ТекСертификат Из oStore.Certificates Цикл
//ТекОтпечаток = ТекСертификат.Thumbprint; // возвращается отпечаток в
шестнадцатеричном виде
//Если ВРЕГ(ТекОтпечаток) = ВРЕГ(ОтпечатокСтр) Тогда //Рез = ТекСертификат;
//Прервать;
//КонецЕсли;
//КонецЦикла;
oStore.Close(); // Закрыть хранилище сертификатов и освободить объект 61
Возврат Рез;
КонецФункции
Пример получения токена при авторизации REACT JS
import { CadesPluginer as anyName } from "@crpt/cades-pluginer"; //or
import CadesPluginer from "@crpt/cades-pluginer";
//usually you will need 2 methods
CadesPluginer.getFinalCertsArray().then(certs => {
console.log("certs", certs);
CadesPluginer.signMessage("lalala", certs[0].certificate).then(signed =>
console.log("signed", signed);
);
});
Пример получения токена при авторизации с помощью
прикрепленной подписи / подписание документов с
помощью открепленной подписи на Java
678
String data = ...//получение кода для авторизации
boolean detached = false;
// false - прикреплённая(для получения токена авторизации) подпись
// true - откреплённая(для подписания документов) подпись
//Формирование подписи
KeyStore keyStore = loadKeyStore();//инициализация хранилища ключей
List<X509CertificateHolder> chain = new ArrayList<>();
List<Certificate> certs = Arrays.asList(keyStore.getCertificateChain(alias));
certs.forEach(cert -> {
try {
chain.add(new X509CertificateHolder(cert.getEncoded()));
} catch (IOException | CertificateEncodingException e) {
log.error("Error while building certificate chain", e);
}
});
PrivateKey privateKey = (PrivateKey) (keyStore.getKey(alias, password));
ByteArrayOutputStream out = new ByteArrayOutputStream();
CAdESSignature signature = new CAdESSignature(detached);
signature.setCertificateStore(new CollectionStore(chain));
final Hashtable table = new Hashtable();
Attribute attr = new Attribute(CMSAttributes.signingTime,
new DERSet(new Time(new Date()))); // устанавливаем время подписи
table.put(attr.getAttrType(), attr);
AttributeTable attrTable = new AttributeTable(table);
//Добавление подписанта. Алгоритмы могут отличаться в зависимости от требований
signature.addSigner(JCP.PROVIDER_NAME,
JCP.GOST_DIGEST_OID,
JCP.GOST_EL_DH_OID,
privateKey,
certs,
CAdESType.CAdES_BES,
null,
false,
attrTable,
null);
signature.open(out);
signature.update(data);
signature.close();
byte[] signedCode = out.toByteArray();
//Использовать подписанный код для получение токена / сформированную открепленную
подпись УКЭП документа вместе с самим документом
Описание методов плагина
679
Метод
Описание
getFinalCertsArray(): Promise<Cert[]>
Init plugin, create store, . Cert: \{certificate: \{},
info: [] }, certificate is an original cadesplugin
Certificate object, info is an array [name,
date_from, date_to, serial_number].
signMessage(message, cert, detached): Promise
Sign message with selected certificate
680
|