Документация »
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 файл