Программный интерфейс приложений (API)
для работы с ИС «ЭДО.Поток»

Введение

Информационной системе «ЭДО.Поток» реализован программный интерфейс приложений (API). API позволяет сторонним приложениям работать с данными информационной системы (ИС) «ЭДО.Поток». В инструкции описаны методы API для получения данных из информационной системы (ИС) «ЭДО.Поток» сторонними приложениями. Взаимодействие клиентского приложения и API производится путем отправки приложением HTTP-запросов к серверу и получением ответов на них. Для отправки запросов и получения ответов используется протокол HTTPS.
В случае возникновения проблем использования ИС «ЭДО.Поток», подробно опишите их и отправьте на edo@edo.ru.
Ниже описаны запросы HTTP, которыми реализуются функции API по работе с ИС «ЭДО.Поток».

1. Общий вид запроса и ответа в API

Кодировка, используемая в запросах и ответах — Windows-1251. Запросы выполняются методами POST и GET, параметры запроса располагаются в структуре данных формата JSON, передаваемой в блоке данных запроса (при использовании POST), также параметры могут передаваться в строке запроса (при использовании GET).
Ответы выдаются сервером в формате JSON и, в случае успешности ответа согласно его заголовку (код ответа по протоколу HTTP равен 200), данные имеют следующий обобщенный вид:

{
  "status": {
    "code": 0,
    "message": "string"
  }
  "result": {
  ...
  }
}

Здесь:

«result» — произвольный тип данных (часто — структура данных, вид которой определяется видом запроса);
«status» — структура, описывающая состояние обработки запроса.

Состав и назначение полей см. в раздел 2. таблицу 2.1.

2. Метод регистрации в ИС «ЭДО.Поток»

Метод позволяет зарегистрироваться в ИС «ЭДО.Поток» и получить логин и пароль при следующей авторизации и работы с API

Используется метод POST следующего вида:

POST https://lk.edo.ru/api/edo/{version}/clients/registration

Заменяемый параметр {version} — обозначение версии системы, по умолчанию равен v1.

Запрос должен выглядеть следующим образом:

POST https://lk.edo.ru/api/edo/v1/clients/registration
Authorization: Token 416b5600-3e36-4418-9604-e0c9843d2eef
Content-Type: application/json

{
  certificate: "MIIKJTCCCdKgAwIBAgIRAgHuzADNrbL....Строка"
  email: "belka@ofd.ru"
  fullLegalAddress: "г Москва"
  fullName: "ИП Пирогова Александра Андреевна"
  ifns: "7700"
  inn: "772863973810"
  kpp: ""
  legalAddress: {fullName: "г Москва", area: null, building: null, city: "Москва", houseNumber: null, office: null,…}
  area: null
  building: null
  city: "Москва"
  fullName: "г Москва"
  houseNumber: null
  office: null
  postalCode: "101000"
  region: "Москва"
  settlement: null
  street: null
  mailAddress: "г Москва"
  name: "Виктория"
  ogrn: "314774617000610"
  password: "TestTest94"
  phone: "99999999999"
}

Назначение полей структуры запроса регистрации приведено в таблице 2.1.

Таблица 2.1. Поля структуры запроса регистрации

Параметр	Вложенные поля	Формат значения	Описание
certificate		String	Сертификат, экспортированный в формате base64
email		String	Email клиента
fullLegalAddress		String	Юридический адрес клиента (полный)
fullName		String	Полное название организации
ifns		String	Код ИФНС, состоит из 4-х цифр
inn		String	ИНН
kpp		String	КПП
legalAddress	Структура		Юридический адрес клиента (по составляющим)
	fullName	String	Юридический адрес клиента (единое название), например «г Москва, ул Хуторская 2-я, д 38А стр 15»
	area	String	Область
	city	String	Город
	street	String	Улица
	houseNumber	String	Номер здания
	building	String	Строение/корпус
	office	String	Номер офиса
	postalCode	String	Почтовый индекс
	region	String	Регион
	settlement	String	Поселок
mailAddress	mailAddress	String	Адрес компании для корреспонденции (полный, например «г Москва, ул Хуторская 2-я, д 38А стр 15»)
name		String	ФИО пользователя
ogrn		String	ОГРН/ОГРИП компании
password		String	Пароль от личного кабинета EDO.ru
phone		String	Номер телефона

В ответ на запрос сервер возвращает структуру данных (приведены примеры значений):

{
  "result": {
    "clientId": "string",
    "password": "string"
  },
  "status": {
    "code": 0,
    "message": "some message here"
  }
}

Назначение полей структуры ответа на запрос регистрации приведено в таблице 2.2.

Таблица 2.2. Поля структуры ответа на запрос регистрации

Параметр	Вложенные поля	Формат значения	Описание
result	Структура		Состояние запроса
	clientId	String	логин клиента
	password	String	пароль клиента
status	Структура		Состояние запроса
	code	Integer	Числовое представление статуса
	message	String	Сообщение с описанием статуса/ошибки

3. Метод авторизации в ИС «ЭДО.Поток»

Доступ в ИС «ЭДО.Поток» возможен при использовании учетной записи пользователя.
Для получения доступа к учетной записи пользователя необходимо успешно пройти процедуру авторизации с помощью механизма AuthToken.

После успешной авторизации пользователь получает токен. И далее к каждому HTTP-запросу к ЭДО.Поток требуется добавлять HTTP-заголовок Authorization с параметром Token {TOKEN}.

Authorization: Token {TOKEN}

Здесь: {TOKEN} — токен, возвращенный в результате авторизации (см. п. 3.1.).

Например, команда получения списка доступных входящих документов транслируется в следующий HTTP-запрос

GET https://lk.edo.ru/api/edo/v1/documents?direction=in
Authorization: Token 99a6f59f-4b2d-4b85-a8e8-0b3231983573

3.1. Авторизация через AuthToken

Авторизация посредством механизма AuthToken предполагает использование квалифицированной электронной подписи (КЭП). Для авторизации необходимо проделать следующую последовательность действий.

1. Со стороны клиента должен быть направлен запрос следующего вида:

GET https://lk.edo.ru/api/edo/{version}/clients/auth-with-ds?fingerprint={fprint1}

Заменяемые параметры:

{version} — обозначение версии системы, по умолчанию равен v1;
{fprint1} — отпечаток сертификата.

В ответ на запрос сервер возвращает структуру данных (приведены примеры значений):

{
  "status": {
    "code": 0,
    "message": "OK"
  },
  "result": "c698a3c9-d22f-4a93-9a8d-d8310cac326a"
}

Назначение полей структуры ответа на запрос авторизации приведено в таблице 3.1.

Таблица 3.1. Поля структуры ответа на запрос авторизации

Параметр	Вложенные поля	Формат значения	Описание
status	Структура		Состояние запроса
	code	Integer	Код ответа на запрос (0 — OK)
	message	String	Сообщение в ответе на запрос
result		String	Поле с ключом «result» имеет тип данных «Строка», и в нем возвращается строка для подписания, которая будет использована в следующих шагах. Действителен в течение суток с момента получения

2. Клиент подписывает строку для подписания с помощью КЭП, а затем отправляет ее вместе с подписью (CMS detached container), закодированную по алгоритму “Base64”, на тот же адрес URL с помощью запроса следующего вида:

POST https://lk.edo.ru/api/edo/{version}/clients/auth-with-ds

Заменяемый параметр {version} — обозначение версии системы, по умолчанию равен v1.

Тело запроса содержит следующую структуру (приведены примеры значений):

POST https://lk.edo.ru/api/edo/v1/clients/auth-with-ds
Authorization: Token 416b5600-3e36-4418-9604-e0c9843d2eef
Content-Type: application/json

{
  "cmsDetached": "UTA9STK1...",
  "content": "IDMYUTA9STK11070FQL..."
}

Назначение полей тела запроса на получение токена приведено в таблице 3.2.

Таблица 3.2. Поля структуры запроса на получение токена

Параметр	Формат значения	Описание
cmsDetached	String	Результат подписания строки (параметр result в ответе на запрос GET /auth-with-ds ), закодированный с помощью “Base64”. Результат, после кодировки должен быть представлен в виде строки (не забудьте удалить символы переноса срок, например '\n' и '\r')
content	String	Сама строка для подписания, полученная на предыдущем шаге (параметр result в ответе на запрос GET /auth-with-ds )

3. Сервер производит проверку переданной строки, и в случае успешной проверки возвращает структуру данных (приведены примеры значений):

{
  "status": {
    "code": 0,
    "message": "OK"
  },
  "result": {
    {
    "sessionId": "440d14a5-9070-49e1-abcd-baa013ff23ad",
    "edoOrgId": "2PS-24610035090000000000000095636522"
    }
  }
}

Назначение полей структуры ответа на запрос авторизации приведено в таблице 3.3.

Таблица 3.3. Поля структуры ответа на запрос авторизации

Параметр	Вложенные поля	Формат значения	Описание
status	Структура		Состояние запроса
	code	Integer	Код ответа на запрос (0 — OK)
	message	String	Сообщение в ответе на запрос
result	Структура		Параметры авторизации
	sessionId	String	Токен, далее используемый клиентом в качестве дополнительного параметра в последующих запросах к API. Действителен в течение суток с момента получения
	edoOrgId	String	Ваш идентификатор участника ЭДО

4. ЭДО.Поток

Запросы (функции) программного интерфейса приложений ИС «ЭДО.Поток» предназначены для выполнения операций документооборота (пересылка, сохранение, подписание документов) для внешних информационных систем, взаимодействующих с ИС «ЭДО.Поток». Большинство запросов и ответов имеет вид, описанный в разделе 2, если входные и выходные данные будут другого вида, это будет описываться дополнительно. Данные документов при передаче кодируются алгоритмом “Base64”. Запросы API ИС «ЭДО.Поток» можно разделить на три группы: запросы, связанные с документами, запросы связанные с клиентами и запросы, связанные с контрагентами. К запросам, связанным с клиентами относится также и авторизация пользователя в системе, описанная в разделе 3.

4.1. Запросы, связанные с документами

4.1.1. Получение списка документов клиента

Для получения списка документов клиента используется HTTP-метод “GET”, в ответ на запрос возвращается список документов клиента, в соответствии с переданным токеном. Список документов клиента может быть запрошен как по всему времени пользования системой, так и по заданному периоду (см. ниже).
Также может быть запрошен как полный список документов, так и его часть (страница), исходя из принципа деления списка на страницы равной длины. Длина страницы и номер выдаваемой страницы определяются в параметрах запроса (см. ниже).
Запрос на получение списка документов клиента имеет вид:

GET https://lk.edo.ru/api/edo/{version}/documents?direction=DIRECTION&from=DATE1&to=DATE2&pageIndex=INDEX&pageRecords=NUM1&sortKey=KEY1&sortDirection=DIR1&typeOfDate=TYPE

Все параметры в данном запросе приведены в таблице 4.1.

Таблица 4.1. Параметры запроса на получение списка документов

Параметр	Заменяемая строка	Описание	Значение по умолчанию	Обязательно в запросе
	{version}	Версия системы	v1	да
direction	DIRECTION	Направление документооборота. Возможные значения: in — входящие документы; out — исходящие документы; deleted — удаленные документы.		да
from	DATE1	Начальная дата периода поиска документов в формате (dd.mm.yyyy), где dd — день, mm — месяц, yyyy — год		нет
to	DATE2	Конечная дата периода поиска документов в формате (dd.mm.yyyy)		нет
pageIndex	INDEX	Номер запрашиваемой страницы списка документов; в виде десятичного целого числа	1	нет
pageRecords	NUM	Количество записей на странице. В виде десятичного целого числа	1000	нет
sortKey	KEY1	Столбец для сортировки	doc_id	нет
sortDirection	DIR1	Порядок сортировки. Возможные значения: asc — восходящая (прямой порядок); desc — нисходящая (обратный порядок).	desc	нет
typeOfDate	TYPE	Способ интерпретации даты в полях from и to: STATUS_CHANGE_DATE — дата изменения статуса; RECEIVED_DATE — дата получения документа; CREATION_IN_DOCUMENT_DATE — дата формирования документа.	RECEIVED_DATE	нет

Далее здесь во всех запросах будет указана первая версия API (“v1”).

Пример запроса:

GET https://lk.edo.ru/api/edo/v1/documents?direction=out&from=31.08.2018&to=01.09.2018&pageIndex=1&pageRecords=50&sortKey=Doc_id&sortDirection=asc&docType=without_service_docs
Authorization: Token 99a6f59f-4b2d-4b85-a8e8-0b3231983573

Пример успешного ответа на запрос (приведены примеры значений, многоточие означает многократно повторяющуюся структуру):

{
  "status": {
    "code": 0,
    "message": "OK"
  },
  "result": {
    "data": [
      {
        "direction": "OUT",
        "docId": 2610,
        "fromOrgId": "2PS-003245025998032",
        "fromOrgName": "PS ST",
        "toOrgId": "2PS-00440111648005445",
        "toOrgName": "ИП Иванов",
        "edoIdFrom": "000-00010035090000000000000095600000",
        "edoIdTo": "000-0000000000003516438590065861909",
        "docTypeId": 1,
        "docTypeName": "Счёт-фактура",
        "docStateId": 0,
        "docStateName": "Создан",
        "sfStateName": "Подписано отправителем",
        "sfStateId": 3,
        "innFrom": "000000000",
        "innTo": "000000000000",
        "kppFrom": "00000000",
        "kppTo": null,
        "content": null,
        "xmlBody": "PD94bWwgdmVyc2...",
        "imgBody": null,
        "signature": "MIIGGAYJKoZIhvcNAQcCoII Строка...",
        "certificateSerialNumber": null,
        "fileName": "ON_SCHFDOPPR_2PS-0069110332410689418822_2PS-007841465194609667_20180820_80aa0ec5-d512-48a1-b504-7d84872d5dcf",
        "docName": null,
        "docNumber": "11321",
        "docDate": "01.09.2020 00:00:00",
        "sumAll": null,
        "sumNds": null,
        "updPokupatelyaId": null,
        "marking": false,
        "fingerprint": "4ff4214c64e8d8db2046defab0dAAAA",
        "mcDocState": "MC_NONE",
        "actions": [
          "ActionRemove",
          "ActionSentRefine",
          "ActionVisualization"
        ],
        "forDocument": [
          null
        ],
        "guid": null,
        "updated": "2018-08-31 13:17"
        "nds": false,
        "signRequested": false
       }
       ...
     ],
    "pageInfo": {
      "pageIndex": 1,
      "pageRecords": 1000,
      "pageCount": 1,
      "sortKey": "doc_id",
      "sortDirection": "desc"
    }
  }
}

Параметры структуры приведены в таблице 4.2.

Таблица 4.2. Параметры структуры ответа на запрос списка документов

Параметр	Вложенные поля	Вложенные поля	Формат значения	Описание
status	Структура			Состояние запроса
	code		Integer	Код ответа на запрос (0 — OK)
	message		String	Сообщение в ответе на запрос
result	Структура			Содержащая список документов
	data	Структура		Данные списка документов
		direction	String	Признак документа: OUT — исходящий; IN — входящий
		docId	Integer	Идентификационный номер (индекс) документа
		fromOrgId	String	Идентификатор организации-отправителя
		fromOrgName	String	Название организации-отправителя
		edoIdFrom	String	Идентификатор в ЭДО организации-отправителя
		edoIdTo	String	Идентификатор в ЭДО организации-получателя
		toOrgId	String	Идентификатор организации-получателя
		docTypeId	Integer	Идентификатор типа документа
		docTypeName	String	Название типа документа
		docStateId	Integer	Идентификатор статуса (состояния) документа
		sfStateName	String	Статус подписи документа
		sfStateId	Integer	Идентификатор статуса подписи документа
		innFrom	String	ИНН организации-отправителя
		innTo	String	ИНН организации-получателя
		kppFrom	String	КПП организации-отправителя
		kppTo	String	КПП организации-получателя
		content	String	Содержимое документа, закодированное с помощью алгоритма “Base 64”
		xmlBody	String	Содержит тело документа в виде двоичного массива, закодированного с помощью алгоритма «Base 64”
		imgBody	String	Содержит тело документа в виде двоичного массива, закодированного с помощью алгоритма «Base 64”
		signature	String	Открепленная подпись в формате PKCS#7/CMS с публичной частью сертификата, закодированная с помощью алгоритма “Base 64”
		certificateSerialNumber	String	Серийный номер сертификата
		fileName	String	Наименование файла
		docName	String	Наименование документа
		docNumber	String	Номер документа
		docDate	String	Дата генерации документа
		sumAll	String	Общая сумма по документу
		sumNds	String	Общая сумма НДС по документу
		updPokupatelyaId	String	Идентификатор УПД покупателя
		marking	Boolean	Признак наличия маркировки
		mcDocState	String	Стейт отправки документа в ЦРПТ
		actions	Структура	Служебная информация о возможных действиях с документом
		forDocument	Структура	Информация о родительском документе
		guid	String	Уникальный идентификатор
		updated	String	Дата и время последнего обновления, формат ISO, с указанием часов и минут (без секунд, дата и время разделены пробелом)
		nds	Boolean	Признак необходимости расчета НДС
		signRequested	Boolean	Признак необходимости подписания документа
