🚛 API «ETTN» v3

Стандартна схема документообігу

Авторизація

Метод

URL запиту

Опис

POST

/api/authorization/hash

Авторизація

GET

/api/auth_check

Перевірка активності сесії

Робота з «Електронною товарно-транспортною накладною» (е-ТТН)

Метод

URL запиту

Опис

POST

/api/eds/doc/ettn/ttn

Створення/редагування чернетки «Електронної товарно-транспортної накладної» (е-ТТН)

PATCH

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

Відправка електронної товарно-транспортної накладної («е-ТТН») з Чернеток

POST

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

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

PUT

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

Відправка нової транзакції до е-ТТН документа

PUT

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

Відхилення «Електронної товарно-транспортної накладної» (е-ТТН)

POST

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

Додавання до документа вкладення (pdf) до документа е-ТТН

GET

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

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

PATCH

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

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

DELETE

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

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

POST

/api/eds/doc/ettn/ttn/create_and_send

Створення та відправка «е-ТТН» документа (без створення чернетки)

Робота з актами («Акт перевантаження», «Акт коригування», …) до е-ТТН

Метод

URL запиту

Опис

POST

/api/eds/doc/ettn/adjustment

Створення/редагування чернетки «Акта коригування» до е-ТТН

POST

/api/eds/doc/ettn/consignee_change

Створення/редагування чернетки «Акта про заміну пункту призначення вантажу» до е-ТТН

POST

/api/eds/doc/ettn/disagreement

Створення/редагування чернетки «Акта розбіжностей про вантаж» до е-ТТН

POST

/api/eds/doc/ettn/load_reject

Створення/редагування чернетки «Акта про відмову вантажити» до е-ТТН

POST

/api/eds/doc/ettn/reload

Створення/редагування чернетки «Акта перевантаження» до е-ТТН

POST

/api/eds/doc/ettn/resealing

Створення/редагування чернетки «Акта перепломбування» до е-ТТН

POST

/api/eds/doc/ettn/stop

Створення/редагування чернетки «Акта примусового завершення е-ТТН»

POST

/api/eds/doc/ettn/storage_delivery

Створення/редагування чернетки «Акта розвантаження на проміжному складі» до е-ТТН

POST

/api/eds/doc/ettn/storage_pickup

Створення/редагування чернетки «Акта завантаження на проміжному складі» до е-ТТН

Метод

URL запиту

Опис

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

Відправка Актів з Чернеток

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

Метод

URL запиту

Опис

GET

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

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

POST

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

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

DELETE

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

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


Опис помилок сервісу «ЕТТН» v3

Код відповіді

Текст помилки

Індекс

Опис

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

INCORRECT_LINK_DOC_STATUSES

ERR_TTN-78

Some link docs has incorrect status

Деякі пов’язані документи знаходяться в некоректному статусі

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

Невалідний токен для отримання документу


Загальні помилки при роботі з API (всі сервіси EDIN)

Код відповіді

Індекс помилки

Текст помилки

Опис

400

ERR_CMN-1

Parameter(s) [%s] is(are) required

Параметр(и) [%s] є обов’язковим(и)

Помилка виникає, якщо не передати обовязковий url-параметр (наприклад, doc_uuid)

400

ERR_CMN-2

Unknown or unsupported %s [%s]

Непідтримуваний %s [%s]

Помилка виникає, якщо вказаний параметр не підтримується (наприклад, передавати response_type=xml, але доступні тільки - file, base64, bytes)

400

ERR_CMN-3

Parameter [%s] must have format format: [%s]

Параметер [%s] повинен мати формат: [%s]

Помилка виникає, коли клієнт в url параметрі передав значення, в форматі, що не підтимується

400

ERR_CMN-4

Incorrect Content-Type in request, one of [%s] is expected

Некоректний Content-Type. Очікується один з наступних:

400

ERR_CMN-5

Unsupported method [%s]

Непідтримуваний метод [%s]

400

ERR_CMN-6

Expected [%s] file(s) in multipart/form data

