Skip to main content

Робота з e-TTH

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

Створення/редагування чернетки e-TTH

POST /api/eds/doc/ettn/ttn

 

Вибір дії (створення чи редагування):

  • якщо в URL запиту передано ідентифікатор документа (doc_uuid), то буде виконано редагування документа сервісу «ETTN» з цим Id;

  • якщо параметр doc_uuid відсутній, то буде створено новий документ.

REQUEST

URL

 https://edo-v2.edin.ua

Метод запиту

POST

URL запиту

/api/eds/doc/ettn/ttn

URL параметри

gln (обов’язково) String - GLN власної Компанії АБО guid (обов’язково) String - унікальний ідентифікатор власної організації на платформі

doc_uuid (опціонально) UUID - ідентифікатор документа (передається для редагування (оновлення) даних раніше створеної чернетки)

template_doc_uuid (опціонально) UUID - ідентифікатор «Попередньої e-ТТН». При передаванні цього параметра створювана чернетка e-ТТН наповнюється даними з документа-підстави («Попередньої e-ТТН»), тому тіло в запиті не передається

new_doc_uuid (опціонально) UUID - ідентифікатор створюваного документа (може передаватись і бути назначеним при створенні документа зі сторони Вашого клієнта)

fill_up (опціонально) boolean - false за замовчуванням; при fill_up = true виконується перевірка тіла e-ТТН та автоматичне наповнення його даними (по Компанії, Водію, Транспорту, Пунктам Навантаження/Розвантаження) з довідників, автоматичний розрахунок Загальної ваги;

full_validate (опціонально) boolean - true за замовчуванням. Незалежно від параметра full_validate документ проходить повну перевірку (всі обов’язкові поля та XSD), якщо ця перевірка успішна - то в extrafield проставляється ready_for_sign параметр

  • Якщо full_validate = false - то у відповіді повертається помилка лише по полях які необхідні для збереження документа;

  • Якщо full_validate = true - то у відповіді повертається помилка по всім обов’язковим полям та xsd валідації.

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json or application/xml

REQUEST

  

JSON Body

В тілі запиту методу передається документ e-ТТН в json чи xml форматі

 

Тіло відсутнє при передачі template_doc_uuid параметра!
RESPONSE

В тілі відповіді (json) передається doc_uuid - унікальний ідентифікатор документа на платформі:

{doc_uuid:"e3dbf6e8-029e-4c3b-804b-9b2741d9f37d"}

Надсилання e-TTH з Чернеток 

PATCH /api/eds/doc/ettn/ttn/send

 

  • Надсилання можливе лише для підписаного документа.
  • Цим методом відправляється тільки новий документ.
  • Подальші доповнення чи зміни до документа, а також їх надсилання, здійснюються за допомогою методів: /api/ettn/eds/ecmr/transaction.
REQUEST 

URL

 https://edo-v2.edin.ua

Метод запиту

PATCH

URL запиту

/api/eds/doc/ettn/ttn/send

URL параметри

gln (обов’язково) String - GLN власної Компанії АБО guid (обов’язково) String - унікальний ідентифікатор власної організації на платформі

doc_uuid (обов’язково) UUID - ідентифікатор документа

branch_uuid (опціонально) UUID - ідентифікатор «гілки постачання» (для мережі АТБ). Використовується для об’єднання документів одного постачання (ланцюжок документів з «Повідомленням про відвантаження» (DESADV)). Якщо в запиті параметр branch_uuid не передається, то значення цього параметра автоматично формується платформою EDI Network на підставі даних з тіла документа е-ТТН:

  • AssociatedReferencedDocument.TypeCode=220

    • AssociatedReferencedDocument.ID <== Номер документа з ORDER.NUMBER

    • AssociatedReferencedDocument.FormattedIssueDateTime.DateTimeString <== Дата документа з ORDER.DATE

  • AssociatedReferencedDocument.TypeCode=351

    • AssociatedReferencedDocument.ID <== Номер документа з DESADV.NUMBER

    • AssociatedReferencedDocument.FormattedIssueDateTime.DateTimeString <== Дата документа з DESADV.DATE

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json
RESPONSE

Код сервера 200 (ok).

Створення/редагування нової транзакції (чернетки) до e-TTH документа