pageInfo	Структура			Информация о делении списка на страницы и о передаваемой странице списка
	pageIndex		Integer	Номер передаваемой страницы
	pageRecords		Integer	Количество строк списка на странице
	pageCount		Integer	Количество страниц в списке
	sortKey		String	Имя поля ключа сортировки (аналогично запросу)
	sortDirection		String	Направление сортировки (аналогично запросу)

4.1.2. Отправка документа

Для отправки формализованного документа заданному получателю используется запрос на основе метода POST.
Запрос имеет следующий вид:

POST https://lk.edo.ru/api/edo/{version}/documents/send

Заменяемый параметр {version} — обозначение версии системы, по умолчанию равен v1.

Параметры запроса располагаются в теле запроса и имеют вид следующей структуры:

POST https://lk.edo.ru/api/edo/v1/documents/send
Authorization: Token 416b5600-3e36-4418-9604-e0c9843d2eef
Content-Type: application/json

{
  "to": "2PS-00631566061106315010010016107897",
  "docType": 7,
  "content": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNv...",
  "signature": "MIIGGAYJKoZIhvcNAQcCoIIGCTCCBg...",
  "fileName": "my_file.txt",
  "parentDocId": "",
  "docAttrs": {
    "docName": "docName",
    "docNumber": "N-345",
    "docDate": "04.10.2018",
    "sumAll": "154.3",
    "sumNds": "12.3",
    "isNds": true,
    "isSignRequested": false
  }
}

Параметры запроса на отправку документа приведены в таблице 4.3.

Таблица 4.3. Параметры запроса на отправку документа

Параметр	Вложенные поля	Формат значения	Описание	Обязательно в запросе
to		String	Идентификатор получателя	да
docType		Integer	Тип документа	да
content		String	Содержимое документа, закодированное с помощью алгоритма “Base 64”	да
signature		String	Открепленная подпись в формате PKCS#7/CMS с публичной частью сертификата, закодированная с помощью алгоритма “Base 64”	да
fileName		String	Имя файла документа	да
parentDocId		String	Идентификатор документа, на основании которого был сгенерирован текущий документ	нет
docAttrs	Структура		Содержит дополнительную информацию о документе	нет
	docName	String	Наименование документа	нет
	docNumber	String	Номер документа	нет
	docDate	String	Дата генерации документа	нет
	sumAll	String	Общая сумма по документу, указывется с использованием “.”, например “356.00”	нет
	sumNds	String	Общая сумма НДС по документу, указывется с использованием “.”, например “12.10”	нет
	isNds	Boolean	Признак необходимости расчета НДС	нет
	isSignRequested	Boolean	Признак необходимости подписания документа	нет

Пример успешного ответа на запрос описан в разделе 1, при этом параметр «message» имеет значение «OK», а «result» имеет значение «null».

4.1.3. Получение списка документов для подписания

Для получения клиентом списка документов для подписания используется HTTP-метод “GET”, в ответ на запрос возвращается список документов, в соответствии с переданным токеном.
Запрос на получение списка документов на подписание имеет вид:

GET https://lk.edo.ru/api/edo/{version}/documents/for-signing?req-duplex-sign={REQ1}

Пример запроса

GET https://lk.edo.ru/api/edo/v1/documents/for-signing?req-duplex-sign=false
Authorization: Token 416b5600-3e36-4418-9604-e0c9843d2eef

Параметры запроса приведены в таблице 4.4.

Таблица 4.4. Параметры запроса на получение списка документов для подписания

Параметр	Заменяемая строка	Описание	Значение по умолчанию	Обязательно в запросе
	{version}	Версия системы	v1 ¹⁾	да
req-duplex-sign	{REQ1}	Тип возвращаемых документов: true — технологические (не требующие второй подписи) и прочие (требующие вторую подпись); false — только технологические	false	нет

Пример успешного ответа на запрос имеет следующий вид (приведены примеры значений):

{
  "status": {
    "code": 0,
    "message": "OK"
  },
  "result": [
    {
      "docId": 4483,
      "fromOrgId": "252",
      "fromOrgName": "ООО ПС-СТ",
      "toOrgId": "1",
      "toOrgName": "ОФД.РУ",
      "edoIdFrom": "2PS-00324502599803245010010096511518",
      "edoIdTo": "2PS",
      "docTypeId": 3,
      "docTypeName": "Извещение о получении электронного документа",
      "docStateId": 0,
      "docStateName": "Ожидается извещение о получении",
      "sfStateName": "Ожидается извещение о получении",
      "sfStateId": 2,
      "content": "PD94bWwgdmVyc2lvbiA9IjEuMCIgZW5jb2R...",
      "signature": null,
      "fileName": "DP_IZVPOL_2PS_2PS-0032450259980324...",
      "certFingerprint": null,
      "docName": null,
      "docNumber": null,
      "docDate": null,
      "sumAll": null,
      "sumNds": null,
      "updated": "17.10.2018 11:15:01",
      "nds": false
    }
  ]
}

Параметры ответа приведены в таблице 4.5.

Таблица 4.5. Параметры ответа на запрос списка документов на подписание

Параметр	Вложенные поля	Формат значения	Описание
status	Структура		Состояние запроса
	code	Integer	Код ответа на запрос (0 — OK)
	message	String	Сообщение в ответе на запрос
result	Структура		Список документов на подписание
	docId	Integer	Идентификационный номер (индекс) документа
	fromOrgId	String	Идентификатор документа, присвоенный организацией-отправителем
	fromOrgName	String	Название документа, присвоенное организацией-отправителем
	toOrgId	String	Идентификатор документа, присвоенный организацией-получателем
	toOrgName	String	Название документа, присвоенное организацией-отправителем
	edoIdFrom	String	Название системы ЭДО отправителя (в случае передачи документов между различными системами ЭДО)
	edoIdTo	String	Название системы ЭДО получателя (в случае передачи документов между различными системами ЭДО)
	docTypeId	Integer	Идентификатор типа документа
	docTypeName	String	Название типа документа
	docStateId	Integer	Идентификатор статуса (состояния) документа
	docStateName	String	Статус документа
	sfStateName	String	Статус подписи документа
	sfStateId	Integer	Идентификатор статуса подписи документа
	content	String	Содержимое документа, закодированное с помощью алгоритма “Base 64”
	signature	String	Открепленная подпись в формате PKCS#7/CMS с публичной частью сертификата, закодированная с помощью алгоритма “Base 64”
	fileName	String	Имя файла документа
	certFingerprint	String	Отпечаток сертификата
	docName	String	Наименование документа
	docNumber	String	Номер документа
	docDate	String, описывающая момент времени (дату и время в формате ISO)	Дата формирования документа
	sumAll	String	Общая сумма по документу
	sumNds	String	Общая сумма НДС по документу
	updated	String, описывающая момент времени (дату и время в формате ISO)	Дата последнего изменения документа
	nds	Boolean	Признак необходимости расчета НДС

4.1.4. Получение предварительно заполненного шаблона документа

В некоторых случаях необходимо, чтобы «ЭДО.Поток» возвращал предварительно заполненные шаблоны XML-документов для УПД-покупателя, УКД покупателя, либо уточняющего документа.
Данные документы могут быть частично сформированы на стороне оператора ЭДО по данным родительского документа (СФ, УПД, УКД).
Недостающая часть информации вводится пользователем ИС «ЭДО.Поток» на веб-странице вручную.
Запросить предварительно заполненные шаблоны XML-документов можно с помощью запроса на основе метода POST.
Запрос имеет следующий вид:

POST https://lk.edo.ru/api/edo/{version}/documents/get-doc-template

Заменяемый параметр {version} — обозначение версии системы, по умолчанию равен v1.

Параметры запроса располагаются в теле запроса и имеют вид следующей структуры (приведены примеры значений):

POST https://lk.edo.ru/api/edo/v1/documents/get-doc-template
Authorization: Token 416b5600-3e36-4418-9604-e0c9843d2eef
Content-Type: application/json

{
  "docTypeId": 6,
  "parentDocId": 3972,
  "textRefinement": "Текстовый комментарий",
  "fingerprint": "4ff4214c64e8d8db2046defab0dAAAA"
}

Параметры запроса предварительно заполненной формы приведены в таблице 4.6.

Таблица 4.6 Параметры запроса предварительно заполненной формы

Параметр	Формат значения	Описание	Обязательно в запросе
docTypeId	Integer	Идентификатор типа документа для частично заполняемого бланка	да
parentDocId	Integer	Идентификатор документа, на основе которого производится частичное заполнение	да
textRefinement	String	Текстовый комментарий	да
fingerprint	String	Отпечаток сертификата	да

Пример успешного ответа на запрос имеет следующий вид (приведены примеры значений):

{
  "status": {
    "code": 0,
    "message": "OK"
  },
  "result": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNv..."
}

Параметры ответа на запрос предварительно заполненной формы приведены в таблице 4.7.

Таблица 4.7. Параметры ответа на запрос предварительно заполненной формы

Параметр	Вложенные поля	Формат значения	Описание
status	Структура		Состояние запроса
	code	Integer	Код ответа на запрос (0 — OK)
	message	String	Сообщение в ответе на запрос
result	String	Содержимое предварительно заполненной формы, закодированное с помощью алгоритма “Base 64”

4.1.5. Подписание документа

POST https://lk.edo.ru/api/edo/{version}/documents/add-signature

POST https://lk.edo.ru/api/edo/v1/documents/add-signature
Authorization: Token 416b5600-3e36-4418-9604-e0c9843d2eef
Content-Type: application/json

{
  "docId": "2614",
  "signature": "MIIGGAYJKoZ…"
}

Параметры запроса на отправку документа приведены в таблице 4.8.

Таблица 4.8. Параметры запроса на отправку документа

Параметр	Формат значения	Описание	Обязательно в запросе
docId	String	Идентификатор подписываемого документа	да
signature	String	Открепленная подпись в формате PKCS#7/CMS с публичной частью сертификата, закодированная с помощью алгоритма “Base 64”	да

4.1.6. Удаление документа

Для удаления документа используется запрос на основе метода POST.
Запрос имеет следующий вид:

POST https://lk.edo.ru/api/edo/{version}/documents/remove-doc

POST https://lk.edo.ru/api/edo/v1/documents/remove-doc
Authorization: Token 416b5600-3e36-4418-9604-e0c9843d2eef
Content-Type: application/json

{
  "docId": "2604"
}

Параметр docId — идентификатор удаляемого документа.
Пример успешного ответа на запрос описан в разделе 1, при этом параметр «message» имеет значение «OK», а «result» имеет значение «null».

4.1.7. Восстановление документа

Для восстановления удаленного документа используется запрос на основе метода POST.
Запрос имеет следующий вид:

POST https://lk.edo.ru/api/edo/{version}/documents/recover-doc

POST https://lk.edo.ru/api/edo/v1/documents/recover-doc
Authorization: Token 416b5600-3e36-4418-9604-e0c9843d2eef
Content-Type: application/json

{
  "docId": "2604"
}

4.1.8. Получение детализированной информации о документе

Для получения детализированной информации о документе используется запрос на основе метода GET; запрос имеет следующий вид:

GET https://lk.edo.ru/api/edo/{version}/documents/document?docId={ID1}

Заменяемые параметры:

{version} — обозначение версии системы, по умолчанию равен v1;
{ID1} — идентификатор документа.

Пример запроса

GET https://lk.edo.ru/api/edo/v1/documents/document?docId=878998
Authorization: Token 416b5600-3e36-4418-9604-e0c9843d2eef

Пример успешного ответа на запрос имеет следующий вид (приведены примеры значений):

{
  "status": {
    "code": 0,
    "message": "OK"
  },
  "result": {
    "docId": 4483,
    "fromOrgId": "252",
    "fromOrgName": "ООО ПС-СТ",
    "toOrgId": "1",
    "toOrgName": "ОФД.РУ",
    "edoIdFrom": "2PS-00324502599803245010010096511518",
    "edoIdTo": "2PS",
    "docTypeId": 3,
    "docTypeName": "Извещение о получении электронного документа",
    "docStateId": 0,
    "docStateName": "Ожидается извещение о получении",
    "sfStateName": "Ожидается извещение о получении",
    "sfStateId": 2,
    "content": "PD94bWwgdmVyc2lvbj0iMTItLRIN...",
    "signature": null,
    "fileName": "DP_IZVPOL_2PS_2PS-0032450259980324...",
    "certFingerprint": null,
    "sumAll": null,
    "sumNds": null,
    "updated": "17.10.2018 11:15:01"
  }
}

Описание параметров ответа описаны в таблице 4.5., п. 4.1.3..

4.1.9. Получение комплекта документов

Запросить комплект связанных документов можно с помощью запроса на основе метода GET, при этом в ответе будут присутствовать все документы комплекта (СФ, ИСФ, КСФ, ИКСФ).
Запрос имеет следующий вид:

GET https://lk.edo.ru/api/edo/{version}/documents/doc-chain?docId={ID1}

Заменяемые параметры:

{version} — обозначение версии системы, по умолчанию равен v1;
{ID1} — идентификатор документа.

Пример запроса

GET https://lk.edo.ru/api/edo/v1/documents/doc-chain?docId=8789987
Authorization: Token 416b5600-3e36-4418-9604-e0c9843d2eef

Пример успешного ответа на запрос, приведенн в п. 4.1.3.

4.1.10. Вывод справочника типов документов

Запросить справочник типов документов, определенных в системе, с указанием их названия, внутреннего идентификатора и признака формализованности можно с помощью запроса на основе метода GET.
Запрос имеет следующий вид:

GET https://lk.edo.ru/api/edo/{version}/dictionary/get-document-type

Заменяемый параметр {version} — обозначение версии системы, по умолчанию равен v1.

Пример запроса

GET https://lk.edo.ru/api/edo/v1/dictionary/get-document-type
Authorization: Token 416b5600-3e36-4418-9604-e0c9843d2eef

Успешный ответ на запрос имеет следующий вид (приведены примеры значений):

{
  "status": {
    "code": 0,
    "message": "OK"
  },
  "result": [
    {
      "id": 1,
      "name": "Счёт-фактура",
      "formalized": true
      "technical": false,
      "primary": true,
      "pokTitle": false
    }
  ]
}

Параметры ответа на запрос справочника типов документов приведены в таблице 4.9.

Таблица 4.9. Параметры ответа на запрос справочника типов документов

Параметр	Вложенные поля	Формат значения	Описание
status	Структура		Состояние запроса
	code	Integer	Код ответа на запрос (0 — OK)
	message	String	Сообщение в ответе на запрос
result	Структура		Список документов
	id	Integer	Внутренний идентификатор типа документа
	name	String	Название типа документа
	formalized	Boolean	Признак формализованности шаблона документа
	technical	Boolean	Признак технического документа
	primary	Boolean	Признак первичного документа
	pokTitle	Boolean	Признак вторичного документа

4.1.11. Загрузка документа

Запросить содержимое документа можно с помощью запроса на основе метода GET, при этом в ответе будут присутствовать все документы комплекта (СФ, ИСФ, КСФ, ИКСФ).
Запрос имеет следующий вид:

GET https://lk.edo.ru/api/edo/{version}/documents/download-doc?docId={ID1}&downloadType={TYPE1}

Пример запроса

GET https://lk.edo.ru/api/edo/v1/documents/download-doc?docId=877678&downloadType=CURRENT
Authorization: Token 416b5600-3e36-4418-9604-e0c9843d2eef

Параметры запроса приведены в таблице 4.10.
Таблица 4.10. Параметры запроса загрузки документа

Параметр	Заменяемая строка	Описание	Значение по умолчанию	Обязательно в запросе
	{version}	Версия системы	v1 ²⁾	да
docId	{ID1}	Идентификатор загружаемого документа		да
downloadType	{TYPE1}	Тип загрузки: CURRENT — загрузка только текущего документа с заданным идентификатором; WITH_SERVICE — загрузка документа с дополнительными служебными документами в архивном файле (.zip)	CURRENT	нет

В ответ на данный запрос начинается загрузка файла в двоичном виде. В заголовках ответа (response headers) указывается имя загружаемого файла.

4.1.12. Получение извещения на подтверждение оператора (для отправителя)

После того как организация отправила документ, Оператор ЭДО создает подтверждение оператора о дате получение документа, подписывает его и направляет организации. Затем, когда организация получила подтверждение оператора, она должна отправить в ответ подписанное извещение о получении данного подтверждения.

