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

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

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

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

Здесь:

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

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

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

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

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

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

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

POST https://lk.edo.ru/api/edo/v1/clients/registration
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"
}

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

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

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

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

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

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

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

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

Authorization: Token {TOKEN}

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

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

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

Авторизация может производиться двумя способами: с помощью логина и пароля или с помощью механизма AuthToken.

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

Authorization: Token {TOKEN1}

Здесь: {TOKEN1} — токен, возвращенный в результате авторизации (см. пп. 1.2.1 Авторизация через AuthToken и 2.2).

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

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

Авторизация посредством механизма 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"
}

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

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

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
Content-Type: application/json

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

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

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

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

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

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

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

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

POST https://lk.edo.ru/api/edo/{VERSION}/clients/auth-global

Здесь: {VERSION} — обозначение текущей версии системы, по умолчанию равное v1, но впоследствии номер версии может быть другим.

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

POST https://lk.edo.ru/api/edo/v1/clients/auth-global
Content-Type: application/json
{
  "clientId": "2PS-0078414651",
  "password": "PASSWORD"
}

Где:

• clientId — уникальный идентификатор клиента в ИС «ЭДО.Поток»;
• password — пароль клиента в «ЭДО.Поток». Для получения пароля обратитесь в техническую поддержку edo@edo.ru

Оба поля являются обязательными для заполнения.

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

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

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

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

Универсальный передаточный документ (УПД) можно использовать как:

• счет-фактуру (функция СЧФ);
• первичный документ, подтверждающий совершение хозяйственной операции, например накладную или акт (функция СЧФДОП);
• документ, который совмещает в себе счет-фактуру и первичный документ, подтверждающий совершение хозяйственной операции (функция ДОП).

Универсальный корректировочный документ (УКД) можно использовать как:

• корректировочную счет-фактуру (функция КСЧФ);
• документ об изменении стоимости в первичном документе (функция КСЧФДИС);
• документ, который совмещает в себе корректировочную счет-фактуру и документ об изменении стоимости в первичном документе (функция ДИС).

«Action»- это список возможных процедур с документами. Список возможных процедур выводится в соответствии с документом. В таблице 2.2. описаны процедуры с документами в соответствие с Action.

Таблица 2.2. Описание процедур с документами в соответствие с Action

Для получения списка документов клиента используется 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

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

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

Далее здесь во всех запросах будет указана первая версия 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"
    }
  }
}

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

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

Для отправки формализованного документа заданному получателю используется запрос на основе метода 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",
    "nds": true,
    "signRequested": true
  }
}

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

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

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

Для получения клиентом списка документов для подписания используется 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

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

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

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

{
  "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
    }
  ]
}

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

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

Метод используется для формирования:

• извещения о получении документа (ИОП),
• уведомления об уточнении (УОУ),
• ответных титулов для УПД/УКД (по приказу 174н),
• ответного титула заказчика на Акт (формализованный),
• ответного титула получателя Накладной (формализованной).

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

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"
}

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

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

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

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

Описание параметров структуры ответа на запрос предварительно заполненной формы приведено в таблице 2.9.

Таблица 2.9. Описание параметров структуры ответа на запрос предварительно заполненной формы

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

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

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

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

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…"
}

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

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

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

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

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

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

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

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 — идентификатор удаляемого документа.
Пример успешного ответа на запрос описан в разделе "Введение", при этом параметр «message» имеет значение «OK», а «result» имеет значение «null».

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

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

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

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

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

{
  "docId": "2604"
}

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

Для получения детализированной информации о документе используется запрос на основе метода 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"
  }
}

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

Запросить комплект связанных документов можно с помощью запроса на основе метода 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

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

Запросить справочник типов документов, определенных в системе, с указанием их названия, внутреннего идентификатора и признака формализованности можно с помощью запроса на основе метода 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
    }
  ]
}

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

Таблица 2.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

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

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

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

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

Для получения извещения о подтверждении оператора о дате получения документа используется запрос на основе метода 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
	}
}

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

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

Для получения извещений для получателя используется запрос на основе метода 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
		}
	}
}

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

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

Для того чтобы получить извещение о получении документа (далее ИОП) применяется запрос, построенный на HTTP-методе POST и имеет следующий вид:

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

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

Запрос:

POST https://lk.edo.ru/api/edo/v1/documents/provisional/tech
Authorization: Token 8890ea5e-95f8-4d33-b4bc-7ace2339fc91

{
  "parentDocId": 1264334,
  "fingerprint": "264f3033bef7d64be7df8375eb0c4882df868f9e"
}

Описание параметров запроса ИОП, приведены в таблице 2.14.

Таблица 2.14. Описание параметров запроса ИОП

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

{
  "status": {
    "code": 0,
    "message": "OK"
  },
  "result": {
    "contentBase64": "PD94bWwgd...",
    "uuid": "64f81e54-3011-4e0e-b619-c102d34bdbae",
    "docTypeId": 3
  }
}

Таблица 2.15. Описание параметров ответа на запрос ИОП

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

