Отчёт по операциям (report/turnover)

Отчёт по операциям (report/turnover)

Отчёт по операциям (report/turnover)

Метод позволяет получить список всех операций за определённый период. Используется для поиска заказов которые были приняты от клиента и/или выданы клиенту.

URL запроса: https://api.multi-point.net/index.php?route=report/turnover&api_key=XXX 

(где XXX, ключ API сгенерированный в панели управления поставщика ПВЗ). 

Тип запроса: GET 

В методах получения списков используется пагинация и параметры page и limit, в случае отсутствия значения / параметра в запросе ответ приходит по умолчанию со следующими значениями:

page = 1

limit = 20

Параметры URL запроса

Параметр
Описание
Формат
Обязательно
api_key
Ключ API сгенерированный в панели управления поставщика ПВЗ
строка
Да
date_start
Дата начала поиска, если параметр не передан, значение по умолчанию 30 дней, формат YYYY-MM-DDстрока
Нет
date_end
Дата окончания поиска, если параметр не передан, значение по умолчанию текущий день, формат YYYY-MM-DD
строка
Нет
point_id
Идентификатор отделенияцелое числоНет
parcel_id
ID заказа из базы Multi Point. Для федеральных поставщиков DPD, Boxberry, Яндекс Маркет, PickPoint и тд. используется внутренний id из базы поставщика, но он есть не у всех заказов, а только у тех, которые выданные через интеграцию.строкаНет
parcel_number
Номер заказа поставщика
строкаНет
payment_methods

Способы оплаты. Возможные значения:

  • cash - оплата наличными
  • card - оплата картой
  • qr - оплата по qr-коду (СБП)
  • without-pay - без оплаты

В случае если требуется найти, например, все заказы только с оплатой, перечислите способы оплаты через запятую, без пробелов: "&payment_methods=cash,card,qr"

строка
Нет
amount
Сумма которую приняли от клиента
число с плавающей точкой
Нет
has_check_url

У операции есть ссылка на чек, возможные значения:

  • 1 - у операции есть ссылка на чек
  • 0 - у операции нет ссылки на чек

Данный параметр используется для поиска только тех операций у которых есть ссылка на чек, так как в системе используется несколько различных драйверов для касс и не каждый драйвер возвращает url чека.

целое числоНет
page
Страница, значение по умолчанию 1
целое число
Нет
limit
Лимит (кол-во) возвращаемых значений на страницу, по умолчанию 20
целое число
Нет

Пример реализации запроса на PHP с помощью CURL

    $url = 'https://api.multi-point.net/index.php?route=parcel/parcel&api_key=XXX&date_start=2022-08-25&date_end=2022-08-25&parcel_number=33460000065&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
                    (
			[point_id] => 6 // Идентификатор отделения
			[point] => ПВЗ Ангарск // Сокращённое название отделения
			[status] => Выдана // Статус отправления
			[parcel_id] => 4481428781465 // Идентификатор отправления
			[parcel_number] => 33460000065 // Номер отправления
			[parcel_code] => 1234 // Код получения (если выдача осуществлялась по коду)
			[payment_method] => 'cash' // Способ оплаты, возможные значения: cash - наличными, card - картой, qr - СБП, without-pay - без оплаты
			[amount] => 2000.00 // Итоговая стоимость оплаченная в отделении или 0.00 если заказ выдан без оплаты
			[comment] => 'Тест'  // Комментарий оператора отделения
			[check_number] => 10410 // Номер чека (Фискального Документа)
			[check_url] => 'https:\/\/ofd.ru\/rec\/381401981601\/0004635763009983\/9287440300744522\/9974\/0607401799' // Ссылка на чек в ОФД
			[date_added] => 2020-04-04 03:43:40 // Дата операции
                    )
            )
        [total_parcels] => 1 // Общее количество отправлений найденных по результату запроса
        [total_pages] => 1 // Общее количество страниц по результату запроса
    )

Результат примера выполненный с ошибкой авторизации

    Array
    (
        [error] => Array // Массив ошибок
         (
            [warning] => У Вас нет прав для просмотра списка отправлений! // Ключ = строковый код ошибки, значение = текст ошибки
         )
    )