Список отделений (company/point)
Список отделений (company/point)
Список отделений поставщика (company/point)
Метод позволяет получить список всех отделений подключённых к компании.
URL запроса: https://api.multi-point.net/index.php?route=company/point&api_key=XXX
(где XXX, ключ API сгенерированный в панели управления поставщика ПВЗ).
Тип запроса: GET
В методах получения списков используется пагинация и параметры page и limit, в случае отсутствия значения / параметра в запросе ответ приходит по умолчанию со следующими значениями:
page = 1
limit = 20
Параметры URL запроса
Параметр | Описание | Формат | Обязательно |
api_key | Ключ API сгенерированный в панели управления поставщика ПВЗ | строка | Да |
region_id | Идентификатор региона | целое число | Нет |
city_id | Идентификатор города | целое число | Нет |
metro_id | Идентификатор станции метро | целое число | Нет |
address | Адрес отделения (улица, номер дома, строение, этаж, офис/павильон) | строка | Нет |
payment_card | Есть возможность оплаты картой, 0 - нет, 1 - есть | целое число | Нет |
page | Страница, значение по умолчанию 1 | целое число | Нет |
limit | Лимит (кол-во) возвращаемых значений на страницу, по умолчанию 20, максимум 1000 | целое число | Нет |
Пример реализации запроса на PHP с помощью CURL
$url = 'https://api.multi-point.net/index.php?route=company/point&api_key=XXX&page=1&limit=20'; $ch = curl_init(); curl_setopt($ch, CURLOPT_URL, $url); curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1); $response = curl_exec($ch); curl_close($ch); $result = json_decode($response, true); return $result;
Успешный результат выполнения примера
Array ( [points] => Array // Массив отделений ( [0] => Array ( [point_id] => 5 // ID отделения [name] => ПВЗ Отрадное // Сокращённое название отделения [fullname] => Пункт выдачи заказов м. Отрадное // Полное название отделения [executor_id] => 1 // ID исполнителя [executor] => ИП Райхштат И. Б. // Сокращённое юр. наименование исполнителя [inn] => 772872855604 // ИНН исполнителя [region_id] => 39 // ID региона [region] => Москва // Название региона [city_id] => 1 // ID города [city] => Москва // Название города [email] => otradnoe@spvz.su // E-mail отделения [telephone] => +7 (985) 064-33-82 // Телефон отделения [skype] => live:otradnoe14-1 // Skype отделения [address] => Москва, бул. Яна Райниса, д. 14, к. 1 // Адрес отделения [payment_card] => 1 // Есть возможность оплаты картой, 1 - да, 0 - нет [description] => м. Отрадное, 1-й вагон из центра, из дверей повернуть направо. Ориентир-вывеска “Детский клуб”. // Описание схемы прохода к отделению [geo_lat] => 55.864800 // Координаты метки, широта [geo_lng] => 37.605100 // Координаты метки, долгота ) ) [total_points] => 1 // Общее количество отделений найденных по результату запроса [total_pages] => 1 // Общее количество страниц по результату запроса )
Результат примера выполненный с ошибкой авторизации
Array ( [error] => Array // Массив ошибок
( [warning] => У Вас нет прав для просмотра списка отделений! // Ключ = строковый код ошибки, значение = текст ошибки
) )