Поиск заказов (parcel/parcel)
Поиск заказов (parcel/parcel)
Поиск заказов среди всех отгруженных в ПВЗ (parcel/parcel)
Метод позволяет получить список всех заказов за определённый период и которые были отгружены в ПВЗ. Используется для поиска заказов среди ожидающих приёма в отделении, ожидающих выдачи получателям, выданных получателям и возвращённых из отделения поставщику.
URL запроса: https://api.multi-point.net/index.php?route=parcel/parcel&api_key=XXX
(где XXX, ключ API сгенерированный в панели управления поставщика ПВЗ).
Тип запроса: GET
В методах получения списков используется пагинация и параметры page и limit, в случае отсутствия значения / параметра в запросе ответ приходит по умолчанию со следующими значениями:
page = 1
limit = 20
Параметры URL запроса
Параметр | Описание | Формат | Обязательно |
api_key | Ключ API сгенерированный в панели управления поставщика ПВЗ | строка | Да |
date_start | Дата начала поиска (используется дата изменения статуса), если параметр не передан, значение по умолчанию 92 дня, формат YYYY-MM-DD | строка | Нет |
date_end | Дата окончания поиска (используется дата изменения статуса), если параметр не передан, значение по умолчанию текущий день, формат YYYY-MM-DD | строка | Нет |
state | Состояние отправления, по умолчанию поиск осуществляется по всем состояниям Возможные значения: awaiting_delivery - Ожидают приёма в отделении awaiting_issued - Ожидают выдачи получателям returned - Возвращены из отделения issued - Выданные получателям | строка | Нет |
external_order_id | Внешний идентификатор отправления зарегистрированный в базе поставщика | строка | Нет |
point_id | Идентификатор отделения | целое число | Нет |
barcode | Штрих-код отправления | строка | Нет |
parcel_number | Номер отправления | строка | Нет |
customer | ФИО получателя | строка | Нет |
telephone | Телефон получателя | строка | Нет |
price | Стоимость к оплате | число с плавающей точкой | Нет |
page | Страница, значение по умолчанию 1 | целое число | Нет |
limit | Лимит (кол-во) возвращаемых значений на страницу, по умолчанию 20, максимум 1000 | целое число | Нет |
Пример реализации запроса на PHP с помощью CURL
$url = 'https://api.multi-point.net/index.php?route=parcel/parcel&api_key=XXX&date_start=2020-01-04&date_end=2020-04-05&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 ( [parcels] => Array ( [0] => Array ( [parcel_id] => 160 // Идентификатор отправления [external_order_id] => 332288QT // Внешний идентификатор отправления зарегистрированный в базе поставщика [point_id] => 6 // Идентификатор отделения [point] => ПВЗ Проспект Вернадского // Сокращённое название отделения [status] => Отправлена в отделение // Статус отправления [barcode] => 1223456789 // Штрих-код отправления [parcel_number] => Тест // Номер отправления [customer] => Иванов Иван Иванович // ФИО получателя [telephone] => 899933333 // Телефон получателя [email] => example@mail.com // E-mail получателя [total] => 2000.00 // Объявленная стоимость отправления [delivery_price] => 200.00 // Стоимость доставки для получателя [price] => 2000.00 // Сумма к оплате с получателя [quantity] => 1 // Количество грузовых мест (упаковок) в отправлении [weight] => 0 // Вес отправления [note] => Тест2 // Примечание к отправлению для сотрудника ПВЗ [date_added] => 2020-04-04 03:43:40 // Дата добавления отправления в систему [date_modified] => 2020-04-04 05:04:45 // Дата изменения статуса отправления ) [1] => Array ( [parcel_id] => 146 [external_order_id] => 332288QT [point_id] => 6 [point] => ПВЗ Проспект Вернадского [status] => Выдана [barcode] => 123456789 [parcel_number] => 8979879 [customer] => [telephone] => [email] => [total] => 2000.00 [delivery_price] => 200.00 [price] => 2000.00 [quantity] => 1 [weight] => 0 [note] => Тест [date_added] => 2020-02-28 12:04:44 [date_modified] => 2020-03-07 12:32:30 ) ) [total_parcels] => 2 // Общее количество отправлений найденных по результату запроса [total_pages] => 1 // Общее количество страниц по результату запроса )
Результат примера выполненный с ошибкой авторизации
Array ( [error] => Array // Массив ошибок
( [warning] => У Вас нет прав для просмотра списка отправлений! // Ключ = строковый код ошибки, значение = текст ошибки
) )