from django.db.models import Avg, Count, Sum
from django.utils.translation import gettext_lazy as _
from shuup.default_reports.forms import OrderReportForm
from shuup.default_reports.mixins import OrderReportMixin
from shuup.reports.report import ShuupReportBase
[docs]
class TotalSales(OrderReportMixin, ShuupReportBase):
identifier = "total_sales_report"
title = _("Total Sales")
form_class = OrderReportForm
filename_template = "total-sales-%(time)s"
schema = [
{"key": "name", "title": _("Shop Name")},
{"key": "currency", "title": _("Currency")},
{"key": "order_amount", "title": _("Order Amount")},
{"key": "customers", "title": _("Customers")},
{"key": "customer_avg_sale", "title": _("Customer Average Sale")},
{"key": "total_sales", "title": _("Total Sales")},
]
[docs]
def get_data(self):
orders = self.get_objects()
aggregation = orders.aggregate(
customers=Count("customer", distinct=True),
total=Sum("taxful_total_price_value"),
avg_sale=Avg("taxful_total_price_value"),
)
total_sales_value = aggregation["total"] or 0
customer_avg_sale = aggregation["avg_sale"] or 0
customers = aggregation["customers"] or 0
data = [
{
"name": self.shop.name,
"order_amount": orders.count(),
"customers": customers,
"customer_avg_sale": self.shop.create_price(customer_avg_sale),
"total_sales": self.shop.create_price(total_sales_value),
"currency": self.shop.currency,
}
]
return self.get_return_data(data)