Очікується [%s] файл(и)ів у multipart/form data

400

ERR_CMN-7

Request body is empty

Тіло запиту порожнє

400

ERR_CMN-7

Unknown gln: [%s]

Невідомий gln: [%s]

400

ERR_CMN-8

Supported not more [%s] files per request

Підтримується не більше [%s] файлів на запит

400

ERR_CMN-9

Exceeded max file name length

Перевищено максимальну довжину імені файлу

400

ERR_CMN-10

Exceeded max file size - [%s]

Перевищено максимальний розмір файлу - [%s]

400

ERR_CMN-11

Action not available, reason - [%s]

Дія не доступна, причина - [%s]

Помилка виникає в різних випадках, наприклад, коли відправник документа CONDRA хоче її прийняти, але це може зробити тільки отримувач документа

400

ERR_CMN-12

Document with identifier [%s] not found

Документ з ідентифікатором [%s] не знайдено

400

ERR_CMN-12

Chain with identifier [%s] not found

Ланцюг з ідентифікатором [%s] не знайдено

400

ERR_CMN-13

Attachment with identifier [%s] not found

Вкладення з ідентифікатором [%s] не знайдено

400

ERR_CMN-14

Ticket not found

Квитанцію не знайдено

400

ERR_CMN-15

Package with identifier [%s] not found

Пакет з ідентифікатором [%s] не знайдено

400

ERR_CMN-16

Incorrect format of field’s value

Некоректний формат значення поля

400

ERR_CMN-17

error

Помилка в роботі процедури (БД)

400

ERR_CMN-18

Document body already exist

Тіло документа вже існує

Дублювання тіла документа

400

ERR_CMN-19

Transformer for document type [%s] not found

Перетворювач для типу документа [%s] не знайдено

Не вдалось знайти компонент для перетворення xml в json / json в xml і т.д.

400

ERR_CMN-20

Transforming error

Помилка перетворення

Помилка при перетворенні, наприклад: при перетворенні xml в json, коли xml не відповідає специфікації документа

400

ERR_CMN-21

Malformed JSON

Невірно сформований JSON

Неправильні дані / некоректний формат в полі json

Код помилки

Опис

Рекомендовані дії

500

Не класифікована помилка

У випадку, якщо Ви отримали у тілі відповіді подібний текст “Internal Server Error. Channel ID: 45b696af”, то зверніться за допомогою до нашої тех. підтримки. Якщо Ви отримали інший текст помилки, то прочитайте її і спробуйте зрозуміти. В багатьох випадках, проблема буде описана.

502

Сервер не відповідає

Перевірте ваше інтернет з’єднання. Якщо все гаразд, то спробуйте повторити раніше надісланий запит.

504

Тайм-аут отримання відповіді з сервера

У випадку надсилання запиту, що змінює дані (наприклад, підписання документа) ми рекомендуємо перевіряти виконання попереднього запиту (наприклад, чи був доданий підпис). З затримкою в 5 секунд надішліть запит для перевірки виконання Вашого попереднього запиту. Якщо Ваш попередній запит не виконався з будь-яких причин, повторіть його.

520

Сервісна помилка

Запит не був опрацьований нашими серверами. З затримкою в 5 секунд, повторіть Ваш запит.

521

Сервісна помилка

Запит не був опрацьований нашими серверами. З затримкою в 5 секунд, повторіть Ваш запит.

522

Сервісна помилка

Запит не був опрацьований нашими серверами. З затримкою в 5 секунд, повторіть Ваш запит.

523

Сервісна помилка

Запит не був опрацьований нашими серверами. З затримкою в 5 секунд, повторіть Ваш запит.

524

Сервісна помилка

Запит не був опрацьований нашими серверами. З затримкою в 5 секунд, повторіть Ваш запит.

525

Сервісна помилка

Запит не був опрацьований нашими серверами. З затримкою в 5 секунд, повторіть Ваш запит.

526

Сервісна помилка

Запит не був опрацьований нашими серверами. З затримкою в 5 секунд, повторіть Ваш запит.