Skip to content

Latest commit

 

History

History
162 lines (126 loc) · 6.54 KB

RetailerIdentificators.rst

File metadata and controls

162 lines (126 loc) · 6.54 KB
Raw

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

Для работы с этим методом пользователь должен быть авторизированным .

Метод запроса HTTP GET
Content-Type application/json (тело запроса/ответа в json формате в теле HTTP запроса
URL запроса https://edo-v2.edi-n.com/api/oas/retailer/identificators?retailer_id=11
Параметры, передаваемые в URL (вместе с адресом метода)

В строке заголовка (Header) "Set-Cookie" обязательно передается SID - токен полученный при авторизации

Обязательные url-параметры:

retailer_id - число; идентификатор розничной сети (из предыдущих методов)

Hint

Также возможно выполнить запрос в виде 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

Таблица 2 - Описание параметров объекта Account)

Таблица 3 - Описание параметров объекта Company)

Таблица 4 - Описание параметров объекта User)

Примеры

Запрос не содержит тела (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": []
        }
    }
]