Для получения извещения о подтверждении оператора о дате получения документа используется запрос на основе метода GET.
Запрос имеет следующий вид:

GET https://lk.edo.ru/api/edo/{version}/documents/for-sync-signing?docId={ID1}

Заменяемые параметры:

{version} — обозначение версии системы, по умолчанию равен v1;
{ID1} — идентификатор документа.

Пример запроса

GET https://lk.edo.ru/api/edo/v1/documents/for-sync-signing?docId=67889999
Authorization: Token 416b5600-3e36-4418-9604-e0c9843d2eef

{
	"status":{
		"code":0,
		"message":"OK"
	},
	"result":{
		"direction":null,
		"docId":631777,
		"fromOrgId":"11801",
		"fromOrgName":"ООО Ромашка Тест",
		"toOrgId":"1",
		"toOrgName":"ОФД.РУ",
		"docTypeId":3,
		"docTypeName":"Извещение о получении электронного документа",
		"docStateId":0,
		"docStateName":null,
		"sfStateName":null,
		"sfStateId":0,
		"innFrom":null,
		"innTo":null,
		"kppFrom":null,
		"kppTo":null,
		"content":"PDiDI7P8  Строка...",
		"signature":null,
		"certificateSerialNumber":null,
		"fileName":"DP_IZVPOL_2PS_2PS-00258532876001890440310032687548_20201112_e3b65627-fa62-41f7-b621-dd546625f8c4.xml",
		"docName":null,
		"docNumber":null,
		"docDate":null,
		"sumAll":null,
		"sumNds":null,
		"updPokupatelyaId":null,
		"marking":false,
		"fingerprint":null,
		"mcDocState":"MC_NONE",
		"actions":[],
		"forDocument":[null],
		"guid":"e3b65627-fa62-41f7-b621-dd546625f8c4",
		"updated":"12.11.2020 17:15:57",
		"signRequested":false,
		"nds":false
	}
}

Параметры структуры ответа приведены в п. 4.1.1. в таблица 4.2.

4.1.13. Получение извещений на документ (для получателя)

Для получения извещений для получателя используется запрос на основе метода GET.
Запрос имеет следующий вид:

GET https://lk.edo.ru/api/edo/{version}/documents/for-finished?docId={ID1}

Заменяемые параметры:

{version} — обозначение версии системы, по умолчанию равен v1;
{ID1} — идентификатор документа.

Пример запроса:

GET https://lk.edo.ru/api/edo/v1/documents/for-finished?docId=6778895
Authorization: Token 416b5600-3e36-4418-9604-e0c9843d2eef

Пример успешного ответа на запрос, в случае отсутствия извещений:

{
	"status":{
		"code":0,
		"message":"OK"
	},
	"result":{
		"parentDocPossibleFinished":true,
		"techDocument":null
	}
}

Пример успешного ответа на запрос, в случае наличия извещений, требующих подписания со стороны получателя:

{
	"status":{
		"code":0,
		"message":"OK"
	},
	"result":{
		"parentDocPossibleFinished":false,
		"techDocument":{
			"direction":null,
			"docId":631775,
			"fromOrgId":"11818",
			"fromOrgName":"ИП Иванов Иван Иванович",
			"toOrgId":"1",
            "edoIdFrom":null,
			"edoIdTo":null,
			"toOrgName":"ОФД.РУ",
			"docTypeId":3,
			"docTypeName":"Извещение о получении электронного документа",
			"docStateId":0,
			"docStateName":null,
			"sfStateName":null,
			"sfStateId":0,
			"innFrom":null,
			"innTo":null,
			"kppFrom":null,
			"kppTo":null,
			"content":"PD94bW  СТрока...",
			"signature":null,
			"certificateSerialNumber":null,
			"fileName":"DP_IZVPOL_2PS_2PS-64553144722100000000000054190308_20201112_636fe79f-f475-480d-a7a4-e87a650b9d05.xml",
			"docName":null,
			"docNumber":null,
			"docDate":null,
			"sumAll":null,
			"sumNds":null,
			"updPokupatelyaId":null,
			"marking":false,
			"fingerprint":null,
			"mcDocState":"MC_NONE",
			"actions":[],
			"forDocument":[null],
			"guid":"636fe79f-f475-480d-a7a4-e87a650b9d05",
			"updated":"12.11.2020 17:15:57",
			"signRequested":false,
            "nds":false
		}
	}
}

Параметры структуры ответа приведены в таблице 4.11.

Таблица 4.11. Параметры структуры ответа на запрос

Параметр	Вложенные поля	Вложенные поля	Формат значения	Описание
status	Структура			Состояние запроса
	code		Integer	Код ответа на запрос (0 — OK)
	message		String	Сообщение в ответе на запрос
result	Структура			Содержащая список документов
	parentDocPossibleFinished		Логический тип	Наличие извещений для подписания: false — есть извещения, true — нет извещений
	techDocument	Структура		Данные списка документов
		direction	String	Признак документа: OUT — исходящий; IN — входящий
		docId	Integer	Идентификационный номер (индекс) документа
		fromOrgId	String	Идентификатор организации-отправителя
		fromOrgName	String	Название организации-отправителя
		edoIdFrom	String	Идентификатор в ЭДО организации-отправителя
		edoIdTo	String	Идентификатор в ЭДО организации-получателя
		toOrgId	String	Идентификатор организации-получателя
		docTypeId	Integer	Идентификатор типа документа
		docTypeName	String	Название типа документа
		docStateId	Integer	Идентификатор статуса (состояния) документа
		sfStateName	String	Статус подписи документа
		sfStateId	Integer	Идентификатор статуса подписи документа
		innFrom	String	ИНН организации-отправителя
		innTo	String	ИНН организации-получателя
		kppFrom	String	КПП организации-отправителя
		kppTo	String	КПП организации-получателя
		content	String	Содержимое документа, закодированное с помощью алгоритма “Base 64”
		signature	String	Открепленная подпись в формате PKCS#7/CMS с публичной частью сертификата, закодированная с помощью алгоритма “Base 64”
		certificateSerialNumber	String	Серийный номер сертификата
		fileName	String	Наименование файла
		docName	String	Наименование документа
		docNumber	String	Номер документа
		docDate	String	Дата генерации документа
		sumAll	String	Общая сумма по документу
		sumNds	String	Общая сумма НДС по документу
		updPokupatelyaId	String	Идентификатор УПД покупателя
		marking	Boolean	Признак наличия маркировки
		mcDocState	String	Стейт отправки документа в ЦРПТ
		actions	Структура	Служебная информация о возможных действиях с документом
		forDocument	Структура	Информация о родительском документе
		guid	String	Уникальный идентификатор
		updated	String	Дата и время последнего обновления, формат ISO, с указанием часов и минут (без секунд, дата и время разделены пробелом)
		nds	Boolean	Признак необходимости расчета НДС
		signRequested	Boolean	Признак необходимости подписания документа

4.1.14. Получение любых извещений на документы

Для получения извещений по всем документам используется запрос на основе метода GET.
Запрос имеет следующий вид:

GET https://lk.edo.ru/api/edo/{version}/documents/for-signing

Заменяемый параметр {version} — обозначение версии системы, по умолчанию равен v1.

Пример запроса

GET https://lk.edo.ru/api/edo/v1/documents/for-signing
Authorization: Token 416b5600-3e36-4418-9604-e0c9843d2eef

Пример успешного ответа на запрос, в случае наличия извещений, которые требуется подписать организации:

{
	"status":{
		"code":0,
		"message":"OK"
	},
	"result":[
		{
			"direction":null,
			"docId":631758,
			"fromOrgId":"11818",
			"fromOrgName":"ИП Иванов Иван Иванович",
			"toOrgId":"1",
			"toOrgName":"ОФД.РУ",
			"edoIdFrom":null,
			"edoIdTo":null,
			"docTypeId":3,
			"docTypeName":"Извещение о получении электронного документа",
			"docStateId":0,
			"docStateName":null,
			"sfStateName":null,"sfStateId":0,
			"innFrom":null,
			"innTo":null,
			"kppFrom":null,
			"kppTo":null,
			"content":"PD94b  Строка...",
			"signature":null,
			"certificateSerialNumber":null,
			"fileName":"DP_IZVPOL_2PS_2PS-64553144722100000000000054190308_20201112_c518df7a-d0ae-41c3-9ddf-500689254d32.xml",
			"docName":null,
			"docNumber":null,
			"docDate":null,
			"sumAll":null,
			"sumNds":null,
			"updPokupatelyaId":null,
			"marking":false,
			"fingerprint":null,
			"mcDocState":"MC_NONE",
			"actions":[],
			"forDocument":[null],
			"guid":"c518df7a-d0ae-41c3-9ddf-500689254d32",
			"updated":"12.11.2020 12:06:43",
			"nds":false,
			"signRequested":false
		},
		...
	]
}

Параметры структуры ответа приведены в таблице 4.11

Пример успешного ответа на запрос, в случае отсутствия извещений:

{
	"status":{
		"code":0,
		"message":"OK"
	},
	"result":[
	]
}

4.1.15. Получение PDF-представления формализованного документа

Документ в формате “Adobe PDF” удобен для просмотра и печати, возможность генерации такого документа присутствует в ИС «ЭДО.Поток», это действие возможно произвести с помощью запроса на основе HTTP-метода GET.
Запрос имеет следующий вид:

GET https://lk.edo.ru/api/edo/{version}/documents/show-doc-pdf?docId={ID1}

Заменяемые параметры:

{version} — обозначение версии системы, по умолчанию равен v1;
{ID1} — идентификатор документа, на основе которого по запросу генерируется документ в формате “Adobe PDF”. Параметр обязателен.

Пример запроса

GET https://lk.edo.ru/api/edo/v1/documents/show-doc-pdf?docId=87789999
Authorization: Token 416b5600-3e36-4418-9604-e0c9843d2eef

4.2 Методы работы с черновиками

4.2.1 Метод загрузки черновика

Для загрузки черновика используется запрос на основе метода POST.
Запрос имеет следующий вид:

POST https://lk.edo.ru/api/edo/{version}/drafts/add

Заменяемый параметр {version} — обозначение версии системы, по умолчанию равен v1.
Таблица 4.12. Параметры запроса