POST https://lk.edo.ru/api/edo/{version}/documents/provisional/tech/sign

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

Запрос:

POST https://dev-dev.edo.ru/api/edo/v1/documents/provisional/tech/sign
Authorization: Token 8890ea5e-95f8-4d33-b4bc-7ace2339fc91

{
  "uuid": "64f81e54-3011-4e0e-b619-c102d34bdbae",
  "signatureBase64": "MIINAwYJKoZIhvcNAQ...UGjuGrfud0="
}

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

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

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

{
  "status": {
    "code": 0,
    "message": "OK"
  },
  "result": {
    "docId": null,
    "docUuid": "64f81e54-3011-4e0e-b619-c102d34bdbae"
  }
}

Таблица 2.17. Описание параметров ответа на запрос опубликования ИОП

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

Для получения извещений по всем документам используется запрос на основе метода 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
		},
		...
	]
}

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

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

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

Документ в формате “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

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

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

POST https://lk.edo.ru/api/edo/{version}/documents/provisional/buyer/title

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

Запрос:

POST https://lk.edo.ru/api/edo/v1/documents/provisional/buyer/title
Authorization: Token 8890ea5e-95f8-4d33-b4bc-7ace2339fc91

{
  "provisionalDocParams": {
    "parentDocId": 1264334,
    "fingerprint": "264f3033bef7d64be7df8375eb0c4882df868f9e"
  },
  "additionalParams": {
    "docTypeId": 11,
    "fingerprint": "264f3033bef7d64be7df8375eb0c4882df868f9e",
    "parentDocId": 1264334,
    "svPrinSodOper": "Принято без замечаний",
    "svPrinDataPrin": "16.09.2021"
  }
}

Описание параметров запроса для получения черновика титула УПД и УКД, приведены в таблице 2.19.

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

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

{
  "status": {
    "code": 0,
    "message": "OK"
  },
  "result": {
    "contentBase64": "PD94bWwgdmVyc2...6es+Cg==",
    "uuid": "17396e78-5464-4419-a2ef-18be3fc3ba4c",
    "docTypeId": 11
  }
}

Таблица 2.20. Описание параметров ответа на запрос получения черновика титула УПД-ПОК

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

POST https://lk.edo.ru/api/edo/{version}/documents/provisional/buyer/title/sign

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

Запрос:

https://lk.edo.ru/api/edo/v1/documents/provisional/buyer/title/sign
Authorization: Token 8890ea5e-95f8-4d33-b4bc-7ace2339fc91

{
  "signatureBase64": "MIINAwYJK...cpPHsag=",
  "uuid": "17396e78-5464-4419-a2ef-18be3fc3ba4c"
}

Описание параметров запроса опубликования подписанного черновика титула УПД или подписанного черновика титула УКД, приведены в таблице 2.21.

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

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

{
  "status": {
    "code": 0,
    "message": "OK"
  },
  "result": {
    "docId": 1266165,
    "docUuid": null
  }
}

Таблица 2.22. Описание параметров ответа на запрос опубликования подписанного черновика титула УПД или подписанного черновика титула УКД

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

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

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

Запрос:

POST https://lk.edo.ru/api/edo/v1/documents/provisional/reject
Authorization: Token 8890ea5e-95f8-4d33-b4bc-7ace2339fc91
{
  "provisionalDocParams": {
    "parentDocId": 1266167,
    "fingerprint": "264f3033bef7d64be7df8375eb0c4882df868f9e"
  },
  "additionalParams": {
    "fingerprint": "264f3033bef7d64be7df8375eb0c4882df868f9e",
    "parentDocId": 1266167,
    "textRefinement": "Не верно указан поставщик ",
    "docTypeId": 6
  }
}

Описание параметров запроса для получения черновик УОУ, приведены в таблице 2.23.

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

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

{
  "status": {
    "code": 0,
    "message": "OK"
  },
  "result": {
    "contentBase64": "PD94bWwgdmVy...t8j4KPC/U4OnrPgo=",
    "uuid": "596c50af-d65a-4cb8-b404-fc27bf805215",
    "docTypeId": 6
  }
}

Таблица 2.24. Описание параметров ответа на запрос получения черновика УОУ

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

POST https://lk.edo.ru/api/edo/{version}/documents/provisional/rejected/sign

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

Запрос:

POST https://lk.edo.ru/api/edo/v1/provisional/rejected/sign
Authorization: Token 8890ea5e-95f8-4d33-b4bc-7ace2339fc91

{
  "signatureBase64": "MIINAwYJKoZIh...GDBKQ=",
  "uuid": "596c50af-d65a-4cb8-b404-fc27bf805215"
}

Описание параметров запроса опубликование подписанного черновика для УОУ, приведены в таблице 2.25.

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

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

{
  "status": {
    "code": 0,
    "message": "OK"
  },
  "result": {
    "docId": 1266172,
    "docUuid": null
  }
}

Таблица 2.26. Описание параметров ответа на запрос опубликования подписанного черновика для УОУ

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

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

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

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

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

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"
        }
    }
}

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

