Робота з API
Усі запити до API EDIN виконуються через HTTPS із використанням протоколу TLS (мінімальна версія 1.2).
- Опис методів API, загальних для всіх сервісів
- Метод авторизації на платформі
- Загальні помилки при роботі з API (всі сервіси EDIN)
- Опис сабстатусів документів для ETTN v3 (XDoc.extraFields.sub_status)
- Сабстатуси квитанцій/документів
- API по роботі з довідниками
- Перелік методів API по роботі з довідниками
- Отримати інформацію про організацію по Назві/ІПН/КПП/GLN GET /api/oas/identifiers
- Отримати перелік доступних одиниць виміру GET /api/oas/units
- Отримати перелік всіх мереж, пов’язаних з авторизованим користувачем GET /api/oas/allretailers
- Отримати перелік GLN номерів, пов’язаних із заданою роздрібною мережею GET /api/oas/retailer/identificators
- Отримати перелік роздрібних мереж, які пов’язані із заданим GLN GET /api/oas/retailers
- Отримати інформацію по GLN номерам, пов’язаним з авторизованим користувачем (на рівні акаунта) GET /api/oas/account/identifiers
- Отримати інформацію про всіх користувачів компанії (на рівні акаунта) GET /api/oas/account/users
- Отримати інформацію по авторизованому користувачу GET /api/oas/user
- Видалити значення з довідника DELETE /api/uds/dictionary/values
- Додати значення в довідник POST /api/uds/dictionary/values
- Видалити довідник DELETE /api/uds/dictionary
- Оновити довідник PUT /api/uds/dictionary
- Створити новий довідник POST /api/uds/dictionary
- Отримати значення з віртуального довідника GET /api/uds/dictionary
- API Особистого кабінету
- Опрацювання заявки на підключення з боку мережі POST /api/oas/retailers/request/status
- Пошук заявок на підключення до мережі GET /api/oas/retailers/requests
- API сервісу EDI Network
- Перелік методів API сервісу EDI Network
- Алгоритми обміну документами (API)
- Опис помилок сервісу «EDI Network»
- Отримати кроки погодження за документом GET /api/eds/doc/approval/step
- Запуск документа на погодження / Зміна статуса кроку погодження POST /api/eds/doc/approval/step
- Редагувати / видалити сценарій погодження документів PUT /api/eds/doc/approval/scenario
- Отримати сценарій/-ї (на рівні GLN) GET /api/eds/doc/approval/scenario
- Створити сценарій погодження документів POST /api/eds/doc/approval/scenario
- Вилучити теги з документа DELETE /api/eds/doc/tags
- Прив'язати тег до документа POST /api/eds/doc/tags
- Видалити теги DELETE /api/eds/tags
- Редагувати тег PUT /api/eds/tags
- Отримати список тегів (міток) GET /api/eds/tags
- Створити новий тег (мітку) POST /api/eds/tags
- Створити квитанцію №14 (відкликати підписання документа COMDOC/TRANSPORTATIONORDER) POST /api/v2/eds/doc/revoke
- Створити на сервері квитанцію «Відкликання підписання документа» (COMDOC_021) GET /api/v2/eds/doc/revoke
- Відправити відмову від підписання (створення квитанції №13) POST /api/v2/eds/doc/reject
- Створити квитанцію №15 (відмова від анулювання COMDOC/DOCUMENTINVOICE/TRANSPORTATIONORDER) POST /api/v2/eds/doc/repeal/reject
- Створити квитанцію №14 (відкликати підписання документа COMDOC/TRANSPORTATIONORDER) POST /api/v2/eds/comdoc/revoke
- Створити квитанцію №13 (відхилення документа COMDOC/TRANSPORTATIONORDER) POST /api/v2/eds/comdoc/reject
- Створити квитанцію №12 (прийняття запиту на анулювання COMDOC/DOCUMENTINVOICE/TRANSPORTATIONORDER) POST /api/v2/eds/doc/repeal/accept
- Створити квитанцію №11 (запит на анулювання COMDOC/DOCUMENTINVOICE/TRANSPORTATIONORDER) POST /api/v2/eds/doc/repeal
- Створити квитанцію №2 (прийняття документа COMDOC) POST /api/v2/eds/comdoc/accept
- Створити квитанцію №1 (підпис чернетки) POST /api/v2/eds/doc/ticket
- Створити на сервері квитанцію «Повідомлення про відмову від підписання документу» (COMDOC_021) GET /api/v2/eds/doc/reject
- Створити на сервері квитанцію «Повідомлення про відмову від підписання документу» (COMDOC_021) для COMDOC/TRANSPORTATIONORDER документів GET /api/v2/eds/comdoc/reject
- Створити на сервері квитанцію «Анулювання» GET /api/v2/eds/doc/repeal
- Отримати дані/контент квитанції GET /api/eds/doc/ticket/body
- Отримати інформацію про підписантів за всіма вказаними транзакціями документа GET /api/v2/eds/doc/signers
- Отримати інформацію про підписантів GET /api/eds/doc/signers
- Отримати всі квитанції вказаного документа GET /api/eds/doc/tickets
- Отримати хеш вкладення (контейнера) документа для підписання GET /api/eds/doc/attachment/sign/hash
- Додати підпис до вкладень документа-чернетки POST /api/eds/doc/attachment/sign
- Роздрукувати вкладення документа GET /api/eds/doc/print
- Видалити файл-вкладення (чернетка) DELETE /api/eds/doc/attachment
- Отримати файл-вкладення GET /api/eds/doc/attachment
- Додати файл до документа-чернетки POST /api/eds/doc/attachment
- Прийняти документ (CONDRA) PATCH /api/v2/eds/condra/confirm/send
- Відкликати документ (CONDRA). Створення квитанції №14. PATCH /api/v2/eds/condra/withdraw
- Відхилити документ (CONDRA). Створення квитанції №13. PATCH /api/v2/eds/condra/reject
- Підписати файл (для CONDRA) POST /api/eds/doc/body
- Отримати UUID (для CONDRA) GET /api/office/uuid
- Створити чернетку документа (для CONDRA) POST /api/eds/doc
- Додати файл-вкладення (для CONDRA) POST /api/eds/doc/body
- Створити й відправити «Універсальний/неструктурований документ» (CONDRA) без створення чернетки POST /api/v2/eds/doc/condra/create_and_send
- Створити чернетку «Універсального/неструктурованого документа» (CONDRA) POST /api/v2/eds/doc/condra/create
- Відправити «Неструктурований (універсальний) документ» (CONDRA) PATCH /api/eds/doc/condra/send
- Завантажити «Неструктурований (універсальний) документ» (CONDRA) в вигляді архіву GET /api/eds/doc/condra/body
- Отримати статус документа POST /api/v2/eds/docs/state
- Одночасне прийняття, підписання та відправка двох пов’язаних документів POST /api/eds/docs_and_tickets
- Відправити транзакції до «Резерву товару» PRDRSRVN (зміни в табличній частині) POST /api/eds/doc/prdrsrvn/transaction
- Отримати тіло документів (json) за вказаними UUID POST /api/v2/eds/doc/content
- Видалити документи-чернетки PATCH /api/eds/docs
- Отримати інформацію про підпис/підписантів GET /api/eds/doc/attachment/sign/info
- Отримати реєстр документів в xls форматі GET /api/eds/doc/reports/doctype
- Архівувати / Розархівувати ланцюжок документів PATCH /api/eds/chain/archive
- Заповнити індекси (додавання / оновлення полів екстрапараметрів) PUT /api/eds/doc/extra_fields
- Редагувати чернетку документа PUT /api/eds/doc
- Отримати статус документа GET /api/eds/doc/statuses
- Відправити статус документа POST /api/eds/doc/statuses
- Завантажити тіло документа/підпису GET /api/eds/doc/download
- Отримати XML контент документа GET /api/eds/doc/xml
- Отримати контент документа GET /api/eds/doc/body
- Отримати ланцюжки вхідних документів POST /api/eds/chains/search
- Отримати конкретний ланцюжок документів GET /api/eds/chain
- Отримати інформацію (мета-дані) про документ GET /api/eds/doc
- Пошук документів (з фільтрацією), вибір списку документів POST /api/eds/docs/search
- Відправити документ (без створення чернетки) POST /api/eds/doc/create_and_send
- Відправити чернетку PATCH /api/eds/doc/send
- Створити чернетку документа / Клонувати відправлений документ (COMDOC) POST /api/v2/eds/doc
- Отримати останню подію за документом GET /api/eds/docs/event/last
- Отримати список подій GET /api/eds/docs/events
- Пошук подій POST /api/eds/docs/events
- 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)
- API сервісу Е-Сертифікати
- Перелік методів API сервісу Е-Сертифікати
- Опис помилок сервісу «Е-Сертифікати»
- Видалити відвантаженя з сертифікату DELETE /api/ecs/certificate/shipments
- Редагувати дані відвантаження PATCH /api/ecs/certificate/shipments
- Додати відвантаження в список відвантажень по сертифікату POST /api/ecs/certificate/shipments
- Отримати список відвантажень по сертифікату GET /api/ecs/certificate/shipments
- Отримати вкладення до сертифіката в PDF GET /api/ecs/body/download
- Видалити всі вкладення сертифіката DELETE /api/ecs/body
- Отримати контент вкладення до сертифіката GET /api/ecs/body
- Додати нові вкладення до сертифіката PUT /api/ecs/body
- Створити вкладення до сертифікату POST /api/ecs/body
- Створити сертифікат з типом «Декларація виробника» (CERTDOC) POST /api/ecs/certdoc
- Масово завантажити сертифікати POST /api/ecs/certificates
- Додати (прив’язати) товари до сертифіката PUT /api/ecs/products
- Знайти сертифікат/-ти POST /api/ecs/search
- Копіювати сертифікат PUT /api/ecs/copy
- Задати/змінити тип доступу до сертифіката PUT /api/ecs/access
- Архівувати / розархівувати сертифікат PUT /api/ecs/archive
- Видалити сертифікат DELETE /api/ecs/certificate
- Отримати сертифікат GET /api/ecs/certificate
- Оновити сертифікат PUT /api/ecs/certificate
- Створити сертифікат POST /api/ecs/certificate
- Підписати вкладення до сертифіката POST /api/ecs/certificate/sign
- Отримати дані про підписання вкладення до сертифіката GET /api/ecs/certificate/sign
- API сервісу Е-Специфікація + Комерційна пропозиція
- Перелік методів API сервісу Е-Специфікація+Комерційна пропозиція
- Алгоритми обміну документами (API)
- Помилки при роботі з API
- Отримати список типів акцій GET /api/es/promotion/type
- Редагувати тип акції PUT /api/es/promotion/type
- Створити новий тип акції POST /api/es/promotion/type
- Отримати список акцій GET /api/es/promotion
- Видалити акцію DELETE /api/es/promotion
- Редагувати акцію PUT /api/es/promotion
- Створити нову акцію POST /api/es/promotion
- Видалити групу / категорію (Мережа) DELETE /api/products/group
- Створити нову групу / категорію (Мережа) POST /api/products/group
- Відредагувати групу / категорію (Мережа) PUT /api/products/group
- Отримати доступні групи / категорії GET /api/products/group
- Видалити зображення до товарної позиції (чернетка Комерційної пропозиції) DELETE /api/es/position/image
- Отримати зображення до товарної позиції Комерційної пропозиції GET /api/es/position/image
- Додати зображення до товарної позиції (чернетка Комерційної пропозиції) POST /api/es/position/image
- Видалити товарну позицію чернетки Комерційної пропозиції (Постачальник) DELETE /api/es/position
- Редагувати товарну позицію чернетки Комерційної пропозиції (Постачальник) PUT /api/es/position
- Отримати дані товарних позицій всіх Комерційних пропозицій за фільтром POST /api/es/position/search
- Отримати дані товарних позицій Комерційної пропозиції GET /api/es/position
- Додати товарну позицію до чернетки Комерційної пропозиції (Постачальник) POST /api/es/position
- Оновити внутрішній статус пропозиції PUT /api/es/agreement/sub_status
- Оновити статус документа (комерційної пропозиції / товарного узгодження) PUT /api/es/agreement/status
- Переглянути коментарі GET /api/es/agreement/comments
- Створити коментар до пропозиції товарного переузгодження POST /api/es/agreement/comment
- Отримати Комерційну пропозицію в xlsx форматі (Excel) GET /api/es/agreement/offer/excel
- Отримати XML контента документа «Товарна специфікація» (Мережа) GET /api/v2/es/agreement/comdoc
- Відправити підписаний документ «Товарна специфікація» (Мережа) PATCH /api/v2/es/agreement/comdoc
- Прийняти «Товарне узгодження» (Мережа) POST /api/v2/es/agreement/comdoc
- Відхилити «Товарне узгодження» (Мережа) PATCH /api/v2/es/agreement/reject
- Прийняти/Відхилити позиції «Товарного узгодження» (Мережа) PATCH /api/v2/es/agreement/positions
- Формування та отримання Excel-звіту по акціях GET /api/es/agreement/excel
- Пошук «Товарних узгоджень» (AGREEM) з фільтрацією POST /api/es/agreements/search
- Клонувати товарне узгодження (створення пропозиції) PUT /api/es/agreement/copy
- Отримання інформації про сертифікати підписантів GET /api/es/agreement/signers
- Надіслати підписану пропозицію PATCH /api/es/agreement/comdoc
- Надіслати пропозицію (переузгодження) (для Постачальника) PATCH /api/es/agreement
- Додати обгрунтування до пропозиції товарного переузгодження (Постачальник) POST /api/es/attachment
- Отримати контент файлу-вкладення товарного узгодження чи коментаря GET /api/es/attachment/body
- Отримати список вкладень до пропозиції товарного переузгодження чи конкретного коментаря документа GET /api/es/attachment
- Видалити вкладення (обгрунтування) пропозиції товарного переузгодження DELETE /api/es/agreement/attachment
- Видалити пропозицію DELETE /api/es/agreement
- Оновити тіло документа (комерційної пропозиції / товарного узгодження) PUT /api/es/agreement/body
- Отримати тіло документа (комерційної пропозиції / товарного узгодження) GET /api/es/agreement/body
- Створити тіло документа (комерційної пропозиції / товарного узгодження) / Додати обгрунтування до пропозиції POST /api/es/agreement/body
- Редагувати пропозицію (переузгодження) (для Постачальника) PUT /api/es/agreement
- Створити пропозицію (переузгодження) (для Постачальника) POST /api/es/agreement
- Отримати дані пропозиції (товарного узгодження) GET /api/es/agreement
- Переглянути налаштування мережі GET /api/oas/retailer/settings
- Отримати список документів в журналі GET /api/es/agreements
- Пошук контрактів/специфікацій (з фільтрацією) POST /api/es/contracts/search
- Видалити контракт/товарні позиції в контракті DELETE /api/es/contract/data
- Переглянути контракт з конкретним контрагентом GET /api/es/contract
- Переглянути усі контракти/специфікації GET /api/es/contracts
- Оновити раніше створенуї специфікацію (Мережа) PUT /api/es/contract
- Створити нову специфікацію (Мережа) POST /api/es/contract
- Вказати нові дії узгодження для вказаного користувача в розрізі кожного підтипу документа AGREEM POST /api/es/user/spec_status
- Вказати нові активні GLN користувача (за якими відображаються категорії товарів) POST /api/es/user/spec_view_glns
- Вказати нові статуси документів, в яких документи будуть доступні користувачу до перегляду POST /api/es/user/spec_view_statuses
- Отримати налаштування дій узгодження для вказаного користувача в розрізі кожного підтипу документа AGREEM GET /api/es/user/spec_status
- Отримати всі активні GLN користувача (за якими відображаються категорії товарів) GET /api/es/user/spec_view_glns
- Отримати всі статуси документів, в яких документи доступні користувачу до перегляду GET /api/es/user/spec_view_statuses
- Отримати всі пов’язані GLN користувача в сервісі «Е-Специфікація» GET /api/es/user/spec_all_glns
- Отримати інформацію про всіх користувачів компанії (на рівні акаунта) GET /api/oas/account/users
- API сервісу Маркет
- Перелік методів АРІ сервіс Маркет
- Опис помилок сервісу Маркет
- Отримання переліку звернень GET api/distribex/buyer/request
- Оновлення статусу звернення PATCH api/distribex/buyer/request
- Редагування звернення PUT api/distribex/buyer/request
- Створити звернення POST api/distribex/buyer/request
- Отримання логотипа за посиланням на динамічний роут GET api/oas/logo/supplier
- Завантаження логотипа POST api/oas/logo/create
- Отримання картки продавця GET api/oas/supplier
- Оновлення картки продавця PUT api/oas/supplier
- Створення картки продавця POST api/oas/supplier
- Отримати перелік дат доступних для відправлення замовлень у вибраному місяці згідно з графіком Продавця (Виробника) (Покупець (Дистриб'ютор)) POST /api/distribex/schedule/dates
- Отримати найактуальніші графіки замовлень для зазначеного списку Продавців (Виробників) (Покупець (Дистриб'ютор)) POST /api/distribex/distributor/schedules
- Видалити графік замовлення (Продавець (Виробник) DELETE /api/distribex/producer/schedules
- Оновити графік замовлення (Продавець (Виробник) PATCH /api/distribex/producer/schedules
- Створити графік замовлень (Продавець (Виробник) POST /api/distribex/producer/schedules
- Отримати список графіків замовлень (Продавець (Виробник) GET /api/distribex/producer/schedules
- Видалити Покупця (Дистрибʼютора) з групи Покупців (Дистрибʼюторів) DELETE /api/distribex/useraccessgroup
- Додати Покупця (Дистрибʼютора) до групи Покупців (Дистрибʼюторів) (на стороні Продавця (Виробника)) POST /api/distribex/useraccessgroup
- Видалити групу Покупців (Дистрибʼюторів) (на стороні Продавця (Виробника)) DELETE /api/distribex/accessgroup
- Перейменувати поточну групу Покупців (Дистрибʼюторів) (на стороні Продавця (Виробника)) PUT /api/distribex/accessgroup
- Створити групу Покупців (Дистрибʼюторів) (на стороні Продавця (Виробника)) POST /api/distribex/accessgroup
- Отримати дані про створені групи Покупців (Дистрибʼюторів) (на стороні Продавця (Виробника)) GET /api/distribex/accessgroup
- Видалити товарну позицію з «Прайс-листа» DELETE /api/distribex/product
- Отримати список категорій товарів Прайс-листа GET /api/distribex/categories
- Відредагувати товарну позицію «Прайс-листа» PUT /api/distribex/product
- Отримати список контрагентів-Продавців (Виробників) GET /api/distribex/producers/list
- Отримати список контрагентів-Покупців (Дистриб'юторів) GET /api/distribex/distributor/list
- Визначення переліку товарних позицій, доступних для повернення, та формування документа “Надсилання Повернення” (ініціатор - Покупець/Дистриб’ютор) POST /api/distribex/doc/retann
- Пошук документів (з фільтрацією), вибір списку документів POST /api/eds/docs/search
- Отримання контенту документа GET /api/eds/doc/body
- Створити копію документа «Замовлення» (ORDER) відповідно до актуального «Прайс-листа» POST /api/distribex/order/copy
- Створити документ «Замовлення» (ORDER) за «Прайс-листом» POST /api/distribex/doc/order
- Створити (розрахувати) номер «Замовлення» (ORDER) GET /api/oas/doc_counter
- Відправити рекомендації до замовлення за «Прайс-листом» POST /api/eds/doc/create_and_send
- Надсилання документа (без створення чернетки) POST /api/eds/doc/create_and_send
- Видалити Замовлення DELETE /api/distribex/preorder
- Зберегти Замовлення по «Прайс-листу» POST /api/distribex/preorder
- Отримати дані для формування Замовлення по «Прайс-листу» GET /api/distribex/preorder
- Зберегти (відредагувати) Замовлення за «Прайс-листом» PUT /api/distribex/preorder
- Видалити позицію або «Прайс-лист» для вказаного Покупця (Дистрибʼютора) DELETE /api/distribex/pricelist
- Отримати дані «Прайс-листа» для вказаного Покупця (Дистрибʼютора) GET /api/distribex/pricelist
- Редагувати дані товарів «Прайс-листа» вказаного Покупця (Дистрибʼютора) PUT /api/distribex/pricelist
- Додати або оновити дані товарів у Прайс-листі для вказаних Покупців (Дистриб’юторів) POST /api/distribex/pricelist
- Масово видалити відмітку надбавки в прайс-листі для Покупця (Дистриб'ютора) DELETE /api/distribex/surcharge
- Отримати дані надбавки по товару для вказаного Покупця (Дистриб'ютора) GET /api/distribex/surcharge
- Встановити відмітку «Надбавка» для Покупців (Дистриб'юторів) PUT /api/distribex/surcharge
- Масово видалити квоти в прайс-листі для Покупця (Дистриб'ютора) DELETE /api/distribex/quotas
- Отримати квоти по товару для вказаного Покупця (Дистриб'ютора) GET /api/distribex/quotas
- Встановити нові квоти для Покупців (Дистриб'юторів) PUT /api/distribex/quotas
- Видалити обмеження для контрагента (ініціатор Продавець (Виробник)) DELETE /api/distribex/limits
- Отримати обмеження контрагента за GLN GET /api/distribex/limits
- Додати/змінити обмеження (ініціатор Продавець (Виробник)) (ініціатор Продавець (Виробник)) POST /api/distribex/limits
- Видалити відправлені запрошення Покупцю (ініціатор Продавець (Виробник)) DELETE /api/distribex/invitation
- Повторно відправити запрошення Покупцю (ініціатор Продавець (Виробник)) PATCH /api/distribex/invitation
- Прийняти / Відхилити запрошення Продавця (ініціатор Покупець (Дистриб’ютор)) POST /api/distribex/invitation
- Отримати запрошення Продавця в сервіс «Маркет»/Отримати вкладення до вказаного запрошення GET /api/distribex/invitation
- Відправити запрошення Покупцю (ініціатор Продавець (Виробник)) POST /api/distribex/invitation
- API сервісу Тендер
- Перелік методів API сервісу Тендер
- Помилки при роботі з API
- Видалити групу учасників DELETE /api/v1/tender/participant_group
- Створити/Редагувати групу учасників POST /api/v1/tender/participant_group
- Отримати дані групи учасників GET /api/v1/tender/participant_group
- Отримати список всіх наявних груп учасників GET /api/v1/tender/participant_group/list
- Отримати довідник одиниць виміру GET /api/v1/tender/units
- Отримати довідник регіонів GET /api/v1/tender/regions
- Отримати довідник валют GET /api/v1/tender/currency
- Отримати довідник категорій GET /api/v1/tender/categories
- Видалити підписку на користувача (Адміністратор акаунта) DELETE /api/v1/tender/user/subscribes
- Додати підписку на користувача (Адміністратор акаунта) POST /api/v1/tender/user/subscribes
- Отримати список користувачів, на яких підписаний поточний Адміністратор акаунта GET /api/v1/tender/user/subscribes
- Видалити вкладення до тендера / лота (Організатор) DELETE /api/v1/tender/attachment
- Отримати файл-вкладення до тендера/лота/ставки
- Отримати список вкладень до тендера/лота/ставки GET /api/v1/tender/attachments
- Додати вкладення до тендера, лота (Організатор) / Додати вкладення до ставки (Учасник) POST /api/v1/tender/attachments
- Відхилити заявку на участь в закритому аукціоні (Організатор) PATCH /api/v1/tender/auction/access/reject
- Схвалити запит на участь в закритому аукціоні (Організатор) PATCH /api/v1/tender/auction/access/confirm
- Отримати дані по заявкам на участь в закритих аукціонах (Учасник) GET /api/v1/tender/auction/access/company/outgoing
- Подати заявку на участь в закритому аукціоні (Учасник) POST /api/v1/tender/auction/access/request
- Запросити компанії взяти участь в тендері (Організатор) POST /api/v1/tender/auction/access/invite
- Завершити тендер (Організатор) PATCH /api/v1/tender/auctions/close
- Отримати список тендерів для неавторизованого користувача GET /api/v1/tender/guest/auctions/all
- Отримати дані про перегляди тендера (за id) GET /api/v1/tender/auction/views
- Отримати список з «Усі тендери» GET /api/v1/tender/auctions/all
- Отримати список тендерів з «Мої тендери» GET /api/v1/tender/auctions/my
- Отримати список тендерів з «Чернеток» GET /api/v1/tender/auctions/drafts
- Отримати дані тендера (за id) GET /api/v1/tender/auction
- Опублікувати тендер PATCH /api/v1/tender/auctions/publish
- Створити новий тендер (чернетку) POST /api/v1/tender/auctions
- Видалити ставку по лоту тендера (Організатор) DELETE /api/v1/tender/lot/bets
- Зробити ставку по лоту (Учасник) POST /api/v1/tender/lot/bets
- Вибір доступних користувачів по компанії GET /api/v1/tender/users
- Надати доступ користувачам до вже опублікованого тендера POST /api/v1/tender/auction/users
- Закрити доступ до вже опублікованого тендера DELETE /api/v1/tender/auction/users
- API сервісу Вільний
- Перелік методів API сервісу Вільний
- Помилки при роботі з API
- Вилучити теги з документа DELETE /api/sd/eds/doc/tags
- Додати теги до документа POST /api/sd/eds/doc/tags
- Видалити тег DELETE /api/sd/eds/employee/tags
- Редагувати тег PUT /api/sd/eds/employee/tags
- Отримати теги GET /api/sd/eds/employee/tags
- Створити новий тег POST /api/sd/eds/employee/tags
- Отримати список контрагентів (розділ «Контрагенти») GET /api/oas/partners
- Завантажити в сервіс список контрагентів з Excel POST /api/oas/partners
- Отримати дані контрагента (розділ «Контрагенти») GET /api/oas/partner
- Додати в сервіс дані нового контрагента / Редагувати дані контрагента POST/api/oas/partner
- Отримання даних контрагента за ім’ям / ІПН / email / ЄДРПОУ / номером телефону GET /api/oas/v2/employees/search
- Створення та відправка документа (без створення чернетки) POST /api/sd/eds/doc/create_and_send
- Отримати дані про підписання файлу-вкладення GET /api/sd/eds/doc/sign
- Підписати документ POST /api/sd/eds/doc/sign
- Видалити файл-вкладення (чернетка) DELETE /api/sd/eds/doc/attachment
- Отримати файл-вкладення GET /api/sd/eds/doc/attachment
- Додати файл до документа-чернетки POST /api/sd/eds/doc/attachment
- Додати отримувача до відправленого документа PATCH /api/sd/eds/doc/send/recipients
- Отримати список документів POST /api/sd/eds/docs/search
- Відмітити документ, як «важливий» / «звичайний» PATCH /api/sd/eds/doc/important
- Відправити документ (чернетку) PATCH /api/sd/eds/doc/send
- Отримати метадані документа GET /api/sd/eds/doc/body
- Завантажити документ (zip-архів) GET /api/sd/eds/doc/zip
- Відхилити вхідний документ POST /api/sd/eds/doc/decline
- Видалити документ (чернетку) DELETE /api/sd/eds/doc
- Редагувати метадані документа (чернетка) PATCH /api/sd/eds/doc
- Отримати документ GET /api/sd/eds/doc
- Створити документ з метаданими (чернетку) POST /api/sd/eds/doc
- API сервісу EDIN-IDP
- Опис типової структури документа
- Опис обʼєктів для методів сервісу EDIN-IDP
- Опис методів для сервісу EDIN-IDP
- JSON приклади
- Приклади відповіді для перегляду пропозиції / узгодження
- Дані запиту налаштування специфікації мережі
- Приклад запиту при відправці вкладень (обгрунтування) до коментаря
- Приклад запиту при формуванні чернетки «Універсального/неструктурованого документа» (CONDRA)
- Приклад запиту при створенні та відправці «Універсального/неструктурованого документа» (CONDRA)
- Дані тіла запиту, що передаються для створення чернетки (CONDRA)
- Приклади додавання / оновлення полів екстрапараметрів
- Приклад відповіді при створенні квитанції «Повідомлення про відмову від підписання документу»
- Приклад запиту при відправці документа без створення чернетки
- Приклад запиту на створення документа-чернетки
- Обʼєкти АРІ
- Об’єкт ApplicableTransportSettingTemperature
- Об’єкт ShippingMarks
- Об’єкт TransportLogisticsPackage
- Об’єкт ApplicableTransportDangerousGoods
- Об’єкт Identification
- Об’єкт ApplicableNote
- Об’єкт AttachedSpecifiedBinaryFile
- Об’єкт DateTimeString
- Об’єкт PostalTradeAddress
- Об’єкт ComunicationContact
- Об’єкт TradeContact
- Об’єкт PreviousAdministrativeReferencedDocument
- Об’єкт PhysicalGeographicalCoordinate
- Об’єкт EntityId
- Об’єкт ContentCode
- Об'єкт IncludedNote
- Об’єкт Partner (дані контрагентів)
- Метадані документа
- Об’єкт ParticipantGroup
- Об’єкт Access (дані запиту на участь в закритому аукціоні)
- Об’єкт AuctionView (дані про перегляди тендера)
- Об'єкт AccessLog
- Об'єкт CompanyAccessRequestStatus
- Об’єкт AuctionContacts
- Об’єкт Region
- Об’єкт Attachment (для сервісу Тендер)
- Об’єкт Unit
- Об’єкт Currency
- Об’єкт Lot
- Об’єкт OfferType
- Об’єкт Type
- Об’єкт AccessType (для сервісу Тендер)
- Об’єкт Status (для сервісу Тендер)
- Об’єкт Category
- Об’єкт SubscribeToCategory
- Об’єкт Subscribes
- Об’єкт Role
- Об’єкт StatusAcc
- Об’єкт Account (для сервісу Тендер)
- Об’єкт User (для сервісу Тендер)
- Об’єкт Comment
- Об’єкт Company (для сервісу Тендер)
- Об'єкт Filter (додаткові параметри виборки)
- Об’єкт Auction (дані тендера)
- Об’єкт Bet (дані ставки по тендеру)
- Об’єкт XDocApprovalStep
- Об'єкт XDocApprovalScenario (дані кроків за сценарієм)
- Об'єкт XQueryShipment
- Об'єкт XCertificateShipment
- Обʼєкт XPromotion
- Об'єкт XPromotionType
- Об’єкт mintransSubscription
- Об'єкт XQueryProduct
- Об’єкт XQueryCertificates
- Дані про сертифікат
- Об'єкт characteristics (характеристики Сертифіката)
- Об'єкт XCertificateProduct (дані товарів)
- Об'єкт Level
- Об'єкт AccessType
- Об’єкт XCertificateView
- Об’єкт XCertificateType
- Об’єкт XCertificate (дані Сертифіката)
- Об’єкт XProductGroup (Групи / категорії товарів)
- Об’єкт XSearchPositionsQuery (Фільтр за позиціями Комерційних пропозицій)
- Масив об’єктів XAgreemDocPosition (Дані позицій Комерційної пропозиції)
- Об’єкт DeliveryInstructions
- Об’єкт MainCarriageLogisticsTransportMovement
- Об’єкт UtilizedLogisticsTransportEquipment
- Об’єкт IncludedSupplyChainConsignmentItem
- Об’єкт TransportEvent
- Об’єкт HandlingInstructions
- Об’єкт ReferencedDocument
- Об’єкт SimpleIdentity
- Об’єкт TradeParty
- Об’єкт InvoiceAmount
- Об’єкт LogisticsLocation
- Об'єкт EcmrUnitValue
- Об’єкт DateTime
- Об’єкт DocumentCode
- Об’єкт SpecifiedSupplyChainConsignment
- Об’єкт ExchangedDocument
- Об’єкт DocumentContext
- Об’єкт Index
- Об’єкт Field
- Об’єкт XSearchDocsQuery (Критерії пошуку/фільтрації «Товарних узгоджень» AGREEM)
- Об’єкт XNoveltyContacts
- Об’єкт XNoveltyComment
- Об’єкт XNoveltyTrade
- Об’єкт XNoveltyMarketing
- Об’єкт XNoveltyPrices
- Об’єкт Ecmr
- Об'єкт Transport
- Об'єкт SignsPackageV2
- Об’єкт XNovelty (Дані комерційної пропозиції)
- Об’єкт RetailerEsSettings
- Об’єкт XAgreemDocStatus
- Об’єкт XAgreemDoc
- Об’єкт XSearchContractsQuery (Критерії пошуку/фільтрації довідника специфікацій/контрактів)
- Об’єкт RemoveProductDetail
- Об’єкт RemoveProductResponse (Деталі результату операції видалення)
- Об’єкт XContractProduct
- Об’єкт XContract (Контракти)
- Об’єкт XAgreemDocAttachment
- Об’єкт XAgreemDocComment
- Об’єкт SpecStatus
- Об'єкт DistribexOrderParams
- Об’єкт XChainStatus
- Об’єкт XChain
- Об’єкт RecurrenceRule
- Об’єкт Schedule
- Об’єкт XDistribexAccessGroup
- Об’єкт XProductGroup
- Об’єкт XDistribexProduct
- Об’єкт Document
- Об’єкт DocumentRequest (Дані пов’язаних документів)
- Об'єкт Signs (дані для здійснення операції підписання)
- Об’єкт SignInfo (інформація про підпис)
- Об’єкт ExEndUserTimeInfo
- Об’єкт EndUserOwnerInfo
- Об’єкт ExEndUserSignInfo (дані підписантів документа)
- Об’єкт DateTimeRange
- Об’єкт Limitation
- Об’єкт Direction
- Об’єкт ExtraQueryParameters
- Об’єкт StorageQuery (Дані для фільтрації)
- Додаткові поля (extra_fields)
- Об’єкт XStatus
- Об’єкт XTag в параметрах об'єкта XDoc
- Об’єкт XDocSignInfo
- Об’єкт XDocStatus
- Об’єкт XDocComment
- Об’єкт XDocCommentsList
- Об’єкт XDocBodyForms
- Об’єкт XDocBodyType
- Об’єкт XDocBody
- Об’єкт XDoc
- Об’єкт XDocType
- Об’єкт DistribexOrderResult
- Об’єкт XDistribexPreorder
- Об'єкт XDistribexPreorderPosition
- Об’єкт Сharacteristics (додаткові характеристики продукту)
- Об’єкт XPriceListProduct
- Об’єкт XPriceListElement
- Об’єкт XTicketBody
- Об’єкт XTicket
- Об’єкт XDocAttachmentSign
- Об’єкт XDocAttachment
- Масив об’єктів одиниць виміру
- Об'єкт Employee
- Об'єкт Company
- Об'єкт Account
- Об'єкти інформації по торгових мережах
- Об’єкт з values даними
- Об’єкт UsersDataStorage
- Об’єкт Retailer
- Об’єкт User
- Об’єкт XDistribexSurcharge
- Об’єкт Quotas
- Об’єкт Identificator
- Об’єкт XDistribexInvitation
- Обʼєкт Limits
- Обʼєкт XTag
- Об'єкт EttnV3Event
- Об'єкт XEvent (Подія за документом)
- Об'єкт DocumentEvent
- Об'єкт EventsStorageQueryResult (результати пошуку подій за документами)
- Об'єкт EventsStorageQuery (параметри пошуку подій)
Опис методів API, загальних для всіх сервісів
Метод авторизації на платформі
Token-Based Authorization
REQUEST
Після підключення послуги для роботи з API, користувач отримує логін і пароль для авторизації.
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
POST |
|
URL запиту |
/api/authorization/hash |
|
Headers |
|
|
Content-Type |
application/x-www-form-urlencoded |
|
REQUEST |
|
|
JSON Body |
email (обов’язково) String - логін користувача password (обов’язково) String - пароль користувача |
Приклад запиту:
curl --location 'https://dev-oed.edin.ua/api/authorization/hash' \
--header 'l: xezpCrzv5fgk1kNRA/QUZg==' \
--header 'Content-Type: application/json' \
--header 'Authorization: ••••••' \
--data-raw 'email={{login}}&password={{password}}'
RESPONSE
В тілі відповіді, у JSON-форматі, передається «ключ сесії», необхідний для подальшої роботи.
У кожному наступному запиті (виклику методу) повинен бути присутнім HTTP-заголовок (Header) «Authorization», який для коректного виконання запитів має містити токен SID зі значенням, отриманим під час авторизації.
Приклад відповіді (JSON):
{"SID": "65daca25-74ba-4c85-8183-71b404a348c0"}Тривалість сесії при бездіяльності користувача становить 20 хвилин.
Тобто ключ буде видалено через 20 хвилин, якщо користувач не буде активним (не надсилатиме HTTP-запити).
HTTP Basic Authentication
Також, при виконанні запитів, замість значення «SID» в HTTP-заголовку (Header) «Authorization», можливо відправляти серверу логін і пароль у якості базової аутентифікації (HTTP Basic Authentication).
При базовій аутентифікації клієнт разом із кожним запитом відправляє серверу логін і пароль. Ці дані передаються в заголовку запиту «Authorization» у вигляді Base64-коду.
Authorization: Basic base64_encode(login:password)Так, наприклад, якщо логін і пароль admin, заголовок виглядатиме:
Authorization: Basic YWRtaW46YWRtaW4=
Загальні помилки при роботі з API (всі сервіси EDIN)
Код 400
|
Код відповіді |
Індекс помилки |
Текст помилки |
Опис |
|
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 |
Error occurred while retrieving information about the signer: Помилка при отриманні інформації про підписанта: |
|
|
400 |
ERR_CMN-19 |
Document body already exist Тіло документа вже існує |
Дублювання тіла документа |
|
400 |
ERR_CMN-20 |
Transformer for document type [%s] not found Перетворювач для типу документа [%s] не знайдено |
Не вдалось знайти компонент для перетворення xml в json / json в xml і т.д. |
|
400 |
ERR_CMN-21 |
Transforming error Помилка перетворення |
Помилка при перетворенні, наприклад: при перетворенні xml в json, коли xml не відповідає специфікації документа |
|
400 |
ERR_CMN-22 |
Malformed JSON Невірно сформований JSON |
Неправильні дані / некоректний формат в полі json |
|
400 |
ERR_CMN-23 |
ZIP format error: Невірний формат ZIP: |
|
|
400 |
ERR_CMN-24 |
UUID format error: Невірний формат UUID: |
|
|
400 |
ERR_CMN-25 |
Expected non-empty list of uuids Cписок uuid не може бути пустим |
|
|
400 |
ERR_CMN-26 |
The size of the list cannot be more than [%s] Розмір списку не може перевищувати [%s] |
|
|
400 |
ERR_CMN-27 |
The data is not signed or contains an incorrect signature Дані не підписані або містять некорректний підпис |
|
|
400 |
ERR_CMN-28 |
Content from request does not match original content, actual_hash:[%s] request_hash:[%s] Контент запиту не відповідає оригінальному контенту, actual_hash:[%s] request_hash:[%s] |
|
|
400 |
ERR_CMN-29 |
GLN from request [%s] should match sender’s GLN from body [%s] GLN із запиту [%s] має збігатися з GLN відправника з тіла [%s] |
|
|
400 |
ERR_CMN-30 |
The requested data was not found Запитувані дані не знайдені |
|
|
400 |
ERR_CMN-31 |
Field [%s] in request body is empty or invalid Поле [%s] в тілі запиту порожнє або має недопустиме значення |
|
|
400 |
ERR_CMN-32 |
Part [%s] in multipart/form-data is required Частина [%s] в multipart/form-data є обов’язковою |
|
|
400 |
ERR_CMN-32 |
File [%s] in multipart/form-data not found Файл [%s] в multipart/form-data не знайдено |
|
|
400 |
ERR_CMN-32 |
Field [%s] in post data is required Поле [%s] в post data запиту не знайдено |
|
|
400 |
ERR_CMN-33 |
At least one of parameters [%s] required Необхідний принаймні один із параметрів [%s]. |
|
|
400 |
ERR_CMN-34 |
Unsupported parameter[%s] Непідтримуваний параметр [%s]. |
Код 500
|
Код помилки |
Опис |
Рекомендовані дії |
|
500 |
Не класифікована помилка |
У випадку, якщо Ви отримали у тілі відповіді подібний текст “Internal Server Error. Channel ID: 45b696af”, то зверніться за допомогою до нашої тех. підтримки. Якщо Ви отримали інший текст помилки, то прочитайте її і спробуйте зрозуміти. В багатьох випадках, проблема буде описана. |
|
502 |
Сервер не відповідає |
Перевірте ваше інтернет з’єднання. Якщо все гаразд, то спробуйте повторити раніше надісланий запит. |
|
504 |
Тайм-аут отримання відповіді з сервера |
У випадку надсилання запиту, що змінює дані (наприклад, підписання документа) ми рекомендуємо перевіряти виконання попереднього запиту (наприклад, чи був доданий підпис). З затримкою в 5 секунд надішліть запит для перевірки виконання Вашого попереднього запиту. Якщо Ваш попередній запит не виконався з будь-яких причин, повторіть його. |
|
520 |
Сервісна помилка |
Запит не був опрацьований нашими серверами. З затримкою в 5 секунд, повторіть Ваш запит. |
|
521 |
Сервісна помилка |
Запит не був опрацьований нашими серверами. З затримкою в 5 секунд, повторіть Ваш запит. |
|
522 |
Сервісна помилка |
Запит не був опрацьований нашими серверами. З затримкою в 5 секунд, повторіть Ваш запит. |
|
523 |
Сервісна помилка |
Запит не був опрацьований нашими серверами. З затримкою в 5 секунд, повторіть Ваш запит. |
|
524 |
Сервісна помилка |
Запит не був опрацьований нашими серверами. З затримкою в 5 секунд, повторіть Ваш запит. |
|
525 |
Сервісна помилка |
Запит не був опрацьований нашими серверами. З затримкою в 5 секунд, повторіть Ваш запит. |
|
526 |
Сервісна помилка |
Запит не був опрацьований нашими серверами. З затримкою в 5 секунд, повторіть Ваш запит. |
Опис сабстатусів документів для ETTN v3 (XDoc.extraFields.sub_status)
Товарно-транспортна накладна v3
|
sub_status_id |
Status |
Опис |
Статус на платформі (web) |
|---|---|---|---|
|
«-1» |
Учасник документообігу (не Вантажовідправник) відправив «Попередню ТТН» |
Попередня ТТН |
|
|
«1» |
PLANNED (IN_PROCESS) |
Вантажовідправник підписав та відправив ТТН |
Очікує на підписання перевізником |
|
«6» |
PICKUP (SIGNED_CARRIER_LOAD) |
Перевізник підписав та відправив ТТН |
Очікує на підписання вантажоодержувачем |
|
«7» |
ARRIVAL (SIGNED_CONSIGNEE) |
Вантажоодержувач підписав та відправив ТТН |
Підписано вантажоодержувачем |
|
«8» |
CANCELED (CANCELED_CONSIGNOR) |
Вантажовідправник відхилив ТТН |
Відмовлено в підписанні вантажовідправником |
|
«9» |
CANCELED (CANCELED_CARRIER_LOAD) |
Перевізник відхилив ТТН |
Відмовлено в підписанні перевізником/водієм |
|
«14» |
CANCELED (CANCELED_MINTRANS) |
ТТН відхилена через конвеєр подій (отримання документів з ЦБД) |
Документ відхилено |
|
«15» |
CANCELED (CANCELED_STOP_ACT) |
ТТН відхилена в результаті складання «Акта примусового завершення е-ТТН» |
ТТН відхилено на підставі Акту примусового завершення ТТН |
|
«16» |
CANCELED (CANCELED_REJECT_ACT) |
ТТН відхилена в результаті складання «Акта про відмову вантажити» |
ТТН відхилено на підставі Акту про відмову вантажити |
|
«6» + extraFields.ettn_onstorage=1 |
ONSTORAGE |
Проміжний склад підписав та відправив «Акт розвантаження на проміжному складі» та підписав і відправив оновлену ТТН |
Очікує на підписання вантажоодержувачем. |
Акти v3 (всі види)
|
sub_status_id |
Status |
Опис |
Статус на платформі (web) |
|---|---|---|---|
|
«1» |
PENDING_SIGNATURE |
Акт підписаний ініціатором або наступним учасником до останнього учасника ЖЦ |
Очікує на підписання отримувачем |
|
«2» |
SIGNED |
Акт підписаний останнім учасником ЖЦ |
Підписано всіма сторонами |
|
«3» |
CANCELED_CONSIGNOR |
Акт відхилений Вантажовідправником |
Відмовлено в підписанні вантажовідправником |
|
«4» |
CANCELED_CONSIGNEE |
Акт відхилений Вантажоодержувач |
Відмовлено в підписанні вантажоодержувачем |
|
«5» |
CANCELED_CARRIER |
Акт відхилений Перевізником |
Відмовлено в підписанні перевізником/водієм |
|
«6» |
CANCELED_CUSTOMER |
Акт відхилений Замовником |
Відмовлено в підписанні замовником |
|
«7» |
CANCELED_CARRIER_SWITCH |
Акт відхилений новим Перевізником |
Відмовлено в підписанні новим перевізником |
|
«8» |
CANCELED_STORAGE |
Акт відхилений Проміжним складом |
Відмовлено в підписанні проміжним складом |
Заявка на транспортування / Підтвердження заявки на транспортування
|
Ticket |
exchange_status |
sub_status_id |
Опис |
Статус на платформі (web) |
|---|---|---|---|---|
|
T1 |
«000000000000000000000001» |
«1» |
Замовник відправив «Заявку на транспортування» Перевізник відправив «Підтвердження заявки на транспортування» |
Очікує на підписання замовником/перевізником |
|
T1 |
«000000000000000000000001» |
«2» |
Перевізник підписав «Заявку на транспортування» Замовник підписав «Підтвердження заявки на транспортування» |
Підписано замовником/перевізником |
|
T2 |
«000000000000000000000011» |
«2» |
Підписано з обох сторін |
Підписано замовником/перевізником |
|
T 11 2 |
«000000000000010000000011» |
«3» |
Може відправлятись на документ «Підтверджений з двох сторін» (2 Ticket) чи після «Відмови в анулюванні» (15 Ticket) |
Надіслано запит на анулювання |
|
T 12 2 |
«000000000000110000000011» |
«4» |
Анульовано | |
|
T 13 1 |
«000000000001000000000001» |
«5» |
«Заявка на транспортування» відхилена Перевізником |
Відмовлено в підписанні перевізником |
|
T 14 1 |
«000000000010000000000001» |
«6» |
«Заявка на транспортування» відхилена Замовником «Підтвердження заявки на транспортування» відхилено Перевізником |
Підпис відкликано |
|
T 15 |
«000000000100010000000011» |
«2» |
Може відправлятись у відповідь на «Запит на анулювання» (11 Ticket) |
Відмовлено в анулюванні |
Сабстатуси квитанцій/документів
Для комерційних документів (COMDOC):
|
Ticket |
exchange_status |
sub_status_id |
Статус |
Коментар |
|---|---|---|---|---|
|
T0 |
«000000000000000000000000» |
«0» |
«Не підписано» |
Інтегрована відправка не підписаного документа |
|
T1 |
«000000000000000000000001» |
«1» |
«Потребує підписання отримувачем» |
Підписано лише Відправником |
|
T1 |
«000000000000000000000001» |
«2» |
«Потребує підписання відправником» |
Підписано лише Отримувачем |
|
T2 |
«000000000000000000000011» |
«2» |
«Підписано двома сторонами» / «Документ не потребує підписання» |
Підписано з обох сторін в будь якому порядку / Відправлений документ містить поле «ОдностороннєПідписання» (підписується лише відправником) |
|
T 11 1 |
«000000000000010000000001» |
«Запит на анулювання» |
В разі інтегрованої відправки COMDOC_19 (Запит на анулювання) до підписання документа COMDOC |
|
|
T 11 2 |
«000000000000010000000011» |
«3» |
«Запит на анулювання» |
Може відправлятись на COMDOC «Підтверджений з двох сторін» (2 Ticket) чи після «Відмови в анулюванні» (15 Ticket) |
|
T 12 1 |
«000000000000110000000001» |
«Прийняття запиту на анулювання» АБО «Анульовано» в разі підписання вхідного інтегровано відправленого COMDOC_19 (Запит на анулювання) до підписання документа COMDOC |
||
|
T 12 2 |
«000000000000110000000011» |
«4» |
«Анульовано» |
|
|
T 13 1 |
«000000000001000000000001» |
«5» |
«Відмовлено в підписі» |
|
|
T 14 1 |
«000000000010000000000001» |
«6» |
«Відкликано» |
|
|
T 15 |
«000000000100010000000011» |
«2» |
«Відмовлено в анулюванні» |
Може відправлятись у відповідь на «Запит на анулювання» (11 Ticket) |
Для різних видів накладних (DOCUMENTINVOICE/DOCCORINVOICE):
|
Ticket |
exchange_status |
sub_status_id |
Статус |
Коментар |
|---|---|---|---|---|
|
T0 |
«000000000000000000000000» |
«0» |
«Не підписано» |
Інтегрована відправка не підписаного документа |
|
T1 |
«000000000000000000000001» |
«1» |
«Потребує підписання отримувачем» |
Підписано лише Відправником |
|
T2 |
«000000000000000000000011» |
«2» |
«Підтверджено з двох сторін» |
Підписано з обох сторін |
|
T 13 1 |
«000000000001000000000001» |
«5» |
«Відмовлено в підписі» |
Для «Заявки на транспортування»/«Підтвердження заявки на транспортування» (TRANSPORTATIONORDER):
|
Ticket |
exchange_status |
sub_status_id |
Статус |
Коментар |
|---|---|---|---|---|
|
T1 |
«000000000000000000000001» |
«1» |
«Потребує підписання отримувачем» |
Замовник відправив «Заявку на транспортування» Перевізник відправив «Підтвердження заявки на транспортування» |
|
T1 |
«000000000000000000000001» |
«2» |
«Потребує підписання відправником» |
Перевізник підписав «Заявку на транспортування» Замовник підписав «Підтвердження заявки на транспортування» |
|
T2 |
«000000000000000000000011» |
«2» |
«Підтверджено з двох сторін» |
Підписано з обох сторін |
|
T 11 2 |
«000000000000010000000011» |
«3» |
«Запит на анулювання» |
Може відправлятись на документ «Підтверджений з двох сторін» (2 Ticket) чи після «Відмови в анулюванні» (15 Ticket) |
|
T 12 2 |
«000000000000110000000011» |
«4» |
«Анульовано» |
|
|
T 13 1 |
«000000000001000000000001» |
«5» |
«Відмовлено в підписі» |
«Заявка на транспортування» відхилена Перевізником |
|
T 14 1 |
«000000000010000000000001» |
«6» |
«Підпис відкликано» |
«Заявка на транспортування» відхилена Замовником «Підтвердження заявки на транспортування» відхилено Перевізником |
|
T 15 |
«000000000100010000000011» |
«2» |
«Відмовлено в анулюванні» |
Може відправлятись у відповідь на «Запит на анулювання» (11 Ticket) |
API по роботі з довідниками
Перелік методів API по роботі з довідниками
Всі запити нижче перерахованих API методів платформи EDIN 2.0 направляються на адресу: https://edo-v2.edin.ua
Для роботи з цими методами користувач повинен бути авторизованим.
Робота з об'єднаним віртуальним довідником (всі сервіси в рамках акаунта/користувача)
| Отримати значення з віртуального довідника | GET /api/uds/dictionary |
| Створити новий довідник | POST /api/uds/dictionary |
| Оновити довідник | PUT /api/uds/dictionary |
| Видалити довідник | DELETE /api/uds/dictionary |
| Додати значення в довідник | POST /api/uds/dictionary/values |
| Видалити значення з довідника | DELETE /api/uds/dictionary/values |
Робота з іншими довідниками
| Отримати інформацію по авторизованому користувачу | GET /api/oas/user |
| Отримати інформацію про всіх користувачів компанії (на рівні акаунта) | GET /api/oas/account/users |
| Отримати інформацію по GLN-номерам, пов'язаним з авторизованим користувачем (на рівні акаунта) | GET /api/oas/account/identifiers |
| Отримати перелік роздрібних мереж, пов'язаних із заданим GLN | GET /api/oas/retailers |
| Отримати перелік GLN-номерів, пов'язаних із заданою роздрібною мережею | GET /api/oas/retailer/identificators |
| Отримати перелік всіх мереж, пов'язаних з авторизованим користувачем | GET /api/oas/allretailers |
| Отримати перелік доступних одиниць виміру | GET /api/oas/units |
| Отримати інформацію про організацію по Назві/ІПН/КПП/GLN | GET /api/oas/identifiers |
Отримати інформацію про організацію по Назві/ІПН/КПП/GLN GET /api/oas/identifiers
Метод дозволяє користувачеві переглядати додаткову інформацію про інші організації на рівні одного загального акаунта, а також знайти Основний GLN за Додатковим GLN.
Основний GLN має унікальний ЄДРПОУ на рівні платформи. Використовується для документів, що потребують дані юридичної особи та подальшого підписання КЕП. Створюється автоматично при реєстрації на платформі EDI Network.
Додатковий GLN підв’язується до «Основного GLN». Використовується для указання точок доставки, дрібних магазинів і т.і.
При заповненні GLN у ТТН перевірте правильність формату адреси «Правила заповнення адрес у ТТН та Актах на основі даних із GLN»
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/oas/identifiers |
|
URL параметри |
gln (обов’язково) String (13) - GLN власної Компанії; query (опціонально) String - текст пошуку (пошук здійснюється за назвою/ІПН/КПП/GLN організації); with_parents (опціонально) boolean - при true значенні у відповідь передаються дані Основного GLN при наявності (параметр parentIdentificator); child_gln (опціонально) GLN - значення Додаткового GLN; якщо передається даний параметр, то у відповідь повертаються дані Основного GLN, з яким встановлено зв’язок за Додатковим GLN; account_id (опціонально) String - ідентифікатор акаунта Компанії. В комбінаціях з account_id параметром можуть застосовуватись додаткові фільтри:
|
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передається інформація про організацію (масив об’єктів Identificator).
Отримати перелік доступних одиниць виміру GET /api/oas/units
Метод дозволяє відобразити довідник одиниць виміру.
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/oas/units |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передається довідник одиниць виміру.
Отримати перелік всіх мереж, пов’язаних з авторизованим користувачем GET /api/oas/allretailers
REQUEST
|
Метод запиту |
GET |
|
URL запиту |
/api/oas/allretailers |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передається інформація по мережах у вигляді масиву об’єктів.
Отримати перелік GLN номерів, пов’язаних із заданою роздрібною мережею GET /api/oas/retailer/identificators
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/oas/retailer/identificators |
|
URL параметри |
retailer_id - число; ідентифікатор роздрібної мережі (параметр retailerId з попередніх методів) |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передаються дані про контрагентів (масив об’єктів Identificator).
Отримати перелік роздрібних мереж, які пов’язані із заданим GLN GET /api/oas/retailers
За допомогою цього метода можна отримати перелік всіх роздрібних мереж-контрагентів користувача.
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/oas/retailers |
|
URL параметри |
gln - рядок (13); номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передається інформація про роздрібні мережі.
Отримати інформацію по GLN номерам, пов’язаним з авторизованим користувачем (на рівні акаунта) GET /api/oas/account/identifiers
Метод дозволяє користувачеві переглядати додаткову інформацію про інших користувачів на рівні одного загального акаунта.
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/oas/account/identifiers |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передається інформація по GLN номерам у вигляді масиву об’єктів Identificator.
Отримати інформацію про всіх користувачів компанії (на рівні акаунта) GET /api/oas/account/users
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/oas/account/users |
|
URL параметри |
type (опціонально) String - тип очікуваної відповіді; можливі варіанти:
|
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передається інформація про користувачів (масив об’єктів User).
Отримати інформацію по авторизованому користувачу GET /api/oas/user
За допомогою цього метода можна отримати інформацію про користувача, наприклад ID користувача, ID акаунта, логін, чи має користувач «права адміністратора» (true / false), дані про платформу та інші ідентифікатори.
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/oas/user |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передається інформація про користувача (об’єкт User).
Видалити значення з довідника DELETE /api/uds/dictionary/values
REQUEST
|
URL |
|
|
Метод запиту |
DELETE |
|
URL запиту |
/api/uds/dictionary/values |
|
URL параметри |
dict_id (обов’язково) String - ідентифікатор довідника |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передається масив з номером значення із довідника, яке потрібно видалити, наприклад: [23] |
RESPONSE
Код сервера 200 (ok).
Додати значення в довідник POST /api/uds/dictionary/values
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/uds/dictionary/values?dict_id=3 |
|
URL параметри |
dict_id (обов’язково) String - ідентифікатор довідника |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передається масив об’єктів зі значеннями віртуального довідника |
RESPONSE
Код сервера 200 (ok).
Видалити довідник DELETE /api/uds/dictionary
REQUEST
|
URL |
|
|
Метод запиту |
DELETE |
|
URL запиту |
/api/uds/dictionary |
|
URL параметри |
dict_id (обов’язково) String - ідентифікатор довідника |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
Код сервера 200 (ok).
Оновити довідник PUT /api/uds/dictionary
При оновленні довідника всі його дані перезаписуються на нові з тіла запиту.
REQUEST
|
URL |
|
|
Метод запиту |
PUT |
|
URL запиту |
/api/uds/dictionary |
|
URL параметри |
dict_id (обов’язково) String - ідентифікатор довідника |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передається масив об’єктів зі значеннями віртуального довідника |
RESPONSE
Код сервера 200 (ok).
Створити новий довідник POST /api/uds/dictionary
Важливо! При створенні довідник одразу наповнюється даними.
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/uds/dictionary |
|
URL параметри |
name (обов’язково) - рядок; назва довідника:
type (обов’язково) - рядок; рівень довідника:
|
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передається масив об’єктів зі значеннями віртуального довідника |
RESPONSE
У тілі відповіді передається об’єкт з dict_id - ідентифікатором нового довідника:
{"dict_id":2}
Отримати значення з віртуального довідника GET /api/uds/dictionary
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/uds/dictionary |
|
URL параметри |
name (обов’язково) - рядок; назва довідника:
type (обов’язково) - рядок; рівень довідника:
|
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді в залежності від параметрів запиту передається об’єкт зі значеннями з віртуального довідника в json форматі.
API Особистого кабінету
Опрацювання заявки на підключення з боку мережі POST /api/oas/retailers/request/status
Всі запити API методів платформи EDIN 2.0 направляються на адресу: https://edo-v2.edin.ua
Для роботи з цим методом користувач повинен бути авторизованим.
Для торгових мереж!
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/oas/retailers/request/status |
|
PARAMS |
|
|
request_id |
ціле число, ІД заявки на підключення |
|
status |
ціле число, статус опрацювання (2 - схвалено, 3 - відхилено) |
Приклад запиту:
https://edo-v2.edin.ua/api/oas/retailers/request/status?request_id=651&status=2
RESPONSE
У відповіді повертається повідомлення та статус:
| STATUS | Message | Коментар |
| 200 | Запит успішно опрацьовано | Статус заявки змінено на вказаний |
| 400 | Запит вже оброблено. Статус: Підтверджено | Запит вже був опрацьований раніше. |
| 400 | Bad Request | Не правильний ІД заявки та/або статус |
| 500 | Internal Server Error. Chanel ID: 123456 | Непередбачена внутрішня помилка. Необхідно звернутись до тех. підтримки для зʼясування причини помилки. |
Пошук заявок на підключення до мережі GET /api/oas/retailers/requests
Всі запити API методів платформи EDIN 2.0 направляються на адресу: https://edo-v2.edin.ua
Для роботи з цим методом користувач повинен бути авторизованим.
Для торгових мереж!
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/oas/retailers/requests |
|
PARAMS |
|
|
limit |
ціле число, к-сть записів для вибірки |
|
offset |
ціле число, № запису з якого починати вибірку |
|
send_date_from |
ціле число (дата в форматі UNIXTIMESTAMP, без мілісекунд), початок періоду відправки заявки (дата з...) |
|
send_date_to |
ціле число (дата в форматі UNIXTIMESTAMP, без мілісекунд), закінчення періоду відправки заявки (дата по...) |
Приклад запиту:
https://edo-v2.edin.ua/api/oas/retailers/requests?limit=100&offset=0&send_date_from=1380000400&send_date_to=1390006799RESPONSE
В тілі відповіді в json-форматі передається масив заявок на підключення
[
{
"accountId": "ІД постачальника в системі EDIN",
"retailerId": "ІД торгової мережі, які відправлено заявку на підключення",
"status": "статус заявки (1 - не опрацьовано, 2 - погоджено, 3 - відхилено)",
"gln": "GLN постачальника",
"contractNumber": "№ договору поставки з мережею",
"contractDate": "Дата договору поставки з мережею в форматі YYYY-MM-DD",
"dateCreated": "Дата/час відправки заявки у форматі YYYY-MM-DD HH:NN:SS",
"fio": "ПІБ відповідальної особи постачальника",
"phone": "Тел. відповідальної особи постачальника",
"email": "Емейл відповідальної особи постачальника",
"edrpou": "ЄДРПОУ/РКНОПП постачальника",
"companyName": "Назва компанії постачальника",
"type": "Тип заявки (1 - підключення EDI, 2 - підключення ЮЗД)",
"id": "ІД заявки"
}
]API сервісу EDI Network
Перелік методів API сервісу EDI Network
Всі запити нижче перерахованих API методів платформи EDIN 2.0 направляються на адресу: https://edo-v2.edin.ua
Для роботи з цими методами користувач повинен бути авторизованим.
Робота з документами
|
Створити чернетку документа / Клонувати відправлений документ (COMDOC) |
POST /api/v2/eds/doc |
|
Відправити чернетку |
PATCH /api/eds/doc/send |
|
Відправити документ (без створення чернетки) |
POST /api/eds/doc/create_and_send |
|
Пошук документів (з фільтрацією), вибір списку документів |
POST /api/eds/docs/search |
|
Отримати інформацію (мета-дані) про документ |
GET /api/eds/doc |
|
Отримати конкретний ланцюжок документів |
GET /api/eds/chain |
|
Отримати ланцюжки вхідних документів |
POST /api/eds/chains/search |
|
Отримати контент документа |
GET /api/eds/doc/body |
|
Отримати XML контенту документа |
GET /api/eds/doc/xml |
|
Завантажити тіло документа/підпису |
GET /api/eds/doc/download |
|
Відправити статус документа |
POST /api/eds/doc/statuses |
|
Отримати статус документа |
GET /api/eds/doc/statuses |
|
Редагувати чернетку документа |
PUT /api/eds/doc |
|
Заповнити індекси (додавання / оновлення полів екстрапараметрів) |
PUT /api/eds/doc/extra_fields |
|
Архівувати / Розархівувати ланцюжок документів |
PATCH /api/eds/chain/archive |
|
Отримати реєстр документів в xls форматі |
GET /api/eds/doc/reports/doctype |
|
Отримати інформацію про підпис/підписантів |
GET /api/eds/doc/attachment/sign/info |
|
Видалити документи-чернетки |
PATCH /api/eds/docs |
|
Отримати тіло документів (json) за вказаними UUID |
POST /api/v2/eds/doc/content |
|
Відправити транзакції до «Резерву товару» PRDRSRVN (зміни в табличній частині) |
POST /api/eds/doc/prdrsrvn/transaction |
|
Одночасне прийняття, підписання та відправка двох пов’язаних документів |
POST /api/eds/docs_and_tickets |
|
Отримати статус документа |
POST /api/v2/eds/docs/state |
Робота з "Універсальним/неструктурованим документом" (CONDRA)
|
Завантажити «Неструктурований (універсальний) документ» (CONDRA) у вигляді архіву |
GET /api/eds/doc/condra/body |
|
Відправити «Неструктурований (універсальний) документ» (CONDRA) |
PATCH /api/eds/doc/condra/send |
|
Створити чернетку «Універсального/неструктурованого документа» (CONDRA) |
POST /api/v2/eds/doc/condra/create |
|
Створити і відправити «Універсальний/неструктурований документ» (CONDRA) без створення чернетки |
POST /api/v2/eds/doc/condra/create_and_send |
|
Додати файл-вкладення (для CONDRA) |
POST /api/eds/doc/body |
|
Створити чернетку документа (для CONDRA) |
POST /api/eds/doc |
|
Отримати UUID (для CONDRA) |
GET /api/office/uuid |
|
Підписати файл (для CONDRA) |
POST /api/eds/doc/body |
|
Відхилити «Універсальний/неструктурований документ» (CONDRA). Створення квитанції №13 |
PATCH /api/v2/eds/condra/reject |
|
Відкликати «Універсальний/неструктурований документ» (CONDRA). Створення квитанції №14 |
PATCH /api/v2/eds/condra/withdraw |
|
Прийняти «Універсальний/неструктурований документ» (CONDRA) |
PATCH /api/v2/eds/condra/confirm/send |
Робота з файлами (вкладення до документа)
|
Додати файл до документа-чернетки |
POST /api/eds/doc/attachment |
|
Отримати файл-вкладення |
GET /api/eds/doc/attachment |
|
Видалити файл-вкладення (чернетка) |
DELETE /api/eds/doc/attachment |
|
Роздрукувати вкладення документа |
GET /api/eds/doc/print |
|
Додати підпис до вкладень документа-чернетки |
POST /api/eds/doc/attachment/sign |
|
Отримати хеш вкладення (контейнера) документа для підписання |
GET /api/eds/doc/attachment/sign/hash |
Робота з квитанціями
|
Отримати всі квитанції вказаного документа |
GET /api/eds/doc/tickets |
|
Отримати інформацію про підписантів |
GET /api/eds/doc/signers |
|
Отримати інформацію про підписантів за всіма вказаними транзакціями документа |
GET /api/v2/eds/doc/signers |
|
Отримати дані/контент квитанції |
GET /api/eds/doc/ticket/body |
|
Створити на сервері квитанцію «Анулювання» |
GET /api/v2/eds/doc/repeal |
|
Створити на сервері квитанцію «Повідомлення про відмову від підписання документу» (COMDOC_021) для COMDOC/TRANSPORTATIONORDER документів |
GET /api/v2/eds/comdoc/reject |
|
Створити на сервері квитанцію «Повідомлення про відмову від підписання документу» (COMDOC_021) |
GET /api/v2/eds/doc/reject |
|
Створити квитанцію №1 (підпис чернетки) |
POST /api/v2/eds/doc/ticket |
|
Створити квитанцію №2 (прийняття документа COMDOC) |
POST /api/v2/eds/comdoc/accept |
|
Створити квитанцію №11 (запит на анулювання COMDOC/DOCUMENTINVOICE/TRANSPORTATIONORDER) |
POST /api/v2/eds/doc/repeal |
|
Створити квитанцію №12 (прийняття запиту на анулювання COMDOC/DOCUMENTINVOICE/TRANSPORTATIONORDER) |
POST /api/v2/eds/doc/repeal/accept |
|
Створити квитанцію №13 (відхилення документа COMDOC/TRANSPORTATIONORDER) |
POST /api/v2/eds/comdoc/reject |
|
Створити квитанцію №14 (відкликати підписання документа COMDOC/TRANSPORTATIONORDER) |
POST /api/v2/eds/comdoc/revoke |
|
Створити квитанцію №15 (відмова від анулювання COMDOC/DOCUMENTINVOICE/TRANSPORTATIONORDER) |
POST /api/v2/eds/doc/repeal/reject |
|
Відправити відмову від підписання (створення квитанції №13) |
POST /api/v2/eds/doc/reject |
|
Створити на сервері квитанцію «Відкликання підписання документа» (COMDOC_021) |
GET /api/v2/eds/doc/revoke |
|
Створити квитанцію №14 (відкликати підписання документа COMDOC/TRANSPORTATIONORDER) |
POST /api/v2/eds/doc/revoke |
Робота з тегами
|
Створити новий тег (мітку) |
POST /api/eds/tags |
|
Отримати список тегів (міток) |
GET /api/eds/tags |
|
Редагувати тег |
PUT /api/eds/tags |
|
Видалити теги |
DELETE /api/eds/tags |
|
Прив'язати тег до документа |
POST /api/eds/doc/tags |
|
Вилучити теги з документа |
DELETE /api/eds/doc/tags |
Погодження
|
Створити сценарій погодження документів |
POST /api/eds/doc/approval/scenario |
|
Отримати сценарій/-ії (на рівні GLN) |
GET /api/eds/doc/approval/scenario |
|
Редагувати / видалити сценарій погодження документів |
PUT /api/eds/doc/approval/scenario |
|
Запуск документа на погодження / Зміна статуса кроку погодження |
POST /api/eds/doc/approval/step |
|
Отримати кроки погодження за документом |
GET /api/eds/doc/approval/step |
Робота з подіями
- Обираєте ідентифікатор документу, з якого Ви плануєте розпочати отримувати всі наступні події.
- Надсилаєте запит на отримання останнього ідентифікатора події за документом.
- В отриманному у відповідь об'єкті XEvent зберігаєте значення параметра id.
- Надсилаєте запит для пошуку подій. В об'єкті запиту EventsStorageQuery, в параметрі fromId вказуєте ідентифікатор події, який Ви отримали в пункті 3.
- З отриманного у відповідь об'єкта EventsStorageQueryResult зберігаєте значення параметра lastEventId замість того, що зберегли в пункті 3.
- Опрацьовуєте документи в EventsStorageQueryResult.
- Якщо кількість значень в параметрі items об'єкта EventsStorageQueryResult:
-
- дорівнює вказаному ліміту (limit) або рівне 100, то повторюйте операції з 4 по 7.
- меньше вказаного ліміту (limit) або менше 100, то необхідно зробити паузу (1 хвилина) для подальшого виконання операцій з 4 по 7.
|
Отримати останню подію за документом
|
GET /api/eds/docs/event/last |
|
Отримати список подій
|
GET /api/eds/docs/events |
|
Пошук подій
|
POST /api/eds/docs/events |
Алгоритми обміну документами (API)
Алгоритм «Прайс-лист» (PRICAT)
PRICAT
Можливо налаштувати процес відправки документа з окремою дією створення чернетки або без неї:
| № кроку | МЕРЕЖА |
| 1.1 | Авторизація |
| а) | Варіант 1: Відправка документа зі створенням чернетки |
| 1.2 | Створення чернетки документа extra |
| 1.3 | Відправка чернетки документа |
| б) | Варіант 2: Відправка документа без створення чернетки |
| 1.2 | Відправка документа без створення чернетки |
| ПОСТАЧАЛЬНИК | |
| 2.1 | Авторизація |
| 2.2 | Отримання контента документа |
[extra] - В алгоритмах з початковим створенням чернетки можливо організувати додаткову перевірку і редагування чернетки документа (за необхідності) іншими співробітниками Вашої компанії:
Алгоритм «Замовлення» (ORDER)
ORDER
Можливо налаштувати процес відправки документа з окремою дією створення чернетки або без неї:
| № кроку | МЕРЕЖА |
| 1.1 | Авторизація |
| а) | Варіант 1: Відправка документа зі створенням чернетки |
| 1.2 | Створення чернетки документа extra |
| 1.3 | Відправка чернетки документа |
| б) | Варіант 2: Відправка документа без створення чернетки |
| 1.2 | Відправка документа без створення чернетки |
| ПОСТАЧАЛЬНИК | |
| 2.1 | Авторизація |
| 2.2 | Отримання контента документа |
[extra] - В алгоритмах з початковим створенням чернетки можливо організувати додаткову перевірку і редагування чернетки документа (за необхідності) іншими співробітниками Вашої компанії:
Алгоритм «Підтвердження замовлення» (ORDRSP)
ORDRSP
Можливо налаштувати процес відправки документа з окремою дією створення чернетки або без неї:
| № кроку | МЕРЕЖА |
| 1.1 | Авторизація |
| а) | Варіант 1: Відправка документа зі створенням чернетки |
| 1.2 | Створення чернетки документа extra |
| 1.3 | Відправка чернетки документа |
| б) | Варіант 2: Відправка документа без створення чернетки |
| 1.2 | Відправка документа без створення чернетки |
| ПОСТАЧАЛЬНИК | |
| 2.1 | Авторизація |
| 2.2 | Отримання контента документа |
[extra] - В алгоритмах з початковим створенням чернетки можливо організувати додаткову перевірку і редагування чернетки документа (за необхідності) іншими співробітниками Вашої компанії:
Алгоритм «Повідомлення про відвантаження» (DESADV)
DESADV
Можливо налаштувати процес відправки документа з окремою дією створення чернетки або без неї:
| № кроку | МЕРЕЖА |
| 1.1 | Авторизація |
| а) | Варіант 1: Відправка документа зі створенням чернетки |
| 1.2 | Створення чернетки документа extra |
| 1.3 | Відправка чернетки документа |
| б) | Варіант 2: Відправка документа без створення чернетки |
| 1.2 | Відправка документа без створення чернетки |
| ПОСТАЧАЛЬНИК | |
| 2.1 | Авторизація |
| 2.2 | Отримання контента документа |
[extra] - В алгоритмах з початковим створенням чернетки можливо організувати додаткову перевірку і редагування чернетки документа (за необхідності) іншими співробітниками Вашої компанії:
Алгоритм «Повідомлення про прийом» (RECADV)
RECADV
Можливо налаштувати процес відправки документа з окремою дією створення чернетки або без неї:
| № кроку | МЕРЕЖА |
| 1.1 | Авторизація |
| а) | Варіант 1: Відправка документа зі створенням чернетки |
| 1.2 | Створення чернетки документа extra |
| 1.3 | Відправка чернетки документа |
| б) | Варіант 2: Відправка документа без створення чернетки |
| 1.2 | Відправка документа без створення чернетки |
| ПОСТАЧАЛЬНИК | |
| 2.1 | Авторизація |
| 2.2 | Отримання контента документа |
[extra] - В алгоритмах з початковим створенням чернетки можливо організувати додаткову перевірку і редагування чернетки документа (за необхідності) іншими співробітниками Вашої компанії:
Алгоритм «Видаткова накладна» (COMDOC_006)
COMDOC_006
Можливо налаштувати процес відправки документа з окремою дією створення чернетки або без неї:
| № кроку | ПОСТАЧАЛЬНИК |
| 1.1 | Авторизація |
| а) | Варіант 1: Відправка документа зі створенням чернетки |
| 1.2 | Створення чернетки документа |
| 1.3 | Підписання чернетки документа |
| 1.4 | Відправка підписаної чернетки документа |
| б) | Варіант 2: Відправка документа без створення чернетки |
| 1.2 | Відправка вже підписаного документа (.p7s) без створення чернетки |
| 1.5* | Відкликання підписання COMDOC документа |
| МЕРЕЖА | |
| 2.1 | Авторизація |
| 2.2 | Отримання контента документа |
| 2.3 | Підписання вхідного документа |
| 2.3* | Відхилення підписання COMDOC документа |
| ІНІЦІАТОР АНУЛЮВАННЯ | |
| 3.1* | Авторизація Ініціатора |
| 3.2* | Створення запиту на анулювання COMDOC документа Ініціатором |
| ОТРИМУВАЧ АНУЛЮВАННЯ | |
| 4.1 | Авторизація Отримувача |
| 4.2 | Відмова від анулювання COMDOC документа Отримувачем |
| 4.2* | Приймання анулювання COMDOC документа Отримувачем |
Алгоритм «Акт про виявлені недоліки» (COMDOC_005)
COMDOC_005
Можливо налаштувати процес відправки документа з окремою дією створення чернетки або без неї:
| № кроку | ПОСТАЧАЛЬНИК |
| 1.1 | Авторизація |
| а) | Варіант 1: Відправка документа зі створенням чернетки |
| 1.2 | Створення чернетки документа |
| 1.3 | Підписання чернетки документа |
| 1.4 | Відправка підписаної чернетки документа |
| б) | Варіант 2: Відправка документа без створення чернетки |
| 1.2 | Відправка вже підписаного документа (.p7s) без створення чернетки |
| 1.5* | Відкликання підписання COMDOC документа |
| МЕРЕЖА | |
| 2.1 | Авторизація |
| 2.2 | Отримання контента документа |
| 2.3 | Підписання вхідного документа |
| 2.3* | Відхилення підписання COMDOC документа |
| ІНІЦІАТОР АНУЛЮВАННЯ | |
| 3.1* | Авторизація Ініціатора |
| 3.2* | Створення запиту на анулювання COMDOC документа Ініціатором |
| ОТРИМУВАЧ АНУЛЮВАННЯ | |
| 4.1 | Авторизація Отримувача |
| 4.2 | Відмова від анулювання COMDOC документа Отримувачем |
| 4.2* | Приймання анулювання COMDOC документа Отримувачем |
Алгоритм «Коригування видаткової накладної» (COMDOC_038)
COMDOC_038
Можливо налаштувати процес відправки документа з окремою дією створення чернетки або без неї:
| № кроку | ПОСТАЧАЛЬНИК |
| 1.1 | Авторизація |
| а) | Варіант 1: Відправка документа зі створенням чернетки |
| 1.2 | Створення чернетки документа |
| 1.3 | Підписання чернетки документа |
| 1.4 | Відправка підписаної чернетки документа |
| б) | Варіант 2: Відправка документа без створення чернетки |
| 1.2 | Відправка вже підписаного документа (.p7s) без створення чернетки |
| 1.5* | Відкликання підписання COMDOC документа |
| МЕРЕЖА | |
| 2.1 | Авторизація |
| 2.2 | Отримання контента документа |
| 2.3 | Підписання вхідного документа |
| 2.3* | Відхилення підписання COMDOC документа |
| ІНІЦІАТОР АНУЛЮВАННЯ | |
| 3.1* | Авторизація Ініціатора |
| 3.2* | Створення запиту на анулювання COMDOC документа Ініціатором |
| ОТРИМУВАЧ АНУЛЮВАННЯ | |
| 4.1 | Авторизація Отримувача |
| 4.2 | Відмова від анулювання COMDOC документа Отримувачем |
| 4.2* | Приймання анулювання COMDOC документа Отримувачем |
Опис помилок сервісу «EDI Network»
На цій сторінці наданий опис специфічних помилок сервісу «EDI Network». Опис загальних помилок для всіх сервісів EDIN можна знайти за посиланням.
|
Код відповіді |
Індекс помилки |
Текст помилки |
Опис |
|
400 |
ERR_EDI-1 |
Validation document errors: [%s] Документ містить помилки: [%s] |
Помилка при перевірці обов'язкових тегів в xml - в дужках перелік незаповнених/некоректно заповнених полів |
|
400 |
ERR_EDI-2 |
XSD Validation document error: [%s] Помилка валідації документа за XSD: [%s] |
Помилка при валідації по xsd - в дужках вказується конкретна причина помилки |
|
400 |
ERR_EDI-3 |
Business logic validation document errors: [%s] Документ містить помилки згідно бізнес-логіки: [%s] |
Помилка при перевірці обов'язкових тегів в xml згідно бізнес-логіки - в дужках перелік незаповнених/ некоректно заповнених полів |
|
400 |
ERR_EDI-4 |
Unknown or unsupported document type: [%s] Невідомий або непідтримуваний тип документа: [%s] |
Помилка виникає тільки в 1-му випадку: при спробі відправити документ CONDRA методом create_and_send |
|
400 |
ERR_EDI-5 |
Помилка виникає при перевірці підпису, якщо позначка часу створена офлайн |
|
|
400 |
ERR_EDI-6 |
Data should contain [%s] marker Данні мають містити [%s] маркер |
Помилка виникає при спробі дешифрування даних, якщо дані не містять крипто-заголовки (CERTCRYPT або UA1_CRYPT) |
|
400 |
ERR_EDI-7 |
Data should be enveloped (crypted) Дані повинні бути захищені (зашифровані) |
Помилка виникає при спробі дешифрування даних, якщо дані не зашифровані |
|
400 |
ERR_EDI-8 |
Decription failed - [%s] Не вдалося розшифрувати - [%s] |
Помилка виникає при спробі дешифрування даних, якщо при дешифруванні виникає помилка - в дужках причина |
|
400 |
ERR_EDI-9 |
The data is not signed or contains an incorrect signature Дані не підписані або містять некоректний підпис |
Помилка виникає коли клієнт передав не підписані або не коректно підписані дані, коли вони мають бути підписані (наприклад, роут create_and_send при відправці p7s-ки, вказуючи content-type = application/pkcs7-signature) |
|
400 |
ERR_EDI-10 |
You cannot send a document signed only with a seal Ви не можете надіслати документ, підписаний тільки печаткою |
|
|
400 |
ERR_EDI-11 |
GLN from request [%s] should match sender’s GLN from body [%s] GLN із запиту [%s] має збігатися з GLN відправника з тіла [%s] |
Помилка виникає в create_and_send або роуті створення документа через API, коли є невідповідність GLN-ів, який був переданий в url-параметрі і GLN відправника в тілі документа |
|
400 |
ERR_EDI-12 |
Sender GLN cannot be same as recipient GLN GLN відправника не може збігатись з GLN отримувача |
Помилка виникає в методі create_and_send, коли клієнти відправляють документи самі собі |
|
400 |
ERR_EDI-13 |
Branch uuid [%s] already revoked UUID [%s] гілки уже відкликано |
|
|
400 |
ERR_EDI-14 |
COMDOC [019/021] not yet supported. COMDOC [019/021] ще не підтримується. |
Помилка виникає тільки в 1-му випадку: при спробі відправити цей підтип COMDOC методом create_and_send |
|
400 |
ERR_EDI-15 |
Doc is not in open status Документ не в статусі - чернетка |
Помилка виникає у випадках, коли клієнт хоче додати/видалити вкладення у документа не чернетки (CONDRA) |
|
400 |
ERR_EDI-16 |
Document already revoked, current status: [%s] Документ уже відкликано, поточний статус: [%s] |
Помилка виникає при спробі відправити тікет (прийняти COMDOC, підписати DOCINVOICE і т.д.), що протирічить логіці документообігу |
|
400 |
ERR_EDI-17 |
Document already signed, current status: [%s] Документ уже підписаний, поточний статус: [%s] |
Помилка виникає при спробі відправити тікет (прийняти COMDOC, підписати DOCINVOICE і т.д.), що протирічить логіці документообігу |
|
400 |
ERR_EDI-18 |
Document already both signed, current status: [%s] Документ уже підписаний двома сторонами, поточний статус: [%s] |
Помилка виникає при спробі відправити тікет (прийняти COMDOC, підписати DOCINVOICE і т.д.), що протирічить логіці документообігу |
|
400 |
ERR_EDI-19 |
Document already сanceled, current status: [%s] Документ уже анульовано, поточний статус: [%s] |
Помилка виникає при спробі відправити тікет (прийняти COMDOC, підписати DOCINVOICE і т.д.), що протирічить логіці документообігу |
|
400 |
ERR_EDI-20 |
Document already repealed, current status: [%s] Документ уже скасовано, поточний статус: [%s] |
Помилка виникає при спробі відправити тікет (прийняти COMDOC, підписати DOCINVOICE і т.д.), що протирічить логіці документообігу |
|
400 |
ERR_EDI-21 |
Document already has repeal request, current status: [%s] Документ уже має запит на скасування, поточний статус: [%s] |
Помилка виникає при спробі відправити тікет (прийняти COMDOC, підписати DOCINVOICE і т.д.), що протирічить логіці документообігу |
|
400 |
ERR_EDI-22 |
Document has no repeal request, current status: [%s] Документ не має запиту на скасування, поточний статус: [%s] |
Помилка виникає при спробі відправити тікет (прийняти COMDOC, підписати DOCINVOICE і т.д.), що протирічить логіці документообігу |
|
400 |
ERR_EDI-23 |
Document’s repeal already rejected, current status: [%s] Скасування документа уже відхилено, поточний статус: [%s] |
Помилка виникає при спробі відправити тікет (прийняти COMDOC, підписати DOCINVOICE і т.д.), що протирічить логіці документообігу |
|
400 |
ERR_EDI-24 |
DocumentInvoice parties do not contain certificate’s EDRPOU: [%s] Сторони DocumentInvoice не містять ЄДРПОУ з сертифіката: [%s] |
|
|
400 |
ERR_EDI-25 |
DocumentInvoice parties do not contain certificate’s DRFO: [%s] Сторони DocumentInvoice не містять ДРФО з сертифіката: [%s] |
|
|
400 |
ERR_EDI-26 |
There is no EDRPOU/DRFO code in the signature certificate У сертифікаті підпису відсутні коди ЄДРПОУ/ДРФО |
|
|
400 |
ERR_EDI-27 |
COMDOC parties do not contain certificate’s EDRPOU: [%s] Сторони COMDOC не містять ЄДРПОУ з сертифіката: [%s] |
|
|
400 |
ERR_EDI-28 |
The signing key is not on a secure medium. Please select a different key and try again Ключ для підписання, що використовується, знаходиться не на захищеному носії. Виберіть, будь ласка, інший ключ і спробуйте ще раз |
|
|
400 |
ERR_EDI-29 |
There is no signer position in the key. Please select a different key and try again У ключі немає посади підписувача. Виберіть, будь ласка, інший ключ і спробуйте ще раз |
|
|
400 |
ERR_EDI-30 |
The document does not contain sender’s signatures. Change the settings of your signature module to create a signature online. Or contact technical support for advice. Документ не містить підписів відправника. Змініть налаштування свого модуля підписання для створення підпису онлайн. Або зверніться до служби технічної підтримки для консультації. |
|
|
400 |
ERR_EDI-31 |
[signs] is empty [signs] порожній |
Помилка виникає в роутах при роботі з тікетами (створення, відхилення документа, прийняття COMDOC і т.д.), у разі якщо клієнт користується застарілим способом передачі тіла, використовуючи об'єкт TicketRequestData і не передавши в json-і [signs] |
|
400 |
ERR_EDI-32 |
Field [%s] is required Поле [%s] є обов’язковим |
Помилка виникає тільки в роуті POST /api/eds/doc/archive, якщо в об’єкті DocumentStorageQuery не передано - direction або type, або docDate |
|
400 |
ERR_EDI-33 |
Expected non-empty list of uuids Cписок uuid не може бути пустим |
Помилка виникає тільки в роуті - /api/v2/eds/doc/content, якщо список uuid-ів порожній |
|
400 |
ERR_EDI-34 |
The size of the list cannot be more than [%s] Розмір списку не може перевищувати [%s] |
Помилка виникає тільки в роуті /api/v2/eds/doc/content, якщо в списку значень UUID більше ніж 50 |
|
400 |
ERR_EDI-35 |
Report’s start date [%s] cannot be more than end date [%s] Дата початку звіту [%s] не може перевищувати дату завершення [%s] |
Помилка виникає в роутах формування звітів |
|
400 |
ERR_EDI-36 |
Date range (from [%s] to [%s]) cannot be more than 31 days Діапазон дат (від [%s] до [%s]) не може перевищувати 31 день |
Помилка виникає в роутах формування звітів |
|
400 |
ERR_EDI-37 |
Report can be created based on only one parameter: sender OR recipient OR partner Звіт можна створити лише за одним параметром: sender OR recipient OR partner |
Помилка виникає в роутах формування звітів |
|
400 |
ERR_EDI-38 |
Content from request does not match original content, actual_hash:[%s] request_hash:[%s], actualContentHash Контент запиту не відповідає оригінальному контенту, actual_hash:[%s] request_hash:[%s], actualContentHash |
Помилка виникає, якщо хеш контенту в eds не відповідають хешу контенту з тіла запиту (це про підписання документів у відповідь) |
|
400 |
ERR_EDI-39 |
Signs count should be more than parent data signs count Кількість підписів повинна бути більшою, ніж у батьківській квитанції |
|
|
400 |
ERR_EDI-40 |
[subjEDRPOUCode] from sign does not match any of [КодКонтрагента] or [ІПН] from XML [subjEDRPOUCode] із підпису не відповідає жодному з [КодКонтрагента] або [ІПН] із XML |
|
|
400 |
ERR_EDI-41 |
Incorrect document family. One of [%s] is expected Некоректний family документа. Очікується один з наступних: [%s] |
|
|
400 |
ERR_EDI-42 |
Handling sign failed - [%s] Не вдалося опрацювати підпис - [%s] |
Помилка виникає при опрацюванні p7s, зазвичай ці помилки пов’язані з ІІТ бібліотекою |
|
400 |
ERR_EDI-43 |
Ticket with transaction type [%s] not found Квитанцію з типом транзакції [%s] не знайдено |
Помилка виникає в роутах при отриманні інформації по підписантам в тікеті |
|
400 |
ERR_EDI-44 |
XSLT for document type [%s] not found XSLT для типу документа [%s] не знайдено |
Не знайдено карту конвертації |
|
400 |
ERR_EDI-45 |
Can’t define recipient GLN Неможливо визначити GLN одержувача |
Не вдалось визначити отримувача при відправці DOCCORINVOICE |
|
400 |
ERR_EDI-46 |
The document can only be signed by one party Документ може бути підписаний тільки однією стороною |
Відправлений COMDOC містить поле «ОдностороннєПідписання» |
Отримати кроки погодження за документом GET /api/eds/doc/approval/step
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/eds/doc/approval/step |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії doc_uuid (обов’язково) UUID - ідентифікатор документа |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передаються дані кроків погодження (об’єкт з масивами об’єктів XDocApprovalStep).
Приклад відповіді:
{
"1": [
{
"docId": 3580,
"scenarioId": 9,
"stepId": 1,
"userId": 60215367,
"stepStatus": 0,
"operationType": 0,
"dateChanged": 1674072579
}
],
"2": [
{
"docId": 3580,
"scenarioId": 9,
"stepId": 2,
"userId": 50206653,
"stepStatus": 0,
"operationType": 0,
"dateChanged": 1674072579
}
],
"3": [
{
"docId": 3580,
"scenarioId": 9,
"stepId": 3,
"userId": 60215367,
"stepStatus": 0,
"operationType": 0,
"dateChanged": 1674072579
}
]
}
Запуск документа на погодження / Зміна статуса кроку погодження POST /api/eds/doc/approval/step
Для запуску документа на погодження в методі потрібно передавати опціональний параметр scenario_id!
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/eds/doc/approval/step |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії doc_uuid (обов’язково) UUID - ідентифікатор документа scenario_id (обов’язково / опціонально) long - ідентифікатор документа (обов’язково при запуску документа на погодження) id (опціонально) long - номер кроку погодження із сценарію status (опціонально) long - ідентифікатор статусу:
|
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
При відхиленні (status=2) в тілі запиту методу потрібно передавати текстовий коментар - причину відхилення. |
RESPONSE
Код сервера 200 (ok).
Редагувати / видалити сценарій погодження документів PUT /api/eds/doc/approval/scenario
REQUEST
|
URL |
|
|
Метод запиту |
PUT |
|
URL запиту |
/api/eds/doc/approval/scenario |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії id (обов’язково) long - ідентифікатор сценарію до редагування |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передаються дані кроків за сценарієм (об’єкт з масивами об’єктів XDocApprovalScenario) |
RESPONSE
Код сервера 200 (ok).
Отримати сценарій/-ї (на рівні GLN) GET /api/eds/doc/approval/scenario
Метод може бути використаний для отримання всіх сценаріїв (на рівні GLN) або конкретного, якщо в методі передається опціональний параметр id!
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/eds/doc/approval/scenario |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії id (опціонально) long - ідентифікатор сценарію auto (опціонально) boolean - автоматичний запуск погодження (false за замовчуванням). При auto=true повертаються тільки сценарії з автозапуском. doc_type (опціонально) int - тип документа для автопогодження (повертаються сценарії тільки за обраним типом документа). Відпрацьовує лише у зв’язці із auto=true. Можливі значення:
|
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передаються дані сценарію/-їв (об’єкт / масив об’єктів XDocApprovalScenario).
Створити сценарій погодження документів POST /api/eds/doc/approval/scenario
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/eds/doc/approval/scenario |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії name (обов’язково) int - назва сценарію |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передаються дані кроків за сценарієм (об’єкт з масивами об’єктів XDocApprovalScenario) |
RESPONSE
В тілі відповіді передаються дані сценарію (об’єкт XDocApprovalScenario).
Вилучити теги з документа DELETE /api/eds/doc/tags
REQUEST
|
URL |
|
|
Метод запиту |
DELETE |
|
URL запиту |
/api/eds/doc/tags |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; АБО guid (обов’язково) String - унікальний ідентифікатор власної Компанії; doc_id (обов’язково) long - ідентифікатор документа |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту (json) передається масив об’єктів: тегів для видалення з документа. |
RESPONSE
Код сервера 200 (ok).
Прив'язати тег до документа POST /api/eds/doc/tags
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/eds/doc/tags |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; АБО guid (обов’язково) String - унікальний ідентифікатор власної Компанії; doc_id (обов’язково) long - ідентифікатор документа |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту (json) передається масив обʼєктів XTag
Приклад:
|
RESPONSE
У відповіді повертається повідомлення та статус:
| STATUS | Message | Коментар |
| 200 | Запит успішно опрацьовано | Статус заявки змінено на вказаний |
| 500 | Internal Server Error. Chanel ID: 123456 | Непередбачена внутрішня помилка. Необхідно звернутись до тех. підтримки для зʼясування причини помилки. |
Видалити теги DELETE /api/eds/tags
REQUEST
|
URL |
|
|
Метод запиту |
DELETE |
|
URL запиту |
/api/eds/tags |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; АБО guid (обов’язково) String - унікальний ідентифікатор власної Компанії |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту (json) передається масив ідентифікаторів тегів до видалення, наприклад: |
RESPONSE
Код сервера 200 (ok).
Редагувати тег PUT /api/eds/tags
Назва тегу повинна бути унікальною й довжиною не більше 20 символів.
REQUEST
|
URL |
|
|
Метод запиту |
PUT |
|
URL запиту |
/api/eds/tags |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; АБО guid (обов’язково) String - унікальний ідентифікатор власної Компанії |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту (json) передається масив об’єктів: тегів з відредагованими назвами/короткими назвами. |
RESPONSE
Код сервера 200 (ok).
Отримати список тегів (міток) GET /api/eds/tags
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
GET |
|
URL запиту |
/api/eds/tags |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; АБО guid (обов’язково) String - унікальний ідентифікатор власної Компанії; search (опціонально) String - пошук за назвою тега |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді в json форматі передається масив тегів (Обʼєкт XTag), що відповідають пошуковому запиту
[
{
"id": "ід тега",
"name": "назва тега"
},
]
Створити новий тег (мітку) POST /api/eds/tags
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/eds/tags |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; АБО guid (обов’язково) String - унікальний ідентифікатор власної Компанії |
|
HEADERS |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту (json) передається список (масив) назв тегів у вигляді масиву.
Назва тегу (мітки) повинна бути унікальною й довжиною не більше 20 символів.
Приклад: |
RESPONSE
В тілі відповіді в json форматі передається масив створених тегів (Обʼєкт XTag)
[
{
"id": "ід тега",
"name": "назва тега"
},
]
Створити квитанцію №14 (відкликати підписання документа COMDOC/TRANSPORTATIONORDER) POST /api/v2/eds/doc/revoke
Відкликати підписання документа COMDOC/TRANSPORTATIONORDER може лише відправник документа до того, як документ змінить свій стан на:
-
відкликаний (в документа є квитанція №14)
-
відмовлений (в документа є квитанція №13)
-
анульований (в документа є квитанція №12)
-
прийнятий (в документа є квитанція №2)
Значення [ЕлектроннийДокумент/Відхилив/GLN] має відповідати параметру gln в запиті. ЄДРПОУ в підписі має відповідати [КодКонтрагента] або [ІПН] в блоці [ЕлектроннийДокумент/Відхилив]
Метод може бути використаний для відправки Відкликання підписання : Комерційних документів (сімейство COMDOC), Накладних (DOCUMENTINVOICE), Додаток до договору 7А (METRO_7A), Додаток до договору 7Б (METRO_7B), Додаток до договору 7Ц (METRO_7C), «Заявка на транспортування» / «Підтвердження заявки на транспортування» (TRANSPORTATIONORDER).
Для DOCUMENTINVOICE та DOCCORINVOICE (і лише для цих документів) метод може бути виконаний в режимі автоматичного формування і відправки «Повідомлення про відмову від підписання документа» (COMDOC_021) при наявності autoGenerate параметра. За наявності параметра autoGenerate тіло квитанції формується автоматично, але без підпису.
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/v2/eds/doc/revoke |
|
URL параметри |
gln (обов’язково) String (13) - номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні аккаунта doc_uuid (обов’язково) UUID - ідентифікатор документа; лише для DOCUMENTINVOICE/DOCCORINVOICE: autoGenerate (опціонально) - параметр (без значення), що вказує на автоматичне генерування квитанції Відкликання підписання |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
|
|
REQUEST |
|
|
Body |
В тілі запиту методу обов’язково передається:
АБО
|
RESPONSE
В тілі відповіді передаються:
-
chain_uuid - ідентифікатор ланцюжка, в якому знаходиться документ
-
doc_uuid - ідентифікатор документа, якому належить квитанція
-
ticket_uuid - ідентифікатор квитанції
JSON приклад відповіді:
{
"chain_uuid": "7b6aef20-9f42-460e-9031-bb81c91e3b03",
"doc_uuid": "e013510a-4267-4553-80f0-eb5ebabdfd05",
"ticket_uuid": "1003706c-3656-497b-9438-c6f33e27c36d"
}
Створити на сервері квитанцію «Відкликання підписання документа» (COMDOC_021) GET /api/v2/eds/doc/revoke
Цей метод може бути використаний для Відкликання підписання : Комерційних документів (сімейство COMDOC), Накладних (DOCUMENTINVOICE), Додаток до договору 7А (METRO_7A), Додаток до договору 7Б (METRO_7B), Додаток до договору 7Ц (METRO_7C), «Заявка на транспортування» / «Підтвердження заявки на транспортування» (TRANSPORTATIONORDER).
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/v2/eds/doc/revoke |
|
URL параметри |
gln - рядок (13); номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта doc_uuid - рядок; UUID документа reason - text; текст причини відкликання response_type (опціонально) - формат очікуваної відповіді; можливі варіанти:
|
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передається тіло згенерованого COMDOC_021 в json форматі або форматі, обраному в запиті response_type (приклади відповіді + специфікація COMDOC_021).
Відправити відмову від підписання (створення квитанції №13) POST /api/v2/eds/doc/reject
Метод може бути використаний для відправки Відмови від підписання : Комерційних документів (сімейство COMDOC), Накладних (DOCUMENTINVOICE), Додаток до договору 7А (METRO_7A), Додаток до договору 7Б (METRO_7B), Додаток до договору 7Ц (METRO_7C), «Заявка на транспортування» / «Підтвердження заявки на транспортування» (TRANSPORTATIONORDER).
Для DOCUMENTINVOICE та DOCCORINVOICE (і лише для цих документів) метод може бути виконаний в режимі автоматичного формування і відправки «Повідомлення про відмову від підписання документа» (COMDOC_021) при наявності autoGenerate параметра. За наявності параметра autoGenerate тіло квитанції формується автоматично, але без підпису.
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/v2/eds/doc/reject |
|
URL параметри |
gln (обов’язково) String (13) - номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні аккаунта АБО guid (обов’язково) String - унікальний ідентифікатор організації на платформі EDIN 2.0 doc_uuid (обов’язково) UUID - ідентифікатор документа; лише для DOCUMENTINVOICE/DOCCORINVOICE: autoGenerate (опціонально) - параметр (без значення), що вказує на автоматичне генерування xml Повідомлення про відмову від підписання документа (COMDOC_021) |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
|
|
REQUEST |
|
|
Body |
В тілі запиту методу обов’язково передається:
АБО
|
RESPONSE
В тілі відповіді передаються:
-
chain_uuid - ідентифікатор ланцюжка, в якому знаходиться документ
-
doc_uuid - ідентифікатор документа, якому належить квитанція
-
ticket_uuid - ідентифікатор квитанції
JSON приклад відповіді:
{
"chain_uuid": "7b6aef20-9f42-460e-9031-bb81c91e3b03",
"doc_uuid": "e013510a-4267-4553-80f0-eb5ebabdfd05",
"ticket_uuid": "1003706c-3656-497b-9438-c6f33e27c36d"
}
Створити квитанцію №15 (відмова від анулювання COMDOC/DOCUMENTINVOICE/TRANSPORTATIONORDER) POST /api/v2/eds/doc/repeal/reject
Виконати «Відмову від анулювання» документа може лише отримувач «Запиту на анулювання» (є квитанція №11) до того, як документ змінить свій стан на «анульовано» (в документа є квитанція №12).
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/v2/eds/doc/repeal/reject |
|
URL параметри |
gln - рядок (13); номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта doc_uuid - рядок; UUID документа COMDOC/DOCUMENTINVOICE/TRANSPORTATIONORDER |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/xml |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передається непідписаний xml (COMDOC_021 з даними документа підстави і причиною відмови від анулювання в полі «Текст») в бінарному вигляді. Тіло можливо створити методом GET /api/v2/eds/doc/reject |
RESPONSE
В тілі відповіді передаються:
chain_uuid - ідентифікатор ланцюжка, в якому знаходиться документ
doc_uuid - ідентифікатор документа, якому належить квитанція
ticket_uuid - ідентифікатор квитанції
Приклад (JSON):
{
"chain_uuid": "d47a29f6-b208-41a1-bb6e-8f5fc58745cd",
"doc_uuid": "38e37759-825a-4774-a3c3-d77f241253a8",
"ticket_uuid": "111aaeaa-3601-49d9-a5e5-fe2aaebdacdb"
}
Створити квитанцію №14 (відкликати підписання документа COMDOC/TRANSPORTATIONORDER) POST /api/v2/eds/comdoc/revoke
Наполегливо рекомендуємо використовувати замість даного методу новий метод /api/v2/eds/doc/revoke за посиланням.
Відкликати підписання документа COMDOC/TRANSPORTATIONORDER може лише відправник документа до того, як документ змінить свій стан на:
-
відкликаний (в документа є квитанція №14)
-
відмовлений (в документа є квитанція №13)
-
анульований (в документа є квитанція №12)
-
прийнятий (в документа є квитанція №2)
Значення [ЕлектроннийДокумент/Відхилив/GLN] має відповідати параметру gln в запиті. ЄДРПОУ в підписі має відповідати [КодКонтрагента] або [ІПН] в блоці [ЕлектроннийДокумент/Відхилив]
Цей метод може бути виконаний двома способами, що відрізняються набором вхідних параметрів і потребою в передаванні тіла запиту:
Спосіб № 1:
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/v2/eds/comdoc/revoke |
|
URL параметри |
gln - рядок (13); номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта doc_uuid - рядок; UUID документа COMDOC |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/pkcs7-signature or application/xml |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу можуть передаватись:
|
Спосіб № 2:
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/v2/eds/comdoc/revoke |
|
URL параметри |
gln - рядок (13); номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта doc_uuid - рядок; UUID документа COMDOC autoGenerate - параметр (без значення), що вказує на автоматичне генерування квитанції |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
REQUEST |
|
|
Body |
В тілі запиту методу обов’язково передається текст причини відкликання документа. |
RESPONSE
В тілі відповіді передаються:
chain_uuid - ідентифікатор ланцюжка, в якому знаходиться документ
doc_uuid - ідентифікатор документа, якому належить квитанція
ticket_uuid - ідентифікатор квитанції
JSON приклад:
{
"chain_uuid": "7b6aef20-9f42-460e-9031-bb81c91e3b03",
"doc_uuid": "e013510a-4267-4553-80f0-eb5ebabdfd05",
"ticket_uuid": "1003706c-3656-497b-9438-c6f33e27c36d"
}Створити квитанцію №13 (відхилення документа COMDOC/TRANSPORTATIONORDER) POST /api/v2/eds/comdoc/reject
Наполегливо рекомендуємо використовувати замість даного методу новий метод /api/v2/eds/doc/reject за посиланням.
Відхилити документ COMDOC може лише отримувач документа до того, як документ змінить свій стан на:
-
відкликаний (в документа є квитанція №14)
-
відмовлений (в документа є квитанція №13)
-
анульований (в документа є квитанція №12)
-
прийнятий (в документа є квитанція №2)
Значення [ЕлектроннийДокумент/Відхилив/GLN] має відповідати параметру gln в запиті. ЄДРПОУ в підписі має відповідати [КодКонтрагента] або [ІПН] в блоці [ЕлектроннийДокумент/Відхилив]
Цей метод може бути виконаний двома способами, що відрізняються набором вхідних параметрів і потребою в передаванні тіла запиту:
Спосіб № 1:
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/v2/eds/comdoc/reject |
|
URL параметри |
gln - рядок (13); номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта doc_uuid - рядок; UUID документа COMDOC |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/pkcs7-signature or application/xml |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу можуть передаватись:
|
Спосіб № 2:
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/v2/eds/comdoc/reject |
|
URL параметри |
gln - рядок (13); номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта; АБО guid - рядок; унікальний ідентифікатор організації в системі; doc_uuid - рядок; UUID документа COMDOC autoGenerate - параметр (без значення), що вказує на автоматичне генерування квитанції |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
REQUEST |
|
|
Body |
В тілі запиту методу обов’язково передається текст причини відхилення документа |
RESPONSE
В тілі відповіді передаються:
chain_uuid - ідентифікатор ланцюжка, в якому знаходиться документ
doc_uuid - ідентифікатор документа, якому належить квитанція
ticket_uuid - ідентифікатор квитанції
JSON приклад:
{
"chain_uuid": "7b6aef20-9f42-460e-9031-bb81c91e3b03",
"doc_uuid": "e013510a-4267-4553-80f0-eb5ebabdfd05",
"ticket_uuid": "1003706c-3656-497b-9438-c6f33e27c36d"
}Створити квитанцію №12 (прийняття запиту на анулювання COMDOC/DOCUMENTINVOICE/TRANSPORTATIONORDER) POST /api/v2/eds/doc/repeal/accept
Підтвердити (прийняти) запит на анулювання документа неможливо, якщо документ:
-
анульовано (у документа є квитанція №12)
-
відсутнє запрошення анулювання (в документа відсутня квитанція №11)
ЄДРПОУ в підписі має відповідати ЄДРПОУ, зазначеному в документі (наприклад, для COMDOC: [КодКонтрагента] або [ІПН] в одному з блоків [ЕлектроннийДокумент/Сторони/Контрагент])
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/v2/eds/doc/repeal/accept |
|
URL параметри |
gln - рядок (13); номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта doc_uuid - рядок; UUID документа COMDOC/DOCUMENTINVOICE/TRANSPORTATIONORDER |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/pkcs7-signature |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передаються підписані дані p7s в бінарному вигляді. Тобто передається підписане з Вашої сторони вхідне тіло документа до анулювання. |
RESPONSE
В тілі відповіді передаються:
chain_uuid - ідентифікатор ланцюжка, в якому знаходиться документ
doc_uuid - ідентифікатор документа, якому належить квитанція
ticket_uuid - ідентифікатор квитанції
JSON приклад:
{
"chain_uuid": "7b6aef20-9f42-460e-9031-bb81c91e3b03",
"doc_uuid": "e013510a-4267-4553-80f0-eb5ebabdfd05",
"ticket_uuid": "1003706c-3656-497b-9438-c6f33e27c36d"
}
Створити квитанцію №11 (запит на анулювання COMDOC/DOCUMENTINVOICE/TRANSPORTATIONORDER) POST /api/v2/eds/doc/repeal
Створити запит на анулювання документа неможливо, якщо документ знаходиться в стані:
-
відкликаний (в документа є квитанція №14)
-
відмовлений (в документа є квитанція №13)
-
запрошено анулювання (в документа є квитанція №11)
ЄДРПОУ в підписі має відповідати ЄДРПОУ, зазначеному в документі (наприклад, для COMDOC: [КодКонтрагента] або [ІПН] в одному з блоків [ЕлектроннийДокумент/Сторони/Контрагент])
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/v2/eds/doc/repeal |
|
URL параметри |
gln - рядок (13); номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта doc_uuid - рядок; UUID документа COMDOC/DOCUMENTINVOICE/TRANSPORTATIONORDER |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/pkcs7-signature |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передаються підписані дані p7s в бінарному вигляді. Тобто передається підписане xml тіло, отримане в результаті виконання методу GET /api/v2/eds/doc/repeal) |
RESPONSE
В тілі відповіді передаються:
chain_uuid - ідентифікатор ланцюжка, в якому знаходиться документ
doc_uuid - ідентифікатор документа, якому належить квитанція
ticket_uuid - ідентифікатор квитанції
JSON приклад:
{
"chain_uuid": "7b6aef20-9f42-460e-9031-bb81c91e3b03",
"doc_uuid": "e013510a-4267-4553-80f0-eb5ebabdfd05",
"ticket_uuid": "1003706c-3656-497b-9438-c6f33e27c36d"
}
Створити квитанцію №2 (прийняття документа COMDOC) POST /api/v2/eds/comdoc/accept
Прийняти документ COMDOC може лише отримувач документа до того, як документ змінить свій стан на:
-
відкликаний (в документа є квитанція №14)
-
відмовлений (в документа є квитанція №13)
-
анульований (в документа є квитанція №12)
-
прийнятий (в документа є квитанція №2)
ЄДРПОУ в підписі має відповідати [КодКонтрагента] або [ІПН] в одному з блоків [ЕлектроннийДокумент/Сторони/Контрагент]
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/v2/eds/comdoc/accept |
|
URL параметри |
gln - рядок (13); номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта doc_uuid - рядок; UUID документа COMDOC |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/pkcs7-signature |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передаються підписані дані p7s в бінарному вигляді |
RESPONSE
В тілі відповіді передаються:
chain_uuid - ідентифікатор ланцюжка, в якому знаходиться документ
doc_uuid - ідентифікатор документа, якому належить квитанція
ticket_uuid - ідентифікатор квитанції
Приклад (JSON):
{
"chain_uuid": "7b6aef20-9f42-460e-9031-bb81c91e3b03",
"doc_uuid": "e013510a-4267-4553-80f0-eb5ebabdfd05",
"ticket_uuid": "1003706c-3656-497b-9438-c6f33e27c36d"
}
Створити квитанцію №1 (підпис чернетки) POST /api/v2/eds/doc/ticket
За допомогою цього методу можливо підписати чернетку документа (COMDOC, DECLAR, DECLARJ12, DOCUMENTINVOICE, KORINVOICE, DOCCORINVOICE, TRANSPORTATIONORDER).
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/v2/eds/doc/ticket |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; АБО guid (обов’язково) String - унікальний ідентифікатор власної Компанії; doc_uuid (обов’язково) String - унікальний ідентифікатор документа |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передаються дані для здійснення операції підписання |
RESPONSE
-
chain_uuid - ідентифікатор ланцюжка, в якому знаходиться документ
-
doc_uuid - ідентифікатор документа на платформі EDIN 2.0;
-
ticket_uuid - ідентифікатор квитанції
JSON приклад відповіді:
{
"chain_uuid": "7ccff78e-ea42-47ea-81e4-5508ed4fbd51",
"doc_uuid": "3698b501-e1ef-464d-a71a-58066f556114",
"ticket_uuid": "1003706c-3656-497b-9438-c6f33e27c36d"
}
Створити на сервері квитанцію «Повідомлення про відмову від підписання документу» (COMDOC_021) GET /api/v2/eds/doc/reject
Метод GET api/v2/eds/doc/reject може бути використаний для Відмови від підписання : Комерційних документів (сімейство COMDOC), Накладних (DOCUMENTINVOICE), Додаток до договору 7А (METRO_7A), Додаток до договору 7Б (METRO_7B), Додаток до договору 7Ц (METRO_7C), «Заявка на транспортування» / «Підтвердження заявки на транспортування» (TRANSPORTATIONORDER).
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/v2/eds/doc/reject |
|
URL параметри |
gln - рядок (13); номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта doc_uuid - рядок; UUID документа COMDOC reason - text; текст причини відмови/анулювання response_type (опціонально) - формат очікуваної відповіді; можливі варіанти:
|
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передається тіло згенерованого:
-
COMDOC_021 для анулювання Комерційних документів (COMDOC)
-
DOCUMENTINVOICE з DocumentFunctionCode=CNCL і сегментом Repealer для анулювання накладних DOCUMENTINVOICE
-
TRANSPORTATIONORDER для анулювання «Заявки на транспортування» / «Підтвердження заявки на транспортування»
в json форматі або форматі, обраному в запиті response_type (приклади відповіді).
Створити на сервері квитанцію «Повідомлення про відмову від підписання документу» (COMDOC_021) для COMDOC/TRANSPORTATIONORDER документів GET /api/v2/eds/comdoc/reject
Наполегливо рекомендуємо використовувати замість даного методу новий метод /api/v2/eds/doc/reject за посиланням.
За допомогою GET методу api/v2/eds/comdoc/reject можливо створити документ COMDOC-відмову.
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/v2/eds/comdoc/reject |
|
URL параметри |
gln - рядок (13); номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта doc_uuid - рядок; UUID документа COMDOC reason - text; текст причини відмови/анулювання response_type (опціонально) - формат очікуваної відповіді; можливі варіанти:
|
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передається тіло згенерованого COMDOC_021 в json форматі або форматі, обраному в запиті response_type (приклади відповіді + специфікація COMDOC_021)».
Створити на сервері квитанцію «Анулювання» GET /api/v2/eds/doc/repeal
За допомогою цього методу можливо створити квитанцію для подальшого запуску «Анулювання».
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/v2/eds/doc/repeal |
|
URL параметри |
gln - рядок (13); номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта; doc_uuid - рядок; UUID документа, до якого потрібно виконати анулювання; reason - text; текст причини відмови/анулювання; response_type (опціонально) - формат очікуваної відповіді; можливі варіанти:
|
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передається тіло згенерованого:
-
COMDOC_019 для анулювання Комерційних документів (COMDOC)
-
DOCUMENTINVOICE з DocumentFunctionCode=RPLN і сегментом Repealer для анулювання накладних DOCUMENTINVOICE
-
TRANSPORTATIONORDER для анулювання «Заявки на транспортування» / «Підтвердження заявки на транспортування»
в json форматі або форматі обраному в запиті response_type (приклади відповіді).
Отримати дані/контент квитанції GET /api/eds/doc/ticket/body
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/eds/doc/ticket/body |
|
URL параметри |
gln - рядок (13); номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта; АБО guid - рядок; унікальний ідентифікатор організації в системі doc_uuid - рядок; UUID документа transaction_type - число; тип транзакції
body_type - число; тип тіла квитанції (індекс контента)
family (опціонально) - сімейство; можливі значення: edi |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/octet-stream |
RESPONSE
В тілі відповіді в залежності від параметра body_type передаються дані підпису (json) або контент підпису (base64).
Отримати інформацію про підписантів за всіма вказаними транзакціями документа GET /api/v2/eds/doc/signers
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/v2/eds/doc/signers |
|
URL параметри |
gln (обов’язково) String (13) - номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта; АБО guid (обов’язково) String - унікальний ідентифікатор організації в системі; doc_uuid (обов’язково) String - UUID документа; transaction_type (обов’язково) int - тип транзакції (параметр можливо передавати списком):
|
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передається інформація про підписантів (об’єкт, що містить перелік номерів вказних в запиті транзакцій та масив об’єктів ExEndUserSignInfo з даними підписантів до кожної вказаної транзакції).
Отримати інформацію про підписантів GET /api/eds/doc/signers
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/eds/doc/signers |
|
URL параметри |
gln - рядок (13); номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта; АБО guid - рядок; унікальний ідентифікатор організації в системі doc_uuid - рядок; UUID документа transaction_type - число; тип транзакції
|
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передається інформація про підписантів (масив об’єктів ExEndUserSignInfo ).
Якщо в квитанції відсутнє тіло з типом транзакції 1 і більше, то у відповіді методу передається порожній масив підписантів (наприклад, при відкликанні підписання документа COMDOC).
Отримати всі квитанції вказаного документа GET /api/eds/doc/tickets
REQUEST
|
URL |
|
|
Метод запиту |
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 передаються масив об’єктів (квитанції вказаного документа) в json форматі чи у вигляді zip-архіву.
Отримати хеш вкладення (контейнера) документа для підписання GET /api/eds/doc/attachment/sign/hash
Реалізовано на даний момент для наступних документів: Універсальний/неструктурований документ (CONDRA)
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/eds/doc/attachment/sign/hash |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; АБО guid (обов’язково) String - унікальний ідентифікатор власної Компанії; attachment_uuid (обов’язково) UUID - ідентифікатор файла-вкладення (параметр attachmentUUID в тілі відповіді при додаванні файла) |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді в текстовому вигляді передається хеш вкладення (контейнера) документа для підписання:
mIDIAXJ6vWVwiuQ1LZ7pNxjOO1b/JuevNmRzfrUtpjU=
Додати підпис до вкладень документа-чернетки POST /api/eds/doc/attachment/sign
Реалізовано на даний момент для наступних документів: Універсальний/неструктурований документ (CONDRA)
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/eds/doc/attachment/sign |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; АБО guid (обов’язково) String - унікальний ідентифікатор власної Компанії; attachment_uuid (обов’язково) UUID - ідентифікатор файла-вкладення (параметр attachmentUUID в тілі відповіді при додаванні файла) |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передається файл підпису p7s в base64 форматі. |
RESPONSE
Код сервера 200 (ok).
Роздрукувати вкладення документа GET /api/eds/doc/print
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/eds/doc/print |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії АБО guid (обов’язково) String - унікальний ідентифікатор власної організації на платформі; doc_uuid (обов’язково) - рядок; UUID документа response_type (опціонально) - MIME типізація згідно типу файлу-вкладення attachment_uuid (обов’язково) UUID - ідентифікатор файла-вкладення (параметр attachmentUUID в тілі відповіді при додаванні файла) |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
MIME типізація згідно типу файлу-вкладення |
RESPONSE
В тілі відповіді передається принт-форма вкладення документа.
Видалити файл-вкладення (чернетка) DELETE /api/eds/doc/attachment
Кожен раз при видаленні одного вкладення підписи всіх інших вкладень документа видаляються.
REQUEST
|
URL |
|
|
Метод запиту |
DELETE |
|
URL запиту |
/api/eds/doc/attachment |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії АБО guid (обов’язково) String - унікальний ідентифікатор власної організації на платформі; attachment_uuid (обов’язково) UUID - ідентифікатор файла-вкладення (параметр attachmentUUID в тілі відповіді при додаванні файла) doc_uuid (обов’язково) UUID - ідентифікатор документа |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
Код сервера 200 (ok).
Отримати файл-вкладення GET /api/eds/doc/attachment
Реалізовано на даний момент для наступних документів: Універсальний/неструктурований документ (CONDRA)
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/eds/doc/attachment |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії АБО guid (обов’язково) String - унікальний ідентифікатор власної організації на платформі; attachment_uuid (обов’язково) UUID - ідентифікатор файла-вкладення (параметр attachmentUUID в тілі відповіді при додаванні файла) |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
MIME типізація згідно типу файлу-вкладення |
RESPONSE
В тілі відповіді передається файл-вкладення.
Додати файл до документа-чернетки POST /api/eds/doc/attachment
Реалізовано на даний момент для наступних документів: Універсальний/неструктурований документ (CONDRA)
Один документ може містити не більше 10 файлів в наступних форматах: PDF/XLS/XLSX/DOC/DOCX/ODT/PPT/PPTX/JPG/BMP/PNG/XML/P7S з розміром файлу не більше 5 Мб. Назва файла не повинна перевищувати 100 символів. Кожен раз при додаванні нового вкладення підписи всіх інших вкладень документа видаляються.
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/eds/doc/attachment |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії АБО guid (обов’язково) String - унікальний ідентифікатор власної організації на платформі; doc_uuid (обов’язково) UUID - ідентифікатор документа |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
multipart/form-data |
|
REQUEST |
|
|
Form-data |
В тілі запиту передається 1 файл. |
Приклад запиту:
boundary=----15217883902974046383107741460
----15217883902974046383107741460
Content-Disposition: form-data; name="file"; filename="name.pdf"
Content-Type: application/pdf
(data)
----15217883902974046383107741460
Прийняти документ (CONDRA) PATCH /api/v2/eds/condra/confirm/send
Підтвердити можна лише вхідний документ, за яким ще не відбувалось Підтвердження / Відхилення / Відкликання!
|
URL |
|
|
Метод запиту |
PATCH |
|
URL запиту |
/api/v2/eds/condra/confirm/send |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії АБО guid (обов’язково) String - унікальний ідентифікатор власної організації на платформі; doc_uuid - рядок; UUID документа |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передається тіло документа в xml форматі (специфікація документа CONDRA). |
RESPONSE
Код сервера 200 (ok).
Відкликати документ (CONDRA). Створення квитанції №14. PATCH /api/v2/eds/condra/withdraw
Відкликати можна лише надісланий документ, за яким ще не відбувалось Підтвердження / Відхилення / Відкликання!
REQUEST
|
URL |
|
|
Метод запиту |
PATCH |
|
URL запиту |
/api/v2/eds/condra/withdraw |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії АБО guid (обов’язково) String - унікальний ідентифікатор власної організації на платформі; doc_uuid (обов’язково) UUID - ідентифікатор документа |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передається тіло документа в xml форматі (специфікація документа CONDRA). |
RESPONSE
В тілі відповіді передаються дані створеної квитанції документа (об’єкт XTicket).
Відхилити документ (CONDRA). Створення квитанції №13. PATCH /api/v2/eds/condra/reject
Відхилити можливо лише вхідний документ, за яким ще не відбувалось Підтвердження / Відхилення / Відкликання!
REQUEST
|
URL |
|
|
Метод запиту |
PATCH |
|
URL запиту |
/api/v2/eds/condra/reject |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії АБО guid (обов’язково) String - унікальний ідентифікатор власної організації на платформі; doc_uuid (обов’язково) UUID - ідентифікатор документа message (обов’язково) String - причина відхилення документа |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/xml |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передається тіло документа в xml форматі (специфікація документа CONDRA). |
RESPONSE
В тілі відповіді передаються дані створеної квитанції документа (об’єкт XTicket ).
Підписати файл (для CONDRA) POST /api/eds/doc/body
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/eds/doc/body |
|
URL параметри |
gln (обов’язково) рядок (13) - номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні аккаунта АБО guid (обов’язково) String - унікальний ідентифікатор організації на платформі EDIN 2.0 doc_uuid (обов’язково) UUID - ідентифікатор документа family (опціонально) int - сервіс (сімейство); допустимі значення:
content_type (обов’язково) String – тип тіла контента; можливі значення: hash_sign (константа) body_type (обов’язково) String - тип тіла документа; можливі значення:
|
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
text/plain |
|
REQUEST |
|
|
Body |
В тілі запиту методу передається p7s файл підпису в бінарному вигляді. |
RESPONSE
Код сервера 200 (ok).
Отримати UUID (для CONDRA) GET /api/office/uuid
За допомогою GET методу /api/office/uuid генерується один UUID. Для створення CONDRA потрібно запускати метод двічі.
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/office/uuid |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді в текстовому вигляді передається uuid - сгенерований унікальний ідентифікатор:
c48f97e9-8d98-4c52-8635-675a6145f570
Створити чернетку документа (для CONDRA) POST /api/eds/doc
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/eds/doc |
|
URL параметри |
gln (обов’язково) String (13) - номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні аккаунта АБО guid (обов’язково) String - унікальний ідентифікатор організації на платформі EDIN 2.0 doc_type (обов’язково) String - тип документа (опис параметру) doc_number (обов’язково) String - номер документа doc_date (обов’язково) число - дата документа (в форматі UNIX-timestamp) recipient (обов’язково) String (13) - gln отримувача family (обов’язково) String (13) - сервіс (сімейство); допустимі значення:
created_from (опціонально) String - ідентифікатор документа або ланцюжка created_from_doc_id (опціонально) String - ідентифікатор документа-підстави (документа, на основі якого буде створено новий) |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передається документ у форматі JSON (XML специфікації EDI документів + XML специфікації ETTN документів). Приклад тіла запиту для створення CONDRA. |
RESPONSE
В тілі відповіді в текстовому вигляді передається doc_uuid - унікальний ідентифікатор документа:
e64a304b-b0c0-454b-a361-5dc5d6987952
Додати файл-вкладення (для CONDRA) POST /api/eds/doc/body
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/eds/doc/body |
|
URL параметри |
gln (обов’язково) рядок (13) - номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні аккаунта АБО guid (обов’язково) String - унікальний ідентифікатор організації на платформі EDIN 2.0 doc_uuid (обов’язково) UUID - ідентифікатор документа family (опціонально) int - сервіс (сімейство); допустимі значення:
body_type (обов’язково) String - тип тіла документа; можливі значення:
|
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/pkcs7-signature – для p7s файла application/vnd.openxmlformats-officedocument.spreadsheetml.sheet – для Excel … etc MIME типізація |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передається тіло файла в бінарному вигляді. |
RESPONSE
Код сервера 200 (ok).
Створити й відправити «Універсальний/неструктурований документ» (CONDRA) без створення чернетки POST /api/v2/eds/doc/condra/create_and_send
За допомогою цього методу відбувається одночасне створення та відправка «Універсального/неструктурованого документа» (CONDRA).
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/v2/eds/doc/condra/create_and_send |
|
URL параметри |
gln (обов’язково) String (13) - номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта recipient (обов’язково) String (13) - GLN отримувача number (обов’язково) String (32) - номер документа date (обов’язково) YYYY-MM-DD - дата документа doctype (обов’язково) String (1000) - код підтипа документа contractNumber (опціонально) String (16) - номер договору contractDate (опціонально) YYYY-MM-DD - дата договору summ (опціонально) Число десяткове - сума документа delivery (опціонально) String (13) - GLN місця доставки |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
|
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передаються підписані чи непідписані файли-вкладення (не більше 10 файлів з розміром файлу не більше 5 Мб) в їх нативному форматі (розширення файлу змінювати не потрібно). Приклади запитів + специфікація документа CONDRA. |
RESPONSE
doc_uuid - ідентифікатор документа на платформі EDIN 2.0;
chain_uuid - ідентифікатор ланцюжка, в якому знаходиться документ.
JSON приклад відповіді:
{
"doc_uuid": "0ca98f00-6988-4aac-a660-8f289a24fe2d",
"chain_uuid": "4838e8fe-c0aa-4fe9-ad78-74832d9e2b59"
}
Створити чернетку «Універсального/неструктурованого документа» (CONDRA) POST /api/v2/eds/doc/condra/create
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/v2/eds/doc/condra/create |
|
URL параметри |
gln (обов’язково) String (13) - номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта recipient (обов’язково) String (13) - GLN отримувача number (обов’язково) String (32) - номер документа date (обов’язково) YYYY-MM-DD - дата документа doctype (обов’язково) String (1000) - код підтипа документа contractNumber (опціонально) String (16) - номер договору contractDate (опціонально) YYYY-MM-DD - дата договору summ (опціонально) Число десяткове - сума документа delivery (опціонально) String (13) - GLN місця доставки |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
|
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передаються підписані чи непідписані файли-вкладення (не більше 10 файлів з розміром файлу не більше 5 Мб) в їх нативному форматі (розширення файлу змінювати не потрібно). Приклади запитів + специфікація документа CONDRA. |
RESPONSE
doc_uuid - ідентифікатор документа на платформі EDIN 2.0;
JSON приклад відповіді:
{
"doc_uuid": "a066f658-e7fa-407d-b4bf-4b044fe5cc88"
}
Відправити «Неструктурований (універсальний) документ» (CONDRA) PATCH /api/eds/doc/condra/send
Наявність ритейлера при документообізі автоматично визначається платформою (тобто якщо Відправник або Одержувач є ритейлером, то створений ланцюжок буде мати позначку конкретного ритейлера).
REQUEST
|
URL |
|
|
Метод запиту |
PATCH |
|
URL запиту |
/api/eds/doc/condra/send |
|
URL параметри |
gln - рядок (13); номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта АБО guid - рядок; унікальний ідентифікатор організації в системі doc_uuid - рядок; UUID документа doc_hash (опціонально) - рядок; хеш документа chain_hash (опціонально) - рядок; хеш ланцюжка chain_uuid (опціонально) - рядок; ID ланцюжка partner_id (опціонально) - число; id торгової мережі (можливо отримати з довідника торгових мереж) chain_type (опціонально) - число; тип ланцюжка документів;
|
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
text/plain; charset=UTF-8 |
RESPONSE
Код сервера 200 (ok).
Завантажити «Неструктурований (універсальний) документ» (CONDRA) в вигляді архіву GET /api/eds/doc/condra/body
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/eds/doc/condra/body |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії doc_uuid (обов’язково) UUID - ідентифікатор документа file_name (обов’язково) String - назва файлу документа |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/octet-stream |
RESPONSE
У тілі відповіді передається архів (.zip), що містить тіло документа CONDRA (.xml), файли-вкладення (оригінали або контейнери тіл підпису (.p7s) + листи підписання кожного вкладення (.pdf), якщо вкладення з підписами).
Отримати статус документа POST /api/v2/eds/docs/state
Метод дозволяє користувачеві отримати статус вхідного/відправленого документа (документів).
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/v2/eds/docs/state |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
Масив UUID документів через кому, наприклад:
|
RESPONSE
В тілі відповіді передається інформація про стан документа (exchange_status і де можливо: sub_status_id).
JSON приклад відповіді:
{
"44f3cf03-e2a3-4f8b-aae1-cafeb28fe699": {
"sub_status_id": "1",
"exchange_status": "000000000000000000000001"
},
"fb56e025-9c4d-4936-b889-087c6d5c837d": {
"sub_status_id": "1",
"exchange_status": "000000000000000000000001"
}
}
Одночасне прийняття, підписання та відправка двох пов’язаних документів POST /api/eds/docs_and_tickets
Даний метод однією дією (одночасно) виконує Прийняття «Акта приймання-передачі (додаток 8)» (COMDOC_032) (створення квитанції) та Відправку пов’язаного «Акта приймання-передачі (додаток 8)» (COMDOC_033) без чернетки (подібно до послідовного виконання /api/v2/eds/comdoc/accept та /api/eds/doc/create_and_send).
Якщо під час виконання методу під час перевірок буде виявлена логічна помилка на будь-якому етапі, то жодні дії не будуть виконані. Тобто або підписуються обидва документа, або жоден.
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/eds/docs_and_tickets |
|
URL параметри |
gln (обов’язково) String (13) - номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
|
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передаються два файли-вкладення пов’язаних документів (рекомендовано в p7s форматі (в бінарному вигляді чи в base64)) та їх дані в об’єкті DocumentRequest |
Повний приклад запиту:
POST /api/eds/docs_and_tickets?gln=9864066822430 HTTP/1.1
Host: localhost:8084
Authorization: 9e04baf1-f33b-4e76-8657-5212bae7a9z5
Content-Length: 590
Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW
----WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="files"; filename="comdoc_32_from_atb.p7s"
Content-Type: <Content-Type header here>
(data)
----WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="documents"
{"documents":[{"fileName":"comdoc_32_from_atb.p7s","type":"comdoc"},{"fileName":"comdoc_33_from_atb.p7s","type":"comdoc"}]}
----WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="files"; filename="comdoc_33_from_atb.p7s"
Content-Type: <Content-Type header here>
(data)
----WebKitFormBoundary7MA4YWxkTrZu0gWRESPONSE
doc_uuid - ідентифікатор документа на платформі EDIN 2.0;
chain_uuid - ідентифікатор ланцюжка, в якому знаходиться документ;
ticket_uuid - ідентифікатор квитанції.
JSON приклад відповіді:
{
"comdoc_32_from_atb.p7s": {
"doc_uuid": "fdae7e57-3706-4599-90e2-1a5ebee71512",
"chain_uuid": "d62f1b6e-7400-4bc3-ba5b-7e5d7931adbc",
"ticket_uuid": "411f23ee-ab07-472f-a1e2-7155a7631ff8"
}, - це для тікета
"comdoc_33_from_atb.p7s": {
"doc_uuid": "b45f5906-9a6b-45d9-adb1-0cc527d260c4",
"chain_uuid": "d62f1b6e-7400-4bc3-ba5b-7e5d7931adbc"
} - це для документа
}
Відправити транзакції до «Резерву товару» PRDRSRVN (зміни в табличній частині) POST /api/eds/doc/prdrsrvn/transaction
Виконувати дії з документом можливо на будь-якому етапі, однак поки оригінальний документ не буде старше 5 днів.
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/eds/doc/prdrsrvn/transaction |
|
URL параметри |
gln - рядок (13); номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта doc_uuid (опціонально) UUID - ідентифікатор документа (передається для редагування (оновлення) даних раніше створеного документа) |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
|
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передається тіло документа (контент) в json/xml форматі (xml-специфікація документа Резерв товару (PRDRSRVN)) |
RESPONSE
Код сервера 200 (ok).
Отримати тіло документів (json) за вказаними UUID POST /api/v2/eds/doc/content
Обмеження: не більше 50 документів одним запитом!
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/v2/eds/doc/content |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
Масив UUID документів через кому |
Приклад запиту:
["8b441f1f-a209-4331-b848-5d01766f3a5c", "07d369fe-6f17-4d7a-94d4-9fe0ccad9379"]
RESPONSE
В тілі відповіді передаються дані тіл документів в json форматі.
JSON приклад відповіді:
{
"07d369fe-6f17-4d7a-94d4-9fe0ccad9379": "{\"DATE\":\"2023-05-16\",\"HEAD\":[{\"SENDER\":\"9864065732181\",\"POSITION\":[{\"POSITIONNUMBER\":1,\"PRODUCT\":\"1231231002\",\"QUANTITYOFCUINTU\":45,\"QUANTITY\":\"10\",\"PRODUCTIDBUYER\":\"11111\",\"DELIVERYPLACE\":\"9864065732211\"}],\"RECIPIENT\":\"9864065732211\",\"SUPPLIER\":\"9864065732181\",\"DELIVERYPLACE\":\"9864065732211\",\"BUYER\":\"9864065732211\"}],\"NUMBER\":\"1111\",\"ORDERNUMBER\":\"1111111\",\"ORDERDATE\":\"2023-05-01\",\"DELIVERYDATE\":\"2023-05-02\",\"AMOUNT\":\"100000\",\"CURRENCY\":\"UAH\",\"DELIVERYINFO\":\"доп\"}",
"8b441f1f-a209-4331-b848-5d01766f3a5b": "{\"title\":{\"number\":\"17301/1010101\",\"type\":\"Акт виконаних робіт\",\"code\":\"013\",\"date\":\"2023-05-18\",\"place_of\":\"м. Київ\",\"doc_basis\":[{\"number\":\"111\",\"type\":\"Договір\",\"code\":\"001\",\"date\":\"2023-05-01\"}]},\"parties\":{\"partners\":[{\"status\":\"Продавець\",\"type\":\"Юридична\",\"name\":\"Товариство з обмеженою відповідальністю \\\"Імпульс Схід\\\"\",\"code\":\"40824037\",\"inn\":\"408240313043\",\"gln\":\"9864065732181\"},{\"status\":\"Покупець\",\"type\":\"Юридична\",\"name\":\"ПрАТ \\\"Монделіс Україна\\\"\",\"code\":\"00382220\",\"inn\":\"003822218163\",\"gln\":\"9864065732211\"}]},\"table\":{\"position\":[{\"position_number\":\"1\",\"description\":\"Відшкодування витрат за гарантії\",\"qty_received\":1.0,\"unit\":\"послуга\",\"price_base\":21309.99,\"vat\":0.0,\"price\":21309.99,\"total\":{\"sum_without_vat\":21309.99,\"sum_vat\":0.0,\"sum\":21309.99},\"id\":\"1\"}]},\"total\":{\"sum_without_vat\":21309.99,\"vat\":0.0,\"sum\":21309.99}}"
}
Видалити документи-чернетки PATCH /api/eds/docs
REQUEST
|
URL |
|
|
Метод запиту |
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).
Отримати інформацію про підпис/підписантів GET /api/eds/doc/attachment/sign/info
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/eds/doc/attachment/sign/info |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; АБО guid (обов’язково) String - унікальний ідентифікатор власної Компанії; attachment_uuid (обов’язково) UUID - ідентифікатор файла-вкладення (параметр attachmentUUID в тілі відповіді при додаванні файла) |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передається інформація про підписантів (масив об’єктів ExEndUserSignInfo).
Отримати реєстр документів в xls форматі GET /api/eds/doc/reports/doctype
Обмеження! Реєстр можливо отримати за період, що не перевищує 31 добу та лише для певних типів документів.
Перелік типів документів, для яких можна отримати реєстр:
-
«Замовлення» (ORDERS)
-
«Повідомлення про відвантаження» (DESADV)
-
«Підтвердження замовлення» (ORDRSP)
-
«Повідомлення про прийом» (RECADV)
-
«Рахунок» (INVOICE)
-
«Накладні» (DOCUMENTIVOICE) загалом чи за вказаним підтипом : «Товарна накладна»/»Цінова накладна»/»Видаткова накладна»/»Накладна за кількістю» (DOCUMENTINVOICE з DocumentFunctionCode=DRN/PRN/TN)
-
«Комерційні документи» (COMDOC) загалом чи за вказаним підтипом «Комерційного документа»
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/eds/doc/reports/doctype |
|
URL параметри |
gln (обов’язково) - рядок (13); номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта; АБО guid (обов’язково) - рядок; унікальний ідентифікатор організації в системі doc_type_id (обов’язково) - число; id типу документа. Доступні значення: 1,2,3,4,5,28,59,67 sub_doc_type_id (опціонально) - число; id підтипу документа date_from (опціонально) - початок періоду виборки в UNIX-форматі (якщо не вказано, то поточна дата мінус 31 день) date_to (опціонально) - кінець періоду виборки в UNIX-форматі (якщо не вказано, то поточна дата) sender (обов’язково) - рядок (13); номер GLN відправника документів АБО recipient (обов’язково) - рядок (13); номер GLN отримувача документів АБО partner (обов’язково) - id рітейлера (торгової мережі) |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
У тілі відповіді передається звіт у вигляді xlsx-файлу з даними документів.
Архівувати / Розархівувати ланцюжок документів PATCH /api/eds/chain/archive
REQUEST
|
URL |
|
|
Метод запиту |
PATCH |
|
URL запиту |
api/eds/chain/archive |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; АБО guid (обов’язково) String - унікальний ідентифікатор власної Компанії; chain_uuid (обов’язково) String - унікальний ідентифікатор ланцюжка документів; archive (обов’язково) boolean - визначає дію:
|
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
Код сервера 200 (ok).
Заповнити індекси (додавання / оновлення полів екстрапараметрів) PUT /api/eds/doc/extra_fields
Заповнення індексів необхідно для коректного відображення та пошуку документів. По факту це повтор «Створення CONDRA», але з іншими полями. Якщо на попередньому кроці отримали помилку, то необхідно переривати подальше виконання запитів.
REQUEST
|
URL |
|
|
Метод запиту |
PUT |
|
URL запиту |
/api/eds/doc/extra_fields |
|
URL параметри |
gln (обов’язково) рядок (13) - номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні аккаунта АБО guid (обов’язково) String - унікальний ідентифікатор організації на платформі EDIN 2.0 doc_uuid (обов’язково) UUID - ідентифікатор документа |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передаються додаткові поля (поля екстрапараметрів). Приклад індексації CONDRA та TRANSPORTATIONORDER |
RESPONSE
Код сервера 200 (ok).
Редагувати чернетку документа PUT /api/eds/doc
REQUEST
|
URL |
|
|
Метод запиту |
PUT |
|
URL запиту |
/api/eds/doc |
|
URL параметри |
gln (обов’язково) Число (13) - номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні аккаунта doc_uuid (обов’язково) UUID - унікальний ідентифікатор документа doc_number (обов’язково) String - номер документа doc_date (обов’язково) Число - дата документа (в форматі UNIX-timestamp) recipient (опціонально) Число (13) - GLN отримувача family (опціонально) String (13) - сервіс (сімейство); допустимі значення:
|
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передається документ у форматі JSON (XML специфікації EDI документів + XML специфікації ETTN документів). Приклад тіла запиту для редагування CONDRA. |
RESPONSE
Код сервера 200 (ok).
Отримати статус документа GET /api/eds/doc/statuses
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/eds/doc/statuses |
|
URL параметри |
gln - рядок (13); номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта; АБО guid - рядок; унікальний ідентифікатор організації в системі doc_uuid - рядок; UUID документа |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
У тілі відповідь передається статус вказаного документа (об’єкт XStatus ).
Відправити статус документа POST /api/eds/doc/statuses
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/eds/doc/statuses |
|
URL параметри |
gln (обов’язково) рядок (13) - номер GLN власної Компанії; doc_uuid (обов’язково) рядок - UUID документа; type (обов’язково) число - статус документа;
sub_status (опціонально) число - сабстатус документа (не використовується для ТТН v3 та пов’язаних Актів):
Взаємовиключаючі параметри:
|
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передається вільний текст (причина, наприклад, для відхилення/відмови/анулювання) |
RESPONSE
Код сервера 200 (ok).
Завантажити тіло документа/підпису GET /api/eds/doc/download
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/eds/doc/download |
|
URL параметри |
gln - String (13); номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта; АБО guid - String; GUID організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта doc_uuid - UUID; UUID документа file_name (опціонально) - String; назва файлу для завантаження format (опціонально) - String; формат файлу для завантаження (якщо не вказано - ZIP); можливі варіанти:
response_type (опціонально) - String; формат відповіді сервера (якщо не вказано - file); можливі варіанти:
|
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/octet-stream |
RESPONSE
У тілі відповідь передається тіло вказаного документа/підпису чи архів з усіма доступними форматами файлів.
Отримати XML контент документа GET /api/eds/doc/xml
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/eds/doc/xml |
|
URL параметри |
gln - рядок (13); номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта doc_uuid - рядок; UUID документа response_type (опціонально) - формат очікуваної відповіді; можливі варіанти:
|
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передається XML контента документа (специфікації документів).
Отримати контент документа GET /api/eds/doc/body
За допомогою цього методу можливо швидко отримати контент документа без підписів/печаток, а також тіло підпису, тіло печатки.
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/eds/doc/body |
|
URL параметри |
gln (обов’язково) String (13) - номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні аккаунта АБО guid (обов’язково) String - унікальний ідентифікатор організації на платформі EDIN 2.0 doc_uuid (обов’язково) UUID - ідентифікатор документа; body_type (обов’язково) String - тип тіла документа; можливі значення:
response_type (опціонально) String - формат очікуваної відповіді; можливі варіанти:
|
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передається тіло документа в форматі, що визначається значенням параметра body_type.
Отримати ланцюжки вхідних документів POST /api/eds/chains/search
За допомогою цього методу можна зробити пошук ланцюжків по заданих критеріях.
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/eds/chains/search |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії АБО guid (обов’язково) String - унікальний ідентифікатор власної організації на платформі status_id (опціонально) int - id папки документів:
family (опціонально) String - назва сімейства документів:
|
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передаються обов’язкові та додаткові критерії пошуку/фільтрації |
RESPONSE
В тілі відповіді передається масив об’єктів XChain.
Отримати конкретний ланцюжок документів GET /api/eds/chain
Документи пов’язуються в один ланцюжок в тому випадку, якщо у них ідентичні значення полів Відправник, Одержувач, Покупець, Точка доставки (GLN-и) і Номер замовлення (якщо відсутній, то Номер документа).
За допомогою методу api/eds/chain і заданих параметрів можливо отримати (вивантажити) необхідні дані вказаного ланцюжка документів.
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/eds/chain |
|
URL параметри |
gln - рядок (13); номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта chain_uuid - рядок; ID ланцюжка Опціональні url-параметри (boolean фільтри): load_docs - чи завантажувати документи, що відносяться до ланцюжка load_bodies - чи завантажувати тіла документів load_package - чи завантажувати пакети load_comments - чи завантажувати коментарі load_tags - чи завантажувати теги до документів load_statuses - чи завантажувати статуси до документів |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
Приклади url-запитів:
- Отримати перелік документів за визначеним ланцюжком без завантаження їхніх тіл, пакетів, коментарів, тегів і статусів:
- Отримати перелік документів за визначеним ланцюжком з завантаженням тіл і коментарів без завантаження їхніх пакетів, тегів і статусів:
- Отримати перелік документів за визначеним ланцюжком з завантаженням пакетів, тегів без завантаження їхніх тіл і коментарів і статусів:
- Отримати перелік документів за визначеним ланцюжком з завантаженням статусів без завантаження їхніх тіл, коментарів, пакетів, тегів:
RESPONSE
В тілі відповіді передається ланцюжок документів (об’єкт XChain).
Отримати інформацію (мета-дані) про документ GET /api/eds/doc
REQUEST
|
URL |
|
|
Метод запиту |
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 ).
Пошук документів (з фільтрацією), вибір списку документів POST /api/eds/docs/search
За допомогою цього методу можна зробити пошук по заданих критеріях, наприклад, отримати список документів з певним статусом або за проміжок часу.
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/eds/docs/search |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії АБО guid (обов’язково) String - унікальний ідентифікатор власної організації на платформі status_id (опціонально) int - id папки документів:
family (опціонально) String - назва сімейства документів:
|
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передаються обов’язкові та додаткові критерії пошуку/фільтрації |
RESPONSE
В тілі відповіді передається масив документів.
Відправити документ (без створення чернетки) POST /api/eds/doc/create_and_send
Метод є універсальним для різних типів документів і дозволяє одночасно створити та відправити документ без створення чернетки.
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/eds/doc/create_and_send |
|
URL параметри |
gln - рядок (13); номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта doc_type - рядок; тип документа (опис параметру) |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
|
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передєються тільки один файл-вкладення в форматі |
При вказуванні application/pkcs7-signature доступна можливість обробки BASE64 формату.
RESPONSE
-
chain_uuid - ідентифікатор ланцюжка, в якому знаходиться документ
-
doc_uuid - ідентифікатор документа на платформі EDIN 2.0;
-
ticket_uuid - ідентифікатор квитанції
Параметр ticket_uuid система повертає тільки у випадках, коли на існуючий документ намагаються створити додатковий тікет (підписання у відповідь, відмова від підпису, запит на анулювання). Тобто, якщо документ новий, система поверне у відповідь тільки chain_uuid та doc_uuid.
Приклад відповіді (JSON):
{
"chain_uuid": "7ccff78e-ea42-47ea-81e4-5508ed4fbd51",
"doc_uuid": "3698b501-e1ef-464d-a71a-58066f556114",
"ticket_uuid": "1003706c-3656-497b-9438-c6f33e27c36d"
}
Відправити чернетку PATCH /api/eds/doc/send
За допомогою цього методу можлива відправка чернетки (з додатковими особливостями відправки).
Наявність ритейлера при документообігу автоматично визначається платформою (тобто якщо Відправник або Одержувач є ритейлером, то створений ланцюжок буде мати позначку конкретного ритейлера).
REQUEST
|
URL |
|
|
Метод запиту |
PATCH |
|
URL запиту |
/api/eds/doc/send |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; АБО guid (обов’язково) String - унікальний ідентифікатор власної Компанії; doc_uuid (обов’язково) String - унікальний ідентифікатор документа; doc_hash (опціонально) - рядок; хеш документа; chain_hash (опціонально) - рядок; хеш ланцюжка документів; chain_uuid (опціонально) - рядок; ID ланцюжка документів; partner_id (опціонально) - число; id торгової мережі (можливо отримати з довідника торгових мереж); chain_type (опціонально) - число; тип ланцюжка документів;
|
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу опціонально передаються додаткові поля Виняток: при відправці
в тілі запиту обов’язково передається параметр sub_status_id. |
Приклад для відправки «Заявки на транспортування» / «Підтвердження транспортування» (TRANSPORTATIONORDER):
{"extra_fields":{"sub_status_id":"1"}}RESPONSE
Код сервера 200 (ok).
Створити чернетку документа / Клонувати відправлений документ (COMDOC) POST /api/v2/eds/doc
За допомогою цього методу можливо створити чернетку документа (передається тіло документа) зазначеного типу (параметр doc_type) для вказаного одержувача АБО можливо клонувати відправлений документ (передається параметр clone_from_doc_uuid) в чернетку.
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/v2/eds/doc |
|
URL параметри |
gln (обов’язково) рядок (13) - номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта doc_type (обов’язково/-) рядок - тип створюваного документа (опис параметру); даний параметр не передається при клонуванні документа (коли передається clone_from_doc_uuid параметр); clone_from_doc_uuid (обов’язково/-) рядок - унікальний ідентифікатор вже відправленого документа (COMDOC) для клонування в чернетку (при цьому тіло передавати не обов’язково, а Content-Type=application/json); даний параметр не передається при створенні чернетки документа |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
|
|
REQUEST |
|
|
JSON Body |
При створенні чернетки в тілі запиту методу передається документ у форматі JSON або XML або P7S в бінарному вигляді (приклад запиту (в тому числі й для створення CONDRA та TRANSPORTATIONORDER) + специфікації документів) |
RESPONSE
В тілі відповіді передаються дані створеного документа (об’єкт XDoc ).
Отримати останню подію за документом GET /api/eds/docs/event/last
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/eds/doc/event/last |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії doc_id (обов’язково) - ідентифікатор документа |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передається остання подія за документом (об'єкт XEvent).
Отримати список подій GET /api/eds/docs/events
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/eds/docs/events
|
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії from_id (обов'язково) long - ідентифікатор події, після якої (починаючи з наступної) необхідно отримати список наступних подій
grouped (опціонально) boolean:
|
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передається список подій за документами (масив об'єктів XEvent).
Пошук подій POST /api/eds/docs/events
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/eds/docs/events
|
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передаються параметри пошуку подій за документами |
RESPONSE
В тілі відповіді передаються результати пошуку подій за документами (об’єкт EventsStorageQueryResult).
API сервісу ETTN v3
Перелік методів АРІ сервісу 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 | + | Замовник ОВ | |
| Реєструється до початку ЖЦ Акту (завжди ініціатором акта) | Реєструється після завершення ЖЦ Акту |
| Акт про заміну пункту призначення вантажу | |
| - |
|
Алгоритм «Рахунок (Логістика)» (COMDOC_040)
Алгоритм «Акт наданих послуг (Логістика)» (COMDOC_037)
API сервісу Е-Сертифікати
Перелік методів API сервісу Е-Сертифікати
Всі запити нижче перерахованих API методів платформи EDIN 2.0 направляються на адресу: https://edo-v2.edin.ua
Для роботи з цими методами користувач повинен бути авторизованим.
Робота з сертифікатами
| Створити сертифікат | POST /api/ecs/certificate |
| Оновити сертифікат | PUT /api/ecs/certificate |
| Отримати сертифікат | GET /api/ecs/certificate |
| Видалити сертифікат | DELETE /api/ecs/certificate |
| Архівувати / розархівувати сертифікат | PUT /api/ecs/archive |
| Задати / змінити тип доступу до сертифіката | PUT /api/ecs/access |
| Копіювати сертифікат | PUT /api/ecs/copy |
| Знайти сертифікат / сертифікати | POST /api/ecs/search |
| Додати (прив'язати) товари до сертифіката | PUT /api/ecs/products |
| Масово завантажити сертифікати | POST /api/ecs/certificates |
|
Створити сертифікат з типом «Декларація виробника» (CERTDOC) |
POST /api/ecs/certdoc |
Робота з вкладеннями до сертифікатів
| Створити вкладення до сертифіката | POST /api/ecs/body |
| Додати нові вкладення до сертифіката | PUT /api/ecs/body |
| Отримати контент вкладення до сертифіката | GET /api/ecs/body |
| Видалити всі вкладення до сертифіката | DELETE /api/ecs/body |
| Отримати вкладення до сертифіката в PDF | GET /api/ecs/body/download |
| Підписати вкладення до сертифіката | |
| Отримати дані про підписання вкладення до сертифіката | GET /api/ecs/certificate/sign |
Робота з пов'язаними відвантаженнями
| Отримати список відвантажень по сертифікату | GET /api/ecs/certificate/shipments |
| Додати відвантаження в список відвантажень по сертифікату | POST /api/ecs/certificate/shipments |
| Редагувати дані відвантаження | PATCH /api/ecs/certificate/shipments |
| Видалити відвантаження з сертифікату | DELETE /api/ecs/certificate/shipments |
Опис помилок сервісу «Е-Сертифікати»
На цій сторінці наданий опис специфічних помилок сервісу «EDI Network». Опис загальних помилок для всіх сервісів EDIN можна знайти за посиланням.
Опис загальних помилок сервісу «Е-Сертифікати»
|
Код відповіді |
Індекс помилки |
Текст помилки |
Опис |
|
400 |
ERR_CRT-1 |
Unknown certificate type: %s Тип сертифіката некоректний: %s |
Невідомий тип сертифіката при зміні типа доступа (PUT, «/api/ecs/access») |
|
400 |
ERR_CRT-2 |
Search query error: %s Помилка пошукового запиту: %s |
Некоректне тіло запита (POST, «/api/ecs/search») |
|
400 |
ERR_CRT-3 |
Certificate with UUID [%s] not found Сертифікат із указаним UUID [%s] не знайдено |
Сертифікат не знайдено (GET, «/api/ecs/certificate») |
|
400 |
ERR_CRT-4 |
Data validation errors detected Виявлено помилки при обробленні даних |
Помилки при опрацюванні сертифікатів, завантажених із excel (POST, «/api/ecs/certificates») |
Опис помилки при масовому завантаженні сертифікатів
Якщо в сертифікатах, що передаються буде допущена помилка, то Ви отримаєте відповідь про помилку в файлі, наприклад:
{
"certificatesErrors":
{
"2":
[
{
"errorType": 1,
"columnName": "Тип сертификату"
},
{
"errorType": 2,
"columnName": "Тип сертификату"
},
{
"errorType": 1,
"columnName": "Номер сертифікату"
},
{
"errorType": 1,
"columnName": "Дата видачі"
},
{
"errorType": 1,
"columnName": "Вид сертифікату"
},
{
"errorType": 2,
"columnName": "Вид сертифікату"
},
{
"errorType": 1,
"columnName": "Дата закінчення дії",
"cause": "Вид сертифікату = 1"
},
{
"errorType": 1,
"columnName": "Номер партії",
"cause": "Вид сертифікату = 2"
},
{
"errorType": 1,
"columnName": "Дата початку дії"
},
{
"errorType": 1,
"columnName": "Назва файлу"
},
{
"errorType": 2,
"columnName": "Назва файлу",
"allowedValues": "[pdf, jpg, jpeg, png, tiff]",
"fileName": "filename.txt"
},
{
"errorType": 3,
"columnName": "Назва файлу",
"fileName": "filename.pdf"
},
{
"errorType": 4,
"columnName": "Назва файлу",
"fileName": "filename.pdf"
}
]
},
"productsErrors":
{
"2":
[
{
"errorType": 1,
"columnName": "Номер сертифікату"
}
]
},
"createdCertificates":
[],
"existedCertificates":
[],
"certsCount": 0,
"productsCount": 0
}
Опис параметрів помилки
|
Поле |
Опис |
|
certificatesErrors/productsErrors |
об’єкт; починається з номера рядка сертифіката / рядка тварної позиції (відповідно), де була допущена помилка. Містить параметри:
|
|
createdCertificates |
масив; номера створених сертифікатів |
|
existedCertificates |
масив; номера існуючих сертифікатів |
|
certsCount - кількість сертифікатів (рядків на 1-му листі xls/xlsx-файлу) |
|
|
productsCount - кількість товарних позицій (рядків на 2-му листі xls/xlsx-файлу) |
Видалити відвантаженя з сертифікату DELETE /api/ecs/certificate/shipments
За допомогою цього методу можна із сертифікату видалити відвантаження по їхньому id.
REQUEST
|
URL |
|
|
Метод запиту |
DELETE |
|
URL запиту |
/api/ecs/certificate/shipments |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту передається JSON масив ідентифікаторів відвантажень.
Приклад запиту:
|
RESPONSE
Код сервера 200 (ok).
Редагувати дані відвантаження PATCH /api/ecs/certificate/shipments
REQUEST
|
URL |
|
|
Метод запиту |
PATCH |
|
URL запиту |
/api/ecs/certificate/shipments |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту передається JSON масив параметрів відвантаження (об'єкт XCertificateShipment).
Приклад запиту:
|
RESPONSE
Код сервера 200 (ok).
Додати відвантаження в список відвантажень по сертифікату POST /api/ecs/certificate/shipments
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/ecs/certificate/shipments |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; uuid (обов'язково) - сертифіката, обовязковий |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту передається JSON масив параметрів відвантаження (об'єкт XCertificateShipment).
Приклад запиту:
|
RESPONSE
Код сервера 200 (ok).
Отримати список відвантажень по сертифікату GET /api/ecs/certificate/shipments
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/ecs/certificate/shipments |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; uuid (обовязково) - ідентифікатор сертифіката |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
У відповідь отримується JSON масив об'єктів з даними відвантажень, пов'язаних з обраним сертифікатом (об'єкти XCertificateShipment).
JSON приклад відповіді:
[{"id":9,"creatorId":13202937,"number":"shipment_2","date":1740369800,"buyer":"9864065750117"},{"id":15,"creatorId":13202937,"number":"shipment_3","date":1740269800,"buyer":"9864065750135"},{"id":13,"creatorId":13202937,"number":"shipment_1","date":1740169800,"buyer":"9864065750119"}]Отримати вкладення до сертифіката в PDF GET /api/ecs/body/download
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/ecs/body/download |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; uuid (обов’язково) UUID - унікальний ідентифікатор сертифіката body_type (обов’язково) int - тип тіла:
|
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/pdf |
RESPONSE
У тілі відповіді передається
- pdf файл з вкладеннями, якщо body_type: 1.
- p7s файл, якщо body_type: 2.
Видалити всі вкладення сертифіката DELETE /api/ecs/body
REQUEST
|
URL |
|
|
Метод запиту |
DELETE |
|
URL запиту |
/api/ecs/body |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; uuid (обов’язково) UUID - унікальний ідентифікатор сертифіката body_type (обов’язково) int - тип тіла:
|
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
RESPONSE
Код сервера 200 (ok).
Отримати контент вкладення до сертифіката GET /api/ecs/body
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/ecs/body |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; uuid (обов’язково) UUID - унікальний ідентифікатор сертифіката body_type (обов’язково) int - тип тіла:
|
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
RESPONSE
У тілі відповіді передається контент сформованого pdf файлу з вкладеннями у вигляді base64 рядка.
Додати нові вкладення до сертифіката PUT /api/ecs/body
Максимальний розмір файлу для завантаження - 7,5 МБ
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/ecs/body |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; uuid (обов’язково) UUID - унікальний ідентифікатор сертифіката body_type (обов’язково) int - тип тіла:
|
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
|
|
REQUEST |
|
|
Form-data |
В тілі запиту передаються файли вкладень в форматі PDF, JPG, JPEG, PNG, TIFF. Всі файли, що передаються будуть автоматично об’єднані в один PDF файл.
Приклад запиту:
|
RESPONSE
У тілі відповіді передається контент сформованого pdf файлу з вкладеннями у вигляді base64 рядка.
Створити вкладення до сертифікату POST /api/ecs/body
Максимальний розмір файлу для завантаження - 7,5 МБ
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/ecs/body |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; uuid (обов’язково) UUID - унікальний ідентифікатор сертифіката body_type (обов’язково) int - тип тіла:
|
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
|
|
REQUEST |
|
|
Form-data |
В тілі запиту передаються файли вкладень в форматі PDF, JPG, JPEG, PNG, TIFF. Всі файли, що передаються будуть автоматично об’єднані в один PDF файл.
|
Приклад запиту:
-----------------------------28001198861666343170695798896
Content-Disposition: form-data; name="files[]"; filename="istockphoto-1154370446-612x612.png"
Content-Type: image/png
(data)
-----------------------------28001198861666343170695798896
Content-Disposition: form-data; name="files[]"; filename="photo-1518020382113-a7e8fc38eac9.jpeg"
Content-Type: image/jpeg
(data)
-----------------------------28001198861666343170695798896--RESPONSE
У тілі відповіді передається контент сформованого pdf файлу з вкладеннями у вигляді base64 рядка.
Створити сертифікат з типом «Декларація виробника» (CERTDOC) POST /api/ecs/certdoc
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/ecs/certdoc |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії publish (необов’язково) Boolean- ознака публікації сертифікату при створенні:
|
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
|
|
REQUEST |
|
|
Form-data |
В тілі запиту передається XML файл сертифіката. |
RESPONSE
У тілі відповіді передається унікальний ідентифікатор (UUID) створеного сертифіката, наприклад:
55ef04b2-281e-4fca-bb67-d48fe88ae74f.
Масово завантажити сертифікати POST /api/ecs/certificates
Максимальний розмір файлу для завантаження - 7,5 МБ
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/ecs/certificates |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
|
|
REQUEST |
|
|
JSON Body |
В тілі запиту передається zip-файл, що містить файли-вкладення (в форматі PDF, JPG, JPEG, PNG, TIFF) та заповнений xls/xlsx шаблон з зазначеними назвами файлів-вкладень. |
Приклад передаваємого zip знаходиться у вкладенні до цієї сторінки (ліва бокова панель).
RESPONSE
У тілі відповіді передаються дані завантажених сертифікатів (масив об’єктів XCertificate).
Якщо в сертифікатах, що передаються, буде допущена помилка, то Ви отримаєте відповідь про помилку в файлі.
Додати (прив’язати) товари до сертифіката PUT /api/ecs/products
Якщо продукт уже прив’язаний до сертифіката і в тілі передано його ідентифікатор (XCertificateProduct.id), то дані товару будуть оновлені, в іншому випадку буде створено новий товар.
REQUEST
|
URL |
|
|
Метод запиту |
PUT |
|
URL запиту |
/api/ecs/products |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; uuid (обов’язково) UUID - унікальний ідентифікатор сертифіката |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передаються дані товарів, що прив’язуються до сертифіката (масив об’єктів XCertificateProduct). |
RESPONSE
Код сервера 200 (ok).
Знайти сертифікат/-ти POST /api/ecs/search
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/ecs/search |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії owner_gln (необов’язково) String - GLN Компанії-Власника сертифікату |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передаються дані для фільтрації (об’єкт XQueryCertificates) |
RESPONSE
В тілі відповіді передаються дані про сертифікати.
Копіювати сертифікат PUT /api/ecs/copy
REQUEST
|
URL |
|
|
Метод запиту |
PUT |
|
URL запиту |
/api/ecs/copy |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; uuid (обов’язково) UUID - унікальний ідентифікатор сертифіката company_id (опціонально) long - ідентифікатор компанії, від якої здійснюється запит |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
Код сервера 200 (ok).
Задати/змінити тип доступу до сертифіката PUT /api/ecs/access
REQUEST
|
URL |
|
|
Метод запиту |
PUT |
|
URL запиту |
/api/ecs/access |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; uuid (обов’язково) UUID - унікальний ідентифікатор сертифіката (можливо передавати кілька в одному запиті) type (обов’язково) String - тип доступу, можливі значення:
|
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
Тіло очікується лише при type=private: тіло запиту в форматі Map<Long, Boolean>, де ключ - це intGlnID кому відкрито доступ, а значення true/false - чи буде дозволено даному intGlnID репостити цей сертифікат комусь іще.
Приклад тіла запиту:
1
[[13203393,false],[13203397,false]]
|
RESPONSE
Код сервера 200 (ok).
Архівувати / розархівувати сертифікат PUT /api/ecs/archive
Дія «архівувати» / «розархівувати» залежить від того, де перебуває сертифікат до виконання метода:
-
якщо сертифікат в Архіві, то виконається розархівування;
-
якщо сертифікат в Опублікованих, то виконається архівування.
REQUEST
|
URL |
|
|
Метод запиту |
PUT |
|
URL запиту |
/api/ecs/archive |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; uuid (обов’язково) UUID - унікальний ідентифікатор сертифіката |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
RESPONSE
Код сервера 200 (ok).
Видалити сертифікат DELETE /api/ecs/certificate
REQUEST
|
URL |
|
|
Метод запиту |
DELETE |
|
URL запиту |
/api/ecs/certificate |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; uuid (обов’язково) UUID - унікальний ідентифікатор сертифіката |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
RESPONSE
Код сервера 200 (ok).
Отримати сертифікат GET /api/ecs/certificate
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/ecs/certificate |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; uuid (обов’язково) UUID - унікальний ідентифікатор сертифіката |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
RESPONSE
В тілі відповіді передаються дані про сертифікат.
Оновити сертифікат PUT /api/ecs/certificate
REQUEST
|
URL |
|
|
Метод запиту |
PUT |
|
URL запиту |
/api/ecs/certificate |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту (json) передається об’єкт з даними сертифіката. |
RESPONSE
Код сервера 200 (ok).
Створити сертифікат POST /api/ecs/certificate
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/ecs/certificate |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту (json) передається об’єкт з даними сертифіката. |
RESPONSE
У тілі відповіді передається унікальний ідентифікатор (UUID) створеного сертифіката, наприклад: 55ef04b2-281e-4fca-bb67-d48fe88ae74f.
Підписати вкладення до сертифіката POST /api/ecs/certificate/sign
Для підпису доступні тільки сертифікати в стані чернетки із завантаженим вкладенням. Підписувати може тільки користувач з GLN, який створив даний сертифікат.
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/ecs/certificate/sign |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; uuid (обов’язково) UUID - унікальний ідентифікатор сертифіката |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/octet-stream |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передається файл підпису p7s в base64 форматі. |
RESPONSE
Код сервера 200 (ok).
Отримати дані про підписання вкладення до сертифіката GET /api/ecs/certificate/sign
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/ecs/certificate/sign |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; uuid (обов’язково) - UUID, унікальний ідентифікатор сертифіката |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
RESPONSE
В тілі відповіді (json) передається інформація про підписантів (масив об’єктів ExEndUserSignInfo ).
API сервісу Е-Специфікація + Комерційна пропозиція
Перелік методів API сервісу Е-Специфікація+Комерційна пропозиція
Всі запити нижче перерахованих API методів платформи EDIN 2.0 направляються на адресу: https://edo-v2.edin.ua
Для роботи з цими методами користувач повинен бути авторизованим.
Налаштування рівнів погодження (тільки для Мережі)
|
Отримати інформацію про всіх користувачів компанії (на рівні акаунта) |
GET /api/oas/account/users |
|
Отримати всі пов’язані GLN користувача в сервісі «Е-Специфікація» |
GET /api/es/user/spec_all_glns |
|
Отримати всі статуси документів, в яких документи доступні користувачу до перегляду |
GET /api/es/user/spec_view_statuses |
|
Отримати всі активні GLN користувача (за якими відображаються категорії товарів) |
GET /api/es/user/spec_view_glns |
|
Отримати налаштування дій узгодження для вказаного користувача в розрізі кожного підтипу документа AGREEM |
GET /api/es/user/spec_status |
|
Вказати нові статуси документів, в яких документи будуть доступні користувачу до перегляду |
POST /api/es/user/spec_view_statuses |
|
Вказати нові активні GLN користувача (за якими відображаються категорії товарів) |
POST /api/es/user/spec_view_glns |
|
Вказати нові дії узгодження для вказаного користувача в розрізі кожного підтипу документа AGREEM |
POST /api/es/user/spec_status |
Робота з контрактами / специфікаціями
|
Створити нову специфікацію (Мережа) |
POST /api/es/contract |
|
Оновити раніше створену специфікацію (Мережа) |
PUT /api/es/contract |
|
Переглянути усі контракти/специфікації |
GET /api/es/contracts |
|
Переглянути контракт з конкретним контрагентом |
GET /api/es/contract |
|
Видалити контракт/товарні позиції в контракті |
DELETE /api/es/contract/data |
|
Пошук контрактів/специфікацій (з фільтрацією) |
POST /api/es/contracts/search |
Робота з пропозиціями
|
Отримати список документів в журналі |
GET /api/es/agreements |
|
Переглянути налаштування мережі |
GET /api/oas/retailer/settings |
|
Отримати дані пропозиції (товарного узгодження) |
GET /api/es/agreement |
|
Створити пропозицію (переузгодження) (для Постачальника) |
POST /api/es/agreement |
|
Редагувати пропозицію (переузгодження) (для Постачальника) |
PUT /api/es/agreement |
|
Створити тіло документа (комерційної пропозиції / товарного узгодження) / Додати обгрунтування до пропозиції |
POST /api/es/agreement/body |
|
Отримати тіло документа (комерційної пропозиції / товарного узгодження) |
GET /api/es/agreement/body |
|
Оновити тіло документа (комерційної пропозиції / товарного узгодження) |
PUT /api/es/agreement/body |
|
Видалити пропозицію |
DELETE /api/es/agreement |
|
Видалити вкладення (обгрунтування) пропозиції товарного переузгодження |
DELETE /api/es/agreement/attachment |
|
Отримати список вкладень до пропозиції товарного переузгодження чи конкретного коментаря документа |
GET /api/es/attachment |
|
Отримати контент файлу-вкладення товарного узгодження чи коментаря |
GET /api/es/attachment/body |
|
Додати обгрунтування до пропозиції товарного переузгодження (Постачальник) |
POST /api/es/attachment |
|
Надіслати пропозицію (переузгодження) (для Постачальника) |
PATCH /api/es/agreement |
|
Надіслати підписану пропозицію |
PATCH /api/es/agreement/comdoc |
|
Отримання інформації про сертифікати підписантів |
GET /api/es/agreement/signers |
|
Клонування товарного узгодження (створення пропозиції) |
PUT /api/es/agreement/copy |
|
Пошук «Товарних узгоджень» (AGREEM) з фільтрацією |
POST /api/es/agreements/search |
|
Формування та отримання Excel-звіту по акціях |
GET /api/es/agreement/excel |
|
Прийняти/Відхилити позиції «Товарного узгодження» (Мережа) |
PATCH /api/v2/es/agreement/positions |
|
Відхилити «Товарне узгодження» (Мережа) |
PATCH /api/v2/es/agreement/reject |
|
Прийняти «Товарне узгодження» (Мережа) |
POST /api/v2/es/agreement/comdoc |
|
Відправити підписаний документ «Товарна специфікація» (Мережа) |
PATCH /api/v2/es/agreement/comdoc |
|
Отримати XML контента документа «Товарна специфікація» (Мережа) |
GET /api/v2/es/agreement/comdoc |
|
Отримати Комерційну пропозицію в xlsx форматі (Excel) |
GET /api/es/agreement/offer/excel |
Робота з коментарями
|
Створити коментар до пропозиції товарного переузгодження |
POST /api/es/agreement/comment |
|
Переглянути коментарі |
GET /api/es/agreement/comments |
Робота зі статусами
|
Оновити статус документа (комерційної пропозиції / товарного узгодження) |
PUT /api/es/agreement/status |
|
Оновити внутрішній статус пропозиції |
PUT /api/es/agreement/sub_status |
Робота з товарними позиціями Комерційних пропозицій
|
Додати товарну позицію до чернетки Комерційної пропозиції (Постачальник) |
POST /api/es/position |
|
Отримати дані товарних позицій Комерційної пропозиції |
GET /api/es/position |
|
Отримати дані товарних позицій всіх Комерційних пропозицій за фільтром |
POST /api/es/position/search |
|
Редагувати товарну позицію чернетки Комерційної пропозиції (Постачальник) |
PUT /api/es/position |
|
Видалити товарну позицію чернетки Комерційної пропозиції (Постачальник) |
DELETE /api/es/position |
|
Додати зображення до товарної позиції (чернетка Комерційної пропозиції) |
POST /api/es/position/image |
|
Отримати зображення до товарної позиції Комерційної пропозиції |
GET /api/es/position/image |
|
Видалити зображення до товарної позиції (чернетка Комерційної пропозиції) |
DELETE /api/es/position/image |
Робота з категоріями / групами
|
Отримати доступні групи / категорії |
GET /api/products/group |
|
Відредагувати групу / категорію (Мережа) |
PUT /api/products/group |
|
Створити нову групу / категорію (Мережа) |
POST /api/products/group |
|
Видалити групу / категорію (Мережа) |
DELETE /api/products/group |
Робота з графіком акцій
|
Створити нову акцію |
POST /api/es/promotion |
|
Редагувати акцію |
PUT /api/es/promotion |
|
Видалити акцію |
DELETE /api/es/promotion |
|
Отримати список акцій |
GET /api/es/promotion |
|
Створити новий тип акції |
POST /api/es/promotion/type |
|
Редагувати тип акції |
PUT /api/es/promotion/type |
|
Отримати список типів акцій |
GET /api/es/promotion/type |
Алгоритми обміну документами (API)
Алгоритм «Електронна специфікація» (PRODUCTLIST)
|
№ кроку |
МЕРЕЖА |
|
1.1 |
|
|
1.2 |
|
|
|
ПОСТАЧАЛЬНИК |
|
2.1 |
|
|
2.2 |
Перегляд усіх Cпецифікацій / Переглянути Специфікацію з конкретним контрагентом |
Алгоритм «Товарне узгодження» (AGREEM)
Алгоритм «Товарна специфікація» (COMDOC_008)
|
№ кроку |
МЕРЕЖА |
|
1.1 |
|
|
1.2 |
|
|
1.3 |
Відправлення підписаного документа «Товарна специфікація» (Мережа) |
|
№ кроку |
ПОСТАЧАЛЬНИК |
|
2.1 |
|
|
2.2 |
|
|
2.3 |
[*] - Після погодження (обоюдного підписання) «Товарної специфікації» (COMDOC_008) реалізована автоматична відправка документа «Електронна специфікація» (PRODUCTLIST) з урахуванням усіх погоджених змін. Мережа при цьому отримує документ через FTP сервіс EDIN. Перегляд усіх Cпецифікацій / Переглянути Специфікацію з конкретним контрагентом.
Помилки при роботі з API
Загальні помилки при роботі з API (для всіх сервісів EDIN) можна подивитись за посиланням.
Отримати список типів акцій GET /api/es/promotion/type
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/es/promotion/type |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; retailer_id - id Мережі на платформі EDIN. Якщо користувач має роль Постачальник, цей параметр є обов'язковим. |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
У відповідь приходить масив об'єктів XPromotionType.
Редагувати тип акції PUT /api/es/promotion/type
REQUEST
|
URL |
|
|
Метод запиту |
PUT |
|
URL запиту |
/api/es/promotion/type |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; retailer_id - id Мережі на платформі EDIN. Якщо користувач має роль Постачальник, цей параметр є обов'язковим. |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передаються параметри типу акції у JSON форматі (об'єкт XPromotionType).
Приклад запиту:
|
RESPONSE
Код сервера 200 (ok).
Створити новий тип акції POST /api/es/promotion/type
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/es/promotion/type |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; retailer_id - id Мережі на платформі EDIN. Якщо користувач має роль Постачальник, цей параметр є обов'язковим. |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передаються параметри типу акції у JSON форматі (об'єкт XPromotionType).
Приклад запиту:
|
RESPONSE
Код сервера 200 (ok).
Отримати список акцій GET /api/es/promotion
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/es/promotion |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; retailer_id - id Мережі на платформі EDIN. Якщо користувач має роль Постачальник, цей параметр є обов'язковим. |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
У відповідь приходить масив об'єктів XPromotion.
Видалити акцію DELETE /api/es/promotion
REQUEST
|
URL |
|
|
Метод запиту |
DELETE |
|
URL запиту |
/api/es/promotion |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; promotion_id (обов'язково) - id акції. |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
Код сервера 200 (ok).
Редагувати акцію PUT /api/es/promotion
REQUEST
|
URL |
|
|
Метод запиту |
PUT |
|
URL запиту |
/api/es/promotion |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передаються параметри акції у JSON форматі (об'єкт XPromotion). При цьому передача ключа id є обов'язковою.
Приклад запиту:
|
RESPONSE
Код сервера 200 (ok).
Створити нову акцію POST /api/es/promotion
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/es/promotion |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передаються параметри акції у JSON форматі (об'єкт XPromotion).
Приклад запиту:
|
RESPONSE
Код сервера 200 (ok).
Видалити групу / категорію (Мережа) DELETE /api/products/group
Даний метод може бути використано лише користувачем на стороні Мережі.
REQUEST
|
URL |
|
|
Метод запиту |
DELETE |
|
URL запиту |
/api/products/group |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; group_id (обов’язково) long - ідентифікатор групи/категорії для видалення |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
Response is empty
Створити нову групу / категорію (Мережа) POST /api/products/group
Даний метод може бути використано лише користувачем на стороні Мережі.
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/products/group |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; group_name (обов’язково) String - назва нової групи / категорії; parrent_group_id (опціонально) long - ідентифікатор вищого рівня в структурі (групи/категорії); За відсутності=0 |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передається ідентифікатор створеної групи/категорії (groupd_id):
{"id":230}
Відредагувати групу / категорію (Мережа) PUT /api/products/group
Даний метод може бути використано лише користувачем на стороні Мережі.
REQUEST
|
URL |
|
|
Метод запиту |
PUT |
|
URL запиту |
/api/products/group |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; group_name (обов’язково) String - назва нової групи / категорії; group_id (обов’язково) long - ідентифікатор групи/категорії, що буде відредагована; parrent_group_id (опціонально) long - ідентифікатор вищого рівня в структурі (групи/категорії); За відсутності=0 |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
Response is empty
Отримати доступні групи / категорії GET /api/products/group
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/products/group |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії (для мережі обидва параметра мають однакове значення); shard_gln (обов’язково) String - GLN мережі; group_id (опціонально) long - ідентифікатор групи/категорії |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді у вигляді масиву об’єктів передаються групи/категорії товарів.
Видалити зображення до товарної позиції (чернетка Комерційної пропозиції) DELETE /api/es/position/image
Даний метод може бути використано лише користувачем з роллю «Постачальник» для комерційних пропозицій в статусі «Чернетка».
REQUEST
|
URL |
|
|
Метод запиту |
DELETE |
|
URL запиту |
/api/es/position/image |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; position_id (обов’язково) String - ідентифікатор товарної позиції; image_type (обов’язково) String - тип зображення:
|
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
Код сервера 200 (ok).
Отримати зображення до товарної позиції Комерційної пропозиції GET /api/es/position/image
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/es/position/image |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; position_id (обов’язково) String - ідентифікатор товарної позиції; image_type (обов’язково) String - тип зображення:
|
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді в текстовому вигляді передається посилання на зображення:
https://static.edin.ua/agreement/positions/eds_ua_158182/logo/24523c0a-ea3e-4239-b15b-0a027cb991e2.jpg
Додати зображення до товарної позиції (чернетка Комерційної пропозиції) POST /api/es/position/image
Даний метод може бути використано лише користувачем з роллю «Постачальник» для комерційних пропозицій в статусі «Чернетка». Розмір зображення, що додається, не повинен перевищувати 5Мб.
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/es/position/image |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; position_id (обов’язково) String - ідентифікатор товарної позиції; image_type (обов’язково) String - тип зображення:
mime_type (обов’язково) String - згідно MIME типізації може бути переданий image/png або image/jpeg для відповідного формату зображення |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передається файл (зображення) в вигляді набору байтів |
RESPONSE
В тілі відповіді в текстовому вигляді передається посилання на збережене зображення:
https://static.edin.ua/agreement/positions/eds_ua_158182/logo/24523c0a-ea3e-4239-b15b-0a027cb991e2.jpg
Видалити товарну позицію чернетки Комерційної пропозиції (Постачальник) DELETE /api/es/position
REQUEST
|
URL |
|
|
Метод запиту |
DELETE |
|
URL запиту |
/api/es/position |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; agreement_uuid (обов’язково) String - унікальний ідентифікатор Комерційної пропозиції; position_id (обов’язково) String - ідентифікатор товарної позиції |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
Код сервера 200 (ok).
Редагувати товарну позицію чернетки Комерційної пропозиції (Постачальник) PUT /api/es/position
REQUEST
|
URL |
|
|
Метод запиту |
PUT |
|
URL запиту |
/api/es/position |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; agreement_uuid (обов’язково) String - унікальний ідентифікатор Комерційної пропозиції |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передаються дані позиції Комерційної пропозиції (об’єкт XAgreemDocPosition). |
RESPONSE
Код сервера 200 (ok).
Отримати дані товарних позицій всіх Комерційних пропозицій за фільтром POST /api/es/position/search
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/es/position/search |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; АБО guid (обов’язково) String - унікальний ідентифікатор власної організації на платформі |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передається набір фільтрів для відбору позицій Комерційних пропозицій (об’єкт XSearchPositionsQuery). |
RESPONSE
В тілі відповіді передаються дані відібраних товарних позицій всіх Комерційних пропозиції: масив об’єктів XAgreemDocPosition.
Отримати дані товарних позицій Комерційної пропозиції GET /api/es/position
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/es/position |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; agreement_uuid (обов’язково) String - унікальний ідентифікатор Комерційної пропозиції; position_id (опціонально) String - ідентифікатор товарної позиції |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передаються дані всіх товарних позицій Комерційної пропозиції або конкретної товарної позиції (якщо передавати position_id) - масив об’єктів XAgreemDocPosition.
Додати товарну позицію до чернетки Комерційної пропозиції (Постачальник) POST /api/es/position
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/es/position |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; agreement_uuid (обов’язково) String - унікальний ідентифікатор Комерційної пропозиції |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передаються дані позицій Комерційної пропозиції (масив об’єктів XAgreemDocPosition). |
RESPONSE
В тілі відповіді передаються дані доданих запитом товарних позицій Комерційної пропозиції: масив об’єктів XAgreemDocPosition.
Оновити внутрішній статус пропозиції PUT /api/es/agreement/sub_status
За допомогою цього методу оновлюється статус пропозиції лише у мережі.
REQUEST
|
URL |
|
|
Метод запиту |
PUT |
|
URL запиту |
/api/es/agreement/sub_status |
|
URL параметри |
doc_uuid (обов’язково) UUID - GUID пропозиції; status_id (обов’язково) int - id статусу |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
Код сервера 200 (ok).
Оновити статус документа (комерційної пропозиції / товарного узгодження) PUT /api/es/agreement/status
За допомогою цього методу оновлюється статус пропозиції у обох контрагентів.
REQUEST
|
URL |
|
|
Метод запиту |
PUT |
|
URL запиту |
/api/es/agreement/status |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; doc_uuid (обов’язково) UUID - GUID документа (комерційної пропозиції / товарного узгодження) sender_id (обов’язково) int - id отримувача recipient_id (обов’язково) int - id отримувача status_id (обов’язково) int - id статусу документа (комерційної пропозиції / товарного узгодження): Для Товарного узгодження (AGREEM):
Для Комерційної пропозиції (NOVELTY):
|
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу при відхиленні (AGREEM / NOVELTY: status_id=4) чи прийманні (NOVELTY: status_id=8) передається тіло відповідного документа, що містить коментар: |
RESPONSE
Код сервера 200 (ok).
Переглянути коментарі GET /api/es/agreement/comments
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/es/agreement/comments |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; agreement_uuid UUID - GUID пропозиції; |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передається список коментарів.
Створити коментар до пропозиції товарного переузгодження POST /api/es/agreement/comment
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/es/agreement/comment |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; uuid (обов’язково) UUID - унікальний ідентифікатор товарного узгодження; comment (обов’язково) String - текст коментаря; forAll (опціонально і лише для Мережі) Boolean:
|
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
multipart/form-data |
|
REQUEST |
|
|
Form-data |
В тілі запиту можуть передаватись файли-вкладення в інтерфейсі form-data (приклад запиту) |
RESPONSE
В тілі відповіді передаються дані коментаря.
Отримати Комерційну пропозицію в xlsx форматі (Excel) GET /api/es/agreement/offer/excel
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/es/agreement/offer/excel |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; АБО guid (обов’язково) String - унікальний ідентифікатор власної організації на платформі; agreement_uuid (обов’язково) String - унікальний ідентифікатор Комерційної пропозиції. |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передається Комерційна пропозиція в xlsx форматі (Excel).
Отримати XML контента документа «Товарна специфікація» (Мережа) GET /api/v2/es/agreement/comdoc
Даний метод виконується на стороні Мережі.
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/v2/es/agreement/comdoc |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; agreement_uuid (обов’язково) UUID - GUID «Товарного узгодження»; response_type (опціонально) String - формат очікуваної відповіді (формат «Товарної специфікації»); можливі варіанти:
|
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передається XML контента документа Товарна специфікація (COMDOC_008) в заданому вигляді.
Відправити підписаний документ «Товарна специфікація» (Мережа) PATCH /api/v2/es/agreement/comdoc
Даний метод виконується на стороні Мережі.
REQUEST
|
URL |
|
|
Метод запиту |
PATCH |
|
URL запиту |
/api/v2/es/agreement/comdoc |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; agreement_uuid (обов’язково) UUID - GUID «Товарного узгодження» |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передається підписаний контент (p7s) Товарної специфікації (COMDOC_008) в бінарному вигляді чи в base64. Під час відпрацювання цього методу здійснюється перевіка (порівняння) змісту тіла «Товарної специфікації», що відправляється цим методом з контентом цього документа, що записується в систему під час Приймання «Товарного узгодження» (документ отримує статус «Готовий до підписання»). Якщо документи по структурі не співпадають, то у відповідь Ви отримаєте помилку: «Signed content from p7s does not match generated comdoc» |
RESPONSE
Код сервера 200 (ok).
Прийняти «Товарне узгодження» (Мережа) POST /api/v2/es/agreement/comdoc
Даний метод виконується на стороні Мережі для підготовки «Товарного узгодження» до підписання (документ отримує статус «Готовий до підписання»). В результаті роботи методу відбувається формування «Товарної специфікації».
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/v2/es/agreement/comdoc |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; agreement_uuid (обов’язково) UUID - GUID «Товарного узгодження»; response_type (опціонально) String - формат очікуваної відповіді (формат «Товарної специфікації»); можливі варіанти:
|
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передається XML контента документа Товарна специфікація (COMDOC_008) в заданому вигляді.
Відхилити «Товарне узгодження» (Мережа) PATCH /api/v2/es/agreement/reject
Даний метод виконується на стороні Мережі. При відхиленні документа всі позиції «Товарного узгодження» стають відхиленими автоматично.
REQUEST
|
URL |
|
|
Метод запиту |
PATCH |
|
URL запиту |
/api/v2/es/agreement/reject |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; agreement_uuid (обов’язково) UUID - GUID «Товарного узгодження» |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу (в json форматі) передається причина відхилення «Товарного узгодження» в текстовому вигляді. |
RESPONSE
Код сервера 200 (ok).
Прийняти/Відхилити позиції «Товарного узгодження» (Мережа) PATCH /api/v2/es/agreement/positions
Даний метод виконується на стороні Мережі. Метод дозволяє змінити «Дати дії нової ціни» (опціонально).
REQUEST
|
URL |
|
|
Метод запиту |
PATCH |
|
URL запиту |
/api/v2/es/agreement/positions |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; agreement_uuid (обов’язково) UUID - GUID «Товарного узгодження»; action (обов’язково) String - дія по позиціям (передаються в тілі запиту):
price_start_date (опціонально) Дата (РРРР-ММ-ДД) - дата початку дії нової ціни «Товарного узгодження»; price_end_date (опціонально) Дата (РРРР-ММ-ДД) - дата завершення дії нової ціни «Товарного узгодження» |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу в json передається масив об’єктів з ідентифікаторами позиції «Товарного узгодження» (штрихкод+артикул товарної позиції), наприклад:
|
Якщо тіло запиту буде порожнім, то дія (action) застосовується до всіх позицій «Товарного узгодження»!
RESPONSE
Код сервера 200 (ok).
Формування та отримання Excel-звіту по акціях GET /api/es/agreement/excel
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/es/agreement/excel |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; АБО guid (обов’язково) String - унікальний ідентифікатор власної Компанії; promotion_id (обов’язково) String - ідентифікатор акції |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передається звіт у вигляді xlsx-файлу.
Пошук «Товарних узгоджень» (AGREEM) з фільтрацією POST /api/es/agreements/search
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/es/agreements/search |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; АБО guid - рядок; унікальний ідентифікатор організації в системі |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передаються критерії пошуку/фільтрації документів. |
RESPONSE
В тілі відповіді в json-форматі передається масив об’єктів з даними по знайденим узгодженням.
Клонувати товарне узгодження (створення пропозиції) PUT /api/es/agreement/copy
Даний метод може бути використано лише користувачем з роллю «Постачальник».
REQUEST
|
URL |
|
|
Метод запиту |
PUT |
|
URL запиту |
/api/es/agreement/copy |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; agreement_uuid (обов’язково) UUID - GUID узгодження для клонування |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді в json-форматі передається GUID створеної пропозиції (вказується в подальших методах):
JSON:
{"uuid":"c1efa050-2633-49f4-9a98-bd9059e20215"}
Отримання інформації про сертифікати підписантів GET /api/es/agreement/signers
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/es/agreement/signers |
|
URL параметри |
gln - рядок (13); номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта; АБО guid - рядок; унікальний ідентифікатор організації в системі agreement_uuid - рядок; GUID пропозиції |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передається інформація про підписантів (масив об’єктів ExEndUserSignInfo).
Надіслати підписану пропозицію PATCH /api/es/agreement/comdoc
Даний метод може бути використано лише користувачем з роллю «Мережа». За допомогою цього методу мережа може надіслати підтвердженний та вже підписаний документ. Підписання відбувається лише на web платформі!
REQUEST
|
URL |
|
|
Метод запиту |
PATCH |
|
URL запиту |
/api/es/agreement/comdoc |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; agreement_uuid (обов’язково) UUID - GUID пропозиції; recipient_id (обов’язково) int - id отримувача |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
Код сервера 200 (ok).
Надіслати пропозицію (переузгодження) (для Постачальника) PATCH /api/es/agreement
При відправці товарного узгодження створюється документ з вкладеннями, що були прикріплені до чернетки.
REQUEST
|
URL |
|
|
Метод запиту |
PATCH |
|
URL запиту |
/api/es/agreement |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; agreement_uuid (обов’язково) UUID - GUID документа (комерційної пропозиції / товарного узгодження); recipient_id (обов’язково) int - id отримувача |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
Код сервера 200 (ok).
Додати обгрунтування до пропозиції товарного переузгодження (Постачальник) POST /api/es/attachment
Даний метод виконується на стороні Постачальника для прискорення погодження. В якості обгрунтування до документу можливо додати максимум 5 файлів розміром кожного не більше 5 МБ в наступних форматах: PDF/JPG/JPEG/PNG/BMP/DOC/DOCX/XLS/XLSX/PPT/PPTX/TXT.
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/es/attachment |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; agreement_uuid (обов’язково) UUID - унікальний ідентифікатор товарного узгодження; file_name (обов’язково) String - назва файлу-вкладення; file_type (обов’язково) String - тип файлу згідно MIME типізації |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
Код сервера 200 (ok).
Отримати контент файлу-вкладення товарного узгодження чи коментаря GET /api/es/attachment/body
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/es/attachment/body |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; agreement_uuid (обов’язково) UUID - унікальний ідентифікатор товарного узгодження; attachment_id (обов’язково) long - ідентифікатор вкладення |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/octet-stream |
RESPONSE
В тілі відповіді передається контент файлу-вкладення в бінарному вигляді.
Отримати список вкладень до пропозиції товарного переузгодження чи конкретного коментаря документа GET /api/es/attachment
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/es/attachment |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; agreement_uuid (обов’язково) UUID - унікальний ідентифікатор товарного узгодження; comment_id (опціонально) long - ідентифікатор коментаря з вкладеннями; якщо параметр не передається або передається comment_id=0, то у відповідь повертаються дані вкладень до документа, а не коментаря |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді в json-форматі передається масив об’єктів з інформацією про вкладення.
Видалити вкладення (обгрунтування) пропозиції товарного переузгодження DELETE /api/es/agreement/attachment
Даний метод може бути використано лише користувачем з роллю «Постачальник». Видалити вкладення можливо лише в Пропозиції в статусі «Чернетка».
REQUEST
|
URL |
|
|
Метод запиту |
DELETE |
|
URL запиту |
/api/es/agreement/attachment |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; agreement_uuid (обов’язково) UUID - унікальний ідентифікатор товарного узгодження; attachment_id (опціонально) long - ідентифікатор вкладення; якщо не передається, то видаляються всі вкладення |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
Код сервера 200 (ok).
Видалити пропозицію DELETE /api/es/agreement
Даний метод може бути використано лише користувачем з роллю «Постачальник». Видалити документ можливо лише в статусі «Чернетка»(status=1)!
REQUEST
|
URL |
|
|
Метод запиту |
DELETE |
|
URL запиту |
api/es/agreement |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; agreement_uuid UUID - GUID документа (комерційної пропозиції / товарного узгодження) |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
Код сервера 200 (ok).
Оновити тіло документа (комерційної пропозиції / товарного узгодження) PUT /api/es/agreement/body
Користувач з роллю «Постачальник» за допомогою цього методу може замінити файл обгрунтування, але лише поки пропозиція у статусі «Чернетка». Користувач з роллю «Мережа» за допомогою цього методу може оновити тіло пропозиції (наприклад змінити ціни).
REQUEST
|
URL |
|
|
Метод запиту |
PUT |
|
URL запиту |
/api/es/agreement/body |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; agreement_uuid (обов’язково) UUID - GUID пропозиції; body_type (обов’язково) int - тип даних; число (1-AGREEM; 3-вкладення обгунтування); |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передаються тіло документа Товарне узгодження (AGREEM) / Комерційна пропозиція (NOVELTY) (json) у вигляді байтмассива |
RESPONSE
Код сервера 200 (ok).
Отримати тіло документа (комерційної пропозиції / товарного узгодження) GET /api/es/agreement/body
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/es/agreement/body |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; agreement_uuid (обов’язково) UUID - GUID пропозиції; body_type (обов’язково) int - тип даних; число (1-AGREEM; 2-налаштування; 3-вкладення); |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді методу передається тіло документа.
Створити тіло документа (комерційної пропозиції / товарного узгодження) / Додати обгрунтування до пропозиції POST /api/es/agreement/body
Даний метод може бути використано лише користувачем з роллю «Постачальник». За допомогою цього методу можливо додати обгрунтування, але лише поки пропозиція у статусі «Чернетка».
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/es/agreement/body?gln=9864067620417&agreement_uuid=e9xxxxa0-aed2-4cd8-b8ba-c6070ecab278&body_type=2 |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; agreement_uuid UUID - GUID документа (комерційної пропозиції / товарного узгодження) (метод створення документа); body_type (обов’язково) long - тип тіла
при body_type=3 вказується attacheName String - назва файла-вкладення разом з роширенням; при body_type=3 вказується attacheMime String - тип файлу-вкладення - application/pdf (може бути переданий файл лише в pdf форматі згідно MIME типізації ) |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передаються:
|
RESPONSE
Код сервера 200 (ok).
Редагувати пропозицію (переузгодження) (для Постачальника) PUT /api/es/agreement
Даний метод виконується лише на стороні Постачальника (роль користувача) для комерційних пропозицій / товарних узгоджень в статусі «Чернетка» (status=1)!
REQUEST
|
URL |
|
|
Метод запиту |
PUT |
|
URL запиту |
/api/es/agreement |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передаються дані для редагування вказаного документа (поле **uuid** передається обов'язково). |
RESPONSE
Код сервера 200 (ok).
Створити пропозицію (переузгодження) (для Постачальника) POST /api/es/agreement
При переузгодженні потрібно створити пропозицію (документ «Товарне узгодження» AGREEM). Один AGREEM може бути пов’язаний лише з одним COMDOC_008, тобто при повторному створенні AGREEM на підставі того ж COMDOC_008 (параметр parent_doc_uuid) буде виникати помилка.
Даний метод може бути використано лише користувачем з роллю «Постачальник».
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/es/agreement |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; sender_id (обов’язково) long - id відправника; recipient_id (обов’язково) long - id одержувача; retailer_id (обов’язково) long - id мережі; contract_uuid (обов’язково) UUID - GUID контракту / договору; type (обов’язково) int - тип документа (1-AGREEM, 2-COMDOC_008, 3-NOVELTY); doc_date (обов’язково) long - дата ствоення документа; doc_number (обов’язково) String - номер документа; status_id (обов’язково) int - статус документа (1-чернетка); parent_doc_uuid UUID - GUID документа-підстави (початкового документа); signperiod String - встановлений період підписання |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передається документ: |
RESPONSE
В тілі відповіді в json-форматі передається GUID створеної пропозиції (вказується в подальших методах):
JSON:
{7a2eee64-f4f0-4388-8023-122d03899a3c}
Отримати дані пропозиції (товарного узгодження) GET /api/es/agreement
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/es/agreement |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; agreement_uuid (обов’язково) String - GUID документа (комерційної пропозиції / товарного узгодження) |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді в json-форматі передається об’єкт з інформацією про документ.
Переглянути налаштування мережі GET /api/oas/retailer/settings
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/oas/retailer/settings |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; retailer_id (обов’язково) long - id мережі |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді в json-форматі передається об’єкт з налаштуваннями мережі.
Отримати список документів в журналі GET /api/es/agreements
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/es/agreements |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії АБО guid (обов’язково) String - унікальний ідентифікатор власної організації на платформі; limit (опціонально) int - ліміт вибірки (за замовчуванням=20); offset (опціонально) int - зміщення відносно верхньої межі вибірки (за замовчуванням=0) |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді в json-форматі передається масив з інформацією про пропозиції .
Пошук контрактів/специфікацій (з фільтрацією) POST /api/es/contracts/search
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/es/contracts/search |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; АБО guid - рядок; унікальний ідентифікатор організації в системі |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передаються критерії пошуку/фільтрації. |
RESPONSE
В тілі відповіді в json-форматі передається масив об’єктів - знайдені контракти/специфікації.
Видалити контракт/товарні позиції в контракті DELETE /api/es/contract/data
Для видалення всього контракту разом з усіма його позиціями тіло запиту передавати не потрібно. Для видалення конкретних позицій з контракту в тілі запиту потрібно передавати об’єкт зі списком id позицій з конкретного контракту.
Наприклад:
{
"productID": [
0,
21212121,
113
]
}Щоб отримати інформацію по контракту з товарними позиціями, можна скористатись методом за посиланням.
REQUEST
|
URL |
|
|
Метод запиту |
DELETE |
|
URL запиту |
/api/es/contract/data |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; contract_uuid (обов’язково) UUID - GUID контракту |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу може передаватись об’єкт з масивом productID, що містить список id позицій вказаного контракту (видалення позицій). Для видалення контракту тіло запиту не передається. |
RESPONSE
В тілі відповіді в json-форматі передаються деталі результату операції видалення.
Переглянути контракт з конкретним контрагентом GET /api/es/contract
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/es/contract |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; contract_uuid (обов’язково) String - GUID контракту / договору |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді в json-форматі передається об’єкт з інформацією про контракти .
Переглянути усі контракти/специфікації GET /api/es/contracts
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/es/contracts |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; expireFrom (опціонально) unix timestamp - завершення терміну дії контракту/специфікації «Від»; expireTo (опціонально) unix timestamp - завершення терміну дії контракту/специфікації «До» |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
Приклади формування запиту:
-
отримати всі контракти/специфікації:
GET /api/es/contracts?gln=9864232319962 -
отримати всі актуальні контракти/специфікації:
GET /api/es/contracts?gln=9864232319962&expireFrom=1601539901 -
отримати всі прострочені контракти/специфікації:
GET /api/es/contracts?gln=9864232319962&expireTo=1601539901 -
отримати контракти/специфікації, термін дії яких завершився/завершується у вказаний період:
GET /api/es/contracts?gln=9864232319962&expireFrom=1601367101&expireTo=1601539901
RESPONSE
В тілі відповіді в json-форматі передається об’єкт з інформацією про контракти/специфікації .
Оновити раніше створенуї специфікацію (Мережа) PUT /api/es/contract
Даний метод виконується на стороні Мережі.
REQUEST
|
URL |
|
|
Метод запиту |
PUT |
|
URL запиту |
/api/es/contract |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії (Мережі); contract_uuid (обов’язково) UUID - GUID контракту / договору |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json or application/xml |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передається тіло документа Електронна специфікація (PRODUCTLIST) в json чи xml форматі відповідно до значення Content-Type |
RESPONSE
Код сервера 200 (ok).
Створити нову специфікацію (Мережа) POST /api/es/contract
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/es/contract |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії (Мережі) |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json or application/xml |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передається тіло документа Електронна специфікація (PRODUCTLIST) в json чи xml форматі відповідно до значення Content-Type |
RESPONSE
В тілі відповіді передається ідентифікатор контракту нової специфікації:
{"contract_uuid": "1a06eda0-2b5f-4fbc-a6d4-3a96d4353da6"}
Вказати нові дії узгодження для вказаного користувача в розрізі кожного підтипу документа AGREEM POST /api/es/user/spec_status
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/es/user/spec_status |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії АБО guid (обов’язково) String - унікальний ідентифікатор власної організації на платформі user_id (обов’язково) long - ідентифікатор користувача |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передаються нові налаштування дій узгодження для вказаного користувача в розрізі кожного підтипу документа AGREEM (об’єкт SpecStatus). |
RESPONSE
Код сервера 200 (ok).
Вказати нові активні GLN користувача (за якими відображаються категорії товарів) POST /api/es/user/spec_view_glns
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/es/user/spec_view_glns |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії АБО guid (обов’язково) String - унікальний ідентифікатор власної організації на платформі user_id (обов’язково) long - ідентифікатор користувача |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передаються пов’язані з користувачем номера GLN, що мають бути активні (за якими будуть відображатись категорії товарів в сервісі Е-Специфікація), наприклад: |
RESPONSE
Код сервера 200 (ok).
Вказати нові статуси документів, в яких документи будуть доступні користувачу до перегляду POST /api/es/user/spec_view_statuses
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/es/user/spec_view_statuses |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії АБО guid (обов’язково) String - унікальний ідентифікатор власної організації на платформі user_id (обов’язково) long - ідентифікатор користувача |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передаються ідентифікатори статусів, в яких документи будуть доступні користувачу до перегляду в сервісі Е-Специфікація, наприклад:
|
RESPONSE
Код сервера 200 (ok).
Отримати налаштування дій узгодження для вказаного користувача в розрізі кожного підтипу документа AGREEM GET /api/es/user/spec_status
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/es/user/spec_status |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії АБО guid (обов’язково) String - унікальний ідентифікатор власної організації на платформі user_id (обов’язково) long - ідентифікатор користувача |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді в json-форматі передається налаштування дій узгодження для вказаного користувача в розрізі кожного підтипу документа AGREEM (об’єкт SpecStatus).
Отримати всі активні GLN користувача (за якими відображаються категорії товарів) GET /api/es/user/spec_view_glns
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/es/user/spec_view_glns |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії АБО guid (обов’язково) String - унікальний ідентифікатор власної організації на платформі user_id (обов’язково) long - ідентифікатор користувача |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді в json-форматі передаються ідентифікатори активних (включених) GLN користувача (за якими відображаються категорії товарів в сервісі «Е-Специфікація»), наприклад: [174988,174990].
Отримати всі статуси документів, в яких документи доступні користувачу до перегляду GET /api/es/user/spec_view_statuses
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/es/user/spec_view_statuses |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії АБО guid (обов’язково) String - унікальний ідентифікатор власної організації на платформі user_id (обов’язково) long - ідентифікатор користувача |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді в json-форматі передаються ідентифікатори статусів, в яких документи доступні користувачу для перегляду в сервісі «Е-Специфікація», наприклад: [12,14,15,17,18] (детальніше).
Отримати всі пов’язані GLN користувача в сервісі «Е-Специфікація» GET /api/es/user/spec_all_glns
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/es/user/spec_all_glns |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії АБО guid (обов’язково) String - унікальний ідентифікатор власної організації на платформі |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді в json-форматі передається інформація про пов’язані GLN (масив об’єктів Identificator).
Отримати інформацію про всіх користувачів компанії (на рівні акаунта) GET /api/oas/account/users
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/oas/account/users |
|
URL параметри |
type (опціонально) String - тип очікуваної відповіді; можливі варіанти:
|
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передається інформація про користувачів (масив об’єктів User).
API сервісу Маркет
Перелік методів АРІ сервіс Маркет
Для роботи з методами користувач повинен бути авторизованим
Готову колекцію основних методів API сервісу Маркет для Postman можна завантажити за посиланням: Сервіс -EDIN-Market-.postman_collection.json
Запрошення
|
Відправити запрошення Покупцю |
POST /api/distribex/invitation |
|
Отримати запрошення Продавця в сервіс «Маркет»/Отримати вкладення до вказаного запрошення |
GET /api/distribex/invitation |
|
Прийняти / Відхилити запрошення Продавця |
POST /api/distribex/invitation |
|
Повторно відправити запрошення Покупцю |
PATCH /api/distribex/invitation |
|
Видалити відправлені запрошення Покупцю |
DELETE /api/distribex/invitation
|
Робота з обмеженнями
|
Додати/змінити обмеження (ініціатор Продавець (Виробник)) |
POST /api/distribex/limits |
|
Отримати обмеження контрагента за GLN |
GET /api/distribex/limits |
|
Видалити обмеження для контрагента (ініціатор Продавець (Виробник)) |
DELETE /api/distribex/limits |
Робота з квотами
|
Встановити нові квоти для Покупців (Дистриб'юторів) |
PUT /api/distribex/quotas |
|
Отримати квоти по товару для вказаного Покупця (Дистриб'ютора) |
GET /api/distribex/quotas |
|
Масово видалити квоти в прайс-листі для Покупця (Дистриб'ютора) |
DELETE /api/distribex/quotas |
Робота з надбавками
|
Встановити відмітку «Надбавка» для Покупців (Дистриб'юторів) |
PUT /api/distribex/surcharge |
|
Отримати дані надбавки по товару для вказаного Покупця (Дистриб'ютора) |
GET /api/distribex/surcharge |
|
Масово видалити відмітку надбавки в прайс-листі для Покупця (Дистриб'ютора) |
DELETE /api/distribex/surcharge |
Робота з «Прайс-листами»
|
Додати або оновити дані товарів у Прайс-листі для вказаних Покупців (Дистриб’юторів) |
POST /api/distribex/pricelist |
|
Редагувати дані товарів «Прайс-листа» вказаного Покупця (Дистрибʼютора) |
PUT /api/distribex/pricelist |
|
Отримати дані «Прайс-листа» для вказаного Покупця (Дистрибʼютора) |
GET /api/distribex/pricelist |
|
Видалити позицію або «Прайс-лист» для вказаного Покупця (Дистрибʼютора) |
DELETE /api/distribex/pricelist |
Робота з Замовленнями
(Покупець (Дистрибʼютор))
|
Зберегти (відредагувати) Замовлення за «Прайс-листом» |
PUT /api/distribex/preorder |
|
Отримати дані для формування Замовлення по «Прайс-листу» |
GET /api/distribex/preorder |
|
Зберегти Замовлення по «Прайс-листу» |
POST /api/distribex/preorder |
|
Видалити Замовлення |
DELETE /api/distribex/preorder |
|
Надсилання документа (без створення чернетки) |
POST /api/eds/doc/create_and_send |
Робота з рекомендаціями до замовлення
(Продавець (Виробник))
|
Відправити рекомендації до замовлення за «Прайс-листом» |
POST /api/eds/doc/create_and_send |
Робота з документами
|
Створити (розрахувати) номер «Замовлення» (ORDER) |
GET /api/oas/doc_counter |
|
Створити документ «Замовлення» (ORDER) за «Прайс-листом» |
POST /api/distribex/doc/order |
|
Створити копію документа «Замовлення» (ORDER) відповідно до актуального «Прайс-листа» |
POST /api/distribex/order/copy |
|
Отримання контенту документа |
GET /api/eds/doc/body |
|
Пошук документів (з фільтрацією), вибір списку документів |
POST /api/eds/docs/search |
|
Визначення переліку товарних позицій, доступних для повернення, та формування документа “Надсилання Повернення” (ініціатор - Покупець / Дистриб’ютор) |
POST /api/distribex/doc/retann |
Робота з дозволами
|
Отримати список контрагентів-Покупців (Дистриб'юторів) |
GET /api/distribex/distributor/list |
|
Отримати список контрагентів-Продавців (Виробників) |
GET /api/distribex/producers/list |
Робота з товарами/товарним довідником
|
Відредагувати товарну позицію «Прайс-листа» |
PUT /api/distribex/product |
|
Отримати список категорій товарів Прайс-листа |
GET /api/distribex/categories |
|
Видалити товарну позицію з «Прайс-листа» |
DELETE /api/distribex/product |
Робота з групами Покупців
(Дистрибʼюторів)
|
Отримати дані про створені групи Покупців (Дистрибʼюторів) (на стороні Продавця (Виробника)) |
GET /api/distribex/accessgroup |
|
Створити групу Покупців (Дистрибʼюторів) (на стороні Продавця (Виробника)) |
POST /api/distribex/accessgroup |
|
Перейменувати поточну групу Покупців (Дистрибʼюторів) (на стороні Продавця (Виробника)) |
PUT /api/distribex/accessgroup |
|
Видалити групу Покупців (Дистрибʼюторів) (на стороні Продавця (Виробника)) |
DELETE /api/distribex/accessgroup |
|
Додати Покупця (Дистрибʼютора) до групи Покупців (Дистрибʼюторів) (на стороні Продавця (Виробника)) |
POST /api/distribex/useraccessgroup |
|
Видалити Покупця (Дистрибʼютора) з групи Покупців (Дистрибʼюторів) |
DELETE /api/distribex/useraccessgroup |
Робота з Графіком замовлень
|
Отримати список графіків замовлень (Продавець (Виробник) |
GET /api/distribex/producer/schedules |
|
Створити графік замовлень (Продавець (Виробник) |
POST /api/distribex/producer/schedules |
|
Оновити графік замовлення (Продавець (Виробник) |
PATCH /api/distribex/producer/schedules |
|
Видалити графік замовлення (Продавець (Виробник) |
DELETE /api/distribex/producer/schedules |
|
Отримати найактуальніші графіки замовлень для зазначеного списку Продавців (Виробників) (Покупець (Дистриб'ютор)) |
POST /api/distribex/distributor/schedules |
|
Отримати перелік дат доступних для відправлення замовлень у вибраному місяці згідно з графіком Продавця (Виробника) (Покупець (Дистриб'ютор)) |
POST /api/distribex/schedule/dates |
Картка продавця
|
Створення картки продавця |
POST api/oas/supplier |
|
Оновлення картки продавця |
PUT api/oas/supplier |
|
Отримання картки продавця |
GET api/oas/supplier |
|
Завантаження логотипа |
POST api/oas/logo/create |
|
Отримання логотипа за посиланням на динамічний роут |
GET api/oas/logo/supplier |
Звернення
|
Створити звернення |
POST api/distribex/buyer/request |
|
Редагування звернення |
PUT api/distribex/buyer/request |
|
Оновлення статусу звернення |
PATCH api/distribex/buyer/request |
|
Отримання переліку звернень |
GET api/distribex/buyer/request |
Опис помилок сервісу Маркет
|
Код відповіді |
Індекс помилки |
Текст помилки |
Опис |
|
400 |
ERR_MRKT-1 |
Validation document errors: [%s] Документ містить помилки: [%s] |
Помилка виникає, якщо не передати обов'язковий url-параметр |
|
400 |
ERR_MRKT-2 |
No connection between producer and distributor Відсутній зв’язок між Продавцем (Виробником) і Покупцем (Дистрибʼютором) |
|
|
400 |
ERR_MRKT-3 |
The currency doesn’t match the one already set Валюта не відповідає вже встановленій |
|
|
400 |
ERR_MRKT-4 |
Save pricelist error: [%s] Помилка при збереженні прайсу: [%s] |
|
|
400 |
ERR_MRKT-5 |
Position with barcode [%s] not found in original order Позиції зі штрихкодом [%s] не знайдено в оригінальному замовленні |
|
|
400 |
ERR_MRKT-6 |
The „VAT included“ doesn’t match the one already set Ознака „З/Без ПДВ“ у прайсі що існує відрізняється |
|
|
400 |
ERR_MRKT-7 |
Some positions don’t have a price %s vat По деяких позиціях відсутня ціна %s ПДВ |
Отримання переліку звернень GET api/distribex/buyer/request
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
GET |
|
URL запиту |
/api/distribex/buyer/request |
|
URL параметри |
producer_id (опціонально) - звернення до конкретного продавця gln (обов’язково) String - GLN власної Компанії |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
RESPONSE
Код сервера 200 (ok).
Приклад відповіді
[
{
"id": 3,
"producerId": 13206429,
"glnId": 13208197,
"text": "Я просто тестую звернення, тому і створив оце одне, щоб подивитися чи те, що я зробив, взагалі працює.. тепер от змінив текст трохи..",
"status": 0,
"contactPerson": {
"firstName": "Alex",
"lastName": "Marchenko",
"phoneNumber": "+380992323992"
}
}
]
Оновлення статусу звернення PATCH api/distribex/buyer/request
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
PATCH |
|
URL запиту |
/api/distribex/buyer/request |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
|
|
REQUEST |
|
|
JSON Body |
У тілі запиту необхідно передати перелік ID звернень для оновлення статусу. |
RESPONSE
Код сервера 200 (ok).
Редагування звернення PUT api/distribex/buyer/request
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
PUT |
|
URL запиту |
/api/distribex/buyer/request |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
RESPONSE
Код сервера 200 (ok).
Створити звернення POST api/distribex/buyer/request
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
POST |
|
URL запиту |
/api/distribex/buyer/request |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
multipart/form-data, де:
|
Приклад запиту
{
"producerId": 13206429,
"glnId": 13208197,
"text": "Я просто тестую звернення, тому і створив оце одне, щоб подивитися чи те, що я зробив, взагалі працює..",
"contactPerson": {
"firstName": "Alex",
"lastName": "Marchenko",
"phoneNumber": "+380992323992"
}
}RESPONSE
Код сервера 200 (ok).
Отримання логотипа за посиланням на динамічний роут GET api/oas/logo/supplier
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
GET |
|
URL запиту |
api/oas/logo/supplier/1.jpg |
|
URL параметри |
logo (обов’язково) |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
RESPONSE
Код сервера 200 (ok).
Завантаження логотипа POST api/oas/logo/create
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
POST |
|
URL запиту |
api/oas/logo/create |
|
URL параметри |
gln (обов’язково) String - GLN Продавця (Виробника) |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
Код сервера 200 (ok).
Отримання картки продавця GET api/oas/supplier
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
GET |
|
URL запиту |
api/oas/supplier |
|
URL параметри |
gln (обов’язково) String - GLN Продавця (Виробника) |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
Код сервера 200 (ok).
Приклад відповіді
{
"id": 1,
"name": "Хлібна майстерня",
"description": "Хлібна майстерня» — це більше ніж пекарня...",
"phone": "+380954603452",
"logo": "1.jpg",
"glnId": 13208197,
"accountId": 40895
}
Оновлення картки продавця PUT api/oas/supplier
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
PUT |
|
URL запиту |
api/oas/supplier |
|
URL параметри |
gln (обов’язково) String - GLN Продавця (Виробника) |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
Приклад запиту
{
"id": 1
"name": "Хлібна майстерня",
"description": "Хлібна майстерня» — це більше ніж пекарня. Це місце, де давні традиції випікання поєднуються із сучасними підходами до якості й смаку. Ми віримо, що справжній хліб має народжуватися з любові до ремесла та натуральних інгредієнтів, тому кожен наш буханець — це результат кропіткої роботи, уваги до деталей і поваги до класичних рецептів.",
"phone": "+380954603452",
"glnId": 13208197,
"accountId": 40895
}RESPONSE
Код сервера 200 (ok).
Створення картки продавця POST api/oas/supplier
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
POST |
|
URL запиту |
api/oas/supplier |
|
URL параметри |
gln (обов’язково) String - GLN Продавця (Виробника) |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
Приклад запиту
{
"name": "Хлібна майстерня",
"description": "Хлібна майстерня» — це більше ніж пекарня. Це місце, де давні традиції випікання поєднуються із сучасними підходами до якості й смаку. Ми віримо, що справжній хліб має народжуватися з любові до ремесла та натуральних інгредієнтів, тому кожен наш буханець — це результат кропіткої роботи, уваги до деталей і поваги до класичних рецептів.",
"phone": "+380954603452",
"glnId": 13208197,
"accountId": 40895
}RESPONSE
Код сервера 200 (ok).
Отримати перелік дат доступних для відправлення замовлень у вибраному місяці згідно з графіком Продавця (Виробника) (Покупець (Дистриб'ютор)) POST /api/distribex/schedule/dates
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/distribex/schedule/dates |
|
URL параметри |
year (обов’язково) int - рік; month (обов’язково) int - порядковий номер місяця |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передається повний об’єкт графіка замовлень (об’єкт Schedule), що може бути отриманий методом POST /api/distribex/distributor/schedules |
RESPONSE
В тілі відповіді передається список дат, наприклад: [1,2,3,4,5,6,7,8,9,10]
Отримати найактуальніші графіки замовлень для зазначеного списку Продавців (Виробників) (Покупець (Дистриб'ютор)) POST /api/distribex/distributor/schedules
Метод враховує ієрархію типів графіків: якщо у Продавця (Виробника) вже діє загальний графік, але для конкретного Покупця (Дистрибʼютора) існує індивідуальний графік, який починає діяти пізніше (після поточної дати), у відповіді буде повернено саме індивідуальний графік.
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
POST |
|
URL запиту |
/api/distribex/distributor/schedules |
|
URL параметри |
gln (обов’язково) String - GLN Покупця (Дистрибʼютора) |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передається список ідентифікаторів GLN Продавців (Виробників) (масив значень gln_id), наприклад: [13200757] |
RESPONSE
В тілі відповіді передаються дані графіка замовлень за кожним вказаним Продавцем (Виробником) (об’єкт Schedule).
Видалити графік замовлення (Продавець (Виробник) DELETE /api/distribex/producer/schedules
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
DELETE |
|
URL запиту |
/api/distribex/producer/schedules |
|
URL параметри |
gln (обов’язково) String - GLN Продавця (Виробника) schedule_id (обов’язково) long - ідентифікатор графіка замовлень |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
Код сервера 200 (ok).
Оновити графік замовлення (Продавець (Виробник) PATCH /api/distribex/producer/schedules
Правило оновлення графіка замовлень
-
При оновленні графіка необхідно передавати всі параметри, так само як і при створенні.
Параметри, що не передаються в «оновленому графіку», автоматично затираються.
- Не допускається графік замовлень, який має перетин дат з іншим графіком для одного й того ж Покупця (Дистриб’ютора) та типу графіка.
- При створенні графіка для конкретного Покупця (Дистриб’ютора) з type = 1 система виконує перевірку усіх існуючих графіків цього Продавця (Виробника) для вказаного Покупця (Дистриб’ютора) (також з типом = 1).
- Якщо буде знайдено перетин дат, система поверне помилку:
Dates can’t overlap with already existing schedule, name - [Test2]. Please edit your schedule.
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
PATCH |
|
URL запиту |
/api/distribex/producer/schedules |
|
URL параметри |
gln (обов’язково) String - GLN Продавця (Виробника) |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передаються нові дані для зазначеного графіка замовлень (об’єкт Schedule) |
RESPONSE
Код сервера 200 (ok).
Створити графік замовлень (Продавець (Виробник) POST /api/distribex/producer/schedules
Правило створення графіка замовлень
Не допускається створення графіка замовлень, який має перетин дат з іншим графіком для одного й того ж Покупця (Дистриб’ютора) та типу графіка.
- При створенні графіка для конкретного Покупця (Дистриб’ютора) з type = 1 система виконує перевірку усіх існуючих графіків цього Продавця (Виробника) для вказаного Покупця (Дистриб’ютора) (також з типом = 1).
- Якщо буде знайдено перетин дат, система поверне помилку:
Dates can’t overlap with already existing schedule, name - [Test2]. Please edit your schedule.
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
POST |
|
URL запиту |
/api/distribex/producer/schedules |
|
URL параметри |
gln (обов’язково) String - GLN Продавця (Виробника) |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передаються дані графіка замовлень (об’єкт Schedule) |
RESPONSE
В тілі відповіді передаються дані графіка замовлень (об’єкт Schedule).
Отримати список графіків замовлень (Продавець (Виробник) GET /api/distribex/producer/schedules
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
GET |
|
URL запиту |
/api/distribex/producer/schedules |
|
URL параметри |
gln (обов’язково) String - GLN Продавця (Виробника) limit (опціонально) int - ліміт вибірки (за замовчуванням=20); offset (опціонально) int - зміщення відносно верхньої межі вибірки (за замовчуванням=0) |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передається список графіків замовлень (масив об’єктів Schedule) відсортованих за датою створення/оновлення.
Видалити Покупця (Дистрибʼютора) з групи Покупців (Дистрибʼюторів) DELETE /api/distribex/useraccessgroup
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
DELETE |
|
URL запиту |
/api/distribex/useraccessgroup |
|
URL параметри |
gln (обов’язково) String - GLN Продавця (Виробника) access_groups_id (обов’язково) long - ідентифікатор групи gln_id (обов’язково) String - GLN Покупця (Дистрибʼютора) |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
Код сервера 200 (ok).
Додати Покупця (Дистрибʼютора) до групи Покупців (Дистрибʼюторів) (на стороні Продавця (Виробника)) POST /api/distribex/useraccessgroup
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
POST |
|
URL запиту |
/api/distribex/useraccessgroup |
|
URL параметри |
gln (обов’язково) String - GLN Продавця (Виробника) access_groups_id (обов’язково) long - ідентифікатор групи gln_id (обов’язково) String - GLN Покупця (Дистрибʼютора) |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
Код сервера 200 (ok).
Видалити групу Покупців (Дистрибʼюторів) (на стороні Продавця (Виробника)) DELETE /api/distribex/accessgroup
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
DELETE |
|
URL запиту |
/api/distribex/accessgroup |
|
URL параметри |
gln (обов’язково) String - GLN Продавця (Виробника) group_id (обов’язково) long - ідентифікатор групи |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
Код сервера 200 (ok).
Перейменувати поточну групу Покупців (Дистрибʼюторів) (на стороні Продавця (Виробника)) PUT /api/distribex/accessgroup
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
PUT |
|
URL запиту |
/api/distribex/accessgroup |
|
URL параметри |
gln (обов’язково) String - GLN Продавця (Виробника) |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передаються дані групи дистиб’юторів (об’єкт XDistribexAccessGroup) |
RESPONSE
Код сервера 200 (ok).
Створити групу Покупців (Дистрибʼюторів) (на стороні Продавця (Виробника)) POST /api/distribex/accessgroup
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
POST |
|
URL запиту |
/api/distribex/accessgroup |
|
URL параметри |
gln (обов’язково) String - GLN Продавця (Виробника) |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
При створенні нової групи в тілі запиту методу передаються лише назва (name) та ідентифікатор Продавця (Виробника) (producerId). |
Приклад запиту
{"name":"Красавчики","producerId":13200791}RESPONSE
В тілі відповіді передаються дані створеної групи Покупців (Дистрибʼюторів) (об’єкт XDistribexAccessGroup).
Отримати дані про створені групи Покупців (Дистрибʼюторів) (на стороні Продавця (Виробника)) GET /api/distribex/accessgroup
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
GET |
|
URL запиту |
/api/distribex/accessgroup |
|
URL параметри |
gln (обов’язково) String - GLN Продавця (Виробника) |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передаються дані всіх створених груп дистриб'юторів (масив об’єктів XDistribexAccessGroup)
Видалити товарну позицію з «Прайс-листа» DELETE /api/distribex/product
Метод доступний лише для користувача з роллю Продавець (Виробник)
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
DELETE |
|
URL запиту |
/api/distribex/product |
|
URL параметри |
gln (обов’язково) String - GLN Продавця (Виробника) producer_id (обов’язково) String - ідентифікатор Продавця (Виробника) list_id (обов’язково) String - ідентифікатор товарної позиції |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
Код сервера 200 (ok).
Отримати список категорій товарів Прайс-листа GET /api/distribex/categories
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
GET |
|
URL запиту |
/api/distribex/categories |
|
URL параметри |
gln (обов’язково) String - GLN ініціатора запиту (Продавця (Виробника) чи Покупця (Дистрибʼютора)); gln_id (обов’язково) String - ідентифікатор GLN контрагента (Покупця (Дистрибʼютора) чи Продавця (Виробника) відповідно); e_product (опціонально) boolean - значення true є індикатором того, що запит виконується в сервісі Є-Товар |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді у вигляді масиву об’єкта XProductGroup передаються категорії товарів Прайс-листа для вказаної пари «Покупець (Дистрибʼютор)»-«Продавець (Виробник)».
Відредагувати товарну позицію «Прайс-листа» PUT /api/distribex/product
Метод доступний лише для користувача з роллю Продавець (Виробник)
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
PUT |
|
URL запиту |
/api/distribex/product |
|
URL параметри |
gln (обов’язково) String - GLN Продавця (Виробника) |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передається об’єкт XDistribexProduct з даними по товарній позиції |
RESPONSE
Код сервера 200 (ok).
Отримати список контрагентів-Продавців (Виробників) GET /api/distribex/producers/list
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
GET |
|
URL запиту |
/api/distribex/producers/list |
|
URL параметри |
gln (обов’язково) String - GLN Покупця (Дистрибʼютора) query (опціонально) String - текст пошуку (пошук здійснюється за назвою/GLN) limit (опціонально) int - ліміт вибірки (за замовчуванням=20); offset (опціонально) int - зміщення відносно верхньої межі вибірки (за замовчуванням=0) |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передається масив об'єкта Identificator з даними контрагентів.
Отримати список контрагентів-Покупців (Дистриб'юторів) GET /api/distribex/distributor/list
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
GET |
|
URL запиту |
/api/distribex/distributor/list |
|
URL параметри |
gln (обов’язково) String - GLN Продавця (Виробника) query (опціонально) String - текст пошуку (пошук здійснюється за назвою/GLN) limit (опціонально) int - ліміт вибірки (за замовчуванням=20); offset (опціонально) int - зміщення відносно верхньої межі вибірки (за замовчуванням=0) accessgroup (опціонально) String - назва групи (пошук за повним збігом) |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передається масив об'єкта Identificator з даними контрагентів.
Визначення переліку товарних позицій, доступних для повернення, та формування документа “Надсилання Повернення” (ініціатор - Покупець/Дистриб’ютор) POST /api/distribex/doc/retann
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
POST |
|
URL запиту |
/api/distribex/doc/retann |
|
URL параметри |
gln (обов’язково) String - GLN Покупця (Дистрибʼютора) producer (обов’язково) String - GLN Продавця (Виробника); period (обов’язково) int - кількість днів, за які з документів робиться вибірка позицій, доступних до повернення (починаючи від поточного дня) - period=1 - за сьогодні, period=2 - за сьогодні та вчора і т.д.; максимум 90 днів, однак обмеження може змінюватись відповідно до наявності Лімітів зазначених Продавцем; search_positions (опціонально) boolean:
|
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
Тіло запиту передається лише при search_positions=false або відсутності даного параметра: «Повідомлення про повернення» (RETANN) в json форматі уже разом із позиціями; при цьому документ одразу відправляється контрагенту (без створення чернетки). |
RESPONSE
В тілі відповіді залежно від параметра search_positions:
-
якщо true, то у відповідь метода повертається список доступних до Повернення позицій (масив об’єктів POSITION «Повідомлення про повернення» (RETANN)) для зазначеного Покупця в межах періоду;
-
якщо false або параметр search_positions відсутній, то повертається doc_uuid - унікальний ідентифікатор успішно відправленого «Повідомлення про повернення» (RETANN).
Приклад відповіді (успішний запит)
- search_positions=true
[
{
"POSITIONNUMBER": 1,
"PRODUCT": "4820022867421",
"PRICE": 96.06,
"PRODUCTIDSUPPLIER": "7127",
"RETURNQUANTITYUNIT": "PCE",
"DELIVEREDQUANTITYUNIT": "PCE",
"DESCRIPTION": "\"Традиционный\" 400х12 зерновой кофе Жокей Укр",
"AMOUNT": "3169.98",
"RETURNQUANTITY": "33"
}
]- search_positions=false
{
doc_uuid:"e3dbf6e8-029e-4c3b-804b-9b2741d9f37d"
}Пошук документів (з фільтрацією), вибір списку документів POST /api/eds/docs/search
Метод виконує пошук за заданими критеріями, наприклад отримати список документів із певним статусом або за визначений період часу.
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
POST |
|
URL запиту |
/api/eds/docs/search |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії АБО guid (обов’язково) String - унікальний ідентифікатор власної організації на платформі status_id (опціонально) int - id папки документів:
family (опціонально) String - назва сімейства документів:
|
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передаються обов’язкові та додаткові критерії пошуку/фільтрації об’єкт StorageQuery |
RESPONSE
В тілі відповіді передається масив документів об'єкт XDoc.
Отримання контенту документа GET /api/eds/doc/body
Метод повертає контент документа без підписів і печаток, а також тіла підпису та печатки. У запиті передаються GLN користувача, doc_uuid та тип тіла документа.
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
GET |
|
URL запиту |
/api/eds/doc/body |
|
URL параметри |
gln (обов’язково) String (13) - номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта АБО guid (обов’язково) String - унікальний ідентифікатор організації на платформі EDIN 2.0 doc_uuid (обов’язково) UUID - ідентифікатор документа; body_type (обов’язково) String - тип тіла документа; можливі значення:
response_type (опціонально) String - формат очікуваної відповіді; можливі варіанти:
|
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передається тіло документа в форматі, що визначається значенням параметра body_type.
Створити копію документа «Замовлення» (ORDER) відповідно до актуального «Прайс-листа» POST /api/distribex/order/copy
При формуванні «Замовлення» необхідно враховувати обмеження, визначені в «Прайс-листі».
Методи API для роботи з обмеженнями.
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
POST |
|
URL запиту |
/api/distribex/order/copy? |
|
URL параметри |
gln (обов’язково) String - GLN Покупця (Дистрибʼютора) АБО guid (обов’язково) String - унікальний ідентифікатор організації Покупця (Дистрибʼютора) на платформі; doc_uuid (обов’язково) UUID - ідентифікатор документа (Замовлення), який потрібно повторити/скопіювати; actualize (обов’язково) boolean = true - актуалізація нового повтореного/скопійованого Замовлення відносно Замовлення-основи на підставі актуального Прайс-листа Продавця (Виробника). Актуалізація означає врахування всіх змін згідно з актуальним Прайс-листом: оновлених цін, наявності товарів та інших відмінностей у документі. |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передається об’єкт DistribexOrderResult з деталями результату операції створення документа «Замовлення» (ORDER).
Створити документ «Замовлення» (ORDER) за «Прайс-листом» POST /api/distribex/doc/order
При формуванні «Замовлення» необхідно враховувати обмеження, визначені в «Прайс-листі».
Методи API для роботи з обмеженнями.
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
POST |
|
URL запиту |
/api/distribex/doc/order |
|
URL параметри |
gln (обов’язково) String - GLN Покупця (Дистрибʼютора) АБО guid (обов’язково) String - унікальний ідентифікатор організації Покупця (Дистрибʼютора) на платформі preorder_id (обов'язково) - id попереднього замовлення producer_gln (обов’язково) String - GLN Продавця (Виробника) number (обов’язково) String - номер документа ORDER doc_date (опціонально) String - дата документа («YYYY-MM-DD»). При відсутності параметра автоматично проставляється поточна дата на момент формування запиту. delivery_date (опціонально) String - дата доставки («YYYY-MM-DD»). При відсутності параметра автоматично проставляється поточна дата на момент формування запиту. delivery_gln (обов’язково) String - GLN точки доставки delivery_terms (обов’язково) String - код умови відвантаження:
payment_method (опціонально) String - код способу оплати:
doc_type (опціонально) String - підтип документа «Замовлення» (ORDER.DOCTYPE); можливі варіанти:
|
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передається об'єкт DistribexOrderParams (якщо необхідно) |
RESPONSE
В тілі відповіді передається об’єкт DistribexOrderResult з деталями результату операції створення документа «Замовлення» (ORDER).
Створити (розрахувати) номер «Замовлення» (ORDER) GET /api/oas/doc_counter
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
GET |
|
URL запиту |
/api/oas/doc_counter |
|
URL параметри |
gln (обов’язково) String - GLN Покупця (Дистрибʼютора) |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передається розрахований номер «Замовлення» (ORDER), наприклад: 1000253.
Відправити рекомендації до замовлення за «Прайс-листом» POST /api/eds/doc/create_and_send
Метод дозволяє надіслати рекомендації до замовлення за Прайс-листом для покупця/-ців.
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
POST |
|
URL запиту |
/api/eds/doc/create_and_send |
|
URL параметри |
gln - рядок (13); номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта doc_type - рядок; тип документа: допустиме значення: |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
|
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передається тільки один файл-вкладення в форматі
При вказуванні |
Приклад запиту в json форматі:
POST /api/eds/doc/create_and_send?doc_type=orders&gln=9864065702429 HTTP/1.1
Content-Type: multipart/form-data; boundary=-------------573cf973d5228
...else headers...
---------------573cf973d5228
Content-Disposition: form-data; name="file"; filename="file.json"
Content-Type: application/json
{Content of JSON file}Приклад запиту в xml форматі:
POST /api/eds/doc/create_and_send?doc_type=orders&gln=9864065702429 HTTP/1.1
Content-Type: multipart/form-data; boundary=-------------573cf973d5228
...else headers...
---------------573cf973d5228
Content-Disposition: form-data; name="file"; filename="file.xml"
Content-Type: application/xml
{Content of XML file}Приклад запиту в p7s форматі:
POST /api/eds/doc/create_and_send?doc_type=orders&gln=9864065702429 HTTP/1.1
Content-Type: multipart/form-data; boundary=-------------573cf973d5228
...else headers...
---------------573cf973d5228
Content-Disposition: form-data; name="file"; filename="file.p7s"
Content-Type: application/pkcs7-signature
{Content of P7S file}RESPONSE
Код сервера 200 (ok).
Надсилання документа (без створення чернетки) POST /api/eds/doc/create_and_send
Метод є універсальним для різних типів документів і дозволяє одночасно створити та відправити документ без створення чернетки.
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
POST |
|
URL запиту |
/api/eds/doc/create_and_send |
|
URL параметри |
gln - рядок (13); номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта doc_type - рядок; тип документа |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
|
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передається тільки один файл-вкладення в форматі
При вказуванні |
Приклад запиту в json форматі:
POST /api/eds/doc/create_and_send?doc_type=orders&gln=9864065702429 HTTP/1.1
Content-Type: multipart/form-data; boundary=-------------573cf973d5228
...else headers...
---------------573cf973d5228
Content-Disposition: form-data; name="file"; filename="file.json"
Content-Type: application/json
{Content of JSON file}Приклад запиту в xml форматі:
POST /api/eds/doc/create_and_send?doc_type=orders&gln=9864065702429 HTTP/1.1
Content-Type: multipart/form-data; boundary=-------------573cf973d5228
...else headers...
---------------573cf973d5228
Content-Disposition: form-data; name="file"; filename="file.xml"
Content-Type: application/xml
{Content of XML file}Приклад запиту в p7s форматі:
POST /api/eds/doc/create_and_send?doc_type=orders&gln=9864065702429 HTTP/1.1
Content-Type: multipart/form-data; boundary=-------------573cf973d5228
...else headers...
---------------573cf973d5228
Content-Disposition: form-data; name="file"; filename="file.p7s"
Content-Type: application/pkcs7-signature
{Content of P7S file}RESPONSE
- chain_uuid - ідентифікатор ланцюжка, в якому знаходиться документ;
- doc_uuid - ідентифікатор документа на платформі EDIN 2.0;
- ticket_uuid - ідентифікатор квитанції
Параметр ticket_uuid повертається системою лише у випадках створення додаткового тікета до вже існуючого документа (наприклад: підписання у відповідь, відмова від підпису, запит на анулювання).
Якщо документ є новим, у відповіді система повертає лише chain_uuid та doc_uuid.
Приклад відповіді:
{
"chain_uuid": "7ccff78e-ea42-47ea-81e4-5508ed4fbd51",
"doc_uuid": "3698b501-e1ef-464d-a71a-58066f556114",
"ticket_uuid": "1003706c-3656-497b-9438-c6f33e27c36d"
}
Видалити Замовлення DELETE /api/distribex/preorder
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
DELETE |
|
URL запиту |
/api/distribex/preorder |
|
URL параметри |
gln (обов’язково) String - GLN Покупця (Дистрибʼютора) preorder_id (обов’язково) String - ідентифікатор Попереднього замовлення |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
Код сервера 200 (ok).
Зберегти Замовлення по «Прайс-листу» POST /api/distribex/preorder
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
POST |
|
URL запиту |
/api/distribex/preorder |
|
URL параметри |
gln (обов’язково) String - GLN Покупця (Дистрибʼютора) producerId (обов’язково) String - ідентифікатор Продавця (Виробника) positions (обов’язково /-) String - позиції Попереднього замовлення. Параметр відсутній при наявності load_excel параметра load_excel (обов’язково /-) boolean - load_excel=true при передачі значень через xls-файл. Параметр відсутній при наявності positions параметра doc_uuid (опціонально) UUID - ідентифікатор документа-підстави type_id (опціонально) int - ідентифікатор підтипу документа:
|
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
При передачі значень вручну (через positions параметр): в тілі запиту методу передається масив об’єктів XDistribexPreorderPosition з вказаною кількістю відповідних товарних позицій для Попереднього замовлення. При передачі значень через xls-файл (вказується параметр load_excel=true): в тілі запиту передається заповнений шаблон order_upload_ua.xls (вкладення ліворуч) |
RESPONSE
В тілі відповіді передаються дані для збереження Замовлення по «Прайс-листу» (об’єкт XDistribexPreorder)
Отримати дані для формування Замовлення по «Прайс-листу» GET /api/distribex/preorder
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
GET |
|
URL запиту |
/api/distribex/preorder |
|
URL параметри |
gln (обов’язково) String - GLN Покупця (Дистрибʼютора) producerId (обов’язково) String - ідентифікатор Продавця (Виробника) type_id (опціонально) int - ідентифікатор підтипу документа:
|
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передаються дані для формування Замовлення по «Прайс-листу» (об’єкт XDistribexPreorder)
Зберегти (відредагувати) Замовлення за «Прайс-листом» PUT /api/distribex/preorder
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
PUT |
|
URL запиту |
/api/distribex/preorder |
|
URL параметри |
gln (обов’язково) String - GLN Покупця (Дистрибʼютора) producerId (обов’язково) String - ідентифікатор Продавця (Виробника) id (обов’язково) String - ідентифікатор Попереднього замовлення positions (обов’язково) String - позиції Попереднього замовлення doc_uuid (опціонально) UUID - ідентифікатор документа-підстави type_id (опціонально) int - ідентифікатор підтипу документа:
|
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передається масив об'єкта XDistribexPreorderPosition |
RESPONSE
В тілі відповіді передаються дані для збереження Замовлення по «Прайс-листу» (об’єкт XDistribexPreorder)
Видалити позицію або «Прайс-лист» для вказаного Покупця (Дистрибʼютора) DELETE /api/distribex/pricelist
Даний метод може бути використано лише користувачем з роллю Продавець (Виробник).
Метод призначений для видалення товарної позиції з «Прайс-листа» для зазначеного «Покупця (Дистрибʼютора)».
Якщо параметр list_id (ID товарної позиції) не передано, тоді «Прайс-лист» для вказаного «Покупця (Дистрибʼютора)» повністю очищується.
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
DELETE |
|
URL запиту |
/api/distribex/pricelist |
|
URL параметри |
gln (обов’язково) String - GLN Продавця (Виробника) gln_id (обов’язково) String - ідентифікатор Покупця (Дистрибʼютора) list_id (опціонально) String - ідентифікатор товарної позиції, яку потрібно видалити в Прайс-листі. Якщо list_id параметр не передається, то Прайс-лист для вказаного Покупця (Дистрибʼютора) видаляється (очищається) повністю. |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
Код сервера 200 (ok).
Отримати дані «Прайс-листа» для вказаного Покупця (Дистрибʼютора) GET /api/distribex/pricelist
Значення параметрів у запиті відрізняються залежно від ролі користувача «Продавець (Виробник)» / «Покупець (Дистрибʼютор)».
REQUEST
Для ролі Покупця (Дистрибʼютора)
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
GET |
|
URL запиту |
/api/distribex/pricelist |
|
URL параметри |
gln (обов’язково) Число (13) - GLN Покупця (Дистрибʼютора) gln_id (обов’язково) String - ідентифікатор Продавця (Виробника) (producer_id) |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
Для ролі Продавця (Виробника)
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
GET |
|
URL запиту |
/api/distribex/pricelist |
|
URL параметри |
gln (обов’язково) Число (13) - GLN Продавця (Виробника) gln_id (обов’язково/-) String - ідентифікатор Покупця (Дистрибʼютора) (distributor_id). Обов’язково передається або gln_id або access_groups_id (один з параметрів); access_groups_id (обов’язково/-) long - ідентифікатор групи Покупців (Дистрибʼюторів). Обов’язково передається або gln_id або access_groups_id (один з параметрів); date (опціонально) YYYY-MM-DD - Прайс-лист Покупця (Дистрибʼютора) на дату (фільтр) |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передаються дані по товарах «Прайс-листа»:
-
у вигляді масиву об’єктів XPriceListElement для вказаного Покупця (Дистрибʼютора);
-
у вигляді об’єкта зі списком ідентифікаторів Покупців (Дистрибʼюторів), що входять до вказаної групи (access_groups_id), та «Прайс-листом» для кожного знайденого Покупця (Дистрибʼютора) (масиву об’єктів XPriceListElement).
Редагувати дані товарів «Прайс-листа» вказаного Покупця (Дистрибʼютора) PUT /api/distribex/pricelist
Даний метод може бути використано лише користувачем з роллю Продавець (Виробник).
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
PUT |
|
URL запиту |
/api/distribex/pricelist |
|
URL параметри |
gln (обов’язково) String - GLN Продавця (Виробника) gln_id (обов’язково) String - ідентифікатор Покупця (Дистрибʼютора) |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передаються нові/оновлені дані товарів Прайс-листа для вказаного Покупця (Дистрибʼютора) (масив об’єктів XPriceListElement) |
RESPONSE
Код сервера 200 (ok).
Додати або оновити дані товарів у Прайс-листі для вказаних Покупців (Дистриб’юторів) POST /api/distribex/pricelist
Даний метод може бути використано лише користувачем з роллю Продавець (Виробник).
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
POST |
|
URL запиту |
/api/distribex/pricelist |
|
URL параметри |
gln (обов’язково) String - GLN Продавця (Виробника) |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передаються нові/оновлені дані товарів, що долучаються в Прайс-лист до вказаних Покупців (Дистрибʼюторів) (об’єкт XPriceListElement) |
RESPONSE
Код сервера 200 (ok).
Масово видалити відмітку надбавки в прайс-листі для Покупця (Дистриб'ютора) DELETE /api/distribex/surcharge
Даний метод може бути використано лише користувачем з роллю Продавець (Виробник).
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
DELETE |
|
URL запиту |
/api/distribex/surcharge |
|
URL параметри |
gln (обов’язково) String - GLN Продавця (Виробника) distributor_gln (обов’язково) String - GLN Покупця (Дистрибʼютора) |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
Код сервера 200 (ok).
Отримати дані надбавки по товару для вказаного Покупця (Дистриб'ютора) GET /api/distribex/surcharge
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
GET |
|
URL запиту |
/api/distribex/surcharge |
|
URL параметри |
gln (обов’язково) String - GLN Продавця (Виробника) distributor_gln (обов’язково) String - GLN Покупця (Дистрибʼютора) barcode (обов’язково) String - штрихкод товару article (опціонально) String - артикул товару |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передаються дані по встановленим надбавкам для вказаного Покупця (Дистрибʼютора).
Встановити відмітку «Надбавка» для Покупців (Дистриб'юторів) PUT /api/distribex/surcharge
Даний метод може бути використано лише користувачем з роллю Продавець (Виробник).
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
PUT |
|
URL запиту |
/api/distribex/surcharge |
|
URL параметри |
gln (обов’язково) String - GLN Продавця (Виробника) |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передається масив об’єктів XDistribexSurcharge з надбавками для зазначених товарних позицій вказаного користувача-Покупця (Дистрибʼютора) |
RESPONSE
Код сервера 200 (ok).
Масово видалити квоти в прайс-листі для Покупця (Дистриб'ютора) DELETE /api/distribex/quotas
Даний метод може бути використано лише користувачем з роллю Продавець (Виробник).
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
DELETE |
|
URL запиту |
/api/distribex/quotas |
|
URL параметри |
gln (обов’язково) String - GLN Продавця (Виробника) d_gln (обов’язково) String - GLN Покупця (Дистрибʼютора) |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
Код сервера 200 (ok).
Отримати квоти по товару для вказаного Покупця (Дистриб'ютора) GET /api/distribex/quotas
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
GET |
|
URL запиту |
/api/distribex/quotas |
|
URL параметри |
gln (обов’язково) String - GLN Продавця (Виробника) d_gln (обов’язково) String - GLN Покупця (Дистрибʼютора) barcode (обов’язково) String - штрихкод товару article (обов’язково) String - артикул товару |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передаються дані по встановленим квотам для вказаного Покупця (Дистрибʼютора).
Встановити нові квоти для Покупців (Дистриб'юторів) PUT /api/distribex/quotas
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
PUT |
|
URL запиту |
/api/distribex/quotas |
|
URL параметри |
gln (обов’язково) String - GLN Продавця (Виробника) |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передається масив об’єктів Quotas з квотами для кожного вказаного користувача-Покупця (Дистрибʼютора) |
RESPONSE
Код сервера 200 (ok).
Видалити обмеження для контрагента (ініціатор Продавець (Виробник)) DELETE /api/distribex/limits
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
DELETE |
|
URL запиту |
/api/distribex/limits |
|
URL параметри |
gln (обов’язково) String - GLN Продавця (Виробника) d_gln (обов’язково) String - GLN Покупця (Дистрибʼютора) limit_key (опціонально) String - перелік доступних значень обмежень. Використовується, якщо потрібно видалити одне обмеження зі списку, а не очистити всі обмеження повністю. |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
Код сервера 200 (ok).
Отримати обмеження контрагента за GLN GET /api/distribex/limits
Метод може використовуватись як Продавцем (Виробником), так і Покупцем (Дистрибʼютором):
- для отримання налаштованих обмежень з боку Продавця (Виробника) передаються параметри gln та d_gln;
- для отримання налаштованих обмежень з боку Покупця (Дистрибʼютора) передаються параметри gln та producerId.
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
GET |
|
URL запиту |
/api/distribex/limits |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії d_gln / producerId (обов’язково) String
|
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передається об’єкт Limits з обмеженнями для вказаного Покупця (Дистрибʼютора).
Додати/змінити обмеження (ініціатор Продавець (Виробник)) (ініціатор Продавець (Виробник)) POST /api/distribex/limits
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
POST |
|
URL запиту |
/api/distribex/limits |
|
URL параметри |
gln (обов’язково) String - GLN Продавця (Виробника) |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передається об’єкт Limits (назва=GLN Покупця (Дистрибʼютора)) з обмеженнями для конкретного користувача-Покупця (Дистрибʼютора) |
RESPONSE
Код сервера 200 (ok)
Видалити відправлені запрошення Покупцю (ініціатор Продавець (Виробник)) DELETE /api/distribex/invitation
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
DELETE |
|
URL запиту |
/api/distribex/invitation |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; invitation_id (обов’язково) String - ідентифікатор раніше відправленого запрошення (XDistribexInvitation.id); можна передавати декілька, для масового надсилання |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
Код сервера 200 (ok).
Повторно відправити запрошення Покупцю (ініціатор Продавець (Виробник)) PATCH /api/distribex/invitation
Повторне надсилання запрошення одному й тому ж Покупцю доступно один раз на 24 години
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
PATCH |
|
URL запиту |
/api/distribex/invitation |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; invitation_id (обов’язково) String - ідентифікатор раніше відправленого запрошення (XDistribexInvitation.id); можна передавати декілька, для масового надсилання |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передається об’єкт з контактами, яким не були відправлені запрошення:
-
done - масив; список контактів, з якими вже утворений зв’язок;
-
errors - масив; список контактів, яким Ви вже відправляли запрошення протягом останніх 24 годин.
Приклад відповіді:
{"done":[save@mail.com],"errors":["savep38075@adosnan.com"]}Прийняти / Відхилити запрошення Продавця (ініціатор Покупець (Дистриб’ютор)) POST /api/distribex/invitation
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
POST |
|
URL запиту |
/api/distribex/invitation |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; invitation_id (обов’язково) String - ідентифікатор раніше відправленого запрошення (XDistribexInvitation.id); status (обов’язково) int - статус, який потрібно надати запрошенню:
|
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В запиті при status=2 може передаватись текстова причина відхилення запрошення, що буде відображатись Продавцю. |
RESPONSE
Код сервера 200 (ok).
Отримати запрошення Продавця в сервіс «Маркет»/Отримати вкладення до вказаного запрошення GET /api/distribex/invitation
REQUEST
- Формування запиту Продавцем
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
GET |
|
URL запиту |
/api/distribex/invitation |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; invitation_id (опціонально) int - ідентифікатор запрошення (передається для того, щоб отримати конкретне запрошення у json форматі). Якщо додатково передати параметр load_body=true, то повертається контент вкладення (pdf-файл) до запрошення; Для фільтрації списку доступних запрошень можливо використовувати дод. параметри:
|
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
- Формування запиту Покупцем
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
GET |
|
URL запиту |
/api/distribex/invitation?gln=9864065732303&limit=21&offset=0 |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; invitation_id (опціонально) int - ідентифікатор запрошення (передається для того, щоб отримати конкретне запрошення у json форматі). Якщо додатково передати параметр load_body=true, то повертається контент вкладення (pdf-файл) до запрошення; buyer_ipn (опціонально) int - ЄДРПОУ / ІПН Покупця, що були зазначені в запрошенні; buyer (опціонально) String - контакти (email або мобільний номер телефону) Покупця, що були зазначені в запрошенні; Для фільтрації списку доступних запрошень можливо використовувати дод. параметри:
|
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді залежно від параметрів, що передаються може повертатись список усіх наявних запрошень (масив об’єктів XDistribexInvitation) чи конкретне запрошення (1 об’єкт XDistribexInvitation). Якщо в методі передавались параметри invitation_id + load_body=true, то у відповідь повертається pdf-вкладення до запрошення в base64 форматі.
Відправити запрошення Покупцю (ініціатор Продавець (Виробник)) POST /api/distribex/invitation
Повторне надсилання запрошення одному й тому ж Покупцю доступно один раз на 24 години
REQUEST
- Надіслати запрошення Покупцю
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
POST |
|
URL запиту |
/api/distribex/invitation |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; buyer (обов’язково) String - контакт Покупця (email або мобільний номер телефону); buyer_ipn (опціонально) String - ЄДРПОУ / ІПН Покупця |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
|
|
REQUEST |
|
|
Form-data |
В запиті може передаватись (опціонально) тіло в форматі |
Приклад запиту:
-----------------------------339686098424586820212953841379
Content-Disposition: form-data; name="attachment"; filename="_pdf_meme.pdf"
Content-Type: application/pdf
(data)
-----------------------------339686098424586820212953841379--- Масове надсилання запрошень Покупцям
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
POST |
|
URL запиту |
/api/distribex/invitation |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; buyer (опціонально) String - контакт Покупця (email або мобільний номер телефону); buyer_ipn (опціонально) String - ЄДРПОУ / ІПН Покупця |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
|
|
REQUEST |
|
|
Form-data |
В запиті може передаватись кілька тіл:
|
Приклад запиту:
-----------------------------42215802802152663972618512251
Content-Disposition: form-data; name="json"; filename="json"
Content-Type: application/json
[{"buyerContact":"test@gmail.com","buyerIPN":"14360570"},{"buyerContact":"test2@gmail.com","buyerIPN":"14360570"}]
-----------------------------42215802802152663972618512251
Content-Disposition: form-data; name="file"; filename="_pdf_meme.pdf"
Content-Type: application/pdf
(data)
-----------------------------42215802802152663972618512251--RESPONSE
В тілі відповіді передається об’єкт з контактами, яким не були відправлені запрошення:
-
done - масив; список контактів, з якими вже утворений зв’язок;
-
duplicates - масив; список контактів, яким Ви вже відправляли запрошення протягом останніх 24 годин
Приклад відповіді:
{"done":[save@mail.com],"duplicates":["savep38075@adosnan.com"]}API сервісу Тендер
Перелік методів API сервісу Тендер
Всі запити нижче перерахованих API методів платформи EDIN 2.0 направляються на адресу: https://edo-v2.edin.ua
Для роботи з цими методами користувач повинен бути авторизованим.
Робота зі ставками
|
Зробити ставку по лоту (Учасник) |
POST /api/v1/tender/lot/bets |
|
Видалити ставку по лоту тендера (Організатор) |
DELETE /api/v1/tender/lot/bets |
Робота з тендерами
|
Створити новий тендер (чернетку) |
POST /api/v1/tender/auctions |
|
Опублікувати тендер |
PATCH /api/v1/tender/auctions/publish |
|
Отримати дані тендера (за id) |
GET /api/v1/tender/auction |
|
Отримати список тендерів з "Чернеток" |
GET /api/v1/tender/auctions/drafts |
|
Отримати список тендерів з "Мої тендери" |
GET /api/v1/tender/auctions/my |
|
Отримати список з "Усі тендери" |
GET /api/v1/tender/auctions/all |
|
Отримати дані про перегляди тендера (за id) |
GET /api/v1/tender/auction/views |
|
Отримання списку тендерів для неавторизованого користувача |
GET /api/v1/tender/guest/auctions/all |
|
Завершити тендер (Організатор) |
PATCH /api/v1/tender/auctions/close |
|
Запросити компанії взяти участь в тендері (Організатор) |
POST /api/v1/tender/auction/access/invite |
|
Подати заявку на участь в закритому аукціоні (Учасник) |
POST /api/v1/tender/auction/access/request |
|
Отримати дані по заявкам на участь в закритих аукціонах (Учасник) |
GET /api/v1/tender/auction/access/company/outgoing |
|
Схвалити заявку на участь в закритому аукціоні (Організатор) |
PATCH /api/v1/tender/auction/access/confirm |
|
Відхилити заявку на участь в закритому аукціоні (Організатор) |
PATCH /api/v1/tender/auction/access/reject |
|
Вибір доступних користувачів для компанії |
GET /api/v1/tender/users |
|
Надати доступ до вже опублікованого тендера |
POST /api/v1/tender/auction/users |
|
Закрити доступ до вже опублікованого тендера |
DELETE /api/v1/tender/auction/users |
Вкладення
|
Додати вкладення до тендера, лота (Організатор) / Додати вкладення до ставки (Учасник) |
POST /api/v1/tender/attachments |
|
Отримати список вкладень до тендера/лота/ставки |
GET /api/v1/tender/attachments |
|
Отримати файл-вкладення до тендера/лота/ставки |
GET /api/v1/tender/attachment |
|
Видалити вкладення до тендера / лота (Організатор) |
DELETE /api/v1/tender/attachment |
Робота з підписками
|
Отримати список користувачів, на яких підписаний поточний Адміністратор акаунта |
GET /api/v1/tender/user/subscribes |
|
Додати підписку на користувача (Адміністратор акаунта) |
POST /api/v1/tender/user/subscribes |
|
Видалити підписку на користувача (Адміністратор акаунта) |
DELETE /api/v1/tender/user/subscribes |
Довідники
|
Отримати довідник категорій |
GET /api/v1/tender/categories |
|
Отримати довідник валют |
GET /api/v1/tender/currency |
|
Отримати довідник регіонів |
GET /api/v1/tender/regions |
|
Отримати довідник одиниць виміру |
GET /api/v1/tender/units |
Довідник учасників
|
Отримати список всіх наявних груп учасників |
GET /api/v1/tender/participant_group/list |
|
Отримати дані групи учасників |
GET /api/v1/tender/participant_group |
|
Створити/Редагувати групу учасників |
POST /api/v1/tender/participant_group |
|
Видалити групу учасників |
DELETE /api/v1/tender/participant_group |
Помилки при роботі з API
Загальні помилки при роботі з API (для всіх сервісів EDIN) можна подивитись за посиланням.
Видалити групу учасників DELETE /api/v1/tender/participant_group
REQUEST
|
URL |
|
|
Метод запиту |
DELETE |
|
URL запиту |
/api/v1/tender/participant_group |
|
URL параметри |
group_id (обов’язково) var - ідентифікатор групи учасників |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
Код сервера 200 (ok).
Створити/Редагувати групу учасників POST /api/v1/tender/participant_group
Вибір дії (створення або редагування): якщо в body запиту присутній ідентифікатор групи учасників (параметр groupId), то група із зазначеним Id підлягає редагуванню. Відсутність в запиті параметра groupId веде до створення нової групи учасників.
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/v1/tender/participant_group |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту передається об’єкт з даними групи учасників. При редагуванні групи важливо передавати всі необхідні ідентифікатори груп та учасників (id), наприклад «нові та попередні», оскільки запит перезаписує всі значення. |
RESPONSE
В тілі відповіді передається передається об’єкт з даними групи учасників (об'єкт PatrticipantGroup).
Отримати дані групи учасників GET /api/v1/tender/participant_group
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/v1/tender/participant_group |
|
URL параметри |
group_id (обов’язково) var - ідентифікатор групи учасників |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передається об’єкт з даними групи учасників (об'єкт ParticipantGroup).
Отримати список всіх наявних груп учасників GET /api/v1/tender/participant_group/list
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/v1/tender/participant_group/list |
|
URL параметри |
limit (опціонально) int - ліміт вибірки (за замовчуванням=20); offset (опціонально) int - зміщення відносно верхньої межі вибірки (за замовчуванням=0); count (опціонально) boolean - при значенні true у відповідь пердається лише число - загальна кількість груп учасників. |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передається передаються дані груп учасників у вигляді масиву об’єктів.
Отримати довідник одиниць виміру GET /api/v1/tender/units
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/v1/tender/units |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передається довідник одиниць виміру (масив об’єктів Unit).
Отримати довідник регіонів GET /api/v1/tender/regions
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/v1/tender/regions |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передається довідник регіонів (масив об’єктів Region).
Отримати довідник валют GET /api/v1/tender/currency
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/v1/tender/currency |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передається довідник валют (масив об’єктів Currency).
Отримати довідник категорій GET /api/v1/tender/categories
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/v1/tender/categories |
|
URL параметри |
ref_id (опціонально) String - ідентифікатор материнської категорії; query (опціонально) String - текст пошуку (пошук здійснюється за назвою чи кодом категорії); limit (опціонально) int - ліміт вибірки; offset (опціонально) int - зміщення відносно верхньої межі вибірки (за замовчуванням=0) |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передається довідник категорій (масив об’єктів Category).
Видалити підписку на користувача (Адміністратор акаунта) DELETE /api/v1/tender/user/subscribes
Даний метод може бути виконаний лише від імені Адміністратора акаунта.
REQUEST
|
URL |
|
|
Метод запиту |
DELETE |
|
URL запиту |
/api/v1/tender/user/subscribes |
|
URL параметри |
user_id (обов’язково) long - ідентифікатор користувача |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передається масив кориcтувачів, на яких оформлена підписка (масив об’єктів User ).
Додати підписку на користувача (Адміністратор акаунта) POST /api/v1/tender/user/subscribes
Даний метод може бути виконаний лише від імені Адміністратора акаунта.
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/v1/tender/user/subscribes |
|
URL параметри |
user_id (обов’язково) long - ідентифікатор користувача |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передається масив користувачів, на яких оформлена підписка (масив об’єктів User ).
Отримати список користувачів, на яких підписаний поточний Адміністратор акаунта GET /api/v1/tender/user/subscribes
Даний метод може бути виконаний лише від імені Адміністратора акаунта.
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/v1/tender/user/subscribes |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передається масив користувачів, на яких оформлена підписка (масив об’єктів User ).
Видалити вкладення до тендера / лота (Організатор) DELETE /api/v1/tender/attachment
Видалити вкладення до тендера / лота може лише Організатор тендера чи Супер адміністратор акаунта організації!
REQUEST
|
URL |
|
|
Метод запиту |
DELETE |
|
URL запиту |
/api/v1/tender/attachment |
|
URL параметри |
auction_id (обов’язково) long - ідентифікатор тендера; attach_id (обов’язково) long - ідентифікатор вкладення (значення id параметра з Отримання списку вкладень до тендера/лота/ставки) |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
Код сервера 200 (ok).
Отримати файл-вкладення до тендера/лота/ставки
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/v1/tender/attachment |
|
URL параметри |
attach_id (обов’язково) long - ідентифікатор вкладення (значення id параметра з Отримання списку вкладень до тендера/лота/ставки) |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
MIME типізація згідно типу файлу-вкла дення |
RESPONSE
В тілі відповіді передається файл-вкладення.
Отримати список вкладень до тендера/лота/ставки GET /api/v1/tender/attachments
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/v1/tender/attachments |
|
URL параметри |
auction_id (обов’язково) long - ідентифікатор тендера; file_name (обов’язково) String - назва файлу разом з його розширенням; lot_id (опціонально) long - ідентифікатор лоту тендера; bet_id (опціонально) long - ідентифікатор ставки |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передаються дані всіх наявних вкладень (масив об’єктів Attachment).
Додати вкладення до тендера, лота (Організатор) / Додати вкладення до ставки (Учасник) POST /api/v1/tender/attachments
Додати вкладення до тендера та лота Організатор може лише до початку тендера! Вкладення зі сторони Учасника додається до вже зробленої ним ставки! До кожного тендера / лота / ставки можливо додати до 5 файлів!
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/v1/tender/attachments |
|
URL параметри |
auction_id (обов’язково) long - ідентифікатор тендера; file_name (обов’язково) String - назва файлу разом з його розширенням; lot_id (опціонально) long - ідентифікатор лоту тендера; bet_id (опціонально) long - ідентифікатор ставки |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передаються дані доданого вкладення (об’єкт Attachment).
Відхилити заявку на участь в закритому аукціоні (Організатор) PATCH /api/v1/tender/auction/access/reject
REQUEST
|
URL |
|
|
Метод запиту |
PATCH |
|
URL запиту |
/api/v1/tender/auction/access/reject |
|
URL параметри |
auction_id (обов’язково) long - ідентифікатор аукціона (тендера) request_id (обов’язково) long - ідентифікатор запиту |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту в текстовому вигляді опціонально може передаватись коментар до заявки на участь (для Учасника) |
RESPONSE
В тілі відповіді (json) передаються дані заявки на участь в закритому аукціоні (об’єкт Access).
Схвалити запит на участь в закритому аукціоні (Організатор) PATCH /api/v1/tender/auction/access/confirm
REQUEST
|
URL |
|
|
Метод запиту |
PATCH |
|
URL запиту |
/api/v1/tender/auction/access/confirm |
|
URL параметри |
auction_id (обов’язково) long - ідентифікатор аукціона (тендера) request_id (обов’язково) long - ідентифікатор запиту |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту в текстовому вигляді опціонально може передаватись коментар до запиту на участь (для Учасника) |
RESPONSE
В тілі відповіді (json) передаються дані заявки на участь в закритому аукціоні (об’єкт Access).
Отримати дані по заявкам на участь в закритих аукціонах (Учасник) GET /api/v1/tender/auction/access/company/outgoing
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/v1/tender/auction/access/company/outgoing |
|
URL параметри |
auction_id (опціонально) long - ідентифікатор аукціона (тендера) company_id (обов’язково) long - ідентифікатор компанії, від якої здійснюється запит |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді (json) передаються дані заявкок на участь в закритих аукціонах (масив об’єктів Access).
Подати заявку на участь в закритому аукціоні (Учасник) POST /api/v1/tender/auction/access/request
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/v1/tender/auction/access/request |
|
URL параметри |
auction_uuid (обов’язково) long - унікальний ідентифікатор аукціона (тендера) company_id (обов’язково) long - ідентифікатор компанії, від якої здійснюється запит contact_name (опціонально) String (250) - контактна особа (ПІБ) contact_phone (опціонально) String (50) - контактний телефон contact_email (опціонально) String (250) - контактний email |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту в текстовому вигляді опціонально може передаватись коментар до заявки на участь (для Організатора) |
RESPONSE
В тілі відповіді (json) передаються дані заявки на участь в закритому аукціоні (об’єкт Access).
Запросити компанії взяти участь в тендері (Організатор) POST /api/v1/tender/auction/access/invite
За допомогою даного методу можливо запрошувати до участі в тендері як зареєстровані в сервісі компанії, так і незареєстровані. Після успішного виконання запиту:
-
-
зареєстрована в сервісі компанія додається в Учасники тендера, а користувачам цієї компанії відправляється повідомлення на e-mail з посиланням на тендер;
-
незареєстрованій в сервісі компанії на вказаний e-mail відправляється запрошення на реєстрацію на платформі EDIN 2.0 та посиланням на тендер.
-
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/v1/tender/auction/access/invite |
|
URL параметри |
auction_id (обов’язково) long - ідентифікатор тендера |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту передаються у вигляді масиву об’єктів (по кожній запрошеній компанії):
|
RESPONSE
В тілі відповіді передається об’єкт з access / invites масивами.
Приклад відповіді:
{
"access": ["999321453"],
"invites": ["test2@edin.ua"]
}де
-
access - масив ЄДРПОУ/ІПН компаній-Учасників, що були запрошені до вказаного тендера (компанії були зареєстровані);
-
invites - масив e-mail адрес, на які відправляється запрошення на реєстрацію.
Завершити тендер (Організатор) PATCH /api/v1/tender/auctions/close
Завершити достроково можливо лише активний (опублікований) тендер. Завершити тендер може лише Організатор, що його створив, та «Супер адміністратор» акаунта цього Організатора.
REQUEST
|
URL |
|
|
Метод запиту |
PATCH |
|
URL запиту |
/api/v1/tender/auctions/close |
|
URL параметри |
auction_id (обов’язково) String - ідентифікатор тендера |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
Код сервера 200 (ok).
Отримати список тендерів для неавторизованого користувача GET /api/v1/tender/guest/auctions/all
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/v1/tender/guest/auctions/all |
|
URL параметри |
Можливо додати фільтр (опціональні параметри) |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передається масив тендерів (масив об’єктів Auction).
Отримати дані про перегляди тендера (за id) GET /api/v1/tender/auction/views
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/v1/tender/auction/views |
|
URL параметри |
auction_id (обов’язково) long - ідентифікатор тендера |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передаються дані про перегляди вказаного тендера (масив об’єктів AuctionView).
Отримати список з «Усі тендери» GET /api/v1/tender/auctions/all
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/v1/tender/auctions/all |
|
URL параметри |
company_id (обов’язково) long - ідентифікатор компанії, від якої здійснюється запит Можливо додати фільтр (опціональні параметри) |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передається масив тендерів (масив об’єктів Auction ).
Отримати список тендерів з «Мої тендери» GET /api/v1/tender/auctions/my
В «Моїх тендерах» відображаються аукціони, які даний користувач створив чи приймає/приймав участь (робив ставку, робив запит на запрошення в тендер чи був запрошений Організатором). Для Супер адміністратора в «Моїх тендерах» відображається така ж інформація, але по відношенню до всіх користувачів акаунту.
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/v1/tender/auctions/my |
|
URL параметри |
company_id (обов’язково) long - ідентифікатор компанії, від якої здійснюється запит Можливо додати фільтр (опціональні параметри) |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передається масив тендерів (масив об’єктів Auction ).
Отримати список тендерів з «Чернеток» GET /api/v1/tender/auctions/drafts
В «Чернетках» відображаються неопубліковані тендери, що були створені даним користувачем. Для Супер адміністратора в «Чернетках» відображається така ж інформація, але відносно всіх користувачів акаунту.
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/v1/tender/auctions/drafts |
|
URL параметри |
Можливо додати фільтр (опціональні параметри) |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передається масив тендерів (масив об’єктів Auction).
Отримати дані тендера (за id) GET /api/v1/tender/auction
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/v1/tender/auction |
|
URL параметри |
auction_id (обов’язково) long - ідентифікатор тендера |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передаються дані вказаного тендера (об’єкт Auction).
Опублікувати тендер PATCH /api/v1/tender/auctions/publish
REQUEST
|
URL |
|
|
Метод запиту |
PATCH |
|
URL запиту |
/api/v1/tender/auctions/publish |
|
URL параметри |
auction_id (обов’язково) String - ідентифікатор тендера |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
Код сервера 200 (ok).
Створити новий тендер (чернетку) POST /api/v1/tender/auctions
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/v1/tender/auctions |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту обов’язково передаються дані нового тендера (об’єкт Auction) |
RESPONSE
В тілі відповіді передаються дані створеного тендера (об’єкт Auction).
Видалити ставку по лоту тендера (Організатор) DELETE /api/v1/tender/lot/bets
REQUEST
|
URL |
|
|
Метод запиту |
DELETE |
|
URL запиту |
/api/v1/tender/lot/bets |
|
URL параметри |
lot_id (обов’язково) long - ідентифікатор лоту тендера auction_id (обов’язково) long - ідентифікатор тендера bet_id (обов’язково) long - ідентифікатор ставки |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту обов’язково передається причина видалення ставки (text) |
RESPONSE
В тілі відповіді (json) передається коротке інфо по видаленій ставці (об’єкт):
{"removedBet":96,"comment":"Причина: погода","newBest":357}де
-
removedBet - ідентифікатор видаленої ставки;
-
comment - коментар (причина видалення);
-
newBest - краща поточна ставка по лоту.
Зробити ставку по лоту (Учасник) POST /api/v1/tender/lot/bets
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/v1/tender/lot/bets |
|
URL параметри |
lot_id (обов’язково) long - ідентифікатор лоту тендера |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту передається об’єкт: {"value":42,"comment":"Коментар2","companyId":447}, де
|
RESPONSE
В тілі відповіді (json) передаються дані зробленої ставки (об’єкт Bet).
Вибір доступних користувачів по компанії GET /api/v1/tender/users
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/v1/tender/users |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
RESPONSE
В тілі відповіді передаються ідентифікатори користувачів у вигляді масиву об'єктів. Також може бути присутня й інша інформація, яка стосується користувача та акаунта.
JSON приклад відповіді:
[
{
"id": 60214599 // ID користувача
},
]
Надати доступ користувачам до вже опублікованого тендера POST /api/v1/tender/auction/users
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/v1/tender/auction/users |
|
URL параметри |
auction_id (обов'язково) - вказується id аукціону, до якого треба надати доступ |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON body |
[users] - масив ідентифікаторів користувачів, яким потрібно надати доступ |
RESPONSE
Код сервера 200 (ok).
Закрити доступ до вже опублікованого тендера DELETE /api/v1/tender/auction/users
REQUEST
|
URL |
|
|
Метод запиту |
DELETE |
|
URL запиту |
/api/v1/tender/auction/users |
|
URL параметри |
auction_id (обов'язково) - вказується id аукціону, до якого треба закрити доступ |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON body |
[users] - масив ідентифікаторів користувачів, яким потрібно закрити доступ |
RESPONSE
Код сервера 200 (ok).
API сервісу Вільний
Перелік методів API сервісу Вільний
Всі запити нижче перерахованих API методів платформи EDIN 2.0 направляються на адресу: https://edo-v2.edin.ua
Для роботи з цими методами користувач повинен бути авторизованим.
Робота з документами
|
Створити документ з метаданими (чернетку) |
POST /api/sd/eds/doc |
|
Отримати документ |
GET /api/sd/eds/doc |
|
Редагувати метадані документа (чернетка) |
PATCH /api/sd/eds/doc |
|
Видалити документ (чернетку) |
DELETE /api/sd/eds/doc |
|
Відхилити вхідний документ |
POST /api/sd/eds/doc/decline |
|
Завантажити документ (zip-архів) |
GET /api/sd/eds/doc/zip |
|
Отримати метадані документа |
GET /api/sd/eds/doc/body |
|
Відправити документ (чернетку) |
PATCH /api/sd/eds/doc/send |
|
Відмітити документа, як «важливий» / «звичайний» |
PATCH /api/sd/eds/doc/important |
|
Отримати список документів |
POST /api/sd/eds/docs/search |
|
Додати отримувача до відправленого документа |
PATCH /api/sd/eds/doc/send/recipients |
Робота з файлами (вкладення до документа)
|
Додати файл до документа-чернетки |
POST /api/sd/eds/doc/attachment |
|
Отримати файл-вкладення |
GET /api/sd/eds/doc/attachment |
|
Видалити файл-вкладення (чернетка) |
DELETE /api/sd/eds/doc/attachment |
Підписання
| Підписати документ | POST /api/sd/eds/doc/sign |
| Отримати дані про підписання файлу-вкладення | GET /api/sd/eds/doc/sign |
| Створення та відправка документа (без створення чернетки) | POST /api/sd/eds/doc/create_and_send |
Робота з довідниками
|
Отримання даних контрагента за ім’ям / ІПН / email / ЄДРПОУ / номером телефону |
GET /api/oas/v2/employees/search |
Контрагенти
| Додати в сервіс дані нового контрагента / Редагувати дані контрагента | POST/api/oas/partner |
| Отримати дані контрагента (розділ «Контрагенти») | GET /api/oas/partner |
| Завантажити в сервіс список контрагентів з Excel | POST /api/oas/partners |
| Отримати список контрагентів (розділ «Контрагенти») | GET /api/oas/partners |
| Відправити запрошення контрагентам | POST /api/eds/doc/statuses |
Робота з тегами
| Створити новий тег | POST /api/sd/eds/employee/tags |
| Отримати теги | GET /api/sd/eds/employee/tags |
| Редагувати тег | PUT /api/sd/eds/employee/tags |
| Видалити тег | DELETE /api/sd/eds/employee/tags |
| Додати теги до документа | POST /api/sd/eds/doc/tags |
| Вилучити теги з документа | DELETE /api/sd/eds/doc/tags |
Помилки при роботі з API
Загальні помилки при роботі з API (для всіх сервісів EDIN) можна подивитись за посиланням.
Вилучити теги з документа DELETE /api/sd/eds/doc/tags
REQUEST
|
URL |
|
|
Метод запиту |
DELETE |
|
URL запиту |
/api/sd/eds/doc/tags |
|
URL параметри |
employee_uuid (обов’язково) UUID - унікальний ідентифікатор користувача doc_uuid (обов’язково) UUID - ідентифікатор документа |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту передається масив об’єктів: тегів для видалення. |
RESPONSE
Код сервера 200 (ok).
Додати теги до документа POST /api/sd/eds/doc/tags
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/sd/eds/doc/tags |
|
URL параметри |
employee_uuid (обов’язково) UUID - унікальний ідентифікатор користувача doc_uuid (обов’язково) UUID - ідентифікатор документа |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту передається масив об’єктів: тегів для додавання. |
RESPONSE
Код сервера 200 (ok).
Видалити тег DELETE /api/sd/eds/employee/tags
REQUEST
|
URL |
|
|
Метод запиту |
DELETE |
|
URL запиту |
/api/sd/eds/employee/tags |
|
URL параметри |
employee_uuid (обов’язково) UUID - унікальний ідентифікатор користувача |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту передається масив ідентифікаторів тегів до видалення.
Приклад запиту:
|
RESPONSE
Код сервера 200 (ok).
Редагувати тег PUT /api/sd/eds/employee/tags
Назва тегу повинна бути унікальною й довжиною не більше 20 символів.
|
URL |
|
|
Метод запиту |
PUT |
|
URL запиту |
/api/sd/eds/employee/tags |
|
URL параметри |
employee_uuid (обов’язково) UUID - унікальний ідентифікатор користувача |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту (json) передається масив об’єктів: тегів з відредагованими назвами. |
RESPONSE
Код сервера 200 (ok).
Отримати теги GET /api/sd/eds/employee/tags
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/sd/eds/employee/tags |
|
URL параметри |
employee_uuid (обов’язково) UUID - унікальний ідентифікатор користувача search (опціонально) String - пошук за назвою тега |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді (json) передається список (масив) тегів.
Створити новий тег POST /api/sd/eds/employee/tags
Назва тегу повинна бути унікальною й довжиною не більше 20 символів.
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/sd/eds/employee/tags |
|
URL параметри |
employee_uuid (обов’язково) UUID - унікальний ідентифікатор користувача |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту (json) передається список назв тегів у вигляді масиву рядків.
Приклад запиту:
|
RESPONSE
В тілі відповіді (json) передається масив створених тегів.
Отримати список контрагентів (розділ «Контрагенти») GET /api/oas/partners
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/oas/partners |
|
URL параметри |
limit (опціонально) int - ліміт вибірки (за замовчуванням=50); offset (опціонально) int - зміщення відносно верхньої межі вибірки (за замовчуванням=0); pattern (опціонально) String - пошукове значення (фільтр по даним контрагентів); registration_status (опціонально) int - статус реєстрації; 0 - незарестрований, 1 - зареєстрований; invitation_status (опціонально) int - статус запрошення; 0 - запрошення не відправлено, 1 - запрошення відправлено |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передається масив об’єктів з даними контрагентів.
Завантажити в сервіс список контрагентів з Excel POST /api/oas/partners
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/oas/partners |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту передається масив об’єктів з даними контрагентів |
RESPONSE
В тілі відповіді (json) передаються завантажені в сервіс контрагенти та контрагенти з помилковими даними (потребують правок).
Отримати дані контрагента (розділ «Контрагенти») GET /api/oas/partner
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/oas/partner |
|
URL параметри |
partner_id int(10) - id контрагента |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді (json) передається об’єкт з даними контрагента.
Додати в сервіс дані нового контрагента / Редагувати дані контрагента POST/api/oas/partner
Вибір дії (додавання або редагування): якщо в тілі запиту (json) присутній ідентифікатор контрагента (параметр id), то такий контрагент підлягає редагуванню (дані оновляться). Відсутність в запиті параметра id веде до створення (додавання в сервіс) нового контрагента.
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/oas/partner |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту передається об’єкт з даними контрагента |
RESPONSE
В тілі відповіді (json) передається об’єкт з даними контрагента.
Отримання даних контрагента за ім’ям / ІПН / email / ЄДРПОУ / номером телефону GET /api/oas/v2/employees/search
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/oas/v2/employees/search |
|
URL параметри |
query (обов’язково) String - текст пошуку (ім’я / ІПН / email / ЄДРПОУ / номер телефону) by_company (опціонально) int - фільтр пошуку:
by_alias (опціонально) int - фільтр пошуку:
|
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передається масив з даними про контрагентів (об’єктів Employee ).
Створення та відправка документа (без створення чернетки) POST /api/sd/eds/doc/create_and_send
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/sd/eds/doc/create_and_send |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
|
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу обов’язково передаються два файли (+ додатково можуть передаватись підписи):
|
RESPONSE
Код сервера 200 (ok).
Отримати дані про підписання файлу-вкладення GET /api/sd/eds/doc/sign
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/sd/eds/doc/sign |
|
URL параметри |
attachment_uuid (обов’язково) UUID - ідентифікатор файла-вкладення; employee_uuid (опціонально) UUID - ідентифікатор співробітника, під яким виконуються обробка документа |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді (json) передається список uuid-ів Відправника і Отримувачів документа з масивами даних про підписи для кожного uuid відповідно.
Підписати документ POST /api/sd/eds/doc/sign
Для підписання документ повинен містити файл/файли.
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/sd/eds/doc/sign |
|
URL параметри |
doc_uuid (обов’язково) UUID - ідентифікатор документа; employee_uuid (опціонально) UUID - ідентифікатор співробітника, під яким виконується обробка документа; |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту (json) передається список uuid-ів вкладених файлів з масивом підписів (BASE64) для підписання цих файлів.
Приклад запиту:
|
RESPONSE
Код сервера 200 (ok).
Видалити файл-вкладення (чернетка) DELETE /api/sd/eds/doc/attachment
REQUEST
|
URL |
|
|
Метод запиту |
DELETE |
|
URL запиту |
/api/sd/eds/doc/attachment |
|
URL параметри |
attachment_uuid (обов’язково) UUID - ідентифікатор файла-вкладення employee_uuid (опціонально) UUID - ідентифікатор співробітника, під яким виконується обробка документа |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
Код сервера 200 (ok).
Отримати файл-вкладення GET /api/sd/eds/doc/attachment
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/sd/eds/doc/attachment |
|
URL параметри |
attachment_uuid (обов’язково) UUID - ідентифікатор файла-вкладення; employee_uuid (опціонально) UUID - ідентифікатор співробітника, під яким виконується обробка документа response_type (опціонально) String - формат очікуваної відповіді сервера; можливі варіанти:
|
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передається файл-вкладення.
Додати файл до документа-чернетки POST /api/sd/eds/doc/attachment
Один документ може містити не більше 10 файлів в наступних форматах: PDF/JPG/JPEG/PNG/BMP/DOC/DOCX/XLS/XLSX/PPT/PPTX/CSV/TXT/XML/P7S (попередній перегляд працює лише для PDF/JPG/JPEG/PNG/BMP/TXT/XML) з розміром файлу не більше 5 Мб. Назва файла не повинна перевищувати 100 символів.
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/sd/eds/doc/attachment |
|
URL параметри |
doc_uuid (обов’язково) UUID - ідентифікатор документа employee_uuid (опціонально) UUID - ідентифікатор співробітника, під яким виконуються обробка документа |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
multipart/form-data |
|
REQUEST |
|
|
Form-data |
В тілі запиту передається 1 файл.
Приклад запиту:
|
RESPONSE
В тілі відповіді (json) передаються дані файла-вкладення (об'єкт XDocAttachment).
Додати отримувача до відправленого документа PATCH /api/sd/eds/doc/send/recipients
Лише Відправник документа має можливість додавати нових контрагентів. Додавання отримувачів до вже відправленого документа можливо поки документ (оригінал) знаходиться в статусі Очікує підпису / Підписано частково (детальніше про статуси документів).
REQUEST
|
URL |
|
|
Метод запиту |
PATCH |
|
URL запиту |
/api/sd/eds/doc/send/recipients |
|
URL параметри |
doc_uuid (обов’язково) UUID - ідентифікатор документа |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
REQUEST |
|
|
JSON Body |
В тілі запиту (json) передається:
АБО
|
RESPONSE
Код сервера 200 (ok).
Отримати список документів POST /api/sd/eds/docs/search
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/sd/eds/docs/search |
|
URL параметри |
employee_uuid (опціонально) UUID - ідентифікатор співробітника, під яким виконується обробка документа |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту (json) передаються дані для фільтрації (об’єкт StorageQuery) |
RESPONSE
В тілі відповіді (json) передається масив з відібраними документами.
Відмітити документ, як «важливий» / «звичайний» PATCH /api/sd/eds/doc/important
REQUEST
|
URL |
|
|
Метод запиту |
PATCH |
|
URL запиту |
/api/sd/eds/doc/important |
|
URL параметри |
doc_uuid (обов’язково) UUID - ідентифікатор документа; employee_uuid (опціонально) UUID - ідентифікатор співробітника, під яким виконуються обробка документа; important (обов’язково) boolean:
|
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
Код сервера 200 (ok).
Відправити документ (чернетку) PATCH /api/sd/eds/doc/send
REQUEST
|
URL |
|
|
Метод запиту |
PATCH |
|
URL запиту |
/api/sd/eds/doc/send |
|
URL параметри |
doc_uuid (обов’язково) UUID - ідентифікатор документа |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
Код сервера 200 (ok).
Отримати метадані документа GET /api/sd/eds/doc/body
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/sd/eds/doc/body |
|
URL параметри |
doc_uuid (обов’язково) UUID - ідентифікатор документа; employee_uuid (опціонально) UUID - ідентифікатор співробітника, під яким виконуються обробка документа; response_type (опціонально) String - формат очікуваної відповіді; можливі варіанти:
|
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді (json) передаються метадані документа.
Завантажити документ (zip-архів) GET /api/sd/eds/doc/zip
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/sd/eds/doc/zip |
|
URL параметри |
doc_uuid (обов’язково) UUID - ідентифікатор документа employee_uuid (опціонально) UUID - ідентифікатор співробітника, під яким виконується обробка документа |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передається документ (zip-архів). Детальніше про завантаження.
Відхилити вхідний документ POST /api/sd/eds/doc/decline
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/sd/eds/doc/decline |
|
URL параметри |
doc_uuid (обов’язково) UUID - ідентифікатор документа |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту передається текст причини відхилення.
Приклад тіла запиту:
Невірно складений договір, орфографічні помилки |
RESPONSE
Код сервера 200 (ok).
Видалити документ (чернетку) DELETE /api/sd/eds/doc
REQUEST
|
URL |
|
|
Метод запиту |
DELETE |
|
URL запиту |
/api/sd/eds/doc |
|
URL параметри |
doc_uuid (обов’язково) UUID - ідентифікатор документа employee_uuid (опціонально) UUID - ідентифікатор співробітника, під яким виконуються обробка документа |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
Код сервера 200 (ok).
Редагувати метадані документа (чернетка) PATCH /api/sd/eds/doc
REQUEST
|
URL |
|
|
Метод запиту |
PATCH |
|
URL запиту |
/api/sd/eds/doc |
|
URL параметри |
doc_uuid (обов’язково) UUID - ідентифікатор документа employee_uuid (опціонально) UUID - ідентифікатор співробітника, під яким виконуються обробка документа |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
multipart/form-data |
|
REQUEST |
|
|
JSON Body |
В тілі запиту передається json файл з метаданими документа
Приклад запиту:
|
RESPONSE
В тілі відповіді (json) передається doc_uuid - унікальний ідентифікатор документа:
{"doc_uuid":"023403f8-9201-41f2-8c18-cf4777a058fc"}
Отримати документ GET /api/sd/eds/doc
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/sd/eds/doc |
|
URL параметри |
doc_uuid (обов’язково) UUID - ідентифікатор документа employee_uuid (опціонально) UUID - ідентифікатор співробітника, під яким виконуються обробка документа |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді (json) передаються дані документа (об'єкт XDoc).
Створити документ з метаданими (чернетку) POST /api/sd/eds/doc
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/sd/eds/doc |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
multipart/form-data |
|
REQUEST |
|
|
JSON Body |
В тілі запиту передається json файл з метаданими документа
Приклад запиту:
|
RESPONSE
В тілі відповіді (json) передається doc_uuid - унікальний ідентифікатор документа:
{"doc_uuid":"023403f8-9201-41f2-8c18-cf4777a058fc"}
API сервісу EDIN-IDP
Опис методів АРІ та обʼєктів для роботи в сервісі EDIN-IDP
Опис типової структури документа
[
{
"DocumentName": "Назва документу",
"Barcode": "штрихкод документу",
"DocumentType": "000-не визначено; 001-договір; 002-додаткова угода; 003-рахунок/рахунок-фактура; 004-акт/акт виконаних робіт/акт наданих послуг/акт надання послуг; 005-накладна/товарна накладна; 006-видаткова накладна; 007-наряд замовлення.",
"DocumentHeader": {
"Number": "номер додаткової угоди. поле опціональне",
"Date": "дата документу. формат YYYY-MM-DD. поле опціональне",
"Location": "місце складання",
"Route": "маршрут",
"DeliveryTerms": "умови поставки",
"DeliveryTime": "час доставки",
"CarNumber": "номер автомобіля",
"PayToDate": "сплатити до дати. формат YYYY-MM-DD. поле опціональне"
},
"Agreement": [
{
"AgreementNumber": "номер договору",
"AgreementDate": "дата документу. формат YYYY-MM-DD. поле опціональне",
"Subject": "предмет договору"
}
],
"Equipment": [
{
"Name": "найменування обладнання",
"Serial": "серійний номер"
}
],
"AdditionalInfo": [
{
"Name": "назва",
"Value": "значення"
}
],
"ReasonOfService": [
"причина виклику"
],
"CompletedWorks": [
"виконані роботи"
],
"Recommendations": [
"рекомендації"
],
"Notes": [
"помітки рукописним шрифтом"
],
"SpareParts": [
{
"Name": "Найменування використаних запасних частин та матеріалів",
"Quantity": "кількість",
"Price": "Вартість"
}
],
"Summary": "короткий зміст документу",
"DocumentParties": [
{
"Role": "роль контрагента: оператор, абонемент, продавець, покупець, ...",
"ILN": "GLN контрагента",
"TaxID": "ІПН контрагента",
"UtilizationRegisterNumber": "ЄДРПОУ контрагента",
"Name": "назва компанії контрагента",
"Signature":"boolean. true- є підпис; false-підпису немає",
"Stamp":"boolean. true- є штамп; false-штампу немає",
"Addresses": [
{
"Type": "тип адреси",
"StreetAndNumber": "вулиця/проспект/бульвар і номер будинку контрагента",
"CityName": "місто контрагента",
"District": "район та/або територіальна громада",
"Region": "область",
"PostalCode": "поштовий код контрагента"
}
],
"PhoneNumbers": [
{
"Type": "тип телефоного номера",
"Phone": "телефоний номер контрагента"
}
],
"BankAccounts": [
{
"IBAN": "IBAN контрагента",
"BankName": "назва банку"
}
],
"Email": "email",
"Signer": {
"Position": "посада підписанта",
"Name": "ПІП підписанта"
}
}
],
"DocumentLines": [
{
"LineNumber": "номер позиції в табличній частині",
"EAN": "Штрих-код продукту відповідно до стандарту EAN-8 та EAN-13",
"BuyerItemCode": "Артикул/код товару",
"CertNumber": "номер сертифікату",
"ExternalItemCode": "Код товару згідно з довідника УКТ ЗЕД. завжди складається з 10 символів",
"ItemDescription": "назва товару/послуги",
"InvoiceQuantity": "Замовлена кількість. десяткове число",
"UnitOfMeasure": "одиниці виміру",
"Location": "Локація де проводилась робота чи для якої продається товар",
"UnitGrossPrice": "Ціна однієї одиниці з ПДВ. десяткове число",
"UnitNetPrice": "Ціна однієї одиниці без ПДВ. десяткове число",
"TaxRate": "Ставка ПДВ (20/19/16/14/7/2/0)",
"TaxCategoryCode": "Код категорії податку:S - стандартний податок; можливі значення TaxRate: 20/19/16/14/7/2 (інакше помилка),E - звільнений від сплати податку; можливі значення TaxRate=0, Z - нульова ставка (0%); можливі значення TaxRate=0",
"GrossAmount": "Сума з ПДВ по позиції. десяткове число",
"TaxAmount": "Сума ПДВ по позиції. десяткове число",
"NetAmount": "Всього без ПДВ. десяткове число"
}
],
"DocumentSummary": {
"TotalLines": "Кількість рядків в документі",
"TotalNetAmount": "Загальна сума без ПДВ. десяткове число",
"TotalTaxAmount": "Сума ПДВ. десяткове число",
"TotalGrossAmount": "Загальна сума з ПДВ. десяткове число",
"TaxSummary": [
{
"TaxRate": "Ставка ПДВ (20/19/16/14/7/2/0)",
"TaxCategoryCode": "Код категорії податку:S - стандартний податок; можливі значення TaxRate: 20/19/16/14/7/2 (інакше помилка),E - звільнений від сплати податку; можливі значення TaxRate=0, Z - нульова ставка (0%); можливі значення TaxRate=0",
"TaxAmount": "Сума податку для конкретної категорії податку. десяткове число",
"TaxableAmount": "Оподаткована сума для конкретної категорії податку. десяткове число"
}
]
},
"AdditionalDocuments": [
{
"DocName": "Назва документу",
"Number": "номер документу. поле опціональне",
"Date": "дата документу. формат YYYY-MM-DD. поле опціональне"
}
]
}
]
Опис обʼєктів для методів сервісу EDIN-IDP
Обʼєкт IDPTasksQuery
export type IDPTasksQuery = {
uuid?: string; // uuid завдання
date?: DateTimeRange; // обʼєкт DateTimeRange
fileName?: string; // назва файла
limit?: Limitation; // обʼєкт Limitation
status?: IDPTaskStatus[]; // масив обʼєктів IDPTaskStatus
source?: IDPTaskSource[]; // масив обʼєктів IDPTaskSource
}Обʼєкт IDPTask
export type IDPTask = {
id: number; // ід задачі
userId: number; // ід користувача
uuid: string; // uuid задачі
status: IDPTaskStatus; // обʼєкт IDPTaskStatus
date: number; // дата завантаження файла у форматі UnixTimeStamp
doneDate: number; // дата завершення розпізнавання
info: IDPTaskInfo; // обʼєкт IDPTaskInfo
docType: IDPDocType; // обʼєкт IDPDocType
}Обʼєкт IDPTaskStatus
export type IDPTaskStatus = "ERROR" | "CREATED" | "PROCESSING" | "DONE" | "VERIFIED" | "PROCESSED";Обʼєкт IDPTaskSource
export type IDPTaskSource = "API" | "WEB";Обʼєкт DateTimeRange
export type DateTimeRange = {
startTimestamp?: number; // дата початку періоду у форматі UnixTimeStamp
finishTimestamp?: number; // дата завершення періоду у форматі UnixTimeStamp
excludeZero?: boolean; // виключити пусті дати
}Обʼєкт Limitation
export type Limitation = {
offset?: number; // початкова позиція
count?: number; // к-сть файлів у відображенні (не більше 100)
}Обʼєкт IDPTaskInfo
export type IDPTaskInfo = {
source: IDPTaskSource; // обʼєкт IDPTaskSource
mimeType: string; // тип файла
fileName: string; // назва файла
}Обʼєкт IDPDocType
export type IDPDocType = {
docTypeId: number; // ід типу документа
docTypeAlias: string; // псевдонім типу документа
docType: string; // назва типу документа
}Опис методів для сервісу EDIN-IDP
Дана інструкція описує послідовність викликів методів API, призначених для розпізнавання та перетворення PDF-файлів у структуровані документи.
Для роботи з методами сервісу EDIN-IDP у вас має бути IDP_API_KEY, який потрібно вказувати в Header в параметрі x-api-key
Надсилання документа на розпізнання
Під час одного запиту можна надіслати лише один файл.
REQUEST
| URL | https://idp.edin.ua/api/docs/upload |
| Method | POST |
| Header | x-api-key={IDP_API_KEY} |
| Body | Content-Type: multipart/form-data. |
| Params | |
| from_user | Опціонально. Логін користувача свого акаунту, від імені якого буде здійснено відправку на конвертацію |
Приклад запиту:
curl -v -H "x-api-key: {IDP_API_KEY}" -F upload='@{path to file}' https://idp.edin.ua/api/docs/uploadRESPONSE
-
У відповідь надходить унікальний ідентифікатор (UUID) завдання на конвертацію.
Отримання списку файлів
REQUEST
| URL | https://idp.edin.ua/api/docs/search |
| Method | POST |
| Header | x-api-key={IDP_API_KEY} |
| Body |
Content-Type: application/json
|
| Params |
|
| from_user | Опціонально. Логін користувача свого акаунту, від імені якого буде здійснено фільтрацію документів. |
Приклад запиту:
curl -v -X POST -H "x-api-key: MY_TEST_API_KEY" -H "Content-Type: application/json" --data '{"status": ["DONE", "VERIFIED"]}' https://idp.edin.ua/api/docs/searchRESPONSE
- Масив об'єктів
IDPTask[].
Приклад відповіді:
[
{
"id": 293,
"userId": 2000988,
"uuid": "90c5f7ae-5747-4f56-bf07-068bfe8160cf",
"status": "DONE",
"date": 1753077616,
"doneDate": 1753077643,
"info": {
"source": "API",
"mimeType": "image/jpeg",
"fileName": "300625_111323_1493.jpg"
}
}
]Отримання результату конвертації файлу
REQUEST
| URL | https://idp.edin.ua/api/docs/response |
| Method | GET |
| Header | x-api-key={IDP_API_KEY} |
| Params | |
| uuid | uuid завдання |
Приклад запиту:
curl -v -H "x-api-key: {IDP_API_KEY}" 'https://idp.edin.ua/api/docs/response?uuid=90c5f7ae-5747-4f56-bf07-068bfe8160cf'RESPONSE
- У відповідь надходить json-масив структурованих документів. Структура документів може бути або типовою (універсальною), або згідно з індивідуальними налаштуваннями
Отримання вмісту файлу, відправленого на конвертацію
REQUEST
| URL | https://idp.edin.ua/api/docs/request |
| Method | GET |
| Header | x-api-key={IDP_API_KEY} |
| Params | |
| uuid | uuid завдання |
Приклад запиту:
curl -v -H "x-api-key: {IDP_API_KEY}" 'https://idp.edin.ua/api/docs/request?uuid=90c5f7ae-5747-4f56-bf07-068bfe8160cf'RESPONSE
- У відповідь надходить оригінальний файл, який було відправлено на розпізнавання та перетворення.
Зміна статусу завдання
REQUEST
| URL | https://idp.edin.ua/api/docs/status |
| Method | POST |
| Header | x-api-key={IDP_API_KEY} |
| Params | |
| uuid | uuid завдання |
| status | одне зі значень [CREATED, VERIFIED, PROCESSED] |
CREATED - цей статус можна вказати у випадку якщо документ має поточний статус ERROR. Після зміни статусу на CREATED, документ буде повторно конвертований.
VERIFIED - цей статус можна вказати у випадку якщо документ має поточний статус DONE.
PROCESSED - цей статус можна вказати у випадку якщо документ має поточний статус DONE або VERIFIED
Приклад запиту:
curl -v -H "x-api-key: {IDP_API_KEY}" 'https://idp.edin.ua/api/docs/status?uuid=90c5f7ae-5747-4f56-bf07-068bfe8160cf&status=PROCESSED'RESPONSE
У відповіді повертається повідомлення та статус:
| STATUS | Message | Коментар |
| 200 | Запит успішно опрацьовано | Статус задачі змінено успішно |
| 400 | Unsupported 'status' param value | Неправильний статус завдання. Вкажіть коректний статус |
| 400 | Only task with status DONE can be changed to VERIFIED. Current task status is: PROCESSED | Неправильна послідовність зміни статусу |
| 500 | Internal Server Error. Chanel ID: 123456 | Непередбачена внутрішня помилка. Необхідно звернутись до тех. підтримки для зʼясування причини помилки. |
JSON приклади
Приклади відповіді для перегляду пропозиції / узгодження
JSON Документ AGREEM (body_type=1):
Специфікація «Товарного узгодження» (AGREEM)
{
"DATE": "2020-05-21",
"NUMBER": "2000000038",
"DOCSTARTDATE": "2020-05-24",
"DOCENDDATE": "2020-05-31",
"CONTRACTNUMBER": "1200.996633",
"CAMPAIGN_GLN": "9864119011415",
"CONTRACTEXPIRYDATE": "2020-05-31",
"CAMPAIGNNUMBER": "1200",
"CAMPAIGNDATE": "2020-07-27",
"PRICETYPE": "regular",
"DOCACTION": "0",
"HEAD": [
{
"SENDER": "9864067620417",
"RECIPIENT": "9864119011415",
"BUYER": "9864119011415",
"SUPPLIER": "9864067620417",
"POSITION": [
{
"POSITIONNUMBER": "1",
"POSITIONIDBUYER": "1",
"PRODUCTIDBUYER": "34734",
"PRODUCT": "5908230523946",
"DESCRIPTION": "Kabanos Pork",
"PRICEWITHOUTVAT": "81.71",
"PRICEWITHVAT": "98.05",
"PRICEWITHOUTVAT_CHNG": "100",
"PRICEWITHVAT_CHNG": "120",
"DISCOUNTPRICEWITHOUTVAT": "60.00",
"DISCOUNTPRICEWITHVAT": "72.00",
"DISCOUNTPRICEWITHOUTVAT_CHNG": "60.00",
"DISCOUNTPRICEWITHVAT_CHNG": "72",
"STATE": 1,
"UNIT": "PCE",
"VAT": "20",
"DIFFPRICE": "22.38",
"DIFFDISCOUNTPRICE": "0",
"DISCOUNTVAL_CHNG": "40",
"DISCOUNTVAL": "26.57",
"UCCFEA": "0000000000"
},
{
"POSITIONNUMBER": "2",
"POSITIONIDBUYER": "2",
"PRODUCTIDBUYER": "34735",
"PRODUCT": "5908230523953",
"DESCRIPTION": "Kabanos Poultry",
"PRICEWITHOUTVAT": "81.71",
"PRICEWITHVAT": "98.05",
"PRICEWITHOUTVAT_CHNG": "120",
"PRICEWITHVAT_CHNG": "144",
"DISCOUNTPRICEWITHOUTVAT": "60.00",
"DISCOUNTPRICEWITHVAT": "72.00",
"DISCOUNTPRICEWITHOUTVAT_CHNG": "60.00",
"DISCOUNTPRICEWITHVAT_CHNG": "72",
"STATE": 0,
"UNIT": "PCE",
"VAT": "20",
"DIFFPRICE": "46.86",
"DIFFDISCOUNTPRICE": "0",
"DISCOUNTVAL_CHNG": "50",
"DISCOUNTVAL": "26.57",
"UCCFEA": "1111111111"
}
],
"ATTACHMENT": "attachdoc.pdf"
}
]
}
JSON Документ NOVELTY (body_type=1):
Специфікація «Комерційна пропозиція» (NOVELTY).
{
"SENDER": "9864067620417",
"RECIPIENT": "9864119011415",
"NUMBER": "1123",
"DATE": "Fri Jan 27 2023 16:38:33 GMT+0200 (за східноєвропейським стандартним часом)",
"CATEGORY": "Бакалія",
"GROUP1": "Обіди швидкого приготування",
"GROUP2": "Бульони, супи швидкого приготування",
"GROUP_ID": "Крем-суп",
"POSTPONEMENT": "15",
"MARKETING": {
"PROMOTION": "23",
"LOGISTICS": "20",
"DAMAGE": "4",
"TPR": "10"
},
"RESPONSIBLE_OFFICER": {
"SURNAME": "Тест",
"NAME": "Александр",
"MIDDLENAME": "Володимирович",
"EMAIL": "1@2.ua",
"PHONE": "380962386999",
"UUID": "c50d78d1-7a91-48f7-b789-a96eaa1fb6bf"
},
"STORAGE_CONDITIONS": "Умови зберігання товару",
"RETURN_CONDITIONS": "Умови повернення товару",
"DELIVERY_OPTION": "3",
"MINIMAL_AMOUNT": "50000",
"DELIVERY_REGION": "Донецька,Житомирська,Закарпатська",
"POSITION": []
}JSON налаштування ритейлера/мережі - лише перегляд (body_type=2):
{
"changePriceTerm": 1,
"isPriceWithDiscount": false,
"isPriceWithVat": false,
"maxNumbersOfAgreements": 0,
"isChangePricePeriod": false,
"changePromoPriceTerm": 3,
"changeLastingTerm": 0,
"changePromoLastingTerm": 0,
"changeOutputGoodsTerm": 2,
"isNewPositions": false,
"isExtendedSpec": false,
"isOutputGoods": true,
"isTypePromo": true,
"isPromoQuantity": false,
"isExtendedSpecUcat": false,
"isSignUnBlock": false,
"isProlongationContract": true,
"isNewSupplier": true,
"isReplaceProductlistData": true,
"isActionControl": true
}
JSON Обгрунтування (body_type=3)
Передається бінарний файл з вкладенням.
Дані запиту налаштування специфікації мережі
Опис параметрів об'єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
changePriceTerm |
int |
термін подачі на перегляд регулярних цін |
|
isPriceWithDiscount |
boolean |
робота з ціною зі знижкою |
|
isPriceWithVat |
boolean |
узгодження по ціні з ПДВ |
|
maxNumbersOfAgreements |
int |
максимальна кількість узгоджень |
|
isChangePricePeriod |
boolean |
доступ до зміни термінів дії |
|
changePromoPriceTerm |
int |
термін подачі на розгляд промо цін |
|
changeLastingTerm |
int |
період дії регулярних цін (за замовчуванням) |
|
changePromoLastingTerm |
int |
період дії промо цін (за замовчуванням) |
|
changeOutputGoodsTerm |
int |
термін подачі на розгляд призупинення/виведення товару |
|
isNewPositions |
boolean |
введення нових пропозицій по розширенню |
|
isExtendedSpec |
boolean |
лише розширені характеристики Listex |
|
isOutputGoods |
boolean |
призупинення/виведення товару з асортименту |
|
isTypePromo |
boolean |
узгодження промо ціни |
|
isPromoQuantity |
boolean |
вказується кількість товарів промо |
|
isExtendedSpecUcat |
boolean |
лише розширені характеристики Ucat |
|
isSignUnBlock |
boolean |
можливість підписувати COMDOC_008 за день до початку дії ціни |
|
isProlongationContract |
boolean |
автоматична пролонгація контракту/специфікації |
|
isNewSupplier |
boolean |
нові постачальники |
|
isReplaceProductlistData |
boolean |
попереднє очищення PRODUCTLIST |
|
isActionControl |
boolean |
керування акціями |
JSON приклад
{
"changePriceTerm":1,
"isPriceWithDiscount":false,
"isPriceWithVat":false,
"maxNumbersOfAgreements":0,
"isChangePricePeriod":true,
"changePromoPriceTerm":3,
"changeLastingTerm":0,
"changePromoLastingTerm":0,
"changeOutputGoodsTerm":2,
"isNewPositions":true,
"isExtendedSpec":false,
"isOutputGoods":true,
"isTypePromo":true,
"isPromoQuantity":false,
"isExtendedSpecUcat":false,
"isSignUnBlock":true,
"isProlongationContract":false,
"isNewSupplier":true,
"isReplaceProductlistData":false,
"isActionControl":true
}
Приклад запиту при відправці вкладень (обгрунтування) до коментаря
POST /api/es/agreement/comment?gln=9864067620417&uuid=8b65e539-fad4-4fc3-ba5c-fe043092851e&comment=Some HTTP/1.1 ...else headers... Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW ----WebKitFormBoundary7MA4YWxkTrZu0gW Content-Disposition: form-data; name="4543"; filename="1625493467304.png" Content-Type: image/png (data) ----WebKitFormBoundary7MA4YWxkTrZu0gW Content-Disposition: form-data; name="333"; filename="List_of_documents_Inbox_2021-06-30_12-47-31.xlsx" Content-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet (data) ----WebKitFormBoundary7MA4YWxkTrZu0gW
Приклад запиту при формуванні чернетки «Універсального/неструктурованого документа» (CONDRA)
Приклад вкладення в pdf форматі
POST /api/v2/eds/doc/condra/create?gln=9864232319962&recipient=9864232319979&number=145-97f4-aa7ff1&date=2021-06-15&doctype=1502&contractNumber=contractNumber_2&contractDate=2021-06-15&summ=30000&delivery=9864232319962 HTTP/1.1
Content-Type: multipart/form-data; boundary=-------------573cf973d5228
...else headers...
---------------573cf973d5228
Content-Disposition: form-data; name="file"; filename="file.pdf"
Content-Type: application/pdf
{Content of PDF file}
Приклад вкладення в xml форматі
POST /api/v2/eds/doc/condra/create?gln=9864232319962&recipient=9864232319979&number=145-97f4-aa7ff1&date=2021-06-15&doctype=1502&contractNumber=contractNumber_2&contractDate=2021-06-15&summ=30000&delivery=9864232319962 HTTP/1.1
Content-Type: multipart/form-data; boundary=-------------573cf973d5228
...else headers...
---------------573cf973d5228
Content-Disposition: form-data; name="file"; filename="file.xml"
Content-Type: application/xml
{Content of XML file}
Приклад вкладення в p7s форматі
POST /api/v2/eds/doc/condra/create?gln=9864232319962&recipient=9864232319979&number=145-97f4-aa7ff1&date=2021-06-15&doctype=1502&contractNumber=contractNumber_2&contractDate=2021-06-15&summ=30000&delivery=9864232319962 HTTP/1.1
Content-Type: multipart/form-data; boundary=-------------573cf973d5228
...else headers...
---------------573cf973d5228
Content-Disposition: form-data; name="file"; filename="file.p7s"
Content-Type: application/pkcs7-signature
{Content of P7S file}
Приклад запиту при створенні та відправці «Універсального/неструктурованого документа» (CONDRA)
Приклад вкладення в pdf форматі:
POST /api/v2/eds/doc/condra/create_and_send?gln=9864232319962&recipient=9864232319979&number=145-97f4-aa7ff1&date=2021-06-15&doctype=1502&contractNumber=contractNumber_2&contractDate=2021-06-15&summ=30000&delivery=9864232319962 HTTP/1.1
Content-Type: multipart/form-data; boundary=-------------573cf973d5228
...else headers...
---------------573cf973d5228
Content-Disposition: form-data; name="file"; filename="file.pdf"
Content-Type: application/pdf
{Content of PDF file}
Приклад вкладення в xml форматі:
POST /api/v2/eds/doc/condra/create_and_send?gln=9864232319962&recipient=9864232319979&number=145-97f4-aa7ff1&date=2021-06-15&doctype=1502&contractNumber=contractNumber_2&contractDate=2021-06-15&summ=30000&delivery=9864232319962 HTTP/1.1
Content-Type: multipart/form-data; boundary=-------------573cf973d5228
...else headers...
---------------573cf973d5228
Content-Disposition: form-data; name="file"; filename="file.xml"
Content-Type: application/xml
{Content of XML file}
Приклад вкладення в p7s форматі:
POST /api/v2/eds/doc/condra/create_and_send?gln=9864232319962&recipient=9864232319979&number=145-97f4-aa7ff1&date=2021-06-15&doctype=1502&contractNumber=contractNumber_2&contractDate=2021-06-15&summ=30000&delivery=9864232319962 HTTP/1.1
Content-Type: multipart/form-data; boundary=-------------573cf973d5228
...else headers...
---------------573cf973d5228
Content-Disposition: form-data; name="file"; filename="file.p7s"
Content-Type: application/pkcs7-signature
{Content of P7S file}
Дані тіла запиту, що передаються для створення чернетки (CONDRA)
Приклад CONDRA:
{
"DATE": "2021-03-02", // Дата документа в форматі YYYY-MM-DD, повинна співпадати з параметром doc_date
"HEAD": [
{
"TYPE": "1", // константа для тіла документа = 1
"SENDER": "9864000000417", // gln відправника
"SUPPLIER": "9864000000417", // gln відправника
"BUYER": "9864000000424", // gln отримувача
"RECIPIENT": "9864000000424", // gln отримувача
"TRANSGUID": "332a120d-6030-48af-bc8b-675f0c7f9823", // UUID транзакції (метод "Отримання UUID" або через Вашу облікову систему)
"DOCGUID": "082667cd-5cb0-4b0a-bae8-51d937f7fe86", // UUID запису (метод "Отримання UUID" або через Вашу облікову систему)
"CONTENT": [
{
"FILENAME": "reestr_nakl_factoring.xlsx" // повне ім'я файлу без дерикторії, але з розширенням.
}
]
}
],
"NUMBER": "api1", // Номер документа, повинен співпадати з doc_number
"DOCTYPE": 81 // тип документа, пока залишаємо константу = 81
}
Приклади додавання / оновлення полів екстрапараметрів
Приклад CONDRA
{
"doc_num": "uniq", // номер документа
"doc_date": 1615932000, // дата документа в Unixtimestamp
"action": "1", // константа = 1
"sender": "9864065160861", // gln відправника
"recipient": "4820000000000", // gln відправника
"trans_id": "c48f97e9-8d98-4c52-8635-675a6145f570", // UUID транзакції (метод "Отримання UUID" або через Вашу облікову систему)
"varn": "a190e8cc-50a9-4ef4-9815-ec41b000f60c", // UUID запису (метод "Отримання UUID" або через Вашу облікову систему)
"buyer_uuid": "4820000000000", // gln отримувача
"supplier_uuid": "9864065160861", // gln отримувача
"delivery_place_uuid": "4820000000000", // gln місця доставки
"file_name": "77f00932fd46bf24ec6046f373898fd7.gif" // повне ім'я файлу без дерикторії, але з розширенням.
}
Приклад TRANSPORTATIONORDER
{
"carrier_uuid": "9864065747215",
"partner_id": "0",
"sub_doc_type_id": "1",
"sender": "9864065737773",
"doc_num": "Zaya_001",
"customer_uuid": "9864065737773",
"doc_date": 1674424800,
"draft_date_created": "1674484067",
"recipient": "9864065747215",
"doc_process": "0",
"driver_uuid": "null",
"car_number": "null",
"trailer_number": "null",
"semitrailer_number": "null"
}
Приклад відповіді при створенні квитанції «Повідомлення про відмову від підписання документу»
Приклад тіла відповіді (JSON)
{
"documentForRepeal": {
"code": "006",
"date": "2019-08-08",
"number": "F24F5899EF846E147AAC",
"type": "Видаткова накладна"
},
"parties": {
"partners": [
{
"IBAN": "UA153510050000026007614396500",
"code": "33133118",
"gln": "9864232319962",
"inn": "3313311833",
"name": "Левицкий М.Г.",
"status": "Відправник",
"type": "Юридична"
},
{
"code": "33133119",
"gln": "9864232319979",
"inn": "3313311834",
"name": "Левицкий М.Г.",
"status": "Отримувач",
"type": "Юридична"
}
]
},
"title": {
"code": "19",
"comments": [],
"date": "2019-12-24",
"number": "F24F5899EF846E147AAC",
"reapealText": "чето как то надо бы аннулировать то ли",
"repealDate": "2019-12-24",
"type": "Анулювання"
}
}
Приклад тіла відповіді (XML)
<?xml version="1.0" encoding="UTF-8"?>
<ЕлектроннийДокумент>
<Заголовок>
<НомерДокументу>7C_ftpTest_test1</НомерДокументу>
<ТипДокументу>Повідомлення про відмову від підписання документу</ТипДокументу>
<КодТипуДокументу>021</КодТипуДокументу>
<ДатаДокументу>2022-10-25</ДатаДокументу>
</Заголовок>
<Сторони>
<Контрагент>
<СтатусКонтрагента>Відправник</СтатусКонтрагента>
<ВидОсоби>Фізична</ВидОсоби>
<НазваКонтрагента>FELEX TEST Bogdan</НазваКонтрагента>
<КодКонтрагента>876543221</КодКонтрагента>
<ІПН>86543326</ІПН>
<GLN>9864065160861</GLN>
</Контрагент>
<Контрагент>
<СтатусКонтрагента>Отримувач</СтатусКонтрагента>
<ВидОсоби>Фізична</ВидОсоби>
<НазваКонтрагента>ТОВ "МЕТРО КЕШ ЕНД КЕРІ УКРАЇНА"</НазваКонтрагента>
<КодКонтрагента>12345670</КодКонтрагента>
<ІПН>1234445670</ІПН>
<GLN>4820086630009</GLN>
</Контрагент>
</Сторони>
<Текст>testreject</Текст>
</ЕлектроннийДокумент>
<?xml version="1.0" encoding="UTF-8"?>
<Document-Invoice>
<Invoice-Header>
<InvoiceNumber>PRN_4855_1</InvoiceNumber>
<InvoiceDate>2024-10-07</InvoiceDate>
<DocumentFunctionCode>RPLN</DocumentFunctionCode>
<InvoiceCancelReason>TEST</InvoiceCancelReason>
</Invoice-Header>
<BasementInvoice-Reference>
<Number>PRN_4855_1</Number>
<Date>2024-10-07</Date>
<FunctionCode>PRN</FunctionCode>
</BasementInvoice-Reference>
<Invoice-Parties>
<Buyer>
<ILN>4824034000005</ILN>
<TaxID>1020301020</TaxID>
<UtilizationRegisterNumber>34554362</UtilizationRegisterNumber>
<Name>ТОВ "Фоззі-Фуд"</Name>
</Buyer>
<Seller>
<ILN>9864065732181</ILN>
<TaxID>1010101016</TaxID>
<UtilizationRegisterNumber>34554363</UtilizationRegisterNumber>
<Name>FelEx_1</Name>
</Seller>
<DeliveryPoint>
<ILN>4824034000005</ILN>
<Name>ТОВ "Фоззі-Фуд"</Name>
<CityName>м. Вишневе</CityName>
<StreetAndNumber>вул. Промислова, 5</StreetAndNumber>
<PostalCode>8132</PostalCode>
</DeliveryPoint>
<Payer>
<ILN>4824034000005</ILN>
<Name>ТОВ "Фоззі-Фуд"</Name>
<CityName>м. Вишневе</CityName>
<StreetAndNumber>вул. Промислова, 5</StreetAndNumber>
<PostalCode>8132</PostalCode>
</Payer>
<Repealer>
<ILN>9864065732181</ILN>
<TaxID>1010101016</TaxID>
<UtilizationRegisterNumber>34554363</UtilizationRegisterNumber>
<Name>FelEx_1</Name>
</Repealer>
</Invoice-Parties>
</Document-Invoice>
Приклад тіла відповіді (json_base64)
eyJ0aXRsZSI6eyJudW1iZXIiOiIyMDE5LTEyLTAzLVRFU1QtMDAzIiwidHlwZSI6ItCQ0L3Rg9C7 0Y7QstCw0L3QvdGPIiwiY29kZSI6IjE5IiwiZGF0ZSI6IjIwMjAtMDEtMDMiLCJyZWFwZWFsVGV4 dCI6ItCa0LDQutCw0Y8g0YLQviDRgdGD0L/QtdGAINC/0YDQuNGH0LjQvdCwINC00LvRjyDQsNC9 0L3Rg9C70LjRgNC+0LLQsNC90LjRjyIsInJlcGVhbERhdGUiOiIyMDIwLTAxLTAzIiwiY29tbWVu dHMiOltdfSwiZG9jdW1lbnRGb3JSZXBlYWwiOnsibnVtYmVyIjoiMjAxOS0xMi0wMy1URVNULTAw MyIsInR5cGUiOiLQktC40LTQsNGC0LrQvtCy0LAg0L3QsNC60LvQsNC00L3QsCIsImNvZGUiOiIw MDYiLCJkYXRlIjoiMjAxOS0xMi0wMyJ9LCJwYXJ0aWVzIjp7InBhcnRuZXJzIjpbeyJzdGF0dXMi OiLQktGW0LTQv9GA0LDQstC90LjQuiIsInR5cGUiOiLQrtGA0LjQtNC40YfQvdCwIiwibmFtZSI6 ItCb0LXQstC40YbQutC40Lkg0Jwu0JMuIiwiY29kZSI6IjMzMTMzMTE4IiwiaW5uIjoiMzMxMzMx MTgzMyIsIklCQU4iOiJVQTE1MzUxMDA1MDAwMDAyNjAwNzYxNDM5NjUwMCIsImdsbiI6Ijk4NjQy MzIzMTk5NjIifSx7InN0YXR1cyI6ItCe0YLRgNC40LzRg9Cy0LDRhyIsInR5cGUiOiLQrtGA0LjQ tNC40YfQvdCwIiwibmFtZSI6ItCb0LXQstC40YbQutC40Lkg0Jwu0JMuIiwiY29kZSI6IjMzMTMz MTE5IiwiaW5uIjoiMzMxMzMxMTgzNCIsImdsbiI6Ijk4NjQyMzIzMTk5NzkifV19fQ==
Приклад тіла відповіді (xml_base64)
PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4gCjzQldC70LXQutGC0YDQvtC9 0L3QuNC50JTQvtC60YPQvNC10L3Rgj4KICA80JfQsNCz0L7Qu9C+0LLQvtC6PgogICAgPNCd0L7Q vNC10YDQlNC+0LrRg9C80LXQvdGC0YM+MjAxOS0xMi0wMy1URVNULTAwMzwv0J3QvtC80LXRgNCU 0L7QutGD0LzQtdC90YLRgz4KICAgIDzQotC40L/QlNC+0LrRg9C80LXQvdGC0YM+0JDQvdGD0LvR jtCy0LDQvdC90Y88L9Ci0LjQv9CU0L7QutGD0LzQtdC90YLRgz4KICAgIDzQmtC+0LTQotC40L/R g9CU0L7QutGD0LzQtdC90YLRgz4xOTwv0JrQvtC00KLQuNC/0YPQlNC+0LrRg9C80LXQvdGC0YM+ CiAgICA80JTQsNGC0LDQlNC+0LrRg9C80LXQvdGC0YM+MjAyMC0wMS0wMzwv0JTQsNGC0LDQlNC+ 0LrRg9C80LXQvdGC0YM+CiAgICA80J/RgNC40YfQuNC90LDQkNC90YPQu9GO0LLQsNC90L3Rjz7Q mtCw0LrQsNGPINGC0L4g0YHRg9C/0LXRgCDQv9GA0LjRh9C40L3QsCDQtNC70Y8g0LDQvdC90YPQ u9C40YDQvtCy0LDQvdC40Y88L9Cf0YDQuNGH0LjQvdCw0JDQvdGD0LvRjtCy0LDQvdC90Y8+CiAg ICA80JTQsNGC0LDQkNC90YPQu9GO0LLQsNC90L3Rjz4yMDIwLTAxLTAzPC/QlNCw0YLQsNCQ0L3R g9C70Y7QstCw0L3QvdGPPgogIDwv0JfQsNCz0L7Qu9C+0LLQvtC6PgogIDzQlNC+0LrRg9C80LXQ vdGC0KnQvtCQ0L3Rg9C70Y7RlNGC0YzRgdGPPgogICAgPNCd0L7QvNC10YDQlNC+0LrRg9C80LXQ vdGC0YM+MjAxOS0xMi0wMy1URVNULTAwMzwv0J3QvtC80LXRgNCU0L7QutGD0LzQtdC90YLRgz4K ICAgIDzQotC40L/QlNC+0LrRg9C80LXQvdGC0YM+0JLQuNC00LDRgtC60L7QstCwINC90LDQutC7 0LDQtNC90LA8L9Ci0LjQv9CU0L7QutGD0LzQtdC90YLRgz4KICAgIDzQmtC+0LTQotC40L/Rg9CU 0L7QutGD0LzQtdC90YLRgz4wMDY8L9Ca0L7QtNCi0LjQv9GD0JTQvtC60YPQvNC10L3RgtGDPgog ICAgPNCU0LDRgtCw0JTQvtC60YPQvNC10L3RgtGDPjIwMTktMTItMDM8L9CU0LDRgtCw0JTQvtC6 0YPQvNC10L3RgtGDPgogIDwv0JTQvtC60YPQvNC10L3RgtCp0L7QkNC90YPQu9GO0ZTRgtGM0YHR jz4KICA80KHRgtC+0YDQvtC90Lg+CiAgICA80JrQvtC90YLRgNCw0LPQtdC90YI+CiAgICAgIDzQ odGC0LDRgtGD0YHQmtC+0L3RgtGA0LDQs9C10L3RgtCwPtCS0ZbQtNC/0YDQsNCy0L3QuNC6PC/Q odGC0LDRgtGD0YHQmtC+0L3RgtGA0LDQs9C10L3RgtCwPgogICAgICA80JLQuNC00J7RgdC+0LHQ uD7QrtGA0LjQtNC40YfQvdCwPC/QktC40LTQntGB0L7QsdC4PgogICAgICA80J3QsNC30LLQsNCa 0L7QvdGC0YDQsNCz0LXQvdGC0LA+0JvQtdCy0LjRhtC60LjQuSDQnC7Qky48L9Cd0LDQt9Cy0LDQ mtC+0L3RgtGA0LDQs9C10L3RgtCwPgogICAgICA80JrQvtC00JrQvtC90YLRgNCw0LPQtdC90YLQ sD4zMzEzMzExODwv0JrQvtC00JrQvtC90YLRgNCw0LPQtdC90YLQsD4KICAgICAgPNCG0J/QnT4z MzEzMzExODMzPC/QhtCf0J0+CiAgICAgIDxJQkFOPlVBMTUzNTEwMDUwMDAwMDI2MDA3NjE0Mzk2 NTAwPC9JQkFOPgogICAgICA8R0xOPjk4NjQyMzIzMTk5NjI8L0dMTj4KICAgIDwv0JrQvtC90YLR gNCw0LPQtdC90YI+CiAgICA80JrQvtC90YLRgNCw0LPQtdC90YI+CiAgICAgIDzQodGC0LDRgtGD 0YHQmtC+0L3RgtGA0LDQs9C10L3RgtCwPtCe0YLRgNC40LzRg9Cy0LDRhzwv0KHRgtCw0YLRg9GB 0JrQvtC90YLRgNCw0LPQtdC90YLQsD4KICAgICAgPNCS0LjQtNCe0YHQvtCx0Lg+0K7RgNC40LTQ uNGH0L3QsDwv0JLQuNC00J7RgdC+0LHQuD4KICAgICAgPNCd0LDQt9Cy0LDQmtC+0L3RgtGA0LDQ s9C10L3RgtCwPtCb0LXQstC40YbQutC40Lkg0Jwu0JMuPC/QndCw0LfQstCw0JrQvtC90YLRgNCw 0LPQtdC90YLQsD4KICAgICAgPNCa0L7QtNCa0L7QvdGC0YDQsNCz0LXQvdGC0LA+MzMxMzMxMTk8 L9Ca0L7QtNCa0L7QvdGC0YDQsNCz0LXQvdGC0LA+CiAgICAgIDzQhtCf0J0+MzMxMzMxMTgzNDwv 0IbQn9CdPgogICAgICA8R0xOPjk4NjQyMzIzMTk5Nzk8L0dMTj4KICAgIDwv0JrQvtC90YLRgNCw 0LPQtdC90YI+CiAgPC/QodGC0L7RgNC+0L3QuD4KPC/QldC70LXQutGC0YDQvtC90L3QuNC50JTQ vtC60YPQvNC10L3Rgj4=
Приклад запиту при відправці документа без створення чернетки
Приклад запиту в json форматі:
POST /api/eds/doc/create_and_send?doc_type=orders&gln=9864065702429 HTTP/1.1
Content-Type: multipart/form-data; boundary=-------------573cf973d5228
...else headers...
---------------573cf973d5228
Content-Disposition: form-data; name="file"; filename="file.json"
Content-Type: application/json
{Content of JSON file}
Приклад запиту в xml форматі:
POST /api/eds/doc/create_and_send?doc_type=orders&gln=9864065702429 HTTP/1.1
Content-Type: multipart/form-data; boundary=-------------573cf973d5228
...else headers...
---------------573cf973d5228
Content-Disposition: form-data; name="file"; filename="file.xml"
Content-Type: application/xml
{Content of XML file}
Приклад запиту в p7s форматі:
POST /api/eds/doc/create_and_send?doc_type=orders&gln=9864065702429 HTTP/1.1
Content-Type: multipart/form-data; boundary=-------------573cf973d5228
...else headers...
---------------573cf973d5228
Content-Disposition: form-data; name="file"; filename="file.p7s"
Content-Type: application/pkcs7-signature
{Content of P7S file}
Приклад запиту на створення документа-чернетки
JSON приклад
{
"NUMBER": "6422722fb78c4509b06eac43758e1545",
"DATE": "2019-02-15",
"TIME": "00:00",
"ORDERNUMBER": "6422722fb78c4509b06eac43758e1545",
"ORDERDATE": "2019-02-15",
"DELIVERYDATE": "2019-02-30",
"DELIVERYTIME": "10:00",
"CAMPAIGNNUMBER": "334455",
"CURRENCY": "UAH",
"LIMES": [],
"HEAD": [
{
"BUYER": "4820128010004",
"SUPPLIER": "9864065702429",
"DELIVERYPLACE": "4820128019007",
"INVOICEPARTNER": "4820128010004",
"SENDER": "4820128010004",
"RECIPIENT": "9864065702429",
"POSITION": [
{
"POSITIONNUMBER": "1",
"PRODUCT": "5029053540900",
"PRODUCTIDBUYER": "527209",
"DESCRIPTION": "пироженко",
"PRICE": 510,
"PRICEWITHVAT": 571.2,
"VAT": "12.00",
"AMOUNT": 0,
"AMOUNTWITHVAT": 0,
"ORDEREDQUANTITY": 64,
"ACCEPTEDQUANTITY": 64,
"PRODUCTTYPE": "1"
},
{
"POSITIONNUMBER": "2",
"PRODUCT": "5029053540924",
"PRODUCTIDBUYER": "527215",
"DESCRIPTION": "мороженко",
"PRICE": 510,
"PRICEWITHVAT": 571.2,
"VAT": "12.00",
"AMOUNT": 0,
"AMOUNTWITHVAT": 0,
"ORDEREDQUANTITY": 32,
"ACCEPTEDQUANTITY": 32,
"PRODUCTTYPE": "1"
},
{
"POSITIONNUMBER": "48",
"PRODUCT": "5029053543987",
"PRODUCTIDBUYER": "100307632",
"DESCRIPTION": "водочка",
"PRICE": 1751.6,
"PRICEWITHVAT": 1961.79,
"VAT": "12.00",
"AMOUNT": 0,
"AMOUNTWITHVAT": 0,
"ORDEREDQUANTITY": 12,
"ACCEPTEDQUANTITY": 12,
"PRODUCTTYPE": "1"
}
]
}
],
"ACTION": "29"
}
JSON приклад CONDRA
{
"DATE": "2021-03-02", // Дата документа в форматі YYYY-MM-DD, повинна співпадати з параметром doc_date
"HEAD": [
{
"TYPE": "1", // константа для тіла документа = 1
"SENDER": "9864000000417", // gln відправника
"SUPPLIER": "9864000000417", // gln відправника
"BUYER": "9864000000424", // gln отримувача
"RECIPIENT": "9864000000424", // gln отримувача
"TRANSGUID": "332a120d-6030-48af-bc8b-675f0c7f9823", // UUID транзакції (метод "Отримання UUID" або через Вашу облікову систему)
"DOCGUID": "082667cd-5cb0-4b0a-bae8-51d937f7fe86", // UUID запису (метод "Отримання UUID" або через Вашу облікову систему)
"CONTENT": [
{
"FILENAME": "reestr_nakl_factoring.xlsx" // повне ім'я файлу без дерикторії, але з розширенням.
}
]
}
],
"NUMBER": "api1", // Номер документа, повинен співпадати з doc_number
"DOCTYPE": 81 // тип документа, пока залишаємо константу = 81
}
JSON приклад TRANSPORTATIONORDER
{
"DATE": "2023-01-23",
"HEAD": [
{
"POSITION": [
{
"LOAD": {
"ADDRESS": {
"GLN": "9864065737759",
"NAME": "м. Київ",
"ADDRESS": "м. Київ, Street",
"ID": "UA80000000000093317"
},
"DATE": "2023-01-23 16:26",
"CONSIGNORCONTACTFACENAME": "reter",
"CONSIGNORCONTACTFACENUMBER": "380987968757",
"CONSIGNORCONTACTFACEID": "908989898908"
},
"UNLOAD": {
"CONSIGNEE": {
"GLN": "9864065747222",
"ID": "23787793",
"NAME": "Тестовий вантажоодержувач",
"ADDRESS": "м. Вінниця, Вінницький р-н, Вінницька, Перша, 5"
},
"ADDRESS": {
"GLN": "9864065747239",
"NAME": "м. Київ",
"ADDRESS": "м. Київ, Індустріальна, 55",
"ID": "UA80000000000093317"
},
"DATE": "2023-01-23 16:26"
},
"PACKAGEQUANTITY": "34",
"PACKAGEWEIGHT": "456",
"POSITIONNUMBER": "1"
}
],
"CUSTOMER": {
"GLN": "9864065737773",
"ID": "99997783",
"NAME": "EDI \"Sender\"",
"ADDRESS": "City, Street, 123"
},
"CONSIGNOR": {
"GLN": "9864065747208",
"ID": "19499025",
"NAME": "Тестовий вантажовідправник",
"ADDRESS": "м. Київ, вул.Жасмінова, 5, 312312"
},
"CARRIER": {
"GLN": "9864065747215",
"ID": "23787764",
"NAME": "Тестовий перевізник",
"ADDRESS": "м. Київ, Грушевського, 25, 49000"
}
}
],
"TRANSPORTATIONCOST": {
"WITHOUTVAT": "100500",
"VAT": 20
},
"SUBDOCTYPE": 1,
"NUMBER": "Zaya_001",
"TRANSPORTATIONTYPE": "7",
"TRANSPORTATIONPAYMENTTYPE": "1",
"PURCHASEORDERNUMBER": "так:)",
"DESCRIPTION": "Подарунки москалям"
}
Обʼєкти АРІ
Об’єкт ApplicableTransportSettingTemperature
Опис параметрів об’єкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
minimum |
O |
string |
Мінімальне значення температури |
|
maximum |
O |
string |
Максимальне значення температури |
[1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
-
Об’єкт ShippingMarks
Опис параметрів об’єкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
marking |
O |
string |
Назва транспортної упаковки (вільна назва), в якій перевозиться вантаж |
|
barcodeLogisticsLabel |
O |
об’єкт; Штрихкод товару |
[1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
-
Об’єкт TransportLogisticsPackage
Опис параметрів об’єкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
itemQuantity |
O |
decimal |
Кількість місць, які визначаються за кожним найменуванням вантажу (це можуть бути ящики, кошики, мішки тощо; якщо вантаж упаковано на піддонах - вказують кількість піддонів) |
|
typeCode |
O |
string |
Вид пакування (Довідник видів упаковок) |
|
type |
O |
string |
Одиниця виміру для ItemQuantity |
|
physicalLogisticsShippingMarks |
O |
об’єкт; Маркування |
[1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
-
Об’єкт ApplicableTransportDangerousGoods
Опис параметрів об’єкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
UNDGIdentificationCode |
O |
decimal |
Клас небезпечних речовин, до якого віднесено вантаж (у разі перевезення небезпечних вантажів). Код UNDG, 0 - якщо не використовується |
|
packagingDangerLevelCode |
O |
decimal |
Клас небезпечних речовин 1-4 |
[1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
-
Об’єкт Identification
Опис параметрів об’єкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
identification |
M |
string |
Найменування вантажу |
[1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
-
Об’єкт ApplicableNote
Опис параметрів об’єкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
contentCode |
O/M |
string |
Код:
|
|
content |
O |
decimal |
Значення |
[1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
-
Об’єкт AttachedSpecifiedBinaryFile
Опис параметрів об’єкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
id |
M |
string |
Ідентифікатор (guid) документа-підстави (ТТН / Акта); має відповідати document.id еТТН/Акта в ЦБД (значення ettnId з методу Отримання списку подій з ЦБД = значення external_doc_id Отримання метаданих документа) |
|
uriid |
O |
string |
Посилання на документ |
|
MIMECode |
O |
string |
Код MIME типізація |
|
SizeMeasure |
O |
Long |
Розмір файла |
[1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
-
Об’єкт DateTimeString
Опис параметрів об’єкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
dateTime |
M |
datetime (2021-12-13T14:19:23+02:00) |
Дата і час складання документа |
[1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
-
Об’єкт PostalTradeAddress
Опис параметрів об’єкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
postCode |
O |
string |
Індекс |
|
streetName |
M |
string |
Адреса (назва вулиці + номер будівлі) |
|
cityName |
M |
string |
Місто (назва населеного пункту) |
|
countryID |
M |
string |
Країна (UA) |
|
countrySubDivisionName |
O |
string |
Область та район (за наявності) |
[1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
-
Об’єкт ComunicationContact
Опис параметрів об’єкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
completeNumber |
O |
string |
Контактні дані |
[1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
-
Об’єкт TradeContact
Опис параметрів об’єкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
personName |
O |
string |
ПІБ |
|
telephoneUniversalCommunication |
O |
об’єкт; Основний телефон |
|
|
mobileTelephoneUniversalCommunication |
O |
об’єкт; Мобільний телефон |
|
|
emailURIUniversalCommunication |
O |
об’єкт; Електронна адреса |
[1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
-
Об’єкт PreviousAdministrativeReferencedDocument
Опис параметрів обʼєкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
typeCode |
O |
string |
Тип документа, на основі якого складено поточний документ. Довідник кодів документів |
|
id |
M |
string |
Відповідає ExchangedDocumentContext.SpecifiedTransactionID попередніх версій |
|
remarks |
O |
string |
Base64 документа попередньої версії |
|
formattedIssueDateTime |
O |
об’єкт; Дата складання документа, на основі якого складено поточний документ |
|
|
attachedSpecifiedBinaryFile |
M/O |
об’єкт; Дані документа до якого складається поточний документ. Обов’язковий при створенні Акта |
[1] - під визначенням колонки Тип мається на увазі скорочене позначення:
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
Об’єкт PhysicalGeographicalCoordinate
Опис параметрів обʼєкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
latitudeMeasure |
O |
string |
Широта |
|
longitudeMeasure |
O |
string |
Довгота |
|
systemId |
M |
GLN |
[1] - під визначенням колонки Тип мається на увазі скорочене позначення:
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
Об’єкт EntityId
Опис параметрів обʼєкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
schemeAgencyID |
O/M |
string |
ідентифікатор; приймає значення УКТЗЕД/ЄДРПОУ/РНОКПП/КАТОТТГ/GLN залежно від блоку, де застосовується - точніше вказано в параметрі на рівень вище |
|
value |
M |
decimal |
Значення |
[1] - під визначенням колонки Тип мається на увазі скорочене позначення:
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
Об’єкт ContentCode
Опис параметрів обʼєкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
listAgencyID |
M для GLN (решта O) |
String |
Ідентифікатор:
Ідентифікатори logistic_unit_number_with_logger / gps_number / logger_number / reserve_number вказуються контрагентом з роллю «Вантажовідправник». Ідентифікатори transportation_max_temperature та logger_return вказуються контрагентом з роллю «Вантажоодержувач». Ідентифікатор comments може вказуватись усіма учасниками документообігу на етапі формування Чернетки ТТН-документа (для Водія/Перевізника це sub_status_id=1; для Вантажоодержувача / Експедитора (+ Водія/Перевізника в рамках опційного підписання) це sub_status_id=6) |
|
value |
M |
|
значення ідентифікатора |
[1] - під визначенням колонки Тип мається на увазі скорочене позначення:
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
Об'єкт IncludedNote
Опис параметрів обʼєкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
contentCode |
M |
об’єкт; Контент запису |
|
|
content |
M |
String |
Код ролі учасника. Довідник ролей
|
[1] - під визначенням колонки Тип мається на увазі скорочене позначення:
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
Об’єкт Partner (дані контрагентів)
Опис параметрів об’єкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
id |
O |
int(10) |
id контрагента |
|
employeeId |
O |
int(10) |
id співробітника, що виконує дію |
|
companyId |
O |
int(10) |
id компанії |
|
serviceId |
O |
tinyint(3) |
id сервісу; доступні значення: 9 - Вільний |
|
|
M |
String(255) |
email контрагента |
|
name |
O |
String(255) |
ПІБ контрагента |
|
companyName |
O |
String(255) |
назва компанії контрагента |
|
companyCode |
O |
String(12) |
код ЄДРПОУ / ІПН компанії |
|
inviteStatus |
O |
tinyint(10) |
статус запрошення; 0 - не запрошений, 1 - запрошений |
|
inviteDate |
O |
int(10) |
дата запрошення (unix-timestamp) |
|
isRegistered |
O |
boolean |
статус реєстрації: true - зареєстрований; false - незареєстрований |
JSON приклад об'єкта
{
"id":239,
"serviceId": 9,
"email": "kit@pes.ua",
"name": "Cat",
"companyName": "Dog",
"companyCode": "666666663"
}JSON приклад масиву об'єктів
[
{
"serviceId": 9,
"email": "example@mail.com",
"name": "",
"companyName": "",
"companyCode": ""
},
{
"serviceId": 9,
"email": "stethem@ukr.mem",
"name": "Джейсон Стетхем",
"companyName": "Повар",
"companyCode": "858585888585"
},
{
"serviceId": 9,
"email": "ozk82086@eoopy.com",
"name": "",
"companyName": "",
"companyCode": ""
}
]JSON приклад відповіді. Завантажені в сервіс контрагенти та контрагенти з помилковими даними (потребують правок)
{
"createdPartners": [
{
"id": 237,
"employeeId": 1035,
"companyId": 0,
"email": "hopa@mail.com",
"inviteStatus": 0,
"inviteDate": 0,
"serviceId": 9,
"isRegistered": false
},
{
"id": 238,
"employeeId": 1035,
"companyId": 0,
"email": "parmezano@pam.ua",
"inviteStatus": 0,
"inviteDate": 0,
"serviceId": 9,
"isRegistered": false
}
],
"errorPartners": [
{
"id": 0,
"employeeId": 1035,
"companyId": 0,
"email": "stethem@ukr.mem",
"name": "Джейсон Стетхем",
"companyName": "Повар",
"companyCode": "858585888585",
"inviteStatus": 0,
"inviteDate": 0,
"serviceId": 9,
"isRegistered": false
},
{
"id": 0,
"employeeId": 1035,
"companyId": 0,
"email": "ozk82086@eoopy.com",
"inviteStatus": 0,
"inviteDate": 0,
"serviceId": 9,
"isRegistered": false
}
]
}де
createdPartners - масив об’єктів Partner (дані контрагентів), що були завантажені в сервіс;
errorPartners - масив об’єктів Partner (дані контрагентів), що містять помилки і потребують правок (не завантажились).
Метадані документа
Опис параметрів
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
receivers |
M |
List<String> |
масив з UUID-ами отримувачів документа; для незареєстрованих на платформі користувачів передаються email адреси |
|
number |
O |
String |
номер документа |
|
date |
O |
String |
дата документа |
|
sum |
O |
String |
Сума (грн) |
|
text |
O |
String |
текст повідомлення |
|
title |
M |
String |
тема документа |
|
recipientEDRPOU |
O |
String |
ЄДРПОУ отримувача. Якщо поле заповнено, то сервіс «Вільний» буде перевіряти отримувача на етапі підписання документа (вказане значення ЄДРПОУ та ЄДРПОУ ключа ЕЦП підписанта повинні співпадати). В разі невідповідності значення під час підписання буде виникати помилка. |
|
senderEDRPOU |
O |
String |
ЄДРПОУ відправника. Якщо поле заповнено, то сервіс «Вільний» буде перевіряти відправника на етапі підписання документа (вказане значення ЄДРПОУ та ЄДРПОУ ключа ЕЦП підписанта повинні співпадати). В разі невідповідності значення під час підписання буде виникати помилка. |
|
googleFileName |
O |
String |
назва документа на Google Диску (відправка документа через віджет «EDIN еПідпис») |
|
handleDocumentRule |
M |
int |
код правила обробки документа отримувачами:
|
|
dateUpdate |
O |
long |
дата оновлення (unix timestamp) |
- [1] - Під визначенням колонки Тип поля мається на увазі скорочене позначення:
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
JSON приклад
{
"receivers": [
"85e32f82-9d86-4c36-8b3f-54eccf13b09c"
],
"date": "2022-08-02",
"title": "SomeSome",
"googleFileName": "SomeSome.pdf",
"handleDocumentRule": 2,
"dateUpdate": 1659454506,
"recipientEDRPOU": "12345678",
"senderEDRPOU": "12345678",
"number": "Number",
"sum": "50.26",
"text": "Message"
}
Об’єкт ParticipantGroup
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
groupId |
long |
ідентифікатор групи учасників |
|
companyId |
long |
ідентифікатор компанії, якій належить група |
|
groupName |
String(255) |
назва групи учасників |
|
comment |
String |
коментар |
|
companies |
List<Company> |
масив об’єктів; компанії в групі учасників |
|
cpvs |
List<Category> |
масив об’єктів; категорії групи учасників |
JSON приклад відповіді (дані груп учасників)
[
{
"groupId": 273,
"companyId": 3600,
"groupName": "Постачальники молока",
"companies": [
{
"id": 11,
"uuid": "e29a089f-3402-44a2-997b-4a263a82ab12",
"accountID": 0,
"name": "ТОВ \"ПРОДМАРКЕТПРОМ\"",
"edrpou": "36863714",
"inn": "368637106262",
"city": "м. Київ",
"address": "вул. Академіка Філатова, б.10-А, оф.2/51"
},
{
"id": 13,
"uuid": "14f91301-fb11-4361-b76b-6e4f495f3055",
"accountID": 0,
"name": "ТОВ \"КОМПАНІЯ \"УКРАВТОЛОГІСТИКА\"",
"edrpou": "39427556",
"inn": "394275515510",
"city": "м. Одеса",
"address": "вул. Академіка Вільямса, буд.86"
},
{
"id": 17,
"uuid": "5736889e-eed5-4894-a866-1ba2129b8d85",
"accountID": 37035,
"name": "ПП \"ПАТМОС\"",
"edrpou": "40756025",
"inn": "407560219187",
"city": "Тернопільська обл., Бережанський район, село Котів",
"address": "вул. Тиха, будинок 1"
}
],
"cpvs": [
{
"id": 9543,
"section": "99",
"group": "9",
"categoryClass": "9",
"category": "9",
"detailing": "017",
"check_sum": "9",
"full_code": "99999017-9",
"description_ua": "Молочні продукти",
"description_en": "Dairy",
"rank": 1,
"refId": 9458,
"hasChildren": 0,
"status": 1,
"isSubscribes": false
}
]
},
{
"groupId": 275,
"companyId": 3600,
"groupName": "Постачальники зоотоварів",
"companies": [
{
"id": 19,
"uuid": "392d3548-e286-4593-96cb-6a3a361085c6",
"accountID": 1232,
"name": "ФОП Мріщук Олександр Петрович",
"edrpou": "1969710734",
"inn": "1969710734",
"city": "м. Вінниця",
"address": "Ленінський район вул. Вишенька, буд. 13"
},
{
"id": 21,
"uuid": "94fc5670-e97f-4b25-b2cb-ca532acc4fe8",
"accountID": 1232,
"name": "ТОВ «ФАКТОР»",
"edrpou": "13731254",
"inn": "137312510086",
"city": "м. Вишгород",
"address": "вул. Кургузова 6А"
}
],
"cpvs": [
{
"id": 9511,
"section": "99",
"group": "9",
"categoryClass": "9",
"category": "9",
"detailing": "001",
"check_sum": "9",
"full_code": "99999001-9",
"description_ua": "Зоотовари",
"description_en": "Pet supplies",
"rank": 1,
"refId": 9458,
"hasChildren": 0,
"status": 1,
"isSubscribes": false
},
{
"id": 9597,
"section": "99",
"group": "9",
"categoryClass": "9",
"category": "9",
"detailing": "044",
"check_sum": "9",
"full_code": "99999044-9",
"description_ua": "Послуги",
"description_en": "Services",
"rank": 1,
"refId": 9458,
"hasChildren": 0,
"status": 1,
"isSubscribes": false
}
]
},
{
"groupId": 279,
"companyId": 3600,
"groupName": "Визволителі України",
"comment": "тут будуть всі важливі для ниньошньої ситуації компанії - вони будуть в пріоритеті",
"companies": [
{
"id": 447,
"uuid": "0e4eca5a-b60d-4e18-b87c-05173ce5dfac",
"accountID": 11158,
"name": "СУБЛАНД УКРАЇНА",
"edrpou": "37212319",
"inn": "372123104628"
}
],
"cpvs": [
{
"id": 9555,
"section": "99",
"group": "9",
"categoryClass": "9",
"category": "9",
"detailing": "023",
"check_sum": "9",
"full_code": "99999023-9",
"description_ua": "Ковбасні вироби",
"description_en": "Sausages",
"rank": 1,
"refId": 9458,
"hasChildren": 0,
"status": 1,
"isSubscribes": false
},
{
"id": 9567,
"section": "99",
"group": "9",
"categoryClass": "9",
"category": "9",
"detailing": "029",
"check_sum": "9",
"full_code": "99999029-9",
"description_ua": "Табачні вироби",
"description_en": "Tobacco products",
"rank": 1,
"refId": 9458,
"hasChildren": 0,
"status": 1,
"isSubscribes": false
}
]
},
{
"groupId": 291,
"companyId": 3600,
"groupName": "Fatality",
"comment": "opa-opa",
"companies": [
{
"id": 5,
"uuid": "a32715ba-b7cb-4702-ae77-e8f6c3aaeb89",
"accountID": 24373,
"name": "тест ЕДІН",
"edrpou": "67553455",
"inn": "1010101016",
"city": "Kiev",
"address": "Mostobudivnykiv St, 17/11"
}
],
"cpvs": [
{
"id": 9525,
"section": "99",
"group": "9",
"categoryClass": "9",
"category": "9",
"detailing": "008",
"check_sum": "9",
"full_code": "99999008-9",
"description_ua": "Проектні роботи",
"description_en": "Design work",
"rank": 1,
"refId": 9458,
"hasChildren": 0,
"status": 1,
"isSubscribes": false
}
]
}
]JSON приклад запиту (дані групи учасників)
{
"companyId": 3600,
"groupName": "Fatality",
"comment": "hello",
"companies": [
{
"id": 5
},
{
"id": 9
}
],
"cpvs": [
{
"id": 9513
},
{
"id": 9519
},
{
"id": 9525
}
]
}
Об’єкт Access (дані запиту на участь в закритому аукціоні)
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
id |
long |
ідентифікатор доступа |
|
auctionId |
long |
ідентифікатор аукціону (тендера) |
|
auction |
об’єкт; дані аукціону (тендера) |
|
|
userId |
long |
ідентифікатор користувача |
|
user |
об’єкт; дані користувача |
|
|
companyId |
long |
ідентифікатор компанії |
|
company |
об’єкт; дані компанії |
|
|
dateCreated |
long |
дата створення |
|
message |
String |
коментар заявки на аукціон (тендер) |
|
status |
об’єкт; статус заявки на аукціон (тендер) |
|
|
contactName |
String(250) |
контактна особа (ПІБ) |
|
contactEmail |
String(250) |
контактний email |
|
contactPhone |
String(50) |
контактний телефон |
|
accessLog |
List<AccessLog> |
масив об’єктів; перебіг (лог) отримання доступу до аукціону (тендера) |
JSON приклад
{
"id": 3069,
"auctionId": 5799,
"userId": 50206653,
"user":
{
"id": 50206653,
"employeeId": 1056,
"accountId": 32657,
"account":
{
"id": 32657,
"name": "Test_EDS3",
"edrpou": "300000003",
"inn": "3030303030",
"status":
{
"code": 1,
"description": "Активный"
},
"emails":
[
"test@qw.we"
],
"phone": "134567890987",
"legalAddress": "#",
"dateCreate": 1572349280,
"dateChange": 1601881494
},
"login": "uaFelExSender",
"role":
{
"code": 1,
"description": "Пользователь"
},
"name": "Boris",
"surname": "Djonsonuk",
"dateLastLogin": 1681821485,
"emails":
[
"test@qw.we",
"storchevayas@edin.ua"
],
"isSubscribes": false
},
"companyId": 3627,
"company":
{
"id": 3627,
"uuid": "f96a5cb6-935b-4940-8c47-ff3f96aa300d",
"accountID": 32657,
"name": "Bimba Inc",
"edrpou": "1488883523",
"inn": "1488883523",
"city": "rrrrr",
"address": "323r23r"
},
"dateCreated": 1681821985,
"message": "password-baracuda",
"status":
{
"code": 2,
"description": "Запрос доступа (не принято решение)"
},
"contactName": "Djonsonuk Boris ",
"contactEmail": "test@qw.we",
"contactPhone": "380684856254"
}
Об’єкт AuctionView (дані про перегляди тендера)
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
id |
long |
ідентифіктор перегляду |
|
auctionId |
long |
ідентифіктор тендера, що переглядався |
|
viewerId |
long |
ідентифіктор користувача, що переглядав тендер |
|
viewer |
об’єкт; дані користувача |
|
|
dateTime |
long |
дата і час перегляду (у форматі Unix timestamp) |
JSON приклад
[
{
"id": 4007,
"auctionId": 4607,
"viewerId": 60212904,
"viewer": {
"id": 60212904,
"employeeId": 1035,
"accountId": 36633,
"account": {
"id": 36633,
"name": "Общество с ограниченной ответственностью \"Скай'нет-56\"",
"edrpou": "89456891",
"inn": "123652632563",
"status": {
"code": 1,
"description": "Активный"
},
"emails": [
"12356@ukr.net"
],
"phone": "355478563",
"legalAddress": "ююю",
"dateCreate": 1598894147,
"dateChange": 1638282398,
"about": "строительство и логистика ",
"logo": "/api/logo/accounts/logo_36633.jpg"
},
"login": "willnotgotomumbai@gmail.com",
"role": {
"code": 1,
"description": "Пользователь"
},
"name": "Арбуз",
"surname": "Арбузов",
"secondName": "Иоанович ",
"phone": "380975560011",
"ipn": "111111111111",
"dateLastLogin": 1654519973,
"info": "self registered. IP: null",
"emails": [
"willnotgotomumbai@gmail.com"
],
"companies": [
{
"id": 3600,
"uuid": "c345ef8f-ba02-439a-afac-007ed088cf2e",
"accountID": 36633,
"name": "Общество с ограниченной ответственностью \"Скай'нет-56\"",
"edrpou": "89456891",
"inn": "125632589223",
"city": "Kiev"
},
{
"id": 3624,
"uuid": "164d8465-aad6-409d-b3a8-5b009e1ca542",
"accountID": 36633,
"name": "Общество с ограниченной ответственностью \"Институт инновационных технологий и строения космических ",
"edrpou": "6465656666",
"inn": "6465656666",
"city": "Львов",
"address": "Волкова"
},
{
"id": 4248,
"uuid": "8520b4ee-c799-461e-9b14-e129dcfef27d",
"accountID": 36633,
"name": "ТОВ \"Отправитель товар",
"edrpou": "643555552",
"inn": "643555552"
},
{
"id": 4408,
"uuid": "cf5def31-8849-4a30-b1fa-0bf3e1d39423",
"accountID": 36633,
"name": "апвапвапв",
"edrpou": "2563256222",
"inn": "2563256222"
}
],
"isSubscribes": false
},
"dateTime": 1654520720
},
{
"id": 3993,
"auctionId": 4607,
"viewerId": 60213504,
"viewer": {
"id": 60213504,
"employeeId": 1841,
"accountId": 36974,
"account": {
"id": 36974,
"name": "ТОВ Фомыч",
"edrpou": "FG258046",
"inn": "FG258046",
"status": {
"code": 1,
"description": "Активный"
},
"emails": [
"kutsenkov@edin.ua"
],
"phone": "325954845956",
"legalAddress": "Киев, ул. Дегляревская 46",
"dateCreate": 1623405150,
"dateChange": 0
},
"login": "kutsenkov@edin.ua",
"role": {
"code": 1,
"description": "Пользователь"
},
"name": "Ингибора",
"surname": "Куц",
"phone": "380123456789",
"ipn": "123654456123",
"dateLastLogin": 1654273155,
"info": "self registered. IP: null",
"emails": [
"kutsenkov@edin.ua"
],
"companies": [
{
"id": 3969,
"uuid": "e0ca4d6f-5572-4749-878b-2863a1e5e0c2",
"accountID": 36974,
"name": "ТОВ Фомич В.І.",
"edrpou": "FG258046",
"inn": "FG258046"
},
{
"id": 4233,
"uuid": "997234e1-ae18-4697-b117-e426b30bc5fa",
"accountID": 36974,
"name": "ТОВ Фома",
"edrpou": "653265666",
"inn": "653265666"
},
{
"id": 6933,
"uuid": "afee3e98-609a-4f29-8e46-2dab8d2c7443",
"accountID": 36974,
"name": "ФІЗ лице",
"edrpou": "569874566",
"inn": "569874566",
"city": "Київ",
"address": "вул.Хрещатик 1"
}
],
"isSubscribes": false
},
"dateTime": 1654273506
}
]
Об'єкт AccessLog
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
id |
long |
ідентифікатор запису |
|
userId |
long |
ідентифікатор користувача |
|
date |
long |
дата логування |
|
message |
String |
повідомлення/коментар |
Об'єкт CompanyAccessRequestStatus
Опис параметрів об’єкта
Об’єкт AuctionContacts
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
auctionId |
long |
id тендера |
|
contactName |
String |
ПІБ контактної особи |
|
contactEmail |
String |
email контактної особи |
|
contactPhone |
String |
номер телефону контактної особи |
Об’єкт Region
Опис параметрів об’єкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
id |
M |
long |
id регіону |
|
code |
String |
код регіону |
|
|
name |
String |
назва регіону |
- [1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
JSON приклад відповіді для отримання довідника регіонів
[ { "id": 1, "code": "01", "name": "Автономна Республіка Крим" }, { "id": 2, "code": "05", "name": "Вінницька область" }, { "id": 3, "code": "07", "name": "Волинська область" }, { "id": 4, "code": "12", "name": "Дніпропетровська область" }, { "id": 5, "code": "14", "name": "Донецька область" }, { "id": 6, "code": "18", "name": "Житомирська область" }, { "id": 7, "code": "21", "name": "Закарпатська область" }, { "id": 8, "code": "23", "name": "Запорізька область" }, { "id": 9, "code": "26", "name": "Івано-Франківська область" }, { "id": 10, "code": "32", "name": "Київська область" }, { "id": 11, "code": "35", "name": "Кіровоградська область" }, { "id": 12, "code": "44", "name": "Луганська область" }, { "id": 13, "code": "46", "name": "Львівська область" }, { "id": 14, "code": "48", "name": "Миколаївська область" }, { "id": 15, "code": "51", "name": "Одеська область" }, { "id": 16, "code": "53", "name": "Полтавська область" }, { "id": 17, "code": "56", "name": "Рівненська область" }, { "id": 18, "code": "59", "name": "Сумська область" }, { "id": 19, "code": "61", "name": "Тернопільська область" }, { "id": 20, "code": "63", "name": "Харківська область" }, { "id": 21, "code": "65", "name": "Херсонська область" }, { "id": 22, "code": "68", "name": "Хмельницька область" }, { "id": 23, "code": "71", "name": "Хмельницька область" }, { "id": 24, "code": "73", "name": "Чернівецька область" }, { "id": 25, "code": "74", "name": "Чернігівська область" }, { "id": 26, "code": "80", "name": "м. Київ " }, { "id": 27, "code": "85", "name": "м. Севастополь" } ] -
Об’єкт Attachment (для сервісу Тендер)
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
id |
long |
id вкладення |
|
auctionId |
long |
id тендера |
|
lotId |
long |
id лоту |
|
betId |
long |
id ставки |
|
userId |
long |
id користувача |
|
user |
об’єкт; дані користувача |
|
|
fileName |
String |
назва файлу |
|
description |
String |
опис |
|
body |
byte[] |
зміст тіла файлу в цілочисельному вигляді |
|
size |
long |
розмір вкладення |
JSON приклад
{
"id": 1673,
"auctionId": 5245,
"lotId": 0,
"betId": 0,
"userId": 0,
"user": {
"id": 60212904,
"employeeId": 1035,
"accountId": 36633,
"account": {
"id": 36633,
"name": "Товариство з обмеженою відповідальнстю \"Скай'нет-56\"",
"edrpou": "89456891",
"inn": "123652632563",
"status": {
"code": 1,
"description": "Активный"
},
"emails": [
"12356@ukr.net"
],
"phone": "355478563",
"legalAddress": "ююю",
"dateCreate": 1598894147,
"dateChange": 1638282398,
"about": "будівництво та логістика ",
"logo": "/api/logo/accounts/logo_36633.jpg"
},
"login": "willnotgotomumbai@gmail.com",
"role": {
"code": 1,
"description": "Пользователь"
},
"name": "Арбуз",
"surname": "Арбузов",
"secondName": "Іоанович ",
"phone": "380975560011",
"ipn": "111111111111",
"dateLastLogin": 1659344038,
"info": "self registered. IP: null",
"emails": [
"willnotgotomumbai@gmail.com"
],
"isSubscribes": false
},
"fileName": "espec03.png",
"size": 142777
}Об’єкт Unit
Опис параметрів об’єкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
id |
M |
long |
id одиниці виміру |
|
code |
String |
код одиниці виміру |
|
|
name |
String |
назва одиниці виміру |
|
|
shortName |
String |
коротка назва одиниці виміру |
- [1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
JSON приклад відповіді для отримання довідника одиниць виміру
[
{
"id": 1,
"code": "2009",
"name": "штука",
"shortName": "шт"
},
{
"id": 2,
"code": "301",
"name": "кілограм",
"shortName": "кг"
},
{
"id": 3,
"code": "303",
"name": "грам",
"shortName": "г"
},
{
"id": 4,
"code": "2938",
"name": "комплект",
"shortName": "компл"
},
{
"id": 5,
"code": "138",
"name": "літр",
"shortName": "л"
},
{
"id": 6,
"code": "101",
"name": "метр",
"shortName": "м"
},
{
"id": 7,
"code": "123",
"name": "квадратний метр",
"shortName": "м2"
},
{
"id": 8,
"code": "134",
"name": "кубічний метр",
"shortName": "м3"
},
{
"id": 9,
"code": "144",
"name": "мілілітр",
"shortName": "мл"
},
{
"id": 10,
"code": "2424",
"name": "робоча година",
"shortName": "роб.год"
},
{
"id": 11,
"code": "2006",
"name": "партія",
"shortName": "партія"
},
{
"id": 12,
"code": "2116",
"name": "рулон",
"shortName": "рул"
},
{
"id": 13,
"code": "306",
"name": "тонна",
"shortName": "т"
},
{
"id": 14,
"code": "2013",
"name": "тисяча штук",
"shortName": "тис.шт."
},
{
"id": 15,
"code": "2110",
"name": "пакунок",
"shortName": "пак"
},
{
"id": 16,
"code": "0000",
"name": "послуга",
"shortName": "послуга"
},
{
"id": 17,
"code": "2075",
"name": "ящик",
"shortName": "ящ"
}
]
Об’єкт Currency
Опис параметрів об’єкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
id |
M |
long |
id валюти |
|
code |
String |
код валюти |
|
|
name |
String |
назва валюти |
- [1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
JSON приклад відповіді для отримання довідника валют
[ { "id": 1, "code": "UAH", "name": "Українська гривня" }, { "id": 2, "code": "USD", "name": "Долар США" }, { "id": 3, "code": "EUR", "name": "Євро" }, { "id": 4, "code": "GBP", "name": "Фунт стерлінгів Великобританії" }, { "id": 5, "code": "CNY", "name": "Китайський юань женьмiньбi" }, { "id": 6, "code": "CHF", "name": "Швейцарський франк" } ] -
Об’єкт Lot
Опис параметрів об’єкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
id |
long |
id лота |
|
|
auctionId |
long |
id тендера |
|
|
auction |
O |
об’єкт; дані тендера |
|
|
title |
M |
String |
заголовок лота |
|
description |
M |
String |
опис лота |
|
expectedValue |
M |
double |
стартова ціна |
|
stepValue |
M |
double |
крок ставки |
|
currencyId |
long |
id валюти |
|
|
currency |
M |
об’єкт; дані про валюту |
|
|
quantity |
M |
double |
кількість |
|
unitId |
long |
id одиниці виміру |
|
|
unit |
M |
об’єкт; одиниці виміру |
|
|
deliveryStartDate |
O |
long |
дата початку доставки |
|
deliveryEndDate |
O |
long |
дата закінчення доставки |
|
productCode |
O |
String |
код товару |
|
categoryId |
long |
id категорії товару (з довідника CPV) |
|
|
category |
M |
об’єкт; дані категорії товару (з довідника CPV) |
|
|
regionId |
long |
id області |
|
|
region |
M |
об’єкт; дані областей |
|
|
noShowBets |
O |
boolean |
відмітка: Не показувати ставки |
|
noShowBestBet |
O |
boolean |
відмітка: Не показувати кращу ставку |
|
hideParticipantNamesOnly |
O |
boolean |
відмітка: Ховати лише імена учасників |
|
betsCount |
Integer |
кількість ставок |
|
|
bestBet |
об’єкт; краща ставка |
||
|
bets |
List<Bet> |
масив об’єктів; список ставок |
|
|
attachmentsCount |
int |
кількість вкладень |
|
|
attachments |
O |
List<Attachment> |
масив об’єктів; вкладення |
- [1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
Об’єкт OfferType
Опис параметрів об’єкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
code |
int |
код;
|
|
|
name |
String |
назва |
|
|
description |
String |
опис |
- [1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
Об’єкт Type
Опис параметрів об’єкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
code |
M |
int |
код;
|
|
name |
String |
назва |
|
|
description |
String |
опис |
- [1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
Об’єкт AccessType (для сервісу Тендер)
Опис параметрів об’єкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
code |
M |
int |
код;
|
|
name |
String |
назва |
|
|
description |
String |
опис |
- [1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
Об’єкт Status (для сервісу Тендер)
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
code |
int |
код; для аукціону (тендера):
для заявки на аукціон (тендер):
|
|
name |
String |
назва |
|
description |
String |
опис |
Об’єкт Category
Опис параметрів об’єкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
id |
M |
long |
ідентифікатор категорії |
|
section |
String |
розділ; перші 2 цифри визначають розділ. 1 рівень (XX000000-Y) |
|
|
group |
String |
група; перші 3 цифри визначають групу. 2 рівень (XXX00000-Y) |
|
|
categoryClass |
String |
клас; перші 4 цифри визначають клас. 3 рівень (XXXX0000-Y) |
|
|
category |
String |
категорія; перші 5 цифр визначають категорію. 4 рівень (XXXXX000-Y) |
|
|
detailing |
String |
деталізація; останні 3 цифри - деталізація в рамках категорії. 5 рівень (XXXXX000-Y) |
|
|
check_sum |
String |
контрольна сума номера (XXXXX000-Y) |
|
|
full_code |
String |
повний код з довідника (XXXXX000-Y) |
|
|
description_ua |
String |
назва українською |
|
|
description_en |
String |
назва англійською |
|
|
rank |
int |
рівень вкладення |
|
|
refId |
long |
посилання на материнський запис |
|
|
hasChildren |
int |
наявність дочірніх значень довідника. 0-ні, 1-так |
|
|
status |
int |
статус; 1-active, 2-not_active |
|
|
isSubscribes |
boolean |
підписка |
- [1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
JSON приклад відповіді для отримання довідника категорій
[ { "id": 9473, "section": "09", "group": "0", "categoryClass": "0", "category": "0", "detailing": "008", "check_sum": "3", "full_code": "09000008-3", "description_ua": "Проектні роботи", "description_en": "Design work", "rank": 1, "refId": 9458, "hasChildren": 0, "status": 1, "isSubscribes": false }, { "id": 9475, "section": "09", "group": "0", "categoryClass": "0", "category": "0", "detailing": "009", "check_sum": "3", "full_code": "09000009-3", "description_ua": "Меблі", "description_en": "Furniture", "rank": 1, "refId": 9458, "hasChildren": 0, "status": 1, "isSubscribes": false }, { "id": 9477, "section": "09", "group": "0", "categoryClass": "0", "category": "0", "detailing": "010", "check_sum": "3", "full_code": "09000010-3", "description_ua": "Автомобілі та запчастини", "description_en": "Cars and spare parts", "rank": 1, "refId": 9458, "hasChildren": 0, "status": 1, "isSubscribes": false }, { "id": 9479, "section": "09", "group": "0", "categoryClass": "0", "category": "0", "detailing": "011", "check_sum": "3", "full_code": "09000011-3", "description_ua": "Фрукти, ягоди", "description_en": "Fruits, berries", "rank": 1, "refId": 9458, "hasChildren": 0, "status": 1, "isSubscribes": false }, { "id": 9481, "section": "09", "group": "0", "categoryClass": "0", "category": "0", "detailing": "012", "check_sum": "3", "full_code": "09000012-3", "description_ua": "Консервовані продукти", "description_en": "Canned foods", "rank": 1, "refId": 9458, "hasChildren": 0, "status": 1, "isSubscribes": false }, { "id": 9483, "section": "09", "group": "0", "categoryClass": "0", "category": "0", "detailing": "013", "check_sum": "3", "full_code": "09000013-3", "description_ua": "Риба та морепродукти", "description_en": "Fish and seafood", "rank": 1, "refId": 9458, "hasChildren": 0, "status": 1, "isSubscribes": false }, { "id": 9485, "section": "09", "group": "0", "categoryClass": "0", "category": "0", "detailing": "014", "check_sum": "3", "full_code": "09000014-3", "description_ua": "Кондитерські вироби, солодощі", "description_en": "Confectionery, sweets", "rank": 1, "refId": 9458, "hasChildren": 0, "status": 1, "isSubscribes": false }, { "id": 9487, "section": "09", "group": "0", "categoryClass": "0", "category": "0", "detailing": "015", "check_sum": "3", "full_code": "09000015-3", "description_ua": "Напої", "description_en": "Beverages", "rank": 1, "refId": 9458, "hasChildren": 0, "status": 1, "isSubscribes": false }, { "id": 9489, "section": "09", "group": "0", "categoryClass": "0", "category": "0", "detailing": "016", "check_sum": "3", "full_code": "09000016-3", "description_ua": "Дитяче харчування", "description_en": "Baby food", "rank": 1, "refId": 9458, "hasChildren": 0, "status": 1, "isSubscribes": false }, { "id": 9491, "section": "09", "group": "0", "categoryClass": "0", "category": "0", "detailing": "017", "check_sum": "3", "full_code": "09000017-3", "description_ua": "Молочні продукти", "description_en": "Dairy", "rank": 1, "refId": 9458, "hasChildren": 0, "status": 1, "isSubscribes": false }, { "id": 9493, "section": "09", "group": "0", "categoryClass": "0", "category": "0", "detailing": "018", "check_sum": "3", "full_code": "09000018-3", "description_ua": "Хлібобулочні вироби", "description_en": "Bakery products", "rank": 1, "refId": 9458, "hasChildren": 0, "status": 1, "isSubscribes": false }, { "id": 9495, "section": "09", "group": "0", "categoryClass": "0", "category": "0", "detailing": "019", "check_sum": "3", "full_code": "09000019-3", "description_ua": "Снеки, насіння, горіхи, сухофрукти", "description_en": "Snacks, seeds, nuts, dried fruits", "rank": 1, "refId": 9458, "hasChildren": 0, "status": 1, "isSubscribes": false }, { "id": 9497, "section": "09", "group": "0", "categoryClass": "0", "category": "0", "detailing": "020", "check_sum": "3", "full_code": "09000020-3", "description_ua": "Заморожені продукти", "description_en": "Frozen products", "rank": 1, "refId": 9458, "hasChildren": 0, "status": 1, "isSubscribes": false }, { "id": 9499, "section": "09", "group": "0", "categoryClass": "0", "category": "0", "detailing": "021", "check_sum": "3", "full_code": "09000021-3", "description_ua": "Овочі, гриби, зелень", "description_en": "Vegetables, mushrooms, greens", "rank": 1, "refId": 9458, "hasChildren": 0, "status": 1, "isSubscribes": false }, { "id": 9501, "section": "09", "group": "0", "categoryClass": "0", "category": "0", "detailing": "022", "check_sum": "3", "full_code": "09000022-3", "description_ua": "М'ясо, птиця, яйце", "description_en": "Meat, bird, egg", "rank": 1, "refId": 9458, "hasChildren": 0, "status": 1, "isSubscribes": false }, { "id": 9503, "section": "09", "group": "0", "categoryClass": "0", "category": "0", "detailing": "023", "check_sum": "3", "full_code": "09000023-3", "description_ua": "Ковбасні вироби", "description_en": "Sausages", "rank": 1, "refId": 9458, "hasChildren": 0, "status": 1, "isSubscribes": false }, { "id": 9505, "section": "09", "group": "0", "categoryClass": "0", "category": "0", "detailing": "024", "check_sum": "3", "full_code": "09000024-3", "description_ua": "Цукор", "description_en": "Sugar", "rank": 1, "refId": 9458, "hasChildren": 0, "status": 1, "isSubscribes": false }, { "id": 9507, "section": "09", "group": "0", "categoryClass": "0", "category": "0", "detailing": "025", "check_sum": "3", "full_code": "09000025-3", "description_ua": "Крупи, борошно, макаронні вироби", "description_en": "Cereals, flour, pasta", "rank": 1, "refId": 9458, "hasChildren": 0, "status": 1, "isSubscribes": false }, ] -
Об’єкт SubscribeToCategory
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
categoryId |
long |
ідентифікатор категорії |
|
category |
об’єкт; дані категорії |
|
|
type |
int |
тип аукціону:
|
Об’єкт Subscribes
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
categories |
List<SubscribeToCategory> |
масив об’єктів; категорії |
|
companies |
List<Company> |
масив об’єктів; компанії |
|
users |
List<User> |
масив об’єктів; користувачі-організатори |
Об’єкт Role
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
code |
int |
код ролі;
|
|
description |
String |
опис ролі |
Об’єкт StatusAcc
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
code |
int |
код;
|
|
description |
String |
опис |
Об’єкт Account (для сервісу Тендер)
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
id |
long |
id аккаунту |
|
name |
String |
повна назва організації або ПІБ індивідуального підприємця |
|
edrpou |
String |
код ЕДРПОУ/КПП |
|
inn |
String |
код ІПН |
|
status |
об’єкт; опис статусу аккаунту |
|
|
emails |
List<String> |
масив E-mail адрес |
|
phone |
String |
№ телефону |
|
legalAddress |
String |
юридична адреса компанії |
|
dateCreate |
long |
дата створення акаунту |
|
dateChange |
long |
дата зміни (оновлення) акаунту |
|
about |
String |
додатковий опис |
|
comment |
об’єкт; коментар |
|
|
logo |
String |
лого |
Об’єкт User (для сервісу Тендер)
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
id |
long |
id користувача |
|
employeeId |
long |
id співробітника |
|
uuid |
UUID |
uuid співробітника |
|
accountId |
long |
id аккаунта |
|
account |
об’єкт; дані аккаунта |
|
|
login |
String |
логін |
|
role |
об’єкт; роль |
|
|
name |
String |
ім’я |
|
surname |
String |
прізвище |
|
secondName |
String |
по батькові |
|
phone |
String |
телефон |
|
ipn |
String |
код ІПН |
|
dateLastLogin |
long |
дата останньої сесії |
|
info |
String |
додакова інформація |
|
emails |
List<String> |
масив E-mail адрес |
|
comment |
об’єкт; коментар |
|
|
companies |
List<Company> |
масив об’єктів; компанії |
|
isSubscribes |
boolean |
підписка |
|
userSubscribes |
об’єкт; підписки на організаторів / категорії / користувачів |
JSON приклад масиву користувачів, на яких оформлена підписка
{
"users": [
{
"id": 60213990,
"employeeId": 2798,
"accountId": 37227,
"account": {
"id": 37227,
"name": "ТОВ \"Відправник товару\"",
"edrpou": "34554363-1",
"status": {
"code": 1,
"description": "Активний"
},
"emails": [
"otpraviteltovara@gmail.com"
],
"phone": "380123456789",
"legalAddress": "Київ, вул.Заболотного 29",
"dateCreate": 1624377561,
"dateChange": 0
},
"login": "test1515",
"role": {
"code": 1,
"description": "Пользователь"
},
"name": "Girl",
"surname": "Good",
"phone": "380669798799",
"dateLastLogin": 0,
"info": "created from web",
"emails": [
"vdymk@mailto.plus",
"zertegokno@vusra.com"
],
"isSubscribes": false
},
{
"id": 60213984,
"employeeId": 2787,
"accountId": 37227,
"account": {
"id": 37227,
"name": "ТОВ \"Відправник товару\"",
"edrpou": "34554363-1",
"status": {
"code": 1,
"description": "Активный"
},
"emails": [
"otpraviteltovara@gmail.com"
],
"phone": "380123456789",
"legalAddress": "Київ, вул.Заболотного 29",
"dateCreate": 1624377561,
"dateChange": 0
},
"login": "tender.vilnui2@gmail.com",
"role": {
"code": 1,
"description": "Пользователь"
},
"name": "Vi",
"surname": "Kut",
"phone": "380646545646",
"dateLastLogin": 1637259663,
"info": "created from web",
"emails": [
"tender.vilnui2@gmail.com"
],
"companies": [
{
"id": 4553,
"uuid": "1a578a08-da65-41a8-a45d-74891a84b8ae",
"accountID": 37227,
"name": "ТОВ Тендер Вільний2",
"edrpou": "563256894",
"inn": "563256894"
}
],
"isSubscribes": false
},
{
"id": 60213983,
"employeeId": 2786,
"accountId": 37227,
"account": {
"id": 37227,
"name": "ТОВ \"Відправник товару\"",
"edrpou": "34554363-1",
"status": {
"code": 1,
"description": "Активный"
},
"emails": [
"otpraviteltovara@gmail.com"
],
"phone": "380123456789",
"legalAddress": "Київ, вул.Заболотного 29",
"dateCreate": 1624377561,
"dateChange": 0
},
"login": "tender",
"role": {
"code": 1,
"description": "Пользователь"
},
"name": "ki",
"surname": "vi",
"phone": "380564654654",
"dateLastLogin": 1635936070,
"info": "created from web",
"emails": [
"tender.vilnui.ttn@gmail.com"
],
"companies": [
{
"id": 4552,
"uuid": "bb63a908-e453-41d4-ace0-d5c894691e92",
"accountID": 37227,
"name": "ТОВ Тендер Вільний",
"edrpou": "123654788",
"inn": "123654788"
}
],
"isSubscribes": false
}
]
}
Об’єкт Comment
Опис параметрів об'єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
id |
long |
id коментаря |
|
accountId |
long |
id аккаунту |
|
companyId |
long |
id компанії |
|
userId |
long |
id користувача |
|
adminId |
long |
id адміністратора |
|
dateChange |
long |
дата зміни коментаря |
|
text |
String |
текст коментаря |
Об’єкт Company (для сервісу Тендер)
Опис параметрів об'єкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
id |
M |
long |
id компанії |
|
uuid |
UUID |
uuid компанії |
|
|
accountID |
long |
id аккаунту |
|
|
account |
Account |
об’єкт; дані аккаунту |
|
|
name |
String |
повне найменування організації чи ПІБ індивудуального підприємця |
|
|
edrpou |
String |
код ЄДРПОУ/КПП |
|
|
inn |
String |
код ІПН |
|
|
city |
String |
місто |
|
|
address |
String |
адреса |
|
|
comment |
об’єкт; коментар |
- [1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
Об'єкт Filter (додаткові параметри виборки)
Опис параметрів об'єкта (пошуку)
|
Параметр |
Формат |
Опис |
|---|---|---|
|
dateStartFrom |
int |
початок яких з |
|
dateStartTo |
int |
початок яких по |
|
dateEndFrom |
int |
завершення яких з |
|
dateEndTo |
int |
завершення яких по |
|
dateCreateFrom |
int |
котрі створені з |
|
dateCreateTo |
int |
котрі створені по |
|
title |
String |
частина назви тендера |
|
lotTitle |
String |
частина назви лота |
|
accessType |
tinyint |
тип доступу:
|
|
offerType |
tinyint |
етап:
|
|
type |
tinyint |
тип торгівлі:
|
|
withTax |
tinyint |
за ціною (ПДВ / без ПДВ):
|
|
organizator |
int |
id Організатора |
|
category |
int |
номер товарної категорії |
|
ordering |
String |
користувацьке сортування |
|
limit |
int |
ліміт вибірки (за замовчуванням 20) |
|
offset |
int |
зміщення відносно верхньої межі вибірки (за замовчуванням 0) |
|
count |
boolean |
значення true повертає у відповіді методу лише кількість відібраних запитом тендерів (число) |
|
status |
tinyint |
статус тендера:
|
Об’єкт Auction (дані тендера)
Опис параметрів об’єкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
id |
long |
id тендера |
|
|
uuid |
UUID |
uuid тендера |
|
|
companyId |
long |
id компанії |
|
|
company |
M |
об’єкт; дані компанії, якій належить тендер |
|
|
dateCreate |
long |
дата створення тендера (UNIX TimeStamp) |
|
|
dateStart |
M |
long |
дата початку тендера (UNIX TimeStamp) |
|
dateEnd |
M |
long |
дата закінчення тендера (UNIX TimeStamp) |
|
dateLastUpdate |
long |
дата останнього оновлення тендера (UNIX TimeStamp) |
|
|
userId |
long |
id користувача |
|
|
user |
об’єкт; дані користувача |
||
|
title |
M |
String |
назва (заголовок) тендера |
|
description |
M |
String |
опис тендера |
|
status |
об’єкт; статус тендера |
||
|
accessType |
M |
об’єкт; вид (тип доступу) |
|
|
type |
M |
об’єкт; напрям тендера (тип торгівлі) |
|
|
offerType |
M |
об’єкт; етап |
|
|
isAutoRenewal |
O |
boolean |
автоматичне продовження тендера (автопродовження) |
|
autoRenewalTime |
O |
int(0-10) |
час в хв, на який здійснюється автопродовження (лише при isAutoRenewal=true); При isAutoRenewal=false параметр autoRenewalTime=0; при isAutoRenewal=true параметр autoRenewalTime=5 за замовчуванням. |
|
autoRenewalMaxCount |
O |
int |
Максимальна кількість продовжень. Якщо значення 0, то тендер буде продовжуватись нескінченну кількість разів |
|
autoRenewalDateUntil |
O |
unixtimestamp |
Дата/час, після якої автопродовження не буде. Якщо значення 0, то тендер буде продовжуватися до нескінченності. |
|
autoRenewalIsWorkDays |
O |
boolean |
Враховувати робочі години. Якщо вказано “Так” і час завершення тендеру більше за 18:00, то такий тендер автоматично продовжується на наступний день на 09:30 |
|
isTax |
O |
boolean |
відображення ціни з ПДВ |
|
noShowBets |
O |
boolean |
приховувати ставки |
|
noShowBestBet |
O |
boolean |
приховувати кращу ставку |
|
hideParticipantNamesOnly |
O |
boolean |
приховувати імена учасників |
|
hideLotsAndBetsCounts |
O |
boolean |
Не показувати кількість ставок та лотів не запрошеним учасникам |
|
isFree |
boolean |
безкоштовна участь |
|
|
isProlonged |
boolean |
відмітка продовження тендера |
|
|
users |
O |
List<Integer> |
масив даних ID користувачів, яким буде надано доступ до відповідного тендеру після його публікації |
|
lots |
M |
List<Lot> |
масив об’єктів; дані лотів |
|
auctionContact |
об’єкт; дані контактної особи |
||
|
lotsCount |
Integer |
кількість лотів |
|
|
betsCount |
Integer |
кількість ставок |
|
|
attachments |
List<Attachment> |
масив об’єктів; вкладення |
|
|
companyAccessRequestStatus |
об’єкт; статус заявки на участь в закритому тендері і коментарями Організатора. Об’єкт доступний лише закритим тендерам для Організатора чи Учасника цього тендера. |
- [1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
JSON приклад запиту (дані для створення тендера)
{
"dateStart": 1654269080,
"dateEnd": 1654269880,
"type": {
"code": 1
},
"offerType": {
"code": 1
},
"accessType": {
"code": 1
},
"status": {
"code": 1
},
"company": {
"id": 3600
},
"title": "свиня",
"description": "поросятко",
"lots": [
{
"title": "поросятко",
"productCode": "",
"description": "поросятко",
"expectedValue": "2",
"stepValue": "3",
"currency": {
"id": 1
},
"region": {
"id": 0
},
"category": {
"id": 9523
},
"unit": {
"id": 17
},
"quantity": "3",
"noShowBets": false,
"noShowBestBet": false,
"hideParticipantNamesOnly": false,
"attachments": []
}
],
"isAutoRenewal": true,
"autoRenewalTime": 5,
"autoRenewalMaxCount": 10,
"autoRenewalDateUntil": 1732788000,
"autoRenewalIsWorkDays": true,
"isTax": true,
"noShowBets": false,
"noShowBestBet": false,
"hideParticipantNamesOnly": false,
"hideLotsAndBetsCounts": false,
"auctionContact": null
}JSON приклад відповіді (дані створеного тендера)
{
"id": 4623,
"uuid": "c79ae8fc-a2cf-4650-90c2-f987b1c28f38",
"companyId": 0,
"company": {
"id": 3600,
"uuid": "c345ef8f-ba02-439a-afac-007ed088cf2e",
"accountID": 36633,
"name": "Товариство з обмеженою відповідальністю \"Скай'нет-56\"",
"edrpou": "89456891",
"inn": "125632589223",
"city": "Kiev"
},
"dateCreate": 1654243789,
"dateStart": 1654245540,
"dateEnd": 1654247340,
"dateLastUpdate": 1654243789,
"userId": 0,
"user": {
"id": 60212904,
"employeeId": 1035,
"accountId": 36633,
"account": {
"id": 36633,
"name": "Товариство з обмеженою відповідальністю \"Скай'нет-56\"",
"edrpou": "89456891",
"inn": "123652632563",
"status": {
"code": 1,
"description": "Активный"
},
"emails": [
"12356@ukr.net"
],
"phone": "355478563",
"legalAddress": "ююю",
"dateCreate": 1598894147,
"dateChange": 1638282398,
"about": "строительство и логистика ",
"logo": "/api/logo/accounts/logo_36633.jpg"
},
"login": "willnotgotomumbai@gmail.com",
"role": {
"code": 1,
"description": "Пользователь"
},
"name": "Арбуз",
"surname": "Арбузов",
"secondName": "Иоанович ",
"phone": "380975560011",
"ipn": "111111111111",
"dateLastLogin": 1654243144,
"info": "self registered. IP: null",
"emails": [
"willnotgotomumbai@gmail.com"
],
"companies": [
{
"id": 3600,
"uuid": "c345ef8f-ba02-439a-afac-007ed088cf2e",
"accountID": 36633,
"name": "Товариство з обмеженою відповідальністю \"Скай'нет-56\"",
"edrpou": "89456891",
"inn": "125632589223",
"city": "Kiev"
},
{
"id": 3624,
"uuid": "164d8465-aad6-409d-b3a8-5b009e1ca542",
"accountID": 36633,
"name": "Товариство з обмеженою відповідальністю \"Інститут інноваційних технологій",
"edrpou": "6465656666",
"inn": "6465656666",
"city": "Львів",
"address": "Волкова"
},
{
"id": 4248,
"uuid": "8520b4ee-c799-461e-9b14-e129dcfef27d",
"accountID": 36633,
"name": "ТОВ \"Отправитель товар",
"edrpou": "643555552",
"inn": "643555552"
},
{
"id": 4408,
"uuid": "cf5def31-8849-4a30-b1fa-0bf3e1d39423",
"accountID": 36633,
"name": "апвапвапв",
"edrpou": "2563256222",
"inn": "2563256222"
}
],
"isSubscribes": false
},
"title": "Шнурок",
"description": "а може навіть хвіст",
"status": {
"code": 1,
"name": "draft",
"description": "Черновик"
},
"accessType": {
"code": 1,
"name": "public",
"description": "Открытый для всех"
},
"type": {
"code": 1,
"name": "purchase",
"description": "Покупка"
},
"offerType": {
"code": 1,
"name": "bargaining",
"description": "Торги"
},
"isAutoRenewal": true,
"isTax": true,
"noShowBets": false,
"noShowBestBet": false,
"hideParticipantNamesOnly": false,
"hideLotsAndBetsCounts": false,
"isFree": false,
"isProlonged": false,
"lots": [
{
"id": 10063,
"auctionId": 4623,
"title": "Шнурок для віслючка",
"description": "нє ну як ще описати",
"expectedValue": 2345.0,
"stepValue": 23.0,
"currencyId": 0,
"currency": {
"id": 1,
"code": "UAH",
"name": "Українська гривня"
},
"quantity": 1.0,
"unitId": 0,
"unit": {
"id": 1,
"code": "2009",
"name": "штука",
"shortName": "шт"
},
"deliveryStartDate": 0,
"deliveryEndDate": 0,
"categoryId": 0,
"category": {
"id": 9511,
"section": "99",
"group": "9",
"categoryClass": "9",
"category": "9",
"detailing": "001",
"check_sum": "9",
"full_code": "99999001-9",
"description_ua": "Зоотовари",
"description_en": "Pet supplies",
"rank": 1,
"refId": 9458,
"hasChildren": 0,
"status": 1,
"isSubscribes": false
},
"regionId": 0,
"region": {
"id": 0,
"code": "0",
"name": "Все области"
},
"noShowBets": false,
"noShowBestBet": false,
"hideParticipantNamesOnly": false,
"attachmentsCount": 0
}
],
"auctionContact": {
"auctionId": 4623
},
"lotsCount": 1
}JSON приклад відповіді (отримання даних існуючого тендера)
{
"id": 4611,
"uuid": "5042fdf7-0985-4429-88d3-4fc1c0055f3f",
"companyId": 4216,
"company": {
"id": 4216,
"uuid": "eaf51f20-810e-4296-952f-b5a0c9c3b1ab",
"accountID": 37228,
"name": "ТОВ Перевозчик товара",
"edrpou": "987456321",
"inn": "987456321",
"city": "Тетиев",
"address": "центральная"
},
"dateCreate": 1654238475,
"dateStart": 1654240260,
"dateEnd": 1657438800,
"dateLastUpdate": 1654238479,
"userId": 60213516,
"user": {
"id": 60213516,
"employeeId": 2123,
"accountId": 37228,
"account": {
"id": 37228,
"name": "ТОВ \"Перевозчик товара\"",
"edrpou": "987456321",
"inn": "987456321",
"status": {
"code": 1,
"description": "Активный"
},
"emails": [
"perevozchiktovara@gmail.com"
],
"phone": "380635025677",
"legalAddress": "вул. Хрещатик 32",
"dateCreate": 1624374233,
"dateChange": 0
},
"login": "perevozchiktovara@gmail.com",
"role": {
"code": 1,
"description": "Пользователь"
},
"name": "Груз",
"surname": "Перевозчик",
"secondName": "LLLL",
"phone": "380534653460",
"ipn": "1234567891",
"dateLastLogin": 1654238418,
"info": "self registered. IP: null",
"emails": [
"perevozchiktovara@gmail.com"
],
"companies": [
{
"id": 4216,
"uuid": "eaf51f20-810e-4296-952f-b5a0c9c3b1ab",
"accountID": 37228,
"name": "ТОВ Перевозчик товара",
"edrpou": "987456321",
"inn": "987456321",
"city": "Тетиев",
"address": "центральная"
},
{
"id": 4219,
"uuid": "c067f69f-aaec-4e04-a3be-4d365fe24a02",
"accountID": 37228,
"name": "Тов Нов перевоз",
"edrpou": "456909720",
"inn": "7527785272",
"city": "Київ",
"address": "проспект Оболонський"
},
{
"id": 4230,
"uuid": "2d617de7-5624-4332-88ea-14529c8b1a73",
"accountID": 37228,
"name": "ДЛП ОРТ-арож",
"edrpou": "151515369",
"inn": "151515369"
},
{
"id": 4231,
"uuid": "eb9b40c4-ed5f-4cb2-820e-265fcb146f42",
"accountID": 37227,
"name": "ТОВ Перевозка",
"edrpou": "19369433",
"inn": "566666666666",
"city": "Київ",
"address": "проспект Бандери 35"
},
{
"id": 4234,
"uuid": "09279204-eda7-468b-bef1-8fe9a5327290",
"accountID": 37227,
"name": "ТОВ Заказчик",
"edrpou": "642456988",
"inn": "642456988",
"city": "Киев",
"address": "проспект Победы 40"
},
{
"id": 4574,
"uuid": "f28e0c65-9802-4cf6-9119-614f65222441",
"accountID": 37228,
"name": "ТОВ Валидный едрпоу",
"edrpou": "42746134",
"inn": "427461345555"
},
{
"id": 6991,
"uuid": "ee0735df-eb71-49a0-acd5-49363984de5f",
"accountID": 37487,
"name": "ТОВ Бурундук",
"edrpou": "5243543",
"inn": "6565315321"
}
],
"isSubscribes": false
},
"title": "Яблука",
"description": "Яблука",
"status": {
"code": 2,
"name": "active",
"description": "Активный"
},
"accessType": {
"code": 1,
"name": "public",
"description": "Открытый для всех"
},
"type": {
"code": 1,
"name": "purchase",
"description": "Покупка"
},
"offerType": {
"code": 1,
"name": "bargaining",
"description": "Торги"
},
"isAutoRenewal": true,
"isTax": true,
"noShowBets": false,
"noShowBestBet": false,
"hideParticipantNamesOnly": false,
"hideLotsAndBetsCounts": false,
"isFree": false,
"isProlonged": false,
"lots": [
{
"id": 10051,
"auctionId": 4611,
"title": "Яблука",
"description": "Яблука",
"expectedValue": 333.0,
"stepValue": 3.0,
"currencyId": 1,
"currency": {
"id": 1,
"code": "UAH",
"name": "Українська гривня"
},
"quantity": 33333333,
"unitId": 14,
"unit": {
"id": 14,
"code": "2013",
"name": "тисяча штук",
"shortName": "тис.шт."
},
"deliveryStartDate": 0,
"deliveryEndDate": 0,
"categoryId": 9511,
"category": {
"id": 9511,
"section": "99",
"group": "9",
"categoryClass": "9",
"category": "9",
"detailing": "001",
"check_sum": "9",
"full_code": "99999001-9",
"description_ua": "Зоотовари",
"description_en": "Pet supplies",
"rank": 1,
"refId": 9458,
"hasChildren": 0,
"status": 1,
"isSubscribes": false
},
"regionId": 0,
"noShowBets": false,
"noShowBestBet": false,
"hideParticipantNamesOnly": false,
"betsCount": 0,
"attachmentsCount": 0
}
],
"lotsCount": 1,
"betsCount": 0,
"attachments": []
}Об’єкт Bet (дані ставки по тендеру)
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
id |
long |
id ставки |
|
lotId |
long |
id лота |
|
lot |
Lot |
об’єкт; детальна інформація про лот |
|
userId |
long |
id користувача |
|
user |
User |
об’єкт; детальна інформація про користувача |
|
companyId |
long |
id компанії |
|
company |
Company |
об’єкт; детальна інформація про компанію |
|
value |
double |
значення ставки |
|
comment |
String |
коментар |
|
dateTime |
long |
дата і час ставки у форматі UNIX TimeStamp |
|
status |
Status |
статус |
|
removeComment |
String |
відмітка про видалення коментаря |
|
auctionChangedDateEnd |
long |
дата і час завершення тендера (у форматі UNIX TimeStamp) |
|
attachmentsCount |
int |
кількість прикладених до ставки файлів (max=5) |
Приклад JSON:
{
"id": 3269,
"lotId": 5681,
"userId": 198,
"user": {
"id": 198,
"employeeId": 198,
"accountId": 11158,
"account": {
"id": 11158,
"name": "СУБЛАНД УКРАЇНА",
"edrpou": "37212319",
"inn": "372123104628",
"status": {
"code": 1,
"description": "Активний"
},
"emails": [
"sinergiya@test.com"
],
"phone": "3805637318",
"legalAddress": "49069, м. Дніпро, вул. Лісова, буд. 49",
"dateCreate": 1371452537,
"dateChange": 1605700611,
"logo": "/api/logo/accounts/logo_11158.jpg"
},
"login": "biba",
"role": {
"code": 1,
"description": "Користувач"
},
"name": "first_name",
"surname": "last_name",
"secondName": "middle_name",
"phone": "9",
"ipn": "1",
"dateLastLogin": 1611594024,
"info": "1e4d3617\r\nЗаблокирован, за неуплату 2010-10-04 16:55\r\nРазблокирован 2010-10-06 17:31\r\nЗаблокирован, за неуплату 2011-03-29 11:47\r\nРазблокирован 2011-03-29 15:34\r\nЗаблокирован, за неуплату 2011-05-10 09:24\r\nРазблокирован 2011-05-10 11:44",
"emails": [
"biba",
"evo-dev@edi.su"
],
"companies": [
{
"id": 447,
"uuid": "0e4eca5a-b60d-4e18-b87c-05173ce5dfac",
"accountID": 11158,
"name": "СУБЛАНД УКРАЇНА",
"edrpou": "37212319",
"inn": "372123104628"
}
]
},
"companyId": 447,
"value": 42.0,
"comment": "Коментар2",
"dateTime": 0,
"status": {
"code": 1,
"name": "active",
"description": "Активна ставка"
},
"auctionChangedDateEnd": 1617178680,
"attachmentsCount": 0
}
Об’єкт XDocApprovalStep
Опис параметрів об’єкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
docId |
long |
id документа |
|
|
scenarioId |
long |
id сценарію |
|
|
stepId |
M |
int |
id кроку погодження |
|
userId |
long |
id користувача |
|
|
stepStatus |
int |
статус кроку погодження
|
|
|
operationType |
M |
int |
тип операції
|
|
stepInfo |
String |
інфо кроку погодження (текст причини відхилення на даному кроці) |
|
|
dateChanged |
long |
дата останньої зміни (unix timestamp) |
- [1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
-
Об'єкт XDocApprovalScenario (дані кроків за сценарієм)
Опис параметрів об’єкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
id |
long |
id сценарію |
|
|
actual |
O |
boolean |
актуальність
actual=false - передається для видалення сценарію |
|
userId |
long |
id користувача |
|
|
docType |
O |
int |
тип документа для автопогодження:
|
|
auto |
O |
boolean |
автоматичний запуск погодження |
|
name |
M |
String |
назва сценарію |
|
subDocTypes |
O |
List<Integer> |
масив чисел; підтип COMDOC документа для автопогодження:
|
|
partners |
O |
List<String> |
масив значень; перелік GLN контрагентів, за якими буде запускатись автопогодження |
|
documentSumMin |
O |
double |
ВІД якої суми документа (з ПДВ) буде запускатись автопогодження |
|
documentSumMax |
O |
double |
ДО якої суми документа (з ПДВ) буде запускатись автопогодження |
|
steps |
M |
<Integer, List<XDocApprovalStep>> |
об’єкт з пронумерованими масивами об’єктів; тіло сценарію (кроки погодження документів) |
JSON приклад запиту
{
"name": "Бахмут - це Україна",
"userId": 50206653,
"actual": true,
"auto": false,
"partners":
[],
"documentSumMin": "500",
"documentSumMax": "1000",
"steps":
{
"1":
[
{
"userId": "50206653",
"operationType": "1"
}
],
"2":
[
{
"userId": "60215367",
"operationType": "2"
}
]
},
"docType": 28,
"subDocTypes":
[
13
]
}JSON приклад відповіді за одним сценарієм
{
"id": 5,
"actual": true,
"userId": 50206655,
"docType": 28,
"auto": true,
"name": "СценкаНова",
"subDocTypes":
[
13
],
"partners":
[],
"documentSumMin": 0.0,
"documentSumMax": 0.0,
"steps":
{
"1":
[
{
"docId": 0,
"scenarioId": 0,
"stepId": 0,
"userId": 50206655,
"stepStatus": 0,
"operationType": 1,
"dateChanged": 0
}
],
"2":
[
{
"docId": 0,
"scenarioId": 0,
"stepId": 0,
"userId": 50206655,
"stepStatus": 0,
"operationType": 2,
"dateChanged": 0
}
]
}
}JSON приклад відповіді за всіма сценаріями
[
{
"id": 1,
"actual": true,
"userId": 50206655,
"docType": 0,
"auto": false,
"name": "very short",
"documentSumMin": 0.0,
"documentSumMax": 0.0,
"steps":
{
"1":
[
{
"docId": 0,
"scenarioId": 0,
"stepId": 0,
"userId": 50206655,
"stepStatus": 0,
"operationType": 2,
"dateChanged": 0
}
]
}
},
{
"id": 2,
"actual": true,
"userId": 50206655,
"docType": 0,
"auto": false,
"name": "Акт наданих послуг",
"documentSumMin": 0.0,
"documentSumMax": 0.0,
"steps":
{
"1":
[
{
"docId": 0,
"scenarioId": 0,
"stepId": 0,
"userId": 50206655,
"stepStatus": 0,
"operationType": 2,
"dateChanged": 0
}
]
}
},
{
"id": 3,
"actual": true,
"userId": 50206655,
"docType": 0,
"auto": false,
"name": "test skip first step",
"documentSumMin": 0.0,
"documentSumMax": 0.0,
"steps":
{
"1":
[
{
"docId": 0,
"scenarioId": 0,
"stepId": 0,
"userId": 50206661,
"stepStatus": 0,
"operationType": 1,
"dateChanged": 0
}
],
"2":
[
{
"docId": 0,
"scenarioId": 0,
"stepId": 0,
"userId": 50206655,
"stepStatus": 0,
"operationType": 1,
"dateChanged": 0
}
]
}
},
{
"id": 4,
"actual": true,
"userId": 50206655,
"docType": 0,
"auto": false,
"name": "На Дарʼю",
"documentSumMin": 0.0,
"documentSumMax": 0.0,
"steps":
{
"1":
[
{
"docId": 0,
"scenarioId": 0,
"stepId": 0,
"userId": 50206655,
"stepStatus": 0,
"operationType": 1,
"dateChanged": 0
}
],
"2":
[
{
"docId": 0,
"scenarioId": 0,
"stepId": 0,
"userId": 50206661,
"stepStatus": 0,
"operationType": 2,
"dateChanged": 0
}
]
}
},
{
"id": 5,
"actual": true,
"userId": 50206655,
"docType": 28,
"auto": true,
"name": "СценкаНова",
"subDocTypes":
[
13
],
"partners":
[],
"documentSumMin": 0.0,
"documentSumMax": 0.0,
"steps":
{
"1":
[
{
"docId": 0,
"scenarioId": 0,
"stepId": 0,
"userId": 50206655,
"stepStatus": 0,
"operationType": 1,
"dateChanged": 0
}
],
"2":
[
{
"docId": 0,
"scenarioId": 0,
"stepId": 0,
"userId": 50206655,
"stepStatus": 0,
"operationType": 2,
"dateChanged": 0
}
]
}
},
{
"id": 6,
"actual": false,
"userId": 50206655,
"docType": 28,
"auto": false,
"name": "На підтримку ЗСУ",
"subDocTypes":
[
13
],
"partners":
[
"1234567890AaB",
"4823058722214"
],
"documentSumMin": 5.0E+10,
"documentSumMax": 5000000000000001,
"steps":
{
"1":
[
{
"docId": 0,
"scenarioId": 0,
"stepId": 0,
"userId": 50206655,
"stepStatus": 0,
"operationType": 1,
"dateChanged": 0
}
],
"2":
[
{
"docId": 0,
"scenarioId": 0,
"stepId": 0,
"userId": 50206655,
"stepStatus": 0,
"operationType": 2,
"dateChanged": 0
}
]
}
}
]
Об'єкт XQueryShipment
Даний об'єкт використовується для пошуку сертифікатів по відвантаженню.
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
number |
FieldParams |
параметри пошуку по номеру відвантаження |
|
date |
|
|
|
buyer |
FieldParams |
|
Приклади пошуку сертифікатів по номеру відвантаження
Пошук сертифікатів, де є відвантаження з номером shipment_1 або shipment_231:
{"shipments":[{"number":{"operator":"AND","type":"IN","query":"'shipment_1','shipment_231'"}}],"queryType":"MY","limit":{"offset":0,"count":21}}Пошук сертифікатів де є відвантаження з частковим співпадінням номера відвантаження:
{"shipments":[{"number":{"operator":"AND","type":"LIKE","query":"shipment_%"}}],"queryType":"MY","limit":{"offset":0,"count":21}}
Об'єкт XCertificateShipment
Опис параметрів обʼєкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
id |
|
long |
id відвантаження |
|
creatorId |
|
long |
GLN id користувача, який створив відвантаження |
|
number |
|
String |
номер накладної |
|
date |
|
long |
дата накладної |
|
buyer |
O |
long |
покупець |
-
[1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
-
-
Обʼєкт XPromotion
Опис параметрів обʼєкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
id |
O/M |
long |
id акції |
|
code |
M |
String |
код акції |
|
name |
M |
String |
назва акції |
|
type_id |
M |
int |
id типу акції |
|
date_from |
M |
long |
дата початку акції |
|
date_to |
M |
long |
дата закінчення акції |
|
date_end |
M |
long |
останній день подання пропозицій |
|
date_changed |
O |
long |
дата створення/редагування/видалення акції зі сторони Мережі |
|
date_notification |
O |
long |
дата сповіщення про закінчення дії акції |
|
state |
O |
int |
стан акції (1 - активна) |
|
type |
O |
тип акції |
|
|
access |
O |
List<String> |
розділення доступу по GLN |
-
[1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
-
-
Об'єкт XPromotionType
Опис параметрів обʼєкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
type_id |
long |
id типу акції |
|
retailer_id |
int |
id Мережі на платформі EDIN |
|
gln_id |
long |
GLN id |
|
type |
String |
назва типу акції |
Об’єкт mintransSubscription
Опис параметрів обʼєкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
id |
long |
ідентифікатор підписки |
|
gln |
String |
GLN компанії |
|
companyCode |
String |
код ЄДРПОУ / ІПН компанії |
|
expired |
long |
кінцевий термін дії підписки (unix timestamp); визначає державний орган що керує |
|
startDate |
long |
початок терміну дії підписки (unix timestamp); дата оформлення підписки на події |
Приклад запиту
{
"id": 14,
"gln": 3958152365482,
"companyCode": "12345678",
"expired": 1719409499,
"startDate": 1703868300
}Об'єкт XQueryProduct
Опис параметрів об'єкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
barcode |
O |
String |
штрихкод товару |
|
article |
O |
String |
артикул продавця |
|
buyerCode |
O |
String |
код покупця |
|
uktveds |
O |
List<Integer> |
масив; коди УКТЗЕД товарів |
|
partNumber |
O |
String |
номер партії |
[1] - під визначенням колонки Тип мається на увазі скорочене позначення:
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
Об’єкт XQueryCertificates
Опис параметрів об’єкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
queryType |
O |
enum (MY, PRIVATE, PUBLIC, DRAFT, ARCHIVE, LIMITED_ACCESS, PUBLIC_ACCESS, PRIVATE_ACCESS) |
розділ сертифікатів, по якому буде здійснюватись пошук:
|
|
companyId |
O |
long |
ідентифікатор компанії |
|
products |
O |
List<XQueryProduct> |
масив об’єктів; дані товарів |
|
number |
O |
String |
номер сертифіката |
|
numbers |
O |
Collection<String> |
список номерів сертифікатів |
|
createDate |
O |
дата створення |
|
|
updateDate |
O |
дата оновлення |
|
|
types |
O |
List<Integer> |
масив об’єктів; типи сертифікатів |
|
startDate |
O |
дата початку дії сертифіката |
|
|
endDate |
O |
дата завершення дії сертифіката |
|
|
isSigned |
O |
Boolean |
true - підписаний, false - не підписаний |
|
limit |
O |
об’єкт; фільтр відбору (налаштування виводу даних) |
|
|
shipments |
O |
об'єкт з параметрами пошуку по пов'язаним відвантаженням |
[1] - під визначенням колонки Тип мається на увазі скорочене позначення:
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
JSON приклад запиту для пошуку всіх сертифікатів, де Ви - власник:
{
"queryType": "MY"
}
JSON приклад запиту для пошуку по Номеру партії 492:
{
"characteristics": {
"Batch Number": "492"
},
"queryType": "ALL",
"limit": {
"offset": 0,
"count": 21
}
}JSON приклад запиту для пошуку по Пов’язаній накладній 492:
{
"shipments": [
{
"number": {
"operator": "AND",
"type": "EQUALS",
"query": "492"
}
}
],
"queryType": "ALL",
"limit": {
"offset": 0,
"count": 21
}
}JSON приклад запиту для пошуку по Артикулу продавця 419775:
{
"products": [
{
"buyerCode": {
"operator": "AND",
"type": "EQUALS",
"query": "419775"
}
}
],
"queryType": "ALL",
"limit": {
"offset": 0,
"count": 21
}
}JSON приклад запиту для пошуку по Штрихкоду 4820275490223:
{
"products": [
{
"barcode": {
"operator": "AND",
"type": "EQUALS",
"query": "4820275490223"
}
}
],
"queryType": "ALL",
"limit": {
"offset": 0,
"count": 21
}
}Дані про сертифікат
Опис параметрів об'єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
certificate |
об’єкт; дані сертифіката |
|
|
glns |
Map<gln_id, Identificator> |
об’єкт; дані власника публічного сертифіката / дані користувачів з правами перегляду |
JSON приклад відповіді:
{
"certificate":
{
"id": 167,
"uuid": "55ef04b2-281e-4fca-bb67-d48fe88ae74f",
"number": "Номер сертифіката1",
"createDate": 1705494187,
"updateDate": 1705499386,
"issueDate": 1704060000,
"type":
{
"id": 10,
"name": "протокол лабораторних досліджень",
"type": 0
},
"view":
{
"id": 1,
"description": "Період дії"
},
"access":
[
13203393
],
"startDate": 1705442400,
"endDate": 1705528800,
"isSigned": false,
"accessType":
{
"code": 2,
"description": "Закритий (приватний)"
},
"creator": 13205923,
"info": "Коментар",
"level":
{
"code": "A",
"description": "Непідписаний сертифікат з прив'язкою до товарів"
},
"bodies":
{
"1":
[]
},
"characteristics":
{
"Issuer Article": "Артикул виробника",
"VMD Number": "Номер ВМД",
"Batch Number": "Номер партії!"
},
"parents":
[],
"products":
[
{
"id": 203,
"certificateId": 167,
"name": "Шоколадка",
"barcode": "1212121212",
"article": "Артикул продавця ",
"buyerCode": "Артикул покупця",
"uktved": 123456,
"dkpp": "Код ДКПП"
}
],
"productsQty": 0,
"autoArchive": true
},
"glns":
{
"13203393":
{
"id": 13203393,
"gln": "9864232607052",
"companyId": 37663,
"retailerId": 0,
"isUzdAts": 0,
"isFinCrypt": 0,
"countryId": 2,
"isERNN": 3,
"name": "TW_Вантажовідправник",
"companyType": "fiz",
"companyInn": "111111111111",
"companyKpp": "11111111",
"zip": "121212",
"katottg": "UA05020030010063857",
"city": "м. Вінниця, Вінницький р-н",
"street": "Тестова 2",
"IBAN": "UA111111111111111111111111111",
"district": "Вінницька",
"dpiCReg": 0,
"dpiCRaj": 0,
"isListex": false,
"isDeclarDateNumRequired": true,
"distribexUser": 0,
"isWithoutTax": true,
"taxSource": 0,
"isDriver": false,
"isSignConfirm": 0,
"isSpecification": 0,
"isCompany": 1,
"isTemporary": 0,
"parentId": 0,
"constructorGroupID": 0
}
}
}
Об'єкт characteristics (характеристики Сертифіката)
Опис параметрів об'єкта
|
Назва |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
Batch Number |
O/M |
String |
Номер партії (обов’язково передається при view.id=2) |
|
Issuer Article |
O |
String |
Артикул виробника |
|
VMD Number |
O |
String |
Номер ВМД |
[1] - під визначенням колонки Тип мається на увазі скорочене позначення:
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
Об'єкт XCertificateProduct (дані товарів)
| Параметр | Тип1 | Формат | Опис |
| id | O | long | ідентифікатор товару |
| certificateId | long | ідентифікатор сертифіката | |
| name | M | String | назва товару |
| barcode | M | String | штрихкод товару |
| article | M | String | артикул продавця |
| buyerCode | O | String | код покупця |
| uktved | O | long | код УКТЗЕД товару |
| dkpp | O | String | код ДКПП товару |
| partNumber | String | номер партії |
[1] - Під визначенням колонки Тип мається на увазі скорочене позначення:-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
JSON приклад відповіді:
-
[
{
"name": "Плотва",
"barcode": "yes it is",
"buyerCode": "Продаван",
"article": "Покупан",
"uktved": "2222222",
"dkpp": "333333"
},
{
"name": "Скумбрія",
"barcode": "121212122",
"dkpp": "12122",
"uktved": "333333",
"article": "Артикул2",
"buyerCode": "Артикул1"
}
]
Об'єкт Level
| Рівень | Опис |
| A+ | Підписаний сертифікат з прив'язкою до товарів |
| A | Непідписаний сертифікат з прив'язкою до товарів |
| B+ | Підписаний сертифікат без товарів |
| B | Непідписаний сертифікат без товарів |
| C | Без файлу сертификата |
Об'єкт AccessType
| Код | Опис |
| 0 | Неопубликований (DRAFT) |
| 1 | Відкритий для всіх (PUBLIC) |
| 2 | Закритий (приватний) (PRIVATE) |
| 3 | Доступний за посиланням (URL_ACCESS) |
Об’єкт XCertificateView
Опис параметрів об’єкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
id |
M |
int |
ідентифікатор виду
|
|
description |
String |
опис виду |
- [1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
Об’єкт XCertificateType
Опис параметрів об’єкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
id |
M |
int |
ідентифікатор типу
|
|
name |
String |
назва типу |
|
|
code |
String |
код типу |
|
|
type |
int |
тип |
- [1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
Об’єкт XCertificate (дані Сертифіката)
Опис параметрів об’єкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
id |
long |
ідентифікатор сертифіката |
|
|
uuid |
-/M |
UUID |
унікальний ідентифікатор сертифіката (передається при редагуванні сертифіката) |
|
number |
M |
String |
номер сертифіката |
|
createDate |
long |
дата створення (Unix timestamp) |
|
|
updateDate |
long |
дата оновлення (Unix timestamp) |
|
|
issueDate |
M |
long |
дата видачі (Unix timestamp) |
|
type |
M |
об’єкт; тип сертифіката |
|
|
view |
M |
об’єкт; вид сертифіката |
|
|
access |
List<Long> |
масив; доступність |
|
|
startDate |
M |
long |
дата початку дії сертифіката (Unix timestamp) |
|
endDate |
O/M |
long |
дата завершення дії сертифіката (Unix timestamp); параметр обов’язковий при view.id=1 |
|
isSigned |
boolean |
true - підписаний, false - не підписаний |
|
|
accessType |
об’єкт; тип доступу до сертифіката |
||
|
creator |
long |
ідентифікатор власника/автора сертифіката |
|
|
info |
O |
String |
коментар (додаткова інформація) |
|
level |
об’єкт; рівень сертифіката |
||
|
bodies |
Map<Integer, byte[]> |
вкладення |
|
|
characteristics |
O/M |
Map<String, String> |
характеристики characteristics (обов’язково передається при view.id=2) |
|
parents |
List<XCertificate> |
масив об’єктів; материнські сертифікати |
|
|
products |
List<XCertificateProduct_> |
масив об’єктів; товари |
|
|
productsQty |
int |
кількість товарів зв’язаних із сертифікатом |
|
|
autoArchive |
boolean |
true - автоматично архівувати, false - не архівувати автоматично |
|
|
is_structured |
int |
ознака, що документ структурований, приймає значення 0 (за замовчуванням) або 1 (якщо документ структурований) |
- [1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
JSON приклад:
{
"creator": 13205923,
"type":
{
"id": "10"
},
"view":
{
"id": "2"
},
"accessType":
{
"code": 0
},
"characteristics":
{
"Batch Number": "Номер партії*",
"Issuer Article": "Артикул виробника",
"VMD Number": "Номер ВМД"
},
"products":
[],
"number": "Номер сертифіката",
"issue_dateString": "2024-01-17",
"endDateString": "2024-01-17",
"startDateString": "2024-01-17",
"info": "Коментар",
"endDate": 1705442400,
"startDate": 1705442400,
"issueDate": 1705442400
}
Об’єкт XProductGroup (Групи / категорії товарів)
Опис параметрів об'єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
groupd_id |
long |
ідентифікатор
|
|
parent_group_id |
long |
ідентифікатор приналежності до вищого рівня в структурі:
|
|
name |
String |
назва:
|
|
children |
List<groupd_id> |
масив;
|
JSON приклад
{
"1": {
"groupd_id": 1,
"parent_group_id": 0,
"name": "Бакалія",
"children": [
7,
16,
2
]
},
"2": {
"groupd_id": 2,
"parent_group_id": 1,
"name": "Безглютенові продукти",
"children": [
3,
5
]
},
"3": {
"groupd_id": 3,
"parent_group_id": 2,
"name": "Кондитерські вироби без глютену",
"children": [
4
]
},
"4": {
"groupd_id": 4,
"parent_group_id": 3,
"name": "Печиво без глютену",
"children": []
},
"5": {
"groupd_id": 5,
"parent_group_id": 2,
"name": "Хлібо булочні вироби без глютену",
"children": [
6
]
},
"6": {
"groupd_id": 6,
"parent_group_id": 5,
"name": "Хліб без глютену",
"children": []
},
"7": {
"groupd_id": 7,
"parent_group_id": 1,
"name": "Борошно",
"children": [
8,
10,
12
]
},
"8": {
"groupd_id": 8,
"parent_group_id": 7,
"name": "Борошно житнє",
"children": [
9
]
},
"9": {
"groupd_id": 9,
"parent_group_id": 8,
"name": "Борошно житнє 1кг",
"children": []
},
"10": {
"groupd_id": 10,
"parent_group_id": 7,
"name": "Борошно кукурудзяне",
"children": [
11
]
},
"11": {
"groupd_id": 11,
"parent_group_id": 10,
"name": "Борошно кукурудзяне 1кг",
"children": []
},
"12": {
"groupd_id": 12,
"parent_group_id": 7,
"name": "Борошно пшеничне",
"children": [
14,
15,
13
]
},
"13": {
"groupd_id": 13,
"parent_group_id": 12,
"name": "Борошно пшеничне 1кг",
"children": []
},
"14": {
"groupd_id": 14,
"parent_group_id": 12,
"name": "Борошно пшеничне 2кг",
"children": []
},
"15": {
"groupd_id": 15,
"parent_group_id": 12,
"name": "Борошно пшеничне 5кг",
"children": []
},
"16": {
"groupd_id": 16,
"parent_group_id": 1,
"name": "Консерви М'ясні, Рибні",
"children": [
17,
20
]
},
"17": {
"groupd_id": 17,
"parent_group_id": 16,
"name": "Консерви Рибні",
"children": [
18,
19
]
},
"18": {
"groupd_id": 18,
"parent_group_id": 17,
"name": "Тунець консервований",
"children": []
},
"19": {
"groupd_id": 19,
"parent_group_id": 17,
"name": "Шпроти консервовані",
"children": []
},
"20": {
"groupd_id": 20,
"parent_group_id": 16,
"name": "Консерви М'ясні",
"children": [
21
]
},
"21": {
"groupd_id": 21,
"parent_group_id": 20,
"name": "Консервоване мясо птиці",
"children": []
}
}
Об’єкт XSearchPositionsQuery (Фільтр за позиціями Комерційних пропозицій)
Опис параметрів об'єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
retailerId |
long |
ідентифікатор мережі |
|
recipientGln |
String |
GLN отримувача |
|
recipientGlnId |
long |
ідентифікатор GLN отримувача |
|
senderGln |
String |
GLN відправника |
|
senderGlnId |
long |
ідентифікатор GLN відправника |
|
name |
String |
найменування позиції |
|
barcode |
String |
штрихкод позиції |
|
dateChanged |
DateTimeRange |
Пошук по даті, з можливістю вказати період. Приклад:
|
|
statuses |
List<Integer> |
масив статусів позицій (0 - чернетка; 1 - прийнято; 2 - відхилено; 3 - на узгодженні) |
|
groups |
Set<Long> |
масив категорій/груп/підгруп/товарних сегментів |
|
limit |
об’єкт; фільтр відбору (налаштування виводу даних) |
JSON приклад
{
"statuses": [
3
],
"groups": [
527,
487,
451,
533
],
"barcode": "111000222",
"retailerId": 7,
"limit": {
"count": 20,
"offset": 0
}
}
Масив об’єктів XAgreemDocPosition (Дані позицій Комерційної пропозиції)
Опис параметрів об'єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
id |
long |
ідентифікатор позиції |
|
uuid |
UUID |
унікальний ідентифікатор позиції |
|
name |
String |
найменування позиції |
|
barcode |
String |
штрихкод позиції |
|
status |
int |
статус позиції (0 - чернетка; 1 - прийнято; 2 - відхилено; 3 - на узгодженні) |
|
content |
byte[] |
контент (байтовий масив) |
|
doc_id |
long |
ідентифікатор Комерційної пропозиції |
|
doc_uuid |
UUID |
унікальний ідентифікатор Комерційної пропозиції |
|
sender_id |
long |
ідентифікатор відправника |
|
senderGln |
String |
GLN відправника |
|
recipient_id |
long |
ідентифікатор отримувача |
|
recipientGln |
String |
GLN отримувача |
JSON приклад запиту:
[
{
"doc_uuid": "3cbb2868-b61b-42d2-86d1-11ffdf4445aa",
"name": "Літун",
"barcode": "01010101010",
"status": 0,
"content": []
}
]
JSON приклад відповіді:
[
{
"id": 672,
"uuid": "d8910d0a-879d-41e9-894d-1b2dcc22494b",
"name": "тест",
"barcode": "12331233213",
"status": 1,
"content": [],
"doc_id": 2659,
"doc_uuid": "fe24ac93-0240-49d0-8a37-23530fb08d5f",
"sender_id": 13200665,
"recipient_id": 41249
},
{
"id": 673,
"uuid": "730bc81b-a17f-413e-a7e5-afbd6cb86790",
"name": "тест2",
"barcode": "1234567890123",
"status": 1,
"content": [],
"doc_id": 2659,
"doc_uuid": "fe24ac93-0240-49d0-8a37-23530fb08d5f",
"sender_id": 13200665,
"recipient_id": 41249
}
]
Об’єкт DeliveryInstructions
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|
|---|---|---|---|
|
description |
O |
string |
Опис (вид роботи перевізника: за відрядним тарифом, за погодинним тарифом, за по кілометровому тарифу, централізовані перевезення тощо) |
|
descriptionCode |
M |
string |
Код (TRANSPORTATION_TYPE) |
[1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
-
Об’єкт MainCarriageLogisticsTransportMovement
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|
|---|---|---|---|
|
specifiedTransportEvents** |
M |
List<TransportEvent> |
масив об’єктів; Проміжне розвантаження |
[1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
-
Об’єкт UtilizedLogisticsTransportEquipment
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|
|---|---|---|---|
|
id |
M |
string |
Реєстраційний номер автомобіля згідно з техпаспортом
|
|
categoryCode |
M |
string |
Тип транспортного засобу (для автомобіля параметр не передається):
|
|
characteristicCode |
O |
string |
Код визначення Причіп/напівпричіп:
|
|
affixedLogisticsSeals |
M/O |
List<SimpleIdentity> |
масив об’єктів; Номера пломб. В Акті перепломбування для автомобіля цей об’єкт є обов’язковим |
|
handlingInstructions |
O |
об’єкт; Інструкції з експлуатації |
|
|
applicableNotes |
M/O |
List<ApplicableNote> |
масив об’єктів; Примітки |
|
applicableTransportDangerousGoods |
O |
об’єкт; Клас небезпечних речовин |
|
|
associatedReferencedLogisticsTransportEquipment |
O |
об’єкт; Номер контейнера, в якому завантажено цей вантаж. Використовується опційно для контейнерних перевезень і має відповідати даним тегу UtilizedLogisticsTransportEquipment |
|
|
associatedReferencedDocuments |
O |
List<ReferencedDocument> |
масив об’єктів; Документи з вантажем |
|
transportLogisticsPackage |
O |
об’єкт; Транспортно-логістичний пакет. ВАЖЛИВО: в Україні дозволяється лише один LogisticsPackage для одного ConsignmentItem! |
|
|
applicableNotes |
O |
List<ApplicableNote> |
масив об’єктів; Примітки |
[1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
-
Об’єкт IncludedSupplyChainConsignmentItem
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|
|---|---|---|---|
|
sequenceNumeric |
M |
int |
Порядковий номер рядка в таблиці |
|
invoiceAmount |
O |
об’єкт; Загальна сума з ПДВ |
|
|
grossWeightMeasure |
M |
об’єкт; Маса брутто вантажу (кг) |
|
|
tariffQuantity |
O |
об’єкт; Ціна без ПДВ за одиницю в грн. Це можуть бути як гривні на кілограм (грн/кг), так і гривні на ящик (грн/ящик) - залежить від зазначеної одиниці виміру |
|
|
globalID |
O |
об’єкт; Код УКТЗЕД продукції |
|
|
natureIdentificationTransportCargo |
M |
об’єкт; Найменування вантажу |
|
|
applicableTransportDangerousGoods |
O |
об’єкт; Клас небезпечних речовин |
|
|
associatedReferencedLogisticsTransportEquipment |
O |
об’єкт; Номер контейнера, в якому завантажено цей вантаж. Використовується опційно для контейнерних перевезень і має відповідати даним тегу UtilizedLogisticsTransportEquipment |
|
|
associatedReferencedDocuments |
O |
List<ReferencedDocument> |
масив об’єктів; Документи з вантажем |
|
transportLogisticsPackage |
O |
об’єкт; Транспортно-логістичний пакет. ВАЖЛИВО: в Україні дозволяється лише один LogisticsPackage для одного ConsignmentItem! |
|
|
applicableNotes |
O |
List<ApplicableNote> |
масив об’єктів; Примітки |
[1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
-
Об’єкт TransportEvent
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|
|---|---|---|---|
|
id |
O/- |
string |
Порядковий номер події (події завжди нумеруються в порядку поступового зростання за принципом N+1) |
|
typeCode |
O |
string |
Тип операції (розвантаження=5, завантаження=10) |
|
description |
O/- |
string |
Опис |
|
actualOccurrenceDateTime |
O |
об’єкт; Дата і час прибуття автомобіля на розвантаження |
|
|
scheduledOccurrenceDateTime |
O |
об’єкт; Дата і час вибуття автомобіля з-під розвантаження |
|
|
occurrenceLogisticsLocation |
O/M |
об’єкт; Місцезнаходження |
|
|
certifyingTradeParties |
O/M |
List<TradeParty> |
масив об’єктів; Інформація (РНОКПП) про відповідальних осіб (підписантів), що передбачені логікою документообігу |
|
applicableNotes |
O |
List<ApplicableNote> |
масив об’єктів; Примітки |
[1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
-
Об’єкт HandlingInstructions
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|
|---|---|---|---|
|
applicableTransportSettingTemperature |
O |
об’єкт; Температурний режим, необхідний для перевезення вантажу |
[1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
-
Об’єкт ReferencedDocument
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|
|---|---|---|---|
|
typeCode |
O/M |
string |
Тип документа (довідник кодів документів) |
|
id |
O/M |
string |
Номер документа |
|
remarks |
O |
string |
UUID документа |
|
formattedIssueDateTime |
O |
об’єкт; Дата складання документа |
[1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
-
Об’єкт SimpleIdentity
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|
|---|---|---|---|
|
id |
M |
string |
ідентифікатор; приймає значення залежно від блоку, де використовується - точніше вказано в параметрі на рівень вище |
[1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
-
Об’єкт TradeParty
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|
|---|---|---|---|
|
id |
M/O |
об’єкт;
|
|
|
name |
M |
string |
Повна назва юридичної, або фізичної особи |
|
roleCode |
M |
string |
Роль учасника. Довідник ролей |
|
tradeContact |
O |
об’єкт; Контакти відповідального представника |
|
|
postalTradeAddress |
O/M |
об’єкт; Юридична адреса для юр. особи, або місце реєстрації для фіз. особи |
|
|
taxRegistration |
O |
об’єкт; Ідентифікаційний код відповідальної особи |
|
|
specifiedGovernmentRegistrations |
O/M |
об’єкт; Посвідчення Водія |
[1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
-
Об’єкт InvoiceAmount
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|
|---|---|---|---|
|
currencyId |
M |
string |
Тризначний код валюти (UAH) |
|
value |
M |
decimal |
Значення |
[1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
-
Об’єкт LogisticsLocation
Опис параметрів обʼєкта
|
Параметр |
Формат |
Опис |
|
|---|---|---|---|
|
id |
M/- |
об’єкт; Код КАТОТТГ місце знаходження пункту навантаження/розвантаження/місця складання/складу
|
|
|
name |
O/M |
string |
Найменування місця складання / пункту навантаження / пункту розвантаження / складу
|
|
typeCode |
O/M/- |
string |
Тип операції: 10 - навантаження; 5 - розвантаження.
|
|
description |
O/M |
string |
Опис (адреса) місця складання / пункту навантаження / пункту розвантаження
|
|
physicalGeographicalCoordinate |
M/O/- |
об’єкт; Географічні координати
|
[1] - під визначенням колонки Тип мається на увазі скорочене позначення:
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
Об'єкт EcmrUnitValue
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|
|---|---|---|---|
|
unitCode |
M |
string |
Код одиниці виміру (для tariffQuantity приймає значення «UAH») |
|
value |
M |
decimal |
Значення |
[1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
-
Об’єкт DateTime
Опис параметрів обʼєкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
dateTime |
datetime (2021-12-13T14:19:23+02:00) |
Дата і час складання документа |
Об’єкт DocumentCode
Опис параметрів обʼєкта
|
Параметр |
Формат |
Опис |
|
|---|---|---|---|
|
id |
M |
string |
код типу/підтипу документа |
[1] - під визначенням колонки Тип мається на увазі скорочене позначення:
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
Об’єкт SpecifiedSupplyChainConsignment
Опис параметрів обʼєкта
|
Параметр |
Формат |
Опис |
|
|---|---|---|---|
|
grossWeightMeasure |
M |
Загальна вага перевезення (маса брутто) в кг |
|
|
associatedInvoiceAmount |
O |
Усього відпущено на загальну суму, грн |
|
|
consignmentItemQuantity |
M |
decimal |
Загальна кількість місць вантажу (контейнерів) |
|
consignor |
M |
Вантажовідправник |
|
|
consignee |
M |
Вантажоодержувач |
|
|
carrier |
M |
Перевізник |
|
|
notifiedTradeParties |
M/O |
List<TradeParty> |
масив об’єктів; інформація (ЄДРПОУ / РНОКПП) про учасників перевезення. Детальніше в специфікації відповідного документа. |
|
carrierAcceptanceLogisticsLocation |
M |
об’єкт; Пункт навантаження |
|
|
consigneeReceiptLogisticsLocation |
M |
об’єкт; Пункт розвантаження |
|
|
associatedReferencedDocuments |
O |
List<ReferencedDocument> |
масив об’єктів; Супровідні документи на вантаж |
|
deliveryTransportEvent |
O |
об’єкт; Розвантажувальні роботи |
|
|
pickUpTransportEvent |
O/M |
об’єкт; Навантажувальні роботи |
|
|
includedSupplyChainConsignmentItems |
M |
масив об’єктів; Відомості про вантаж |
|
|
utilizedLogisticsTransportEquipments |
O/M |
масив об’єктів; Запис про автомобіль в перевезенні. Обов’язково заповнюється для Автомобіля (для причепа/напівпричепа опційно) |
|
|
mainCarriageLogisticsTransportMovement |
O |
об’єкт; Маршрутизація (проміжні пункти перевантаження). Заповнюється Перевізником |
|
|
deliveryInstructions |
M/O |
об’єкт; Вид перевезень |
|
|
previousAdministrativeReferencedDocument |
-/M |
об’єкт; Попередня транзакція ECMR, на основі якої складено поточний документ. Блок не вказується, якщо документ створено з «нуля» |
[1] - під визначенням колонки Тип мається на увазі скорочене позначення:
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
Об’єкт ExchangedDocument
Опис параметрів обʼєкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
id |
M |
string |
порядковий номер (серія) документа |
|
issueDateTime |
M |
об’єкт; Дата і час складання документа |
|
|
remarks |
O |
string |
Ремарки |
|
includedNote |
M/O |
List<IncludedNote> |
Масив об’єктів; Додані записи. Поле обов’язкове для е-ТТН документа |
|
issueLogisticsLocation |
M |
об’єкт; Місце складання документа |
[1] - під визначенням колонки Тип мається на увазі скорочене позначення:
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
Об’єкт DocumentContext
Опис параметрів обʼєкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
transactionID |
M |
string |
Номер версії документа (транзакції) в ланцюгу підписання документів |
|
documentCode |
M |
об’єкт; параметр контексту документа, визначений бізнес-процесом |
|
|
documentSubCode |
M |
об’єкт; параметр контексту визначеного документа |
[1] - під визначенням колонки Тип мається на увазі скорочене позначення:
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
Об’єкт Index
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
operator |
enum (AND, OR) |
тип оператора;
|
|
type |
enum (MORE, EQUALS, LIKE) |
тип документа;
|
|
fieldName |
String |
назва параметра, за яким буде здійснюватись фільтрація
|
|
value |
String |
значення поля fieldName |
Об’єкт Field
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
operator |
enum (AND, OR) |
тип оператора;
|
|
type |
enum (MORE, EQUALS, LIKE) |
тип документа;
|
|
value |
String |
значення поля |
Об’єкт XSearchDocsQuery (Критерії пошуку/фільтрації «Товарних узгоджень» AGREEM)
Опис параметрів об'єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
indexes |
List<Index> |
масив об’єктів; індекси |
|
direction |
об’єкт; напрямок документообігу; вказуються відправник, отримувач і зв’язок між ними в умовах відбору документів |
|
|
retailerId |
Long |
id мережі (ритейлера) |
|
retailers |
List<Long> |
масив; список мереж (ритейлерів) |
|
statuses |
List<Integer> |
масив; статус документа
|
|
types |
List<Integer> |
масив; тип документа
|
|
contractGlnIDs |
List<Integer> |
масив; id Gln-нів контрагентів |
|
contractNumber |
об’єкт; номер контракту/специфікації |
|
|
contractDescription |
об’єкт; опис контракту/специфікації |
|
|
dateCreated |
об’єкт; дата створення документа (в форматі UNIX-timestamp) з / по |
|
|
dateChanged |
об’єкт; дата зміни документа (в форматі UNIX-timestamp) з / по |
|
|
docDate |
об’єкт; дата документа (в форматі UNIX-timestamp) з / по |
|
|
limit |
об’єкт; фільтр відбору (налаштування виводу даних) |
|
|
docNumber |
String |
номер документа |
|
archive |
Boolean |
відмітка про те, що документ оброблений (архівний) |
|
withChilds |
Boolean |
відмітка про наявність дочірніх документів |
JSON приклади:
Отримати 20 останніх неархівних (необроблених) «Товарних узгоджень» (AGREEM) для Відправника «13200665»
{
"indexes": [],
"types": [],
"statuses": [],
"direction": {
"type": "EQ",
"sender": [
13200665
]
},
"archive": false,
"limit": {
"count": 20,
"offset": 0
}
}
Отримати 20 останніх важливих завершених «Товарних узгоджень» (AGREEM) типу «Промо ціна» для Відправника «13200665»
{
"indexes": [
{
"operator": "AND",
"type": "EQUALS",
"fieldName": "isFavorite",
"value": "true"
}
],
"types": [
2
],
"statuses": [
7
],
"direction": {
"type": "EQ",
"sender": [
13200665
]
},
"limit": {
"count": 20,
"offset": 0
}
}
Отримати 20 останніх оброблених (архівних) «Товарних узгоджень» (AGREEM) типу «Регулярна ціна» для Відправника «13200665» з датою документа за період 2021-07-01-2021-07-27
{
"indexes": [],
"types": [
1
],
"statuses": [],
"direction": {
"type": "EQ",
"sender": [
13200665
]
},
"archive": true,
"docDate": {
"startTimestamp": 1625086800,
"finishTimestamp": 1627419599
},
"limit": {
"count": 20,
"offset": 0
}
}
Отримати 40 останніх необроблених (неархівних) «Товарних узгоджень» (AGREEM) для Відправника «13200665» з номером контракту «666.333333»
{
"indexes": [],
"types": [],
"statuses": [],
"direction": {
"type": "EQ",
"sender": [
13200665
]
},
"archive": false,
"contractNumber": {
"operator": "AND",
"type": "EQUALS",
"value": "666.333333"
},
"limit": {
"count": 40,
"offset": 0
}
}
Об’єкт XNoveltyContacts
Опис параметрів об'єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
surname |
String |
Прізвище |
|
name |
String |
Ім’я |
|
middleName |
String |
По батькові |
|
|
String |
|
|
phone |
String |
Телефон |
|
uuid |
String |
Ідентифікатор контакту |
Об’єкт XNoveltyComment
Опис параметрів об'єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
date |
long |
дата коментаря (зміни статусу КП) у форматі UNIX TimeStamp |
|
user |
String |
найменування користувача Мережі |
|
comment |
String |
коментар при обробці комерційної пропозиції |
Об’єкт XNoveltyTrade
Опис параметрів об'єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
national1 |
String |
Національна мережа №1 (грн) |
|
national2 |
String |
Національна мережа №2 (грн) |
|
regional1 |
String |
Регіональна мережа №1 (грн) |
|
regional2 |
String |
Регіональна мережа №2 (грн) |
Об’єкт XNoveltyMarketing
Опис параметрів об'єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
promotion |
String |
Просування (%) |
|
logistics |
String |
Логістика (%) |
|
damage |
String |
Псування продукту (%) |
|
TPR |
String |
ТPR бюджет (%) |
Об’єкт XNoveltyPrices
Опис параметрів об'єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
unit_price |
String |
Ціна за одиницю (грн) |
|
weight_price |
String |
Ціна за кг (грн) |
|
volume_price |
String |
Ціна за літр (грн) |
|
profitability |
String |
Націнка (%); може мати від’ємне значення |
Об’єкт Ecmr
Опис параметрів обʼєкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
documentContext |
M |
об’єкт; технічні дані |
|
|
exchangedDocument |
M |
об’єкт; реквізити е-ТТН |
|
|
specifiedSupplyChainConsignment |
M |
об’єкт; інформація про перевезення |
[1] - під визначенням колонки Тип мається на увазі скорочене позначення:
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
Об'єкт Transport
Опис параметрів обʼєкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
id |
long |
ідентифікатор транспортного засобу |
|
|
number |
M |
String |
номер транспортного засобу (у літеро сполученні допускається лише латинниця (case sensitive)) в форматі «AA0001AA» |
|
brand |
M |
String |
марка транспортного засобу («Hyundai») |
|
model |
M |
String |
модель транспортного засобу («HD 78») |
|
type |
M |
String |
тип транспортного засобу («рефрижератор») |
|
color |
O |
String |
колір транспортного засобу |
|
length |
O |
String |
довжина транспортного засобу (мм) |
|
width |
O |
String |
ширина транспортного засобу (мм) |
|
height |
O |
String |
висота транспортного засобу (мм) |
|
weight |
O |
String |
вага транспортного засобу без вантажу (кг) |
|
isTrailer |
O |
int |
відмітка про тип транспортного засобу:
|
-
[1] Під визначенням колонки Тип мається на увазі скорочене позначення:
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
Приклад запиту
[
{
"id": 93,
"number": "AA0000AA",
"brand": "Тестовий траспорт",
"model": "модель модель",
"type": "Тип",
"color": "брудний",
"isTrailer": 1
},
{
"id": 104,
"number": "AA0001AA",
"brand": "Trailer",
"model": "Модель",
"type": "Trailer",
"color": "lime",
"isTrailer": 2
},
{
"id": 130,
"number": "AA0020XH",
"brand": "1",
"model": "SCHMITZ",
"type": "рефрижератор",
"isTrailer": 0
},
{
"id": 150,
"number": "AA0000",
"brand": "vv",
"model": "78",
"type": "вантажний",
"isTrailer": 2
},
{
"id": 265,
"number": "AA0099BB",
"brand": "hyundai",
"type": "вантажний",
"isTrailer": 0
},
{
"id": 266,
"number": "AA0098AП",
"brand": "Renault",
"type": "грузовий",
"isTrailer": 0
},
{
"id": 267,
"number": "AA0002BA",
"brand": "Hyundai",
"type": "тестовий",
"isTrailer": 0
},
{
"id": 273,
"number": "AA0011AA",
"brand": "тест",
"model": "тест",
"type": "тягач",
"color": "Синій, Текст,ТекстекстТекстТекстТекст",
"isTrailer": 0
},
{
"id": 274,
"number": "AA0011BB",
"brand": "тест",
"model": "тест",
"type": "тягач",
"isTrailer": 0
},
{
"id": 431,
"number": "AA0003AA",
"brand": "Ferrari",
"model": "F40",
"type": "cabriolet",
"color": "yellow",
"isTrailer": 0
},
{
"id": 435,
"number": "AA0000BB",
"brand": "Марка",
"model": "Модель",
"type": "Тип",
"isTrailer": 0
},
{
"id": 457,
"number": "AA0000123AA",
"brand": "Mazda",
"model": "R8",
"type": "Fast",
"color": "Black",
"isTrailer": 0
},
{
"id": 495,
"number": "AA00000AA",
"brand": "Ferrari",
"model": "F40",
"type": "cabriolet",
"color": "yellow",
"isTrailer": 0
},
{
"id": 501,
"number": "AA001100AA",
"brand": "test1",
"model": "test2",
"type": "test3",
"isTrailer": 0
},
{
"id": 575,
"number": "AA000001AB",
"brand": "testMarka",
"model": "testModel",
"type": "testTypeCar",
"color": "testColorCar",
"isTrailer": 0
},
{
"id": 577,
"number": "AA000002BB",
"brand": "testMarka2",
"model": "testModel2",
"type": "testType2",
"isTrailer": 1
},
{
"id": 579,
"number": "AA000003BB",
"brand": "testMarka3",
"model": "testModel3",
"type": "testType3",
"isTrailer": 1
},
{
"id": 613,
"number": "AA00001AA",
"brand": "AUTO",
"model": "AUTO",
"type": "AUTO",
"color": "AUTO",
"isTrailer": 0
}
]Об'єкт SignsPackageV2
Опис параметрів обʼєкта
|
Параметр |
Формат |
Код ролі |
Опис |
|---|---|---|---|
|
carrier |
List<ExEndUserSignInfo>
|
CA |
масив об’єктів; дані підписів Перевізника |
|
consignee |
CN |
масив об’єктів; дані підписів Вантажоодержувача |
|
|
consignor |
CZ |
масив об’єктів; дані підписів Вантажовідправника |
|
|
driver |
DR |
масив об’єктів; дані підписів Водія |
|
|
storage |
WD/WH |
масив об’єктів; дані підписів Проміжного складу |
|
|
customer |
OB |
масив об’єктів; дані підписів Замовника |
|
|
expeditor |
FW |
масив об’єктів; дані підписів Експедитора |
|
|
carrier_switch |
CH |
масив об’єктів; дані підписів Нового Перевізника |
|
|
security |
COP |
масив об’єктів; дані підписів Охорони |
Приклад запиту
{
"consignee": [
{
"isStamp": false,
"ownerInfo": {
"issuer": "O\u003dТОВ \"Центр сертифікації ключів \"Україна\";CN\u003dКНЕДП ТОВ \"Центр сертифікації ключів \"Україна\";Serial\u003dUA-36865753-2101;C\u003dUA;L\u003dКиїв;OI\u003dNTRUA-36865753",
"issuerCN": "КНЕДП ТОВ \"Центр сертифікації ключів \"Україна\"",
"serial": "5897920700000000000000000000000000000001",
"subject": "O\u003dТОВ \"Вайтдок\";Title\u003d1;CN\u003dІванов Іван Іванович;SN\u003dІванов;GivenName\u003dІван Іванович;Serial\u003d1234567890D;C\u003dUA;L\u003dмісто КИЇВ",
"subjCN": "Іванов Іван Іванович",
"subjOrg": "ТОВ \"Вайтдок\"",
"subjTitle": "1",
"subjLocality": "місто КИЇВ",
"subjFullName": "Іванов Іван Іванович",
"subjEMail": "info@uakey.com.ua",
"subjEDRPOUCode": "12345678",
"subjDRFOCode": "1234567890"
},
"timeInfo": {
"isTimeAvail": true,
"isTimeStamp": true,
"dateTime": 1694158195
},
"certificateInfo": {
"issuer": "O\u003dТОВ \"Центр сертифікації ключів \"Україна\";CN\u003dКНЕДП ТОВ \"Центр сертифікації ключів \"Україна\";Serial\u003dUA-36865753-2101;C\u003dUA;L\u003dКиїв;OI\u003dNTRUA-36865753",
"issuerCN": "КНЕДП ТОВ \"Центр сертифікації ключів \"Україна\"",
"serial": "5897920700000000000000000000000000000001",
"subject": "O\u003dТОВ \"Вайтдок\";Title\u003d1;CN\u003dІванов Іван Іванович;SN\u003dІванов;GivenName\u003dІван Іванович;Serial\u003d1234567890D;C\u003dUA;L\u003dмісто КИЇВ",
"subjCN": "Іванов Іван Іванович",
"subjOrg": "ТОВ \"Вайтдок\"",
"subjTitle": "1",
"subjLocality": "місто КИЇВ",
"subjFullName": "Іванов Іван Іванович",
"subjEMail": "info@uakey.com.ua",
"subjEDRPOUCode": "12345678",
"subjDRFOCode": "1234567890",
"certBeginTime": "Mar 30, 2022, 5:56:29 PM",
"certEndTime": "Mar 29, 2024, 11:59:59 PM",
"privKeyTimesAvail": false,
"privKeyBeginTime": "Mar 30, 2022, 5:56:29 PM",
"privKeyEndTime": "Mar 29, 2024, 11:59:59 PM",
"publicKeyBits": 264,
"publicKey": "33 AC 59 40 D1 B8 6C 6D C3 9D 55 C7 43 A0 51 8F 55 09 6A D4 AA 26 98 86 08 0D 32 B1 71 3D E4 02 00 ",
"publicKeyID": "F1 73 2A 78 C0 F7 86 A2 3D B6 18 AF DE 4A 87 89 20 EE 0C FE F4 A0 12 06 1B 95 BB 0A BD 01 77 1F ",
"issuerPublicKeyID": "52 ED 74 ED 3A E9 49 36 C5 78 B5 A0 60 0B 65 F1 10 09 BF EF 5F 1E ED 43 CD 23 A4 98 F0 7D E3 80 ",
"keyUsage": "ЕЦП, Неспростовність",
"extKeyUsages": "1.2.804.2.1.1.1.11.36865753.1",
"policies": "Правила посиленої сертифікації",
"crlDistribPoint1": "http://uakey.com.ua/list.crl",
"crlDistribPoint2": "http://uakey.com.ua/list-delta.crl",
"powerCert": true,
"subjTypeAvail": false,
"subjCA": false,
"chainLength": 0,
"publicKeyType": 1,
"keyUsageType": 3,
"OCSPAccessInfo": "http://uakey.com.ua/services/ocsp/",
"issuerAccessInfo": "http://uakey.com.ua/uakeycert.p7b",
"TSPAccessInfo": "http://uakey.com.ua/services/tsp/",
"limitValueAvailable": false,
"limitValue": 0,
"subjType": 4,
"subjSubType": 0,
"subjCountry": "UA",
"qscd": false,
"certHashType": 1
}
}
],
"driver": [
{
"isStamp": false,
"ownerInfo": {
"issuer": "O\u003dТОВ \"Центр сертифікації ключів \"Україна\";CN\u003dКНЕДП ТОВ \"Центр сертифікації ключів \"Україна\";Serial\u003dUA-36865753-2101;C\u003dUA;L\u003dКиїв;OI\u003dNTRUA-36865753",
"issuerCN": "КНЕДП ТОВ \"Центр сертифікації ключів \"Україна\"",
"serial": "5897920700000000000000000000000000000001",
"subject": "O\u003dТОВ \"Вайтдок\";Title\u003d1;CN\u003dІванов Іван Іванович;SN\u003dІванов;GivenName\u003dІван Іванович;Serial\u003d1234567890D;C\u003dUA;L\u003dмісто КИЇВ",
"subjCN": "Іванов Іван Іванович",
"subjOrg": "ТОВ \"Вайтдок\"",
"subjTitle": "1",
"subjLocality": "місто КИЇВ",
"subjFullName": "Іванов Іван Іванович",
"subjEMail": "info@uakey.com.ua",
"subjEDRPOUCode": "12345678",
"subjDRFOCode": "1234567890"
},
"timeInfo": {
"isTimeAvail": true,
"isTimeStamp": true,
"dateTime": 1693231021
},
"certificateInfo": {
"issuer": "O\u003dТОВ \"Центр сертифікації ключів \"Україна\";CN\u003dКНЕДП ТОВ \"Центр сертифікації ключів \"Україна\";Serial\u003dUA-36865753-2101;C\u003dUA;L\u003dКиїв;OI\u003dNTRUA-36865753",
"issuerCN": "КНЕДП ТОВ \"Центр сертифікації ключів \"Україна\"",
"serial": "5897920700000000000000000000000000000001",
"subject": "O\u003dТОВ \"Вайтдок\";Title\u003d1;CN\u003dІванов Іван Іванович;SN\u003dІванов;GivenName\u003dІван Іванович;Serial\u003d1234567890D;C\u003dUA;L\u003dмісто КИЇВ",
"subjCN": "Іванов Іван Іванович",
"subjOrg": "ТОВ \"Вайтдок\"",
"subjTitle": "1",
"subjLocality": "місто КИЇВ",
"subjFullName": "Іванов Іван Іванович",
"subjEMail": "info@uakey.com.ua",
"subjEDRPOUCode": "12345678",
"subjDRFOCode": "1234567890",
"certBeginTime": "Mar 30, 2022, 5:56:29 PM",
"certEndTime": "Mar 29, 2024, 11:59:59 PM",
"privKeyTimesAvail": false,
"privKeyBeginTime": "Mar 30, 2022, 5:56:29 PM",
"privKeyEndTime": "Mar 29, 2024, 11:59:59 PM",
"publicKeyBits": 264,
"publicKey": "33 AC 59 40 D1 B8 6C 6D C3 9D 55 C7 43 A0 51 8F 55 09 6A D4 AA 26 98 86 08 0D 32 B1 71 3D E4 02 00 ",
"publicKeyID": "F1 73 2A 78 C0 F7 86 A2 3D B6 18 AF DE 4A 87 89 20 EE 0C FE F4 A0 12 06 1B 95 BB 0A BD 01 77 1F ",
"issuerPublicKeyID": "52 ED 74 ED 3A E9 49 36 C5 78 B5 A0 60 0B 65 F1 10 09 BF EF 5F 1E ED 43 CD 23 A4 98 F0 7D E3 80 ",
"keyUsage": "ЕЦП, Неспростовність",
"extKeyUsages": "1.2.804.2.1.1.1.11.36865753.1",
"policies": "Правила посиленої сертифікації",
"crlDistribPoint1": "http://uakey.com.ua/list.crl",
"crlDistribPoint2": "http://uakey.com.ua/list-delta.crl",
"powerCert": true,
"subjTypeAvail": false,
"subjCA": false,
"chainLength": 0,
"publicKeyType": 1,
"keyUsageType": 3,
"OCSPAccessInfo": "http://uakey.com.ua/services/ocsp/",
"issuerAccessInfo": "http://uakey.com.ua/uakeycert.p7b",
"TSPAccessInfo": "http://uakey.com.ua/services/tsp/",
"limitValueAvailable": false,
"limitValue": 0,
"subjType": 4,
"subjSubType": 0,
"subjCountry": "UA",
"qscd": false,
"certHashType": 1
}
}
],
"carrier":
[
{
"isStamp": false,
"ownerInfo":
{
"issuer": "O=ТОВ \"Центр сертифікації ключів \"Україна\";CN=КНЕДП ТОВ \"Центр сертифікації ключів \"Україна\";Serial=UA-36865753-2101;C=UA;L=Київ;OI=NTRUA-36865753",
"issuerCN": "КНЕДП ТОВ \"Центр сертифікації ключів \"Україна\"",
"serial": "4691660700000000000000000000000000000001",
"subject": "O=ТОВ \"Тест\";CN=Тест Тест Тест;SN=Тест;GivenName=Тест Тест;Serial=1111111111D;C=UA;L=місто КИЇВ",
"subjCN": "Тест Тест Тест",
"subjOrg": "ТОВ \"Тест\"",
"subjLocality": "місто КИЇВ",
"subjFullName": "Тест Тест Тест",
"subjEMail": "info@uakey.com.ua",
"subjEDRPOUCode": "12345678",
"subjDRFOCode": "1111111111"
},
"timeInfo":
{
"isTimeAvail": true,
"isTimeStamp": true,
"dateTime": 1677664504
},
"certificateInfo":
{
"issuer": "O=ТОВ \"Центр сертифікації ключів \"Україна\";CN=КНЕДП ТОВ \"Центр сертифікації ключів \"Україна\";Serial=UA-36865753-2101;C=UA;L=Київ;OI=NTRUA-36865753",
"issuerCN": "КНЕДП ТОВ \"Центр сертифікації ключів \"Україна\"",
"serial": "4691660700000000000000000000000000000001",
"subject": "O=ТОВ \"Тест\";CN=Тест Тест Тест;SN=Тест;GivenName=Тест Тест;Serial=1111111111D;C=UA;L=місто КИЇВ",
"subjCN": "Тест Тест Тест",
"subjOrg": "ТОВ \"Тест\"",
"subjLocality": "місто КИЇВ",
"subjFullName": "Тест Тест Тест",
"subjEMail": "info@uakey.com.ua",
"subjEDRPOUCode": "12345678",
"subjDRFOCode": "1111111111",
"certBeginTime": "Jun 16, 2021, 10:30:43 AM",
"certEndTime": "Jun 15, 2023, 11:59:59 PM",
"privKeyTimesAvail": false,
"privKeyBeginTime": "Jun 16, 2021, 10:30:43 AM",
"privKeyEndTime": "Jun 15, 2023, 11:59:59 PM",
"publicKeyBits": 264,
"publicKey": "14 8C 49 63 CA 4C 0B 0F 80 C6 33 4A FE 2B 7B 34 C8 0C 37 D4 AF CE 42 D7 82 54 11 A0 78 DB 48 6E 00 ",
"publicKeyID": "DF 0E D5 34 E9 61 8C 46 3B 9F 1E C1 94 CE 09 AD 7F 6C B4 01 59 85 54 CE F2 CD 83 0A D0 53 65 B0 ",
"issuerPublicKeyID": "52 ED 74 ED 3A E9 49 36 C5 78 B5 A0 60 0B 65 F1 10 09 BF EF 5F 1E ED 43 CD 23 A4 98 F0 7D E3 80 ",
"keyUsage": "ЕЦП, Неспростовність",
"extKeyUsages": "1.2.804.2.1.1.1.11.36865753.1",
"policies": "Правила посиленої сертифікації",
"crlDistribPoint1": "http://uakey.com.ua/list.crl",
"crlDistribPoint2": "http://uakey.com.ua/list-delta.crl",
"powerCert": true,
"subjTypeAvail": false,
"subjCA": false,
"chainLength": 0,
"publicKeyType": 1,
"keyUsageType": 3,
"OCSPAccessInfo": "http://uakey.com.ua/services/ocsp/",
"issuerAccessInfo": "http://uakey.com.ua/uakeycert.p7b",
"TSPAccessInfo": "http://uakey.com.ua/services/tsp/",
"limitValueAvailable": false,
"limitValue": 0,
"subjType": 4,
"subjSubType": 0,
"subjCountry": "UA",
"qscd": false
}
}
],
"consignor": [
{
"isStamp": false,
"ownerInfo": {
"issuer": "O\u003dТОВ \"Центр сертифікації ключів \"Україна\";CN\u003dКНЕДП ТОВ \"Центр сертифікації ключів \"Україна\";Serial\u003dUA-36865753-2101;C\u003dUA;L\u003dКиїв;OI\u003dNTRUA-36865753",
"issuerCN": "КНЕДП ТОВ \"Центр сертифікації ключів \"Україна\"",
"serial": "5897920700000000000000000000000000000001",
"subject": "O\u003dТОВ \"Вайтдок\";Title\u003d1;CN\u003dІванов Іван Іванович;SN\u003dІванов;GivenName\u003dІван Іванович;Serial\u003d1234567890D;C\u003dUA;L\u003dмісто КИЇВ",
"subjCN": "Іванов Іван Іванович",
"subjOrg": "ТОВ \"Вайтдок\"",
"subjTitle": "1",
"subjLocality": "місто КИЇВ",
"subjFullName": "Іванов Іван Іванович",
"subjEMail": "info@uakey.com.ua",
"subjEDRPOUCode": "12345678",
"subjDRFOCode": "1234567890"
},
"timeInfo": {
"isTimeAvail": true,
"isTimeStamp": true,
"dateTime": 1693230800
},
"certificateInfo": {
"issuer": "O\u003dТОВ \"Центр сертифікації ключів \"Україна\";CN\u003dКНЕДП ТОВ \"Центр сертифікації ключів \"Україна\";Serial\u003dUA-36865753-2101;C\u003dUA;L\u003dКиїв;OI\u003dNTRUA-36865753",
"issuerCN": "КНЕДП ТОВ \"Центр сертифікації ключів \"Україна\"",
"serial": "5897920700000000000000000000000000000001",
"subject": "O\u003dТОВ \"Вайтдок\";Title\u003d1;CN\u003dІванов Іван Іванович;SN\u003dІванов;GivenName\u003dІван Іванович;Serial\u003d1234567890D;C\u003dUA;L\u003dмісто КИЇВ",
"subjCN": "Іванов Іван Іванович",
"subjOrg": "ТОВ \"Вайтдок\"",
"subjTitle": "1",
"subjLocality": "місто КИЇВ",
"subjFullName": "Іванов Іван Іванович",
"subjEMail": "info@uakey.com.ua",
"subjEDRPOUCode": "12345678",
"subjDRFOCode": "1234567890",
"certBeginTime": "Mar 30, 2022, 5:56:29 PM",
"certEndTime": "Mar 29, 2024, 11:59:59 PM",
"privKeyTimesAvail": false,
"privKeyBeginTime": "Mar 30, 2022, 5:56:29 PM",
"privKeyEndTime": "Mar 29, 2024, 11:59:59 PM",
"publicKeyBits": 264,
"publicKey": "33 AC 59 40 D1 B8 6C 6D C3 9D 55 C7 43 A0 51 8F 55 09 6A D4 AA 26 98 86 08 0D 32 B1 71 3D E4 02 00 ",
"publicKeyID": "F1 73 2A 78 C0 F7 86 A2 3D B6 18 AF DE 4A 87 89 20 EE 0C FE F4 A0 12 06 1B 95 BB 0A BD 01 77 1F ",
"issuerPublicKeyID": "52 ED 74 ED 3A E9 49 36 C5 78 B5 A0 60 0B 65 F1 10 09 BF EF 5F 1E ED 43 CD 23 A4 98 F0 7D E3 80 ",
"keyUsage": "ЕЦП, Неспростовність",
"extKeyUsages": "1.2.804.2.1.1.1.11.36865753.1",
"policies": "Правила посиленої сертифікації",
"crlDistribPoint1": "http://uakey.com.ua/list.crl",
"crlDistribPoint2": "http://uakey.com.ua/list-delta.crl",
"powerCert": true,
"subjTypeAvail": false,
"subjCA": false,
"chainLength": 0,
"publicKeyType": 1,
"keyUsageType": 3,
"OCSPAccessInfo": "http://uakey.com.ua/services/ocsp/",
"issuerAccessInfo": "http://uakey.com.ua/uakeycert.p7b",
"TSPAccessInfo": "http://uakey.com.ua/services/tsp/",
"limitValueAvailable": false,
"limitValue": 0,
"subjType": 4,
"subjSubType": 0,
"subjCountry": "UA",
"qscd": false,
"certHashType": 1
}
}
]
}Об’єкт XNovelty (Дані комерційної пропозиції)
Опис параметрів об'єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
novelty_id |
long |
id комерційної пропозиції |
|
novelty_uuid |
UUID |
uuid комерційної пропозиції |
|
status |
int |
Статус комерційної пропозиції
|
|
date_created |
long |
Дата створення (UNIX TimeStamp) |
|
date_changed |
long |
Дата останніх змін (UNIX TimeStamp) |
|
supplier |
String |
GLN Постачальника |
|
retailer |
String |
GLN Мережі |
|
supplier_gln_id |
long |
GLN id Постачальника |
|
retailer_gln_id |
long |
GLN id Мережі |
|
retailer_id |
long |
id Мережі на платформі EDIN |
|
group_id |
int |
id групи товарів |
|
name |
String |
Найменування |
|
barcode |
String |
Штрихкод |
|
brand |
String |
Торгова марка |
|
producer_name |
String |
Виробник |
|
postponement |
int |
Відстрочка платежу (днів) |
|
unit_id |
int |
Код одиниці виміру
|
|
unit_weight |
String |
Вага одиниці виміру (кг) |
|
unit_volume |
String |
Обсяг/об’єм одиниці виміру (літр) |
|
tax_id |
int |
Код ставки ПДВ
|
|
prices |
об’єкт; ціни |
|
|
marketing |
об’єкт; маркетинг |
|
|
trade |
об’єкт; торгівля |
|
|
listex_link |
String |
Посилання на Listex |
|
icon_link |
String |
Посилання на фото товару |
|
comments |
об’єкт; коментарі |
|
|
supplierContacts |
об’єкт; контакти Постачальника |
JSON приклад запиту
{
"novelty_id": 1164,
"novelty_uuid": "9b1b51c6-c0d3-4899-8f73-0d04ee443f66",
"status": 0,
"date_created": 1622625545,
"date_changed": 1622625545,
"supplier": "9864232399285",
"retailer": "9864232377986",
"supplier_gln_id": 179438,
"retailer_gln_id": 174988,
"retailer_id": 17548,
"group_id": 51,
"name": "Багет колоСок",
"barcode": "020202020",
"brand": "Мучне",
"producer_name": "Піч",
"postponement": 1,
"unit_id": 8,
"unit_weight": "250",
"unit_volume": "2",
"tax_id": 5,
"prices": {
"unit_price": "25",
"weight_price": "0.1",
"volume_price": "12.5",
"profitability": "12"
},
"marketing": {
"promotion": "12",
"logistics": "23",
"damage": "34",
"TPR": "34"
},
"trade": {
"national1": "23",
"national2": "12",
"regional1": "32",
"regional2": "45"
},
"icon_link": "https://static.edi-n.com/agreement/novelties/icon/1164.jpg",
"comments": [],
"supplierContacts": {
"surname": "Криптонець",
"name": "Зоряний",
"middleName": "Косоокий",
"email": "jedolab332@edmondpt.com",
"phone": "380000000000",
"uuid": "fa9de12d-a3c1-49d8-8f28-3fb1994eebaa"
}
}
Об’єкт RetailerEsSettings
Опис параметрів об'єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
changePriceTerm |
int |
термін подачі на розгляд регулярних цін |
|
isPriceWithDiscount |
boolean |
робота з ціною зі знижкою |
|
isPriceWithVat |
boolean |
узгодження за ціною з ПДВ |
|
maxNumbersOfAgreements |
int |
максимальна кількість узгоджень |
|
isChangePricePeriod |
boolean |
доступ до зміни термінів дії |
|
changePromoPriceTerm |
int |
термін подачі на розгляд промо цін |
|
changeLastingTerm |
int |
період дії регулярних цін (за замовчуванням) |
|
changePromoLastingTerm |
int |
період дії промо цін (за замовчуванням) |
|
changeOutputGoodsTerm |
int |
термін подачі на розгляд призупинки/виводу товарів |
|
isNewPositions |
boolean |
відображення списка мереж на стороні Постачальника у вкладці Новинки |
|
isExtendedSpec |
boolean |
тільки розширені характеристики |
|
isOutputGoods |
boolean |
призупинка/вивід товарів з асортимента |
|
isTypePromo |
boolean |
узгодження промо ціни |
|
isPromoQuantity |
boolean |
відображення колонки Кількість товарів промо |
|
isExtendedSpecUcat |
boolean |
тільки розширені характеристики Ucat |
|
isSignUnBlock |
boolean |
можливо підписувати «Товарну специфікацію» (COMDOC_008) за день до початку дії ціни |
|
isProlongationContract |
boolean |
автоматична пролонгація контракту |
|
isNewSupplier |
boolean |
нові постачальники |
|
isReplaceProductlistData |
boolean |
попередня очистка «Електронної специфікації» (PRODUCTLIST) |
|
isActionControl |
boolean |
керування акціями |
|
isWorkWithUKTVED |
boolean |
робота з кодом УКТЗЕД |
JSON:
{
"changePriceTerm": 1,
"isPriceWithDiscount": false,
"isPriceWithVat": false,
"maxNumbersOfAgreements": 0,
"isChangePricePeriod": true,
"changePromoPriceTerm": 2,
"changeLastingTerm": 0,
"changePromoLastingTerm": 0,
"changeOutputGoodsTerm": 2,
"isNewPositions": true,
"isExtendedSpec": false,
"isOutputGoods": true,
"isTypePromo": false,
"isPromoQuantity": false,
"isExtendedSpecUcat": false,
"isSignUnBlock": false,
"isProlongationContract": false,
"isNewSupplier": true,
"isReplaceProductlistData": true,
"isActionControl": true,
"isWorkWithUKTVED": false
}
Об’єкт XAgreemDocStatus
Опис параметрів об'єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
id |
int |
id статусу
|
|
name |
String |
назва статусу |
|
description |
String |
опис статусу |
Об’єкт XAgreemDoc
Об'єкт використовується для отримання даних по перегляду пропозицій, а також для отримання даних комерційної пропозиції / товарного узгодження
Опис параметрів об'єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
body |
Map<Integer, byte[]> |
тіло документа |
|
indexes |
Map<String, String> |
набір параметрів для фільтрації
|
|
childs |
List<XAgreemDoc> |
дочірні документи |
|
id |
long |
id документу |
|
uuid |
UUID |
GUID документу |
|
parentDocId |
transient long |
id батьківського документу; число |
|
parentDocUUID |
UUID |
GUID батьківського документу |
|
sender |
long |
GLN відправника; число |
|
recipient |
long |
GLN одержувача; число |
|
retailerId |
long |
id мережі (ритейлера); число |
|
contractUUID |
UUID |
GUID контракту / договору |
|
status |
статус узгодження; число |
|
|
type |
int |
тип документа; число
|
|
dateCreated |
long |
дата створення документа; число |
|
dateChanged |
long |
дата зміни документа; число |
|
docDate |
long |
дата з документу; число |
|
docNumber |
String |
номер документу |
|
isArchive |
Boolean |
відмітка про те, що документ оброблений (архівний) |
JSON приклади відповіді:
Отримання списку документів в журналі
[
{
"body": {},
"indexes": {
"isComments": "false",
"isSigns": "false",
"rejected": "0",
"count": "2",
"isRead": "false",
"isAttaches": "false",
"isTags": "false",
"increase": "0",
"confirmed": "0",
"decrease": "0",
"isFavorite": "false"
},
"childs": [],
"id": 369,
"uuid": "1168fc16-6473-4c82-9fbe-4d2ba210fafa",
"sender": 13200665,
"recipient": 41249,
"retailerId": 7,
"contractUUID": "cd0d1033-a442-4971-8f94-abab35e36414",
"status": {
"id": 12,
"name": "sub_onagreement"
},
"type": 2,
"dateCreated": 1588861558,
"dateChanged": 1588861558,
"docDate": 1588859657,
"docNumber": "JJJ"
},
{
"body": {},
"indexes": {
"isComments": "false",
"isSigns": "false",
"rejected": "0",
"count": "2",
"isRead": "false",
"isAttaches": "false",
"isTags": "false",
"increase": "0",
"confirmed": "0",
"decrease": "0",
"isFavorite": "false"
},
"childs": [],
"id": 368,
"uuid": "1cac7b65-46a0-4924-9611-29967aca3ec5",
"sender": 13200665,
"recipient": 41249,
"retailerId": 7,
"contractUUID": "cd0d1033-a442-4971-8f94-abab35e36414",
"status": {
"id": 12,
"name": "sub_onagreement"
},
"type": 1,
"dateCreated": 1588856745,
"dateChanged": 1588856745,
"docDate": 1588857,
"docNumber": "Time-03"
},
{
"body": {},
"indexes": {
"isComments": "false",
"isSigns": "false",
"rejected": "0",
"count": "1",
"isRead": "true",
"isAttaches": "false",
"isTags": "false",
"increase": "0",
"confirmed": "1",
"decrease": "0",
"isFavorite": "false"
},
"childs": [
{
"body": {},
"indexes": {},
"childs": [],
"id": 367,
"uuid": "78d27dce-0576-450f-83bb-14b8467d94cf",
"parentDocUUID": "5b19556e-65ab-40e9-b397-64f6183e35b3",
"sender": 41249,
"recipient": 13200665,
"retailerId": 7,
"contractUUID": "ebe77c79-85fc-4c58-a07b-833caac25d65",
"status": {
"id": 3,
"name": "onagreement"
},
"type": 2,
"dateCreated": 1588853003,
"dateChanged": 1588853003,
"docDate": 1588853003,
"docNumber": "Time-02"
}
],
"id": 366,
"uuid": "5b19556e-65ab-40e9-b397-64f6183e35b3",
"sender": 13200665,
"recipient": 41249,
"retailerId": 7,
"contractUUID": "ebe77c79-85fc-4c58-a07b-833caac25d65",
"status": {
"id": 6,
"name": "onsigning2"
},
"type": 1,
"dateCreated": 1588850830,
"dateChanged": 1588852976,
"docDate": 0,
"docNumber": "Time-02"
}
]
Отримання даних комерційної пропозиції / товарного узгодження
{
"body": {},
"indexes": {
"isComments": "false",
"isSigns": "false",
"rejected": "0",
"count": "2",
"isRead": "false",
"isAttaches": "false",
"isTags": "false",
"increase": "0",
"confirmed": "0",
"decrease": "0",
"isFavorite": "false"
},
"childs": [],
"id": 369,
"uuid": "1168fc16-6473-4c82-9fbe-4d2ba210fafa",
"sender": 13200665,
"recipient": 41249,
"retailerId": 7,
"contractUUID": "cd0d1033-a442-4971-8f94-abab35e36414",
"status": {
"id": 12,
"name": "sub_onagreement"
},
"type": 2,
"dateCreated": 1588861558,
"dateChanged": 1588861558,
"docDate": 1588859657,
"docNumber": "JJJ"
}
Перегляд даних документів-узгоджень
[
{
"body": {},
"indexes": {
"isSigns": "false",
"flag": "0",
"discount_increase": "0",
"rejected": "0",
"count": "1",
"isRead": "true",
"isAttaches": "false",
"isTags": "false",
"increase": "0",
"confirmed": "0",
"decrease": "0",
"isComments": "false",
"afterDeadline": "false",
"rejection_reason": "проверка раз раз как-то так раз два три, ну всем понятно, Отклоняю док как тока могу по полной",
"discount_decrease": "0",
"lastSignDate": "undefined",
"isFavorite": "false"
},
"childs": [],
"id": 1930,
"uuid": "49b8640a-8393-4235-a506-696eecc14c3c",
"sender": 13200665,
"recipient": 41249,
"retailerId": 7,
"contractUUID": "cb35cd0c-1b3d-45d8-b96f-b49b34c9153f",
"status": {
"id": 4,
"name": "rejected",
"description": "Відхилено"
},
"type": 1,
"dateCreated": 1631101503,
"dateChanged": 1631101958,
"docDate": 1631101502,
"docNumber": "2000001011",
"isArchive": false
},
{
"body": {},
"indexes": {
"isSigns": "false",
"flag": "0",
"discount_increase": "0",
"rejected": "0",
"count": "1",
"isRead": "true",
"isAttaches": "false",
"isTags": "false",
"increase": "0",
"confirmed": "0",
"decrease": "0",
"isComments": "false",
"afterDeadline": "false",
"discount_decrease": "0",
"lastSignDate": "undefined",
"isFavorite": "false"
},
"childs": [],
"id": 1912,
"uuid": "8f9efb2e-022b-450a-92d4-6f2b32bf5f99",
"sender": 13200665,
"recipient": 41249,
"retailerId": 7,
"contractUUID": "cb35cd0c-1b3d-45d8-b96f-b49b34c9153f",
"status": {
"id": 3,
"name": "onagreement",
"description": "На узгодженні"
},
"type": 1,
"dateCreated": 1630922241,
"dateChanged": 1630922251,
"docDate": 1630922240,
"docNumber": "2000001004",
"isArchive": false
},
{
"body": {},
"indexes": {
"isSigns": "false",
"flag": "0",
"discount_increase": "0",
"rejected": "0",
"count": "1",
"isRead": "false",
"isAttaches": "false",
"isTags": "false",
"increase": "0",
"confirmed": "0",
"decrease": "0",
"isComments": "false",
"afterDeadline": "false",
"discount_decrease": "0",
"lastSignDate": "undefined",
"isFavorite": "false"
},
"childs": [],
"id": 1910,
"uuid": "e74c280a-8db6-4079-b6e7-0375014f7c7f",
"sender": 13200665,
"recipient": 41249,
"retailerId": 7,
"contractUUID": "cb35cd0c-1b3d-45d8-b96f-b49b34c9153f",
"status": {
"id": 3,
"name": "onagreement",
"description": "На узгодженні"
},
"type": 1,
"dateCreated": 1630922196,
"dateChanged": 1630922207,
"docDate": 1630922195,
"docNumber": "2000001003",
"isArchive": false
},
{
"body": {},
"indexes": {
"isSigns": "false",
"flag": "0",
"discount_increase": "0",
"rejected": "0",
"count": "2",
"isRead": "true",
"isAttaches": "false",
"isTags": "false",
"increase": "0",
"confirmed": "0",
"decrease": "0",
"isComments": "false",
"afterDeadline": "false",
"rejection_reason": "Отклонение",
"discount_decrease": "0",
"lastSignDate": "undefined",
"isFavorite": "false"
},
"childs": [],
"id": 1900,
"uuid": "e44d62d5-9ffd-4e5b-b704-9cd47c2ff141",
"sender": 13200665,
"recipient": 41249,
"retailerId": 7,
"contractUUID": "cb35cd0c-1b3d-45d8-b96f-b49b34c9153f",
"status": {
"id": 4,
"name": "rejected",
"description": "Відхилено"
},
"type": 1,
"dateCreated": 1630917718,
"dateChanged": 1630920092,
"docDate": 1630917718,
"docNumber": "2000000998",
"isArchive": false
},
{
"body": {},
"indexes": {
"lastSignDate": "undefined"
},
"childs": [],
"id": 1894,
"uuid": "bb1e3f94-320a-4f36-b45c-6245b15a7616",
"sender": 13200665,
"recipient": 41249,
"retailerId": 7,
"contractUUID": "cb35cd0c-1b3d-45d8-b96f-b49b34c9153f",
"status": {
"id": 1,
"name": "draft",
"description": "Чернетка"
},
"type": 1,
"dateCreated": 1630851806,
"dateChanged": 1630851806,
"docDate": 1630851807,
"docNumber": "2000000995",
"isArchive": false
},
{
"body": {},
"indexes": {
"isSigns": "false",
"flag": "0",
"discount_increase": "0",
"rejected": "0",
"count": "1",
"isRead": "false",
"isAttaches": "false",
"isTags": "false",
"increase": "0",
"confirmed": "0",
"decrease": "0",
"isComments": "false",
"afterDeadline": "false",
"discount_decrease": "0",
"lastSignDate": "undefined",
"isFavorite": "false"
},
"childs": [],
"id": 1892,
"uuid": "049cdec2-10ab-4233-a5a2-e497ae199d33",
"sender": 13200665,
"recipient": 41249,
"retailerId": 7,
"contractUUID": "cb35cd0c-1b3d-45d8-b96f-b49b34c9153f",
"status": {
"id": 3,
"name": "onagreement",
"description": "На узгодженні"
},
"type": 1,
"dateCreated": 1630851450,
"dateChanged": 1630851507,
"docDate": 1630851451,
"docNumber": "2000000994",
"isArchive": false
},
{
"body": {},
"indexes": {
"lastSignDate": "undefined"
},
"childs": [],
"id": 1890,
"uuid": "698a7a22-f983-4b0e-8f59-62d9204ea681",
"sender": 13200665,
"recipient": 41249,
"retailerId": 7,
"contractUUID": "cb35cd0c-1b3d-45d8-b96f-b49b34c9153f",
"status": {
"id": 1,
"name": "draft",
"description": "Чернетка"
},
"type": 1,
"dateCreated": 1630851109,
"dateChanged": 1630851109,
"docDate": 1630851109,
"docNumber": "2000000993",
"isArchive": false
},
{
"body": {},
"indexes": {
"isSigns": "false",
"flag": "0",
"discount_increase": "0",
"rejected": "0",
"count": "1",
"isRead": "false",
"isAttaches": "false",
"isTags": "false",
"increase": "0",
"confirmed": "0",
"decrease": "0",
"isComments": "false",
"afterDeadline": "false",
"discount_decrease": "0",
"lastSignDate": "undefined",
"isFavorite": "false"
},
"childs": [],
"id": 1888,
"uuid": "a92a664c-3977-4858-8737-e2a634e2b3c5",
"sender": 13200665,
"recipient": 41249,
"retailerId": 7,
"contractUUID": "cb35cd0c-1b3d-45d8-b96f-b49b34c9153f",
"status": {
"id": 3,
"name": "onagreement",
"description": "На узгодженні"
},
"type": 1,
"dateCreated": 1630686290,
"dateChanged": 1630686340,
"docDate": 1630686291,
"docNumber": "2000000992",
"isArchive": false
},
{
"body": {},
"indexes": {
"isSigns": "false",
"flag": "0",
"discount_increase": "0",
"rejected": "0",
"count": "2",
"isRead": "true",
"isAttaches": "false",
"isTags": "false",
"increase": "0",
"confirmed": "0",
"decrease": "0",
"isComments": "false",
"afterDeadline": "false",
"rejection_reason": "Отклонение",
"discount_decrease": "0",
"lastSignDate": "undefined",
"isFavorite": "false"
},
"childs": [],
"id": 1886,
"uuid": "bcf032f9-3411-4d9f-b6c8-4ac7f34d728f",
"sender": 13200665,
"recipient": 41249,
"retailerId": 7,
"contractUUID": "cb35cd0c-1b3d-45d8-b96f-b49b34c9153f",
"status": {
"id": 4,
"name": "rejected",
"description": "Відхилено"
},
"type": 1,
"dateCreated": 1630674569,
"dateChanged": 1630678024,
"docDate": 1630674568,
"docNumber": "2000000991",
"isArchive": false
}
]
Об’єкт XSearchContractsQuery (Критерії пошуку/фільтрації довідника специфікацій/контрактів)
Опис параметрів об'єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
direction |
об’єкт; напрямок документообігу; вказуються відправник, отримувач і зв’язок між ними в умовах відбору документів |
|
|
contractGlnId |
List<Long> |
масив; id Gln-у контракту/специфікації |
|
contractGln |
List<String> |
масив; Gln-у контракту/специфікації |
|
productBarcode |
List<String> |
масив; список товарних штрихкодів |
|
buyerArticle |
List<String> |
масив; артикул продавця |
|
retailerId |
Long |
id мережі (ритейлера) |
|
retailers |
List<Long> |
масив; список мереж (ритейлерів) |
|
contractStatus |
List<Integer> |
масив; список статусів контрактів: 1 - активний, 2 - неактивний / видалений |
|
productStatus |
List<Integer> |
масив; список статусів товарів: 1 - активний, 2 - неактивний / видалений |
|
number |
String |
номер специфікації |
|
subContractNumber |
String |
номер договору |
|
expireDate |
об’єкт; дата закінчення специфікації (в форматі UNIX-timestamp) з / по |
|
|
subContractExpireDate |
об’єкт; дата договору (в форматі UNIX-timestamp) з / по |
|
|
changeDate |
об’єкт; дата зміни специфікації (в форматі UNIX-timestamp) з / по |
|
|
limit |
об’єкт; фільтр відбору (налаштування виводу даних) |
JSON приклад запиту для отримання всіх завершених контрактів / специфікацій для Отримувача «13200665»:
{
"contractGlnId": [],
"productBarcode": [],
"buyerArticle": [],
"contractStatus": [],
"productStatus": [],
"direction": {
"type": "EQ",
"recipient": [
13200665
]
},
"expireDate": {
"startTimestamp": 1631353973
}
}
Об’єкт RemoveProductDetail
Опис параметрів об'єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
productID |
long |
id товарної позиції, що була в запиті на видалення |
|
removed |
boolean |
чи видалено товарну позицію з контракту |
|
cause |
String |
якщо [removed == false] - указана причина неможливості видалити товарну позицію (наприклад, відсутність позиції в контракті) |
Об’єкт RemoveProductResponse (Деталі результату операції видалення)
Опис параметрів обєкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
contractUUID |
UUID |
uuid контракту |
|
removedContract |
boolean |
чи видалено весь контракт |
|
contractProducts |
int |
кількість позицій в контракті |
|
requestProducts |
int |
кількість позицій в запиті на видалення |
|
removedProducts |
int |
кількість видалених позицій |
|
details |
List<RemoveProductDetail> |
масив об’єктів; деталі виконання операції видалення для кожної позиції |
JSON приклад відповіді при видаленні товарних позицій
{
"contractProducts": 2,
"contractUUID": "43cea8c2-320a-439b-a596-d39c0ad0f0f8",
"details": [
{
"cause": "XContract 43cea8c2-320a-439b-a596-d39c0ad0f0f8 does not have product ID 0",
"productID": 0,
"removed": false
},
{
"cause": "XContract 43cea8c2-320a-439b-a596-d39c0ad0f0f8 does not have product ID 21212121",
"productID": 21212121,
"removed": false
},
{
"productID": 113,
"removed": true
}
],
"removedContract": false,
"removedProducts": 1,
"requestProducts": 3
}
JSON приклад відповіді при видаленні всього контракту
{
"contractUUID": "41bee947-abfc-471a-86e6-4c85f813ad9f",
"removedContract": true,
"contractProducts": 51,
"requestProducts": 0,
"removedProducts": 51,
"details": [
{
"productID": 2,
"removed": true
},
{
"productID": 3,
"removed": true
},
...
{
"productID": 50,
"removed": true
},
{
"productID": 51,
"removed": true
},
{
"productID": 52,
"removed": true
}
]
}
Об’єкт XContractProduct
Опис параметрів об'єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
id |
long |
id документа |
|
contractId |
long |
id контракту / договору; |
|
barcode |
String |
штрих-код продукту |
|
product |
XProduct |
список товарних позицій |
|
buyerArticle |
String |
артикул покупця |
|
status |
int |
статус узгодження; число |
|
dateFrom |
int |
дата початку дії асортименту |
|
dateTo |
int |
дата закінчення дії асортименту |
|
content |
byte[] |
набір байт; закодоване в utf8 JSON-тіло позиції (сервіс онлайн дешифрування) |
Об’єкт XContract (Контракти)
Опис параметрів об'єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
products |
List<XContractProduct> |
список товарних позицій |
|
id |
long |
id контракту / договору; |
|
uuid |
UUID |
GUID контракту / договору; число |
|
retailerId |
long |
id мережі (ритейлера); |
|
sender |
long |
ID GLN відправника; число |
|
senderGln |
String(13) |
GLN одержувача |
|
recipient |
long |
ID GLN одержувача; число |
|
recipientGln |
String(13) |
GLN одержувача |
|
number |
String |
номер контракту / договору; число |
|
expireDate |
long |
дата закінчення дії договору |
|
description |
String |
опис / коментарі |
|
subContractNumber |
String |
номер дочірнього договору |
|
subContractExpireDate |
long |
дата закінчення дії дочірнього договору |
|
contractGlnId |
long |
ID GLN-ну контракту/специфікації |
|
contractGln |
String(13) |
GLN контракту/специфікації |
|
reviewDeadLine |
int |
кількість днів на розгляд |
|
agrementsNumber |
int |
допустима кількість погоджень |
|
discountWorkStatus |
int |
робота з ціною зі знижкою: 0-ні, 1-так |
|
changeDate |
long |
дата зміни документу |
|
prolongationContract |
int |
автоматична пролонгація контракту; 0-ні, 1-так |
|
region |
String |
код регіону; число |
|
content |
byte[] |
набір байт; закодоване в utf8 JSON-тіло документа PRODUCTLIST (сервіс онлайн дешифрування) |
JSON приклади відповіді:
[
{
"products": [],
"id": 8,
"uuid": "ebe77c79-85fc-4c58-a07b-833caac25d65",
"retailerId": 7,
"sender": 41249,
"recipient": 13200665,
"number": "1200.996633",
"expireDate": 1590872400,
"description": "Карантин",
"subContractNumber": "1200",
"subContractExpireDate": 1595797200,
"contractGlnId": 41249,
"reviewDeadLine": 24,
"agrementsNumber": 5,
"discountWorkStatus": 3,
"changeDate": 1588673640,
"prolongationContract": 0
},
{
"products": [],
"id": 7,
"uuid": "eac52f9f-1487-43e4-8eeb-88c61136dd84",
"retailerId": 7,
"sender": 41249,
"recipient": 13200665,
"number": "1200.66333",
"expireDate": 1585602000,
"description": "Отходы",
"subContractNumber": "1200",
"subContractExpireDate": 1595797200,
"contractGlnId": 41249,
"reviewDeadLine": 24,
"agrementsNumber": 5,
"discountWorkStatus": 0,
"changeDate": 1583324665,
"prolongationContract": 0
},
{
"products": [],
"id": 6,
"uuid": "2ca3ce28-0b13-4163-b7c4-e5c178114ab2",
"retailerId": 7,
"sender": 41249,
"recipient": 13200665,
"number": "98765.12345",
"expireDate": 1609365600,
"description": "Пятница - хороший день",
"subContractNumber": "98765",
"subContractExpireDate": 1574719200,
"contractGlnId": 41249,
"reviewDeadLine": 24,
"agrementsNumber": 5,
"discountWorkStatus": 0,
"changeDate": 1582301296,
"prolongationContract": 0
}
]
[
{
"products": [],
"id": 922,
"uuid": "cb35cd0c-1b3d-45d8-b96f-b49b34c9153f",
"retailerId": 7,
"sender": 41249,
"recipient": 13200665,
"number": "666.333333",
"expireDate": 1640901600,
"status": {
"code": 1,
"description": "Активный"
},
"description": "МясоНеСодержащие",
"subContractNumber": "666",
"subContractExpireDate": 1630443600,
"contractGlnId": 41249,
"reviewDeadLine": 24,
"agrementsNumber": 5,
"discountWorkStatus": 3,
"changeDate": 1630503488,
"prolongationContract": 0
},
{
"products": [],
"id": 12,
"uuid": "ebe77c79-85fc-4c58-a07b-833caac25d65",
"retailerId": 7,
"sender": 41249,
"recipient": 13200665,
"number": "1200.996633",
"expireDate": 1672437600,
"status": {
"code": 1,
"description": "Активный"
},
"description": "Карантин",
"subContractNumber": "1200",
"subContractExpireDate": 1609365600,
"contractGlnId": 41249,
"reviewDeadLine": 0,
"agrementsNumber": 5,
"discountWorkStatus": 3,
"changeDate": 1609365600,
"prolongationContract": 0
},
{
"products": [],
"id": 4,
"uuid": "e940fe80-1b9d-4240-aa71-52a7eafc2afe",
"retailerId": 16244,
"sender": 54968,
"recipient": 13200665,
"number": "1000.50001",
"expireDate": 1652907600,
"status": {
"code": 1,
"description": "Активный"
},
"description": "Носочки, резиночки",
"subContractNumber": "1000",
"subContractExpireDate": 1529701200,
"contractGlnId": 54968,
"reviewDeadLine": 0,
"agrementsNumber": 0,
"discountWorkStatus": 0,
"changeDate": 1569844604,
"prolongationContract": 0
}
]
Об’єкт XAgreemDocAttachment
Опис параметрів об'єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
attachment_id |
long |
ідентифікатор вкладення |
|
comment_id |
long |
ідентифікатор коментаря |
|
file_name |
String |
назва файлу |
|
file_type |
String |
тип файлу згідно MIME типізації |
|
content |
byte[] |
тіло вкладення |
JSON приклад відповіді (Інформація про вкладення до пропозиції товарного переузгодження чи конкретного коментаря документа)
[
{
"attachment_id": 610,
"comment_id": 0,
"file_name": "1625493467304.png",
"file_type": "image/png"
},
{
"attachment_id": 612,
"comment_id": 0,
"file_name": "1624010092199.png",
"file_type": "image/png"
},
{
"attachment_id": 614,
"comment_id": 0,
"file_name": "323232323.png",
"file_type": "image/png"
}
]
Об’єкт XAgreemDocComment
Опис параметрів об'єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
id |
long |
id коментаря |
|
docId |
long |
id документа (пропозиції) |
|
date |
long |
дата коментаря |
|
user |
String |
id користувача |
|
comment |
String |
текст коментаря |
|
attachments |
List<XAgreemDocAttachment> |
масив об’єктів; дані файла-вкладення |
JSON приклад відповіді при створенні коментаря
{
"id": 436,
"docId": 1664,
"date": 1625662188,
"user": "uatestuserfx01",
"comment": "text comment",
"attachments": [
{
"attachment_id": 646,
"comment_id": 436,
"file_name": "Модель Кеневин (Cynefin framework).pdf",
"file_type": "application/pdf"
},
{
"attachment_id": 648,
"comment_id": 436,
"file_name": "1625493467304.png",
"file_type": "image/png"
},
{
"attachment_id": 650,
"comment_id": 436,
"file_name": "323232323.png",
"file_type": "image/png"
}
]
}
JSON приклад відповіді при отриманні списку коментарів
[
{
"docId": 378,
"date": 1589454390,
"user": "uatestuserfx01",
"comment": "qwertyui"
},
{
"docId": 378,
"date": 1589454390,
"user": "uatestuserfx01",
"comment": "helloworld"
}
]
Об’єкт SpecStatus
Об'єкт SpecStatus використовується для
- налаштування дій узгодження для вказаного користувача в розрізі кожного підтипу документа AGREEM.
-
вказання нових дій узгодження в розрізі кожного підтипу документа AGREEM
Опис параметрів об'єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
userId |
long |
ID користувача |
|
isSpecification |
int |
доступ до сервісу Е-Специфікація (0-ні; 1-так) |
|
isContractDivide |
boolean |
підв’язаний контракт (за GLN роздрібної мережі) |
|
isViewStatusDivide |
boolean |
відображати документи |
|
writeStatuses |
Map<String, Integer> |
підтип документа:
|
|
workStatuses |
Map<String, Integer> |
підтип документа:
|
Доступні значення статусів для вказання нових дій узгодження:
-
12 - На узгодженні (на стороні мережі)
-
13 - Підготовлено (на стороні мережі)
-
14 - Готовий до підписання (на стороні мережі)
-
15 - Погоджено (на стороні мережі)
-
17 - Перевірено (на стороні мережі)
-
18 - Підтверджено (на стороні мережі)
-
19 - Підписання постачальником (на стороні мережі)
-
20 - Підписання мережею (на стороні мережі)
JSON приклад налаштування дій узгодження для вказаного користувача в розрізі кожного підтипу документа AGREEM:
{
"userId": 13191,
"isSpecification": 1,
"isContractDivide": true,
"isViewStatusDivide": true,
"writeStatuses": {
"offer": 26,
"promo_combo": 14,
"regular": 14
},
"workStatuses": {
"offer": 4,
"promo_combo": 12,
"regular": 12
}
}
JSON приклад вказання нових дій узгодження в розрізі кожного підтипу документа AGREEM:
{
"writeStatuses": {
"offer": 26,
"promo": 14,
"promo_compensation": 12,
"promo_combo": 12,
"regular": 14
},
"workStatuses": {
"offer": 21,
"promo": 12,
"promo_compensation": 12,
"promo_combo": 12,
"regular": 12
}
}
Об'єкт DistribexOrderParams
Опис параметрів обʼєкта
|
Параметр |
Формат |
Опис |
|
senderName |
String |
імʼя відправника |
| senderLastName | String | прізвище відправника |
| senderPhone | String | телефон відправника |
Приклад
[
{
"senderName": "Микола",
"senderLastName": "Стрига",
"senderPhone": "380967929292"
}
]Об’єкт XChainStatus
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
Об’єкт XChainStatus |
||
|
state |
int |
id статусу |
|
title |
String |
статус |
Опис ChainStatus параметрів
|
id статусу |
статус |
|---|---|
|
0 |
ALL - будь-який статус |
|
1 |
OPEN - чернетка (відправник) |
|
2 |
SENT - відправлений (відправник) |
|
3 |
DELIVERED - доставлений (відправник) |
|
4 |
INBOX - вхідний (одержувач) |
|
5 |
READ - прочитаний (одержувач) |
|
6 |
ERROR - помилка |
|
7 |
DELETED - видалений |
Об’єкт XChain
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
id |
long |
ID ланцюжка |
|
uuid |
UUID |
UUID ланцюжка документів |
|
packageID |
long |
ID пакета |
|
type |
об’єкт; тип документа |
|
|
docsCount |
int |
кількість документів в ланцюжку |
|
lastInDocID |
long |
id останнього вхідного документа в ланцюжку |
|
lastOutDocID |
long |
id останнього вихідного документа в ланцюжку |
|
partnerId |
long |
id роздрібної мережі |
|
important |
boolean |
відмітка важливий документ |
|
status |
об’єкт; статус пари документів у відправника і одержувача |
|
|
visualStatus |
int |
номер іконки |
|
archive |
boolean |
відмітка; Архівний документ чи ні |
|
childs |
List<XDoc> |
масив об’єктів; дані документів/квитанцій |
|
chainsInPackage |
List<XChain> |
масив об’єктів; дані пов’язаних ланцюжків |
|
hash |
String |
хеш-значення, отримане в результаті обробки |
JSON приклад
{
"id": 1,
"uuid": "0fe60377-51db-4b7a-b7eb-cdf5fa91a46a",
"packageID": 0,
"type": {
"type": 5,
"title": "ordrsp",
"description": "Подтверждение заказа"
},
"docsCount": 13,
"lastInDocID": 1,
"lastOutDocID": 29,
"partnerId": 0,
"important": false,
"status": {
"status": 2,
"title": "sent"
},
"visualStatus": 0,
"archive": false,
"childs": [
{
"body": {
"forms": {}
},
"attachments": [],
"comments": [],
"doc_id": 1,
"doc_uuid": "bf8dacb1-7b61-4c9c-ab36-ac37620db051",
"uuidSender": "9864232304319",
"uuidReceiver": "9864232304302",
"docNumber": "1001",
"dateCreated": 1555487166,
"dateChanged": 1555487166,
"dateRead": 1555497325,
"docDate": 1555448400,
"chain_id": 1,
"chain_uuid": "0fe60377-51db-4b7a-b7eb-cdf5fa91a46a",
"family": 1,
"hash": "A1FF5B519289B936A09E99514277F429",
"type": {
"type": 2,
"title": "orders",
"description": "Заказ"
},
"status": {
"status": 5,
"title": "read"
},
"exchange_status": "000000000000000000000000",
"is_archive": false,
"extraFields": {
"sub_doc_type_id": "2",
"buyer_uuid": "9864232304319",
"doc_num": "1001",
"order_number": "1001",
"ftpex_file_date": "1555487160",
"supplier_uuid": "9864232304302",
"delivery_place_uuid": "9864232304562",
"order_date": "1555448400",
"delivery_date": "1556485200",
"ftpex_file_name": "order_20190417104600_475593380.xml",
"contract_number": "Дог 1",
"sender": "9864232304319",
"doc_date": "1555448400",
"recipient": "9864232304302",
"action": "0"
},
"tags": [],
"statuses": [],
"multiExtraFields": {}
},
...
{
"body": {
"forms": {}
},
"attachments": [],
"comments": [],
"doc_id": 29,
"doc_uuid": "cb2f183f-ccbc-467b-9eb2-90b2c1ff8f5c",
"uuidSender": "9864232304302",
"uuidReceiver": "9864232304319",
"docNumber": "АФ00-000001",
"dateCreated": 1556115021,
"dateChanged": 1556115022,
"dateRead": 0,
"docDate": 1556116482,
"chain_id": 1,
"chain_uuid": "0fe60377-51db-4b7a-b7eb-cdf5fa91a46a",
"family": 1,
"hash": "0F9CEEC0717992EB76A848F2E106D2D0",
"type": {
"type": 5,
"title": "ordrsp",
"description": "Подтверждение заказа"
},
"status": {
"status": 2,
"title": "sent"
},
"exchange_status": "000000000000000000000000",
"is_archive": false,
"extraFields": {
"order_date": "1555448400",
"delivery_date": "1556485200",
"contract_number": "Дог 1",
"sender": "9864232304319",
"buyer_uuid": "9864232304319",
"doc_num": "АФ00-000001",
"order_number": "1001",
"doc_date": "1556116482",
"action": "4",
"supplier_uuid": "9864232304302",
"delivery_place_uuid": "9864232304562"
},
"tags": [],
"statuses": [],
"multiExtraFields": {}
}
],
"hash": "ABB416F3FF3B5027D212D62DD9F99E94"
}
Об’єкт RecurrenceRule
Опис параметрів обʼєкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
frequency |
M |
enum |
об’єкт; частота, допустимі значення:
|
|
interval |
M |
int |
інтервал |
|
count |
O |
int |
кількість повторів події (значення розраховується: кількість з дати старту графіка) |
|
dateUntil |
O |
long |
дата до якої діють повтори - НЕ ЗАВЖДИ дата закінчення графіку (Unix timestamp) |
|
byDay |
-/M |
List<Integer> |
Масив; список номерів днів тижня за якими можливо відправляти замовлення. Параметр обов’язковий для frequency=WEEKLY (тобто потрібно обрати, як мінімум 1 день тижня) |
[1] - під визначенням колонки Тип мається на увазі скорочене позначення:
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
Об’єкт Schedule
Опис параметрів обʼєкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
id |
-/M |
long |
ідентифікатор графіка замовлень; параметр обов’язковий при оновленні графіка |
|
producerId |
long |
ідентифікатор Продавця (Виробника) |
|
|
name |
M |
String |
назва графіка замовлень |
|
dateCreated |
long |
дата створення (Unix timestamp) |
|
|
dateChanged |
long |
дата останньої зміни (Unix timestamp) |
|
|
dateStart |
M |
long |
дата початку графіка замовлень (Unix timestamp) |
|
dateEnd |
long |
дата останньої події (Unix timestamp); примітка:
|
|
|
timeFrom |
M |
String |
час З якого можливо відправляти замовлення (ГГ:ХХ:СС) |
|
timeTo |
M |
String |
час ДО якого можливо відправляти замовлення (ГГ:ХХ:СС) |
|
timeRemind |
O |
String |
час нагадування (о котрій годині нагадати) - працює лише тоді коли Продавець (Виробник) передав значення |
|
block |
O |
boolean |
блокуємо (true) / не блокуємо (false) замовлення, які не задовольняють налаштуванням графіка; за замовчуванням false |
|
type |
O |
int |
тип графіка замовлень:
Якщо не передається, то встановлюється автоматично за значенням distributors параметра |
|
recurrenceRule |
O |
об’єкт; правила повторів (передається, якщо Продавець (Виробник) налаштував повтори) |
|
|
distributors |
O/M |
List<Long> |
масив; список GLN-ів Покупців (Дистрибʼюторів), обов’язковий при type=1 |
|
dateClosest |
long |
дата найближчої можливості відправлення замовлень на сьогодні - це поле динамічне (кожен день може змінюватись); якщо у продавця немає графіка або графік є, але він вже закінчився - даного параметра у відповіді не буде |
[1] - під визначенням колонки Тип мається на увазі скорочене позначення:
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
Приклад запиту
{
"name": "Test5",
"dateStart": 1761516000,
"timeFrom": "09:00:00",
"timeTo": "21:00:00",
"block": false,
"type": 1,
"recurrenceRule":
{
"frequency": "WEEKLY",
"interval": 1,
"count": 50,
"dateUntil": 0,
"byDay":
[
1,
2,
4,
6
]
},
"distributors":
[
13200791,
13202863
]
}Приклад відповіді
[
{
"id": 9,
"producerId": 13200757,
"name": "Test3",
"dateCreated": 1700659795,
"dateChanged": 1700659795,
"dateStart": 1701381600,
"dateEnd": 1702159200,
"timeFrom": "09:00:00",
"timeTo": "21:00:00",
"block": false,
"type": 2,
"recurrenceRule":
{
"frequency": "DAILY",
"interval": 1,
"count": 10,
"dateUntil": 0,
"byDay":
[
1,
2,
4,
6
]
},
"dateClosest": 0
},
{
"id": 1,
"producerId": 13200757,
"name": "Test2",
"dateCreated": 1700656825,
"dateChanged": 1700658476,
"dateStart": 1704060000,
"dateEnd": 0,
"timeFrom": "09:00:00",
"timeTo": "21:00:00",
"block": false,
"type": 2,
"recurrenceRule":
{
"frequency": "WEEKLY",
"interval": 1,
"count": 0,
"dateUntil": 0,
"byDay":
[
1,
2,
4,
6
]
},
"dateClosest": 0
}
]Об’єкт XDistribexAccessGroup
Опис параметрів обʼєкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
producerId |
long |
ідентифікатор Продавця (Виробника) |
|
name |
String |
назва групи |
|
groupId |
long |
ідентифікатор групи |
Приклад запиту
{
"name": "ШахИМат",
"producerId": 13200791,
"groupId": 28
}Об’єкт XProductGroup
Опис параметрів обʼєкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
groupd_id |
long |
ідентифікатор
|
|
parent_group_id |
long |
ідентифікатор приналежності до вищого рівня в структурі:
|
|
name |
String |
назва:
|
|
children |
List<groupd_id> |
масив;
|
Приклад запиту
[
{
"groupd_id": 135,
"parent_group_id": 115,
"name": "Листовой ж/б"
},
...
{
"groupd_id": 156,
"parent_group_id": 155,
"name": "Кастрюлі"
},
{
"groupd_id": 155,
"parent_group_id": 0,
"name": "Кухня"
}
]Об’єкт XDistribexProduct
Опис параметрів обʼєкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
id |
long |
ідентифікатор запису |
|
date_changed |
long |
дата внесених змін в дані товару |
|
producer_id |
long |
ідентифікатор Продавця (Виробника) |
|
product_id |
long |
ідентифікатор товару |
|
unit_id |
long |
ідентифікатор одиниці виміру; допустимі значення:
|
|
price_without_vat |
Double |
ціна одиниці без ПДВ, грн |
|
vat |
int |
ставка ПДВ, % |
|
price_with_vat |
Double |
ціна одиниці з ПДВ, грн |
|
price_discont |
Double |
ціна одиниці зі знижкою без ПДВ, грн |
|
price_with_vat_discont |
Double |
ціна одиниці зі знижкою з ПДВ, грн |
|
date_from |
long |
період дії з |
|
date_to |
long |
період дії по |
|
stock_balance |
Double |
залишок |
|
comment |
String |
коментарі |
|
quota |
Double |
квота на замовлення |
|
multiplicity |
double |
кратність кількості в замовленні. Значення кратно якому має бути заповнена кількість замовленої позиції |
|
is_promo |
boolean |
відмітка «Акція!» |
|
is_new |
boolean |
відмітка «Новинка!» |
|
is_public |
boolean |
відмітка «Публічна позиція!» |
|
is_surcharge |
boolean |
відмітка «Надбавка!» |
|
is_bestseller |
boolean |
відмітка «Хіт продажу!» |
|
add_characteristics |
String |
характеристики |
Об’єкт Document
Опис параметрів об’єкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
fileName |
M |
String |
назва файлу разом з розширенням |
|
type |
M |
String |
|
|
uuid |
O |
String |
унікальний ідентифікатор документа |
-
[1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
-
-
Об’єкт DocumentRequest (Дані пов’язаних документів)
Опис параметрів об’єкта DocumentRequest
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
documents |
M |
List<Document> |
масив об’єктів; дані документів |
JSON приклад:
{
"documents":
[
{
"fileName": "comdoc_32_from_atb.p7s",
"type": "comdoc"
},
{
"fileName": "comdoc_33_from_atb.p7s",
"type": "comdoc"
}
]
}
-
[1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
-
-
Об'єкт Signs (дані для здійснення операції підписання)
Опис json-параметрів
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
signs |
M |
ArrayList<Signs> |
Масив об’єктів; підписи |
|
signInfo |
M |
Об’єкт; інформація про підписи |
Опис параметрів об’єкта Signs
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
sign |
string |
підписані дані |
|
|
type |
number |
кількість sign в об’єкті Signs (число N ) |
JSON приклад даних для здійснення операції підписання
{
"signInfo": {
"certData": [
{
"EDRPOUCode": "",
"isTimeStamp": true,
"ownerName": "ЕДІН Тест ФОП",
"serial": "1A15A67BC8E82F4C040000003AFA04000F890B00",
"signDate": "08.08.2019 13:46 ",
"subjOrg": "ЕДІН Тест ФОП",
"subjTitle": "ЕДІН Тест ФОП"
}
],
"count": 1,
"date": null,
"hash": "3BC3AF062BCC00D51EC20EEDF6D4D7A7"
},
"signs": [
{
"sign": "MIIX0Q...Q5/XCjmk1pXR8mrASIx3U1zV0=",
"type": 1
}
]
}
[1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
-
Об’єкт SignInfo (інформація про підпис)
Опис параметрів об’єкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
doc_id |
number |
id конкретного документа |
|
|
date |
any |
дата підписання |
|
|
count |
number |
кількість підписів |
|
|
hash |
string |
хеш контента підпису |
|
|
certData |
{…} |
об’єкт; {} - умовний елемент масиву з інформацією про підписи, котрі містять дані (поля) з сертификату : ownerName, EDRPOUCode, subjTitle, subjOrg, signDate, isTimeStamp, serial |
JSON приклад
{
"doc_id": 0,
"date": 0,
"count": 1,
"certData": [
{
"ownerName": "Сидоренко Василь Леонідович (Тест)",
"EDRPOUCode": "34554362",
"subjTitle": "Сидоренко Василь Леонідович (Тест)",
"subjOrg": "Сидоренко Василь Леонідович (Тест)",
"signDate": "10.03.2020 16:07 ",
"isTimeStamp": true,
"serial": "58E2D9E7F900307B00000000F6AA2500E59F7B00"
}
],
"hash": "EF3DE5D9CFA92CC4BB5CE71F20C42F6B"
}
[1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
-
Об’єкт ExEndUserTimeInfo
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
isTimeAvail |
boolean |
присутність часу підписання |
|
isTimeStamp |
boolean |
присутність мітки часу |
|
dateTime |
long |
мітка часу підписання (Unix timestamp) |
Об’єкт EndUserOwnerInfo
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
isFilled |
boolean |
відмітка про заповненість сертифікату |
|
issuer |
string |
видавець сертифікату |
|
issuerCN |
string |
назва видавця сертифікату |
|
serial |
string |
серійний номер сертифікату |
|
subject |
string |
загальна інформація про власника сертифікату |
|
subjCN |
string |
ім’я власника сертифікату |
|
subjOrg |
string |
організація власника сертифікату |
|
subjOrgUnit |
string |
підрозділ власника сертифікату |
|
subjTitle |
string |
посада власника сертифікату |
|
subjState |
string |
регіон/область власника сертифікату |
|
subjLocality |
string |
місцеперебування власника сертифікату |
|
subjFullName |
string |
повне ім’я власника сертифікату |
|
subjAddress |
string |
адреса власника сертифікату |
|
subjPhone |
string |
номер телефону власника сертифікату |
|
subjEMail |
string |
e-mail власника сертифікату |
|
subjDNS |
string |
|
|
subjEDRPOUCode |
string |
код ЕДРПОУ власника сертифікату |
|
subjDRFOCode |
string |
код ДРФО власника сертифікату |
Об’єкт ExEndUserSignInfo (дані підписантів документа)
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
isStamp |
boolean |
true - печатка; false - підпис |
|
ownerInfo |
об’єкт; дані власника сертифікату |
|
|
timeInfo |
об’єкт; дата підписання сертифікату |
|
|
certificateInfo |
EndUserCertificateInfo |
об’єкт; дані про сертифікат |
JSON приклад масиву об'єктів з даними підписантів
[
{
"isStamp": false,
"ownerInfo": {
"issuer": "O=Інформаційно-довідковий департамент ДПС;OU=Управління (центр) сертифікації ключів ІДД ДПС;CN=КНЕДП - ІДД ДПС;Serial=UA-43177711-2019;C=UA;L=Київ",
"issuerCN": "КНЕДП - ІДД ДПС",
"serial": "58E2D9E777----------AA2500E59F7B00",
"subject": "O=Тестовий платник 3 (Тестовий сертифікат);CN=Сидоренко Василь Леонідович (Тест);SN=Сидоренко;GivenName=Василь Леонідович (Тест);Serial=2467778;C=UA;L=Жашків;ST=Черкаська",
"subjCN": "Сидоренко Василь Леонідович (Тест)",
"subjOrg": "Тестовий платник 3 (Тестовий сертифікат)",
"subjState": "Черкаська",
"subjLocality": "Жашків",
"subjFullName": "Сидоренко Василь Леонідович (Тест)",
"subjPhone": "+38 (0 88) 888-88-88",
"subjEMail": "777test1@gmail.com",
"subjEDRPOUCode": "34577762",
"subjDRFOCode": "101777014"
},
"timeInfo": {
"isTimeAvail": true,
"isTimeStamp": true,
"dateTime": 1583849275
},
"certificateInfo": {
"issuer": "O=Інформаційно-довідковий департамент ДПС;OU=Управління (центр) сертифікації ключів ІДД ДПС;CN=КНЕДП - ІДД ДПС;Serial=UA-4317777711-2019;C=UA;L=Київ",
"issuerCN": "КНЕДП - ІДД ДПС",
"serial": "58E2D9E7F900307-------2500E59F7B00",
"subject": "O=Тестовий платник 3 (Тестовий сертифікат);CN=Сидоренко Василь Леонідович (Тест);SN=Сидоренко;GivenName=Василь Леонідович (Тест);Serial=24677798;C=UA;L=Жашків;ST=Черкаська",
"subjCN": "Сидоренко Василь Леонідович (Тест)",
"subjOrg": "Тестовий платник 3 (Тестовий сертифікат)",
"subjState": "Черкаська",
"subjLocality": "Жашків",
"subjFullName": "Сидоренко Василь Леонідович (Тест)",
"subjPhone": "+38 (0 88) 888-88-88",
"subjEMail": "777test1@gmail.com",
"subjEDRPOUCode": "34577762",
"subjDRFOCode": "101077714",
"certBeginTime": "Nov 21, 2019 12:00:00 AM",
"certEndTime": "Nov 21, 2021 12:00:00 AM",
"privKeyTimesAvail": false,
"privKeyBeginTime": "Nov 21, 2019 12:00:00 AM",
"privKeyEndTime": "Nov 21, 2021 12:00:00 AM",
"publicKeyBits": 264,
"publicKey": "6896AF6336BE76B0F9-----------FF69E18E4C74AE2E512A1500",
"publicKeyID": "88 B9 20 A1 91 B2 40 2E 86 F5 ---- 73 5B 0D 97 34 B7 26 6B 80 F1 56 ",
"ecdhPublicKeyAvail": false,
"ecdhPublicKeyBits": 0,
"issuerPublicKeyID": "D8 E2 D9 E7 F9 00 30 7B 38 F---- 91 D0 64 A7 33 8C 5C ",
"keyUsage": "ЕЦП, Неспростовність",
"polices": "Правила посиленої сертифікації",
"crlDistribPoint1": "http://acskidd.gov.ua/download/crls/CA-D87779E7-Full.crl",
"crlDistribPoint2": "http://acskidd.gov.ua/download/crls/CA-D8777E7-Delta.crl",
"powerCert": true,
"subjTypeAvail": true,
"subjCA": false
}
},
{
"isStamp": false,
"ownerInfo": {
"issuer": "O=Інформаційно-довідковий департамент ДПС;OU=Управління (центр) сертифікації ключів ІДД ДПС;CN=КНЕДП - ІДД ДПС;Serial=UA-43177711-2019;C=UA;L=Київ",
"issuerCN": "КНЕДП - ІДД ДПС",
"serial": "58E2D9E777----------AA2500E59F7B00",
"subject": "O=Тестовий платник 3 (Тестовий сертифікат);CN=Сидоренко Василь Леонідович (Тест);SN=Сидоренко;GivenName=Василь Леонідович (Тест);Serial=2467778;C=UA;L=Жашків;ST=Черкаська",
"subjCN": "Сидоренко Василь Леонідович (Тест)",
"subjOrg": "Тестовий платник 3 (Тестовий сертифікат)",
"subjState": "Черкаська",
"subjLocality": "Жашків",
"subjFullName": "Сидоренко Василь Леонідович (Тест)",
"subjPhone": "+38 (0 88) 888-88-88",
"subjEMail": "777test1@gmail.com",
"subjEDRPOUCode": "34577762",
"subjDRFOCode": "101777014"
},
"timeInfo": {
"isTimeAvail": true,
"isTimeStamp": true,
"dateTime": 1583849275
},
"certificateInfo": {
"issuer": "O=Інформаційно-довідковий департамент ДПС;OU=Управління (центр) сертифікації ключів ІДД ДПС;CN=КНЕДП - ІДД ДПС;Serial=UA-4317777711-2019;C=UA;L=Київ",
"issuerCN": "КНЕДП - ІДД ДПС",
"serial": "58E2D9E7F900307-------2500E59F7B00",
"subject": "O=Тестовий платник 3 (Тестовий сертифікат);CN=Сидоренко Василь Леонідович (Тест);SN=Сидоренко;GivenName=Василь Леонідович (Тест);Serial=24677798;C=UA;L=Жашків;ST=Черкаська",
"subjCN": "Сидоренко Василь Леонідович (Тест)",
"subjOrg": "Тестовий платник 3 (Тестовий сертифікат)",
"subjState": "Черкаська",
"subjLocality": "Жашків",
"subjFullName": "Сидоренко Василь Леонідович (Тест)",
"subjPhone": "+38 (0 88) 888-88-88",
"subjEMail": "777test1@gmail.com",
"subjEDRPOUCode": "34577762",
"subjDRFOCode": "101077714",
"certBeginTime": "Nov 21, 2019 12:00:00 AM",
"certEndTime": "Nov 21, 2021 12:00:00 AM",
"privKeyTimesAvail": false,
"privKeyBeginTime": "Nov 21, 2019 12:00:00 AM",
"privKeyEndTime": "Nov 21, 2021 12:00:00 AM",
"publicKeyBits": 264,
"publicKey": "6896AF6336BE76B0F9-----------FF69E18E4C74AE2E512A1500",
"publicKeyID": "88 B9 20 A1 91 B2 40 2E 86 F5 ---- 73 5B 0D 97 34 B7 26 6B 80 F1 56 ",
"ecdhPublicKeyAvail": false,
"ecdhPublicKeyBits": 0,
"issuerPublicKeyID": "D8 E2 D9 E7 F9 00 30 7B 38 F---- 91 D0 64 A7 33 8C 5C ",
"keyUsage": "ЕЦП, Неспростовність",
"polices": "Правила посиленої сертифікації",
"crlDistribPoint1": "http://acskidd.gov.ua/download/crls/CA-D87779E7-Full.crl",
"crlDistribPoint2": "http://acskidd.gov.ua/download/crls/CA-D8777E7-Delta.crl",
"powerCert": true,
"subjTypeAvail": true,
"subjCA": false
}
}
]
JSON приклад масиву об'єктів з даними підписантів до кожної вказаної транзакції
{
"1": [
{
"isStamp": false,
"ownerInfo": {
"issuer": "O=ТОВ \"Центр сертифікації ключів \"Україна\";CN=КНЕДП ТОВ \"Центр сертифікації ключів \"Україна\";Serial=UA-36865753-2101;C=UA;L=Київ;OI=NTRUA-36865753",
"issuerCN": "КНЕДП ТОВ \"Центр сертифікації ключів \"Україна\"",
"serial": "5897920700000000000000000000000000000001",
"subject": "O=ТОВ \"Вайтдок\";Title=1;CN=Іванов Іван Іванович;SN=Іванов;GivenName=Іван Іванович;Serial=1234567890D;C=UA;L=місто КИЇВ",
"subjCN": "Іванов Іван Іванович",
"subjOrg": "ТОВ \"Вайтдок\"",
"subjTitle": "1",
"subjLocality": "місто КИЇВ",
"subjFullName": "Іванов Іван Іванович",
"subjEMail": "info@uakey.com.ua",
"subjEDRPOUCode": "12345678",
"subjDRFOCode": "1234567890"
},
"timeInfo": {
"isTimeAvail": true,
"isTimeStamp": true,
"dateTime": 1695981706
},
"certificateInfo": {
"issuer": "O=ТОВ \"Центр сертифікації ключів \"Україна\";CN=КНЕДП ТОВ \"Центр сертифікації ключів \"Україна\";Serial=UA-36865753-2101;C=UA;L=Київ;OI=NTRUA-36865753",
"issuerCN": "КНЕДП ТОВ \"Центр сертифікації ключів \"Україна\"",
"serial": "5897920700000000000000000000000000000001",
"subject": "O=ТОВ \"Вайтдок\";Title=1;CN=Іванов Іван Іванович;SN=Іванов;GivenName=Іван Іванович;Serial=1234567890D;C=UA;L=місто КИЇВ",
"subjCN": "Іванов Іван Іванович",
"subjOrg": "ТОВ \"Вайтдок\"",
"subjTitle": "1",
"subjLocality": "місто КИЇВ",
"subjFullName": "Іванов Іван Іванович",
"subjEMail": "info@uakey.com.ua",
"subjEDRPOUCode": "12345678",
"subjDRFOCode": "1234567890",
"certBeginTime": "Mar 30, 2022, 5:56:29 PM",
"certEndTime": "Mar 29, 2024, 11:59:59 PM",
"privKeyTimesAvail": false,
"privKeyBeginTime": "Mar 30, 2022, 5:56:29 PM",
"privKeyEndTime": "Mar 29, 2024, 11:59:59 PM",
"publicKeyBits": 264,
"publicKey": "33 AC 59 40 D1 B8 6C 6D C3 9D 55 C7 43 A0 51 8F 55 09 6A D4 AA 26 98 86 08 0D 32 B1 71 3D E4 02 00 ",
"publicKeyID": "F1 73 2A 78 C0 F7 86 A2 3D B6 18 AF DE 4A 87 89 20 EE 0C FE F4 A0 12 06 1B 95 BB 0A BD 01 77 1F ",
"issuerPublicKeyID": "52 ED 74 ED 3A E9 49 36 C5 78 B5 A0 60 0B 65 F1 10 09 BF EF 5F 1E ED 43 CD 23 A4 98 F0 7D E3 80 ",
"keyUsage": "ЕЦП, Неспростовність",
"extKeyUsages": "1.2.804.2.1.1.1.11.36865753.1",
"policies": "Правила посиленої сертифікації",
"crlDistribPoint1": "http://uakey.com.ua/list.crl",
"crlDistribPoint2": "http://uakey.com.ua/list-delta.crl",
"powerCert": true,
"subjTypeAvail": false,
"subjCA": false,
"chainLength": 0,
"publicKeyType": 1,
"keyUsageType": 3,
"OCSPAccessInfo": "http://uakey.com.ua/services/ocsp/",
"issuerAccessInfo": "http://uakey.com.ua/uakeycert.p7b",
"TSPAccessInfo": "http://uakey.com.ua/services/tsp/",
"limitValueAvailable": false,
"limitValue": 0,
"subjType": 4,
"subjSubType": 0,
"subjCountry": "UA",
"qscd": false,
"certHashType": 1
}
}
],
"2": [
{
"isStamp": false,
"ownerInfo": {
"issuer": "O=ТОВ \"Центр сертифікації ключів \"Україна\";CN=КНЕДП ТОВ \"Центр сертифікації ключів \"Україна\";Serial=UA-36865753-2101;C=UA;L=Київ;OI=NTRUA-36865753",
"issuerCN": "КНЕДП ТОВ \"Центр сертифікації ключів \"Україна\"",
"serial": "5897920700000000000000000000000000000001",
"subject": "O=ТОВ \"Вайтдок\";Title=1;CN=Іванов Іван Іванович;SN=Іванов;GivenName=Іван Іванович;Serial=1234567890D;C=UA;L=місто КИЇВ",
"subjCN": "Іванов Іван Іванович",
"subjOrg": "ТОВ \"Вайтдок\"",
"subjTitle": "1",
"subjLocality": "місто КИЇВ",
"subjFullName": "Іванов Іван Іванович",
"subjEMail": "info@uakey.com.ua",
"subjEDRPOUCode": "12345678",
"subjDRFOCode": "1234567890"
},
"timeInfo": {
"isTimeAvail": true,
"isTimeStamp": true,
"dateTime": 1695981706
},
"certificateInfo": {
"issuer": "O=ТОВ \"Центр сертифікації ключів \"Україна\";CN=КНЕДП ТОВ \"Центр сертифікації ключів \"Україна\";Serial=UA-36865753-2101;C=UA;L=Київ;OI=NTRUA-36865753",
"issuerCN": "КНЕДП ТОВ \"Центр сертифікації ключів \"Україна\"",
"serial": "5897920700000000000000000000000000000001",
"subject": "O=ТОВ \"Вайтдок\";Title=1;CN=Іванов Іван Іванович;SN=Іванов;GivenName=Іван Іванович;Serial=1234567890D;C=UA;L=місто КИЇВ",
"subjCN": "Іванов Іван Іванович",
"subjOrg": "ТОВ \"Вайтдок\"",
"subjTitle": "1",
"subjLocality": "місто КИЇВ",
"subjFullName": "Іванов Іван Іванович",
"subjEMail": "info@uakey.com.ua",
"subjEDRPOUCode": "12345678",
"subjDRFOCode": "1234567890",
"certBeginTime": "Mar 30, 2022, 5:56:29 PM",
"certEndTime": "Mar 29, 2024, 11:59:59 PM",
"privKeyTimesAvail": false,
"privKeyBeginTime": "Mar 30, 2022, 5:56:29 PM",
"privKeyEndTime": "Mar 29, 2024, 11:59:59 PM",
"publicKeyBits": 264,
"publicKey": "33 AC 59 40 D1 B8 6C 6D C3 9D 55 C7 43 A0 51 8F 55 09 6A D4 AA 26 98 86 08 0D 32 B1 71 3D E4 02 00 ",
"publicKeyID": "F1 73 2A 78 C0 F7 86 A2 3D B6 18 AF DE 4A 87 89 20 EE 0C FE F4 A0 12 06 1B 95 BB 0A BD 01 77 1F ",
"issuerPublicKeyID": "52 ED 74 ED 3A E9 49 36 C5 78 B5 A0 60 0B 65 F1 10 09 BF EF 5F 1E ED 43 CD 23 A4 98 F0 7D E3 80 ",
"keyUsage": "ЕЦП, Неспростовність",
"extKeyUsages": "1.2.804.2.1.1.1.11.36865753.1",
"policies": "Правила посиленої сертифікації",
"crlDistribPoint1": "http://uakey.com.ua/list.crl",
"crlDistribPoint2": "http://uakey.com.ua/list-delta.crl",
"powerCert": true,
"subjTypeAvail": false,
"subjCA": false,
"chainLength": 0,
"publicKeyType": 1,
"keyUsageType": 3,
"OCSPAccessInfo": "http://uakey.com.ua/services/ocsp/",
"issuerAccessInfo": "http://uakey.com.ua/uakeycert.p7b",
"TSPAccessInfo": "http://uakey.com.ua/services/tsp/",
"limitValueAvailable": false,
"limitValue": 0,
"subjType": 4,
"subjSubType": 0,
"subjCountry": "UA",
"qscd": false,
"certHashType": 1
}
},
{
"isStamp": false,
"ownerInfo": {
"issuer": "O=ТОВ \"Центр сертифікації ключів \"Україна\";CN=КНЕДП ТОВ \"Центр сертифікації ключів \"Україна\";Serial=UA-36865753-2101;C=UA;L=Київ;OI=NTRUA-36865753",
"issuerCN": "КНЕДП ТОВ \"Центр сертифікації ключів \"Україна\"",
"serial": "5897920700000000000000000000000000000001",
"subject": "O=ТОВ \"Вайтдок\";Title=1;CN=Іванов Іван Іванович;SN=Іванов;GivenName=Іван Іванович;Serial=1234567890D;C=UA;L=місто КИЇВ",
"subjCN": "Іванов Іван Іванович",
"subjOrg": "ТОВ \"Вайтдок\"",
"subjTitle": "1",
"subjLocality": "місто КИЇВ",
"subjFullName": "Іванов Іван Іванович",
"subjEMail": "info@uakey.com.ua",
"subjEDRPOUCode": "12345678",
"subjDRFOCode": "1234567890"
},
"timeInfo": {
"isTimeAvail": true,
"isTimeStamp": true,
"dateTime": 1695981971
},
"certificateInfo": {
"issuer": "O=ТОВ \"Центр сертифікації ключів \"Україна\";CN=КНЕДП ТОВ \"Центр сертифікації ключів \"Україна\";Serial=UA-36865753-2101;C=UA;L=Київ;OI=NTRUA-36865753",
"issuerCN": "КНЕДП ТОВ \"Центр сертифікації ключів \"Україна\"",
"serial": "5897920700000000000000000000000000000001",
"subject": "O=ТОВ \"Вайтдок\";Title=1;CN=Іванов Іван Іванович;SN=Іванов;GivenName=Іван Іванович;Serial=1234567890D;C=UA;L=місто КИЇВ",
"subjCN": "Іванов Іван Іванович",
"subjOrg": "ТОВ \"Вайтдок\"",
"subjTitle": "1",
"subjLocality": "місто КИЇВ",
"subjFullName": "Іванов Іван Іванович",
"subjEMail": "info@uakey.com.ua",
"subjEDRPOUCode": "12345678",
"subjDRFOCode": "1234567890",
"certBeginTime": "Mar 30, 2022, 5:56:29 PM",
"certEndTime": "Mar 29, 2024, 11:59:59 PM",
"privKeyTimesAvail": false,
"privKeyBeginTime": "Mar 30, 2022, 5:56:29 PM",
"privKeyEndTime": "Mar 29, 2024, 11:59:59 PM",
"publicKeyBits": 264,
"publicKey": "33 AC 59 40 D1 B8 6C 6D C3 9D 55 C7 43 A0 51 8F 55 09 6A D4 AA 26 98 86 08 0D 32 B1 71 3D E4 02 00 ",
"publicKeyID": "F1 73 2A 78 C0 F7 86 A2 3D B6 18 AF DE 4A 87 89 20 EE 0C FE F4 A0 12 06 1B 95 BB 0A BD 01 77 1F ",
"issuerPublicKeyID": "52 ED 74 ED 3A E9 49 36 C5 78 B5 A0 60 0B 65 F1 10 09 BF EF 5F 1E ED 43 CD 23 A4 98 F0 7D E3 80 ",
"keyUsage": "ЕЦП, Неспростовність",
"extKeyUsages": "1.2.804.2.1.1.1.11.36865753.1",
"policies": "Правила посиленої сертифікації",
"crlDistribPoint1": "http://uakey.com.ua/list.crl",
"crlDistribPoint2": "http://uakey.com.ua/list-delta.crl",
"powerCert": true,
"subjTypeAvail": false,
"subjCA": false,
"chainLength": 0,
"publicKeyType": 1,
"keyUsageType": 3,
"OCSPAccessInfo": "http://uakey.com.ua/services/ocsp/",
"issuerAccessInfo": "http://uakey.com.ua/uakeycert.p7b",
"TSPAccessInfo": "http://uakey.com.ua/services/tsp/",
"limitValueAvailable": false,
"limitValue": 0,
"subjType": 4,
"subjSubType": 0,
"subjCountry": "UA",
"qscd": false,
"certHashType": 1
}
}
],
"11": [
{
"isStamp": false,
"ownerInfo": {
"issuer": "O=ТОВ \"Центр сертифікації ключів \"Україна\";CN=КНЕДП ТОВ \"Центр сертифікації ключів \"Україна\";Serial=UA-36865753-2101;C=UA;L=Київ;OI=NTRUA-36865753",
"issuerCN": "КНЕДП ТОВ \"Центр сертифікації ключів \"Україна\"",
"serial": "5897920700000000000000000000000000000001",
"subject": "O=ТОВ \"Вайтдок\";Title=1;CN=Іванов Іван Іванович;SN=Іванов;GivenName=Іван Іванович;Serial=1234567890D;C=UA;L=місто КИЇВ",
"subjCN": "Іванов Іван Іванович",
"subjOrg": "ТОВ \"Вайтдок\"",
"subjTitle": "1",
"subjLocality": "місто КИЇВ",
"subjFullName": "Іванов Іван Іванович",
"subjEMail": "info@uakey.com.ua",
"subjEDRPOUCode": "12345678",
"subjDRFOCode": "1234567890"
},
"timeInfo": {
"isTimeAvail": true,
"isTimeStamp": true,
"dateTime": 1695981988
},
"certificateInfo": {
"issuer": "O=ТОВ \"Центр сертифікації ключів \"Україна\";CN=КНЕДП ТОВ \"Центр сертифікації ключів \"Україна\";Serial=UA-36865753-2101;C=UA;L=Київ;OI=NTRUA-36865753",
"issuerCN": "КНЕДП ТОВ \"Центр сертифікації ключів \"Україна\"",
"serial": "5897920700000000000000000000000000000001",
"subject": "O=ТОВ \"Вайтдок\";Title=1;CN=Іванов Іван Іванович;SN=Іванов;GivenName=Іван Іванович;Serial=1234567890D;C=UA;L=місто КИЇВ",
"subjCN": "Іванов Іван Іванович",
"subjOrg": "ТОВ \"Вайтдок\"",
"subjTitle": "1",
"subjLocality": "місто КИЇВ",
"subjFullName": "Іванов Іван Іванович",
"subjEMail": "info@uakey.com.ua",
"subjEDRPOUCode": "12345678",
"subjDRFOCode": "1234567890",
"certBeginTime": "Mar 30, 2022, 5:56:29 PM",
"certEndTime": "Mar 29, 2024, 11:59:59 PM",
"privKeyTimesAvail": false,
"privKeyBeginTime": "Mar 30, 2022, 5:56:29 PM",
"privKeyEndTime": "Mar 29, 2024, 11:59:59 PM",
"publicKeyBits": 264,
"publicKey": "33 AC 59 40 D1 B8 6C 6D C3 9D 55 C7 43 A0 51 8F 55 09 6A D4 AA 26 98 86 08 0D 32 B1 71 3D E4 02 00 ",
"publicKeyID": "F1 73 2A 78 C0 F7 86 A2 3D B6 18 AF DE 4A 87 89 20 EE 0C FE F4 A0 12 06 1B 95 BB 0A BD 01 77 1F ",
"issuerPublicKeyID": "52 ED 74 ED 3A E9 49 36 C5 78 B5 A0 60 0B 65 F1 10 09 BF EF 5F 1E ED 43 CD 23 A4 98 F0 7D E3 80 ",
"keyUsage": "ЕЦП, Неспростовність",
"extKeyUsages": "1.2.804.2.1.1.1.11.36865753.1",
"policies": "Правила посиленої сертифікації",
"crlDistribPoint1": "http://uakey.com.ua/list.crl",
"crlDistribPoint2": "http://uakey.com.ua/list-delta.crl",
"powerCert": true,
"subjTypeAvail": false,
"subjCA": false,
"chainLength": 0,
"publicKeyType": 1,
"keyUsageType": 3,
"OCSPAccessInfo": "http://uakey.com.ua/services/ocsp/",
"issuerAccessInfo": "http://uakey.com.ua/uakeycert.p7b",
"TSPAccessInfo": "http://uakey.com.ua/services/tsp/",
"limitValueAvailable": false,
"limitValue": 0,
"subjType": 4,
"subjSubType": 0,
"subjCountry": "UA",
"qscd": false,
"certHashType": 1
}
}
],
"12": [
{
"isStamp": false,
"ownerInfo": {
"issuer": "O=ТОВ \"Центр сертифікації ключів \"Україна\";CN=КНЕДП ТОВ \"Центр сертифікації ключів \"Україна\";Serial=UA-36865753-2101;C=UA;L=Київ;OI=NTRUA-36865753",
"issuerCN": "КНЕДП ТОВ \"Центр сертифікації ключів \"Україна\"",
"serial": "5897920700000000000000000000000000000001",
"subject": "O=ТОВ \"Вайтдок\";Title=1;CN=Іванов Іван Іванович;SN=Іванов;GivenName=Іван Іванович;Serial=1234567890D;C=UA;L=місто КИЇВ",
"subjCN": "Іванов Іван Іванович",
"subjOrg": "ТОВ \"Вайтдок\"",
"subjTitle": "1",
"subjLocality": "місто КИЇВ",
"subjFullName": "Іванов Іван Іванович",
"subjEMail": "info@uakey.com.ua",
"subjEDRPOUCode": "12345678",
"subjDRFOCode": "1234567890"
},
"timeInfo": {
"isTimeAvail": true,
"isTimeStamp": true,
"dateTime": 1695981988
},
"certificateInfo": {
"issuer": "O=ТОВ \"Центр сертифікації ключів \"Україна\";CN=КНЕДП ТОВ \"Центр сертифікації ключів \"Україна\";Serial=UA-36865753-2101;C=UA;L=Київ;OI=NTRUA-36865753",
"issuerCN": "КНЕДП ТОВ \"Центр сертифікації ключів \"Україна\"",
"serial": "5897920700000000000000000000000000000001",
"subject": "O=ТОВ \"Вайтдок\";Title=1;CN=Іванов Іван Іванович;SN=Іванов;GivenName=Іван Іванович;Serial=1234567890D;C=UA;L=місто КИЇВ",
"subjCN": "Іванов Іван Іванович",
"subjOrg": "ТОВ \"Вайтдок\"",
"subjTitle": "1",
"subjLocality": "місто КИЇВ",
"subjFullName": "Іванов Іван Іванович",
"subjEMail": "info@uakey.com.ua",
"subjEDRPOUCode": "12345678",
"subjDRFOCode": "1234567890",
"certBeginTime": "Mar 30, 2022, 5:56:29 PM",
"certEndTime": "Mar 29, 2024, 11:59:59 PM",
"privKeyTimesAvail": false,
"privKeyBeginTime": "Mar 30, 2022, 5:56:29 PM",
"privKeyEndTime": "Mar 29, 2024, 11:59:59 PM",
"publicKeyBits": 264,
"publicKey": "33 AC 59 40 D1 B8 6C 6D C3 9D 55 C7 43 A0 51 8F 55 09 6A D4 AA 26 98 86 08 0D 32 B1 71 3D E4 02 00 ",
"publicKeyID": "F1 73 2A 78 C0 F7 86 A2 3D B6 18 AF DE 4A 87 89 20 EE 0C FE F4 A0 12 06 1B 95 BB 0A BD 01 77 1F ",
"issuerPublicKeyID": "52 ED 74 ED 3A E9 49 36 C5 78 B5 A0 60 0B 65 F1 10 09 BF EF 5F 1E ED 43 CD 23 A4 98 F0 7D E3 80 ",
"keyUsage": "ЕЦП, Неспростовність",
"extKeyUsages": "1.2.804.2.1.1.1.11.36865753.1",
"policies": "Правила посиленої сертифікації",
"crlDistribPoint1": "http://uakey.com.ua/list.crl",
"crlDistribPoint2": "http://uakey.com.ua/list-delta.crl",
"powerCert": true,
"subjTypeAvail": false,
"subjCA": false,
"chainLength": 0,
"publicKeyType": 1,
"keyUsageType": 3,
"OCSPAccessInfo": "http://uakey.com.ua/services/ocsp/",
"issuerAccessInfo": "http://uakey.com.ua/uakeycert.p7b",
"TSPAccessInfo": "http://uakey.com.ua/services/tsp/",
"limitValueAvailable": false,
"limitValue": 0,
"subjType": 4,
"subjSubType": 0,
"subjCountry": "UA",
"qscd": false,
"certHashType": 1
}
},
{
"isStamp": false,
"ownerInfo": {
"issuer": "O=ТОВ \"Центр сертифікації ключів \"Україна\";CN=КНЕДП ТОВ \"Центр сертифікації ключів \"Україна\";Serial=UA-36865753-2101;C=UA;L=Київ;OI=NTRUA-36865753",
"issuerCN": "КНЕДП ТОВ \"Центр сертифікації ключів \"Україна\"",
"serial": "5897920700000000000000000000000000000001",
"subject": "O=ТОВ \"Вайтдок\";Title=1;CN=Іванов Іван Іванович;SN=Іванов;GivenName=Іван Іванович;Serial=1234567890D;C=UA;L=місто КИЇВ",
"subjCN": "Іванов Іван Іванович",
"subjOrg": "ТОВ \"Вайтдок\"",
"subjTitle": "1",
"subjLocality": "місто КИЇВ",
"subjFullName": "Іванов Іван Іванович",
"subjEMail": "info@uakey.com.ua",
"subjEDRPOUCode": "12345678",
"subjDRFOCode": "1234567890"
},
"timeInfo": {
"isTimeAvail": true,
"isTimeStamp": true,
"dateTime": 1695988091
},
"certificateInfo": {
"issuer": "O=ТОВ \"Центр сертифікації ключів \"Україна\";CN=КНЕДП ТОВ \"Центр сертифікації ключів \"Україна\";Serial=UA-36865753-2101;C=UA;L=Київ;OI=NTRUA-36865753",
"issuerCN": "КНЕДП ТОВ \"Центр сертифікації ключів \"Україна\"",
"serial": "5897920700000000000000000000000000000001",
"subject": "O=ТОВ \"Вайтдок\";Title=1;CN=Іванов Іван Іванович;SN=Іванов;GivenName=Іван Іванович;Serial=1234567890D;C=UA;L=місто КИЇВ",
"subjCN": "Іванов Іван Іванович",
"subjOrg": "ТОВ \"Вайтдок\"",
"subjTitle": "1",
"subjLocality": "місто КИЇВ",
"subjFullName": "Іванов Іван Іванович",
"subjEMail": "info@uakey.com.ua",
"subjEDRPOUCode": "12345678",
"subjDRFOCode": "1234567890",
"certBeginTime": "Mar 30, 2022, 5:56:29 PM",
"certEndTime": "Mar 29, 2024, 11:59:59 PM",
"privKeyTimesAvail": false,
"privKeyBeginTime": "Mar 30, 2022, 5:56:29 PM",
"privKeyEndTime": "Mar 29, 2024, 11:59:59 PM",
"publicKeyBits": 264,
"publicKey": "33 AC 59 40 D1 B8 6C 6D C3 9D 55 C7 43 A0 51 8F 55 09 6A D4 AA 26 98 86 08 0D 32 B1 71 3D E4 02 00 ",
"publicKeyID": "F1 73 2A 78 C0 F7 86 A2 3D B6 18 AF DE 4A 87 89 20 EE 0C FE F4 A0 12 06 1B 95 BB 0A BD 01 77 1F ",
"issuerPublicKeyID": "52 ED 74 ED 3A E9 49 36 C5 78 B5 A0 60 0B 65 F1 10 09 BF EF 5F 1E ED 43 CD 23 A4 98 F0 7D E3 80 ",
"keyUsage": "ЕЦП, Неспростовність",
"extKeyUsages": "1.2.804.2.1.1.1.11.36865753.1",
"policies": "Правила посиленої сертифікації",
"crlDistribPoint1": "http://uakey.com.ua/list.crl",
"crlDistribPoint2": "http://uakey.com.ua/list-delta.crl",
"powerCert": true,
"subjTypeAvail": false,
"subjCA": false,
"chainLength": 0,
"publicKeyType": 1,
"keyUsageType": 3,
"OCSPAccessInfo": "http://uakey.com.ua/services/ocsp/",
"issuerAccessInfo": "http://uakey.com.ua/uakeycert.p7b",
"TSPAccessInfo": "http://uakey.com.ua/services/tsp/",
"limitValueAvailable": false,
"limitValue": 0,
"subjType": 4,
"subjSubType": 0,
"subjCountry": "UA",
"qscd": false,
"certHashType": 1
}
}
]
}
Об’єкт DateTimeRange
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
startTimestamp |
long |
початок часового діапазону |
|
finishTimestamp |
long |
закінчення часового діапазону |
Об’єкт Limitation
Опис параметрів об’єкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
offset |
O |
int |
зміщення першого елемента списку щодо верхньої межі вибірки (за замовчуванням 0) |
|
count |
O |
int |
ліміт вибірки (кількість); за замовчуванням 20 |
- [1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
-
Об’єкт Direction
Опис параметрів об’єкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
type |
enum (EQ, OR, IN) |
тип вибірки; можливі значення: » EQ » / » OR » / » IN »
|
|
|
sender |
M/O |
List<String> |
масив; відправники; GLN відправників - обов’язковий, але може бути порожнім якщо зазначений масив GLN одержувачів (receiver) |
|
receiver |
M/O |
List<String> |
масив; одержувачі; GLN одержувачів - обов’язковий, але може бути порожнім якщо зазначений масив GLN відправників (sender) |
|
senderGln |
M/O |
List<String> |
масив; GLN відправників - обов’язковий, але може бути порожнім якщо зазначені інші параметри (для об’єкта XSearchContractsQuery) |
|
recipient |
M/O |
List<String> |
масив; id GLN одержувачів - обов’язковий, але може бути порожнім якщо зазначені інші параметри(для об’єкта XSearchContractsQuery) |
|
recipientGln |
M/O |
List<String> |
масив; GLN одержувачів - обов’язковий, але може бути порожнім якщо зазначені інші параметри(для об’єкта XSearchContractsQuery) |
- [1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
-
Об’єкт ExtraQueryParameters
Опис параметрів об’єкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
Об’єкт ExtraQueryParameters |
|||
|
operator |
enum (AND, OR) |
||
|
type |
М |
enum (EQUALS, EQUALS_UUID, EQUALS_MD5, LIKE, MORE, MORE_EQ, LESS, LESS_EQ, IN) |
|
|
String |
найменування параметру |
||
|
value |
String |
id параметра |
Опис fieldName параметрів
|
id параметра |
Найменування параметра |
Тип 1 |
Формат |
Опис параметра |
|---|---|---|---|---|
|
1 |
created_from |
UUID |
ідентифікатор документа або ланцюжка |
|
|
2 |
is_signed |
TINYINT |
відмітка про підписання;
|
|
|
3 |
encrypted |
TINYINT |
відмітка про шифрування |
|
|
4 |
comdoc_reestr_id |
INT |
id факторингового Реєстру на підставі комерційного документа |
|
|
5 |
comdoc_reestr_is_active |
TINYINT |
відмітка про активність факторингового договору |
|
|
6 |
ftpex_file_name |
VARCHAR |
найменування файлу, відправленого по FTP |
|
|
7 |
ftpex_file_date |
INT |
дата/час відправки документа по FTP |
|
|
8 |
inv_date |
INT |
дата документа invrpt (Звіт про інвентаризацію) |
|
|
9 |
inv_num |
VARCHAR |
номер документа invrpt (Звіт про інвентаризацію) |
|
|
10 |
error_code |
INT |
код помилки документообігу |
|
|
11 |
sub_doc_type_id |
INT |
id підтипу документа ( опис_підтипів ) |
|
|
12 |
sub_status_id |
INT |
id статусу документа (опис + опис для ETTN v3); характеризує стан ланцюжка документів для PRDRSRVN:
|
|
|
13 |
action |
VARCHAR |
статус/стан документа за здійсненими діями користувача; Для EDI: ORDER (тип документа):
RETANN:
PRICAT (тип документа):
COACSU (тип документа):
CONDRA:
Для Вільний:
Для ЕТТН:
|
|
|
14 |
buyer_uuid |
VARCHAR |
відправник документа |
|
|
15 |
consignee_uuid |
VARCHAR |
вантажоодержувач |
|
|
16 |
consignor_uuid |
VARCHAR |
вантажовідправник |
|
|
17 |
customer_uuid |
VARCHAR |
Покупець / Замовник |
|
|
18 |
performer_uuid |
VARCHAR |
виконавець |
|
|
19 |
supplier_uuid |
VARCHAR |
постачальник |
|
|
20 |
delivery_place_uuid |
VARCHAR |
місце доставки |
|
|
21 |
contract_date |
VARCHAR |
дата договору |
|
|
22 |
contract_number |
VARCHAR |
номер договору |
|
|
23 |
delivery_date |
M |
INT |
дата доставки |
|
24 |
order_number |
M |
VARCHAR |
номер замовлення |
|
25 |
order_date |
INT |
дата замовлення |
|
|
26 |
return_date |
INT |
дата повернення |
|
|
27 |
summ |
decimal |
сума з ПДВ / загальна сума штрафу (ORDRPT) |
|
|
28 |
parent_chain_hash |
MD5 |
хеш ланцюжка |
|
|
29 |
period |
VARCHAR |
крайня дата підпису документа |
|
|
31 |
trans_id |
VARCHAR |
id транзакції |
|
|
32 |
ttn |
VARCHAR |
номер накладної |
|
|
33 |
doc_start_date |
VARCHAR |
початок терміну підписання документа |
|
|
34 |
doc_end_date |
VARCHAR |
закінчення терміну підписання документа |
|
|
35 |
delivery_note_number |
VARCHAR |
номер накладної |
|
|
42 |
contract_gln |
VARCHAR |
GLN місце доставки при товарному узгодженні (Agreem->Comdoc) для сервісу Е-Специфікація. Також для EDI сервісу в нього пишеться поле ContractGLN з документа Метро 7а |
|
|
43 |
doc_date |
INT |
дата з документа |
|
|
44 |
delivery_agreement_number |
VARCHAR |
кількість узгоджень |
|
|
45 |
delivery_agreement_date |
INT |
дата узгодження |
|
|
46 |
varn |
VARCHAR |
ЮЗД id документа |
|
|
47 |
other_info |
TEXT |
додаткові дані |
|
|
48 |
sub_doc_date |
INT |
дата підтипу документа |
|
|
49 |
sub_doc_number |
VARCHAR |
номер підтипу документа |
|
|
50 |
doc_error |
TEXT |
помилка при роботі з документом |
|
|
51 |
doc_info |
TEXT |
коментар до документа |
|
|
52 |
old_doc_id |
INT |
id документа |
|
|
53 |
sub_status_date |
INT |
дата статусу документа (стан ланцюжка документів) |
|
|
54 |
from_doc_id |
INT |
порядковий номер документа в ланцюжку |
|
|
56 |
doc_num |
VARCHAR |
номер документа |
|
|
57 |
sender |
VARCHAR |
GLN відправника |
|
|
58 |
recipient |
VARCHAR |
GLN одержувача |
|
|
59 |
file_name |
VARCHAR |
найменування прикладаємого (вкладення) файлу |
|
|
60 |
xml_hash |
VARCHAR |
хеш змісту документа |
|
|
61 |
answer_doc_id |
INT |
id COMDOC документа відправленного у відповідь |
|
|
80 |
identifier |
VARCHAR |
ідентифікатор документа в системі клієнта |
|
|
82 |
compound_number |
VARCHAR |
складовий номер |
|
|
85 |
doc_process |
TINYINT |
процес, що здійснюється з документом даним учасником для Погодження:
|
|
|
87 |
users |
VARCHAR |
список користувачів (що приймають участь в сценарії погодження, тощо) |
|
|
88 |
basis_doc_subtype |
INT |
підтип документа-підстави |
|
|
89 |
basis_doc_number |
|
INT |
номер документа-підстави |
|
90 |
basis_doc_date |
INT |
дата документа-підстави |
|
|
116 |
ready_for_sign |
INT |
відмітка готовності до підписання (0-ні; 1-так) |
|
|
118 |
ready_for_send |
INT |
відмітка готовності до відправки (0-ні; 1-так) |
|
|
95 |
summ_without_tax |
decimal |
сума без ПДВ |
|
|
tax_summ |
decimal |
сума ПДВ |
||
|
129 |
receiving_note_number |
VARCHAR |
Номер повідомлення про прийом (DOCUMENTINVOICE…ReceivingAdviceNumber) |
|
|
137 |
branch_uuid |
VARCHAR |
uuid «гілки поставки» для мережі АТБ (документи однієї поставки). Використовується для COMDOC та ETTNv3 документів. Поле заповнюється при відправці е-ТТН чи фомується автоматично платформою EDI Network на підставі даних з документа-основи: «Повідомлення про відвантаження» (DESADV.NUMBER + DESADV.DATE + DESADV.ORDERNUMBER + DESADV.ORDERDATE). |
|
|
parent_doc_uuid |
VARCHAR |
uuid початкового документа / документа-підстави (записується також при заміні відправленої чернетки) |
||
|
139 |
format_version |
VARCHAR |
номер версії (поле C_DOC_VER) з Податкової накладної (DECLAR) чи Коригування до податкової накладної (DECLARj12) |
|
|
142 |
parent_docs_match |
INT |
0 - comdoc_007 зі зміненими даними для звірки по desadv; 1 - comdoc_007 з коректними / не зміненими даними для звірки по desadv |
|
|
149 |
post_start_date |
[yyyy-MM-dd] |
дата дедлайну для документів Метро 7а |
|
|
153 |
review_deadline_date |
[yyyy-MM-dd] |
термін подачі на перегляд для документів Метро 7b (ReviewDeadlineDate) |
|
|
sign_hash |
VARCHAR |
хеш підпису |
||
|
draft_date_created |
INT |
дата створення чернетки |
||
|
carrier_b_uuid |
BINARY |
ідентифікатор перевізника |
||
|
consignee_b_uuid |
BINARY |
ідентифікатор вантажоодержувача |
||
|
consignor_b_uuid |
BINARY |
ідентифікатор вантажовідправника |
||
|
external_doc_id |
INT |
id ТТН документа в ЦБД |
||
|
orderpartner_uuid |
BINARY |
ідентифікатор замовника (для документа ORDER з поля ORDERPARTNER) |
||
|
invoicepartner_uuid |
BINARY |
ідентифікатор платника (для документа ORDER з поля INVOICEPARTNER) |
||
|
finalrecipient_uuid |
BINARY |
ідентифікатор кінцевого консигнатора (для документів ORDER та DESADV з поля FINALRECIPIENT) |
||
|
is_offline_sign |
INT |
документ з офлайн підписом (мітка часу не підтверджена); 0-ні / 1-так |
||
|
car_number |
VARCHAR |
номер авто |
||
|
carrier |
VARCHAR |
GLN перевізника |
||
|
carrier_signed |
INT |
відмітка підписання перевізником (0-ні; 1-підписано (ТТН в статусі 6); 2-підписано (ТТН в статусі 7)) |
||
|
consignee |
VARCHAR |
GLN вантажоодержувача |
||
|
consignee_signed |
INT |
відмітка підписання вантажоодержувачем (0-ні; 1-підписано (ТТН в статусі 6); 2-підписано (ТТН в статусі 7)) |
||
|
consignor |
VARCHAR |
GLN вантажовідправника |
||
|
consignor_signed |
INT |
відмітка підписання вантажовідправником (0-ні; 1-підписано (ТТН в статусі 6); 2-підписано (ТТН в статусі 7)) |
||
|
customer |
VARCHAR |
GLN замовника |
||
|
driver |
VARCHAR |
GLN водія |
||
|
driver_signed |
INT |
відмітка підписання водієм (0-ні; 1-підписано (ТТН в статусі 6); 2-підписано (ТТН в статусі 7)) |
||
|
expeditor_signed |
INT |
відмітка підписання експедитором (0-ні; 1-підписано (ТТН в статусі 6); 2-підписано (ТТН в статусі 7)) |
||
|
gross_weight |
INT |
маса брутто (кг) |
||
|
load_point |
VARCHAR |
GLN пункту завантаження |
||
|
sub_status_next |
INT |
|||
|
trailer_number |
VARCHAR |
номер причіпа |
||
|
unload_point |
VARCHAR |
GLN пункту розвантаження |
||
|
family |
INT |
сімейство
|
||
|
hash |
VARCHAR |
хеш документа |
||
|
is_archive |
VARCHAR |
документ перенесено в архів (true / false) |
||
|
user_status |
INT |
список користувачів із відповідним статусом погодження (сценарії) в форматі: userID:statusID, де statusID:
|
||
|
ettn_process_act |
INT |
Присутність значення свідчить про створений Акт до ТТН v3: 1 - ТТН v3 заблоковано від певних дій (Акт знаходиться в опрацьовуванні (життєвий цикл Акта не завершено) |
||
|
ettn_process_act_type |
INT |
ідентифікатор типу (doc_type) документа (Акта), що був складений до ТТН і зараз знаходиться в опрацьовуванні (життєвий цикл Акта не завершено). Доступні значення: 133,134,135,136,137,138,139,140,141. За наявності цього параметра блокуються дії:
Розблокування дій з ТТН виконується автоматично після завершення життєвого циклу Акта. |
||
|
carrier_uuid |
VARCHAR |
GLN перевізника (він же sender Акта наданих послуг (Логістика)) |
||
|
driver_switch_uuid |
VARCHAR |
GLN нового водія (Акт перевантаження) |
||
|
driver_uuid |
VARCHAR |
Водій |
||
|
expeditor_uuid |
VARCHAR |
Експедитор |
||
|
load_place_uuid |
VARCHAR |
Місце завантаження (COMDOC_027/МісцеНавантаження/GLN) |
||
|
ettn_onstorage |
INT |
ідентифікатор статусу документа: Вантаж розвантажено та отримувач підписав Акт перевантаження на проміжному складі |
||
|
track_number |
VARCHAR |
Номер рейсу (може вказуватись Вантажовідправником для ТТН v2) |
||
|
last_trans_id |
VARCHAR |
Ідентифікатор останньої транзакції (додається після реєстрації транзакції або при створенні документа з нуля) |
||
|
finalised |
INT |
Відмітка про фіналізацію замовлення в сервісі Маркет (0-ні, 1-так) |
||
|
236 |
currency |
VARCHAR |
Валюта; доступні значення:
|
|
|
237 |
is_unilateral_signing |
INT |
Відправлений COMDOC містить поле «ОдностороннєПідписання» (документ підписується лише відправником); 0-ні, 1-так |
|
|
cloned_from |
UUID |
унікальний ідентифікатор документа, з якого даний документ був клонований |
||
|
ttn_in_process |
INT |
індекси для доаткових ключів пошуку Заявки / Підтвердження:
|
||
|
invoice_exist |
INT |
відмітка існування Рахунку в ланцюжку з TRANSPORTATIONORDER (+ дозволи створення Рахунку)
|
||
|
act_exist |
INT |
відмітка існування Акта наданих послуг в ланцюжку з TRANSPORTATIONORDER (+ дозволи створення Акта наданих послуг)
|
- [1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
-
Об’єкт StorageQuery (Дані для фільтрації)
Опис параметрів об’єкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
extraParams |
List<ExtraQueryParameters> |
масив об’єктів; набір індексів |
|
|
multiExtraParams |
List<ExtraQueryParameters> |
масив об’єктів; мультиіндекс (може приймати масив параметрів з масивами значень для кожного з параметрів) |
|
|
type |
M |
List<XDocType> |
масив об’єктів; список типів документів: 0 - всі типи, 1/2/3 … і більше - конкретний тип документа |
|
statuses |
M |
List<Integer> |
масив; список статусів (станів) документів, за якими буде відбуватися відбір:
|
|
extraStatuses |
List<Integer> |
масив; список екстрастатусів |
|
|
tags |
List<Long> |
масив; тег |
|
|
exchangeStatus |
O |
List<Integer> |
масив; статус документообігу |
|
docs |
List<Long> |
масив; документи |
|
|
docUUIDs |
List<UUID> |
масив; унікальні ідентифікатори документів |
|
|
partners |
List<Long> |
масив; ідентифікатори контрагентів |
|
|
families |
List<Integer> |
масив; ознака сервісу (сімейство)
|
|
|
direction |
M |
об’єкт; напрямок документообігу; вказуються відправник, отримувач і зв’язок між ними в умовах відбору документів |
|
|
limit |
O |
об’єкт; фільтр відбору (налаштування виводу даних) |
|
|
orderBy |
O |
OrderBy |
фільтрувати по даті чи опису документа |
|
groupBy |
O |
String |
об’єднані по id ланцюжка/документа |
|
number |
O |
String |
номер документа |
|
family |
O |
int |
сімейство
|
|
partnerId |
Long |
id роздрібної мережі |
|
|
chainHash |
String |
хеш-значення, отримане в результаті обробки ланцюжка |
|
|
docHash |
String |
хеш-значення, отримане в результаті обробки документа |
|
|
docCreate |
O |
об’єкт; дата створення документа (у форматі UNIX-timestamp) з / по |
|
|
docRead |
O |
об’єкт; дата прочитання документа (у форматі UNIX-timestamp) з / по |
|
|
docChanged |
O |
об’єкт; дата останньої зміни документа (у форматі UNIX-timestamp) з / по |
|
|
archive |
Boolean |
відмітка наявності архівної ознаки документа |
|
|
important |
boolean |
відмітка важливий документ |
|
|
visible |
boolean |
відмітка видимості |
|
|
loadBody |
boolean |
відмітка наявності тіла документа |
|
|
loadComments |
boolean |
відмітка наявності коментарів до документа |
|
|
loadStatuses |
boolean |
відмітка наявності статусів документа |
|
|
loadTags |
boolean |
відмітка наявності тегів документа |
|
|
loadChain |
boolean |
відмітка наявності ланцюжка документів |
|
|
loadAttachments |
boolean |
відмітка наявності вкладень |
Приклади для сервісу «EDI Network»
Отримати всі документи-чернетки, в яких відправником зазначений GLN 9864065732303
JSON приклад
{
"archive": false,
"direction":
{
"type": "EQ",
"sender":
[
"9864065732303"
]
},
"exchangeStatus":
[],
"family": 1,
"limit":
{
"offset": "0",
"count": 21
},
"statuses":
[
1
],
"tags":
[],
"type":
[
{
"type": 0,
"title": "all",
"description": "all"
}
],
"families":
[
1,
7
]
}
Отримати всі вхідні «Видаткові накладні», що знаходяться в статусі «Потребує підписання отримувачем»
JSON приклад
{
"statuses": [4, 5, 6],
"type": [
{
"type": 28
}
],
"limit": {
"offset": "0",
"count": 21
},
"exchangeStatus": [
1
],
"extraParams": [
{
"operator": "AND",
"type": "EQUALS",
"value": "6",
"fieldName": "sub_doc_type_id"
},
{
"operator": "AND",
"type": "EQUALS",
"value": "1",
"fieldName": "sub_status_id"
}
],
"tags": [],
"archive": false,
"direction": {
"type": "EQ",
"receiver": [
"9864066822430"
],
"sender": []
},
"family": 1
}
Отримати всі документи, окрім чернеток (масив statuses не містить «1»), в яких отримувачем є GLN 9864232304302
JSON приклад
{
"direction": {
"sender": [],
"receiver": ["9864232304302"],
"type": "EQ"
},
"exchangeStatus": [],
"family": "1",
"statuses": ["2","3","4","5","6","7"],
"type": [
{
"type": "0"
}
]
}
Отримати всі документи, окрім чернеток (масив statuses не містить «1»), в яких відправником є GLN 9864232304302
JSON приклад
{
"direction": {
"sender": ["9864232304302"],
"receiver": [],
"type": "EQ"
},
"exchangeStatus": [],
"family": "1",
"statuses": ["2","3","4","5","6","7"],
"type": [
{
"type": "0"
}
]
}
Отримати всі вхідні документи (GLN отримувача 9864232304302)
JSON приклад
{
"direction": {
"sender": [],
"receiver": ["9864232304302"],
"type": "EQ"
},
"exchangeStatus": [],
"family": "1",
"statuses": ["4","5","6"],
"type": [
{
"type": "0"
}
]
}
Отримати всі відправлені документи (GLN відправника 9864232304302)
JSON приклад
{
"direction": {
"sender": ["9864232304302"],
"receiver": [],
"type": "EQ"
},
"exchangeStatus": [],
"family": "1",
"statuses": ["2","3","6"],
"type": [
{
"type": "0"
}
]
}
Отримати документи з номером, рівним значенню «1001» (пошук серед усіх документів, окрім чернеток), в яких отримувачем є GLN 9864232304302
JSON приклад
{
"direction": {
"sender": [],
"receiver": ["9864232304302"],
"type": "EQ"
},
"exchangeStatus": [],
"family": "1",
"statuses": ["2","3","4","5","6","7"],
"number": "1001",
"type": [
{
"type": "0"
}
]
}
Отримати всі документи, окрім чернеток, для GLN відправника 9864232304302, що створені в травні 2019 (startTimestamp і finishTimestamp дати в форматі UNIX-timestamp за київським часом відносно UTC)
JSON приклад
{
"direction": {
"sender": ["9864232304302"],
"receiver": [],
"type": "EQ"
},
"exchangeStatus": [],
"family": "1",
"statuses": ["2","3","4","5","6","7"],
"type": [
{
"type": "0"
}
],
"extraParams": [
{
"operator": "AND",
"type": "MORE_EQ",
"fieldName": "doc_date",
"value": "1556668800"
},
{
"operator": "AND",
"type": "LESS_EQ",
"fieldName": "doc_date",
"value": "1559347199"
}
}Приклади для сервісу «Маркет»
Отримати список всіх відправлених «Замовлень» (ORDERS) для GLN відправника 9864232324065
JSON приклад
{
"archive": false,
"direction": {
"receiver": [],
"sender": ["9864232324065"],
"type": "EQ"
},
"exchangeStatus": [],
"extraParams": [],
"family": 8,
"multiExtraFields": [],
"statuses": [2],
"type": [
{
"type": 2
}
]
}
Отримати список всіх чернеток «Замовлень» (ORDERS) для GLN 9864232324065 (створювач-відправник)
JSON приклад
{
"archive": false,
"direction": {
"receiver": [],
"sender": ["9864232324065"],
"type": "EQ"
},
"exchangeStatus": [],
"extraParams": [],
"family": 8,
"multiExtraFields": [],
"statuses": [1],
"type": [
{
"type": 2
}
]
}
Приклади для сервісу «Вільний»
Отримати всі надіслані документи («statuses»: 2,3), що очікують підпису («action»: 0)
JSON приклад
{
"statuses": [
2,
3
],
"type": [
{
"type": 0
}
],
"limit": {
"count": 21,
"offset": "0"
},
"exchangeStatus": [],
"extraParams": [
{
"operator": "AND",
"type": "IN",
"value": "0",
"fieldName": "action"
}
],
"multiExtraParams": [],
"tags": [],
"archive": false,
"direction": {
"type": "EQ",
"sender": [
"7c30a623-b84f-44d1-bda1-fdcc5f8be3d7"
],
"receiver": []
},
"loadChain": true,
"family": 9
}Отримати всі вхідні документи («statuses»: 4,5) від вказаного відправника/-ів (sender:uuid)
JSON приклад
{
"statuses": [
4,
5
],
"type": [
{
"type": 0
}
],
"limit": {
"count": 21,
"offset": "0"
},
"exchangeStatus": [],
"extraParams": [],
"multiExtraParams": [],
"tags": [],
"archive": false,
"direction": {
"type": "EQ",
"sender": [
"831714cf-064b-4ce9-bdc4-b6a79784639c"
],
"receiver": [
"7c30a623-b84f-44d1-bda1-fdcc5f8be3d7"
]
},
"loadChain": true,
"family": 9
}- [1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
-
Додаткові поля (extra_fields)
Опис json-параметрів
|
Найменування |
Формат |
Опис |
|---|---|---|
|
extra_fields |
Map<String, String> |
масив об’єктів; набір індексів |
|
multi_extra_fields |
Map<String, List<String>> |
масив об’єктів; мультиіндекс. Може бути використаний для індексування елементів рядка |
Опис extra_fields параметрів
|
id параметра |
Найменування параметра |
Тип 1 |
Формат |
Опис параметра |
|---|---|---|---|---|
|
1 |
created_from |
UUID |
ідентифікатор документа або ланцюжка |
|
|
2 |
is_signed |
TINYINT |
відмітка про підписання;
|
|
|
3 |
encrypted |
TINYINT |
відмітка про шифрування |
|
|
4 |
comdoc_reestr_id |
INT |
id факторингового Реєстру на підставі комерційного документа |
|
|
5 |
comdoc_reestr_is_active |
TINYINT |
відмітка про активність факторингового договору |
|
|
6 |
ftpex_file_name |
VARCHAR |
найменування файлу, відправленого по FTP |
|
|
7 |
ftpex_file_date |
INT |
дата/час відправки документа по FTP |
|
|
8 |
inv_date |
INT |
дата документа invrpt (Звіт про інвентаризацію) |
|
|
9 |
inv_num |
VARCHAR |
номер документа invrpt (Звіт про інвентаризацію) |
|
|
10 |
error_code |
INT |
код помилки документообігу |
|
|
11 |
sub_doc_type_id |
INT |
id підтипу документа ( опис_підтипів ) |
|
|
12 |
sub_status_id |
INT |
id статусу документа (опис + опис для ETTN v3); характеризує стан ланцюжка документів для PRDRSRVN:
|
|
|
13 |
action |
VARCHAR |
статус/стан документа за здійсненими діями користувача; Для EDI: ORDER (тип документа):
RETANN:
PRICAT (тип документа):
COACSU (тип документа):
CONDRA:
Для Вільний:
Для ЕТТН:
|
|
|
14 |
buyer_uuid |
VARCHAR |
відправник документа |
|
|
15 |
consignee_uuid |
VARCHAR |
вантажоодержувач |
|
|
16 |
consignor_uuid |
VARCHAR |
вантажовідправник |
|
|
17 |
customer_uuid |
VARCHAR |
Покупець / Замовник |
|
|
18 |
performer_uuid |
VARCHAR |
виконавець |
|
|
19 |
supplier_uuid |
VARCHAR |
постачальник |
|
|
20 |
delivery_place_uuid |
VARCHAR |
місце доставки |
|
|
21 |
contract_date |
VARCHAR |
дата договору |
|
|
22 |
contract_number |
VARCHAR |
номер договору |
|
|
23 |
delivery_date |
M |
INT |
дата доставки |
|
24 |
order_number |
M |
VARCHAR |
номер замовлення |
|
25 |
order_date |
INT |
дата замовлення |
|
|
26 |
return_date |
INT |
дата повернення |
|
|
27 |
summ |
decimal |
сума з ПДВ / загальна сума штрафу (ORDRPT) |
|
|
28 |
parent_chain_hash |
MD5 |
хеш ланцюжка |
|
|
29 |
period |
VARCHAR |
крайня дата підпису документа |
|
|
31 |
trans_id |
VARCHAR |
id транзакції |
|
|
32 |
ttn |
VARCHAR |
номер накладної |
|
|
33 |
doc_start_date |
VARCHAR |
початок терміну підписання документа |
|
|
34 |
doc_end_date |
VARCHAR |
закінчення терміну підписання документа |
|
|
35 |
delivery_note_number |
VARCHAR |
номер накладної |
|
|
42 |
contract_gln |
VARCHAR |
GLN місце доставки при товарному узгодженні (Agreem->Comdoc) для сервісу Е-Специфікація. Також для EDI сервісу в нього пишеться поле ContractGLN з документа Метро 7а |
|
|
43 |
doc_date |
INT |
дата з документа |
|
|
44 |
delivery_agreement_number |
VARCHAR |
кількість узгоджень |
|
|
45 |
delivery_agreement_date |
INT |
дата узгодження |
|
|
46 |
varn |
VARCHAR |
ЮЗД id документа |
|
|
47 |
other_info |
TEXT |
додаткові дані |
|
|
48 |
sub_doc_date |
INT |
дата підтипу документа |
|
|
49 |
sub_doc_number |
VARCHAR |
номер підтипу документа |
|
|
50 |
doc_error |
TEXT |
помилка при роботі з документом |
|
|
51 |
doc_info |
TEXT |
коментар до документа |
|
|
52 |
old_doc_id |
INT |
id документа |
|
|
53 |
sub_status_date |
INT |
дата статусу документа (стан ланцюжка документів) |
|
|
54 |
from_doc_id |
INT |
порядковий номер документа в ланцюжку |
|
|
56 |
doc_num |
VARCHAR |
номер документа |
|
|
57 |
sender |
VARCHAR |
GLN відправника |
|
|
58 |
recipient |
VARCHAR |
GLN одержувача |
|
|
59 |
file_name |
VARCHAR |
найменування прикладаємого (вкладення) файлу |
|
|
60 |
xml_hash |
VARCHAR |
хеш змісту документа |
|
|
61 |
answer_doc_id |
INT |
id COMDOC документа відправленного у відповідь |
|
|
80 |
identifier |
VARCHAR |
ідентифікатор документа в системі клієнта |
|
|
82 |
compound_number |
VARCHAR |
складовий номер |
|
|
85 |
doc_process |
TINYINT |
процес, що здійснюється з документом даним учасником для Погодження:
|
|
|
87 |
users |
VARCHAR |
список користувачів (що приймають участь в сценарії погодження, тощо) |
|
|
88 |
basis_doc_subtype |
INT |
підтип документа-підстави |
|
|
89 |
basis_doc_number |
|
INT |
номер документа-підстави |
|
90 |
basis_doc_date |
INT |
дата документа-підстави |
|
|
116 |
ready_for_sign |
INT |
відмітка готовності до підписання (0-ні; 1-так) |
|
|
118 |
ready_for_send |
INT |
відмітка готовності до відправки (0-ні; 1-так) |
|
|
95 |
summ_without_tax |
decimal |
сума без ПДВ |
|
|
tax_summ |
decimal |
сума ПДВ |
||
|
129 |
receiving_note_number |
VARCHAR |
Номер повідомлення про прийом (DOCUMENTINVOICE…ReceivingAdviceNumber) |
|
|
137 |
branch_uuid |
VARCHAR |
uuid «гілки поставки» для мережі АТБ (документи однієї поставки). Використовується для COMDOC та ETTNv3 документів. Поле заповнюється при відправці е-ТТН чи фомується автоматично платформою EDI Network на підставі даних з документа-основи: «Повідомлення про відвантаження» (DESADV.NUMBER + DESADV.DATE + DESADV.ORDERNUMBER + DESADV.ORDERDATE). |
|
|
parent_doc_uuid |
VARCHAR |
uuid початкового документа / документа-підстави (записується також при заміні відправленої чернетки) |
||
|
139 |
format_version |
VARCHAR |
номер версії (поле C_DOC_VER) з Податкової накладної (DECLAR) чи Коригування до податкової накладної (DECLARj12) |
|
|
142 |
parent_docs_match |
INT |
0 - comdoc_007 зі зміненими даними для звірки по desadv; 1 - comdoc_007 з коректними / не зміненими даними для звірки по desadv |
|
|
149 |
post_start_date |
[yyyy-MM-dd] |
дата дедлайну для документів Метро 7а |
|
|
153 |
review_deadline_date |
[yyyy-MM-dd] |
термін подачі на перегляд для документів Метро 7b (ReviewDeadlineDate) |
|
|
sign_hash |
VARCHAR |
хеш підпису |
||
|
draft_date_created |
INT |
дата створення чернетки |
||
|
carrier_b_uuid |
BINARY |
ідентифікатор перевізника |
||
|
consignee_b_uuid |
BINARY |
ідентифікатор вантажоодержувача |
||
|
consignor_b_uuid |
BINARY |
ідентифікатор вантажовідправника |
||
|
external_doc_id |
INT |
id ТТН документа в ЦБД |
||
|
orderpartner_uuid |
BINARY |
ідентифікатор замовника (для документа ORDER з поля ORDERPARTNER) |
||
|
invoicepartner_uuid |
BINARY |
ідентифікатор платника (для документа ORDER з поля INVOICEPARTNER) |
||
|
finalrecipient_uuid |
BINARY |
ідентифікатор кінцевого консигнатора (для документів ORDER та DESADV з поля FINALRECIPIENT) |
||
|
is_offline_sign |
INT |
документ з офлайн підписом (мітка часу не підтверджена); 0-ні / 1-так |
||
|
car_number |
VARCHAR |
номер авто |
||
|
carrier |
VARCHAR |
GLN перевізника |
||
|
carrier_signed |
INT |
відмітка підписання перевізником (0-ні; 1-підписано (ТТН в статусі 6); 2-підписано (ТТН в статусі 7)) |
||
|
consignee |
VARCHAR |
GLN вантажоодержувача |
||
|
consignee_signed |
INT |
відмітка підписання вантажоодержувачем (0-ні; 1-підписано (ТТН в статусі 6); 2-підписано (ТТН в статусі 7)) |
||
|
consignor |
VARCHAR |
GLN вантажовідправника |
||
|
consignor_signed |
INT |
відмітка підписання вантажовідправником (0-ні; 1-підписано (ТТН в статусі 6); 2-підписано (ТТН в статусі 7)) |
||
|
customer |
VARCHAR |
GLN замовника |
||
|
driver |
VARCHAR |
GLN водія |
||
|
driver_signed |
INT |
відмітка підписання водієм (0-ні; 1-підписано (ТТН в статусі 6); 2-підписано (ТТН в статусі 7)) |
||
|
expeditor_signed |
INT |
відмітка підписання експедитором (0-ні; 1-підписано (ТТН в статусі 6); 2-підписано (ТТН в статусі 7)) |
||
|
gross_weight |
INT |
маса брутто (кг) |
||
|
load_point |
VARCHAR |
GLN пункту завантаження |
||
|
sub_status_next |
INT |
|||
|
trailer_number |
VARCHAR |
номер причіпа |
||
|
unload_point |
VARCHAR |
GLN пункту розвантаження |
||
|
family |
INT |
сімейство
|
||
|
hash |
VARCHAR |
хеш документа |
||
|
is_archive |
VARCHAR |
документ перенесено в архів (true / false) |
||
|
user_status |
INT |
список користувачів із відповідним статусом погодження (сценарії) в форматі: userID:statusID, де statusID:
|
||
|
ettn_process_act |
INT |
Присутність значення свідчить про створений Акт до ТТН v3: 1 - ТТН v3 заблоковано від певних дій (Акт знаходиться в опрацьовуванні (життєвий цикл Акта не завершено) |
||
|
ettn_process_act_type |
INT |
ідентифікатор типу (doc_type) документа (Акта), що був складений до ТТН і зараз знаходиться в опрацьовуванні (життєвий цикл Акта не завершено). Доступні значення: 133,134,135,136,137,138,139,140,141. За наявності цього параметра блокуються дії:
Розблокування дій з ТТН виконується автоматично після завершення життєвого циклу Акта. |
||
|
carrier_uuid |
VARCHAR |
GLN перевізника (він же sender Акта наданих послуг (Логістика)) |
||
|
driver_switch_uuid |
VARCHAR |
GLN нового водія (Акт перевантаження) |
||
|
driver_uuid |
VARCHAR |
Водій |
||
|
expeditor_uuid |
VARCHAR |
Експедитор |
||
|
load_place_uuid |
VARCHAR |
Місце завантаження (COMDOC_027/МісцеНавантаження/GLN) |
||
|
ettn_onstorage |
INT |
ідентифікатор статусу документа: Вантаж розвантажено та отримувач підписав Акт перевантаження на проміжному складі |
||
|
track_number |
VARCHAR |
Номер рейсу (може вказуватись Вантажовідправником для ТТН v2) |
||
|
last_trans_id |
VARCHAR |
Ідентифікатор останньої транзакції (додається після реєстрації транзакції або при створенні документа з нуля) |
||
|
finalised |
INT |
Відмітка про фіналізацію замовлення в сервісі Маркет (0-ні, 1-так) |
||
|
236 |
currency |
VARCHAR |
Валюта; доступні значення:
|
|
|
237 |
is_unilateral_signing |
INT |
Відправлений COMDOC містить поле «ОдностороннєПідписання» (документ підписується лише відправником); 0-ні, 1-так |
|
|
cloned_from |
UUID |
унікальний ідентифікатор документа, з якого даний документ був клонований |
||
|
ttn_in_process |
INT |
індекси для доаткових ключів пошуку Заявки / Підтвердження:
|
||
|
invoice_exist |
INT |
відмітка існування Рахунку в ланцюжку з TRANSPORTATIONORDER (+ дозволи створення Рахунку)
|
||
|
act_exist |
INT |
відмітка існування Акта наданих послуг в ланцюжку з TRANSPORTATIONORDER (+ дозволи створення Акта наданих послуг)
|
JSON приклад
{
"extra_fields": {
"sender": "4820128010004",
"doc_num": "ORG00000014",
"buyer_uuid": "4820128010004",
"delivery_date": "1551477600",
"order_number": "6422722fb78c4509b06eac43758e1545",
"supplier_uuid": "9864065702429",
"contract_number": "334455",
"delivery_place_uuid": "4820128019007",
"order_date": "1550181600",
"doc_date": "1555432208",
"action": "29"
}
}
[1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
-
Об’єкт XStatus
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
docId |
long |
id документа/квитанції |
|
date |
long |
дата статусу; формат unix timestamp |
|
type |
int |
тип статусу:
|
|
text |
String |
зміст статусу |
JSON приклад:
[
{
"docId": 3914,
"date": 1607695844,
"type": 1
}
]
Об’єкт XTag в параметрах об'єкта XDoc
Опис параметрів об’єкта XTag
|
Параметр |
Формат |
Опис |
|---|---|---|
|
id |
long |
id тега |
|
name |
String |
зміст тега |
|
shortName |
String |
коротка назва тега |
Об’єкт XDocSignInfo
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
doc_id |
long |
id документа/квитанції |
|
date |
long |
дата підписання; формат unix timestamp |
|
count |
short |
кількість підписів |
|
info |
String |
додаткова інформація |
|
hash |
String |
хеш-значення, отримане в результаті обробки |
Об’єкт XDocStatus
Опис параметрів об’єкту
|
id статусу |
статус |
|---|---|
|
0 |
ALL - будь-який статус |
|
1 |
OPEN - чернетка (відправник) |
|
2 |
SENT - відправлений (відправник) |
|
3 |
DELIVERED - доставлений (відправник) |
|
4 |
INBOX - вхідний (одержувач) |
|
5 |
READ - прочитаний (одержувач) |
|
6 |
ERROR - помилка |
|
7 |
DELETED - видалений |
Об’єкт XDocComment
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
id |
long |
id коментаря |
|
docUUID |
UUID |
унікальний ідентифікатор документа |
|
createTimestamp |
long |
дата створення коментаря у форматі timestamp |
|
authorLogin |
String |
автор коментаря |
|
comment |
String |
зміст коментаря |
Об’єкт XDocCommentsList
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
XDocCommentsList |
List<XDocComment> |
масив об’єктів; коментарі до документа |
Об’єкт XDocBodyForms
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
forms |
HashMap<String, XDocBody> |
масив об’єктів; тіло документа |
Об’єкт XDocBodyType
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
id |
int |
id типу тіла документа |
|
name |
String |
назва типу тіла документа |
Об’єкт XDocBody
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
type |
об’єкт; тип тіла документа: CONTENT = 1 - зміст в байтах; JSON = 2 - зміст в json форматі; SIGN = 3 - зміст підпису; STAMP = 4; CRYPTED = 5 - зміст в зашифрованому вигляді; UZDRESPONSE = 6 |
|
|
base64content |
String |
зміст тіла документа в BASE64 |
Об’єкт XDoc
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
body |
об’єкт; тіла документів |
|
|
attachments |
List<XDocAttachment> |
масив об’єктів; вкладення (може не використовуватися) |
|
comments |
об’єкт (в якому масив об’єктів); список коментарів |
|
|
doc_id |
long |
id документа |
|
doc_uuid |
UUID |
унікальний ідентифікатор документа/квитанції |
|
uuidSender |
String |
унікальний ідентифікатор відправника |
|
uuidReceiver |
String |
унікальний ідентифікатор одержувача |
|
docNumber |
String |
номер документа |
|
dateCreated |
long |
дата створення документа (unix timestamp); після відправки: дата відправки/отримання документа |
|
dateChanged |
long |
дата останньої зміни документа (unix timestamp) |
|
dateRead |
long |
дата прочитання документа (unix timestamp) |
|
docDate |
long |
дата документа, зазначена в документі |
|
chain_id |
long |
id ланцюжка документів |
|
chain_uuid |
UUID |
унікальний ідентифікатор ланцюжка документів |
|
family |
int |
сімейство
|
|
hash |
String |
хеш-значення, отримане в результаті обробки |
|
type |
об’єкт; тип документа |
|
|
status |
об’єкт; статус пари документів у відправника і одержувача |
|
|
exchange_status |
String |
сабстатус документа (детальніше) |
|
is_archive |
boolean |
відмітка; Архівний документ чи ні |
|
signInfo |
об’єкт; дані про підписи |
|
|
chain |
XChain |
об’єкт; дані пов’язаних ланцюжків |
|
extraFields |
Map<String, String> |
масив об’єктів; набір індексів (аналог індексних таблиць) |
|
tags |
List<XTag> |
масив об’єктів; прикріплені теги |
|
statuses |
List<XStatus> |
масив об’єктів; статуси обробки відправлених документів |
|
multiExtraFields |
Map<String, List<String>> |
масив об’єктів; мультиіндекс. Приклад: {„key1“: [„val1“, „val2“], „key2“: [„val1“, „val2“]}. Використовується, наприклад для обробки передаваємого рядка => розбивка рядка за умовою => індексування кожного шматка |
JSON приклад
{
"attachments": [],
"body": {
"forms": {
"json": {
"type": {
"id": 2,
"name": "json"
}
}
}
},
"chain_id": 0,
"comments": [],
"dateChanged": 0,
"dateCreated": 1574421527,
"dateRead": 0,
"docDate": 1565211600,
"docNumber": "2019-08-08-TEST-001",
"doc_id": 143,
"doc_uuid": "6ffc8dfa-1cd5-4137-82cf-29b5969c2e74",
"extraFields": {
"basis_doc_date": "1565211600",
"basis_doc_number": "1",
"basis_doc_subtype": "007",
"doc_date": "1565211600",
"doc_num": "2019-08-08-TEST-001",
"order_number": "1",
"recipient": "9864232319979",
"sender": "9864232319962",
"sub_doc_type_id": "006"
},
"family": 1,
"hash": "D4733FDDDEBE23B4E38DC5F257604234",
"is_archive": false,
"multiExtraFields": {},
"status": {
"status": 1,
"title": "open"
},
"statuses": [],
"tags": [],
"type": {
"description": "Коммерческий документ",
"title": "comdoc",
"type": 28
},
"uuidReceiver": "9864232319979",
"uuidSender": "9864232319962"
}
JSON приклад для сервіса Вільний
{
"body": {
"forms": {
"json": {
"type": {
"id": 2,
"name": "json"
}
}
}
},
"attachments": [
{
"id": 247,
"docUUID": "a4ab5f49-9f5b-4a05-ae61-825b76ef3e4a",
"attachmentUUID": "66c673fe-4beb-48e1-94bc-16bbae74ead6",
"fileName": "21-Speed-Front-Suspension-MTB-Snow-Beach-Bike-Fat-Bike.jpg",
"createDate": 1613753224,
"type": "image/jpeg",
"signs": [],
"signHash": "EQt6XqKdKdTsjH1e+zgHOyi6FwFohC/jS5XyBgYN4k8="
},
{
"id": 249,
"docUUID": "a4ab5f49-9f5b-4a05-ae61-825b76ef3e4a",
"attachmentUUID": "37280d06-c85e-42bc-aa97-670950d1739f",
"fileName": "1613469397472.png",
"createDate": 1613754039,
"type": "image/png",
"signs": [],
"signHash": "6zcK6RDHUxAV3icq6p0uMHmGfA1DYhfKZz053tw75+Y="
},
{
"id": 250,
"docUUID": "a4ab5f49-9f5b-4a05-ae61-825b76ef3e4a",
"attachmentUUID": "14904c6b-a83d-4e08-9bbf-5427d1d015f0",
"fileName": "8cb20e57bcf705981d4605d6af413a91.png",
"createDate": 1613754581,
"type": "image/png",
"signs": [],
"signHash": "B5qPxPAju4pZ3x9blBo+NQVFRv8TU/5rxkwAWnhAyPw="
}
],
"comments": [],
"doc_id": 125,
"doc_uuid": "a4ab5f49-9f5b-4a05-ae61-825b76ef3e4a",
"uuidSender": "7c30a623-b84f-44d1-bda1-fdcc5f8be3d7",
"uuidReceiver": "831714cf-064b-4ce9-bdc4-b6a79784639c",
"uuidReceivers": [
"831714cf-064b-4ce9-bdc4-b6a79784639c"
],
"docNumber": "1613753224",
"dateCreated": 1613753224,
"dateChanged": 1613754581,
"dateRead": 0,
"docDate": 1613753224,
"chain_id": 0,
"family": 9,
"hash": "D6387945D930C872219A5BA48FD50849",
"type": {
"type": 122,
"title": "simple_doc",
"description": "simple_doc"
},
"status": {
"status": 1,
"title": "open"
},
"exchange_status": "000000000000000000000000",
"is_archive": false,
"extraFields": {
"doc_title": "rock&roll123",
"action": "0"
},
"tags": [],
"statuses": [],
"multiExtraFields": {}
}
Об’єкт XDocType
Таблиця 1. Опис параметрів об'єкту XDocType
|
Параметр |
Формат |
Опис |
|
Об’єкт XDocType |
||
|
type |
int |
id типу документа/квитанції |
|
title |
String |
назва документа/квитанции |
|
description |
String |
опис документа/квитанції (найменування кирилицею) |
Таблиця 2. Опис типів документів для об'єкту XDocType
|
Тип |
Назва (doc_type) |
Опис (найменування кирилицею) |
|---|---|---|
|
0 |
all |
всі |
|
1 |
invoice |
|
|
2 |
orders |
|
|
3 |
recadv |
|
|
4 |
desadv |
|
|
5 |
ordrsp |
|
|
6 |
pricat |
|
|
7 |
comdis |
|
|
10 |
declar |
|
|
11 |
insdes |
|
|
12 |
desscc |
|
|
13 |
slsrpt |
|
|
14 |
invrpt |
|
|
15 |
coacsu |
|
|
17 |
iftmin |
|
|
18 |
retann |
|
|
19 |
iftmbf |
|
|
20 |
partin |
|
|
21 |
mscons |
|
|
22 |
transportationorder |
Заявка на транспортування / Підтвердження заявки на транспортування |
|
25 |
retins |
|
|
28 |
comdoc |
|
|
29 |
declarj12 |
|
|
30 |
condra |
|
|
35 |
metro7a |
|
|
39 |
metro7b |
|
|
40 |
prodlist |
|
|
41 |
agreem |
|
|
42 |
iftmbc |
|
|
59 |
documentinvoice |
|
|
60 |
prdrsrvn |
|
|
67 |
doccorinvoice |
|
|
72 |
metro7c |
|
|
98 |
quotes |
|
|
111 |
transhipment |
|
|
115 |
ordrpt |
|
|
118 |
docinvoiceact |
|
|
119 |
discrepancy |
|
|
120 |
contrl |
|
|
122 |
simple_doc |
Документ сервісу «Вільний» |
|
132 |
ttn_ecmr |
ETTN (v3) |
|
133 |
reload_ecmr |
Акт перевантаження (v3) |
|
134 |
disagreement_ecmr |
Акт розбіжностей (v3) |
|
135 |
consignee_change_ecmr |
|
|
136 |
storage_delivery_ecmr |
|
|
137 |
adjustment_ecmr |
Акт коригування (v3) |
|
138 |
storage_pickup_ecmr |
|
|
139 |
resealing_ecmr |
Акт переопломбування (v3) |
|
140 |
load_reject_ecmr |
|
|
141 |
stop_ecmr |
Об’єкт DistribexOrderResult
Опис параметрів обʼєкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
status |
String |
статус виконання запиту |
|
doc_uuid |
String |
ідентифікатор документа |
|
errors |
List<String> |
масив; помилки при формуванні Замовлення |
Приклад відповіді
{
"status": "OK",
"doc_uuid": "80928188-e10b-4f99-9db9-604addb77264",
"errors": []
}Приклад відповідей помилок
1. {
"status": "ERROR",
"errors": [
"Замовлена кількість перевищує встановлену квоту [1]"
]
}
2. {
"status": "ERROR",
"errors": [
"Замовлена кількість перевищує наявний залишок [1]"
]
}
3. {
"status": "ERROR",
"errors": [
"Сума замовлення менше мінімально встановленої суми"
]
}
4. {
"status": "ERROR",
"errors": [
"Сума замовлення перевищує максимально встановлену суму"
]
}
5. {
"status": "ERROR",
"errors": [
"Перевищена максимальна вага замовлення"
]
}
6. {
"status": "ERROR",
"errors": [
"Перевищено максимальну кількість позицій у замовленні"
]
}
7. {
"status": "ERROR",
"errors": [
"Перевищено максимальну кількість коробок на замовлення"
]
}
8. {
"status": "ERROR",
"errors": [
"Перевищено максимальну кількість палет на замовлення"
]
}
9. {
"status": "ERROR",
"errors": [
"Замовлена кількість не кратна упаковці [1]"
]
}
10. {
"status": "ERROR",
"errors": [
"java.sql.SQLException: Product not found: 42541040" // вказана позиція відсутня в прайс-листі
]
}
------------------------------
{
"status": "ERROR",
"errors": [
"Замовлена кількість перевищує встановлену квоту [1]",
"Замовлена кількість перевищує наявний залишок [1]",
"Замовлена кількість не кратна упаковці [1]",
"Замовлена кількість не кратна упаковці [2]",
"Сума замовлення перевищує максимально встановлену суму",
"Перевищена максимальна вага замовлення",
"Перевищено максимальну кількість позицій у замовленні",
"Перевищено максимальну кількість коробок на замовлення",
"Перевищено максимальну кількість палет на замовлення",
"java.sql.SQLException: Product not found: 42541040" // вказана позиція відсутня в прайс-листі
]
}Об’єкт XDistribexPreorder
Опис параметрів обʼєкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
positions |
List<Long> |
масив; позиції Замовлення |
|
id |
long |
ідентифікатор Замовлення |
|
producerId |
long |
ідентифікатор Продавця (Виробника) |
|
type |
int |
ідентифікатор підтипу документа:
|
|
docUuid |
UUID |
ідентифікатор документа-підстави |
|
content |
byte[] |
масив байтів; контент |
Приклад
{
"positions": [1186],
"id": 22,
"producerId": 13200791,
"type": 3,
"docUuid": "19e049cd-190d-4774-bdbe-e8801f6869a7",
"content": [91,123,34,108,105,115,116,95,105,100,34,58,49,49,56,54,44,34,113,110,116,121,34,58,53,54,125,93]
}Об'єкт XDistribexPreorderPosition
Опис параметрів обʼєкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
list_id |
long |
ідентифікатор товарної позиції |
|
barcode |
String |
штрихкод товарної позиції |
|
article |
String |
артикул товарної позиції |
|
qnty |
double |
кількість товарів для Попереднього замовлення (альтернативна назва quantity) |
Приклад запиту
{
"list_id": 123,
"barcode": "12000123",
"article": "art1",
"qnty": 123.00
}Об’єкт Сharacteristics (додаткові характеристики продукту)
Опис параметрів обʼєкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
recommended_order_pce |
О |
Число з плаваючою точкою (максимально: 10 знаків до крапки та 3 знаки після крапки) |
Рекомендоване замовлення, шт |
|
recommended_order_box |
О |
Число з плаваючою точкою (максимально: 10 знаків до крапки та 3 знаки після крапки) |
Рекомендоване замовлення, ящ |
|
secondary_sales |
О |
Число з плаваючою точкою (максимально: 10 знаків до крапки та 3 знаки після крапки) |
Вторинні продажі за 21 день, шт (у Покупця (Дистрибʼютора) по звітах. інформаційне) |
|
average_sales |
О |
Число з плаваючою точкою (максимально: 10 знаків до крапки та 3 знаки після крапки) |
Середньомісячні вторинні продажі (середні за останні 3 місяці), шт (у Покупця (Дистрибʼютора) по звітах. інформаційне) |
|
actual_qty_buyer |
О |
Число з плаваючою точкою (максимально: 10 знаків до крапки та 3 знаки після крапки) |
Залишок покупця, шт (у Покупця (Дистрибʼютора) по звітах. інформаційне) |
[1] - під визначенням колонки Тип мається на увазі скорочене позначення:
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
Об’єкт XPriceListProduct
Опис параметрів обʼєкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
group_id |
long |
ідентифікатор групи |
|
|
article |
M |
String |
артикул |
|
name |
M |
String |
назва товару |
|
barcode |
M |
String |
штрихкод |
|
user_code |
O |
String |
код УКТ ЗЕД |
|
unit_weight |
O |
String |
вага одиниці товару, кг |
|
box_qty |
M |
String |
одиниць в коробці |
|
box_weight |
O |
String |
вага коробки, кг |
|
box_in_layer |
O |
String |
кількість коробок в шарі, шт. |
|
box_in_palette |
O |
String |
кількість коробок на палеті, шт. |
|
palette_weight |
O |
String |
вага палети, кг |
|
producer_code |
O |
String |
код Продавця (Виробника) |
|
min_order_qty |
O |
float (10,3) |
Мінімальна кількість замовлення |
|
regions |
M |
String |
Область/країни наявності товару (перелік назв через кому) |
|
characteristics |
O |
об’єкт; додаткові характеристики продукту |
|
|
id |
long |
ідентифікатор товарної позиції |
|
|
date_created |
long |
дата створення запису про товар |
|
|
date_changed |
long |
дата внесених змін в дані товару |
|
|
producer_id |
long |
ідентифікатор Продавця (Виробника) |
|
|
product_id |
long |
ідентифікатор товару |
|
|
unit_id |
O |
long |
ідентифікатор одиниці виміру; допустимі значення:
|
|
price_without_vat |
M |
Double |
ціна одиниці без ПДВ, грн |
|
vat |
O |
int |
ставка ПДВ, % |
|
price_with_vat |
O |
Double |
ціна одиниці з ПДВ, грн |
|
price_discont |
O |
Double |
ціна одиниці зі знижкою без ПДВ, грн |
|
price_with_vat_discont |
O |
Double |
ціна одиниці зі знижкою з ПДВ, грн |
|
date_from |
long |
період дії з |
|
|
date_to |
long |
період дії по |
|
|
stock_balance |
O |
Double |
залишок |
|
comment |
O |
String |
коментарі |
|
quota |
O |
Double |
квота на замовлення |
|
multiplicity |
O |
int |
кратність кількості в замовленні. Значення кратно якому має бути заповнена кількість замовленої позиції |
|
is_promo |
O |
boolean |
відмітка «Акція!» |
|
is_new |
O |
boolean |
відмітка «Новинка!» |
|
is_public |
O |
boolean |
відмітка «Публічна позиція!» |
|
is_surcharge |
O |
boolean |
відмітка «Надбавка!» |
|
is_pickup |
O |
boolean |
відмітка «Самовивіз!» |
|
is_bestseller |
O |
boolean |
відмітка «Хіт продажу!» |
|
add_characteristics |
O |
String |
характеристики |
[1] - під визначенням колонки Тип мається на увазі скорочене позначення:
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
Об’єкт XPriceListElement
Опис параметрів обʼєкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
currency |
M |
String |
код валюти:
|
|
category_id |
O |
long |
ідентифікатор
|
|
category_name |
M |
String |
назва:
|
|
children |
O/M |
List<XPriceListElement> |
масив об’єктів;
|
|
prods |
M |
List<XPriceListProduct> |
масив об’єктів; дані товарів |
[1] - під визначенням колонки Тип мається на увазі скорочене позначення:
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
Приклад запиту
[
{
"currency": "UAH",
"category_id": 504,
"category_name": "Хлібобулочні вироби",
"children":
[
{
"category_id": 507,
"category_name": "Слойка",
"children":
[
{
"category_id": 508,
"category_name": "Слойка",
"children":
[],
"prods":
[
{
"group_id": 508,
"article": "2261628093012",
"name": "Палички листкові 1 кг",
"barcode": "2261628093012",
"box_qty": "1",
"box_weight": "1",
"characteristics":
{
"box_qty": "1",
"box_weight": "1"
},
"is_pickup": false,
"id": 19163,
"date_created": 1707489221,
"date_changed": 1707489221,
"producer_id": 13200791,
"product_id": 965,
"unit_id": 12,
"price_without_vat": 125.83,
"vat": 5,
"price_with_vat": 151.0,
"date_from": 1707429600,
"date_to": 1709157600,
"multiplicity": 0,
"is_promo": false,
"is_new": false,
"is_public": false,
"is_surcharge": false,
"is_bestseller": false
}
]
}
],
"prods":
[]
}
]
}
]
Об’єкт XTicketBody
Опис параметрів об'єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
docID |
long |
ідентифікатор документа |
|
transactionType |
int |
тип транзакції Для EDI:
Для ЕТТН v3: значення співпадають з sub_status_id |
|
type |
int |
тип квитанції |
|
version |
int |
версія; використовується для підрахунку кількості анулювань |
|
content |
byte[] |
вміст тіла квитанції |
|
base64content |
String |
вміст тіла квитанції в BASE64 |
Об’єкт XTicket
В масиві даних об'єктів передаються квитанції документа.
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
docID |
long |
ідентифікатор документа |
|
transactionType |
int |
тип транзакції |
|
version |
int |
версія; використовується для підрахунку кількості анулювань |
|
documentType |
int |
|
|
date |
long |
дата/час транзакції (у форматі UNIX TimeStamp) |
|
uuid |
UUID |
ідентифікатор документообігу (однаковий у межах ланцюжка) |
|
senderID |
long |
ідентифікатор відправника |
|
recipientID |
long |
ідентифікатор отримувача |
|
sosID |
int |
ідентифікатор провайдера документообігу |
|
status |
String |
статус квитанції
|
|
bodys |
List<XTicketBody> |
масив об’єктів; тіла квитанцій |
JSON приклад
[
{
"docID": 3788,
"transactionType": 1,
"version": 1,
"documentType": 59,
"date": 1635410558,
"uuid": "96c9669f-72eb-4a62-aba5-ccc0cf2b4557",
"senderID": 13200757,
"recipientID": 15399,
"sosID": 0,
"status": "00000100",
"bodys": [
{
"docID": 3788,
"transactionType": 1,
"type": 1,
"version": 1
}
]
},
{
"docID": 3788,
"transactionType": 2,
"version": 1,
"documentType": 59,
"date": 1635410741,
"uuid": "648b527c-6a7e-4e50-bc14-8ae6b6b51734",
"senderID": 15399,
"recipientID": 13200757,
"sosID": 0,
"status": "00010000",
"bodys": [
{
"docID": 3788,
"transactionType": 2,
"type": -1,
"version": 1
},
{
"docID": 3788,
"transactionType": 2,
"type": 1,
"version": 1
}
]
}
]
Об’єкт XDocAttachmentSign
Опис параметрів об'єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
attachmentId |
long |
id вкладення |
|
identifierId |
long |
id запису |
|
crc32hash |
long |
хеш контрольної суми підпису (CRC32 кодування) |
|
signerUUID |
String |
унікальний ідентифікатор підписанта |
|
signBody |
transient byte[] |
байтовий масив тіла підпису |
Об’єкт XDocAttachment
В даному об'єкті передаються дані файла-вкладення.
Опис параметрів об'єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
id |
long |
id вкладення |
|
docUUID |
UUID |
унікальний ідентифікатор документа |
|
attachmentUUID |
UUID |
унікальний ідентифікатор вкладення |
|
identifierId |
long |
ідентифікатор (id запису) |
|
fileName |
String |
найменування файлу |
|
createDate |
long |
дата створення вкладення; формат unix timestamp |
|
type |
String |
тип вкладення; це може бути числове значення (1-25) з довідника DICT.01.10 |
|
status |
int |
статус реєстрації в ЦБД
|
|
creatorUUID |
UUID |
GLN, від імені якого додається вкладення |
|
base64content |
String |
зміст вкладення в BASE64 |
|
content |
transient byte[] |
байтовий масив контенту |
|
signs |
List<XDocAttachmentSign> |
масив об’єктів; підписи вкладень (файлів) |
|
signHash |
String |
хеш тіла вкладення (в base64) для формування підпису |
JSON приклад
{
"id": 257,
"docUUID": "b6d1c701-86f3-4d6d-9da5-f7db284f78b9",
"attachmentUUID": "b7e53a94-dd61-4e8b-bc98-44100e434efb",
"fileName": "1613574143975.png",
"createDate": 0,
"type": "image/png",
"signs": [],
"signHash": "6FZSWM0tGh4+P6KoLF1ZA6+wo73WZZgaY3JHQB7hgu8="
}
Масив об’єктів одиниць виміру
Опис параметрів відповіді методу
|
Параметр |
Формат |
Опис |
|---|---|---|
|
id |
long |
ідентифікатор одиниці виміру |
|
name |
String |
найменування |
|
nameOKEI |
String |
найменування згідно державного класифікатора |
|
shortNameOKEI |
String |
сокращение згідно державного класифікатора |
|
OKEI |
String |
код державного класифікатора |
|
KSPOVO |
String |
код КСПОВО |
JSON приклад
[
{
"id": 1,
"name": "GRM",
"nameOKEI": "Грамм",
"shortNameOKEI": "г",
"OKEI": "163",
"KSPOVO": "0303"
},
{
"id": 2,
"name": "KGM",
"nameOKEI": "Килограмм",
"shortNameOKEI": "кг",
"OKEI": "166",
"KSPOVO": "0301"
},
{
"id": 3,
"name": "LTR",
"nameOKEI": "Литр",
"shortNameOKEI": "л",
"OKEI": "112",
"KSPOVO": "0138"
},
...
{
"id": 45,
"name": "OD",
"nameOKEI": "Единица (продукции)",
"shortNameOKEI": "од",
"KSPOVO": "2431"
}
]
Об'єкт Employee
Опис параметрів об’єкта
|
Параметр |
Тип поля 1 |
Формат |
Опис |
|---|---|---|---|
|
uuid |
O/M |
UUID |
ідентифікатор співробітника (параметр обов’язковий для редагування/оновлення даних співробітника) |
|
userId |
O |
long |
id користувача |
|
lastName |
M |
String |
прізвище співробітника |
|
firstName |
M |
String |
ім’я співробітника |
|
middleName |
O |
String |
по батькові співробітника |
|
ipn |
O |
long |
код ІПН співробітника |
|
|
M |
String |
email співробітника |
|
tel |
M |
String |
номер телефону співробітника |
|
docNum |
O |
String |
документ підстава |
|
docDate |
O |
long |
дата документа підстави у форматі UNIX TimeStamp |
|
chatId |
O |
long |
ідентифікатор чату (telegram помічник) |
|
identifiers |
O |
Map<Integer, String> |
додаткові дані; контакти |
|
aliases |
O |
List<String> |
масив аліасів (email) для сервісу Вільний |
-
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
-
JSON приклад
[
{
"uuid": "ac970fb6-194f-4801-8fe9-02cbeaa5c03e",
"userId": 2000988,
"lastName": "LastName",
"firstName": "FirstName",
"middleName": "MiddleName",
"ipn": "1111111111",
"email": "1@mail.com",
"tel": "380954443919",
"identifiers": {
"1": "AAA770099"
}
}
]Об'єкт Company
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
id |
long |
id компанії; число |
|
account |
об’єкт; дані акаунта |
|
|
name |
String |
повне найменування організації або ПІБ індивідуального підприємця |
|
ownership |
String |
форма власності; рядок 5 символів; jur - Юридична особа, fiz - Фізична особа |
|
edrpou |
String |
код ЄДРПОУ/КПП; рядок 50 символів |
|
inn |
String |
код ІПН; рядок 50 символів |
|
|
String |
пошта |
|
phone |
String |
№ телефону; рядок 50 символів |
|
ndsNumber |
String |
№ свідоцтва ПДВ; рядок 50 символів |
|
bankAccount |
String |
розрахунковий рахунок банку; рядок 50 символів |
|
bankName |
String |
назва банку; рядок 100 символів |
|
bankMfo |
String |
МФО банку, код-реквізит банку |
|
bankAddress |
String |
адреса банку; рядок 150 символів |
|
users |
List<User> |
масив об’єктів; |
Об'єкт Account
Опис параметрів об'єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
accountId |
long |
ID акаунта |
|
companyId |
long |
ID компанії |
|
company |
об’єкт; дані про компанію |
|
|
mfo |
String |
МФО банку |
|
paymentAccount |
String |
розрахунковий рахунок |
|
tariffId |
int |
ID тарифу |
|
fullName |
String |
ПІП користувача |
|
phone |
String |
телефон |
|
|
String |
|
|
dirPosition |
String |
посада директора |
|
activityBase |
String |
підстава діяльності |
|
isIndivOffer |
int |
відмітка про наявність індивідуального договору; 0 - ні, 1 - так |
|
adminAccountId |
long |
ID акаунту в Адмінці |
|
addInfo |
String |
додаткова інформація |
|
whiteList |
List<String> |
масив; список білих ip адрес |
|
decryptType |
int |
тип розшифровки; 1 - WEB; 2 - Cryptex |
|
cryptexServer |
String |
адреса cryptex-сервера на стороні клієнта |
|
status |
int |
статус; 0 - заблокований; 1 - активний |
|
accountInfo |
AccountInfo_ |
об’єкт; додаткова інформація про акаунт |
|
adminAccount |
AdminAccount_ |
об’єкт; данні по акаунту в Адмінці |
Об'єкти інформації по торгових мережах
Опис параметрів об'єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
id |
число |
ідентифікатор роздрібної мережі |
|
name |
рядок |
ім’я роздрібної мережі |
|
gln |
рядок (13) |
номер GLN організації |
|
aliasName |
рядок |
бренд ТЗ, альтернативне ім’я |
|
type |
число |
тип мережі, 1 - пряма, 2 - роумінгова |
JSON приклад
[
{
"id": 7,
"name": "Варус (ОМЕГА)",
"gln": "4820110632160",
"aliasName": "Варус(ОМЕГА))",
"type": 1
},
{
"id": 8,
"name": "Старый Колос",
"gln": "4829900003845",
"aliasName": "Олд_Колос",
"type": 1
},
{
"id": 9,
"name": "АТБ-маркет",
"gln": "4820128010004",
"aliasName": "АТБ-маркет",
"type": 1
},
{
"id": 17297,
"name": "Интеграция",
"gln": "1234567890123",
"aliasName": "Интеграция",
"type": 2
}
]
Об’єкт з values даними
Масив об’єктів з values даними використовується для передачі даних віртуального довідника.
Опис параметрів об'єкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
Для name=TRANSPORT: |
|||
|
isTrailer |
M |
int |
тип транспортного засобу:
|
|
number |
M |
String |
реєстраційний номер |
|
brand |
M |
String |
марка |
|
model |
M |
String |
модель |
|
type |
M |
String |
тип |
|
color |
O |
String |
колір |
|
Для name=TTN_RESPONSIBLE_PERSONS: |
|||
|
name |
M |
String |
ПІБ |
|
ipn |
M |
String |
IПН |
|
position |
M |
String |
Посада |
|
phone |
M |
String |
Телефон |
|
|
O |
String |
|
|
isPartner |
M |
String |
чи є представником Мережі: 0 -ні, 1-так |
|
companyGln |
M |
String |
GLN компанії |
|
Для name=comdoc_responsible: |
|||
|
surname |
M |
String |
Прізвище |
|
name |
M |
String |
Ім’я |
|
basement |
M |
String |
На підставі |
|
ipn |
M |
String |
ІПН Відповідальної Особи |
|
basementDate |
M |
Дата (РРРР-ММ-ДД) |
На підставі (дата) |
|
unit |
M |
String |
Посада |
|
secondName |
M |
String |
По батькові |
JSON приклад
[
"{\"isTrailer\":0,\"number\":\"AA0000AA\",\"brand\":\"Ferrari\",\"model\":\"F40\",\"type\":\"гоночна\",\"color\":\"червона\"}"
]
[
"{\"name\":\"Антимоскаль Іван Микитович\",\"ipn\":\"1234568445\",\"position\":\"артилерист\",\"phone\":\"380562351849\",\"email\":\"xevesid221@breazeim.com\",\"isPartner\":false,\"companyGln\":\"9864065732181\"}"
]
[
"{\"surname\":\"Шевченко\",\"name\":\"Тарас\",\"basement\":\"Важная\",\"ipn\":\"111111111111\",\"basementDate\":\"2022-09-01\",\"unit\":\"Гендир\",\"secondName\":\"Григорьевич\"}"
]
- [1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
Об’єкт UsersDataStorage
Даний об'єкт використовується для передачі значення з віртуального довідника.
Опис параметрів об'єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
id |
long |
ідентифікатор довідника |
|
name |
String |
назва довідника; допустимі значення:
|
|
values |
text |
json = набір полів, як значення довідника |
JSON приклад
{
"id": 2,
"name": "TRANSPORT",
"values": {
"16": "{\"isTrailer\":0,\"number\":\"AA0000AA\",\"brand\":\"Ferrari\",\"model\":\"F40\",\"type\":\"гоночна\",\"color\":\"червона\"}",
"17": "{\"isTrailer\":0,\"number\":\"ББ00000ББ\",\"brand\":\"Бусік\",\"model\":\"Старий\",\"type\":\"їздить\",\"color\":\"натуральний\"}"
}
}
Об’єкт Retailer
За допомогою масиву об'єктів Relailer передається інформація по торговельним мережам.
Опис параметрів об’єкта Retailer
|
Параметр |
Формат |
Опис |
|---|---|---|
|
id |
long |
ідентифікатор торгової мережі |
|
accountId |
long |
ідентифікатор акаунту |
|
name |
String |
назва торгової мережі |
|
gln |
String |
GLN торгової мережі |
|
aliasName |
String |
бренд торгової мережі |
|
details |
String |
|
|
type |
int |
тип/ознака торгової мережі (type=1) |
|
countryId |
int |
ідентифікатор країни |
|
startDate |
String |
дата додавання нової мережі (YYYY-MM-DD) |
|
visible |
boolean |
true - мережа відображається в Особистому кабінеті в списку доступних до підключення до Постачальника; false - мережа не відображається в Особистому кабінеті |
|
special |
boolean |
true - в мережі наявні спеціальні умови; false - мережа без спеціальних умов |
|
emails |
String |
список Email (через крапку з комою) отримувачів заявки на підключення до мережі |
|
copyEmails |
String |
список Email (через крапку з комою) для копії |
|
docTypes |
List<Integer> |
список ідентифікаторів підключених типів документів |
|
services |
List<String> |
список сервісів, які використовує мережа |
|
edrpouCode |
String |
код ЄДРПОУ торгової мережі |
|
legalAddress |
String |
юридична адреса торгової мережі |
|
isNewPositions |
boolean |
true - в Особистому кабінеті в мережу можливо Відправити комерційну пропозицію |
JSON приклад
[
{
"id": 17,
"accountId": 6442,
"name": "Метро",
"gln": "4820086630009",
"aliasName": "Метро",
"type": 1,
"visible": true,
"special": false,
"docTypes": [],
"services": [],
"isNewPositions": true
},
{
"id": 13,
"accountId": 1557,
"name": "Ашан",
"gln": "4824027999989",
"aliasName": "Ашан",
"type": 1,
"visible": true,
"special": false,
"docTypes": [],
"services": [],
"isNewPositions": true
},
{
"id": 246,
"accountId": 4530,
"name": "ЕКО-МАРКЕТ",
"gln": "4820129370008",
"aliasName": "ЕКО-МАРКЕТ",
"type": 1,
"visible": true,
"special": false,
"docTypes": [],
"services": [],
"isNewPositions": false
},
{
"id": 7,
"accountId": 9549,
"name": "Варус (ОМЕГА)",
"gln": "9864119011415",
"aliasName": "Варус(ОМЕГА)",
"type": 1,
"visible": true,
"special": false,
"emails": "kutsenkov@edin.ua",
"docTypes": [],
"services": [],
"isNewPositions": true
}
]Об’єкт User
В даному об'єкті передається інформація про користувача або кількох користувачів .
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
blockedServices |
List<String> |
масив; список коротких назв заблокованих сервісів, наприклад:
|
|
role |
int |
id ролі доступу користувача:
|
|
roleAccess |
int |
id типу ролі:
|
|
accountRole |
int |
id ролі в акаунті |
|
access |
Map<String, AccessStatus> |
масив; доступ |
|
identificators |
List<Identificator> |
масив; ідентифікатори |
|
filters |
List<UserFilterData> |
фільтри |
|
id |
long |
id користувача |
|
accountId |
long |
id акаунта |
|
login |
String |
логін користувача |
|
stringEmails |
String |
список E-mail адрес в одному рядку |
|
phone |
String |
телефон |
|
emails |
List<String> |
масив; E-mail адреси |
|
blocked |
int |
відмітка про блокування; число; 0 - немає, 1 - так |
|
allowFTP |
int |
відмітка доступу до FTP; число; 0 - немає, 1 - так |
|
autoSending |
boolean |
автовідправка документів |
|
statusFile |
int |
створення статус-файлів; число; 0 - Ні, 1 - Так, 2 - Так, про доставку, 3 - Так, про прочитання |
|
isNotificationEnabled |
int |
повідомлення на E-mail
|
|
isSatusFromOut |
boolean |
|
|
isAdmin |
boolean |
користувач є адміністратором |
|
isSpecXML |
boolean |
включена конвертація файлів |
|
isCerts |
int |
доступ до сервісу Е-Сертифікати; 0 - ні, 1 - так, 2 - так (Адміністратор) |
|
XMLConv |
int |
XML-конвертор
|
|
account |
об’єкт; дані акаунта |
|
|
companies |
List<Company> |
масив об’єктів; дані компаній |
|
employee |
об’єкт; дані співробітника |
|
|
isStatusNotification |
boolean |
статус повідомлення |
|
isPasswordChange |
boolean |
зміна паролю |
|
isSpecification |
int |
доступ до сервісу Е-Специфікація; 0-ні, 1-так |
|
statusNotifyTypes |
List<Integer> |
масив; типи статусів |
|
otherInfo |
UserOtherInfo |
об’єкт; додаткове інфо |
JSON приклад для передачі даних одного користувача
{
"blockedServices": [],
"role": 0,
"roleAccess": 0,
"accountRole": 4,
"access": {},
"identificators": [],
"filters": [],
"id": 77016,
"accountId": 40692,
"login": "FelexSpec1",
"stringEmails": "docerrors@edi-n.com",
"emails": [
"docerrors@edi-n.com"
],
"blocked": 0,
"allowFTP": 1,
"autoSending": true,
"statusFile": 0,
"isNotificationEnabled": 4,
"isSatusFromOut": false,
"isAdmin": false,
"isSpecXML": false,
"isCerts": 0,
"XMLConv": 0,
"account": {},
"employee": {},
"isStatusNotification": false,
"isPasswordChange": false,
"isSpecification": 1,
"statusNotifyTypes": [],
"otherInfo": {
"needOriginalFilename": 0
}
}JSON приклад для передачі даних кількох користувачів
[
{
"blockedServices": [],
"role": 2,
"roleAccess": 0,
"accountRole": 127,
"access": {},
"identificators": [],
"filters": [],
"id": 90688,
"accountId": 40692,
"login": "g1@gmail.com",
"stringEmails": "g1@gmail.com",
"phone": "380992369658",
"emails": [
"g1@gmail.com"
],
"blocked": 0,
"allowFTP": 0,
"autoSending": false,
"statusFile": 0,
"isNotificationEnabled": 1,
"isSatusFromOut": false,
"isAdmin": true,
"isSpecXML": false,
"isCerts": 2,
"XMLConv": 0,
"account": {
"id": 40692,
"name": "\"Тестова мережа - EDIN\"",
"ownership": "ТОВ",
"inn": "#",
"kpp": "34554363",
"mail": "kozlenkoy@edi-n.com",
"identificators": [],
"phone": "0443590112",
"ndsNumber": "#",
"users": [],
"billingMail": "kozlenkoy@edi-n.com",
"bankName": "#",
"bankAccount": "#",
"bankMfo": "#",
"bankAddress": "#",
"isOffert": false,
"country": "UA",
"address": "м. Київ, вул. Михайла Донця, буд.6",
"legalAddress": "м. Київ, вул. Михайла Донця, буд.6",
"factAddress": "м. Київ, вул. Михайла Донця, буд.6",
"directorName": "Франко І.Я.",
"tariffVersion": 1,
"directorPosition": "Директор",
"registrationDate": "2020-08-17 00:00:00",
"allowUnsignedComdoc": 0,
"allowUnsignedCondra": 0,
"platform": "FELEX",
"autoProlongation": true,
"docBasisForNTM": 0,
"isSignConfirm": 0,
"sessionsTTL": 3600,
"companies": []
},
"employee": {
"uuid": "3492a46f-998c-4aeb-990c-0293a8d59067",
"userId": 90688,
"lastName": "Прізвище",
"firstName": "Ім'я",
"email": "g1@gmail.com",
"tel": "380992369658",
"docDate": 0,
"identifiers": {},
"aliases": []
},
"isStatusNotification": false,
"isPasswordChange": false,
"isSpecification": 0,
"statusNotifyTypes": []
}
]
Об’єкт XDistribexSurcharge
Опис параметрів обʼєкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
surcharge |
boolean |
відмітка про надбавку |
|
producer_id |
long |
id Продавця (Виробника) |
|
distributor_id |
long |
id Покупця (Дистрибʼютора) |
|
distributor_gln |
String |
GLN Покупця (Дистрибʼютора) |
|
product_id |
long |
id товарної позиції |
|
barcode |
String |
штрихкод товарної позиції |
|
article |
String |
артикул товарної позиції |
Приклад запиту
[
{
"distributor_gln": "1234567890123",
"barcode" : "123000321",
"article" : "ART01",
"product_id" : 101,
"surcharge" : true
},
{
"distributor_gln": "1234567890123",
"barcode" : "123000322",
"article" : "ART02",
"product_id" : 102,
"surcharge" : true
}
]Приклад відповіді
{
"surcharge": false,
"producer_id": 13200791,
"distributor_id": 13200793,
"product_id": 149,
"barcode": "4820022867421",
"article": "7127"
}Об’єкт Quotas
Опис параметрів обʼєкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
quota |
double |
квота |
|
produser_id |
long |
ідентифікатор компанії-Продавця (Виробника) |
|
distrib_id |
long |
ідентифікатор компанії-Покупця (Дистрибʼютора) |
|
distrib_gln |
String |
GLN компанії-Покупця (Дистрибʼютора) |
|
product_id |
long |
ідентифікатор товару |
|
gtin |
String |
штрихкод |
|
name |
String |
назва компанії-Покупця (Дистрибʼютора) |
Приклад запиту
[
{
"distrib_gln": "9864065732327",
"gtin": "4820022867438",
"name": "Dist_Test_1",
"quota": 100.201
},
{
"distrib_gln": "9864065732334",
"gtin": "4820022867421",
"name": "Dist_Test_2",
"quota": 310.118
}
]Приклад відповіді
{
"quota": 25,
"produser_id": 13200791,
"distrib_id": 13200795,
"product_id": 149,
"gtin": "4820022867421"
}Об’єкт Identificator
Опис параметрів обʼєкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
guid |
String |
GUID організації |
|
taxNum |
String(50) |
Податковий ідентифікаційний номер |
|
ndsNum |
String(50) |
№ свідоцтва ПДВ |
|
manager |
String(100) |
ПІБ менеджера |
|
accountant |
String(100) |
ПІБ бухгалтера |
|
id |
long |
GLN ID |
|
gln |
String(13) |
GLN організації |
|
companyId |
long |
id акаунта |
|
retailerId |
long |
id мережі (ритейлера) |
|
isUzdAts |
int |
ЮЗД від АТС; 0-ні, 1-так |
|
isFinCrypt |
int |
шифрування FINDOC; 0-ні, 1-так |
|
countryId |
int |
ідентифікатор країни |
|
isERNN |
int |
схема обробки DECLAR; 0 - надсилання отримувачу тільки після успішної реєстрації в реєстрі, 1 - реєстрація після перевірки отримувачем, 3 - надсилання отримувачу без реєстрації |
|
name |
String(100) |
назва організації |
|
nameEn |
String |
назва організації латинницею |
|
companyType |
String(5) |
форма власності: jur - Юридична особа, fiz - Фізична особа |
|
companyInn |
String(50) |
код ІПН компанії |
|
companyKpp |
String(50) |
код ЄДРПОУ/КПП |
|
companyOgrn |
String(15) |
Основний Державний Реєстраційний Номер |
|
companyTaxDepartmentID |
String |
ідентифікатор відділення податкової інспекції |
|
dirLastName |
String(150) |
прізвище директора |
|
dirFirstName |
String(150) |
ім’я директора |
|
director |
String(100) |
ПІБ директора |
|
apartment |
String(20) |
квартира |
|
zip |
String(20) |
поштовий індекс |
|
katottg |
String(20) |
код КАТОТТГ |
|
city |
String(50) |
місто |
|
street |
String(100) |
назва вулиці |
|
regionCode |
String(3) |
код регіону |
|
bankName |
String(100) |
назва банку |
|
bankMfo |
String |
МФО банку, код-реквізит банку |
|
phone |
String(50) |
№ телефону |
|
bankAccount |
String(50) |
розрахунковий рахунок банку |
|
otherInfo |
String |
коментарі |
|
|
String(255) |
|
|
metroCode |
String(20) |
код точки доставлення |
|
IBAN |
String |
IBAN (англ. International Bank Account Number) |
|
district |
String |
назва району |
|
dpiCReg |
String |
регіон/область податкової |
|
dpiCRaj |
String |
район (по регіону) прив’язки до податкової |
|
account |
Account_ |
id акаунту |
|
isListex |
boolean |
підключений довідник Listex |
|
isDeclarDateNumRequired |
boolean |
обов’язковість № і дати ПН в ТН (МЕТРО) |
|
distribexUser |
int |
користувач сервісу; 1-Виробник; 2-Дистриб’ютор |
|
isWithoutTax |
boolean |
неплатник ПДВ |
|
additionalInfo |
IdentificatorAdditionalInfo_ |
додаткова інформація |
|
taxSource |
int |
Код ознаки джерела податкового номера
|
|
driverLicense |
String |
номер водійського посвідчення |
|
isDriver |
boolean |
має роль Водій (робота з ТТН та коригуючими Актами) |
|
isSignConfirm |
int |
gln підтверджений КЕП (0-ні; 1-так) |
|
isSpecification |
int |
доступ до сервісу Е-Специфікація (0-ні; 1-так) |
|
isCompany |
int |
атрибут; Основний GLN компанії (0-ні; 1-так) |
|
parentId |
long |
значення Основного GLN компанії |
|
parentIdentificator |
Identificator |
дані Основного GLN (за наявності) |
Приклад запиту
[
{
"manager": "#",
"id": 13200791,
"gln": "9864065732303",
"companyId": 32657,
"retailerId": 0,
"isUzdAts": 0,
"isFinCrypt": 0,
"countryId": 2,
"isERNN": 0,
"name": "PRO_Test",
"companyType": "fiz",
"companyInn": "1010101016",
"companyKpp": "34554363",
"zip": "996633",
"city": "г. Киев",
"street": "вул. Трудітся, 7",
"phone": "380696969696",
"otherInfo": "[]",
"IBAN": "UA696456000000147852369000696",
"dpiCReg": 26,
"dpiCRaj": 1,
"isListex": true,
"isDeclarDateNumRequired": true,
"distribexUser": 1,
"isWithoutTax": false,
"taxSource": 0,
"isDriver": false,
"isSignConfirm": 1,
"isSpecification": 0,
"isCompany": 0,
"isTemporary": 0,
"parentId": 13200757,
"constructorGroupID": 0
}
]Об’єкт XDistribexInvitation
Опис параметрів обʼєкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
id |
-/M |
long |
ідентифікатор запрошення; параметр обов’язковий при оновленні запрошення |
|
userId |
long |
ідентифікатор користувача Продавця (Виробника) |
|
|
producer |
long |
ідентифікатор Продавця (Виробника) |
|
|
buyerContact |
O/M |
String |
контакт (email або мобільний номер телефону) Покупця (Дистриб’ютора); параметр обов’язковий при масовому надсиланню запрошень |
|
buyerIPN |
O |
String |
ЄДРПОУ / ІПН Покупця (Дистриб’ютора) |
|
status |
int |
статус запрошення:
|
|
|
date |
long |
дата/час надсилання запрошення (у форматі Unix timestamp) |
|
|
comment |
String |
текстовий коментар, що додається при відхиленні запрошення |
|
|
attachmentId |
long |
ідентифікатор вкладення (pdf-файлу) - інформаційного листа від Продавця |
|
|
attachment |
transient byte[] |
контент вкладення (pdf-файлу) |
|
|
producerId |
об’єкт; ідентифікатори Продавця (Виробника) |
-
[1] - під визначенням колонки Тип мається на увазі скорочене позначення:
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
Приклад запиту
[
{
"id": 1249,
"userId": 50206659,
"producer": 13200791,
"buyerContact": "maxecid823@craftapk.com",
"buyerIPN": "125365845",
"status": 0,
"date": 1729004947,
"attachmentId": 37,
"producerId":
{
"manager": "#",
"id": 13200791,
"gln": "9864065732303",
"companyId": 32657,
"retailerId": 0,
"isUzdAts": 0,
"isFinCrypt": 0,
"countryId": 2,
"isERNN": 0,
"name": "PRO_Test",
"companyType": "fiz",
"companyInn": "1010101016",
"companyKpp": "34554363",
"zip": "996633",
"city": "г. Киев",
"street": "вул. Трудітся, 7",
"phone": "380696969696",
"otherInfo": "[]",
"IBAN": "UA696456000000147852369000696",
"dpiCReg": 26,
"dpiCRaj": 1,
"isListex": true,
"isDeclarDateNumRequired": true,
"distribexUser": 1,
"isWithoutTax": false,
"taxSource": 0,
"isDriver": false,
"isSignConfirm": 1,
"isSpecification": 0,
"isCompany": 0,
"isTemporary": 0,
"parentId": 13200757,
"constructorGroupID": 0
}
}
]Обʼєкт Limits
Опис параметрів обʼєкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
credit_limit |
float (10,4) |
кредитний ліміт |
|
max_pack_qty |
число позитивне (10) |
максимальна кількість коробок / ящиків |
|
max_pallet_qty |
число позитивне (10) |
максимальна кількість палет |
|
max_pos_qty |
число позитивне (10) |
Макс. кількість товарних позицій |
|
max_sum_nds |
float (10,4) |
максимальна сума замовлення з ПДВ |
|
max_sum_without_nds |
float (10,4) |
максимальна сума замовлення без ПДВ |
|
max_weight |
float (13,3) |
максимальна вага замовлення, кг |
|
min_sum_nds |
float (10,4) |
мінімальна сума замовлення з ПДВ |
|
min_sum_without_nds |
float (10,4) |
мінімальна сума замовлення без ПДВ |
|
multiplicity_packing |
int |
кратність коробці/ящику; 0-ні, 1-так |
|
surcharge_rate |
float (10,2) |
Тариф для надбавки |
|
multiplicity_min_order_qty |
int |
Кратність мінімальній кількості одиниць; 0-ні, 1-так |
|
balance_quota_control |
int |
Контроль залишків та квот; 0-ні, 1-так. За balance_quota_control=0 Покупець може замовити більше встановленого залишку та/або квоти |
|
max_return_days |
число позитивне (3) |
Максимальна кількість днів для повернення товару |
Приклад запиту
{
"9864065732327": {
"credit_limit": "25005678.0124",
"max_pack_qty": "11",
"max_pallet_qty": "3",
"max_pos_qty": "6",
"max_sum_nds": "20005678.1124",
"max_weight": "50.001",
"min_sum_nds": "1000.0124",
"multiplicity_packing": "1"
}
}
Приклад відповіді
{
"max_pallet_qty": "3",
"max_weight": "50.001",
"max_pack_qty": "11",
"max_sum_nds": "20005678.1124",
"credit_limit": "25005678.0124",
"multiplicity_packing": "0",
"min_sum_nds": "1000.0124",
"max_pos_qty": "6"
}Обʼєкт XTag
Опис параметрів об’єкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
id |
|
long |
id тега |
|
name |
|
String |
назва тега |
|
shortName |
O |
String |
коротка назва тега (необов'язково) |
Приклад запиту
[
{
"id": "ід тега",
"name": "назва тега"
}
]-
[1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
-
-
Об'єкт EttnV3Event
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
entityId |
String |
id події |
|
entityType |
String |
тип події |
|
ettnId |
String |
id ТТН документа в ЦБД (= external_doc_id) |
|
entityStatus |
String |
статус події |
|
timestamp |
String |
дата/час події |
|
documentId |
String |
id документа |
|
actorIdentifier |
String |
ЄДРПОУ/ІПН компанії |
JSON приклад
[
{
"entityId": "050ae960-1a34-4720-ad8b-19e03d87ff03",
"entityType": "ETTN",
"ettnId": "050ae960-1a34-4720-ad8b-19e03d87ff03",
"entityStatus": "PLANNED",
"timestamp": "2022-01-10T15:31:13.863Z",
"documentId": "bb1f6c52-273f-4442-97ee-6f28340cb30d",
"actorIdentifier": "12345678"
},
{
"entityId": "40123cf2-498c-4386-ba2d-72f190accbfb",
"entityType": "ETTN",
"ettnId": "40123cf2-498c-4386-ba2d-72f190accbfb",
"entityStatus": "PLANNED",
"timestamp": "2022-01-10T16:22:13.995Z",
"documentId": "abf60787-e884-418b-8718-2be189081287",
"actorIdentifier": "12345678"
},
{
"entityId": "20bf123b-1b6b-4707-b728-f62e40f3b0e5",
"entityType": "ETTN",
"ettnId": "20bf123b-1b6b-4707-b728-f62e40f3b0e5",
"entityStatus": "PLANNED",
"timestamp": "2022-01-11T08:05:37.896Z",
"documentId": "c59aab2b-8d6e-4f08-9203-0d1a0d7718b4",
"actorIdentifier": "12345678"
},
{
"entityId": "cf53985a-8af8-46e2-bd28-de50eb84421d",
"entityType": "ETTN",
"ettnId": "cf53985a-8af8-46e2-bd28-de50eb84421d",
"entityStatus": "PLANNED",
"timestamp": "2022-01-11T08:08:22.232Z",
"documentId": "c62fe08b-5837-4acc-b812-70bb5a464447",
"actorIdentifier": "12345678"
}
]
Об'єкт XEvent (Подія за документом)
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
id |
long |
ідентифікатор події |
|
docId |
long |
id документа |
|
type |
int |
тип події:
|
JSON приклад об'єкту:
{
"id": 25,
"docId": 3229,
"type": 2
}JSON приклад масиву об'єктів:
-
-
[ { "id": 23, "docId": 2227, "type": 4 }, { "id": 24, "docId": 3228, "type": 2 }, { "id": 25, "docId": 3229, "type": 2 } ]
-
Об'єкт DocumentEvent
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
event |
об’єкт; дані події |
|
|
doc |
об’єкт; дані документа (можуть бути відсутні при типі події (XEvent.type) = 6 (чернетку видалено) |
Об'єкт EventsStorageQueryResult (результати пошуку подій за документами)
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
lastEventId |
long |
ідентифікатор останньої події |
|
items |
List<DocumentEvent> |
масив об’єктів; дані подій та документів |
JSON приклад:
{
"lastEventId": 26,
"items": [
{
"event": {
"id": 22,
"docId": 2229,
"type": 4
},
"doc": {
"body": {
"forms": {
"json": {
"type": {
"id": 2,
"name": "json"
}
},
"content": {
"type": {
"id": 1,
"name": "content"
}
}
}
},
"attachments": [
{
"id": 92,
"docUUID": "c4893135-155c-4c77-a4a7-00145e819217",
"attachmentUUID": "205d3da1-59e0-427d-bd5e-e65f2081d629",
"fileName": "dobroe_utro.jpg",
"createDate": 1669996758,
"type": "image/jpeg",
"signs": [],
"signHash": "W/kdOwRWzCxNIq230Q5lLbMpxYvUhwQHwH8VlTmFfHE="
}
],
"comments": [],
"doc_id": 2229,
"doc_uuid": "c4893135-155c-4c77-a4a7-00145e819217",
"uuidSender": "9864065732181",
"uuidReceiver": "9864065732211",
"uuidReceivers": [
"9864065732211"
],
"docNumber": "882_3",
"dateCreated": 1599117969,
"dateChanged": 1669996758,
"dateRead": 0,
"docDate": 1599080400,
"chain_id": 661,
"chain_uuid": "10d8731d-8575-4d01-9de3-5d7a880dfe07",
"family": 1,
"hash": "FC38F425650BF9CAA0ACB6583B529F35",
"type": {
"type": 30,
"title": "condra",
"description": "Не структурированный документ "
},
"status": {
"status": 4,
"title": "inbox"
},
"exchange_status": "000000000000000000000001",
"is_archive": false,
"chain": {
"id": 661,
"uuid": "10d8731d-8575-4d01-9de3-5d7a880dfe07",
"packageID": 0,
"type": 0,
"docsCount": 1,
"lastInDocID": 2229,
"lastOutDocID": 0,
"partnerId": 17264,
"important": false,
"status": {
"status": 4,
"title": "inbox"
},
"visualStatus": 0,
"archive": false,
"childs": [],
"hash": "DC66EF41FFC2E4EED451D6EE28104973"
},
"extraFields": {
"varn": "3fdd4faf-df46-49c4-9e43-7ac94b5b64a2",
"partner_id": "17264",
"sender": "9864065732181",
"doc_num": "882_3",
"file_name": "dobroe_utro.jpg",
"doc_date": "1599080400",
"recipient": "9864065732211",
"action": "1",
"trans_id": "fc1eba11-1ddb-40dc-8659-6bec23904862"
},
"tags": [],
"statuses": [],
"multiExtraFields": {}
}
}
]
}
Об'єкт EventsStorageQuery (параметри пошуку подій)
Опис параметрів об’єкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
fromId |
M |
long |
ідентифікатор події, після якої (починаючи з наступної) необхідно отримати список наступних подій |
|
limit |
O |
int |
кількість подій, що будуть повернені за пошуком. Max=100 (за замовчуванням) |
|
skipTypes |
O |
List<Integer> |
масив; типи подій, що НЕ потрібно враховувати при пошуку
|
|
loadBody |
O |
boolean |
передавати у відповіді пошуку тіло документа |
|
loadComments |
O |
boolean |
передавати у відповіді пошуку коментарі документа |
|
loadStatuses |
O |
boolean |
передавати у відповіді пошуку статуси документа |
|
loadTags |
O |
boolean |
передавати у відповіді пошуку теги документа |
|
loadChain |
O |
boolean |
передавати у відповіді пошуку дані пов’язаного ланцюжка документів |
|
loadAttachments |
O |
boolean |
передавати у відповіді пошуку вкладення до документа |
JSON приклад:
{
"fromId": 21,
"loadBody": true,
"loadComments": true,
"loadStatuses": true,
"loadTags": true,
"loadChain": true,
"loadAttachments": true
}- 1 - Під визначенням колонки Тип поля мається на увазі скорочене позначення:
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-