Параметр	Формат значения	Описание	Обязательно в запросе
content	String	Содержимое документа, закодированное с помощью алгоритма “Base 64”, в одну строку (без переноса строк)	да
docType	Integer	Тип документа (параметр id в ответе на запрос Вывод справочника типов документов.	да
fileName	String	Наименование документа	да
signRequested	Boolean	Запрос подписи у контрагента: true — требуется подпись, false — подпись не требуется. Подпись контрагента запрашивается всегда по: УПД, УКД, Накладная (формализованная), Акт (формализованный). Подпись никогда не запрашивается по любым счет фактурам.	да
to	String	Идентификатор клиента в ИС «ЭДО.Поток». Можно получить используя метод Поиск контрагентов	да

Пример запроса

POST https://lk.edo.ru/api/edo/v1/drafts/add
Authorization: Token 416b5600-3e36-4418-9604-e0c9843d2eef
Content-Type: application/json

{
  "content": "UEsDBBQABgA...Строка",
  "docType": 7,
  "fileName": "С подписью. Подписание.docx",
  "signRequested": true,
  "to": "2PS-00784146519807841010010013609667"
}

Пример успешного ответа на запрос

{
    "status": {
        "code": 0,
        "message": "OK"
    },
    "result": {
        "errorCode": [],
        "data": {
            "draftId": 28027,
            "fromOrgId": "2",
            "fromOrgName": "ОФД.РУ",
            "toOrgId": "11818",
            "toOrgName": "ИП Иванов Иван Иванович",
            "edoIdFrom": "2PS-00784146519807841010010013609667",
            "edoIdTo": "2PS-64553144722100000000000054190308",
            "docTypeId": 8,
            "docTypeName": "УПД",
            "innFrom": "7841465198",
            "innTo": "645531447221",
            "kppFrom": "772501001",
            "kppTo": null,
            "content": "PD94bWwgdmVyc2l...Строка",
            "fileName": "ON_NSCHFDOPPRMARK_2PS-64553144722100000000000054190308_2PS-00784146519807841010010013609667_20201101_69bc52a0-39e6-4454-8328-6c98c74f0916",
            "docName": "Счет-фактура и документ об отгрузке товаров (выполнении работ), передаче имущественных прав (документ об оказании услуг)",
            "docNumber": "9",
            "docDate": "02.06.2020 00:00:00",
            "sumAll": 14000,
            "sumNds": 2333.33,
            "statusId": 1,
            "statusName": "Готов",
            "nds": true,
            "signRequested": true,
            "updated": "29.04.2021 15:05:14"
        }
    }
}

Параметры структуры ответа приведены в таблице 4.13

Таблица 4.13. Параметры структуры ответа

Параметр	Вложенные поля	Вложенные поля	Формат значения	Описание
status	Структура			Состояние запроса
	code		Integer	Код ответа на запрос (0 — OK)
	message		String	Сообщение в ответе на запрос
result	Структура			Содержащая список документов
	data	Структура		Данные списка документов
		draftId	String	Идентификатор черновика в системе «ЭДО.Поток»
		fromOrgId	String	Идентификатор организации-отправителя
		fromOrgName	String	Название организации-отправителя
		edoIdFrom	String	Идентификатор в ЭДО организации-отправителя
		edoIdTo	String	Идентификатор в ЭДО организации-получателя
		toOrgId	String	Идентификатор организации-получателя
		toOrgName	String	Название организации-получателя
		docTypeId	Integer	Идентификатор типа документа
		docTypeName	String	Название типа документа
		innFrom	String	ИНН организации-отправителя
		innTo	String	ИНН организации-получателя
		kppFrom	String	КПП организации-отправителя
		kppTo	String	КПП организации-получателя
		content	String	Содержимое документа, закодированное с помощью алгоритма “Base 64”
		fileName	String	Наименование файла
		docName	String	Наименование документа
		docNumber	String	Номер документа
		docDate	String	Дата генерации документа
		sumAll	String	Общая сумма по документу
		sumNds	String	Общая сумма НДС по документу
		statusId	Integer	Идентификатор статуса (состояния) документа: 0 — не готов, не заполнены параметры , обязательные для отправки; 1 — готов к отправке.
		statusName	String	Наименование статуса (состояния) документа
		nds	Boolean	Признак необходимости расчета НДС
		signRequested	Boolean	Признак необходимости подписания документа
		updated	String	Дата и время загрузки черновика
	errorCode	Массив		Ошибки, которые могли возникнуть при загрузке черновика

4.2.2 Метод получения списка черновиков

Для получения списка черновиков используется запрос на основе метода POST.

GET https://lk.edo.ru/api/edo/{version}/drafts

Заменяемый параметр {version} — обозначение версии системы, по умолчанию равен v1.

Пример запроса

GET https://lk.edo.ru/api/edo/v1/drafts
Authorization: Token 416b5600-3e36-4418-9604-e0c9843d2eef

Параметры структуры ответа приведены в таблице 4.14

Таблица 4.14. Параметры запроса

Параметр	Формат значения	Описание	Обязательно в запросе
from	String	Начальная дата периода поиска черновиков в формате (dd.MM.yyyy HH:mm), где dd — день, mm — месяц, yyyy — год, HH — часы, mm — минуты.	нет
to	String	Конечная дата периода поиска черновиков в формате (dd.MM.yyyy HH:mm), где dd — день, mm — месяц, yyyy — год, HH — часы, mm — минуты.	нет
orgNameTo	String	Наименование компании получателя	нет
orgInnTo	String	ИНН получателя	нет
docTypeId	Array[integer]	Тип документа (параметр id в ответе на запрос Вывод справочника типов документов.	нет
status	Array[integer]	Статус черновика: 1 — «Готов», черновик готов к отправке; 0 — «Не готов», значит, что черновик не может быть отпарвлена, например ошибка: «Не найден предполагаемый получатель файла».	нет
pageIndex	Integer	Номер страницы выдачи (по умолчанию — 1)	нет
pageRecords	Integer	Количество записей на странице (по умолчанию — 1000)	нет
pageCount	Integer	Всего страниц	нет
sortKey	String	Столбец для сортировки. По умолчанию — docDate.	нет
sortDirection	String	Порядок сортировки. Возможные значения: asc — восходящая (прямой порядок); desc — нисходящая (обратный порядок). По умолчанию — desc	нет

Пример ответа на запрос

{
    "status": {
        "code": 0,
        "message": "OK"
    },
    "result": {
        "data": [
            {
                "errorCode": [],
                "data": {
                    "draftId": 28027,
                    "fromOrgId": "2",
                    "fromOrgName": "ОФД.РУ",
                    "toOrgId": "11818",
                    "toOrgName": "ИП Иванов Иван Иванович",
                    "edoIdFrom": "2PS-00784146519807841010010013609667",
                    "edoIdTo": "2PS-64553144722100000000000054190308",
                    "docTypeId": 8,
                    "docTypeName": "УПД",
                    "innFrom": "7841465198",
                    "innTo": "645531447221",
                    "kppFrom": "772501001",
                    "kppTo": null,
                    "content": null,
                    "fileName": "ON_NSCHFDOPPRMARK_2PS-64553144722100000000000054190308_2PS-00784146519807841010010013609667_20201101_69bc52a0-39e6-4454-8328-6c98c74f0916.xml",
                    "docName": "Счет-фактура и документ об отгрузке товаров (выполнении работ), передаче имущественных прав (документ об оказании услуг)",
                    "docNumber": "sign_send_9",
                    "docDate": "02.06.2020 00:00:00",
                    "sumAll": 14000,
                    "sumNds": 2333.33,
                    "statusId": 1,
                    "statusName": "Готов",
                    "nds": true,
                    "signRequested": false,
                    "updated": "29.04.2021 15:05:14"
                }
            }
        ],
        "pageInfo": {
            "pageIndex": 1,
            "pageRecords": 1000,
            "pageCount": 1,
            "sortKey": null,
            "sortDirection": "desc"
        }
    }
}

Параметры структуры ответа приведены в таблице 4.15

Таблица 4.15. Параметры структуры ответа

Параметр	Вложенные поля	Вложенные поля	Вложенные поля	Формат значения	Описание
status	Структура				Состояние запроса
	code			Integer	Код ответа на запрос (0 — OK)
	message			String	Сообщение в ответе на запрос
result	Структура				Содержащая список черновиков
	data	Структура			Данные списка черновиков и страниц выдачи
		data	Структура		Данные списка черновиков
			draftId	String	Идентификатор черновика в системе «ЭДО.Поток»
			fromOrgId	String	Идентификатор организации-отправителя
			fromOrgName	String	Название организации-отправителя
			edoIdFrom	String	Идентификатор в ЭДО организации-отправителя
			edoIdTo	String	Идентификатор в ЭДО организации-получателя
			toOrgId	String	Идентификатор организации-получателя
			toOrgName	String	Название организации-получателя
			docTypeId	Integer	Идентификатор типа документа
			docTypeName	String	Название типа документа
			innFrom	String	ИНН организации-отправителя
			innTo	String	ИНН организации-получателя
			kppFrom	String	КПП организации-отправителя
			kppTo	String	КПП организации-получателя
			content	String	Содержимое документа, закодированное с помощью алгоритма “Base 64”
			fileName	String	Наименование файла
			docName	String	Наименование документа
			docNumber	String	Номер документа
			docDate	String	Дата генерации документа
			sumAll	String	Общая сумма по документу
			sumNds	String	Общая сумма НДС по документу
			statusId	Integer	Идентификатор статуса (состояния) документа: 0 — не готов, не заполнены параметры , обязательные для отправки; 1 — готов к отправке.
			statusName	String	Наименование статуса (состояния) документа
			nds	Boolean	Признак необходимости расчета НДС
			signRequested	Boolean	Признак необходимости подписания документа
			updated	String	Дата и время загрузки черновика
		errorCode	Массив		Ошибки, которые могли возникнуть при загрузке черновика
	pageInfo	Структура			Информация о делении списка на страницы и о передаваемой странице списка
		pageIndex		Integer	Номер страницы выдачи
		pageRecords		Integer	Количество записей на странице
		pageCount		Integer	Всего страниц
		sortKey		String	Столбец для сортировки. По умолчанию — docDate.
		sortDirection		String	Порядок сортировки. Возможные значения: asc — восходящая (прямой порядок); desc — нисходящая (обратный порядок). По умолчанию — desc

4.2.3 Метод скачивания черновика

Для скачивания черновика используется запрос на основе метода POST.

GET https://lk.edo.ru/api/edo/{version}/drafts/download?draftId={DRAFT_ID}

Заменяемые парметры:

{version} — обозначение версии системы, по умолчанию равен v1;
{DRAFT_ID} — Идентификатор черновика в системе «ЭДО.Поток».

Пример запроса

GET https://lk.edo.ru/api/edo/v1/drafts/download?draftId=28027
Authorization: Token 416b5600-3e36-4418-9604-e0c9843d2eef

В ответ на данный запрос начинается загрузка файла в двоичном виде.

4.2.6 Метод удаления черновика

Для удаления черновика используется запрос на основе метода POST.

POST https://lk.edo.ru/api/edo/{version}/drafts/remove

POST https://lk.edo.ru/api/edo/v1/drafts/remove
Authorization: Token 416b5600-3e36-4418-9604-e0c9843d2eef
Content-Type: application/json

{
  "draftId": "28027"
}

Параметр draftId — идентификатор удаляемого черновика в «ЭДО.Поток». Пример успешного ответа на запрос описан в разделе 1, при этом параметр «message» имеет значение «OK», а «result» имеет значение «null».

4.3. Работа с контрагентами

Перед началом работы с контрагентами, проверьте возможность обмена документами с организациями. Для этого используйте метод "Поиск контрагентов". Если ваш контрагент зарегистрирован в ЭДО.Поток, то вы можете сразу обмениваться с ним электронными документами. Если организация еще не пользуется сервисом ЭДО.Поток, вы можете отправить ей приглашение на почту, методом "Отправка контрагенту на почту ссылку с приглашением в ЭДО.Поток". Если контрагент пользуется другим оператором ЭДО — вам понадобится разово настроить роуминг с ним.

Роуминг можно настроить несколькими способами: 1. Ручная настройка.

Для настройки роуминга с использованием приглашений необходимо: 1. Отправить приглашение в роуминг своему контрагенту методом "Отправка приглашения контрагенту". 2. Контрагент получит приглашение на настройку роуминга в системе своего оператора ЭДО. 3. Контрагент или соглашается на настройку роуминга и отправляет ответное приглашение, или отклоняет запрос на настройку. 4. Обновленный статус роуминга отслеживайте методом "Получение списка роуминговых контрагентов и их статуса".

Для получения списка контрагентов используйте метод "Получение списка контрагентов с заданным статусом".

4.3.1. Поиск контрагентов 4.3.2. Получение списка контрагентов с заданным статусом 4.3.3. Получение списка роуминговых контрагентов и их статуса 4.3.4. Настройка роуминга с контрагентом через ЭДО Лайт 4.3.5. Отправка приглашения контрагенту 4.3.6. Отправка контрагенту на почту ссылку с приглашением в ЭДО.Поток

4.3.1. Поиск контрагентов

Метод позволяет искать контрагентов, с которыми можно сразу начать обмен документами: контрагент или зарегистрирован и работает в ЭДО.Поток или с контрагентом успешно настроен роуминг через стороннего оператора ЭДО.

Поиск контрагентов в ИС «ЭДО.Поток» осуществляется HTTP-метода GET и имеет следующий вид:

GET https://lk.edo.ru/api/edo/{version}/contractors/search-contractors?query={inf01}

Пример запроса

GET https://lk.edo.ru/api/edo/v1/contractors/search-contractors?query=7841465198
Authorization: Token 416b5600-3e36-4418-9604-e0c9843d2eef

Параметры запроса на поиск контрагента приведены в таблице 4.16.

Таблица 4.16. Параметры запроса на поиск контрагента

Параметр	Заменяемая строка	Описание
	{version}	Версия системы, текущая версия равна v1. В дальнейшем версия может измениться
query	{inf01}	ИНН клиента, КПП клиента или последовательность символов, искомая в полном названии контрагента ³⁾

Успешный ответ на запрос имеет следующий вид:

{
  "status": {
    "code": 0,
    "message": "OK"
  },
  "result": {
    "data": [
      {
        "clientId": "2PS-00278567668300483440610014472643",
        "fullName": "ООО \"Рога и копыта\"",
        "phone": "79103333412",
        "email": "RogaIKopyta@rk.ru",
        "mailAddress": null,
        "fullLegalAddress": "Брянск г Брянской Пролетарской Дивизии ул. 9",
        "kpp": "048344061",
        "inn": "2785676683",
        "ogrn": "5097571958996",
        "ifns": null,
        "certificate": null,
        "stateName": null,
        "legalAddress": {
          "postalCode": null,
          "region": null,
          "area": null,
          "city": null,
          "settlement": null,
          "street": null,
          "houseNumber": null,
          "building": null,
          "office": null,
        }
      },
      "status": "NEW",
      "operatorMnemo": "ТЕНЗОР"
    ],
    "pageInfo": {
      "pageIndex": 1,
      "pageRecords": 1,
      "pageCount": 239,
      "sortKey": NULL,
      "sortDirection": "desc"
    }
  }
}

Параметры ответа на запрос на поиск контрагента приведены в таблице 4.17.

Таблица 4.17. Параметры ответа на запрос поиска контрагента

Параметр	Вложенные поля	Вложенные поля	Формат значения	Описание
status	Структура			Состояние запроса
	code		Integer	Код ответа на запрос (0 — OK)
	message		String	Сообщение в ответе на запрос
result	Структура			Информацию по клиенту
	data	Структура		Записи о контрагентах. Параметры элементов структуры data приведены в таблице 4.17
	pageInfo	Структура		Информация о делении списка на страницы и о передаваемой странице списка
		pageIndex	Integer	Номер передаваемой страницы
		pageRecords	Integer	Количество строк списка на странице
		pageCount	Integer	Количество страниц в списке
		sortKey	String	Имя поля ключа сортировки
		sortDirection	String	Направление сортировки (см. п. 4.1.1., таблица 4.2)

Таблица 4.18. Параметры структуры «data»

Параметр	Вложенные поля	Формат значения	Описание
clientId		String	Идентификатор клиента в ИС «ЭДО.Поток»
fullName		String	Полное название клиента
phone		String	Телефонный номер клиента
email		String	Адрес электронной почты клиента
mailAddress		String	Фактический почтовый адрес клиента одной строкой
fullLegalAddress		String	Юридический адрес клиента одной строкой
kpp		String	КПП клиента
inn		String	ИНН клиента
ogrn		String	ОГРН клиента
ifns		String	Идентификационный номер ФНС, за которой закреплен клиент
certificate		String	Открытая часть сертификата электронной подписи клиента
stateName		String	Название государства, к которому относится клиент
legalAddress	Структура		Информация о юридическом адресе клиента
	postalCode	String	Почтовый индекс
	region	String	Область
	area	String	Район области (если используется)
	city	String	Город
	settlement	String	Населенный пункт
	street	String	Улица
	houseNumber	String	Номер дома
	building	String	Номер корпуса или здания
	office	String	Номер офиса
status		String	Состояние контрагента
operatorMnemo		String	Оператор ЭДО контрагента

4.3.2. Получение списка контрагентов с заданным статусом

Для получения списка контрагентов с фильтрацией по статусу применяется запрос, построенный на HTTP-методе GET и имеющий следующий вид:

GET https://lk.edo.ru/api/edo/{version}/contractors?status={status1}

Пример запроса

GET https://lk.edo.ru/api/edo/v1/contractors?status=ARE_CONTRACTORS
Authorization: Token 416b5600-3e36-4418-9604-e0c9843d2eef

Параметры запроса на поиск контрагента с заданным статусом приведены в таблице 4.20.

Таблица 4.19. Параметры запроса на поиск контрагента с заданным статусом

Параметр	Заменяемая строка	Описание
	{version}	Версия системы, текущая версия равна v1. В дальнейшем версия может измениться
status	{status1}	Состояние (статус) контрагента. Возможные значения: NO_CONNECTION — Нет соединения, NEW_CONTRACTORS — заявка на роуминг сформирована, ARE_CONTRACTORS — роуминг настроен, ARE_BLOCKED_CONTRACTORS — роуминг отключен, RC_INVITE_CONTRACTORS — пришло приглашение на настройку роуминга RC_REQUEST_CONTRACTORS — вы отправили приглашение в роуминг, ожидается ответ от контрагента, RC_ERROR — Ошибка настройки роуминга, RC_WAITING_FINISH — Ожидание окончания настройки роуминга.

Пример успешного ответа на запрос приведен в разделе. 4.3.1. Структура ответа описана в таблицах 4.17. и 4.18.

4.3.3. Получение списка роуминговых контрагентов и их статуса

Для получения списка роуминговых контрагентов и статусом работы с ними применяется запрос, построенный на HTTP-методе GET и имеющий следующий вид:

GET https://lk.edo.ru/api/edo/{version}/contractors/invitations

Заменяемый параметр {version} — обозначение текущей версии системы, по умолчанию равен v1. Пример запроса:

GET https://lk.edo.ru/api/edo/v1/contractors/invitations
Authorization: Token 416b5600-3e36-4418-9604-e0c9843d2eef

Приведен пример ответа на запрос:

{
    "status": {
        "code": 0,
        "message": "OK"
    },
    "result": {
        "data": [
            {
                "clientId": "2AL-264906832440",
                "fullName": "ЗАО \"Тест\"",
                "operatorName": "ТАКСКОМ",
                "kpp": null,
                "inn": "264906832440",
                "modifyTime": "17.06.2021 03:00:00",
                "statusType": "RC_INVITE_CONTRACTORS",
                "actions":
                [
                    "0": "ACCEPT"
                ]
            },
            {
                "clientId": "2BE-6678069434",
                "fullName": "ООО \"АВТОБЛЕСК\"",
                "operatorName": "ТЕНЗОР",
                "kpp": "667801001",
                "inn": "6678069434",
                "modifyTime": "10.06.2021 03:00:00",
                "statusType": "NEW_CONTRACTORS",
                "actions": []
            },
            {
                "clientId": "2AL1699100125",
                "fullName": "1699100125",
                "operatorName": "ТАКСКОМ",
                "kpp": "169910012",
                "inn": "1699100125",
                "modifyTime": "30.04.2021 03:00:00",
                "statusType": "RC_ERROR",
                "invitationErrorDescription":
                {
                    "errorDescription": "ИНН получателя в приглашении отличается от ИНН в online.sbis.ru",
                    "messageId": "587bf47d3c214f2588582375882c10ea",
                    "packageId": "a4b4db43fd9848d58e3b392a3b0f597e"
                },
                "actions": []

            }
        ],
        "pageInfo": {
            "pageIndex": 1,
            "pageRecords": 1000,
            "pageCount": 1,
            "sortKey": null,
            "sortDirection": "desc"
        }
    }
}

Таблица 4.21. Параметры ответа на запрос роуминговых контрагентов и их статуса

Параметр	Вложенные поля	Вложенные поля	Формат значения	Описание
status	Структура			Состояние запроса
	code		Integer	Код ответа на запрос (0 — OK)
	message		String	Сообщение в ответе на запрос
result	Структура			Информацию по клиенту
	data	Структура		Записи о контрагентах. Параметры элементов структуры data приведены в таблице 21.2
	pageInfo	Структура		Информация о делении списка на страницы и о передаваемой странице списка
		pageIndex	Integer	Номер передаваемой страницы
		pageRecords	Integer	Количество строк списка на странице
		pageCount	Integer	Количество страниц в списке
		sortKey	String	Имя поля ключа сортировки
		sortDirection	String	Направление сортировки (см. п. 4.1.1, таблица 4.1.)

Таблица 4.22. Параметры структуры «data»

Параметр	Вложенные поля	Формат значения	Описание
clientId		String	Идентификатор клиента в ИС «ЭДО.Поток»
fullName		String	Полное название клиента
phone		String	Телефонный номер клиента
operatorName		String	Названия оператора ЭДО
kpp		String	КПП клиента
inn		String	ИНН клиента
modifyTime		String	Дата и время заключения договора с контрагентом, формат ISO
statusType		String	Статус роуминга: NEW_CONTRACTORS — «Отправляет заявку», приглашение в процессе отправки, ARE_CONTRACTORS — «Роуминг настроен», ARE_BLOCKED_CONTRACTORS — «Отклонено», роуминг отключен или пришел отказ от контрагента, RC_INVITE_CONTRACTORS — «Приглашают вас», пришло приглашение на настройку роуминга RC_REQUEST_CONTRACTORS — «Ожидается ответ»,вы отправили приглашение в роуминг, ожидается ответ от контрагента, RC_ERROR — «Ошибка», настройки роуминга, описание ошибки в errorDescription, NO_CONNECTION — Нет соединения, RC_WAITING_FINISH — «В обработке», ожидание окончания настройки роуминга.
invitationErrorDescription	Структура		Данные об ошибке
	errorDescription	String	Описание ошибки, текст сформирован сторонним оператором ЭДО
	messageId	String	Технический идентификатор ЛС
	packageId	String	Технический идентификатор ТП
actions		String	мм

4.3.4. Настройка роуминга с контрагентом через ЭДО Лайт

Для настройки роуминга с контрагентом через ЭДО Лайт применяется запрос, построенный на HTTP-методе POST и имеющий следующий вид:

POST https://lk.edo.ru/api/edo/{version}/contractors/add-rc-contractor/edo-lite

Заменяемый параметр {version} — обозначение текущей версии системы, по умолчанию равен v1.

Пример запроса:

POST https://lk.edo.ru/api/edo/v1/contractors/add-rc-contractor/edo-lite
Authorization: Token 416b5600-3e36-4418-9604-e0c9843d2eef
Content-Type: application/json
{
  "fullName": "_ТЕСТ_9614000538",
  "inn":"9614000538",
  "kpp":""
}

Параметры запроса настройка роуминга с контрагентом приведены в таблице 4.23.

Таблица 4.23. Параметры запроса настройки роуминга с контрагентом

Параметр	Формат значения	Описание	Обязательно в запросе
fullName	String	название контрагента	нет
inn	String	ИНН контрагента	да
kpp	String	КПП контрагента	нет

Приведен пример успешного ответа на запрос:

{
    "status: {
        code: 0,
	    message: "OK"
    },
    "result: "5c9354ef-1dfe-4d7e-b044-706138c8de71"
}

Таблица 4.24. Параметры ответа на запрос настройки роуминга с контрагентом

Параметр	Вложенные поля	Формат значения	Описание
status	Структура		Состояние запроса
	code	Integer	Код ответа на запрос (0 — OK)
	message	String	Сообщение в ответе на запрос
result	String	Информация по настройке роуминга с контрагентом

Таблица 4.25. Описания кодов ответа на запрос

Код ответа на запрос	Сообщение	Описание кода
400	Bad Request	неправильный, некорректный запрос
50001	Clients already contractors	С клиентом уже настроен роуминг
50002	Contractor not found in EDO LITE	Клиент не найден в системе EDO Lite

4.3.5. Отправка приглашения контрагенту

Для отправки приглашения контрагенту применяется запрос, построенный на HTTP-методе POST и имеющий следующий вид:

POST https://lk.edo.ru/api/edo/{version}/contractors/add-rc-contractor

Заменяемый параметр {version} — обозначение версии системы, по умолчанию равен v1.

POST https://lk.edo.ru/api/edo/v1/contractors/add-rc-contractor
Authorization: Token 416b5600-3e36-4418-9604-e0c9843d2eef
Content-Type: application/json
{
  "clientId":"2AL-264906832440",
  "fullName":"ЗАО \"Тест\"",
  "inn":"264906832440",
  "kpp": ""
}

Параметры запроса отправка приглашения контрагенту приведены в таблице 4.26.
Таблица 4.26. Параметры запроса списка контрагентов выбранного клиента

Параметр	Формат значения	Описание	Обязательно в запросе
clientId	String	Идентификатор участника ЭДО, в сторонней системе документооборота	да
fullName	String	название организации	нет
inn	String	ИНН контрагента	да
kpp	String	КПП контрагента	нет

Приведен пример ответа на запрос:

{
    "status": {
        "code": 0,
        "message": "OK"
    },
    "result": "OK"
}

Таблица 4.27. Параметры ответа на запрос списка контрагентов, выбранного клиентам

Параметр	Вложенные поля	Формат значения	Описание
status	Структура		Состояние запроса
	code	Integer	Код ответа на запрос (0 — OK)
	message	String	Сообщение в ответе на запрос
result	String		Статус отправленного приглашения

4.3.6. Отправка контрагенту на почту ссылку с приглашением в ЭДО.Поток

Для отправки приглашения контрагенту на почту ссылку с приглашением в ЭДО.Поток применяется запрос, построенный на HTTP-методе POST и имеющий следующий вид:

POST https://lk.edo.ru/api/edo/{version}/contractors/invite-contractor

Заменяемый параметр {version} — обозначение текущей версии системы, по умолчанию равен v1.

Пример запроса:

POST https://lk.edo.ru/api/edo/v1/contractors/invite-contractor
Authorization: Token 416b5600-3e36-4418-9604-e0c9843d2eef
Content-Type: application/json
{
    email: "ofd@ofd.ru"
}

Параметры запроса отправки контрагенту на почту ссылки с приглашением в ЭДО.Поток, приведены в таблице 4.28.

Таблица 4.29. Параметры запроса отправки контрагенту на почту ссылки с приглашением в ЭДО.Поток

Параметр	Формат значения	Описание	Обязательно в запросе
email	String	Адрес электронной почты контрагента	да

Приведен пример ответа на запрос:

{
    "status": {
        "code": 0,
        "message": "OK"
    },
    "result": "b7995598-cb5c-43b2-b047-bec4d9ceeb48"
}

Таблица 4.29. Параметры ответа на запрос отправки контрагенту на почту ссылки с приглашением в ЭДО.Поток

Параметр	Вложенные поля	Формат значения	Описание
status	Структура		Состояние запроса
	code	Integer	Код ответа на запрос (0 — OK)
	message	String	Сообщение в ответе на запрос
result		String	Информация по отправки контрагенту на почту ссылки с приглашением в ЭДО.Поток

5. Маркировка

5.1. Авторизация для работы с маркировкой

Для работы с системой маркировки: отправки заказа на эмиссию кодов маркировки, документа ввода в оборот или для обновления статуса обработки этих документов в системе маркировки необходима авторизация со стороны клиента.

Ключ сессии, полученный при авторизации действует в течение 10 часов.

Для авторизации потребуется:

Методом "Запросить авторизацию при единой аутентификации" получить данные для авторизации. В запросе указать тип авторизации: emission — для работы со Станцией управления заказами (СУЗ), например для заказа новых кодов маркировки; introduction — для работы с «Честным ЗНАКом» (TrueApi) по остальным процессам маркировки, например, для ввода в оборот.
Сформировать прикрепленную подпись для данных, полученных на предыдущем методе.
Передать подписанные данные с помощью метода "Получить ключ сессии при единой аутентификации".

Текущий статус авторизации можно получить с помощью метода "Получить состояние авторизации".

5.1.1 Запрос авторизации при единой аутентификации

Запрос имеет следующий вид:

GET https://lk.edo.ru/api/edo/{version}/{authType}/auth/data-for-sign

Зменяемые параметры:

{version} — обозначение версии системы, по умолчанию равен v1;
{authType} — тип авторизации: emission — для работы со станцией управления заказами (СУЗ), например для заказа новых кодов маркировки; introduction — для работы с «Честным ЗНАКом» (TrueApi) по остальным процессам маркировки, например, для ввода в оборот.

Пример запроса

GET https://lk.edo.ru/api/edo/v1/emission/auth/data-for-sign
Authorization: Token 416b5600-3e36-4418-9604-e0c9843d2eef

Пример ответа на запрос:

{
  "contentsToSign": [
    {
      "contents": [
        {
          "content": "YmEtYTU1ZC1kNjIzMGM2NGIzMzIiCn0K",
          "id": "df08122e-30b5-11eb-adc1-02411c120123"
        }
      ],
      "providerId": "4f770978-abae-49dd-a2c7-9329b61556e9"
    }
  ]
}

Таблица 5.1. Параметры ответа на запрос

Параметр	Формат значения	Описание
Структура		Содержащая контейнеры для подписания
content	String	Строка на подпись пользователю
id	String	Уникальный идентификатор запроса на аутентификацию
providerId	String	Идентификатор провайдера авторизации

5.1.2 Получение ключа сессии при единой аутентификации

Чтобы получить ключ сессии при единой аутентификации, используется метод POST следующего вида:

POST https://lk.edo.ru/api/edo/{version}/{authType}/auth/sign

Заменяемые параметры:

{version} — обозначение версии системы, по умолчанию равен v1;
{authType} — тип авторизации: emission — для работы со станцией управления заказами (СУЗ), например для заказа новых кодов маркировки; introduction — для работы с «Честным ЗНАКом» (TrueApi) по остальным процессам маркировки, например, для ввода в оборот.

Пример запроса:

POST https://lk.edo.ru/api/edo/v1/emission/auth/sign
Authorization: Token 416b5600-3e36-4418-9604-e0c9843d2eef
Content-Type: application/json

{
  "signedContents": [
    {
      "contents": [
        {
          "content": "YmEtYTU1ZC1kNjIzMGM2NGIzMzIiCn0K....",
          "id": "df08122e-30b5-11eb-adc1-02411c120123"
        }
      ],
      "providerId": "4f770978-abae-49dd-a2c7-9329b61556e9"
    }
  ]
}

Таблица 5.2. Параметры структуры ответа

Параметр	Формат значения	Описание
Структура		Содержащая контейнеры для подписания
content	String	Сформированная прикрепленную подпись для контента, полученного ранее: параметр «content» из ответа за запрос метода «Запрос авторизации при единой аутентификации»
id	String	Уникальный идентификатор запроса на аутентификацию, полученный в методе «Запрос авторизации при единой аутентификации»
providerId	String	Идентификатор провайдера авторизации, полученный в методе «Запрос авторизации при единой аутентификации»

Пример ответа на запрос:


{
  "actualStates": [
    {
      "inn": "5250030906",
      "profiles": [
        {
          "providerId": "4f770978-abae-49dd-a2c7-9329b61556e9",
          "tokenTtl": "2018-01-01T12:13:14Z"
        }
      ]
    }
  ]
}

Таблица 5.3. Поля структуры ответа на запрос

Параметр	Формат значения	Описание
inn		String	ИНН клиента
legalAddress	Массив данных		Профили авторизации
	providerId	String	Идентификатор провайдера авторизации
	tokenTtl	String	Время инвалидации токена (UTC).

5.1.3 Получение состояния авторизации

Чтобы получить состояние авторизации, используется метод GET следующего вида:

GET https://lk.edo.ru/api/edo/{version}/{authType}/auth/state

Заменяемые параметры:

{version} — обозначение версии системы, по умолчанию равен v1;
{authType} — тип авторизации: emission — для работы со станцией управления заказами (СУЗ), например для заказа новых кодов маркировки; introduction — для работы с «Честным ЗНАКом» (TrueApi) по остальным процессам маркировки, например, для ввода в оборот.

Пример запроса

GET https://lk.edo.ru/api/edo/v1/emission/auth/state
Authorization: Token 416b5600-3e36-4418-9604-e0c9843d2eef

Пример ответа на запрос:

{
  "actualStates": [
    {
      "inn": "5250030906",
      "profiles": [
        {
          "providerId": "4f770978-abae-49dd-a2c7-9329b61556e9",
          "tokenTtl": "2018-01-01T12:13:14Z"
        }
      ]
    }
  ]
}

Таблица 5.4. Поля структуры состояния авторизации

Параметр	Формат значения	Описание
inn		String	ИНН пользователя
legalAddress	Массив данных		Профили авторизации
	providerId	String	Идентификатор провайдера авторизации. Параметр будет отсутствовать, если токена авторизации нет или закончился срок его действия
	tokenTtl	String	Время инвалидации токена (UTC). Параметр будет отсутствовать, если токена авторизации нет или закончился срок его действия

5.2. Заказ кодов маркировки

Прежде чем создать и отправить первый заказ в «Честный ЗНАК», настройте работу с заказами. Для этого вам понадобится указать параметр OMS ID — уникальный идентификатор клиента в Станции управления заказами (СУЗ) и получить OmsConnection — уникальный идентификатор соединения.

Шаги по первичной настройке работы с заказами:

Узнать ваш OMS ID — уникальный идентификатор клиента в Станции управления заказами (СУЗ) (Как найти этот параметр?).
Методом "5.2.9 Сохранение OMS ID " сохранить OMS ID;
Методом "5.2.10 Получить данные для подписи в рамках получения omsConnection" получить сроку для подписания в параметре ответа «contentForSignBase64».
Подписать полученную на предыдущем шаге строку. Для подписания требуется взять данные из параметра «contentForSignBase64» запроса "5.2.10 Получить данные для подписи в рамках получения omsConnection", перевести эти данные из формата base64 в бинарные данные и поместить в файл для подписания, после чего сформировать открепленную однострочную (без знаков переноса) подпись.
Методом "5.2.11 Отправка подписанных данных в рамках получения omsConnection" передать бинарный контент подписи (в Base64) и строку для подписания, для которой сформирована подпись.

Текущие параметры OMS ID и OmsConnection можно получить с помощью метода "Получение параметров OMS ID и OmsConnection".

Порядок действий при заказе кодов маркировки:

Авторизоваться для работы с маркировкой. Как это сделать читайте в разделе "5.1. Авторизация для работы с маркировкой".
Методом "5.2.1 Создание заказа на коды маркировки" создать заказ на коды маркировки.
Методом "5.2.2 Получить контенты заказа для подписания" получить один или несколько бинарных контентов заказа (Base64) и идентификаторов контента.
Подписать полученные контенты. Для подписания контента требуется взять данные из параметра «content» запроса "5.2.2 Получить контенты заказа для подписания", перевести эти данные из формата base64 в бинарные данные и поместить в файл для подписания, после чего сформировать открепленную однострочную (без знаков переноса) подпись.
Методом "5.2.3 Отправка подписанных контентов заказа" передать бинарный контент подписи (в Base64) и идентификатор контента, для которого сформирована подпись.
Проверять статус заказа с помощью метода "5.2.4 Получить статус заказа", пока статус не изменится на success или partialFailure.
Получить коды методом "5.2.6 Получение кодов маркировки".

Так же существуют методы: "5.2.5 Cписок заказов и их статусы" — на получение списка заказов; метод "5.2.7 Получение подробной информации о статусе каждого кода товара/GTIN в заказе" и "5.2.8 Получение информации об общих параметрах заказа" — на получение полной информации по конкретному заказу.

5.2.1 Создание заказа на коды маркировки

Для создания заказа используется запрос на основе метода POST. Запрос имеет следующий вид:

POST https://lk.edo.ru/api/edo/{version}/marking-codes/orders/create

Заменяемый параметр {version} — обозначение версии системы, по умолчанию равен v1.

Параметры запроса на создание заказа приведены в таблице 25.

Таблица 5.5. Параметры запроса на создание заказа

Параметр	Вложенные поля	Формат значения	Описание	Обязательно в запросе
orderName		String	Наименование заказа	Да
number		String	Номер заказа (должен быть уникальным)	Да
comment		String	Комментарий к заказу	Нет
positions	Структура		Список товаров	Да
	gtin	String (14) [0-9] {14}	Код товара (GTIN)	Да
	name	String	Наименование товара	Да
	quantity	Integer ($int32)	Количество КМ	Да
	serialNumberType	String	Способ генерации серийных номеров: SELF_MADE — самостоятельно; OPERATOR — оператором ГИС МТ.	Да
	serialNumbers	JSON Array of String	Массив серийных номеров. Это поле указывается в случае, если значение «serialNumber = SELF_MADE»	Нет Условно обязательное
	templateId	Integer ($int32)	Идентификатор шаблона товарной группы: 1 — обувные товары; 10 — предметы одежды, белье постельное, столовое, туалетное и кухонное; 7 — шины и покрышки пневматические резиновые новые; 8 — фотокамеры (кроме кинокамер), фотовспышки и лампы-вспышки; 9 — Духи и туалетная вода; 11 — велосипеды и велосипедные рамы; 12 — кресла коляски.	Да
	cisType	String	Тип кода маркировки: UNIT — единица товара; BUNDLE — комплект; SET — набор; GROUP — групповая потребительская упаковка. Используется только для ТГ «Одежда», «Фото» и «Духи», обязательно для данной ТГ.	Нет Условно обязательное
	exporterTaxpayerId	String	ИНН/УНБ (или аналог) экспортера. Используется только для ТГ «Одежда», «Фото», «Шины», «Духи» и «Обувь». Становится обязательным для этих ТГ, только если в поле releaseMethod (способ выпуска товара в оборот) было выбрано значение «CROSSBORDER» (Ввезен в РФ из стран ЕАЭС)	Нет Условно обязательное
productGroup		String	Товарная группа: lp — легкая промышленность; shoes — обувные товары; perfumery — Духи и туалетная вода; tires — Шины и покрышки пневматические резиновые новые; electronics — Фотокамеры (кроме кинокамер), фотовспышки и лампы-вспышки; bicycle –Велосипеды и велосипедные рамы; wheelchairs — Кресла коляски.	Да
clientToken		String		Да
omsId		String		Да
createMethodType		String	Способ изготовления: SELF_MADE — Самостоятельно; CEM — ЦЭМ; CM — Контрактное производство; CL — Логистический склад; CA — Комиссионная площадка. Используется только для ТГ «Одежда», «Фото», «Кресла-коляски», «Велосипеды», «Шины», «Духи» и «Обувь», обязательно для данных ТГ.	Нет Условно обязательное
releaseMethodType		String	Способ выпуска товаров: PRODUCTION — производство РФ; IMPORT — ввезен в РФ (импорт); REMAINS — маркировка остатков (доступно только для ТГ «Духи и туалетная вода»); COMMISSION — Принят на комиссию от физического лица (доступно для ТГ «Одежда», «Обувь»). Используется только для ТГ «Одежда» и «Обувь», обязательно для данных ТГ.	Нет Условно обязательное
contactPerson		String	Контактное лицо. Используется только для ТГ «Одежда», «Велосипеды», «Кресла-коляски», «Шины», «Фото», «Духи» и «Обувь».	Нет
productionOrderId		String	Идентификатор производственного заказа. Используется только для ТГ «Одежда», «Велосипеды», «Кресла-коляски», «Фото», «Шины», «Духи» и «Обувь».	Нет
serviceProviderId		String (36) UUID	Идентификатор сервис-провайдера. Используется только при наличии сервис-провайдера в ЛК Честного знака.	Нет

Пример содержимого заказа кодов по товарной группе «Предметы одежды, белье постельное, столовое, туалетное и кухонное»

POST https://lk.edo.ru/api/edo/v1/marking-codes/orders/create
Authorization: Token 416b5600-3e36-4418-9604-e0c9843d2eef
Content-Type: application/json

{
  "orderName": "Заказ Краснодар №41",
  "number": "NUMBER_1",
  "comment": "Comment",
  "positions": [
    {
      "gtin": "04636332455049",
      "name": "ПАЛЬТО ЗИМНЕЕ ЛЁГКОЕ КОРИЧНЕВОЕ .ВОРОТНИК-ПЕСЕЦ",
      "quantity": 125,
      "serialNumberType": "OPERATOR",
      "templateId": 10,
      "cisType": "BUNDLE"
    },
    {
      "gtin": "04636332455041",
      "name": "Наволочки белые 40х30х60 артикул 8786347879",
      "quantity": 125,
      "serialNumberType": "OPERATOR",
      "templateId": 10,
      "cisType": "UNIT
    }
  ],
  "productGroup": "lp",
  "clientToken": "d1d15b74-e56a-45d9-aaa9-9ad25f5108e8",
  "omsId": "79871fbf-c16d-4213-868a-462f5fcacc19",
  "createMethodType": "SELF_MADE",
  "releaseMethodType": "PRODUCTION",
  "contactPerson": "Иванов П.А."
}

Пример содержимого заказа кодов по товарной группе «Обувные товары»

{
  "orderName": "Заказ Уфа №41 от 01.02.2021",
  "number": "NUMBER_DRAFT_2",
  "comment": "Comment",
  "positions": [
    {
      "gtin": "04636332455067",
      "name": "Галоши резиновые мужские, 56 размер",
      "quantity": 100,
      "serialNumberType": "OPERATOR",
      "templateId": 1
    }
  ],
  "productGroup": "SHOES",
  "clientToken": "d1d15b74-e56a-45d9-aaa9-9ad25f5108e8",
  "omsId": "79871fbf-c16d-4213-868a-462f5fcacc19",
  "createMethodType": "SELF_MADE",
  "releaseMethodType": "IMPORT"
}

В случае успешной отправки возвращается идентификатор заказа (draftId). Пример успешного ответа на запрос:

  "df08122e-30b5-11eb-adc1-0242ac120016"

5.2.2 Получить контенты заказа для подписания

Для получения контентов заказа для подписания используется запрос на основе метода GET. Запрос имеет следующий вид:

GET https://lk.edo.ru/api/edo/{version}/marking-codes/orders/{draftId}/contents

Заменяемые параметры:

{version} — обозначение версии системы, по умолчанию равен v1;
{draftId} — идентификатор заказа, полученный на предыдущем шаге (содержится в успешном ответе на запрос POST /marking-codes/orders/create).

Пример запроса

GET https://lk.edo.ru/api/edo/v1/marking-codes/orders/df08122e-30b5-11eb-adc1-0242ac120016/contents
Authorization: Token 416b5600-3e36-4418-9604-e0c9843d2eef

Пример успешного ответа на запрос:

[
  {
    "content": "ewogICAgInByb2R1Y3...",
    "id": "6f9619ff-8b86-d011-b42d-00cf4fc964f2"
  },
  {
    "content": "CAgICAgICAgImAgImA...",
    "id": "6cbf8302-25f6-4139-834e-b857143cbd8f"
  }
]

Параметры ответа приведены в таблице 5.6.

Таблица 5.6. Параметры структуры ответа на запрос

Параметр	Формат значения	Описание
Структура		Содержащая контейнеры для подписания
content	String	Контент документа в формате base64
id	String	Идентификатор контента документа

После получения контентов для подписания, нужно подписать их. Для этого требуется перевести данные из формата base64 в бинарные данные и поместить в файл для подписания, после чего создать открепленную однострочную (без знаков переноса) подпись и отправляем ее, используя метод «4.1.3 Отправка подписанных контентов заказа».

5.2.3 Отправка подписанных контентов заказа

Метод позволяет отправить заказ на обработку в «Честный ЗНАК». Используется после получения контентов из метода «4.1.2 Получить контенты заказа для подписания» и их подписания. Для подписания контента требуется перевести данные параметра «content» из формата base64 в бинарные данные и поместить в файл для подписания, после чего создать открепленную однострочную (без знаков переноса) подпись и отправить ее в параметре «content» запроса «4.1.3 Отправка подписанных контентов заказа».

Для отправки подписанных контентов заказа используется запрос на основе метода POST. Запрос имеет следующий вид:

POST https://lk.edo.ru/api/edo/{version}/marking-codes/orders/{draftId}/contents/sign

Заменяемые параметры:

{version} — обозначение версии системы, по умолчанию равен v1;
{draftId} — идентификатор заказа, полученный в методе «4.1.1 Создание заказа на коды маркировки».

Параметры запроса на отправку заказа в «Честный ЗНАК» представлены в таблице 5.7.

Таблица 5.7. Параметры структуры запроса

Параметр	Формат значения	Описание
Структура		Содержащая подписанные контейнеры
content	String	Подписанный контент заказа
id	String	Идентификатор контента заказа

Пример содержимого метода отправки заказа:

POST https://lk.edo.ru/api/edo/v1/marking-codes/orders/df08122e-30b5-11eb-adc1-0242ac120016/contents/sign
Authorization: Token 416b5600-3e36-4418-9604-e0c9843d2eef
Content-Type: application/json
{
  "contents": [
    {
      "content": "MIIMuAYJKoInByb2R1Y3RzIjogWwogICA...",
      "id": "6f9619ff-8b86-d011-b42d-00cf4fc964f2"
    },
    {
      "content": "MIIMuAYJKoZIhvcNAQcCoIIMqTCCDKUCA...",
      "id": "6cbf8302-25f6-4139-834e-b857143cbd8f"
    }
  ]
}

В случае успешной отправки возвращается Response Messages: 200 ОК.

5.2.4 Получить статус заказа

Метод позволяет получить статус конкретного заказа, используется запрос на основе метода GET. Запрос имеет следующий вид:

GET https://lk.edo.ru/api/edo/{version}/marking-codes/orders/{draftId}/status

Заменяемые параметры:

{version} — обозначение версии системы, по умолчанию равен v1;
{draftId} — идентификатор заказа, полученный в методе «4.1.1 Создание заказа на коды маркировки».

Пример запроса

GET https://lk.edo.ru/api/edo/v1/marking-codes/orders/df08122e-30b5-11eb-adc1-0242ac120016/status
Authorization: Token 416b5600-3e36-4418-9604-e0c9843d2eef

Пример успешного ответа на запрос:

    IN_PROC

Параметры ответа представлены в таблице 5.8.

Таблица 5.8. Параметры структуры ответа на запрос

Формат значения	Описание
String	Статус заказа: DRAFT — Черновик, INPROC — Заказ в обработке, SUCCESS — Заказа обработан без ошибок, FAILURE — Заказ обработан: ошибка по всем позициям, PARTIALFAILURE — Заказ обработан: часть позиций с ошибками.

5.2.5 Cписок заказов и их статусы

Для получения списка заказов и их статусов используется запрос на основе метода POST. Запрос имеет следующий вид:

POST https://lk.edo.ru/api/edo/{version}/marking-codes/orders/list

Заменяемый параметр {version} — обозначение версии системы, по умолчанию равен v1.

Параметры запроса приведены в таблице 5.9.
Таблица 5.9. Параметры запроса на получение списка заказа

Параметр	Формат значения	Описание	Значение по умолчанию	Обязательность в запросе
creationTimeFromIncl	String	Начальная дата периода поиска документов в формате (yyyy-MM-ddTHH:mm:ssZ), где yyyy — год, mm — месяц, dd — день, T — это долговременный паттерн (константа), HH — часы, mm — минуты, ss — секунды, Z — часовой пояс. Примеры даты: «2021-02-15T18:46:25+03:00» — UTC+03 часа, по Московскому времени, «2021-02-15T18:46:25Z» — UTC.		нет
creationTimeToExcl	String	Конечная дата периода поиска документов в формате (yyyy-MM-ddTHH:mm:ssZ), где yyyy — год, mm — месяц, dd — день, T — это долговременный паттерн (константа), HH — часы, mm — минуты, ss — секунды, Z — часовой пояс.	Текущая дата	нет
orderName	String	Наименование заказа		нет
draftId	String	Идентификатор заказа		нет
pageSize	NUM	Количество записей на странице. В виде десятичного целого числа	1000	нет
pageIndex	INDEX	Номер запрашиваемой страницы списка документов; в виде десятичного целого числа	1	нет

Пример запроса:

POST https://lk.edo.ru/api/edo/v1/marking-codes/orders/list
Authorization: Token 416b5600-3e36-4418-9604-e0c9843d2eef
Content-Type: application/json
{
  "creationTimeFromIncl": "2021-02-15T18:46:25+03:00",
  "creationTimeToExcl": "2021-02-16T18:46:25+03:00",
  "pageSize": 1000,
  "pageIndex": 1
}

Пример запроса без фильтров:

POST https://lk.edo.ru/api/edo/v1/marking-codes/orders/list
Authorization: Token 416b5600-3e36-4418-9604-e0c9843d2eef
Content-Type: application/json
{

}

Пример успешного ответа на запрос:

{
  "result": {
    "data": [
      [
        {
          "draftId": "3cf0b5ce-447d-4fb9-86dd-c982362aa754",
          "productGroup": "lp",
          "creationTime": "2021-03-22T11:18:56.174Z",
          "status": "Success",
          "requestedQuantity": 9,
          "actualQuantity": 9,
          "gtinCount": 3,
          "orderName": "Тестирование 1 ",
          "number": "1616411464201",
          "releaseMethodType": "IMPORT"
        }
      ]
    ],
    "pageInfo": {
      "pageCount": 0,
      "pageIndex": 0,
      "pageRecords": 0,
      "sortDirection": "string",
      "sortKey": {
        "present": true
      }
    }
  },
  "status": {
    "code": 0,
    "message": "string"
  }
}

Параметры ответа представлены в таблице 5.10.

Таблица 5.10. Параметры структуры ответа на запрос

Параметр	Вложенные поля	Вложенные поля	Формат значения	Описание
result	Структура			Параметры авторизации
	data	Структура		Данные списка заказов
		creationtime	String	Дата создания заказа
		draftId	String	Идентификатор заказа, полученный в ответе на метод «Создание заказа на коды маркировки»
		orderName	String	Наименование заказа
		number	String	Идентификатор заказа, полученный от пользователя
		gtincount	String	Ваш идентификатор участника ЭДО
		productgroup	String	Товарная группа: lp — легкая промышленность; shoes — обувные товары; perfumery — Духи и туалетная вода; tires — Шины и покрышки пневматические резиновые новые; electronics — Фотокамеры (кроме кинокамер), фотовспышки и лампы-вспышки; bicycle –Велосипеды и велосипедные рамы; wheelchairs — Кресла коляски.
		gtinCounty	Integer	Количество кодов товара/GTIN в заказе
		requestedQuantity	Integer	Заказанное количество кодов маркировки
		actualQuantity	Integer	Фактически полученное количество кодов маркировки
		status	String	Статус заказа: DRAFT — Черновик, INPROC — Заказ в обработке, SUCCESS — Заказа обработан без ошибок, FAILURE — Заказ обработан: ошибка по всем позициям, PARTIALFAILURE — Заказ обработан: часть позиций с ошибками
	pageInfo	Структура		Информация о делении списка на страницы и о передаваемой странице списка
		pageCount	Integer	Количество страниц в списке
		pageIndex	Integer	Номер передаваемой страницы
		pageRecords	Integer	Количество строк списка на странице
		sortDirection	String	Порядок сортировки. Возможные значения: asc — восходящая (прямой порядок); desc — нисходящая (обратный порядок). Значение по умолчанию — desc.
status	Структура			Состояние запроса
	code		Integer	Код ответа на запрос (0 — OK)
	message		String	Сообщение в ответе на запрос

5.2.6 Получение кодов маркировки

Метод используется для получения кодов маркировки по заказу. Заказ должен иметь статус Success или PartialFailure. Метод позволяет забрать все доступные коды по заказу или по конкретному коду товара (gtin).
Для получения кодов маркировки используется запрос на основе метода GET.
Запрос имеет следующий вид:

GET https://lk.edo.ru/api/edo/{version}/marking-codes/orders/{draftId}/codes?gtin={gtin}

Все параметры в данном запросе приведены в таблице 5.11.

Таблица 5.11. Параметры запроса на получение списка документов

Параметр	Заменяемая строка	Описание	Обязательно в запросе
	{version}	Обозначение версии системы, текущая версия равна v1	да
draftId	{draftId}	Идентификатор заказа	да
gtin	{gtin}	Код товара	нет

Пример запроса

GET https://lk.edo.ru/api/edo/v1/marking-codes/orders/df08122e-30b5-11eb-adc1-0242ac120016/codes?gtin=04636332455032
Authorization: Token 416b5600-3e36-4418-9604-e0c9843d2eef

Структура успешного ответа на запрос:

{
  "draftId": "string",
  "markingCodes": [
    "string"
  ]
}

Параметры ответа представлены в таблице 5.12.

Таблица 5.12. Параметры структуры ответа на запрос

Параметр	Формат значения	Описание
draftId	String	Идентификатор заказа
markingCodes		Массив кодов маркировки

5.2.7 Получение подробной информации о статусе каждого кода товара/GTIN в заказе

Метод позволяет получить информацию о товарных позициях конкретного заказа кодов маркировки, используется запрос на основе метода GET. Запрос имеет следующий вид:

GET https://lk.edo.ru/api/edo/{version}/marking-codes/orders/{orderId}/positions

Заменяемые параметры:

{version} — обозначение версии системы, по умолчанию равен v1;
{orderId} — Id заказа.

Пример запроса

GET https://lk.edo.ru/api/edo/v1/marking-codes/orders/df08122e-30b5-11eb-adc1-0242ac120016/positions
Authorization:Token 416b5600-3e36-4418-9604-e0c9843d2eef

Пример успешного ответа на запрос:

{
  "result": {
    "data": [
      {
        "name": "04636332455032",
        "gtin": "04636332455032",
        "requestedCodesCnt": 2,
        "obtainedCodesCnt": 0,
        "status": "Failure",
        "details": "Проверка учетных данных УОТ не пройдена. Маркер безопасности b9b248ec-ea14-2f4f-7372-37e80892a1ae не найден"
      }
    ],
    "pageInfo": {
      "pageCount": 1,
      "pageIndex": 1,
      "pageRecords": 1,
      "sortDirection": "desc",
      "sortKey": "someKey"
    }
  },
  "status": {
    "code": 0,
    "message": "some message here"
  }
}

Параметры ответа представлены в таблице 5.13.

Таблица 5.13. Параметры структуры ответа на запрос

Параметр	Вложенные поля	Вложенные поля	Формат значения	Описание
result	Структура			Содержимое ответа
	data	Структура		Данные контейнера
		gtin	String	Номер gtin
		name	String	Наименование
		requestedCodesCnt	Integer	Количество запрошенных кодов
		obtainedCodesCnt	Целое число	Количество полученных кодов
		status	Integer	Статус заказа по конкретному коду товара/GTIN: Success — коды получены, PartialFailure, Failure — отклонено, InProс — в обработке, AwaitingSign — заказ создан, ожидает подписания для отправки в «Честный ЗНАК»
		details	String	Причина ошибки
	pageInfo	Структура		Информация о делении списка на страницы и о передаваемой странице списка
		pageCount	Integer	Количество страниц в списке
		pageIndex	Integer	Номер передаваемой страницы
		pageRecords	Integer	Количество записей на странице.
		sortDirection	Integer	Направление сортировки
		sortKey	String	Порядок сортировки. Возможные значения: asc — восходящая (прямой порядок); desc — нисходящая (обратный порядок). Значение по умолчанию — desc
status	Структура			Состояние запроса
	code		Integer	Код ответа на запрос (0 — OK)
	message		String	Сообщение в ответе на запрос

5.2.8 Получение информации об общих параметрах заказа

Метод позволяет получить параметры конкретного заказа, используется запрос на основе метода GET. Запрос имеет следующий вид:

GET https://lk.edo.ru/api/edo/{version}/marking-codes/orders/{orderId}?include=mc-orig-req&include=mc&include=intro

Заменяемые параметры:

{version} — обозначение версии системы, по умолчанию равен v1;
{orderId} — Id заказа

Пример запроса

GET https://lk.edo.ru/api/edo/v1/marking-codes/orders/df08122e-30b5-11eb-adc1-0242ac120016?include=mc-orig-req&include=mc&include=intro
Authorization: Token 416b5600-3e36-4418-9604-e0c9843d2eef

Пример успешного ответа на запрос:

{
    "result": {
        "originalRequest": {
            "number": "938a9a02-f203-4694-9165-8326a22f9f38",
            "comment": "комментарий",
            "omsId": "79871fbf-c16d-4213-868a-462f5fcacc14",
            "clientToken": "d1d15b74-e56a-45d9-aaa9-9ad25f5108e9",
            "positions": [
                {
                    "gtin": "04636332455094",
                    "name": "Куртка зеленая мужская, 54 размер",
                    "quantity": 98,
                    "serialNumberType": "OPERATOR",
                    "templateId": "10",
                    "cisType": "UNIT"
                }
            ],
            "releaseMethodType": "IMPORT",
            "productGroup": "lp",
            "contactPerson": "Иванов И.А.",
            "createMethodType": "SELF_MADE",
            "orderName": "531313"
        },
        "mcOrderInfo": {
            "comment": "комментарий к заказу",
            "creationTime": "2021-02-15T10:51:55.457Z",
            "finishedProcessingTime": "2021-02-15T10:51:55.457Z",
            "orderName": "Наименование заказа",
            "startProcessingTime": "2021-02-15T10:51:55.457Z",
            "status": "InProc",
            "totalObtainedCodesCnt": 8,
            "totalRequestedCodesCnt": 10
        }
  },
  "status": {
    "code": 0,
    "message": "ОК"
  }
}

Параметры ответа представлены в таблице 5.14.

Таблица 5.14. Параметры структуры ответа на запрос

Параметр	Вложенные поля	Вложенные поля	Вложенные поля	Формат значения	Описание
result	Структура				Параметры авторизации
	originalRequest	Структура			Параметры заказа, полученные при его формировании
		number		String	Номер заказа, указанный клиентом в методе «Создание заказа на коды маркировки»
		comment		String	Комментарий
		omsId		String	Идентификатор клиента в ЧЗ, указанный при создании заказа
		clientToken		String	Токен авторизации, указанный при создании заказа
		positions	Структура		Список товаров
			gtin	String (14) [0-9] {14}	Код товара (GTIN)
			name	String	Наименование товара
			quantity	Integer($int32)	Количество КМ
			serialNumberType	String	Способ генерации серийных номеров: SELF_MADE — самостоятельно; OPERATOR — оператором ГИС МТ.
			serialNumbers	JSON Array of String	Массив серийных номеров. Это поле указывается в случае, если значение «serialNumber = SELF_MADE»
			templateId	Integer ($int32)	Идентификатор шаблона товарной группы: 1 — обувные товары; 10 — предметы одежды, белье постельное, столовое, туалетное и кухонное; 7 — шины и покрышки пневматические резиновые новые; 8 — фотокамеры (кроме кинокамер), фотовспышки и лампы-вспышки; 9 — Духи и туалетная вода; 11 — велосипеды и велосипедные рамы; 12 — кресла коляски.
			cisType	String	Тип кода маркировки: UNIT — единица товара; BUNDLE — комплект; SET — набор; GROUP — групповая потребительская упаковка. Используется только для ТГ «Одежда», обязательно для данной ТГ.
			exporterTaxpayerId	String	ИНН/УНБ (или аналог) экспортера. Используется только для ТГ «Одежда» и «Обувь». Становится обязательным для этих ТГ, только если в поле releaseMethod (способ выпуска товара в оборот) было выбрано значение «CROSSBORDER» (Ввезен в РФ из стран ЕАЭС)
		productGroup		String	Товарная группа: lp — легкая промышленность; shoes — обувные товары; perfumery — Духи и туалетная вода; tires — Шины и покрышки пневматические резиновые новые; electronics — Фотокамеры (кроме кинокамер), фотовспышки и лампы-вспышки; bicycle –Велосипеды и велосипедные рамы; wheelchairs — Кресла коляски.
		clientToken		String
		omsId		String
		createMethodType		String	Способ изготовления: SELF_MADE — Самостоятельно; CEM — ЦЭМ; CM — Контрактное производство; CL — Логистический склад; CA — Комиссионная площадка. Используется только для ТГ «Одежда» и «Обувь», обязательно для данных ТГ.
		releaseMethodType		String	Способ выпуска товаров: PRODUCTION — производство РФ; IMPORT — ввезен в РФ (импорт); REMAINS — маркировка остатков (доступно только для ТГ «Духи и туалетная вода»); COMMISSION — Принят на комиссию от физического лица (доступно для ТГ «Одежда», «Обувь»). Используется только для ТГ «Одежда» и «Обувь», обязательно для данных ТГ.
		contactPerson		String	Контактное лицо. Используется только для ТГ «Одежда» и «Обувь»
		productionOrderId		String	Идентификатор производственного заказа. Используется только для ТГ «Одежда» и «Обувь»
		serviceProviderId		String(36) UUID	Идентификатор сервис-провайдера. Используется только при наличии сервис-провайдера в ЛК Честного знака.
		orderName		String	Наименование заказа
	mcOrderInfo	Структура			Информация об обработке заказа в ЧЗ
		comment		String	Пользовательский комментарий
		creationTime		String	Время создания заказа
		finishedProcessingTime		String	Время получения итогового ответа от ЧЗ по каждому коду товара/GTIN в заказе
		orderName		String	Наименование заказа
		startProcessingTime		String	Время подписания заказа и отправки в ЧЗ
		status		String	Статус заказа: DRAFT — Черновик, INPROC — Заказ в обработке, SUCCESS — Заказа обработан без ошибок, FAILURE — Заказ обработан: ошибка по всем позициям, PARTIALFAILURE — Заказ обработан: часть позиций с ошибками
		totalObtainedCodesCnt		Integer	Общее количество полученных КМ для заказа
		totalRequestedCodesCnt		Integer	Общее количество заказанных КМ для заказа
status	Структура				Состояние запроса
	code			Integer	Код ответа на запрос (0 — OK)
	message			String	Сообщение в ответе на запрос

5.2.9 Сохранение OMS ID

Метод позволяет сохранить параметр OMS ID — уникальный идентификатор клиента в Станции управления заказами (СУЗ) Честного ЗНАКа. Как найти этот параметр?
При повторном успешном вызове метода параметр OMS ID пересохраняется.
Используется запрос на основе метода POST. Запрос имеет следующий вид:

POST https://lk.edo.ru/api/edo/{version}/crpt/org/oms-info/edit

Заменяемый параметр {version} — обозначение версии системы, по умолчанию равен v1.

Параметры запроса

Параметр	Формат значения	Описание	Обязательно в запросе
omsId	String	OMS ID — уникальный идентификатор в СУЗ	Да

Пример запроса

POST https://lk.edo.ru/api/edo/v1/crpt/org/oms-info/edit
Authorization: Token 416b5600-3e36-4418-9604-e0c9843d2eef
Content-Type: application/json

{
  omsId: "79871fbf-c16d-4213-868a-462f5fcacc14"
}

Пример успешного ответа на запрос имеет следующий вид

{
  "result": {
    "omsId": "79871fbf-c16d-4213-868a-462f5fcacc14"
  },
  "status": {
    "code": 0,
    "message": "ОК"
  }
}

Назначение полей структуры ответа на запрос авторизации приведено в таблице 5.15.
Таблица 5.15. Поля структуры ответа на запрос авторизации

Параметр	Вложенные поля	Формат значения	Описание
status	Структура		Состояние запроса
	code	Integer	Код ответа на запрос (0 — OK)
	message	String	Сообщение в ответе на запрос
result	Структура		Параметры
result	omsId	String	OMS ID — уникальный идентификатор в СУЗ

5.2.10 Получить данные для подписи в рамках получения omsConnection

Для получения данных для подписания используется запрос на основе метода POST. Запрос имеет следующий вид:

POST https://lk.edo.ru/api/edo/{version}/crpt/org/oms-info/oms-connection/for-sign

Заменяемый параметр {version} — обозначение версии системы, по умолчанию равен v1..

Пример запроса

POST https://lk.edo.ru/api/edo/v1/crpt/org/oms-info/oms-connection/for-sign
Authorization: Token 416b5600-3e36-4418-9604-e0c9843d2eef

Структура успешного ответа на запрос:

{
  "result": {
    "contentForSignBase64": "contentForSignBase64"
  },
  "status": {
    "code": 0,
    "message": "some message here"
  }
}

Параметры ответа приведены в таблице 5.16.

Таблица 5.16. Параметры структуры ответа на запрос

Параметр	Вложенные поля	Формат значения	Описание
status	Структура		Состояние запроса
	code	Integer	Код ответа на запрос (0 — OK)
	message	String	Сообщение в ответе на запрос
result	Структура		Параметры
result	contentForSignBase64	String	Строка для подписания

После получения строки для подписания, нужно подписать ее. Для этого требуется перевести данные из формата base64 в бинарные данные и поместить в файл для подписания, после чего создать открепленную однострочную (без знаков переноса) подпись и отправить ее, используя метод «5.2.11 Отправка подписанных данных в рамках получения omsConnection».

5.2.11 Отправка подписанных данных в рамках получения omsConnection

Метод позволяет отправить заказ на обработку в «Честный ЗНАК». Используется после получения строки из метода «5.2.10 Получить данные для подписи в рамках получения omsConnection» и ее подписания. Для подписания строки требуется перевести данные из формата base64 в бинарные данные и поместить в файл для подписания, после чего создать открепленную однострочную (без знаков переноса) подпись и отправить ее в параметре «contentSignedBase64» запроса «5.2.11 Отправка подписанных данных в рамках получения omsConnection».

Для отправки подписанных данных используется запрос на основе метода POST. Запрос имеет следующий вид:

POST https://lk.edo.ru/api/edo/{version}/crpt/org/oms-info/oms-connection/sign

Заменяемый параметр {version} — обозначение версии системы, по умолчанию равен v1.

Параметры запроса на отправку данных представлены в таблице 5.17.

Таблица 5.17. Параметры структуры запроса

Параметр	Формат значения	Описание
contentBase64	String	Строка для подписания, полученная в параметре «contentForSignBase64» метода "Отправка подписанных данных в рамках получения omsConnection"
contentSignedBase64	String	Результат подписания строки: открепленная подпись в формате PKCS#7/CMS, закодированная с помощью алгоритма “Base 64”, без переноса строк.

Пример структуры содержимого метода:

POST https://lk.edo.ru/api/edo/v1/crpt/org/oms-info/oms-connection/sign
Authorization: Token 416b5600-3e36-4418-9604-e0c9843d2eef
Content-Type: application/json

{
  "contentBase64": "ceyJhZGRyZXNzIjo....Строка",
  "contentSignedBase64": "MIIMuAYJKoZIhvc.....Строка"
}

Пример успешного ответа на запрос:

{
  "result": {},
  },
  "status": {
    "code": 0,
    "message": "OK"
  }
}