POST /api/eds/doc/ettn/ttn/transaction

При повторному виклику методу з тими ж URL-параметрами вкладений контент буде перезаписано (відредаговано).

REQUEST 

URL

 https://edo-v2.edin.ua

Метод запиту

POST

URL запиту

/api/eds/doc/ettn/ttn/transaction

URL параметри

gln (обов’язково) String - GLN власної Компанії АБО guid (обов’язково) String - унікальний ідентифікатор власної організації на платформі

doc_uuid (обов’язково) UUID - ідентифікатор документа

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json або application/xml

REQUEST

  

JSON Body

В тілі запиту методу (в json форматі) передається транзакція - контент документа без підписів (об’єкт Ecmr)
RESPONSE

Код сервера 200 (ok).

Після виконання методу, але до надсилання транзакції, результат отримання документа в сервісі відрізнятиметься для інших контрагентів.

Надсилання нової транзакції до e-TTH документа

PUT /api/eds/doc/ettn/ttn/transaction
REQUEST 

URL

 https://edo-v2.edin.ua

Метод запиту

PUT

URL запиту

/api/eds/doc/ettn/ttn/transaction?doc_uuid=13891ca1-76ff-40a6-927b-98db9444d3bf&gln=9864065732327

URL параметри

gln (обов’язково) String - GLN власної Компанії АБО guid (обов’язково) String - унікальний ідентифікатор власної організації на платформі

doc_uuid (обов’язково) UUID - ідентифікатор документа

role_code (опціонально) String - код ролі учасника документообігу, що відправляє транзакцію (за замовчуванням визначається автоматично). Використовується у випадку, коли кілька ролей-учасників мають однаковий GLN і роль за замовчуванням (згідно з життєвим циклом документа) для виконання обробки документа не підходить. Допустимі значення:

  • CZ - Вантажовідправник

  • DR - Водій

  • CA - Перевізник

  • CN - Вантажоодержувач

  • FW - Експедитор

  • OB - Замовник

update_doc_state (опціонально) boolean - true за замовчуванням; значення false використовується для внесення учасником змін в уже відправлену транзакцію (коригування) без зміни статусу документообігу (sub_status_id). Якщо передати update_doc_state=false, то транзакція відправиться без зміни статусу е-ТТН.

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json або application/xml
RESPONSE

Код сервера 200 (ok).

Відхилення e-TTH

PUT /api/eds/doc/ettn/ttn/reject

Відхилення документа може здійснюватися:

  • Вантажовідправником — після реєстрації своєї транзакції, але до моменту реєстрації транзакції від Водія/Перевізника;

  • Перевізником або Водієм — до реєстрації власної транзакції.

REQUEST 

URL

  

Метод запиту

PUT

URL запиту

/api/eds/doc/ettn/ttn/reject

URL параметри

gln (обов’язково) String - GLN власної Компанії АБО guid (обов’язково) String - унікальний ідентифікатор власної організації на платформі

doc_uuid (обов’язково) UUID - ідентифікатор документа

rejected_by (обов’язково) String - ПІБ співробітника

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

REQUEST

  

JSON Body

В тілі запиту методу (в json форматі) передається причина відхилення документа в текстовому вигляді.
RESPONSE

Код сервера 200 (ok).

Додавання вкладення (pdf) до e-TTH

POST /api/eds/doc/ettn/ttn/attachment

Вкладення може бути лише в pdf форматі!

REQUEST 

URL

  

Метод запиту

POST

URL запиту

/api/eds/doc/ettn/ttn/attachment

URL параметри

gln (обов’язково) String - GLN власної Компанії АБО guid (обов’язково) String - унікальний ідентифікатор власної організації на платформі

doc_uuid (обов’язково) UUID - ідентифікатор документа

type (обов’язково) String - тип вкладення (число 1-25) з довідника DICT.01.10

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

multipart/form-data

REQUEST

  

Form-data

В тілі запиту передається pdf файл (доступна можливість обробки файла в BASE64 форматі).
RESPONSE

Код сервера 200 (ok).

Отримати (завантажити) файл-вкладення до e-TTH

Надіслати вкладення на повторну реєстрацію у разі виникнення помилки

Видалити файл-вкладення з документа

Створення та надсилання  e-TTH (без створення чернетки)

 

 

 

Back to top