Реестры отправлений (report/shipment)
Реестры отправлений (report/shipment)
Получить список реестров отправлений (report/shipment)
Метод позволяет получить список всех реестров отправлений зарегистрированных в системе за определённый период в результате отгрузки отправлений. Метод возвращает список идентификаторов необходимых для получения акта приёма-передачи (см. печать акта-приёма передачи).
URL запроса: https://api.multi-point.net/index.php?route=report/shipment&api_key=XXX
(где XXX, ключ API сгенерированный в панели управления поставщика ПВЗ).
Тип запроса: GET
В методах получения списков используется пагинация и параметры page и limit, в случае отсутствия значения / параметра в запросе ответ приходит по умолчанию со следующими значениями:
page = 1
limit = 20
Параметры URL запроса
Параметр | Описание | Формат | Обязательно |
api_key | Ключ API сгенерированный в панели управления поставщика ПВЗ | строка | Да |
date_start | Дата начала поиска, если параметр не передан, значение по умолчанию 61 день, формат YYYY-MM-DD | строка | Нет |
date_end | Дата окончания поиска, если параметр не передан, значение по умолчанию текущий день, формат YYYY-MM-DD | строка | Нет |
point_id | Идентификатор отделения в системе | целое число | Нет |
page | Страница, значение по умолчанию 1 | целое число | Нет |
limit | Лимит (кол-во) возвращаемых значений на страницу, по умолчанию 20, максимум 1000 | целое число | Нет |
Пример реализации запроса на PHP с помощью CURL
$url = 'https://api.multi-point.net/index.php?route=report/shipment&api_key=XXX&date_start=2020-01-04&date_end=2020-04-08&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 ( [shipments] => Array // Массив реестров ( [0] => Array ( [shipment_id] => 66 // Идентификатор реестра [point_id] => 6 // Идентификатор отделения [point] => ПВЗ Проспект Вернадского // Сокращённое название отделения [quantity] => 2 // Количество отправлений в реестре [date_added] => 05.04.2020 23:20:37 // Дата и время создания реестра и отгрузки ) [1] => Array ( [shipment_id] => 65 // Идентификатор реестра [point_id] => 5 // Идентификатор отделения [point] => ПВЗ Отрадное // Сокращённое название отделения [quantity] => 1 // Количество отправлений в реестре [date_added] => 05.04.2020 23:20:37 // Дата и время создания реестра и отгрузки ) [2] => Array ( [shipment_id] => 64 // Идентификатор реестра [point_id] => 1 // Идентификатор отделения [point] => ПВЗ Авиамоторная // Сокращённое название отделения [quantity] => 2 // Количество отправлений в реестре [date_added] => 05.04.2020 23:20:37 // Дата и время создания реестра и отгрузки ) ) [total_shipments] => 3 // Общее количество реестров найденных по результату запроса [total_pages] => 1 // Общее количество страниц по результату запроса )
Результат примера выполненный с ошибкой авторизации
Array ( [error] => Array // Массив ошибок
( [warning] => У Вас нет прав для просмотра списка отправлений! // Ключ = строковый код ошибки, значение = текст ошибки
) )