Параметры ответа приведены в таблице 5.18.

Таблица 5.18. Параметры структуры ответа на запрос

Параметр	Вложенные поля	Формат значения	Описание
status	Структура		Состояние запроса
	code	Integer	Код ответа на запрос (0 — OK)
	message	String	Сообщение в ответе на запрос
result	Структура

5.2.12 Получение параметров OMS ID и OmsConnection

Метод позволяет получить информацию о сохраненных параметрах OMS ID (уникальный идентификатор клиента в Станции управления заказами (СУЗ) Честного ЗНАКа) и OmsConnection (уникальный идентификатор соединения), используется запрос на основе метода GET. Запрос имеет следующий вид:

GET https://lk.edo.ru/api/edo/{version}/crpt/org/oms-info

Заменяемый параметр {version} — обозначение версии системы, по умолчанию равен v1.

Пример запроса

GET https://lk.edo.ru/api/edo/v1/crpt/org/oms-info
Authorization: Token 416b5600-3e36-4418-9604-e0c9843d2eef

Пример успешного ответа на запрос:

{
  "result": {
    "omsConnection": "a35c80bb-9af3-4478-8d91-a07ce3be6c43",
    "omsId": "79871fbf-c16d-4213-868a-462f5fcacc14"
  },
  "status": {
    "code": 0,
    "message": "OK"
  }
}

