Тип запроса query
.
Возращает отчет о продажах за указанный промежуток времени.
Параметры запроса
В теле запроса вводятся:
Параметр | Тип данных | Описание | Обязательно | Пример |
---|---|---|---|---|
PaymentsReport |
Array | Диапазон дат для формирования отчета продаж | + | PaymentsReport |
В теле ответа указываются необходимые параметры единого отчета UnifiedReport
Пример запроса
query salesReport{
salesReport(input:{
from:"2024-02-20 22:00:00"
to:"2024-03-25 22:00:00"
})
{
labels
extraLabels
extraLabels2
extraLabels3
keys
points
data{
values
}
url
summary{
title
value
}
}
}
Пример ответа
{
"data": {
"salesReport": {
"labels": [
"Название позиции",
"Категория",
"Продано",
"Сумма",
"Ср. стоимость",
"Кол-во отмен"
],
"extraLabels": [
"DEPOSIT",
"TARIFF",
"TARIFF",
"TARIFF",
"TARIFF",
"GOOD",
"GOOD"
],
"extraLabels2": [
"",
"",
"",
"",
"",
"",
""
],
"extraLabels3": [
"",
"",
"",
"",
"",
"",
""
],
"keys": [
"DEPOSIT",
"1 мин",
"6 минут",
"Пакетный до 20",
"Пруф для вани",
"002. Капучино",
"004. Доктор пепер"
],
"points": 7,
"data": [
{
"values": [
1,
1000,
1000,
4
]
},
{
"values": [
4,
4,
1,
0
]
},
{
"values": [
5,
25,
5,
1
]
},
{
"values": [
1,
50,
50,
0
]
},
{
"values": [
5,
250,
50,
1
]
},
{
"values": [
1,
80,
80,
0
]
},
{
"values": [
0,
0,
0,
1
]
}
],
"url": "https://storage.yandexcloud.net/smartshell-static/report/sales/1872/wK2sovzo0RcXsales.csv",
"summary": [
{
"title": "deposit sum",
"value": 1000
},
{
"title": "deposit count",
"value": 1
},
{
"title": "bonus sum",
"value": 0
},
{
"title": "bonus count",
"value": 0
},
{
"title": "tariff sum",
"value": 329
},
{
"title": "tariff count",
"value": 15
},
{
"title": "good sum",
"value": 80
},
{
"title": "good count",
"value": 1
},
{
"title": "service sum",
"value": 0
},
{
"title": "service count",
"value": 0
},
{
"title": "cloudpayments sum",
"value": 0
},
{
"title": "cloudpayments count",
"value": 0
}
]
}
}
}
Параметры ответа
В ответе возвращаются параметры единого отчета UnifiedReport выбранного пользователя.