Таблица 2.30. Описание параметров структуры ответа

Для получения списка черновиков используется запрос на основе метода 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

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

Таблица 2.31. Описание параметров запроса

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

{
    "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"
        }
    }
}

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

Таблица 2.32. Описание параметров структуры ответа

Для скачивания черновика используется запрос на основе метода 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

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

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

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

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

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

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

{
  "draftId": "28027"
}

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

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

Роуминг можно настроить несколькими способами:

1. Ручная настройка.

Для настройки роуминга с использованием приглашений необходимо:

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

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

Поиск контрагентов в ИС «ЭДО.Поток» осуществляется 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

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

Таблица 2.33. Описание параметров запроса на поиск контрагента

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

{
  "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"
    }
  }
}

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

Таблица 2.34. Описание параметров ответа на запрос поиска контрагента

Таблица 2.35. Описание параметров структуры «data»

Для получения списка контрагентов с фильтрацией по статусу применяется запрос, построенный на 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

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

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

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

Для получения списка роуминговых контрагентов и статусом работы с ними применяется запрос, построенный на 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"
        }
    }
}

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

Таблица 2.38. Описание параметров структуры «data»

Для настройки роуминга с контрагентом через ЭДО Лайт применяется запрос, построенный на 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":""
}

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

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

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

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

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

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

Для отправки приглашения контрагенту применяется запрос, построенный на 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": ""
}

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

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

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

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

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

Для отправки приглашения контрагенту на почту ссылку с приглашением в ЭДО.Поток применяется запрос, построенный на 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"
}

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

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

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

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

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

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

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

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

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

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

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"
    }
  ]
}

Таблица 3.1. Описание параметров ответа на запрос

Чтобы получить ключ сессии при единой аутентификации, используется метод 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"
    }
  ]
}

Таблица 3.2. Описание параметров структуры ответа

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

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

Таблица 3.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"
        }
      ]
    }
  ]
}

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

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

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

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

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

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

1. Проверьте, что вы авторизованы в системе маркировки с помощью метода "Получить состояние авторизации", указав в запросе в параметре authType значение emission. В ответе вы получите Время инвалидации токена (параметр tokenTtl). Если время больше текущего, значит вы авторизованы в системе. Если в ответе параметр отсутствует или время меньше текущего, то требуется авторизоваться для работы с маркировкой. Как это сделать читайте в разделе "3.1. Авторизация для работы с маркировкой". При авторизации в запросах в параметре authType указывайте значение emission.
2. Методом "3.2.1 Создание заказа на коды маркировки" создать заказ на коды маркировки.
3. Методом "3.2.2 Получить контенты заказа для подписания" получить один или несколько контентов заказа (Base64) и идентификаторов контента.
4. Подписать полученные контенты. Для подписания контента требуется взять данные из параметра «content» запроса "3.2.2 Получить контенты заказа для подписания", перевести эти данные из формата base64 в данные и поместить в файл для подписания, после чего сформировать открепленную однострочную (без знаков переноса) подпись.
5. Методом "3.2.3 Отправка подписанных контентов заказа" передать контент подписи (в Base64) и идентификатор контента, для которого сформирована подпись.
6. Проверять статус заказа с помощью метода "3.2.4 Получить статус заказа", пока статус не изменится на success или partialFailure.
7. Получить коды методом "3.2.6 Получение кодов маркировки".

Так же существуют методы:

1. "3.2.5 Список заказов и их статусы" — на получение списка заказов;
2. "3.2.7 Получение подробной информации о статусе каждого кода товара/GTIN в заказе"
3. "3.2.8 Получение информации об общих параметрах заказа" — на получение полной информации по конкретному заказу.

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

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

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

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

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

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

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"

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

{
  "status": {
    "code": 40032,
    "message": "Request contains duplicate gtins: [aaaaaa, bbbb]"
    },
  "result": null
}

В запросе создание заказа на коды маркировки присутствуют элементы совпадающие с GTIN.

Для получения контентов заказа для подписания используется запрос на основе метода 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"
  }
]

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

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

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

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

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

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

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

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

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

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

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

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 ОК.

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

{
  "status": {
    "code": 40031,
    "message": "Requested contents for order '0835504b-c325-4119-ad3e-16e6c7c72e70' are not available for sign: [fce4c600-a834-4d02-913c-5ab2d032ac6f]"
    },
  "result": null
}

Подписанные контейнеры не прошли проверку, подписанные контейнеры не входят в состав заказа.

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

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

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

• {version} — обозначение версии системы, по умолчанию равен v1;
  
• {draftId} — идентификатор заказа, полученный в методе "3.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

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

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

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

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

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

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

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

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"
  }
}

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

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

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

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

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

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

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

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"
  ]
}

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

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

Метод позволяет получить информацию о товарных позициях конкретного заказа кодов маркировки, используется запрос на основе метода 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"
  }
}

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

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

Метод позволяет получить параметры конкретного заказа, используется запрос на основе метода 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": "ОК"
  }
}

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

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

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

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

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

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

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

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": "ОК"
  }
}

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

