🚛 API «ETTN» v3¶
Алгоритми обміну документами (API)¶
- Пряма схема документообігу е-ТТН v3
- Алгоритм «Заявка на транспортування»->»Підтвердження транспортування» (TRANSPORTATIONORDER)
- Алгоритм «Акта розбіжностей про вантаж» (DisagreementAct)
- Алгоритм «Акта про відмову вантажити» (LoadRejectAct)
- Алгоритм «Акт примусового завершення е-ТТН» (StopAct)
- Алгоритм «Акт перепломбування» (ResealingAct)
- Алгоритм «Акт розвантаження на проміжному складі» (StorageDeliveryAct)
- Алгоритм «Акт завантаження на проміжному складі» (StoragePickUpAct)
- Алгоритм «Акт перевантаження» (ReloadAct)
- Алгоритми «Акт про заміну пункту призначення вантажу» (ConsigneeChangeAct)
- Алгоритм «Акт коригування» (AdjustmentAct)
Підказка
Всі запити нижче перерахованих API методів сервісу «ЕТТН» направляються на адресу: https://edo-v2.edin.ua
Загальні методи сервісу «ЕТТН»¶
Метод |
URL запиту |
Опис |
---|---|---|
GET |
|
Отримання (завантаження) тіла документа сервісу «ЕТТН» в JSON/XML/ECMR/PDF/ZIP форматі |
POST |
|
|
GET |
|
|
GET |
|
|
GET |
|
Отримання інформації про підписантів е-ТТН та Актів v3 (family=7) |
PATCH |
|
Робота з «Електронною товарно-транспортною накладною» (е-ТТН)¶
Метод |
URL запиту |
Опис |
---|---|---|
POST |
|
Створення/редагування чернетки «Електронної товарно-транспортної накладної» (е-ТТН) |
PATCH |
|
Відправка електронної товарно-транспортної накладної («е-ТТН») з Чернеток |
POST |
|
Створення/редагування нової транзакції (чернетки) до е-ТТН документа |
PUT |
|
|
PUT |
|
Відхилення «Електронної товарно-транспортної накладної» (е-ТТН) |
POST |
|
|
GET |
|
|
PATCH |
|
Відправки вкладення на повторну реєстрацію (при виникненні помилки) |
DELETE |
|
Робота з актами («Акт перевантаження», «Акт коригування», …) до е-ТТН¶
Метод |
URL запиту |
Опис |
---|---|---|
POST |
|
|
POST |
|
Створення/редагування чернетки «Акта про заміну пункту призначення вантажу» до е-ТТН |
POST |
|
Створення/редагування чернетки «Акта розбіжностей про вантаж» до е-ТТН |
POST |
|
Створення/редагування чернетки «Акта про відмову вантажити» до е-ТТН |
POST |
|
Створення/редагування чернетки «Акта перевантаження» до е-ТТН |
POST |
|
Створення/редагування чернетки «Акта перепломбування» до е-ТТН |
POST |
|
Створення/редагування чернетки «Акта примусового завершення е-ТТН» |
POST |
|
Створення/редагування чернетки «Акта розвантаження на проміжному складі» до е-ТТН |
POST |
|
Створення/редагування чернетки «Акта завантаження на проміжному складі» до е-ТТН |
Метод |
URL запиту |
Опис |
---|---|---|
POST |
|
Створення/редагування нової транзакції (чернетки) до Актів сервісу |
PUT |
|
|
PUT |
|
|
PATCH |
|
Підписки на події¶
Метод |
URL запиту |
Опис |
---|---|---|
GET |
|
Отримання даних про підписки на події (отримання документів) |
POST |
|
Створення (оформлення) підписки на події (отримання документів) |
DELETE |
|
|
GET |
|
|
GET |
|
Опис помилок сервісу «ЕТТН» v3¶
Код відповіді |
Текст помилки |
Індекс |
Опис |
400 |
SETUP_DOC_NUMBER_ERROR |
TTN_ERR-1 |
Setup document number [%s] Заповніть номер документу [%s] |
400 |
SETUP_DOC_DATE_ERROR |
TTN_ERR-2 |
Setup document date [%s] Заповніть дату документу [%s] |
400 |
SETUP_ETTN_REF_ERROR |
TTN_ERR-3 |
Setup reference to ettn Заповніть посилання на ТТН |
400 |
EMPTY_GLN_FIELD_ERROR |
TTN_ERR-4 |
[%s] is not filled in gln [%s] [%s] не заповнено в gln [%s] |
400 |
TRADE_PARTY_ID_NOT_FILED_ERROR |
TTN_ERR-5 |
Field [id.value] in trade party for role [%s] is not filled Поле [id.value] учасника ролі [%s] не заповнено |
400 |
EMPTY_FIELD_ERROR |
TTN_ERR-6 |
field [%s] is not filled Поле [%s] не заповнене |
400 |
UNKNOWN_INITIATOR_ERROR |
TTN_ERR-7 |
Unknown initiator Невідомий ініціатор |
400 |
UNKNOWN_CARRIER_ERROR |
TTN_ERR-8 |
Unknown carrier Невідомий перевізник |
400 |
UNKNOWN_UNLOAD_STORAGE |
TTN_ERR-9 |
Unknown unload storage Невідомий склад розвантаження |
400 |
UNKNOWN_LOAD_STORAGE |
TTN_ERR-10 |
Unknown load storage Невідомий склад навантаження |
400 |
UNKNOWN_CONSIGNOR_ERROR |
TTN_ERR-11 |
Unknown consignor Невідомий вантажовідправник |
400 |
UNKNOWN_CONSIGNEE_ERROR |
TTN_ERR-12 |
Unknown consignee Невідомий вантажоотримувач |
400 |
UNKNOWN_CUSTOMER_ERROR |
TTN_ERR-13 |
Unknown customer Невідомий замовний |
400 |
UNKNOWN_NEW_CONSIGNEE_ERROR |
TTN_ERR-14 |
Unknown new consignee Невідомий новий вантажоотримувач |
400 |
UNKNOWN_NEW_CARRIER_ERROR |
TTN_ERR-15 |
Unknown new carrier Невідомий новий перевізник |
400 |
UNKNOWN_DRIVER_ERROR |
TTN_ERR-16 |
Unknown driver Невідомий водій |
400 |
UNKNOWN_NEW_DRIVER_ERROR |
TTN_ERR-17 |
Unknown new driver Невідомий новий водій |
400 |
UNKNOWN_INITIATOR_GLN_ERROR |
TTN_ERR-18 |
Unknown initiator gln [%s] Невідомий ініціатор gln [%s] |
400 |
DETERMINE_GLN_ERROR |
TTN_ERR-19 |
Failed to determine gln for trade party [%s] Не вдалося визначити gln для учасника [%s] |
400 |
DETERMINE_DRIVER_GLN_ERROR |
TTN_ERR-20 |
Failed to determine gln for driver [%s] Не вдалося визначити gln для водія [%s] |
400 |
DETERMINE_TRADE_PARTY_ERROR |
TTN_ERR-21 |
Failed to determine trading party for gln [%s] Не вдалося визначити учасника для gln [%s] |
400 |
GLN_TRADEPARTY_ERROR |
TTN_ERR-22 |
Unknown gln [%s] for tradeParty with role: [%s], and name [%s] Невідомий gln [%s] для учасника з роллю: [%s] і назвою [%s] |
400 |
IS_NOT_DRIVER_GLN_ERROR |
TTN_ERR-23 |
gln [%s] is not driver gln gln [%s] не є gln-ом водія |
400 |
INCORRECT_DRIVER_TIN |
TTN_ERR-24 |
Incorrect driver TIN in field [taxRegistration.id], expected [%s] Неправильний ІПН водія в полі [taxRegistration.id], очікується [%s] |
400 |
EDRPOU_MISMATCH |
TTN_ERR-25 |
Edrpou [%s] in gln [%s] and document [%s] are different ЄДРПОУ [%s] в gln [%s] та документі [%s] відрізняються |
400 |
TIN_MISMATCH |
TTN_ERR-26 |
TIN [%s] in gln [%s] and document [%s] are different ІПН [%s] в gln [%s] та документі [%s] відрізняються |
400 |
PARENT_ETTN_NOT_FOUND_ERROR |
TTN_ERR-27 |
Parent ettn not found Документ підстава (ТТН) не знайдено |
400 |
PARENT_STORAGE_DELIVERY_DOC_FOUND_ERROR |
TTN_ERR-28 |
Parent storage delivery doc not found Документ підстава (акт розвантаження на проміжному складі) не знайдено |
400 |
PARENT_ETTN_STATUS_ERROR |
TTN_ERR-29 |
Parent TTN has incorrect status Документ підстава (ТТН) має некоректний статус |
400 |
ETTN_ONSTORAGE_ERROR |
TTN_ERR-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 |
TTN_ERR-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 |
TTN_ERR-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 |
TTN_ERR-33 |
Key blocked. EDRPOU/TIN mismatch. Ключ заблоковано. Невідповідність ЄДРПОУ/ІПН. |
400 |
CONTENT_FOR_SIGN_IS_NOT_CREATED_ERROR |
TTN_ERR-34 |
No signature content created. Resave document Вміст для підписання не створено. Збережіть документ повторно |
400 |
SIGN_HASH_ERROR |
TTN_ERR-35 |
sign_hash is broken, resave document невідповідний sign_hash, повторно збережіть документ |
400 |
ONLY_SIGNED_STAMP_ERROR |
TTN_ERR-36 |
The document cannot be signed only with the stamp. Sign the document with your signature. Документ не може бути підписаний лише печаткою. Підпишіть документ своїм підписом. |
400 |
INCORRECT_CONTENT_TYPE_ERROR |
TTN_ERR-37 |
Setup correct content type in request. Use „application/json“ or „application/xml“ Вкажіть content type в запиті. Використовуйте «application/json» або «application/xml». |
400 |
ACTION_NOT_AVAILABLE |
TTN_ERR-38 |
Action not available. Дія недоступна. |
400 |
DOCUMENT_NOT_FOUND_ERROR |
TTN_ERR-39 |
Document not found Документ не знайдено |
400 |
TICKET_NOT_FOUND_ERROR |
TTN_ERR-40 |
The required ticket was not found Необхідна квитанція не знайдена |
400 |
ROLE_MISMATCH_ERROR |
TTN_ERR-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 |
TTN_ERR-42 |
Unknown or unsupported doc type. Невідомий або непідтримуваний тип документа. |
400 |
MINTRANS_STATUS_ERROR |
TTN_ERR-43 |
Mintrans status error. expected: [%s], actual: [%s] Невідповідність статусу від Мінтранс. Очікуваний [%s], фактичний [%s]. |
400 |
INITIATOR_ROLE_ERROR |
TTN_ERR-44 |
Invalid initiator role Некоректна роль ініціатора |
400 |
TTN_ACT_INP_ROCESS_ERROR |
TTN_ERR-45 |
Act for TTN is in process Присутній незавершенний акт до ТТН |
400 |
TEMPLATE_DOC_UUID_PARAMS_ERROR |
TTN_ERR-46 |
"template_doc_uuid" and "doc_uuid" parameters cannot be set at the same time Параметри "template_doc_uuid" і "doc_uuid" не можна встановити одночасно |
400 |
INCORRECT_DOC_STATUS |
TTN_ERR-47 |
Incorrect doc status Неправильний статус документа |
400 |
UNSUPPORTED_ROLE_CODE |
TTN_ERR-48 |
Unknown or unsupported role_code [%s] Невідомий або непідтримуваний role_code [%s] |
400 |
UNSUPPORTED_FORMAT_ERROR |
TTN_ERR-49 |
Unsupported format [%s] Непідтримуваний формат [%s] |
400 |
UNSUPPORTED_RESPONSE_TYPE_ERROR |
TTN_ERR-50 |
Unsupported response_type [%s] Непідтримуваний response_type [%s] |
400 |
INCORRECT_SUBSTATUS_ERROR |
TTN_ERR-51 |
Detect sub_status error. Current sub_status: [%s] Некорекнтий сабстатус. Поточний сабстатус: [%s] |
400 |
ACT_IS_COMPLETED_ERROR |
TTN_ERR-52 |
Act is completed Акт завершено |
400 |
DELIVERY_COMPLETED_ERROR |
TTN_ERR-53 |
Delivery is completed Поставку завершено |
400 |
ATTACHMENT_TYPE_ERROR |
TTN_ERR-54 |
Incorrect attachment type: [%s] one of: [%s] expected Неправильний тип вкладення: очікується [%s] один із: [%s]. |
400 |
ATTACHMENT_FILE_TYPE_ERROR |
TTN_ERR-55 |
Unsupported file type [%s] Непідтримуваний тип файлу [%s]. |
400 |
ATTACHMENT_FILE_COUNT_ERROR |
TTN_ERR-56 |
Expected 1 file in multipart/form data Очікується 1 файл у multipart/form data |
400 |
ATTACHMENT_NOT_FOUND_ERROR |
TTN_ERR-57 |
Attachment not found Вкладення не знайдено |
400 |
PARENT_DOC_PARTICIPANTS_MISMATCHED |
TTN_ERR-58 |
The list of participants in the basis document does not correspond to the list of participants in the current document Перелік учасників документа підстави не відповідає переліку учасників поточного документа |
400 |
MINTRANS_ERROR |
TTN_ERR-59 |
MINTRANS_ERROR: [%s] Помилка від Мінтранс: [%s] |
400 |
FAIL_TO_PARSE_CONTENT |
TTN_ERR-60 |
Fail to parse content in field [%s] Не вдалося опрацювати контент у полі [%s] |
400 |
INVALID_SIGN_FORMAT_ERROR |
TTN_ERR-61 |
INVALID_SIGN_FORMAT, CADES_X_LONG is expected Некоректний форма підпису, допустимий лише CADES_X_LONG |
400 |
GLN_ADDRESS_NOT_FOUND |
TTN_ERR-62 |
Gln for address [%s] not found Не вдалося визначити gln для адреси [%s] |
400 |
KATOTTG_MISMATCH |
TTN_ERR-63 |
katottg [%s] in gln [%s] and document [%s] are different катоттг [%s] в gln [%s] та документі [%s] відрізняються |
400 |
SIGN_CONTAINER_IS_EMPTY |
TTN_ERR-64 |
Signs not found В документі відсутні підписи |
400 |
XSD_VALIDATION_ERROR |
TTN_ERR-65 |
xsd validation error: [%s] Помилка при валідації за xsd: [%s] |
400 |
APPLICATION_XML_CONTENT_TYPE_EXPECTED |
TTN_ERR-66 |
Setup correct content type in request. Use „application/xml“ Вкажіть content type в запиті. Використовуйте «application/xml». |
400 |
XML_BODY_IS_NOT_CANONICAL |
TTN_ERR-67 |
xml body is not canonical or invalid xml тіло не канонізоване або некоректне |
400 |
DOCUMENT_VALIDATION_ERROR |
TTN_ERR-68 |
Validation document errors: [%s] Документ містить помилки: [%s] |
400 |
DOCUMENT_XSD_VALIDATION_ERROR |
TTN_ERR-69 |
XSD Validation document error: [%s] Помилка валідації документа за XSD: [%s] |
400 |
DRIVER_RESP_PERSON_NTO_FOUND |
TTN_ERR-70 |
No person with the driver’s TIN was found among the responsible persons of the carrier Серед відповідальних осіб перевізника не знайдено особу з ІПН водія |
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 |
Невалідний токен для отримання документу |