Документація »

report


URL
http://api.brain.com.ua/report/report_type/SID [?date_from=date_from&date_to=date_to&file_type=file_type&orderID=orderID]

HTTP Метод
GET

Опис
Метод для отримання звітів

Параметри
Назва параметра Обов'язковий параметр Опис
report_type так тип звіту
SID так ідентифікатор сесії
date_from ні початкова дата
date_to ні кінцева дата
file_type ні тип звіту, який повертатиметься (html, xls).
За замовчуванням – html.
orderID ні ідентифікатор замовлення

Використовуваний формат дати - DD.MM.YYYY

Якщо буде передана лише одна дата - вона буде проігнорована, і буде використано діапазон дат за замовчуванням (14 днів, кінцева дата діапазону дорівнює поточній даті).

Максимально можливий діапазон дат становить 92 дні.

Для кожного типу звітів діє обмеження на частоту запиту - не частіше одного запиту в 300 секунд.
При спробі більш частих запитів повертатиметься помилка 54.

Типи звітів, що використовуються:
Тип звіту Назва звіту
reserves Звіт з резервів
payment_shedule Платіжний календар
shipment_balance Залишки по відвантаженням (повний)
shipment_balance_commission Залишки з відвантажень (комісія)
client_card Картка клієнта
client_card_commission Картка клієнта (комісія)
warranty_list Гарантійна відомість
warranty_list_commission Гарантійна відомість (комісія)
b2bsales В2В продажі
shipment_balance_short Залишки по відвантаженням (короткий)
rejects_report Звіт по браку товару
rejects_report_commission Звіт по браку (комісія)
rejects_movements Звіт з руху браку
bonuses Бонуси
postal_declarations Поштові декларації
get_order_status Статус замовлення
(для цього типу звіту параметр orderID - обов'язковий)
payments Звіт з безготівки
payments_commission Звіт з безготівки (комісія)
commission_sales Комісійні продажі (повний)
commission_sales_processing Комісійні продажі (у роботі)
order_report_logistics Звіт по замовленнях (логістика)
com_returns Незакриті повернення (комісія)
unclosed_com_docs Незакриті документи (комісія)


Результат
Метод повертає запитаний звіт.

Приклад
    Запит:
    http://api.brain.com.ua/report/reject_remains/gpkavk4s0aciujg6m698gev040?date_from=23.12.2013&date_to=31.12.2013

    Відповідь:
    {
    "status":1,
    "result":"<p>Звіт у форматі html</p>"
    }
Приклад 2
    Запит:
    http://api.brain.com.ua/report/reject_remains/gpkavk4s0aciujg6m698gev040?date_from=23.12.2013&date_to=31.12.2013&file_type=xls

    Відповідь:
    Повертає xls файл