Список заказов ожидающих приёма от клиента (reception/parcel)
Список заказов ожидающих приёма от клиента (reception/parcel)
Список заказов ожидающих приёма от клиента (reception/parcel)
Метод позволяет получить список всех заказов зарегистрированных в системе и которые ожидают приём от клиента в ПВЗ но ещё не были приняты.
URL запроса: https://api.multi-point.net/index.php?route=reception/parcel&api_key=XXX
(где XXX, ключ API сгенерированный в панели управления поставщика ПВЗ).
Тип запроса: GET
В методах получения списков используется пагинация и параметры page и limit, в случае отсутствия значения / параметра в запросе ответ приходит по умолчанию со следующими значениями:
page = 1
limit = 20
Параметры URL запроса
Параметр | Описание | Формат | Обязательно |
api_key | Ключ API сгенерированный в панели управления поставщика ПВЗ | строка | Да |
parcel_id | Идентификатор заказа | целое число | Нет |
external_order_id | Внешний идентификатор отправления зарегистрированный в системе поставщика | строка | Нет |
point_id | Идентификатор отделения | целое число | Нет |
barcode | Штрих-код заказа | строка | Нет |
parcel_number | Номер заказа | строка | Нет |
customer | ФИО получателя | строка | Нет |
date_added | Дата добавления в формате ГГГГ-ММ-ДД | строка | Нет |
page | Страница, значение по умолчанию 1 | целое число | Нет |
limit | Лимит (кол-во) возвращаемых значений на страницу, по умолчанию 20, максимум 1000 | целое число | Нет |
Пример реализации запроса на PHP с помощью CURL
$url = 'https://api.multi-point.net/index.php?route=parcel/shipment&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 ( [parcels] => Array // Массив отправлений ( [0] => Array ( [parcel_id] => 157 // Идентификатор отправления [external_order_id] => 332288QT // Внешний идентификатор отправления [point_id] => 6 // Идентификатор отделения [point] => ПВЗ Проспект Вернадского // Сокращённое название отделения [barcode] => 1223456789 // Штрих-код отправления [parcel_number] => Тест123 // Номер отправления [customer] => Иванов Иван Иванович // ФИО получателя [telephone] => 899933333 // Телефон получателя [email] => example@mail.com // E-mail получателя [total] => 2000.00 // Объявленная стоимость [delivery_price] => 200.00 // Стоимость доставки для получателя [price] => 2000.00 // Стоимость к оплате [quantity] => 1 // Количество упаковок в отправлении [weight] => 0 // Вес отправления [note] => Примечание // Примечание к отправлению для сотрудника ПВЗ [date_added] => 2020-04-04 00:25:59 // Дата добавления отправления ) ) [total_parcels] => 1 // Общее количество отправлений найденных по результату запроса [total_pages] => 1 // Общее количество страниц по результату запроса )
Результат примера выполненный с ошибкой авторизации
Array ( [error] => Array // Массив ошибок
( [warning] => У Вас нет прав для просмотра списка отправлений! // Ключ = строковый код ошибки, значение = текст ошибки
) )