Rest API Данные по выбранным документам - datawizio/pythonAPI GitHub Wiki
Ресурс /olap-report/ POST
Данные по документам. С помощью ресурса /olap-report/ можно получить данные по выбранным документам ( чеки, остатки, заказы, получения от поставщиков, перемещение с магазина в магазин/склад, документы инвентаризации, оприходования/списания в результате инвентаризации), сгруппировать результат по дате, продуктам, магазинам (магазин отправителя, магазин получателя для документа перемещения с магазина в магазин/склад), брэндам, категориям, поставщикам и отфильтровать по дате и магазинам.
POST-параметры:
Название параметра
Тип параметра
Доступные значения
Значение по умолчанию
Описание
Обязательный параметр
format
строка
"json", "api"
"json"
Формат ответа сервера
Нет
documents
строка
"doc_type", "group_by", "agg"
-
Идентификатор документа, по которому выводить информацию
Да
shops
id или список id
-
Все магазины
Идентификатор магазинов, по которым будет осуществляться выборка
"qty (stock_qty и fact_qty для stocktaking)", "price (original_price для inventory)", "total_price (stock_total_price для inventory)", "margin_price_total(для receipts)"
-
Параметры "ключа" для агрегатора данных
Да
agg_func
строка
"sum", "mean", "max", "min", "count"
-
Параметры "значения" для агрегатора данных
Да
Параметры ответа :
Название поля
Тип поля
Обязательно присутствует в ответе
Описание
receipts
список
нет
Документ по которому осуществлялась выборка
date
строка
нет
Дата, за которую осуществилась выборка
receipts_qty
число
нет
Количество чеков
receipts_price
число
нет
-
receipts_margin_price_total
строка
нет
Прибыль по чеках
shop
число
нет
Идентификатор магазина, по которому осуществлялась выборка