Skip to main content

Робота зі «Зведеною ТТН»

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

Отримання пов'язаних документів  «Зведеної ТТН»

GET /api/eds/doc/ettn/ttn/link_docs

 

REQUEST

URL

https://edo-v2.edin.ua

Метод запиту

GET

URL запиту

/api/eds/doc/ettn/ttn/link_docs

URL параметри

gln (обов’язково) String - GLN власної Компанії;

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

Headers

 

Authorization

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

Content-Type

application/json

RESPONSE

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

Прив'язка ТТН до «Зведеної ТТН»

POST /api/eds/doc/ettn/ttn/link_docs

 

 

Правила формування зв’язку між ТТН та «Зведеною ТТН»

  1. Унікальність зв’язку

    • Одна ТТН може бути пов’язана лише з однією «Зведеною ТТН».

    • Для створення нового зв’язку попередній необхідно розірвати.

  2. Умови формування зв’язку

    • «Зведена ТТН» має перебувати у статусі «Чернетка».

    • ТТН може перебувати в одному з допустимих статусів:

      • OPEN (чернетка відправника) зі значенням ready_for_sign == 1 (готовий до підписання);

      • SENT (відправлений відправником).

  3. Вимоги до узгодженості даних

    • Поле carrier_uuid («Перевізник») у всіх пов’язаних ТТН має збігатися.

    • Значення наступних додаткових полів у всіх ТТН повинні бути однаковими та відповідати даним «Зведеної ТТН»:

      • consignee_uuid – Вантажоотримувач,

      • consignor_uuid – Вантажовідправник,

      • driver_uuid – Водій,

      • load_place_uuid – Місце завантаження,

      • delivery_place_uuid – Місце доставки.

  4. Обмеження

    • До однієї «Зведеної ТТН» можна прив’язати не більше 100 ТТН документів.

REQUEST

URL

https://edo-v2.edin.ua

Метод запиту

POST

URL запиту

/api/eds/doc/ettn/ttn/link_docs

URL параметри

gln (обов’язково) String - GLN власної Компанії;

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

Headers

 

Authorization

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

Content-Type

application/json

REQUEST

 

JSON Body

В тілі запиту методу (в json форматі) передається масив UUID-ів ТТН документів, що будуть пов’язані зі «Зведеною ТТН».

Приклад запиту

["doc_uuid одиночної ТТН №1", "doc_uuid одиночної ТТН №2", "doc_uuid одиночної ТТН №3"]
RESPONSE

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

Видалення прив’язки ТТН до «Зведеної ТТН»

DELETE /api/eds/doc/ettn/ttn/link_docs
REQUEST

URL

https://edo-v2.edin.ua

Метод запиту

DELETE

URL запиту

/api/eds/doc/ettn/ttn/link_docs

URL параметри

gln (обов’язково) String - GLN власної Компанії;

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

Headers

 

Authorization

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

Content-Type

application/json

REQUEST

 

JSON Body

В тілі запиту методу (в json форматі) передається масив UUID-ів ТТН документів, що будуть видалені зі «Зведеної ТТН».

Приклад запиту

["doc_uuid одиночної ТТН №1", "doc_uuid одиночної ТТН №2", "doc_uuid одиночної ТТН №3"]
RESPONSE

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