Параметры ответа представлены в таблице 5.19.

Таблица 5.19. Параметры структуры ответа на запрос

Параметр	Вложенные поля	Формат значения	Описание
result	Структура		Содержимое ответа
	omsConnection	String	Уникальный идентификатор соединения
	omsId	String	Уникальный идентификатор клиента в СУЗ
status	Структура		Состояние запроса
	code	Integer	Код ответа на запрос (0 — OK)
	message	String	Сообщение в ответе на запрос

5.3. Ввод в оборот

Порядок действий при вводе в оборот:

методом «Создать документ ввода в оборот (Импорт с ФТС, Производство в РФ, Полученных от физических лиц)» создать документ ввода в оборот;
методом "5.3.4 Получить данные документа ввода в оборот для подписания" получить бинарный контент документа (Base64) и идентификатор контента;
Сформировать прикреплённую подпись для бинарного контента заказа;
Передать бинарный контент подписи (в Base64) методом "5.3.5 Отправить подписанный документ ввода в оборот в «Честный ЗНАК»";
Проверять статус обработки документа ввода с помощью метода "5.3.6 Получить статус документа ввода в оборот ".

5.3.1 Создать документ ввода в оборот (Импорт ФТС)

Данный метод позволяет создать документ «Ввод в оборот. Импорт ФТС». В случае успешной отправки возвращается идентификатор документа (documentId).