Для получения данных для подписания используется запрос на основе метода 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"
  }
}

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

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

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

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

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

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

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

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

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

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

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"
  }
}

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

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

Метод позволяет получить информацию о сохраненных параметрах 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"
  }
}

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

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

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

1. Проверить, что вы авторизованы в системе маркировки с помощью метода "Получить состояние авторизации". Обязательно указать в запросе в параметре {authType} значение introduction. В ответе вы получите Время инвалидации токена (параметр tokenTtl). Если время больше текущего, значит вы авторизованы в системе. Если в ответе параметр отсутствует или время меньше текущего, то требуется авторизоваться для работы с маркировкой. Как это сделать читайте в разделе "3.1. Авторизация для работы с маркировкой". При авторизации в запросах в параметре authType указывайте значение introduction.
2. Воспользуйтесь одним из методов создания заявки ввода в оборот:
   1. Методом Создание заявки "Ввода в оборот (Импорт ФТС)" создать документ ввода в оборот (Импорт ФТС).
      
   2. Методом Создание заявки "Ввода в оборот (Полученных от физических лиц)" создать документ ввода в оборот (Полученных от физических лиц).
      
   3. Методом Создание заявки "Ввод из оборот (Производство РФ)" создать документ ввода в оборот (Производство РФ).
      
3. Методом "3.3.4 Получить данные документа ввода в оборот для подписания" получить контент документа (Base64) и идентификатор контента.
   
4. Подписать полученный контент. Для подписания контента требуется перевести данные параметра «content» из формата base64 и поместить в файл для подписания, после чего создать открепленную/отсоединенную однострочную (без знаков переноса) подпись.
5. Отправить подписанный контент. Для этого нужно закодировать полученную подпись в base64 и отправить ее в параметре «content» метода "3.3.5 Отправить подписанный документ ввода в оборот в «Честный ЗНАК»".
   
6. Проверить статус обработки документа ввода с помощью метода "3.3.6 Получить статус документа ввода в оборот".

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Используется запрос на основе метода 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"
}

Таблица 3.23. Описание параметров ответа на запрос

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

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

POST https://lk.edo.ru/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..."
}

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

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

Используется запрос на основе метода 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"
}

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

Метод возвращает подробную информацию о запрашиваемом списке кодов идентификации товара: в одном запросе указывается как один КИ, так и несколько КИ (не более 1000 КИ). Коды товарной группы «Табачная продукция» и «Альтернативная табачная продукция» по блокам можно указывать в запросах как со скобками, так и без скобок. В ответе код всегда будет со скобками.

Перед вызовом метода рекомендуем проверить, что вы авторизованы в системе маркировки с помощью метода "Получить состояние авторизации", указав в запросе в параметре authType значение introduction. В ответе вы получите Время инвалидации токена (параметр tokenTtl). Если время больше текущего, значит вы авторизованы в системе. Если в ответе параметр отсутствует или время меньше текущего, то требуется авторизоваться для работы с маркировкой. Как это сделать читайте в разделе "3.1. Авторизация для работы с маркировкой". При авторизации в запросах в параметре authType указывайте значение introduction.

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

POST https://lk.edo.ru/api/edo/{version}/cises/info

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

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

Таблица 3.26. Описание параметров запроса, проверки кода маркировки

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

POST https://lk.edo.ru/api/edo/v1/cises/info
Authorization: Token 416b5600-3e36-4418-9604-e0c9843d2eef

{
  "cisList": [
    "010087879823112021fIYV1Gs-pFVYn",
    "010087879823112021>Qie.6lpQt!h!"
  ],
  "productGroup": "lp"
}

Пример положительного ответа (Код 200):

{
    "status": {
        "code": 0,
        "message": "OK"
    },
    "result": [
        {
            "cisInfo": {
                "requestedCis": "010088579823682021>Qie.6lpQt!h!",
                "cis": "010088579823682021>Qie.6lpQt!h!",
                "gtin": "00885798236820",
                "productName": "MWX0340OL71, КУРТКА МУЖСКАЯ, РАЗМЕР M",
                "productGroupId": 1,
                "productGroup": "lp",
                "brand": "BARBOUR",
                "emissionDate": "2020-12-01T09:13:34.492+0000",
                "emissionType": "FOREIGN",
                "packageType": "UNIT",
                "ownerInn": "323401346147",
                "ownerName": "ИП Каменцов Денис Анатольевич",
                "status": "RETIRED",
                "statusEx": "EMPTY",
                "producerInn": "7729491871",
                "producerName": "АО \"ЛАЙТ ХАУЗ\"",
                "markWithdraw": false,
                "certDoc": [
                    {
                        "number": "ЕАЭС N RU Д-GB.АБ43.В.01347",
                        "date": "2018-08-08"
                    }
                ],
                "withdrawReason": "RETAIL"
            }
        }
    ]
}

Пример ошибки (Код 400):

{
    "status": {
        "code": 40033,
        "message": "Invalid client token"
    },
    "result": null
}

