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

Для роботи з цим методом користувач повинен бути `авторизованим <https://wiki.edi-n.com/ru/latest/integration_2_0/API/Authorization.html`__ .

Метод запиту

HTTP GET

Content-Type

application/json (тіло HTTP запиту / відповіді в json форматі)

URL запиту

https://edo-v2.edi-n.com/api/oas/retailer/identificators?retailer_id=11

Параметры, передаваемые в URL (вместе с адресом метода)

У рядку заголовка (Header) «Cookie» обов’язково передається SID - токен отриманий при авторизації

Обов’язкові url-параметри:

retailer_id - число; ідентифікатор роздрібної мережі (з попередніх методів)

Підказка

Також можливо виконати запит у вигляді curl-рядка:

curl -X GET „/api/oas/retailer/identificators?retailer_id=11“ -b „SID=458a0d38-5b56-4b8e-8998-009a1edd31eb“

Специфікація для розшифровки ключів curl запиту: https://curl.haxx.se/docs/manpage.html

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

У цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

Відповідь: масив об’єктів даних про контрагентів

Таблиця 1 - Опис json-параметрів, які можуть передаватися у відповідь на метод API

Параметр	Формат	Опис
	Об’єкт Identificator
guid	String	GUID організації
taxNum	String	Податковий ідентифікаційний номер; рядок 50 символів
ndsNum	String	№ свідоцтва ПДВ; рядок 50 символів
manager	String	ПІБ менеджера; рядок 100 символів
accountant	String	ПІБ бухгалтера; рядок 100 символів
id	long	ID користувача
gln	String	GLN організації, яка пов’язана з авторизованим користувачем?; рядок 13 символів
companyId	long	id аккаунта; число
retailerId	long	id мережі (ритейлера); число
name	String	назва організації; рядок 100 символів
companyType	String	форма власності; рядок 5 символів; jur - Юридична особа, fiz - Фізична особа
companyInn	String	код ІПН компанії; рядок 50 символів
companyKpp	String	код ЄДРПОУ/КПП; рядок 50 символів
companyOgrn	String	Основний Державний Реєстраційний Номер; рядок 15 символів
companyTaxDepartmentID	String	ідентифікатор відділення податкової інспекції
dirLastName	String	прізвище директора; рядок 150 символів
dirFirstName	String	ім’я директора; рядок 150 символів
apartment	String	квартира; рядок 20 символів
zip	String	поштовий індекс; рядок 20 символів
city	String	місто; рядок 50 символів
street	String	назва вулиці; рядок 100 символів
regionCode	String	код регіону; рядок 3 символу
bankName	String	назва банку; рядок 100 символів
bankMfo	String	МФО банку, код-реквізит банку
phone	String	№ телефону; рядок 50 символів
bankAccount	String	розрахунковий рахунок банку; рядок 50 символів
otherInfo	String	коментарі
email	String	E-mail; рядок 255 символів
metroCode	String	код точки доставки; рядок 20 символів

Таблиця 2 - Опис параметрів об’єкта Account)

Параметр	Формат	Опис
	Об’єкт Account
platform	enum	ознака приналежності до платформи EVO/FELEX
id	int	id аккаунта; число 11 символів
name	String	повне найменування організації або ПІБ індивідуального підприємця
ownership	String	форма власності; рядок 5 символів; jur - Юридична особа, fiz - Фізична особа
inn	String	код ІПН; рядок 50 символів
kpp	String	код ЄДРПОУ / КПП; рядок 50 символів
mail	String	пошта
phone	String	№ телефону; рядок 50 символів
ndsNumber	String	№ свідоцтва ПДВ; рядок 50 символів
bankAccount	String	розрахунковий рахунок банку; рядок 50 символів
bankName	String	назва банку; рядок 100 символів
bankMfo	String	МФО банку, код-реквізит банку
bankAddress	String	адреса банку; рядок 150 символів
identificators	List<Identificator>	масив об’єктів;
companies	List<Company>	масив об’єктів;
users	List<User>	масив об’єктів;

Таблиця 3 - Опис параметрів об’єкта Company)

Параметр	Формат	Опис
	Об’єкт Company
id	long	id компанії; число
account	Account	об’єкт; дані аккаунта
name	String	повне найменування організації або ПІБ індивідуального підприємця
ownership	String	форма власності; рядок 5 символів; jur - Юридична особа, fiz - Фізична особа
edrpou	String	код ЄДРПОУ/КПП; рядок 50 символів
inn	String	код ІПН; рядок 50 символів
mail	String	пошта
phone	String	№ телефону; рядок 50 символів
ndsNumber	String	№ свідоцтва ПДВ; рядок 50 символів
bankAccount	String	розрахунковий рахунок банку; рядок 50 символів
bankName	String	назва банку; рядок 100 символів
bankMfo	String	МФО банку, код-реквізит банку
bankAddress	String	адреса банку; рядок 150 символів
users	List<User>	масив об’єктів;

Таблиця 4 - Опис параметрів об’єкта User)

Параметр	Формат	Опис
	Об’єкт User
id	long	id користувача; число
accountId	long	id аккаунта
login	String	логін користувача; рядок 50 символів
stringEmails	String	E-mail; рядок 255 символів
emails	List<String>	масив адрес E-mail
blocked	int	відмітка про блокування; число; 0 - немає, 1 - так
allowFTP	int	відмітка доступу до FTP; число; 0 - немає, 1 - так
autoSending	boolean	автоотправка; число; 0 - Ні, 1 - Так (документи автоматично відправляються при перенесенні документа для відправки в папку outbox)
statusFile	int	створення статус-файлів; число; 0 - Ні, 1 - Так, 2 - Так, про доставку, 3 - Так, про прочитання
isAdmin	boolean	відмітка, чи є користувач адміністратором в управлінні користувачами; число; 0 - немає, 1 - так

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

Приклад тіла відповіді (json):

[
    {
        "guid": {},
        "id": 82208,
        "gln": "5790000017089",
        "companyId": 19,
        "retailerId": 16404,
        "name": "ECCO - EDITEL",
        "companyInn": "№",
        "companyKpp": "№",
        "city": "№",
        "street": "№",
        "account": {
            "platform": "EVO",
            "id": 19,
            "name": "eXite-Ukraine",
            "ownership": "ФОП",
            "inn": "-",
            "kpp": "#",
            "mail": "DikhtyarZ@exite-edi.com",
            "phone": "1111111111",
            "ndsNumber": "#",
            "bankAccount": "#",
            "bankName": "#",
            "bankMfo": "#",
            "bankAddress": "#",
            "identificators": [],
            "companies": [],
            "users": []
        }
    },
    {
        "guid": {},
        "manager": "#",
        "id": 126701,
        "gln": "5790000833054",
        "companyId": 19,
        "retailerId": 16404,
        "name": "ECCO - EDITEL SUPPLIER",
        "companyInn": "#",
        "companyKpp": "#",
        "zip": "#",
        "city": "#",
        "street": "#",
        "phone": "#",
        "account": {
            "platform": "EVO",
            "id": 19,
            "name": "eXite-Ukraine",
            "ownership": "ФОП",
            "inn": "-",
            "kpp": "#",
            "mail": "DikhtyarZ@exite-edi.com",
            "phone": "1111111111",
            "ndsNumber": "#",
            "bankAccount": "#",
            "bankName": "#",
            "bankMfo": "#",
            "bankAddress": "#",
            "identificators": [],
            "companies": [],
            "users": []
        }
    }
]