Для создания заказа используется запрос на основе метода POST. Запрос имеет следующий вид:

POST https://lk.edo.ru/api/edo/{version}/marking-codes/introduction/import-fts

Заменяемый параметр {version} — обозначение версии системы, по умолчанию равен v1.

Параметры запроса на создание заказа приведены в таблице 5.20.

Таблица 5.20. Параметры запроса на создание заказа

Параметр	Вложенные поля	Формат значения	Описание	Обязательно в запросе
documentNumber		String	Номер документа ввода в оборот (должно быть уникальным)	Да
declarationDate		String	Дата декларации имеет вид «YYYY-MM-DD». Пример «2020-02-22»	Да
declarationNumber		String	Номер декларации. Пример номера декларации: «05100000/220220/0002233», где «220220» — это дата декларации, которая должна совпадать с датой, указанной в параметре declarationDate.	Да
comment		String	Комментарий к документу	Нет
positions	Структура		Список товаров	Да
	cis	String	Код маркировки	Да
	packtype	String	Тип упаковки: UNIT — КИ; LEVEL1-99 — КИТУ.	Да
productGroup		String	Товарная группа: lp — легкая промышленность; shoes — обувные товары.	Да

Пример запроса

POST https://lk.edo.ru/api/edo/v1/marking-codes/introduction/import-fts
Authorization: Token 416b5600-3e36-4418-9604-e0c9843d2eef
Content-Type: application/json

{
  "documentNumber": "6f9619ff-8b86-d011-b42d-00cf4fc964f2",
  "declarationNumber": "05100000/110121/0002233",
  "declarationDate": "2021-01-11",
  "comment": "комментарий к документу",
  "positions": [
    {
      "cis": "010463633245506321VKCCw)HEmmMog",
      "packType": "UNIT"
    }
  ],
  "productGroup": "lp"
}

В случае успешной отправки возвращается идентификатор документа (documentId).
Пример успешного ответа на запрос:


   df08122e-30b5-11eb-adc1-0242ac120016

5.3.2 Создать документ ввода в оборот (Полученных от физических лиц)

Данный метод позволяет создать документ «Ввод в оборот. Полученных от физических лиц». В случае успешной отправки возвращается идентификатор документа (documentId).

Для создания заказа используется запрос на основе метода POST. Запрос имеет следующий вид:

POST https://lk.edo.ru/api/edo/{version}/marking-codes/introduction/individual

Заменяемый параметр {version} — обозначение версии системы, по умолчанию равен v1.

Параметры запроса на создание заказа приведены в таблице 5.21.

Таблица 5.21. Параметры запроса на создание заказа