Требуется проверить авторизацию в честном знаке, методом "Получение состояния авторизации" или пройти повторную авторизацию в честном знаке. Описание авторизации в честном знаке описаны в разделах 3.1.1, 3.1.2.

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

Таблица 3.28. «Актуальные особые состояния».

Таблица 3.29. «Справочник причин вывода из оборота».

Создание документа доступно для товарных групп «Альтернативная табачная продукция», Антисептики и дезинфицирующие средства», «Биологически активные добавки к пище», «Велосипеды и велосипедные рамы», «Духи и туалетная вода», «Кресла-коляски», «Молочная продукция», «Обувные товары», «Пиво, напитки, изготавливаемые на основе пива, слабоалкогольные напитки», Предметы одежды, бельё постельное, столовое, туалетное и кухонное«, «Упакованная вода», «Фотокамеры (кроме кинокамер), фотовспышки и лампы-вспышки», «Шины и покрышки пневматические резиновые новые».

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

1. Проверьте, что вы авторизованы в системе маркировки с помощью метода "Получить состояние авторизации", указав в запросе в параметре authType значение introduction. В ответе вы получите Время инвалидации токена (параметр tokenTtl). Если время больше текущего, значит вы авторизованы в системе. Если в ответе параметр отсутствует или время меньше текущего, то требуется авторизоваться для работы с маркировкой. Как это сделать читайте в разделе "3.1. Авторизация для работы с маркировкой". При авторизации в запросах в параметре authType указывайте значение introduction.
2. Методом Создание заявки "Вывод из оборота" создайте документ вывода из оборота.
   
3. Методом "Получить данные документа вывода из оборота для подписания" получите контент документа (Base64) и идентификатор контента.
   
4. Сформируйте откреплённую подпись для контента заказа.
   
5. Отправьте контент подписи (в Base64) методом "Отправить подписанный документ вывода из оборота в «Честный ЗНАК»".
   
6. Проверить статус обработки документа вывода можно с помощью метода "Получение карточки".

Список всех заявок на вывод из оборота можно получить методом "Получение списка заявок". Методом "Получение списка кодов маркировки из заявки" можно получить список всех кодов маркировки, которые были в документе вывода.

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

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

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

Таблица 3.30. Описание параметров запроса

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

POST https://lk.edo.ru/api/edo/v1/marking-codes/withdrawal/create
Authorization: Token 416b5600-3e36-4418-9604-e0c9843d2eef
Content-Type: application/json
{
  "documentDescription": "Вывод из оборот тест 1 шт",
  "payload": {
    "action": "OTHER",
    "action_date": "2021-11-15",
    "document_date": "2021-11-14T00:00:00.000Z",
    "document_number": "2348",
    "document_type": "RECEIPT",
    "inn": "7841465198",
    "products": [
      {
        "cis": "01029000003418832155mXfVWAQUs5C"
      }
    ]
  },
  "productGroup": "lp",
  "userRequestId": "6f9619ff-8b86-d011-b42d-00cf4fc96411"
}

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

{
  "result": {
    "id": 123456,
    "userRequestId": "6f9619ff-8b86-d011-b42d-00cf4fc964f2"
  },
  "status": {
    "code": 0,
    "message": "some message here"
  }
}

Таблица 3.31. Описание параметров ответа на запрос

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

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

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

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

• {version} — обозначение версии системы, по умолчанию равен v1;
• {userRequestId} — 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"
}

Таблица 3.32. Описание параметров ответа на запрос

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

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

POST https://lk.edo.ru/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..."
}

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

Метод получения списка заявок позволяет получить все заявки с различными статусами, параметрами кодами маркировки

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

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

Таблица 3.34. Описание параметров запроса

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

POST https://lk.edo.ru/api/edo/{version}/marking-codes/withdrawal/list
Authorization: Token 416b5600-3e36-4418-9604-e0c9843d2eef
Content-Type: application/json
{
  "action": "RETAIL",
  "creationTimeFromIncl": "2021-08-31T00:00:00+00:00",
  "creationTimeToExcl": "2021-09-01T00:00:00+00:00",
  "czDocumentId": "Some string",
  "documentDescription": "Some string",
  "documentStatus": "CREATED",
  "id": 12345,
  "markingCodeCount": 123456,
  "pageIndex": 4,
  "pageRecords": 10,
  "productGroup": "LP",
  "sortType": "BY_ID_ASC"
}

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

{
  "result": {
    "data": [
      {
        "action": "RETAIL",
        "creationTime": "2021-10-04T21:00:00.000Z",
        "czDocumentId": "Some string",
        "documentDescription": "Some string",
        "id": 123456,
        "markingCodeCount": 123456,
        "productGroup": "lp",
        "status": "CREATED"
      }
    ],
    "pageInfo": {
      "pageCount": 1,
      "pageIndex": 1,
      "pageRecords": 1,
      "recordsTotalCount": 1500,
      "sortDirection": "desc",
      "sortKey": {
        "present": true
      }
    }
  },
  "status": {
    "code": 0,
    "message": "some message here"
  }
}

