Робота з довідниками

Всі запити нижче перерахованих API методів платформи EDIN 2.0 направляються на адресу: https://edo-v2.edin.ua

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

Отримання інформації по авторизованому користувачу:

GET /api/oas/user

За допомогою цього метода можна отримати інформацію про користувача, наприклад ID користувача, ID акаунта, логін, чи має користувач «права адміністратора» (true / false), дані про платформу та інші ідентифікатори.

REQUEST

URL	https://edo-v2.edin.ua
Метод запиту	GET
URL запиту	/api/oas/user
Headers
Authorization	SID - токен, отриманий при авторизації
Content-Type	application/json

RESPONSE

В тілі відповіді передається інформація про користувача (об’єкт User).

Отримання інформації про всіх користувачів компанії (на рівні акаунта):

GET /api/oas/account/users

REQUEST

URL	https://edo-v2.edin.ua
Метод запиту	GET
URL запиту	/api/oas/account/users
URL параметри	type (опціонально) String - тип очікуваної відповіді; можливі варіанти: full (за замовчуванням) short
Headers
Authorization	SID - токен, отриманий при авторизації
Content-Type	application/json

RESPONSE

В тілі відповіді передається інформація про користувачів (масив об’єктів User).

Отримання інформації по GLN номерам, пов’язаним з авторизованим користувачем (на рівні акаунта):

GET /api/oas/account/identifiers

Метод дозволяє користувачеві переглядати додаткову інформацію про інших користувачів на рівні одного загального акаунта.

REQUEST

URL	https://edo-v2.edin.ua
Метод запиту	GET
URL запиту	/api/oas/account/identifiers
Headers
Authorization	SID - токен, отриманий при авторизації
Content-Type	application/json

RESPONSE

В тілі відповіді передається інформація по GLN номерам в вигляді масиву об’єктів Identificator.

Отримання переліку роздрібних мереж, які пов’язані із заданим GLN:

GET /api/oas/retailers

За допомогою цього метода можна отримати перелік всіх роздрібних мереж-контрагентів користувача.

REQUEST

URL	https://edo-v2.edin.ua
Метод запиту	GET
URL запиту	/api/oas/retailers?gln=9864065702429
URL параметри	gln - рядок (13); номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта
Headers
Authorization	SID - токен, отриманий при авторизації
Content-Type	application/json

RESPONSE

В тілі відповіді передається інформація про роздрібні мережі.

Отримання переліку GLN номерів, які пов’язані із заданою роздрібною мережею:

GET /api/oas/retailer/identificators

REQUEST

URL	https://edo-v2.edin.ua
Метод запиту	GET
URL запиту	/api/oas/retailer/identificators?retailer_id=11
URL параметри	retailer_id - число; ідентифікатор роздрібної мережі (праметр retailerId з попередніх методів)
Headers
Authorization	SID - токен, отриманий при авторизації
Content-Type	application/json

RESPONSE

В тілі відповіді передаються дані про контрагентів (масив об’єктів Identificator).

Отримання переліку всіх мереж, пов’язаних з авторизованим користувачем:

GET /api/oas/allretailers

REQUEST

URL	https://edo-v2.edin.ua
Метод запиту	GET
URL запиту	/api/oas/allretailers
Headers
Authorization	SID - токен, отриманий при авторизації
Content-Type	application/json

RESPONSE

В тілі відповіді передається інформація по мережам в вигляді масиву об’єктів.

Отримання переліку доступних одиниць виміру:

GET /api/oas/units

Метод дозволяє відобразити довідник одиниць виміру.

REQUEST

URL	https://edo-v2.edin.ua
Метод запиту	GET
URL запиту	/api/oas/units
Headers
Authorization	SID - токен, отриманий при авторизації
Content-Type	application/json

RESPONSE

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

Отримання інформації про організацію по Назві/ІПН/КПП/GLN:

GET /api/oas/identifiers

Метод дозволяє користувачеві переглядати додаткову інформацію про інші організації на рівні одного загального акаунта, а також знайти Основний GLN за Додатковим GLN.

Основний GLN має унікальний ЄДРПОУ на рівні платформи. Використовується для документів, що потребують дані юридичної особи та подальшого підписання КЕП. Створюється автоматично при реєстрації на платформі EDI Network.

Додатковий GLN підв’язується до «Основного GLN». Використовується для указання точок доставки, дрібних магазинів і т.і.

REQUEST

URL	https://edo-v2.edin.ua
Метод запиту	GET
URL запиту	/api/oas/identifiers?gln=9864232319979&query=1234567891234
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 параметром можуть застосовуватись додаткові фільтри: katottg_required (опціонально) boolean - при true значенні пошук здійснюється лише по записах з заповненим значенням коду КАТОТТГ; is_company (опціонально) boolean - при true значенні пошук здійснюється лише за Основним GLN компанії; driver_license_required (опціонально) boolean - при true значенні пошук здійснюється лише по записах з вказаним водійським посвідченням
Headers
Authorization	SID - токен, отриманий при авторизації
Content-Type	application/json

RESPONSE

В тілі відповіді передається інформація про організацію (масив об’єктів Identificator).