API сервісу ETTN v3
- Перелік методів АРІ сервісу e-TTН
- Алгоритми обміну документами (API)
- Алгоритм «Заявка на транспортування»->»Підтвердження транспортування» (TRANSPORTATIONORDER)
- Алгоритм «Акт коригування» (AdjustmentAct)
- Алгоритм «Акт розвантаження на проміжному складі» (StorageDeliveryAct)
- Алгоритм «Акт перепломбування» (ResealingAct)
- Алгоритм «Акта розбіжностей про вантаж» (DisagreementAct)
- Додаткові транзакції та зміни до е-ТТН v3 при формуванні актів
- Опис помилок сервісу e-TTН
- Видалення прив’язки ТТН до «Зведеної ТТН» DELETE /api/eds/doc/ettn/ttn/link_docs
- Прив'язка ТТН до «Зведеної ТТН» POST /api/eds/doc/ettn/ttn/link_docs
- Отримання пов'язаних документів «Зведеної ТТН» GET /api/eds/doc/ettn/ttn/link_docs
- Отримання документа з ЦБД GET /api/mintrans/doc
- Отримання списку подій з ЦБД GET /api/mintrans/events
- Видалення підписки на події (отримання документів) DELETE /api/mintrans/subscribe
- Створення підписки про події (отримання документів) POST /api/mintrans/subscribe
- Отримання даних про підписки на події / Отримання даних про підпис особи GET /api/mintrans/subscribe
- Надсилання Актів з Чернеток PATCH /api/eds/doc/ettn/act/send
- Відхилення Актів сервісу PUT /api/eds/doc/ettn/act/reject
- Надсилання нової транзакції до Актів сервісу PUT /api/eds/doc/ettn/act/transaction
- Створення/редагування нової транзакції (чернетки) до Актів сервісу POST /api/eds/doc/ettn/act/transaction
- Створення/редагування чернетки «Акт завантаження на проміжному складі до e-TTN» POST /api/eds/doc/ettn/storage_pickup
- Створення/редагування чернетки «Акт розвантаження на проміжному складі до e-TTN» POST /api/eds/doc/ettn/storage_delivery
- Створення/редагування чернетки «Акт примусового завершення e-TTN» POST /api/eds/doc/ettn/stop
- Створення/редагування чернетки «Акт перепломбування до e-TTN» POST /api/eds/doc/ettn/resealing
- Створення/редагування чернетки «Акт перевантаження до e-TTN» POST /api/eds/doc/ettn/reload
- Створення/редагування чернетки «Акт про відмову вантажити до e-TTN» POST /api/eds/doc/ettn/load_reject
- Створення/редагування чернетки «Акт розбіжностей про вантаж» POST /api/eds/doc/ettn/disagreement
- Створення/редагування чернетки «Акт про заміну пункту призначення вантажу» POST /api/eds/doc/ettn/consignee_change
- Створення/редагування чернетки «Акт коригування» POST /api/eds/doc/ettn/adjustment
- Створення та надсилання e-TTH (без створення чернетки) POST /api/eds/doc/ettn/ttn/create_and_send
- Видалити файл-вкладення з документа DELETE /api/eds/doc/ettn/ttn/attachment
- Надіслати вкладення на повторну реєстрацію у разі виникнення помилки PATCH /api/eds/doc/ettn/ttn/attachment
- Отримати (завантажити) файл-вкладення до e-TTH GET /api/eds/doc/ettn/ttn/attachment
- Додавання вкладення (pdf) до e-TTH POST /api/eds/doc/ettn/ttn/attachment
- Відхилення e-TTH PUT /api/eds/doc/ettn/ttn/reject
- Надсилання нової транзакції до e-TTH документа PUT /api/eds/doc/ettn/ttn/transaction
- Створення/редагування нової транзакції (чернетки) до e-TTH документа POST /api/eds/doc/ettn/ttn/transaction
- Надсилання e-TTH з Чернеток PATCH /api/eds/doc/ettn/ttn/send
- Створення/редагування чернетки e-TTH
- Видалення чернетки транзакції DELETE /api/eds/doc/ettn/draft_ticket
- Створення нового транспортного засобу в довіднику POST /api/oas/v2/transport
- Пошук транспортного засобу у власному довіднику транспортних засобів GET /api/oas/v2/transport
- Видалити документи-чернетки PATCH /api/eds/docs
- Отримання інформації про підписантів е-ТТН та Актів v3 (family=7) GET /api/eds/doc/ettn/sign/info
- Отримання інформації (мета-даних) про документ GET /api/eds/doc
- Отримання всіх квитанцій вказаного документа GET /api/eds/doc/tickets
- Підписання даних сервісу (збереження підпису) POST /api/eds/doc/ettn/sign
- Завантаження тіла документа у форматі JSON/XML/ECMR/PDF/ZIP GET /api/eds/doc/ettn/body
- Алгоритм «Акта про відмову вантажити» (LoadRejectAct)
- Алгоритм «Акт завантаження на проміжному складі» (StoragePickUpAct)
- Алгоритм «Акт перевантаження» (ReloadAct)
- Алгоритми «Акт про заміну пункту призначення вантажу» (ConsigneeChangeAct)
- Алгоритм «Рахунок (Логістика)» (COMDOC_040)
- Алгоритм «Акт наданих послуг (Логістика)» (COMDOC_037)
Перелік методів АРІ сервісу e-TTН
Для роботи з методами користувач повинен бути авторизованим.
Загальні методи
|
Завантаження тіла документа у форматі JSON/XML/ECMR/PDF/ZIP |
GET /api/eds/doc/ettn/body |
|
Підписання даних сервісу (збереження підпису) |
POST /api/eds/doc/ettn/sign |
|
Отримання всіх квитанцій вказаного документа |
GET /api/eds/doc/tickets |
|
Отримання інформації (мета-даних) про документ |
GET /api/eds/doc |
|
Отримання інформації про підписантів е-ТТН та Актів v3 (family=7) |
GET /api/eds/doc/ettn/sign/info |
|
Видалити документи-чернетки |
PATCH /api/eds/docs |
|
Пошук транспортного засобу у власному довіднику транспортних засобів |
GET /api/oas/v2/transport |
|
Створення нового транспортного засобу в довіднику |
POST /api/oas/v2/transport |
|
Видалення чернетки транзакції |
DELETE /api/eds/doc/ettn/draft_ticket |
Робота з e-TTН
|
Створення/редагування чернетки e-TTH |
POST /api/eds/doc/ettn/ttn |
|
Надсилання e-TTH з Чернеток |
PATCH /api/eds/doc/ettn/ttn/send |
|
Створення/редагування нової транзакції (чернетки) до e-TTH документа |
POST /api/eds/doc/ettn/ttn/transaction |
|
Надсилання нової транзакції до e-TTH документа |
PUT /api/eds/doc/ettn/ttn/transaction |
|
Відхилення e-TTH |
PUT /api/eds/doc/ettn/ttn/reject |
|
Додавання вкладення (pdf) до e-TTH |
POST /api/eds/doc/ettn/ttn/attachment |
|
Отримати (завантажити) файл-вкладення до e-TTH |
GET /api/eds/doc/ettn/ttn/attachment |
|
Надіслати вкладення на повторну реєстрацію у разі виникнення помилки |
PATCH /api/eds/doc/ettn/ttn/attachment |
|
Видалити файл-вкладення з документа |
DELETE /api/eds/doc/ettn/ttn/attachment |
|
Створення та надсилання e-TTH (без створення чернетки) |
POST /api/eds/doc/ettn/ttn/create_and_send |
Робота з актами до e-TTH
|
Створення/редагування чернетки «Акт коригування» |
POST /api/eds/doc/ettn/adjustment |
|
Створення/редагування чернетки «Акт про заміну пункту призначення вантажу» |
POST /api/eds/doc/ettn/consignee_change |
|
Створення/редагування чернетки «Акт розбіжностей про вантаж» |
POST /api/eds/doc/ettn/disagreement |
|
Створення/редагування чернетки «Акт про відмову вантажити до e-TTN» |
POST /api/eds/doc/ettn/load_reject |
|
Створення/редагування чернетки «Акт перевантаження до e-TTN» |
POST /api/eds/doc/ettn/reload |
|
Створення/редагування чернетки «Акт перепломбування до e-TTN» |
POST /api/eds/doc/ettn/resealing |
|
Створення/редагування чернетки «Акт примусового завершення e-TTN» |
POST /api/eds/doc/ettn/stop |
|
Створення/редагування чернетки «Акт розвантаження на проміжному складі до e-TTN» |
POST /api/eds/doc/ettn/storage_delivery |
|
Створення/редагування чернетки «Акт завантаження на проміжному складі до e-TTN» |
POST /api/eds/doc/ettn/storage_pickup |
|
Створення/редагування нової транзакції (чернетки) до Актів сервісу |
POST /api/eds/doc/ettn/act/transaction |
|
Надсилання нової транзакції до Актів сервісу |
PUT /api/eds/doc/ettn/act/transaction |
|
Відхилення Актів сервісу |
PUT /api/eds/doc/ettn/act/reject |
|
Надсилання Актів з Чернеток |
PATCH /api/eds/doc/ettn/act/send |
Підписки на події
|
Отримання даних про підписки на події / Отримання даних про підпис особи |
GET /api/mintrans/subscribe |
|
Створення підписки про події (отримання документів) |
POST /api/mintrans/subscribe |
|
Видалення підписки на події (отримання документів) |
DELETE /api/mintrans/subscribe |
|
Отримання списку подій з ЦБД |
GET /api/mintrans/events |
|
Отримання документа з ЦБД |
GET /api/mintrans/doc |
Робота зі «Зведеною e-ТТН»
|
Отримання пов'язаних документів «Зведеної e-ТТН» |
GET /api/eds/doc/ettn/ttn/link_docs |
|
Прив'язка ТТН до «Зведеної e-ТТН» |
POST /api/eds/doc/ettn/ttn/link_docs |
|
Видалення прив’язки e-ТТН до «Зведеної e-ТТН» |
DELETE /api/eds/doc/ettn/ttn/link_docs |
Алгоритми обміну документами (API)
- Пряма схема документообігу е-ТТН v3
-
Додаткові транзакції та зміни до е-ТТН v3 при формуванні актів
-
Алгоритм «Заявка на транспортування»->»Підтвердження транспортування» (TRANSPORTATIONORDER)
-
Алгоритм «Акта розбіжностей про вантаж» (DisagreementAct)
Алгоритм «Акта про відмову вантажити» (LoadRejectAct)
Алгоритм «Акт примусового завершення е-ТТН» (StopAct)
Алгоритм «Акт перепломбування» (ResealingAct)
Алгоритм «Акт розвантаження на проміжному складі» (StorageDeliveryAct)
Алгоритм «Акт завантаження на проміжному складі» (StoragePickUpAct)
Алгоритм «Акт перевантаження» (ReloadAct)
Алгоритми «Акт про заміну пункту призначення вантажу» (ConsigneeChangeAct)
Алгоритм «Заявка на транспортування»->»Підтвердження транспортування» (TRANSPORTATIONORDER)
Алгоритм «Акт коригування» (AdjustmentAct)
| Реєструється до початку ЖЦ Акту (завжди ініціатором акта) | Хто виступає ініціатором Акта (ролі вказані з ТТН) | Реєструється після завершення ЖЦ Акту | Хто реєструє транзакцію ТТН по завершенню ЖЦ Акта (ролі вказані з ТТН) |
| Акт коригування | |||
| Замовник OB, Вантажовідправник CZ, Перевізник CA або Водій DR, Вантажоодержувач CN | Ініціатор акта (Замовник OB, Вантажовідправник CZ, Перевізник CA або Водій DR, Вантажоодержувач CN) | ||
| Реєструється до початку ЖЦ Акту (завжди ініціатором акта) | Реєструється після завершення ЖЦ Акту |
| Акт коригування | |
| - |
|
Алгоритм «Акт розвантаження на проміжному складі» (StorageDeliveryAct)
| Реєструється до початку ЖЦ Акту (завжди ініціатором акта) | Хто виступає ініціатором Акта (ролі вказані з ТТН) | Реєструється після завершення ЖЦ Акту | Хто реєструє транзакцію ТТН по завершенню ЖЦ Акта (ролі вказані з ТТН) |
| Акт розвантаження на проміжному складі | |||
| + | Перевізник CA (поточний) або Водій DR (поточний) | + | Проміжний склад WD |
| Реєструється до початку ЖЦ Акту (завжди ініціатором акта) | Реєструється після завершення ЖЦ Акту |
| Акт розвантаження на проміжному складі | |
|
Позитивне завершення ЖЦ Акту:
Негативне завершення ЖЦ Акту (відхилено Перевізником або Проміжним складом):
|
Алгоритм «Акт перепломбування» (ResealingAct)
| Реєструється до початку ЖЦ Акту (завжди ініціатором акта) | Хто виступає ініціатором Акта (ролі вказані з ТТН) | Реєструється після завершення ЖЦ Акту | Хто реєструє транзакцію ТТН по завершенню ЖЦ Акта (ролі вказані з ТТН) |
| Акт перепломбування | |||
| Замовник OB | + | Перевізник CA або Водій DR / Замовник ОВ | |
| Реєструється до початку ЖЦ Акту (завжди ініціатором акта) | Реєструється після завершення ЖЦ Акту |
| Акт перепломбування | |
| - |
|
Алгоритм «Акта розбіжностей про вантаж» (DisagreementAct)
| Реєструється до початку ЖЦ Акту (завжди ініціатором акта) | Хто виступає ініціатором Акта (ролі вказані з ТТН) | Реєструється після завершення ЖЦ Акту | Хто реєструє транзакцію ТТН по завершенню ЖЦ Акта (ролі вказані з ТТН) |
| Акт розбіжностей про вантаж | |||
| Вантажовідправник CZ | Вантажоодержувач CN | ||
| Реєструється до початку ЖЦ Акту (завжди ініціатором акта) | Реєструється після завершення ЖЦ Акту |
| Акт розбіжностей про вантаж | |
|
- |
|
Додаткові транзакції та зміни до е-ТТН v3 при формуванні актів
| Тип документа | Реєструється до початку ЖЦ Акту (завжди ініціатором акта) | Хто виступає ініціатором Акта (ролі вказані з ТТН) | Реєструється після завершення ЖЦ Акту | Хто реєструє транзакцію ТТН по завершенню ЖЦ Акта (ролі вказані з ТТН) |
| Акт перевантаження | + | Перевізник CA (поточний) або Водій DR (поточний) | + | Перевізник CA (новий) або Водій DR (новий) |
| Акт розвантаження на проміжному складі | + | Перевізник CA (поточний) або Водій DR (поточний) | + | Проміжний склад WD |
| Акт про відмову вантажити | Вантажовідправник CZ | Не потребує реєстрації транзакцій до ТТН | ||
| Акт завантаження на проміжному складі | + | Проміжний склад WD | + | Перевізник CA (новий) або Водій DR (новий) |
| Акт перепломбування | Замовник OB | + | Перевізник CA або Водій DR / Замовник ОВ | |
| Акт про заміну пункту призначення вантажу | Вантажоодержувач CN, Вантажовідправник CZ, Замовник OB, Перевізник CA або Водій DR | + | Замовник ОВ | |
| Акт розбіжностей про вантаж | Вантажоодержувач CN | + | Вантажоодержувач CN | |
| Акт коригування | Замовник OB, Вантажовідправник CZ, Перевізник CA або Водій DR, Вантажоодержувач CN | + | Ініціатор акта (Замовник OB, Вантажовідправник CZ, Перевізник CA або Водій DR, Вантажоодержувач CN) | |
| Акт примусового завершення | Замовник OB | Не потребує реєстрації транзакцій до ТТН |
| Реєструється до початку ЖЦ Акту (завжди ініціатором акта) | Реєструється після завершення ЖЦ Акту |
| Акт перевантаження | |
|
У разі заміни Перевізника та/або Водія:
|
Позитивне завершення ЖЦ Акту:
Негативне завершення ЖЦ Акту (відхилено Перевізником або Водієм):
|
| Акт розвантаження на проміжному складі |
|
|
Позитивне завершення ЖЦ Акту:
Негативне завершення ЖЦ Акту (відхилено Перевізником або Проміжним складом):
|
| Акт завантаження на проміжному складі |
|
|
|
| Акт перепломбування |
|
|
-
|
|
|
Акт про заміну пункту призначення вантажу |
|
|
- |
|
|
Акт розбіжностей про вантаж |
|
|
- |
|
|
Акт коригування |
|
|
- |
|
|
Акт примусового завершення |
|
|
- |
- |
|
Акт про відмову вантажити |
|
|
- |
- |
Опис помилок сервісу e-TTН
На сторінці наведено опис помилок сервісу «e-TTН». Опис загальних помилок для всіх сервісів EDIN доступний за посиланням.
Опис помилок сервісу «e-ТТН»
|
Код відповіді |
Текст помилки |
Індекс |
Опис |
|
400 |
SETUP_DOC_NUMBER_ERROR |
ERR_TTN-1 |
Setup document number [%s] Заповніть номер документу [%s] |
|
400 |
SETUP_DOC_DATE_ERROR |
ERR_TTN-2 |
Setup document date [%s] Заповніть дату документу [%s] |
|
400 |
SETUP_ETTN_REF_ERROR |
ERR_TTN-3 |
Setup reference to ettn Заповніть посилання на ТТН |
|
400 |
EMPTY_GLN_FIELD_ERROR |
ERR_TTN-4 |
[%s] is not filled in gln [%s] [%s] не заповнено в gln [%s] |
|
400 |
TRADE_PARTY_ID_NOT_FILED_ERROR |
ERR_TTN-5 |
Field [id.value] in trade party for role [%s] is not filled Поле [id.value] учасника ролі [%s] не заповнено |
|
400 |
EMPTY_FIELD_ERROR |
ERR_TTN-6 |
field [%s] is not filled Поле [%s] не заповнене |
|
400 |
UNKNOWN_INITIATOR_ERROR |
ERR_TTN-7 |
Unknown initiator Невідомий ініціатор |
|
400 |
UNKNOWN_CARRIER_ERROR |
ERR_TTN-8 |
Unknown carrier Невідомий перевізник |
|
400 |
UNKNOWN_UNLOAD_STORAGE |
ERR_TTN-9 |
Unknown unload storage Невідомий склад розвантаження |
|
400 |
UNKNOWN_LOAD_STORAGE |
ERR_TTN-10 |
Unknown load storage Невідомий склад навантаження |
|
400 |
UNKNOWN_CONSIGNOR_ERROR |
ERR_TTN-11 |
Unknown consignor Невідомий вантажовідправник |
|
400 |
UNKNOWN_CONSIGNEE_ERROR |
ERR_TTN-12 |
Unknown consignee Невідомий вантажоотримувач |
|
400 |
UNKNOWN_CUSTOMER_ERROR |
ERR_TTN-13 |
Unknown customer Невідомий замовний |
|
400 |
UNKNOWN_NEW_CONSIGNEE_ERROR |
ERR_TTN-14 |
Unknown new consignee Невідомий новий вантажоотримувач |
|
400 |
UNKNOWN_NEW_CARRIER_ERROR |
ERR_TTN-15 |
Unknown new carrier Невідомий новий перевізник |
|
400 |
UNKNOWN_DRIVER_ERROR |
ERR_TTN-16 |
Unknown driver Невідомий водій |
|
400 |
UNKNOWN_NEW_DRIVER_ERROR |
ERR_TTN-17 |
Unknown new driver Невідомий новий водій |
|
400 |
UNKNOWN_INITIATOR_GLN_ERROR |
ERR_TTN-18 |
Unknown initiator gln [%s] Невідомий ініціатор gln [%s] |
|
400 |
DETERMINE_GLN_ERROR |
ERR_TTN-19 |
Failed to determine gln for trade party [%s] Не вдалося визначити gln для учасника [%s] |
|
400 |
DETERMINE_DRIVER_GLN_ERROR |
ERR_TTN-20 |
Failed to determine gln for driver [%s] Не вдалося визначити gln для водія [%s] |
|
400 |
DETERMINE_TRADE_PARTY_ERROR |
ERR_TTN-21 |
Failed to determine trading party for gln [%s] Не вдалося визначити учасника для gln [%s] |
|
400 |
GLN_TRADEPARTY_ERROR |
ERR_TTN-22 |
Unknown gln [%s] for tradeParty with role: [%s], and name [%s] Невідомий gln [%s] для учасника з роллю: [%s] і назвою [%s] |
|
400 |
IS_NOT_DRIVER_GLN_ERROR |
ERR_TTN-23 |
gln [%s] is not driver gln gln [%s] не є gln-ом водія |
|
400 |
INCORRECT_DRIVER_TIN |
ERR_TTN-24 |
Incorrect driver TIN in field [taxRegistration.id], expected [%s] Неправильний ІПН водія в полі [taxRegistration.id], очікується [%s] |
|
400 |
EDRPOU_MISMATCH |
ERR_TTN-25 |
Edrpou [%s] in gln [%s] and document [%s] are different ЄДРПОУ [%s] в gln [%s] та документі [%s] відрізняються |
|
400 |
TIN_MISMATCH |
ERR_TTN-26 |
TIN [%s] in gln [%s] and document [%s] are different ІПН [%s] в gln [%s] та документі [%s] відрізняються |
|
400 |
PARENT_ETTN_NOT_FOUND_ERROR |
ERR_TTN-27 |
Parent ettn not found Документ підстава (ТТН) не знайдено |
|
400 |
PARENT_STORAGE_DELIVERY_DOC_FOUND_ERROR |
ERR_TTN-28 |
Parent storage delivery doc not found Документ підстава (акт розвантаження на проміжному складі) не знайдено |
|
400 |
PARENT_ETTN_STATUS_ERROR |
ERR_TTN-29 |
Parent TTN has incorrect status Документ підстава (ТТН) має некоректний статус |
|
400 |
ETTN_ONSTORAGE_ERROR |
ERR_TTN-30 |
TTN status «ONSTORAGE» can be changed automatically only after the completion of the life cycle of the storage pick up act or the stop TTN act Статус ТТН «ONSTORAGE» може бути змінено автоматично лише після завершення життєвого циклу акта завантаження на складі або акту зупинки ТТН |
|
400 |
ACT_IN_PROCESS_ERROR |
ERR_TTN-31 |
Work with TTN is temporarily unavailable. Due to the unfinished process of working with the act [%s] to this TTN. Wait for the completion of work on it. Робота з ТТН тимчасово недоступна. У зв’язку з незавершеним процесом роботи з актом [%s] до цієї ТТН. Дочекайтеся завершення роботи над ним. |
|
400 |
WAITING_FOR_TTN_UPDATE_ERROR |
ERR_TTN-32 |
We have already created a new transaction for TTN. Please use API method GET, "/api/eds/doc/ettn/body" for receiving this new transaction. Ми вже створили нову транзакцію для ТТН. Будь ласка, використовуйте метод API GET, "/api/eds/doc/ettn/body" для отримання цієї нової транзакції. |
|
400 |
KEY_BLOCKED_ERROR |
ERR_TTN-33 |
Key blocked. EDRPOU/TIN mismatch. Ключ заблоковано. Невідповідність ЄДРПОУ/ІПН. |
|
400 |
CONTENT_FOR_SIGN_IS_NOT_CREATED_ERROR |
ERR_TTN-34 |
No signature content created. Resave document Вміст для підписання не створено. Збережіть документ повторно |
|
400 |
SIGN_HASH_ERROR |
ERR_TTN-35 |
sign_hash is broken, resave document невідповідний sign_hash, повторно збережіть документ |
|
400 |
ONLY_SIGNED_STAMP_ERROR |
ERR_TTN-36 |
The document cannot be signed only with the stamp. Sign the document with your signature. Документ не може бути підписаний лише печаткою. Підпишіть документ своїм підписом. |
|
400 |
INCORRECT_CONTENT_TYPE_ERROR |
ERR_TTN-37 |
Setup correct content type in request. Use „application/json“ or „application/xml“ Вкажіть content type в запиті. Використовуйте «application/json» або «application/xml». |
|
400 |
ACTION_NOT_AVAILABLE |
ERR_TTN-38 |
Action not available. Дія недоступна. |
|
400 |
DOCUMENT_NOT_FOUND_ERROR |
ERR_TTN-39 |
Document not found Документ не знайдено |
|
400 |
TICKET_NOT_FOUND_ERROR |
ERR_TTN-40 |
The required ticket was not found Необхідна квитанція не знайдена |
|
400 |
ROLE_MISMATCH_ERROR |
ERR_TTN-41 |
The company role specified in the URL parameter does not match the role of this company in the document structure Вказана в URL-параметрі роль компанії не відповідає ролі цієї компанії в структурі документа |
|
400 |
UNSUPPORTED_DOC_TYPE_ERROR |
ERR_TTN-42 |
Unknown or unsupported doc type. Невідомий або непідтримуваний тип документа. |
|
400 |
MINTRANS_STATUS_ERROR |
ERR_TTN-43 |
Mintrans status error. expected: [%s], actual: [%s] Невідповідність статусу від Мінтранс. Очікуваний [%s], фактичний [%s]. |
|
400 |
INITIATOR_ROLE_ERROR |
ERR_TTN-44 |
Invalid initiator role Некоректна роль ініціатора |
|
400 |
TTN_ACT_INP_ROCESS_ERROR |
ERR_TTN-45 |
Act for TTN is in process Присутній незавершенний акт до ТТН |
|
400 |
TEMPLATE_DOC_UUID_PARAMS_ERROR |
ERR_TTN-46 |
"template_doc_uuid" and "doc_uuid" parameters cannot be set at the same time Параметри "template_doc_uuid" і "doc_uuid" не можна встановити одночасно |
|
400 |
INCORRECT_DOC_STATUS |
ERR_TTN-47 |
Incorrect doc status Неправильний статус документа |
|
400 |
UNSUPPORTED_ROLE_CODE |
ERR_TTN-48 |
Unknown or unsupported role_code [%s] Невідомий або непідтримуваний role_code [%s] |
|
400 |
UNSUPPORTED_FORMAT_ERROR |
ERR_TTN-49 |
Unsupported format [%s] Непідтримуваний формат [%s] |
|
400 |
UNSUPPORTED_RESPONSE_TYPE_ERROR |
ERR_TTN-50 |
Unsupported response_type [%s] Непідтримуваний response_type [%s] |
|
400 |
INCORRECT_SUBSTATUS_ERROR |
ERR_TTN-51 |
Detect sub_status error. Current sub_status: [%s] Некорекнтий сабстатус. Поточний сабстатус: [%s] |
|
400 |
ACT_IS_COMPLETED_ERROR |
ERR_TTN-52 |
Act is completed Акт завершено |
|
400 |
DELIVERY_COMPLETED_ERROR |
ERR_TTN-53 |
Delivery is completed Поставку завершено |
|
400 |
ATTACHMENT_TYPE_ERROR |
ERR_TTN-54 |
Incorrect attachment type: [%s] one of: [%s] expected Неправильний тип вкладення: очікується [%s] один із: [%s]. |
|
400 |
ATTACHMENT_FILE_TYPE_ERROR |
ERR_TTN-55 |
Unsupported file type [%s] Непідтримуваний тип файлу [%s]. |
|
400 |
ATTACHMENT_FILE_COUNT_ERROR |
ERR_TTN-56 |
Expected 1 file in multipart/form data Очікується 1 файл у multipart/form data |
|
400 |
ATTACHMENT_NOT_FOUND_ERROR |
ERR_TTN-57 |
Attachment not found Вкладення не знайдено |
|
400 |
PARENT_DOC_PARTICIPANTS_MISMATCHED |
ERR_TTN-58 |
The list of participants in the basis document does not correspond to the list of participants in the current document Перелік учасників документа підстави не відповідає переліку учасників поточного документа |
|
400 |
MINTRANS_ERROR |
ERR_TTN-59 |
MINTRANS_ERROR: [%s] Помилка від Мінтранс: [%s] |
|
400 |
FAIL_TO_PARSE_CONTENT |
ERR_TTN-60 |
Fail to parse content in field [%s] Не вдалося опрацювати контент у полі [%s] |
|
400 |
INVALID_SIGN_FORMAT_ERROR |
ERR_TTN-61 |
INVALID_SIGN_FORMAT, CADES_X_LONG is expected Некоректний форма підпису, допустимий лише CADES_X_LONG |
|
400 |
GLN_ADDRESS_NOT_FOUND |
ERR_TTN-62 |
Gln for address [%s] not found Не вдалося визначити gln для адреси [%s] |
|
400 |
KATOTTG_MISMATCH |
ERR_TTN-63 |
katottg [%s] in gln [%s] and document [%s] are different катоттг [%s] в gln [%s] та документі [%s] відрізняються |
|
400 |
SIGN_CONTAINER_IS_EMPTY |
ERR_TTN-64 |
Signs not found В документі відсутні підписи |
|
400 |
XSD_VALIDATION_ERROR |
ERR_TTN-65 |
xsd validation error: [%s] Помилка при валідації за xsd: [%s] |
|
400 |
APPLICATION_XML_CONTENT_TYPE_EXPECTED |
ERR_TTN-66 |
Setup correct content type in request. Use „application/xml“ Вкажіть content type в запиті. Використовуйте «application/xml». |
|
400 |
XML_BODY_IS_NOT_CANONICAL |
ERR_TTN-67 |
xml body is not canonical or invalid xml тіло не канонізоване або некоректне |
|
400 |
DOCUMENT_VALIDATION_ERROR |
ERR_TTN-68 |
Validation document errors: [%s] Документ містить помилки: [%s] |
|
400 |
DOCUMENT_XSD_VALIDATION_ERROR |
ERR_TTN-69 |
XSD Validation document error: [%s] Помилка валідації документа за XSD: [%s] |
|
400 |
DRIVER_RESP_PERSON_NTO_FOUND |
ERR_TTN-70 |
No person with the driver’s TIN was found among the responsible persons of the carrier Серед відповідальних осіб перевізника не знайдено особу з ІПН водія |
|
400 |
EMPTY_LINK_DOC_LIST |
ERR_TTN-72 |
empty link doc list Порожній список документів |
|
400 |
LINK_DOCS_LIMIT_EXCEEDED |
ERR_TTN-73 |
The limit of the number of linked documents has been exceeded. Limit: [%s], 1 Перевищено ліміт кількості пов’язаних документів. Ліміт: [%s], 1 |
|
400 |
INCORRECT_LINKED_DOC_UUID_LIST |
ERR_TTN-74 |
Incorrect list uuid of documents Некоректний список uuid-ів документів |
|
400 |
INCORRECT_LINK_DOCS_DATA |
ERR_TTN-75 |
Errors found when checking documents: [%s], 1 Знайдені помилки при перевірці документів: [%s], 1 |
|
400 |
SIGN_ERROR |
ERR_TTN-76 |
Signs is invalid: [%s], 1 Помилка при перевірці підпису: [%s], 1 |
|
400 |
SIGN_EDRPOU_MISMATCH_COMPANY_EDRPOU |
ERR_TTN-77 |
EDRPOU from sign: [%s] is not equals gln EDRPOU: [%s], 2 ЄДРПОУ з підписа: [%s] не відповідає ЄДРПОУ з глн: [%s], 2 |
|
400 |
ERR_TTN-78 |
It is not possible to generate a new bill of lading with the same data of ORDER_NO, ORDER_DATE, DELIVERY_NOTE_NO, DELIVERY_NOTE_DATEaccording to the settings of the consignee Неможливо створити нову накладну з тими самими даними ORDER_NO, ORDER_DATE, DELIVERY_NOTE_NO, DELIVERY_NOTE_DATEвідповідно до налаштувань одержувача |
|
|
400 |
ERR_TTN-79 |
Unknown performer Невідомий виконавець |
|
|
400 |
ERR_TTN-80 |
Key blocked. Key is not on secure media Ключ заблоковано. Ключ знаходиться на незахищеному носії |
|
|
400 |
ERR_TTN-82 |
Key blocked. Signer position is required Ключ заблоковано. Наявність посади підписанта обов’язкова |
|
|
400 |
ERR_TTN-83 |
Company not found by code: [%s], companyCode За кодом [%s] компанія не знайдена, companyCode |
|
|
400 |
ERR_TTN-84 |
Document body not found or not created, try to resave document Тіло документа не знайдено або ще не створено, спробуйте повторно зберегти документ |
|
|
400 |
ERR_TTN-85 |
Setup url params: [%s], params Вкажіть url-параметри: [%s], params |
|
|
400 |
ERR_TTN-86 |
Request body is empty or invalid Тіло запиту порожнє або некоректне |
|
|
400 |
ERR_TTN-88 |
Document is not signed Документ не підписаний |
|
|
400 |
ERR_TTN-89 |
Completed doc [%s] for parent eTTN already exists Для документа підстави (ТТН) вже зареєстровано документ: [%s] |
|
|
400 |
ERR_TTN-90 |
Unsupported status [%s], one of [%s] is expected Некоректний статус [%s]. Очікується один з наступних: [%s] |
|
|
400 |
ERR_TTN-91 |
Confirm document error Помилка при підтвердження документа |
|
|
400 |
ERR_TTN-92 |
Reject document error Помилка при відхиленні документа |
|
|
400 |
ERR_TTN-93 |
Company not found for this user Не знайдено компанію для поточного юзера |
|
|
400 |
ERR_TTN-94 |
No supported documents Відсутні підтримувані документи |
|
|
400 |
ERR_TTN-95 |
Invalid format of transport id, only Latin uppercase letters and numbers are expected. Некоректний формат транспортного засобу, очікуються лише латинські великі літери та цифри. |
|
|
400 |
ERR_TTN-96 |
Some link docs has incorrect status Деякі пов’язані документи знаходяться в некоректному статусі. |
|
|
400 |
ERR_TTN-97 |
Katottg code for [%s] is required КАТОТТГ для адреси [%s] є обов’язковим |
|
|
400 |
ERR_TTN-98 |
Rejection unavailable after carrier signing Відхилення неможливе після підписання перевізником |
|
|
400 |
ERR_TTN-99 |
The signature is not available according to the recipient’s requirements Підпис недоступний відповідно до вимог одержувача |
|
|
400 |
ERR_TTN-100 |
It is not possible to create / send a new transaction to a document in Draft status Неможливо створити / відправити нову транзакцію до документа в статусі Чернетка |
|
|
400 |
ERR_TTN-101 |
Дія недоступна для поточної ролі учасника Action not available for current party role |
|
|
400 |
ERR_TTN-102 |
The action is not available for a document in draft status Дія недоступна для документа в статусі чернетка |
|
|
400 |
ERR_TTN-103 |
Field {field} has invalid value {value} Поле {поле} має недопустиме значення {значення} |
|
|
400 |
ERR_TTN-105 |
The action is not available. TTN lifecycle was terminated Дія недоступна. Життєвий цикл ТТН було завершено |
|
|
400 |
ERR_TTN-106 |
The action is not available. TTN lifecycle was terminated based on {doc name} Дія недоступна. Життєвий цикл ТТН було завершено на підставі {назва документа} |
|
|
500 |
Internal server error: sd898sdf63 |
Виникає в разі неможливості опрацювати запит (рекомендуємо звернутись до нашої технічної підтримки: support@edin.ua) |
Помилки, що можуть виникнути на стороні ЦБД
|
Код відповіді |
Код помилки |
Опис |
|
400 |
0 |
Внутрішня помилка ЦБД |
|
400 |
1 |
Некоректно сформований запит |
|
400 |
2 |
Некоректний токен |
|
400 |
4 |
Некоректний тип транспортного засобу |
|
400 |
5 |
Некоректна роль представника |
|
400 |
6 |
Об’єкт eTTN не знайдений |
|
400 |
7 |
Некоректний перехід між станами eTTN |
|
400 |
9 |
Завантаження у поточному стані не дозволене |
|
400 |
10 |
Об’єкт супровідного документу не знайдений |
|
400 |
11 |
Запропонований тип супровідного документу відрізняється від поточного |
|
400 |
12 |
Некоректний перехід між станами супровідних документів |
|
400 |
13 |
Некоректний запропонований час відміни супровідного документу |
|
400 |
14 |
Підпис подіїї більше не дійсний |
|
400 |
15 |
Відсутній ідентифікатор події |
|
400 |
16 |
Розбіжність у текстах згоди |
|
400 |
17 |
Споживач не підписаний на події |
|
400 |
18 |
Відсутній текст згоди |
|
400 |
19 |
Токен доступу більше не дійсний |
|
400 |
20 |
Некоректна роль підписанта eTTN |
|
400 |
21 |
Некоректна роль підписанта супровідного документу |
|
400 |
22 |
Некоректне посилання на документ |
|
400 |
24 |
Некоректна комбінація станів eTTN та супровідного документу |
|
400 |
25 |
Некоректна операція з оновлення представників |
|
400 |
26 |
Некоректна кількість підписів супровідного документу |
|
400 |
27 |
Некоректний тип супровідного документу |
|
400 |
28 |
Некоректний запропонований час оновлення супровідного документу |
|
400 |
29 |
Документ не відповідає схемі |
|
400 |
30 |
Підпис документу не пройшов перевірку |
|
400 |
31 |
Невалідна попередня версія документу |
|
400 |
32 |
Не вдалося завантажити документ |
|
400 |
33 |
Невалідний токен для отримання документу |
Видалення прив’язки ТТН до «Зведеної ТТН» 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).
Прив'язка ТТН до «Зведеної ТТН» POST /api/eds/doc/ettn/ttn/link_docs
Правила формування зв’язку між ТТН та «Зведеною ТТН»
-
Унікальність зв’язку
-
Одна ТТН може бути пов’язана лише з однією «Зведеною ТТН».
-
Для створення нового зв’язку попередній необхідно розірвати.
-
-
Умови формування зв’язку
-
«Зведена ТТН» має перебувати у статусі «Чернетка».
-
ТТН може перебувати в одному з допустимих статусів:
-
OPEN (чернетка відправника) зі значенням
ready_for_sign == 1(готовий до підписання); -
SENT (відправлений відправником).
-
-
-
Вимоги до узгодженості даних
-
Поле
carrier_uuid(«Перевізник») у всіх пов’язаних ТТН має збігатися. -
Значення наступних додаткових полів у всіх ТТН повинні бути однаковими та відповідати даним «Зведеної ТТН»:
-
consignee_uuid– Вантажоотримувач, -
consignor_uuid– Вантажовідправник, -
driver_uuid– Водій, -
load_place_uuid– Місце завантаження, -
delivery_place_uuid– Місце доставки.
-
-
-
Обмеження
-
До однієї «Зведеної ТТН» можна прив’язати не більше 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).
Отримання пов'язаних документів «Зведеної ТТН» 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).
Отримання документа з ЦБД GET /api/mintrans/doc
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
GET |
|
URL запиту |
/api/mintrans/doc |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії АБО guid (обов’язково) String - унікальний ідентифікатор власної організації на платформі mintrans_doc_id (обов’язково) String - ідентифікатор документа (documentId з методу отримання даних подій) |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
У тілі відповіді передаються дані документа з ЦБД (об’єкт EttnV3MintransDoc).
Отримання списку подій з ЦБД GET /api/mintrans/events
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
GET |
|
URL запиту |
/api/mintrans/events |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії АБО guid (обов’язково) String - унікальний ідентифікатор власної організації на платформі; date_from (обов’язково) long - дата (unix timestamp), починаючи з якої буде робитись вибірка; limit (опціонально) int - ліміт вибірки (за замовчуванням=50); offset (опціонально) int - зміщення відносно верхньої межі вибірки (за замовчуванням=0) |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
У тілі відповіді передаються дані подій з ЦБД масив об’єктів EttnV3Event.
Видалення підписки на події (отримання документів) DELETE /api/mintrans/subscribe
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
DELETE |
|
URL запиту |
/api/mintrans/subscribe |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії АБО guid (обов’язково) String - унікальний ідентифікатор власної організації на платформі |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу в base64 форматі передається підписаний рядок «yes» (попередньо підписуємо рядок «yes» -> отримуємо p7s файл підпису -> конвертуємо p7s в base64 формат) |
RESPONSE
Код сервера 200 (ok).
Створення підписки про події (отримання документів) POST /api/mintrans/subscribe
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
POST |
|
URL запиту |
/api/mintrans/subscribe |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії АБО guid (обов’язково) String - унікальний ідентифікатор власної організації на платформі |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу в base64 форматі передається підписаний рядок «yes» (попередньо підписуємо рядок «yes» -> отримуємо p7s файл підпису -> конвертуємо p7s в base64 формат) |
RESPONSE
У тілі відповіді передаються дані підписки (об'єкт mintransSubscription).
Отримання даних про підписки на події / Отримання даних про підпис особи GET /api/mintrans/subscribe
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
GET |
|
URL запиту |
/api/mintrans/subscribe |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії АБО guid (обов’язково) String - унікальний ідентифікатор власної організації на платформі sign_info (опціонально) Boolean - при sign_info=true в тілі відповіді передаються дані про підпис особи, що оформила підписку (не дані про підписку) |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
У тілі відповіді передаються дані підписок (масив об’єктів mintransSubscription) або дані про підпис особи, що оформила підписку (об’єкт ExEndUserSignInfo), якщо в методі передається параметр sign_info.
Надсилання Актів з Чернеток PATCH /api/eds/doc/ettn/act/send
Метод призначений для надсилання нових документів, які вже підписані. У разі внесення змін чи доповнень, їх надсилання здійснюється через методи /api/eds/doc/ettn/act/transaction.
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
PATCH |
|
URL запиту |
/api/eds/doc/ettn/act/send |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії АБО guid (обов’язково) String - унікальний ідентифікатор власної організації на платформі doc_uuid (обов’язково) UUID - ідентифікатор документа |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
Код сервера 200 (ok).
Відхилення Актів сервісу PUT /api/eds/doc/ettn/act/reject
Метод може використовуватися як ініціатором Акта (до підписання іншою стороною), так і отримувачем — до моменту підписання.
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
PUT |
|
URL запиту |
/api/eds/doc/ettn/act/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).
Надсилання нової транзакції до Актів сервісу PUT /api/eds/doc/ettn/act/transaction
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
PUT |
|
URL запиту |
/api/eds/doc/ettn/act/transaction |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії АБО guid (обов’язково) String - унікальний ідентифікатор власної організації на платформі doc_uuid (обов’язково) UUID - ідентифікатор документа |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json або application/xml |
RESPONSE
Код сервера 200 (ok).
Створення/редагування нової транзакції (чернетки) до Актів сервісу POST /api/eds/doc/ettn/act/transaction
При повторному виклику методу з тими самими URL-параметрами відбувається оновлення (перезапис) вже вкладеного контенту.
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
POST |
|
URL запиту |
/api/eds/doc/ettn/act/transaction |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії АБО guid (обов’язково) String - унікальний ідентифікатор власної організації на платформі doc_uuid (обов’язково) UUID - ідентифікатор документа |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json або application/xml |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу (в json/xml форматі) передається транзакція - контент документа без підписів (об’єкт EcmrAct) |
RESPONSE
Код сервера 200 (ok).
Після відпрацювання методу, та до надсилання транзакції, результат отримання документа сервісу матиме відмінність для інших контрагентів.
Створення/редагування чернетки «Акт завантаження на проміжному складі до e-TTN» POST /api/eds/doc/ettn/storage_pickup
Вибір дії (створення чи редагування) визначається параметрами запиту:
-
якщо в URL присутній ідентифікатор документа (
doc_uuid), відбувається редагування документа сервісу «ETTN» з указаним Id; -
якщо параметр
doc_uuidвідсутній, створюється новий документ, тип якого задається в URL.
Перед створенням чернетки перевірте коректність формування адреси компанії відповідно до даних, зазначених у GLN. Ознайомитися з правилами заповнення адрес можна за посиланням.
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
POST |
|
URL запиту |
/api/eds/doc/ettn/storage_pickup |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії АБО guid (обов’язково) String - унікальний ідентифікатор власної організації на платформі doc_uuid (опціонально) UUID - ідентифікатор документа (передається для редагування (оновлення) даних раніше створеного документа) new_doc_uuid (опціонально) UUID - ідентифікатор створюваного документа (може передаватись і бути назначеним при створенні документа зі сторони Вашого клієнта) |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json or application/xml |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передається тіло документа Акта завантаження на проміжному складі в форматі json чи xml залежно від Content-Type. Важливо: в тілі Акта має передаватись ідентифікатор (guid) е-ТТН (детальніше за посиланням вище). |
RESPONSE
В тілі відповіді (json) передається doc_uuid - унікальний ідентифікатор документа на платформі
{"doc_uuid":"6cd39021-bb80-4eb6-a6f9-03f76a2a9d54"}
Створення/редагування чернетки «Акт розвантаження на проміжному складі до e-TTN» POST /api/eds/doc/ettn/storage_delivery
Вибір дії (створення чи редагування) визначається параметрами запиту:
-
якщо в URL присутній ідентифікатор документа (
doc_uuid), відбувається редагування документа сервісу «ETTN» з указаним Id; -
якщо параметр
doc_uuidвідсутній, створюється новий документ, тип якого задається в URL.
Перед створенням чернетки перевірте коректність формування адреси компанії відповідно до даних, зазначених у GLN. Ознайомитися з правилами заповнення адрес можна за посиланням.
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
POST |
|
URL запиту |
/api/eds/doc/ettn/storage_delivery |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії АБО guid (обов’язково) String - унікальний ідентифікатор власної організації на платформі doc_uuid (опціонально) UUID - ідентифікатор документа (передається для редагування (оновлення) даних раніше створеного документа) new_doc_uuid (опціонально) UUID - ідентифікатор створюваного документа (може передаватись і бути назначеним при створенні документа зі сторони Вашого клієнта) |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json or application/xml |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передається тіло документа Акта розвантаження на проміжному складі в форматі json чи xml залежно від Content-Type. Важливо: в тілі Акта має передаватись ідентифікатор (guid) е-ТТН (детальніше за посиланням вище). |
RESPONSE
В тілі відповіді (json) передається doc_uuid - унікальний ідентифікатор документа на платформі
{"doc_uuid":"6cd39021-bb80-4eb6-a6f9-03f76a2a9d54"}
Створення/редагування чернетки «Акт примусового завершення e-TTN» POST /api/eds/doc/ettn/stop
Вибір дії (створення чи редагування) визначається параметрами запиту:
-
якщо в URL присутній ідентифікатор документа (
doc_uuid), відбувається редагування документа сервісу «ETTN» з указаним Id; -
якщо параметр
doc_uuidвідсутній, створюється новий документ, тип якого задається в URL.
Перед створенням чернетки перевірте коректність формування адреси компанії відповідно до даних, зазначених у GLN. Ознайомитися з правилами заповнення адрес можна за посиланням.
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
POST |
|
URL запиту |
/api/eds/doc/ettn/stop |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії АБО guid (обов’язково) String - унікальний ідентифікатор власної організації на платформі doc_uuid (опціонально) UUID - ідентифікатор документа (передається для редагування (оновлення) даних раніше створеного документа) new_doc_uuid (опціонально) UUID - ідентифікатор створюваного документа (може передаватись і бути назначеним при створенні документа зі сторони Вашого клієнта) |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json or application/xml |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передається тіло документа Акта примусового завершення е-ТТН у форматі json чи xml залежно від Content-Type. Важливо: в тілі Акта має передаватись ідентифікатор (guid) е-ТТН (детальніше за посиланням вище). |
RESPONSE
В тілі відповіді (json) передається doc_uuid - унікальний ідентифікатор документа на платформі
{"doc_uuid":"6cd39021-bb80-4eb6-a6f9-03f76a2a9d54"}
Створення/редагування чернетки «Акт перепломбування до e-TTN» POST /api/eds/doc/ettn/resealing
Вибір дії (створення чи редагування) визначається параметрами запиту:
-
якщо в URL присутній ідентифікатор документа (
doc_uuid), відбувається редагування документа сервісу «ETTN» з указаним Id; -
якщо параметр
doc_uuidвідсутній, створюється новий документ, тип якого задається в URL.
Перед створенням чернетки перевірте коректність формування адреси компанії відповідно до даних, зазначених у GLN. Ознайомитися з правилами заповнення адрес можна за посиланням.
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
POST |
|
URL запиту |
/api/eds/doc/ettn/resealing |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії АБО guid (обов’язково) String - унікальний ідентифікатор власної організації на платформі doc_uuid (опціонально) UUID - ідентифікатор документа (передається для редагування (оновлення) даних раніше створеного документа) new_doc_uuid (опціонально) UUID - ідентифікатор створюваного документа (може передаватись і бути назначеним при створенні документа зі сторони Вашого клієнта) |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json or application/xml |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передається тіло документа Акта перепломбування в форматі json чи xml залежно від Content-Type. Важливо: в тілі Акта має передаватись ідентифікатор (guid) е-ТТН (детальніше за посиланням вище). |
RESPONSE
В тілі відповіді (json) передається doc_uuid - унікальний ідентифікатор документа на платформі
{"doc_uuid":"6cd39021-bb80-4eb6-a6f9-03f76a2a9d54"}
Створення/редагування чернетки «Акт перевантаження до e-TTN» POST /api/eds/doc/ettn/reload
Вибір дії (створення чи редагування) визначається параметрами запиту:
-
якщо в URL присутній ідентифікатор документа (
doc_uuid), відбувається редагування документа сервісу «ETTN» з указаним Id; -
якщо параметр
doc_uuidвідсутній, створюється новий документ, тип якого задається в URL.
Перед створенням чернетки перевірте коректність формування адреси компанії відповідно до даних, зазначених у GLN. Ознайомитися з правилами заповнення адрес можна за посиланням.
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
POST |
|
URL запиту |
/api/eds/doc/ettn/reload |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії АБО guid (обов’язково) String - унікальний ідентифікатор власної організації на платформі doc_uuid (опціонально) UUID - ідентифікатор документа (передається для редагування (оновлення) даних раніше створеного документа) new_doc_uuid (опціонально) UUID - ідентифікатор створюваного документа (може передаватись і бути назначеним при створенні документа зі сторони Вашого клієнта) |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json or application/xml |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передається тіло документа Акта перевантаження в форматі json чи xml залежно від Content-Type. Важливо: в тілі Акта має передаватись ідентифікатор (guid) е-ТТН (детальніше за посиланням вище). |
RESPONSE
В тілі відповіді (json) передається doc_uuid - унікальний ідентифікатор документа на платформі
{"doc_uuid":"6cd39021-bb80-4eb6-a6f9-03f76a2a9d54"}
Створення/редагування чернетки «Акт про відмову вантажити до e-TTN» POST /api/eds/doc/ettn/load_reject
Вибір дії (створення чи редагування) визначається параметрами запиту:
-
якщо в URL присутній ідентифікатор документа (
doc_uuid), відбувається редагування документа сервісу «ETTN» з указаним Id; -
якщо параметр
doc_uuidвідсутній, створюється новий документ, тип якого задається в URL.
Перед створенням чернетки перевірте коректність формування адреси компанії відповідно до даних, зазначених у GLN. Ознайомитися з правилами заповнення адрес можна за посиланням.
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
POST |
|
URL запиту |
/api/eds/doc/ettn/load_reject |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії АБО guid (обов’язково) String - унікальний ідентифікатор власної організації на платформі doc_uuid (опціонально) UUID - ідентифікатор документа (передається для редагування (оновлення) даних раніше створеного документа) new_doc_uuid (опціонально) UUID - ідентифікатор створюваного документа (може передаватись і бути назначеним при створенні документа зі сторони Вашого клієнта) |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json or application/xml |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передається тіло документа Акта про відмову вантажити в форматі json чи xml залежно від Content-Type. Важливо: в тілі Акта має передаватись ідентифікатор (guid) е-ТТН (детальніше за посиланням вище). |
RESPONSE
В тілі відповіді (json) передається doc_uuid - унікальний ідентифікатор документа на платформі
{"doc_uuid":"6cd39021-bb80-4eb6-a6f9-03f76a2a9d54"}
Створення/редагування чернетки «Акт розбіжностей про вантаж» POST /api/eds/doc/ettn/disagreement
Вибір дії (створення чи редагування) визначається параметрами запиту:
-
якщо в URL присутній ідентифікатор документа (
doc_uuid), відбувається редагування документа сервісу «ETTN» з указаним Id; -
якщо параметр
doc_uuidвідсутній, створюється новий документ, тип якого задається в URL.
Перед створенням чернетки перевірте коректність формування адреси компанії відповідно до даних, зазначених у GLN. Ознайомитися з правилами заповнення адрес можна за посиланням.
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
POST |
|
URL запиту |
/api/eds/doc/ettn/disagreement |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії АБО guid (обов’язково) String - унікальний ідентифікатор власної організації на платформі doc_uuid (опціонально) UUID - ідентифікатор документа (передається для редагування (оновлення) даних раніше створеного документа) new_doc_uuid (опціонально) UUID - ідентифікатор створюваного документа (може передаватись і бути назначеним при створенні документа зі сторони Вашого клієнта) |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json or application/xml |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передається тіло документа Акта розбіжностей про вантаж в форматі json чи xml залежно від Content-Type. Важливо: в тілі Акта має передаватись ідентифікатор (guid) е-ТТН (детальніше за посиланням вище). |
RESPONSE
В тілі відповіді (json) передається doc_uuid - унікальний ідентифікатор документа на платформі
{"doc_uuid":"6cd39021-bb80-4eb6-a6f9-03f76a2a9d54"}
Створення/редагування чернетки «Акт про заміну пункту призначення вантажу» POST /api/eds/doc/ettn/consignee_change
Вибір дії (створення чи редагування) визначається параметрами запиту:
-
якщо в URL присутній ідентифікатор документа (
doc_uuid), відбувається редагування документа сервісу «ETTN» з указаним Id; -
якщо параметр
doc_uuidвідсутній, створюється новий документ, тип якого задається в URL.
Перед створенням чернетки перевірте коректність формування адреси компанії відповідно до даних, зазначених у GLN. Ознайомитися з правилами заповнення адрес можна за посиланням.
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
POST |
|
URL запиту |
/api/eds/doc/ettn/consignee_change |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії АБО guid (обов’язково) String - унікальний ідентифікатор власної організації на платформі doc_uuid (опціонально) UUID - ідентифікатор документа (передається для редагування (оновлення) даних раніше створеного документа) new_doc_uuid (опціонально) UUID - ідентифікатор створюваного документа (може передаватись і бути назначеним при створенні документа зі сторони Вашого клієнта) |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json or application/xml |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передається тіло документа Акта про заміну пункту призначення вантажу в форматі json чи xml залежно від Content-Type. Важливо: в тілі Акта має передаватись ідентифікатор (guid) е-ТТН (детальніше за посиланням вище). |
RESPONSE
В тілі відповіді (json) передається doc_uuid - унікальний ідентифікатор документа на платформі
{"doc_uuid":"6cd39021-bb80-4eb6-a6f9-03f76a2a9d54"}
Створення/редагування чернетки «Акт коригування» POST /api/eds/doc/ettn/adjustment
Вибір дії (створення чи редагування) визначається параметрами запиту:
-
якщо в URL присутній ідентифікатор документа (
doc_uuid), відбувається редагування документа сервісу «ETTN» з указаним Id; -
якщо параметр
doc_uuidвідсутній, створюється новий документ, тип якого задається в URL.
Перед створенням чернетки перевірте коректність формування адреси компанії відповідно до даних, зазначених у GLN. Ознайомитися з правилами заповнення адрес можна за посиланням.
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
POST |
|
URL запиту |
/api/eds/doc/ettn/adjustment |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії АБО guid (обов’язково) String - унікальний ідентифікатор власної організації на платформі doc_uuid (опціонально) UUID - ідентифікатор документа (передається для редагування (оновлення) даних раніше створеного документа) new_doc_uuid (опціонально) UUID - ідентифікатор створюваного документа (може передаватись і бути назначеним при створенні документа зі сторони Вашого клієнта) |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json or application/xml |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передається тіло документа Акта коригування в форматі json чи xml залежно від Content-Type. Важливо: в тілі Акта має передаватись ідентифікатор (guid) е-ТТН (детальніше за посиланням вище). |
RESPONSE
В тілі відповіді (json) передається doc_uuid - унікальний ідентифікатор документа на платформі
{"doc_uuid":"6cd39021-bb80-4eb6-a6f9-03f76a2a9d54"}
Створення та надсилання e-TTH (без створення чернетки) POST /api/eds/doc/ettn/ttn/create_and_send
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
POST |
|
URL запиту |
/api/eds/doc/ettn/ttn/create_and_send |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії new_doc_uuid (опціонально) UUID - ідентифікатор створюваного документа (може передаватись і бути назначеним при створенні документа зі сторони Вашого клієнта) |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/xml |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передається повне UAECMR тіло документа е-ТТН (з заповненим UaSignatureStorage та підписом/підписами) в xml форматі. |
Приклад запиту в xml форматі
<UAECMR
xmlns:qdt="urn:un:unece:uncefact:data:standard:QualifiedDataType:103"
xmlns:ram="urn:un:unece:uncefact:data:standard:ReusableAggregateBusinessInformationEntity:103"
xmlns:uas="urn:ua:signatures:SignaturesExtensions:1"
xmlns:udt="urn:un:unece:uncefact:data:standard:UnqualifiedDataType:27">
<eCMR>
<ExchangedDocumentContext>
<ram:SpecifiedTransactionID>0</ram:SpecifiedTransactionID>
<ram:BusinessProcessSpecifiedDocumentContextParameter>
<ram:ID>urn:ua:e-transport.gov.ua:ettn:01</ram:ID>
</ram:BusinessProcessSpecifiedDocumentContextParameter>
<ram:GuidelineSpecifiedDocumentContextParameter>
<ram:ID>urn:ua:e-transport.gov.ua:ettn:01:generic:001</ram:ID>
</ram:GuidelineSpecifiedDocumentContextParameter>
</ExchangedDocumentContext>
<ExchangedDocument>
<ram:ID>test_3674_re-test_010</ram:ID>
<ram:IssueDateTime>
<udt:DateTime>2023-09-17T09:30:00.000Z</udt:DateTime>
</ram:IssueDateTime>
<ram:IncludedNote>
<ram:ContentCode listAgencyID="logistic_unit_number_with_logger">logistic number</ram:ContentCode>
<ram:Content>CZ</ram:Content>
</ram:IncludedNote>
<ram:IncludedNote>
<ram:ContentCode listAgencyID="gps_number">gps</ram:ContentCode>
<ram:Content>CZ</ram:Content>
</ram:IncludedNote>
<ram:IncludedNote>
<ram:ContentCode listAgencyID="logger_number">termologer number</ram:ContentCode>
<ram:Content>CZ</ram:Content>
</ram:IncludedNote>
<ram:IncludedNote>
<ram:ContentCode listAgencyID="reserve_number">reserve_number</ram:ContentCode>
<ram:Content>CZ</ram:Content>
</ram:IncludedNote>
<ram:IncludedNote>
<ram:ContentCode listAgencyID="comment">comment by CZ</ram:ContentCode>
<ram:Content>CZ</ram:Content>
</ram:IncludedNote>
<ram:IssueLogisticsLocation>
<ram:Name>Місце складання документу</ram:Name>
<ram:Description>test1</ram:Description>
</ram:IssueLogisticsLocation>
</ExchangedDocument>
<SpecifiedSupplyChainConsignment>
<ram:GrossWeightMeasure unitCode="KGM">555</ram:GrossWeightMeasure>
<ram:AssociatedInvoiceAmount currencyID="UAH">4690</ram:AssociatedInvoiceAmount>
<ram:ConsignmentItemQuantity>234</ram:ConsignmentItemQuantity>
<ram:ConsignorTradeParty>
<ram:ID schemeAgencyID="ЄДРПОУ">42453235</ram:ID>
<ram:Name>Володя Нова ГЛН</ram:Name>
<ram:RoleCode>CZ</ram:RoleCode>
<ram:PostalTradeAddress>
<ram:PostcodeCode>456464</ram:PostcodeCode>
<ram:StreetName>вул. Атом, буд. 1</ram:StreetName>
<ram:CityName>c. Річиця</ram:CityName>
<ram:CountryID>UA</ram:CountryID>
<ram:CountrySubDivisionName>Волинська обл. Ковельський р-н</ram:CountrySubDivisionName>
</ram:PostalTradeAddress>
<ram:SpecifiedGovernmentRegistration>
<ram:ID>9864065748076</ram:ID>
<ram:TypeCode>TRADEPARTY_GLN</ram:TypeCode>
</ram:SpecifiedGovernmentRegistration>
</ram:ConsignorTradeParty>
<ram:ConsigneeTradeParty>
<ram:ID schemeAgencyID="ЄДРПОУ">98084002</ram:ID>
<ram:Name>Мій Одержувач</ram:Name>
<ram:RoleCode>CN</ram:RoleCode>
<ram:PostalTradeAddress>
<ram:PostcodeCode>734532</ram:PostcodeCode>
<ram:StreetName>б.145, вул. Зелена</ram:StreetName>
<ram:CityName>c. Річиця</ram:CityName>
<ram:CountryID>UA</ram:CountryID>
<ram:CountrySubDivisionName>Волинська обл. Ковельський р-н</ram:CountrySubDivisionName>
</ram:PostalTradeAddress>
<ram:SpecifiedGovernmentRegistration>
<ram:ID>9864065748694</ram:ID>
<ram:TypeCode>TRADEPARTY_GLN</ram:TypeCode>
</ram:SpecifiedGovernmentRegistration>
</ram:ConsigneeTradeParty>
<ram:CarrierTradeParty>
<ram:ID schemeAgencyID="ЄДРПОУ">12345678</ram:ID>
<ram:Name>Мій Перевізник</ram:Name>
<ram:RoleCode>CA</ram:RoleCode>
<ram:DefinedTradeContact>
<ram:PersonName>Мій водій</ram:PersonName>
<ram:TelephoneUniversalCommunication>
<ram:CompleteNumber>380759876087</ram:CompleteNumber>
</ram:TelephoneUniversalCommunication>
</ram:DefinedTradeContact>
<ram:PostalTradeAddress>
<ram:PostcodeCode>734532</ram:PostcodeCode>
<ram:StreetName>б. 77, вул. Вічна</ram:StreetName>
<ram:CityName>м. Вінниця</ram:CityName>
<ram:CountryID>UA</ram:CountryID>
<ram:CountrySubDivisionName>Вінницька обл. Вінницький р-н</ram:CountrySubDivisionName>
</ram:PostalTradeAddress>
<ram:SpecifiedTaxRegistration>
<ram:ID>3607902</ram:ID>
</ram:SpecifiedTaxRegistration>
<ram:SpecifiedGovernmentRegistration>
<ram:ID>DER453456</ram:ID>
</ram:SpecifiedGovernmentRegistration>
<ram:SpecifiedGovernmentRegistration>
<ram:ID>9864065748793</ram:ID>
<ram:TypeCode>DRIVER_GLN</ram:TypeCode>
</ram:SpecifiedGovernmentRegistration>
<ram:SpecifiedGovernmentRegistration>
<ram:ID>9864065748724</ram:ID>
<ram:TypeCode>TRADEPARTY_GLN</ram:TypeCode>
</ram:SpecifiedGovernmentRegistration>
</ram:CarrierTradeParty>
<ram:NotifiedTradeParty>
<ram:ID schemeAgencyID="ЄДРПОУ">43234323</ram:ID>
<ram:Name>3674_test</ram:Name>
<ram:RoleCode>OB</ram:RoleCode>
<ram:PostalTradeAddress>
<ram:PostcodeCode>468373</ram:PostcodeCode>
<ram:StreetName>вул. МОлода, б.53</ram:StreetName>
<ram:CityName>м. Житомир</ram:CityName>
<ram:CountryID>UA</ram:CountryID>
<ram:CountrySubDivisionName>Житомирська обл., Житомирський р-н</ram:CountrySubDivisionName>
</ram:PostalTradeAddress>
<ram:SpecifiedGovernmentRegistration></ram:SpecifiedGovernmentRegistration>
</ram:NotifiedTradeParty>
<ram:NotifiedTradeParty>
<ram:ID schemeAgencyID="ЄДРПОУ">23462345</ram:ID>
<ram:Name>Мій Експедитор</ram:Name>
<ram:RoleCode>FW</ram:RoleCode>
<ram:PostalTradeAddress>
<ram:PostcodeCode>888888</ram:PostcodeCode>
<ram:StreetName>Новий Ужгород</ram:StreetName>
<ram:CityName>м. Ужгород</ram:CityName>
<ram:CountryID>UA</ram:CountryID>
<ram:CountrySubDivisionName>Закарпатська обл. Ужгородський р-н</ram:CountrySubDivisionName>
</ram:PostalTradeAddress>
<ram:SpecifiedGovernmentRegistration>
<ram:ID>9864065748823</ram:ID>
<ram:TypeCode>TRADEPARTY_GLN</ram:TypeCode>
</ram:SpecifiedGovernmentRegistration>
</ram:NotifiedTradeParty>
<ram:NotifiedTradeParty>
<ram:ID schemeAgencyID="ЄДРПОУ">23232178</ram:ID>
<ram:Name>Мій WH</ram:Name>
<ram:RoleCode>WD</ram:RoleCode>
<ram:PostalTradeAddress>
<ram:PostcodeCode>7728382</ram:PostcodeCode>
<ram:StreetName>Моя Адреса</ram:StreetName>
<ram:CityName>c. Хороша</ram:CityName>
<ram:CountryID>UA</ram:CountryID>
<ram:CountrySubDivisionName>Вінницька обл. Вінницький р-н</ram:CountrySubDivisionName>
</ram:PostalTradeAddress>
<ram:SpecifiedGovernmentRegistration>
<ram:ID>9864232613176</ram:ID>
<ram:TypeCode>TRADEPARTY_GLN</ram:TypeCode>
</ram:SpecifiedGovernmentRegistration>
</ram:NotifiedTradeParty>
<ram:NotifiedTradeParty>
<ram:ID schemeAgencyID="ЄДРПОУ">56523432</ram:ID>
<ram:Name>Мій COP</ram:Name>
<ram:RoleCode>COP</ram:RoleCode>
<ram:PostalTradeAddress>
<ram:PostcodeCode>46234523222</ram:PostcodeCode>
<ram:StreetName>Моя Адреса</ram:StreetName>
<ram:CityName>c. Непереможне</ram:CityName>
<ram:CountryID>UA</ram:CountryID>
<ram:CountrySubDivisionName>Дніпропетровська обл. Криворізький р-н</ram:CountrySubDivisionName>
</ram:PostalTradeAddress>
<ram:SpecifiedGovernmentRegistration>
<ram:ID>9864232613183</ram:ID>
<ram:TypeCode>TRADEPARTY_GLN</ram:TypeCode>
</ram:SpecifiedGovernmentRegistration>
</ram:NotifiedTradeParty>
<ram:CarrierAcceptanceLogisticsLocation>
<ram:ID schemeAgencyID="КАТОТТГ">UA07060170160041154</ram:ID>
<ram:Name>Володя Нова ГЛН</ram:Name>
<ram:TypeCode>10</ram:TypeCode>
<ram:Description>Україна, 456464, Волинська обл. Ковельський р-н, c. Річиця, вул. Атом, буд. 1</ram:Description>
<ram:PhysicalGeographicalCoordinate>
<ram:SystemID schemeAgencyID="GLN">9864065748076</ram:SystemID>
</ram:PhysicalGeographicalCoordinate>
</ram:CarrierAcceptanceLogisticsLocation>
<ram:ConsigneeReceiptLogisticsLocation>
<ram:ID schemeAgencyID="КАТОТТГ">UA07060170160041154</ram:ID>
<ram:Name>Мій Одержувач</ram:Name>
<ram:TypeCode>5</ram:TypeCode>
<ram:Description>Україна, 734532, Волинська обл. Ковельський р-н, c. Річиця, б.145, вул. Зелена</ram:Description>
<ram:PhysicalGeographicalCoordinate>
<ram:SystemID schemeAgencyID="GLN">9864065748694</ram:SystemID>
</ram:PhysicalGeographicalCoordinate>
</ram:ConsigneeReceiptLogisticsLocation>
<ram:DeliveryTransportEvent></ram:DeliveryTransportEvent>
<ram:PickUpTransportEvent>
<ram:CertifyingTradeParty>
<ram:ID schemeAgencyID="РНОКПП">111111111111</ram:ID>
<ram:Name>Post</ram:Name>
<ram:RoleCode>CZ</ram:RoleCode>
<ram:DefinedTradeContact>
<ram:PersonName>Consignor</ram:PersonName>
<ram:MobileTelephoneUniversalCommunication>
<ram:CompleteNumber>380222222222</ram:CompleteNumber>
</ram:MobileTelephoneUniversalCommunication>
<ram:EmailURIUniversalCommunication>
<ram:CompleteNumber>consignor@edin.ua</ram:CompleteNumber>
</ram:EmailURIUniversalCommunication>
</ram:DefinedTradeContact>
</ram:CertifyingTradeParty>
</ram:PickUpTransportEvent>
<ram:IncludedSupplyChainConsignmentItem>
<ram:SequenceNumeric>1</ram:SequenceNumeric>
<ram:InvoiceAmount currencyID="UAH">4690</ram:InvoiceAmount>
<ram:GrossWeightMeasure unitCode="KGM">555</ram:GrossWeightMeasure>
<ram:TariffQuantity unitCode="UAH">3</ram:TariffQuantity>
<ram:GlobalID schemeAgencyID="УКТЗЕД">234523</ram:GlobalID>
<ram:NatureIdentificationTransportCargo>
<ram:Identification>Name 1</ram:Identification>
</ram:NatureIdentificationTransportCargo>
<ram:ApplicableTransportDangerousGoods>
<ram:UNDGIdentificationCode>234523</ram:UNDGIdentificationCode>
</ram:ApplicableTransportDangerousGoods>
<ram:AssociatedReferencedLogisticsTransportEquipment>
<ram:ID>Номер контейнера</ram:ID>
</ram:AssociatedReferencedLogisticsTransportEquipment>
<ram:TransportLogisticsPackage>
<ram:ItemQuantity>234</ram:ItemQuantity>
<ram:TypeCode>CT</ram:TypeCode>
<ram:Type>палета</ram:Type>
<ram:PhysicalLogisticsShippingMarks>
<ram:Marking>Назва транспортної упаковки</ram:Marking>
<ram:BarcodeLogisticsLabel>
<ram:ID>34623345</ram:ID>
</ram:BarcodeLogisticsLabel>
</ram:PhysicalLogisticsShippingMarks>
</ram:TransportLogisticsPackage>
<ram:ApplicableNote>
<ram:ContentCode>VENDOR_CODE</ram:ContentCode>
<ram:Content>6234</ram:Content>
</ram:ApplicableNote>
<ram:ApplicableNote>
<ram:ContentCode>BUYER_CODE</ram:ContentCode>
<ram:Content>452345</ram:Content>
</ram:ApplicableNote>
<ram:ApplicableNote>
<ram:ContentCode>QUANTITY</ram:ContentCode>
<ram:Content>2345</ram:Content>
</ram:ApplicableNote>
<ram:ApplicableNote>
<ram:ContentCode>BASE_UOM</ram:ContentCode>
<ram:Content>палета</ram:Content>
</ram:ApplicableNote>
<ram:ApplicableNote>
<ram:ContentCode>PRICE_WITH_VAT</ram:ContentCode>
<ram:Content>2</ram:Content>
</ram:ApplicableNote>
<ram:ApplicableNote>
<ram:ContentCode>SUM_WITHOUT_VAT</ram:ContentCode>
<ram:Content>7035</ram:Content>
</ram:ApplicableNote>
<ram:ApplicableNote>
<ram:ContentCode>NET_WEIGHT</ram:ContentCode>
<ram:Content>11</ram:Content>
</ram:ApplicableNote>
<ram:ApplicableNote>
<ram:ContentCode>RETURN_TARE</ram:ContentCode>
<ram:Content>Зворотня тара</ram:Content>
</ram:ApplicableNote>
<ram:ApplicableNote>
<ram:ContentCode>RTP_TYPE</ram:ContentCode>
<ram:Content>Тип транспортної упаковки</ram:Content>
</ram:ApplicableNote>
<ram:ApplicableNote>
<ram:ContentCode>RTP_QUANTITY</ram:ContentCode>
<ram:Content>42</ram:Content>
</ram:ApplicableNote>
</ram:IncludedSupplyChainConsignmentItem>
<ram:UtilizedLogisticsTransportEquipment>
<ram:ID>bb77767AB</ram:ID>
<ram:SettingTransportSettingTemperature>
<ram:MinimumValueMeasure unitCode="CEL">11</ram:MinimumValueMeasure>
<ram:MaximumValueMeasure unitCode="CEL">22</ram:MaximumValueMeasure>
</ram:SettingTransportSettingTemperature>
<ram:ApplicableNote>
<ram:ContentCode>BRAND</ram:ContentCode>
<ram:Content>auto_from_act_brand</ram:Content>
</ram:ApplicableNote>
<ram:ApplicableNote>
<ram:ContentCode>MODEL</ram:ContentCode>
<ram:Content>auto_from_act_model</ram:Content>
</ram:ApplicableNote>
<ram:ApplicableNote>
<ram:ContentCode>COLOR</ram:ContentCode>
<ram:Content>black_color</ram:Content>
</ram:ApplicableNote>
<ram:ApplicableNote>
<ram:ContentCode>TYPE</ram:ContentCode>
<ram:Content>auto_from_act_type</ram:Content>
</ram:ApplicableNote>
</ram:UtilizedLogisticsTransportEquipment>
<ram:DeliveryInstructions>
<ram:Description>покілометровий тариф</ram:Description>
<ram:DescriptionCode>TRANSPORTATION_TYPE</ram:DescriptionCode>
</ram:DeliveryInstructions>
</SpecifiedSupplyChainConsignment>
</eCMR>
<UaSignatureStorage>
<Signature>
<SigningPartyRoleCode>CZ</SigningPartyRoleCode>
<PartySignature>MIIhZQYJK...r8OD+8LBU5</PartySignature>
<Name>Іванов Іван Іванович</Name>
<Position>1</Position>
<SpecifiedTaxRegistration>
<ram:ID>1234567890</ram:ID>
</SpecifiedTaxRegistration>
</Signature>
</UaSignatureStorage>
</UAECMR>
RESPONSE
В тілі відповіді (json) передається doc_uuid - унікальний ідентифікатор документа на платформі:
{"doc_uuid":"6cd39021-bb80-4eb6-a6f9-03f76a2a9d54"}
Видалити файл-вкладення з документа DELETE /api/eds/doc/ettn/ttn/attachment
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
DELETE |
|
URL запиту |
/api/eds/doc/ettn/ttn/attachment |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії АБО guid (обов’язково) String - унікальний ідентифікатор власної організації на платформі doc_uuid (обов’язково) UUID - ідентифікатор документа attach_uuid (обов’язково) - UUID; ідентифікатор вкладення |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
Код сервера 200 (ok).
Надіслати вкладення на повторну реєстрацію у разі виникнення помилки PATCH /api/eds/doc/ettn/ttn/attachment
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
PATCH |
|
URL запиту |
/api/eds/doc/ettn/ttn/attachment? |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії АБО guid (обов’язково) String - унікальний ідентифікатор власної організації на платформі doc_uuid (обов’язково) UUID - ідентифікатор документа attach_uuid (обов’язково) - UUID; ідентифікатор вкладення |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
Код сервера 200 (ok).
Отримати (завантажити) файл-вкладення до e-TTH GET /api/eds/doc/ettn/ttn/attachment
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
GET |
|
URL запиту |
/api/eds/doc/ettn/ttn/attachment |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії АБО guid (обов’язково) String - унікальний ідентифікатор власної організації на платформі doc_uuid (обов’язково) UUID - ідентифікатор документа type (обов’язково) String - формат очікуваної відповіді; можливі варіанти:
attach_uuid (опціонально/обов’язково) - UUID; ідентифікатор вкладення. Параметр є обов’язковим при type = |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
У тілі відповіді передається вкладення до документа сервісу «е-ТТН»:
-
у вигляді набору байтів — якщо
type=bytes; -
у вигляді файлу — якщо
type=file; -
у форматі JSON (масив об’єкта XDocAttachment) — якщо
type=list.
Додавання вкладення (pdf) до e-TTH POST /api/eds/doc/ettn/ttn/attachment
Вкладення може бути лише в pdf форматі!
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
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 |
|
|
REQUEST |
|
|
Form-data |
В тілі запиту передається pdf файл (доступна можливість обробки файла в BASE64 форматі). |
RESPONSE
Код сервера 200 (ok).
Відхилення e-TTH PUT /api/eds/doc/ettn/ttn/reject
Відхилення документа може здійснюватися:
-
Вантажовідправником — після реєстрації своєї транзакції, але до моменту реєстрації транзакції від Водія/Перевізника;
-
Перевізником або Водієм — до реєстрації власної транзакції.
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
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).
Надсилання нової транзакції до e-TTH документа PUT /api/eds/doc/ettn/ttn/transaction
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
PUT |
|
URL запиту |
/api/eds/doc/ettn/ttn/transaction |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії АБО guid (обов’язково) String - унікальний ідентифікатор власної організації на платформі doc_uuid (обов’язково) UUID - ідентифікатор документа role_code (опціонально) String - код ролі учасника документообігу, що відправляє транзакцію (за замовчуванням визначається автоматично). Використовується у випадку, коли кілька ролей-учасників мають однаковий GLN і роль за замовчуванням (згідно з життєвим циклом документа) для виконання обробки документа не підходить. Допустимі значення:
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 документа 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 з Чернеток 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 на підставі даних з тіла документа е-ТТН:
|
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
Код сервера 200 (ok).
Створення/редагування чернетки e-TTH
Вибір дії (створення чи редагування):
-
якщо в URL запиту передано ідентифікатор документа (doc_uuid), то буде виконано редагування документа сервісу «ETTN» з цим Id;
-
якщо параметр doc_uuid відсутній, то буде створено новий документ.
Перед створенням чернетки перевірте коректність формування адреси компанії відповідно до даних, зазначених у GLN. Ознайомитися з правилами заповнення адрес можна за посиланням.
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 параметр
|
|
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"}
Видалення чернетки транзакції DELETE /api/eds/doc/ettn/draft_ticket
Метод призначений для видалення чернетки транзакції, створеної з помилками, до документа.
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
DELETE |
|
URL запиту |
/api/eds/doc/ettn/draft_ticket |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії doc_uuid (обов’язково) UUID - ідентифікатор документа, до якого створено чернетку |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
Код сервера 200 (ok).
Створення нового транспортного засобу в довіднику POST /api/oas/v2/transport
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
POST |
|
URL запиту |
/api/oas/v2/transport |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу (в json форматі) передаються дані нового транспортного засобу (об'єкт Transport). |
RESPONSE
Код сервера 200 (ok).
Пошук транспортного засобу у власному довіднику транспортних засобів GET /api/oas/v2/transport
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
GET |
|
URL запиту |
/api/oas/v2/transport |
|
URL параметри |
transport_number (обов’язково) String - номер транспортного засобу (у літеро сполученні допускається лише латинниця) від 4 символів. Так номер AA0001AA користувач може знайти за |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
У тілі відповіді з довідника передаються дані знайдених транспортних засобів (масив об'єкта Transport).
Видалити документи-чернетки PATCH /api/eds/docs
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
PATCH |
|
URL запиту |
/api/eds/docs |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; family (опціонально) UUID - сервіс/сімейство документів; можливі значення: edi detailed_response (опціонально) boolean - false за замовчуванням; при detailed_response = true, то у відповідь повернеться додатково статус видалення по кожному документу (success/failed) |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передається масив ідентифікаторів документів-чернеток до видалення, наприклад: |
RESPONSE
Код сервера 200 (ok).
Отримання інформації про підписантів е-ТТН та Актів v3 (family=7) GET /api/eds/doc/ettn/sign/info
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
GET |
|
URL запиту |
/api/eds/doc/ettn/sign/info |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії doc_uuid (обов’язково) UUID - ідентифікатор документа |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передається інформація про підписантів (об’єкт SignsPackageV2).
Отримання інформації (мета-даних) про документ GET /api/eds/doc
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
GET |
|
URL запиту |
/api/eds/doc |
|
URL параметри |
gln - рядок (13); номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта; АБО guid - рядок; унікальний ідентифікатор організації в системі doc_uuid - рядок; UUID документа |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
У тілі відповідь передаються дані вказаного документа (об'єкт XDoc).
Отримання всіх квитанцій вказаного документа GET /api/eds/doc/tickets
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
GET |
|
URL запиту |
/api/eds/doc/tickets |
|
URL параметри |
gln (обов’язково) - рядок (13); номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта; АБО guid (обов’язково) - рядок; унікальний ідентифікатор організації в системі doc_uuid (обов’язково) - рядок; UUID документа loadBody (опціонально) - отримати квитанції разом з їх тілами; можливі значення: loadBody type (опціонально) - тип отримання даних; можливі значення: zip - у вигляді архіву (при цьому обов’язково вказується назва архіву - параметр file_name) file_name - назва архіву (вказується при наявності параметра type) family (опціонально) - сімейство; можливі значення: edi |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json or application/zip |
RESPONSE
В тілі відповіді залежно від наявності параметра type передається масив об’єкта XTicket (квитанції вказаного документа) в json форматі чи у вигляді zip-архіву.
Підписання даних сервісу (збереження підпису) POST /api/eds/doc/ettn/sign
Формат підпису повинен відповідати стандарту CAdES-X Long (детальніше — у специфікації)
Підписання в сервісі «ЕТТН» можна здійснювати двома способами:
Через ECMR тіло документа
Підписати отримане ECMR тіло (результат — p7s-файл підпису)
Конвертувати p7s у base64 — цей результат передається у масиві тіла запиту
Через sign_hash (extra_fields)
Підписати значення
sign_hash(результат — p7s-файл підпису)Конвертувати p7s у base64 — цей результат передається у масиві тіла запиту
Перепідписання документа (оновлення підпису повторним викликом методу) дозволяється лише до моменту відправки документа контрагенту.
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
POST |
|
URL запиту |
/api/eds/doc/ettn/sign |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії АБО guid (обов’язково) String - унікальний ідентифікатор власної організації на платформі role_code (обов’язково) String - код ролі учасника-підписанта:
doc_uuid (обов’язково) UUID - ідентифікатор документа |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передається масив файлів підпису p7s в base64 форматі. |
Приклад тіла запиту:
["ZGZkZmRmZGZkZmRmdnh2dmM==", "ZGZkZmRmZGZkZmRmdnh2dmM=="]
RESPONSE
Код сервера 200 (ok).
Завантаження тіла документа у форматі JSON/XML/ECMR/PDF/ZIP GET /api/eds/doc/ettn/body
Метод використовується для всіх оновлених документів сервісу «e-ТТН»
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
GET |
|
URL запиту |
/api/eds/doc/ettn/body |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії АБО guid (обов’язково) String - унікальний ідентифікатор власної організації на платформі doc_uuid (обов’язково) UUID - ідентифікатор документа response_type (опціонально) String - тип формату, в якому будуть передаватись дані (для зручності подальшого опрацювання); можливі варіанти:
file_name (опціонально) - String; назва файлу для завантаження. Якщо вказано, то при response_type = format (опціонально) - String; формат файлу для отримання/завантаження (якщо не вказано - ZIP); можливі варіанти:
|
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
У тілі відповідь передається документ сервісу «e-ТТН» в визначеному запитом форматі (Специфікації документів).
Алгоритм «Акта про відмову вантажити» (LoadRejectAct)
| Реєструється до початку ЖЦ Акту (завжди ініціатором акта) | Хто виступає ініціатором Акта (ролі вказані з ТТН) | Реєструється після завершення ЖЦ Акту | Хто реєструє транзакцію ТТН по завершенню ЖЦ Акта (ролі вказані з ТТН) |
| Акт про відмову вантажити | |||
| Вантажовідправник CZ | Не потребує реєстрації транзакцій до ТТН | ||
| Реєструється до початку ЖЦ Акту (завжди ініціатором акта) | Реєструється після завершення ЖЦ Акту |
| Акт про відмову вантажити |
|
| - | - |
Алгоритм «Акт завантаження на проміжному складі» (StoragePickUpAct)
| Реєструється до початку ЖЦ Акту (завжди ініціатором акта) | Хто виступає ініціатором Акта (ролі вказані з ТТН) | Реєструється після завершення ЖЦ Акту | Хто реєструє транзакцію ТТН по завершенню ЖЦ Акта (ролі вказані з ТТН) |
| Акт завантаження на проміжному складі | |||
| + | Проміжний склад WD | + | Перевізник CA (новий) або Водій DR (новий) |
| Реєструється до початку ЖЦ Акту (завжди ініціатором акта) | Реєструється після завершення ЖЦ Акту |
| Акт завантаження на проміжному складі | |
|
|
Алгоритм «Акт перевантаження» (ReloadAct)
| Реєструється до початку ЖЦ Акту (завжди ініціатором акта) | Хто виступає ініціатором Акта (ролі вказані з ТТН) | Реєструється після завершення ЖЦ Акту | Хто реєструє транзакцію ТТН по завершенню ЖЦ Акта (ролі вказані з ТТН) |
| Акт перевантаження | |||
| + | Перевізник CA (поточний) або Водій DR (поточний) | + | Перевізник CA (новий) або Водій DR (новий) |
| Реєструється до початку ЖЦ Акту (завжди ініціатором акта) | Реєструється після завершення ЖЦ Акту |
| Акт перевантаження | |
|
У разі заміни Перевізника та/або Водія:
|
Позитивне завершення ЖЦ Акту:
Негативне завершення ЖЦ Акту (відхилено Перевізником або Водієм):
|
Алгоритми «Акт про заміну пункту призначення вантажу» (ConsigneeChangeAct)
| Реєструється до початку ЖЦ Акту (завжди ініціатором акта) | Хто виступає ініціатором Акта (ролі вказані з ТТН) | Реєструється після завершення ЖЦ Акту | Хто реєструє транзакцію ТТН по завершенню ЖЦ Акта (ролі вказані з ТТН) |
| Акт про заміну пункту призначення вантажу | |||
| Вантажоодержувач CN, Вантажовідправник CZ, Замовник OB, Перевізник CA або Водій DR | + | Замовник ОВ | |
| Реєструється до початку ЖЦ Акту (завжди ініціатором акта) | Реєструється після завершення ЖЦ Акту |
| Акт про заміну пункту призначення вантажу | |
| - |
|