Таблица 3.35. Описание параметров ответа на запрос

GET https://lk.edo.ru/api/edo/{version}/marking-codes/withdrawal/order-details

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

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

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

GET https://lk.edo.ru/api/edo/v1/marking-codes/withdrawal/order-details
Authorization: Token 416b5600-3e36-4418-9604-e0c9843d2eef
Content-Type: application/json
{
 "orderId": 1234
}

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

{
  "result": {
    "action": "OTHER",
    "actionDate": "2021-10-15",
    "creationTime": "2021-11-16T18:31:25.000Z",
    "czDocObtainedTime": "2021-11-16T18:31:25.000Z",
    "destinationCountryCode": "112",
    "documentDate": "2020-01-14T00:00:00.000Z",
    "documentDescription": "Текст на 1000 символов",
    "documentNumber": "Текст до 255ти символов",
    "documentType": "OTHER",
    "errorDetail": "string",
    "id": 123456,
    "inn": "0123456789",
    "kktNumber": "Любой текст до 255 символов",
    "modificationTime": "2021-11-16T18:31:25.000Z",
    "primaryDocumentCustomName": "Текст до 255ти символов",
    "productGroup": "BICYCLE",
    "stateContractId": "АБВ123",
    "status": "Introduced",
    "userRequestId": "6f9619ff-8b86-d011-b42d-00cf4fc964f2",
    "withdrawalTypeOther": "Текст до 255ти символов"
  },
  "status": {
    "code": 0,
    "message": "some message here"
  }
}

Таблица 3.36. Описание параметров ответа на запрос

POST https://lk.edo.ru/api/edo/{version}/marking-codes/withdrawal/order-details-products-list

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

Таблица 3.37. Описание параметров запроса

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

POST https://lk.edo.ru/api/edo/v1/marking-codes/withdrawal/order-details-products-list
Authorization: Token 416b5600-3e36-4418-9604-e0c9843d2eef
Content-Type: application/json
{
  "cis": "010464444444444421FFFFFFFFFFFFF",
  "documentDateFromIncl": "2020-01-14T00:00:00.000Z",
  "documentDateToExcl": "2020-01-14T23:59:59.999Z",
  "documentNumber": "Текст до 255ти символов",
  "documentType": "OTHER",
  "id": 12345,
  "pageIndex": 4,
  "pageRecords": 10
}

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

{
  "result": {
    "data": [
      {
        "cis": "010464444444444421FFFFFFFFFFFFF",
        "primary_document_custom_name": "Текст до 255ти символов",
        "primary_document_date": "2020-01-14T00:00:00.000Z",
        "primary_document_number": "Текст до 255ти символов",
        "primary_document_type": "OTHER",
        "product_cost": "195.05"
      }
    ],
    "pageInfo": {
      "pageCount": 1,
      "pageIndex": 1,
      "pageRecords": 1,
      "recordsTotalCount": 1500,
      "sortDirection": "desc",
      "sortKey": {
        "present": true
      }
    }
  },
  "status": {
    "code": 0,
    "message": "some message here"
  }
}

Таблица 3.38. Описание параметров ответа на запрос

Создание документа доступно для товарных групп «Антисептики и дезинфицирующие средства», «Биологически активные добавки к пище», «Велосипеды и велосипедные рамы», «Духи и туалетная вода», «Медицинские изделия», «Обувные товары», «Предметы одежды, бельё постельное, столовое, туалетное и кухонное», «Товары из натурального меха», «Упакованная вода», «Фотокамеры (кроме кинокамер), фотовспышки и лампы-вспышки», «Шины и покрышки пневматические резиновые новые».

Краткое описание причин перемаркировки

• испорчено либо утеряно СИ с КМ (KM_SPOILED) — участник оборота товаров, являющийся собственником товара, планирует перемаркировать товар, который находится в обороте.
  Указание данной причины возможно с указанием или без указания предыдущего КИ / КиЗ.
  Указанный предыдущий КИ должен быть в статусе «В обороте»/«Выбыл» по причине списания КИ / КиЗ;
• выявлены ошибки описания товара (DESCRIPTION_ERRORS) — участник оборота товаров, являющийся собственником товара, планирует перемаркировать товар, который находится в обороте.
  Указание данной причины возможно только с указанием предыдущего КИ / КиЗ в статусе «В обороте»/«Выбыл» по причине списания КИ / КиЗ;