Параметр	Вложенные поля	Формат значения	Описание	Обязательно в запросе
documentnumber		String	Номер документа ввода в оборот (должно быть уникальным)	Да
comment		String	Комментарий к документу	Нет
positions	Структура		Список товаров	Да
	uit	String	Код маркировки. Обязательный, если не указан «uitu»	Условно обязательное
	uitu	String	Уникальный идентификатор транспортной упаковки. Обязательный, если не указан «uit»	Условно обязательное
	product_receiving_date	date	Дата получения товара. Параметр присутствует в запросе, если его значение отличается от значения параметра «product_receiving_date». Задается в формате yyyy-MMddTHH:mm:ss.SSS’Z	Нет
productgroup		String	Товарная группа: lp — легкая промышленность; shoes — обувные товары.	Да
productReceivingDate		String (date-time)	Дата получения товара. Задается в формате yyyy-MMddTHH:mm:ss.SSS’Z, например, «2021-01-19T21:00:00.000Z»	Да

Пример запроса

POST https://lk.edo.ru/api/edo/v1/marking-codes/introduction/individual
Authorization: Token 416b5600-3e36-4418-9604-e0c9843d2eef
Content-Type: application/json

{
  "documentNumber": "6f9619ff-8b86-d011-b42d-00cf4fc964f2",
  "comment": "комментарий к документу",
  "positions": [
    {
      "uit": "010463633245506321VKCCw)HEmmMog"
    }
  ],
  "productgroup": "lp",
  "productReceivingDate: "2021-01-19T21:00:00.000Z"
}

В случае успешной отправки возвращается идентификатор документа (documentId).
Пример успешного ответа на запрос:

   df08122e-30b5-11eb-adc1-0242ac120016

5.3.3 Создать документ ввода в оборот (Производство РФ)

Данный метод позволяет создать документ «Ввод в оборот. Производство РФ». В случае успешной отправки возвращается идентификатор документа (documentId).

Для создания заказа используется запрос на основе метода POST. Запрос имеет следующий вид:

POST https://lk.edo.ru/api/edo/{version}/marking-codes/introduction/production

Заменяемый параметр {version} — обозначение версии системы, по умолчанию равен v1.

Параметры запроса на создание заказа приведены в таблице 5.22.

Таблица 5.22. Параметры запроса на создание заказа

Параметр	Вложенные поля	Формат значения	Описание	Обязательно в запросе
documentnumber		String	Номер документа ввода в оборот (должно быть уникальным)	Да
comment		String	Комментарий к документу	Нет
positions	Структура		Список товаров	Да
	productGroup	String	Товарная группа: lp — легкая промышленность; shoes — обувные товары.	Да
	productionDate	date	Дата создания продукции. Задается в формате yyyy-MM-dd	Да
	uit	String	Код маркировки. Обязательный, если не указан «uitu»	Условно обязательное
	uitu	String	Уникальный идентификатор транспортной упаковки. Обязательный, если не указан «uit»	Условно обязательное
	tnved_code	String	Код товарной номенклатуры (10 знаков)	Нет
	certificate_document	String	Код вида документа обязательной сертификации \\Возможные значения: CONFORMITY_CERTIFICATE — сертификат соответствия; CONFORMITY_DECLARATION –декларация соответствия	Нет
	certificate_document_number	String	Номер документа обязательной сертификации	Нет
	certificate_document_date	String (date-time)	Дата документа обязательной сертификации. Задается в формате yyyy-MM-dd. Диапазон даты, начиная с 2000-01-01 по дату создания документа	Да
	vsd_number	string	Номер ВСД, указывается для ТГ «Молочная продукция», обязательный, если в карточке НК «veterinaryControl» = true	Да

POST https://lk.edo.ru/api/edo/v1/marking-codes/introduction/production
Authorization: Token 416b5600-3e36-4418-9604-e0c9843d2eef
Content-Type: application/json

{
  "comment": "Some comment",
  "documentNumber": "6f9619ff-8b86-d011-b42d-00cf4fc964f2",
  "positions": [
   {     "production_date": "2019-01-01",
         "uit_code": "0104630033880100211AREwAwLETM7g240ffd0",
         "uitu_code": 111111111111111111,
         "tnved_code": "6401921000",
          "certificate_document": "CONFORMITY_CERTIFICATE",
          "certificate_document_number": "123",
          "certificate_document_date": "2019-01-01",
           "vsd_number": "9DDA-5D57-FAEA-46DD-B94D-3DCC-AC70-1091" }
           ],
  "productGroup": "lp",
  "productionDate": "2019-01-01"
}

В случае успешной отправки возвращается идентификатор документа (documentId).
Пример успешного ответа на запрос:

   df08122e-30b5-11eb-adc1-0242ac120016

5.3.4 Получить данные документа ввода в оборот для подписания

Данный метод позволяет получить данные документа для подписания.

Используется запрос на основе метода GET. Запрос имеет следующий вид:

GET https://lk.edo.ru/api/edo/{version}/marking-codes/introduction/{documentId}/contents

Ззаменяемые параметры:

{version} — обозначение версии системы, по умолчанию равен v1;
{documentId} — Id документа.

Пример запроса

GET https://lk.edo.ru/api/edo/v1/marking-codes/introduction/df08122e-30b5-11eb-adc1-0242ac120016/contents
Authorization: Token 416b5600-3e36-4418-9604-e0c9843d2eef

Пример ответа

{
  "content": "ewogICAgInB...",
  "id": "6f9619ff-8b86-d011-b42d-00cf4fc964f2"
}

Таблица 38. Параметры ответа на запрос

Параметр	Формат значения	Описание
content	string	Идентификатор контента документа
id	String	Контент документа в формате base64

5.3.5 Отправить подписанный документ ввода в оборот в «Честный ЗНАК»

Метод позволяет отправить документ ввода в оборот в «Честный ЗНАК». Используется после получения контента из метода «Получение данных документа ввода в оборот для подписания» и их подписания. Для подписания контента требуется перевести данные параметра «content» из формата base64 в бинарные данные и поместить в файл для подписания, после чего создать прикрепленную однострочную (без знаков переноса) подпись и отправить ее в параметре «content» запроса «Отправка подписанного документа ввода в оборот в «Честный ЗНАК».

Для отправки документа используется запрос на основе метода POST. Запрос имеет следующий вид:

POST https://lk.edo.ru/POST/api/edo/{version}/marking-codes/introduction/{documentId}/send

Ззаменяемые параметры:

{version} — обозначение версии системы, по умолчанию равен v1;
{documentId} — Id документа.

Пример запроса

POST https://lk.edo.ru/api/edo/v1/marking-codes/introduction/df08122e-30b5-11eb-adc1-0242ac120016/send
Authorization: Token 416b5600-3e36-4418-9604-e0c9843d2eef
Content-Type: application/json

{
  "content": "ewogICAgInB..."
}

Таблица 5.23. Коды ответа на запрос

Статус кода HTTP	Причина ответа
200	Запрос выполнен успешно
401	Ошибка аутентификации/авторизации

5.3.6 Получить статус документа ввода в оборот

Данный метод позволяет получить статус документа ввода в оборот.

Используется запрос на основе метода GET. Запрос имеет следующий вид:

GET https://lk.edo.ru/api/edo/{version}/marking-codes/introduction/{documentId}/status

Ззаменяемые параметры:

{version} — обозначение версии системы, по умолчанию равен v1;
{documentId} — Id документа.

Пример запроса

GET https://lk.edo.ru/api/edo/v1/marking-codes/introduction/df08122e-30b5-11eb-adc1-0242ac120016/status
Authorization: Token 416b5600-3e36-4418-9604-e0c9843d2eef

Пример ответа

{
  "codesIntroductionType": "LP_FTS_INTRODUCE",
  "comment": "some comment",
  "documentId": "cf9619ff-8b76-d211-b42d-00cf4fc964f5",
  "documentNumber": "6f9619ff-8b86-d011-b42d-00cf4fc964f2",
  "documentStatus": "Created",
  "errors": "\"errors\":\"{\"errors\": [\"parse_error\", \"parse_error_2\"]\"}\"",
  "productGroup": "lp"
}

Таблица 5.24. Параметры ответа на запрос на создание заказа

Параметр	Формат значения	Описание	Обязательно в запросе
codesIntroductionType	string	Тип документа на ввод в оборот: LP_FTS_INTRODUCE — Ввод в оборот. Импорт с ФТС; LP_INTRODUCE_GOODS — Ввод в оборот. Производство; LK_INDI_COMMISSIONING — Ввод в оборот. Полученных от физических лиц.	Да
comment	String	Комментарий к документу	Нет
documentId	String	Уникальный идентификатор документа в ГИС МТ.	Да
documentNumber	String	Уникальный идентификатор запроса пользователя, задается пользователем	Да
documentStatus	string	Статус документа: Created — «Требуется подпись», документ ввода создан, требуется подписать документ для отправки его в Честный ЗНАК»; Sending — «Отправляется» SentForIntroduction — «Отправлен в ЧЗ» IntroductionFailed — «Ошибка ввода» SendingError — «Ошибка отправки документа» Introduced — «Введено в оборот».	Да
errors	string	Ошибки документа по вводу в оборот КМ	Нет
productgroup	String	Товарная группа: lp — легкая промышленность; shoes — обувные товары.	Да

6. Порядок тестирования

6.1. Описание

Раздел описывает способ тестирования услуги «ЭДО.Поток». Для тестирования используется демонстрационный личный кабинет клиента (ЛКК), подключенный к тестовой информационной системе «ЭДО.Поток».

6.2. Вход в демо ЛКК

Чтобы войти в личный кабинет клиента (демо), выполнить следующие действия:

Переходим по ссылке;
Автоматически подставленные данные в полях «Электронная почта» и «Пароль» удаляем.
Вводим данные:
1. электронная почта: edotest1@ofd.ru
2. пароль: 1231
Нажимаем кнопку «Войти»;
Вы оказались в демо личном кабинете.

Теперь вы можете проверить работоспособность функционала ИС «ЭДО.Поток»

История изменений

Версия 2.0
Выпущена 11 января 2019 г.
Первая регистрируемая версия документа.

Версия 2.1
Выпущена 10 апреля 2019 г.
Исправлены ошибки в тексте и в ответах получаемые при выполнении запросов.

Версия 2.2
Выпущена 24 апреля 2020 г.
Изменен адрес сервера, на который необходимо отправлять API-запросы.

Версия 2.3
Выпущена 11 сентября 2020 г.
Исправлена ошибка в методе авторизации в ИС «ЭДО.Поток».

Версия 2.4
Выпущена 25 сентября 2020 г.

Исправлена нумерация таблиц;
Устранены мелкие недочеты по всему объему документа.

Версия 2.5
Выпущена 09 октября 2020 г.

Переработаны таблицы для большей наглядности информации о вложенных полях в структурах;
Исправлены названия таблиц по всему объему документа;
Исправлены ошибки в тексте и в ответах получаемые при выполнении запросов;
Добавлены параметры в таблицу 4;
Исправлена ошибка в методе авторизации через AuthToken.

Версия 2.6
Выпущена 12 октября 2020 г.

Исправлена ошибка в методе 3.1.10 Вывод справочника типов документов;
Исправлены ошибка в методе 3.3.1 Поиск контрагентов;
Добавлен метод 3.3.2. Получение списка контрагентов по статусу.

Версия 2.7
Выпущена 15 октября 2020 г.
Убран блок информации 3.2. Запросы, связанные с клиентами.

Версия 2.8
Выпущена 18 ноября 2020 г.

Изменен адрес запросов с edmapi.ofd.ru на lk.edo.ru;
Временно убран раздел «Авторизация с помощью имени пользователя (логина) и пароля»;
Добавлен раздел 3.1.13. Получение извещения на подтверждение оператора (для отправителя);
Добавлен раздел 3.1.14. Получение извещений на документ (для получателя);
Добавлен раздел 3.1.15. Получение любых извещений на документы.

Версия 2.9
Выпущена 23 декабря 2020 г.

Добавлен раздел 3.1 Отправка заказа кодов маркировки в «Честный ЗНАК»
Добавлен раздел 3.2 Получение статуса заказа и кодов маркировки

Версия 3.0
Выпущена 03 марта 2021 г.
Добавлен раздел 4. Маркировка

Версия 3.1
Выпущена 04 марта 2021 г.

Добавлен раздел 4.2.3 Создание документа ввода в оборот (Производство РФ)
Добавлен раздел 4.2.4 Получение данных документа для подписания
Добавлен раздел 4.2.5 Сохранение подписанных данных заказа на ввод кодов в оборот для последующей отправки в ГИС МТ
Добавлен раздел 4.2.6 Получение статуса документа ввода в оборот КМ

Версия 3.2
Выпущена 10 марта 2021 г.
Добавлен раздел 2 — Метод регистрации в ИС «ЭДО.Поток»

Версия 3.3
Выпущена 23 марта 2021 г.
Добавлены методы получение информации о товарных позициях заказа КМ, получение информации о параметрах заказа КМ

Версия 3.4
Выпущена 27 апреля 2021 г.
Добавлены разделы:

4.2.1. Метод загрузки черновика
4.2.2. Метод получения списка черновиков
4.2.3. Метод скачивания черновика
4.2.4. Метод удаления черновика
4.2.5. Метод отправки черновика
4.2.6. Метод получения печатной формы черновика в PDF

Версия 3.5
Выпущена 30 июня 2021 г.
Добавлены разделы:

4.3. Работа с контрагентами;
6. Порядок тестирования.

¹⁾

Зависит от текущей или используемой версии системы, может изменяться.

²⁾

Зависит от текущей или используемой версии системы, может изменяться

³⁾

Задается по правилам написания адресов URL и URI: недопустимые символы заменяются служебными последовательностями в соответствии с RFC 3986, см. https://ru.wikipedia.org/wiki/URL, https://www.ietf.org/rfc/rfc3986.txt и http://www.protocols.ru/WP/rfc3986/.

API ЭДО.Поток

Коннектор 1C.ОП

Коннектор 1C.УП

Программный интерфейс приложений (API)для работы с ИС «ЭДО.Поток»

Введение

1. Общий вид запроса и ответа в API

2. Метод регистрации в ИС «ЭДО.Поток»

3. Метод авторизации в ИС «ЭДО.Поток»

3.1. Авторизация через AuthToken

4. ЭДО.Поток

4.1. Запросы, связанные с документами

4.1.1. Получение списка документов клиента

4.1.2. Отправка документа

4.1.3. Получение списка документов для подписания

4.1.4. Получение предварительно заполненного шаблона документа

4.1.5. Подписание документа

4.1.6. Удаление документа

4.1.7. Восстановление документа

4.1.8. Получение детализированной информации о документе

4.1.9. Получение комплекта документов

4.1.10. Вывод справочника типов документов

4.1.11. Загрузка документа

4.1.12. Получение извещения на подтверждение оператора (для отправителя)

4.1.13. Получение извещений на документ (для получателя)

4.1.14. Получение любых извещений на документы

4.1.15. Получение PDF-представления формализованного документа

4.2 Методы работы с черновиками

4.2.1 Метод загрузки черновика

4.2.2 Метод получения списка черновиков

4.2.3 Метод скачивания черновика

4.2.6 Метод удаления черновика

4.3. Работа с контрагентами

4.3.1. Поиск контрагентов

4.3.2. Получение списка контрагентов с заданным статусом

4.3.3. Получение списка роуминговых контрагентов и их статуса

4.3.4. Настройка роуминга с контрагентом через ЭДО Лайт

4.3.5. Отправка приглашения контрагенту

4.3.6. Отправка контрагенту на почту ссылку с приглашением в ЭДО.Поток

5. Маркировка

5.1. Авторизация для работы с маркировкой

5.1.1 Запрос авторизации при единой аутентификации

5.1.2 Получение ключа сессии при единой аутентификации

5.1.3 Получение состояния авторизации

5.2. Заказ кодов маркировки

5.2.1 Создание заказа на коды маркировки

5.2.2 Получить контенты заказа для подписания

5.2.3 Отправка подписанных контентов заказа

5.2.4 Получить статус заказа

5.2.5 Cписок заказов и их статусы

5.2.6 Получение кодов маркировки

5.2.7 Получение подробной информации о статусе каждого кода товара/GTIN в заказе

5.2.8 Получение информации об общих параметрах заказа

5.2.9 Сохранение OMS ID

5.2.10 Получить данные для подписи в рамках получения omsConnection

5.2.11 Отправка подписанных данных в рамках получения omsConnection

5.2.12 Получение параметров OMS ID и OmsConnection

5.3. Ввод в оборот

5.3.1 Создать документ ввода в оборот (Импорт ФТС)

5.3.2 Создать документ ввода в оборот (Полученных от физических лиц)

5.3.3 Создать документ ввода в оборот (Производство РФ)

5.3.4 Получить данные документа ввода в оборот для подписания

5.3.5 Отправить подписанный документ ввода в оборот в «Честный ЗНАК»

5.3.6 Получить статус документа ввода в оборот

6. Порядок тестирования

6.1. Описание

6.2. Вход в демо ЛКК

История изменений

Программный интерфейс приложений (API)
для работы с ИС «ЭДО.Поток»