Получение списка GLN номеров, которые связаны с заданной розничной сетью

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

Метод запроса

HTTP GET

Content-Type

application/json (тело запроса/ответа в json формате в теле HTTP запроса

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": "[email protected]",
            "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": "[email protected]",
            "phone": "1111111111",
            "ndsNumber": "#",
            "bankAccount": "#",
            "bankName": "#",
            "bankMfo": "#",
            "bankAddress": "#",
            "identificators": [],
            "companies": [],
            "users": []
        }
    }
]