• возврат товаров с повреждённым СИ/без СИ при розничной реализации (в ЛК ГИС МТ «Возврат от розничного покупателя» (RETAIL_RETURN)) — участник оборота товара, являющийся собственником товара, планирует перемаркировать товар, возвращённый после розничной реализации (например: чек возврата без КИ / КиЗ). Указание данной причины возможно с указанием или без указания предыдущего КИ / КиЗ. Указанный предыдущий КИ / КиЗ должен быть в статусе «Выбыл» по причине розничной реализации;
• возврат товаров с повреждённым СИ/без СИ при дистанционном способе продажи (в ЛК ГИС МТ «Возврат в случае дистанционной продажи» (REMOTE_SALE_RETURN)) — участник оборота товара, являющийся собственником товара, планирует перемаркировать товар, возвращённый после дистанционного способа продажи. Указание данной причины возможно с указанием или без указания предыдущего КИ / КиЗ. Указанный предыдущий КИ / КиЗ должен быть в статусе «Выбыл» по причине дистанционного способа продажи;
• возврат от конечного покупателя (юр. лица/ИП) (LEGAL_RETURN) — участник оборота товара, являющийся собственником товара, планирует перемаркировать товар, возвращённый после реализации ЮЛ/ИП. Указание данной причины возможно как с указанием предыдущего КИ / КиЗ, так и без него. Указанный предыдущий КИ / КиЗ должен быть в статусе «Выбыл» по причине исполнения государственного контракта безвозмездной передачи, использования товара для собственных нужд покупателем;
• решение о реализации товаров, приобретённых в целях, не связанных с их реализацией (INTERNAL_RETURN) — участник оборота товара, являющийся собственником товара, планирует перемаркировать ранее приобретённый товар с целью дальнейшей реализации.
  Указание данной причины возможно как с указанием предыдущего КИ / КиЗ, так и без него.
  Указанный предыдущий КИ / КиЗ должен быть в статусе «Выбыл» по причине использования товара для собственных нужд. КИ / КиЗ был выведен из оборота путём отгрузки с выводом из оборота или через УПД с выводом из оборота;
• возврат ранее экспортированного в ЕАЭС (EEC_EXPORT_RETURN) — участник оборота товара, являющийся последним собственником товара, планирует перемаркировать ранее приобретённый товар, который возвращён после экспорта в страны ЕАЭС.
  Указание данной причины возможно как с указанием предыдущего КИ / КиЗ, так и без него. Указанный предыдущий КИ / КиЗ должен быть в статусе «Выбыл» по причине экспорта в страны ЕАЭС.

Условия перемаркировки:

• новый КИ / КиЗ может быть только в статусе «Эмитирован. Получен» (APPLIED) с типом эмиссии «Перемаркировка» (REMARK);
• перемаркировка осуществляется для предыдущего КИ / КиЗ только в статусе «В обороте» (INTRODUCED) или «Выбыл» (RETIRED);
• участник оборота товаров, осуществляющий перемаркировку, должен быть владельцем предыдущего КИ / КиЗ;
• обязательно указание предыдущего КИ / КиЗ в поле «last_uin» («Предыдущий КИ / КИК / КИН / КиЗ») для причины перемаркировки «Выявлены ошибки описания товара».
  При указании предыдущего КИ / КиЗ данные о цвете, размере и стране производства берутся из указанного предыдущего КИ / КиЗ, даже если при формировании документа были указаны данные, отличные от данных предыдущего КИ / КиЗ;
• КИ агрегата и КИ товара, входящего в состав агрегата, в параметре «new_uin» не указывается. При указании КИ, входящего в состав агрегата в статусе «Сформирован», агрегат расформировывается;
• причина выбытия КИ / КиЗ соответствует причине перемаркировки;
• тип упаковки нового КИ / КиЗ должен соответствовать типу упаковки предыдущего КИ / КиЗ.

Условия перемаркировки КИН:

• обязательно указание предыдущего КИН в поле «last_uin» для всех причин перемаркировки;
• предыдущий КИН находится в статусе «В обороте» (INTRODUCED) для причины перемаркировки «Испорчено либо утеряно СИ с КМ» (KM_SPOILED)) и в статусе «Выбыл» (RETIRED) для причин перемаркировки «Возврат товаров с повреждённым СИ/без СИ при розничной реализации» (RETAIL_RETURN), «Возврат товаров с повреждённым СИ/без СИ при дистанционном способе продажи»(REMOTE_SALE_RETURN), «Возврат ранее экспортированного в ЕАЭС» (EEC_EXPORT_RETURN), «Решение о реализации товаров, приобретённых в целях, не связанных с их реализацией» INTERNAL_RETURN), «Возврат от конечного покупателя (юр. лица/ИП)» (LEGAL_RETURN));
• статус предыдущего КИН соответствует статусу вложенных КИ и должен иметь значение «В обороте» (INTRODUCED) или «Выбыл» (RETIRED);
• GTIN предыдущего и нового КИН должны совпадать. В противном случае рекомендуется расформировать набор и сформировать новый;
• перемаркируемый КИН должен иметь вложения. При перемаркировке старый КИН выбывает из оборота, новый вводится в оборот;
• доступна перемаркировка вложений, входящих в КИН, при этом КИ и КИН должны выть в статусе «В обороте» (INTRODUCED).

Перемаркировка КИН или КИ в составе КИН недоступна при следующих условиях (документ будет обработан с ошибкой):

• указание значения DESCRIPTION_ERRORS («Выявлены ошибки описания товара»);
• КИ в статусе «Списан» (WRITTEN_OFF), находящийся в составе КИН;
• указание КИН и вложенных в него КИ в одном документе.

После обработки документа все вложения из предыдущего КИН переходят в новый КИН, при этом предыдущий КИН переходит в статус «Выбыл» (RETIRED), а новый КИН переходит в статус «В обороте» (INTRODUCED). Если статус предыдущего КИН «Выбыл» (RETIRED), то все вложения переходят в новый КИН и вводятся в оборот вместе с КИН.

При перемаркировке КИ в статусе «В обороте» (INTRODUCED) в составе КИН со статусом «В обороте» (INTRODUCED), КИН не расформировывается, предыдущий КИ списывается, исключается из КИН и в состав КИН включается новый КИ, при этом GTIN нового и предыдущего КИ должны совпадать.

При перемаркировке КИ в статусе «Выведен из оборота» (RETIRED) в составе КИН со статусом «Выведен из оборота» (RETIRED), КИН расформировывается (DISAGGREGATION), предыдущий КИ списывается (WRITTEN_OFF), а новый КИ вводится в оборот (INTRODUCED). В результате успешной обработки документа, в котором агентом / комиссионером были указаны предыдущий и новый КИ / КиЗ, полученные на один код товара, новый КИ / КиЗ получит те же самые характеристики, что и предыдущий КИ / КиЗ, а именно о том, что КИ / КиЗ был передан по АКС с указанием того собственника, который передал агенту / комиссионеру этот КИ / КиЗ.

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

1. Проверить, что вы авторизованы в системе маркировки с помощью метода "Получить состояние авторизации". Обязательно указать в запросе в параметре {authType} значение introduction. В ответе вы получите Время инвалидации токена (параметр tokenTtl). Если время больше текущего, значит вы авторизованы в системе. Если в ответе параметр отсутствует или время меньше текущего, то требуется авторизоваться для работы с маркировкой. Как это сделать читайте в разделе "3.1. Авторизация для работы с маркировкой". При авторизации в запросах в параметре authType указывайте значение introduction.
2. Методом Создание заявки "Перемаркировки" создать документ перемаркировки.
   
3. Методом "3.6.4 Получить данные документа перемаркировки для подписания" получить контент документа (Base64) и идентификатор контента.
   
4. Подписать полученный контент. Для подписания контента требуется перевести данные параметра «content» из формата base64 и поместить в файл для подписания, после чего создать открепленную/отсоединенную однострочную (без знаков переноса) подпись.
5. Отправить подписанный контент. Для этого нужно закодировать полученную подпись в base64 и отправить ее в параметре «content» метода "3.6.3 Отправить подписанный документ перемаркировки в «Честный ЗНАК»".
   
6. Проверить статус обработки документа ввода с помощью метода "3.3.4 Получить статус документа перемаркировки".

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

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

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

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

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

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

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

{
  "comment": "Some comment",
  "documentDescription": "Текст на 1000 символов",
  "productGroup": "BICYCLE",
  "userRequestId": "6f9619ff-8b86-d011-b42d-00cf4fc964f2",
  "payload": {
    "participant_inn": "5708634927",
    "remarking_date": "2020-02-22",
    "remarking_cause": "KM_SPOILED",
    "products": [
      {
        "last_uin": "010461111111111121LLLLLLLLLLLLL",
        "new_uin": "010463333333333321FFFFFFFFFFFFF",
        "tnved_10": "0000000000",
        "production_country": "string",
        "color": "string",
        "product_size": "string",
        "certificate_document_data": [
          {
            "certificate_document_type": "CONFORMITY_CERTIFICATE",
            "certificate_document_number": "326",
            "certificate_document_date": "2021-10-10"
          },
          {
            "certificate_document_type": "CONFORMITY_CERTIFICATE",
            "certificate_document_number": "123",
            "certificate_document_date": "2021-10-10"
          }
        ]
      }
    ]
  }
}

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

{
  "status": {
    "code": 0,
    "message": "OK"
  },
  "result": {
    "id": 12345,
    "userRequestId": "6f9619ff-8b86-d011-b42d-00cf4fc964f2"
  }
}

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

Используется запрос на основе метода 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"
}

Таблица 3.40. Описание параметров ответа на запрос

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

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

POST https://lk.edo.ru/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..."
}

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

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

Используется запрос на основе метода 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"
}

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

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

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

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

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

Версия 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. Порядок тестирования.

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

• 4.1.2. Получение списка документов со статусом документооборота клиента
• 4.4. Описание методов, порядка документооборота клиента по 14н

Версия 3.7
Выпущена 22 октября 2021 г.

• Измена структура документа
• Добавлены схемы порядок обмена по приказу 14Н

Версия 3.8
Выпущена 09 декабря 2021 г.

• Добавлен раздел 3.4. Проверка кодов маркировки

Версия 3.9
Выпущена 25 января 2022 г.

• Добавлен раздел 3.5. Вывод из оборота

Версия 4.0
Выпущена 12 мая 2022 г.

• Добавлен раздел 1.2.2 Авторизация с помощью логина и пароля

Версия 4.1
Выпущена 30 декабря 2022 г.

• 3.6. Перемаркировка