shuup.default_reports.reports package

Submodules

shuup.default_reports.reports.customer_sales module

class shuup.default_reports.reports.customer_sales.CustomerSalesReport(**kwargs)

Bases: OrderReportMixin, ShuupReportBase

identifier = 'customer_sales_report'

title = 'Customer Sales'

form_class

alias of CustomerSalesReportForm

filename_template = 'customer-sales-report-%(time)s'

schema = [{'key': 'customer', 'title': 'Customer'}, {'key': 'order_count', 'title': 'Orders'}, {'key': 'average_sales', 'title': 'Average Sales'}, {'key': 'taxless_total', 'title': 'Taxless Total'}, {'key': 'taxful_total', 'title': 'Taxful Total'}]

get_objects()

get_data()

shuup.default_reports.reports.new_customers module

class shuup.default_reports.reports.new_customers.NewCustomersReport(**kwargs)

Bases: ShuupReportBase

identifier = 'new_customers_report'

title = 'New Customers'

form_class

alias of NewCustomersReportForm

filename_template = 'new-customers-report-%(time)s'

schema = [{'key': 'date', 'title': 'Date'}, {'key': 'personcontact', 'title': 'Persons'}, {'key': 'companycontact', 'title': 'Companies'}, {'key': 'users', 'title': 'Users'}]

get_data()

shuup.default_reports.reports.orders module

class shuup.default_reports.reports.orders.OrdersReport(**kwargs)

Bases: OrderReportMixin, ShuupReportBase

identifier = 'orders_report'

title = 'Orders Report'

form_class

alias of OrderReportForm

filename_template = 'orders-report-%(time)s'

schema = [{'key': 'order_num', 'title': 'Order ref.'}, {'key': 'order_date', 'title': 'Order date'}, {'key': 'customer', 'title': 'Customer'}, {'key': 'status', 'title': 'Status'}, {'key': 'order_line_quantity', 'title': 'Order line quantity'}, {'key': 'payment_status', 'title': 'Payment status'}, {'key': 'shipment_status', 'title': 'Shipment status'}, {'key': 'order_total_amount', 'title': 'Total'}]

get_data()

class shuup.default_reports.reports.orders.OrderLineReport(**kwargs)

Bases: OrderLineReportMixin, ShuupReportBase

identifier = 'order_line_report'

title = 'Order Line Report'

form_class

alias of OrderLineReportForm

filename_template = 'orders-report-%(time)s'

schema = [{'key': 'order_line_sku', 'title': 'Order Line SKU'}, {'key': 'order_line_text', 'title': 'Order Line Text'}, {'key': 'order_line_quantity', 'title': 'Quantity'}, {'key': 'taxless_unit_price', 'title': 'Taxless Unit Price'}, {'key': 'taxful_unit_price', 'title': 'Taxful Unit Price'}, {'key': 'taxful_price', 'title': 'Taxful Price'}, {'key': 'created_on', 'title': 'Created on'}, {'key': 'type', 'title': 'Type'}]

get_data()

shuup.default_reports.reports.product_total_sales module

class shuup.default_reports.reports.product_total_sales.ProductSalesReport(**kwargs)

Bases: OrderReportMixin, ShuupReportBase

identifier = 'product_total_sales_report'

title = 'Product Total Sales'

form_class

alias of ProductTotalSalesReportForm

filename_template = 'product-total-sales-report-%(time)s'

schema = [{'key': 'product', 'title': 'Product'}, {'key': 'sku', 'title': 'SKU'}, {'key': 'quantity', 'title': 'Quantity'}, {'key': 'taxless_total', 'title': 'Taxless Total'}, {'key': 'taxful_total', 'title': 'Taxful Total'}]

get_objects()

get_data()

shuup.default_reports.reports.refunds module

class shuup.default_reports.reports.refunds.RefundedSalesReport(**kwargs)

Bases: OrderReportMixin, ShuupReportBase

identifier = 'refunded-sales'

title = 'Refunded Sales'

filename_template = 'refunded-sales-%(time)s'

form_class

alias of OrderReportForm

schema = [{'key': 'refunded_orders', 'title': 'Refunded Orders'}, {'key': 'total_refunded', 'title': 'Total Refunded'}]

get_data(**kwargs)

shuup.default_reports.reports.sales module

class shuup.default_reports.reports.sales.SalesReport(**kwargs)

Bases: OrderReportMixin, ShuupReportBase

identifier = 'sales_report'

title = 'Sales Report'

form_class

alias of OrderReportForm

filename_template = 'sales-report-%(time)s'

schema = [{'key': 'date', 'title': 'Date'}, {'key': 'order_count', 'title': 'Orders'}, {'key': 'product_count', 'title': 'Products'}, {'key': 'taxless_total', 'title': 'Taxless Total'}, {'key': 'taxful_total', 'title': 'Taxful Total'}]

extract_date(entity)

get_data()

shuup.default_reports.reports.sales_per_hour module

class shuup.default_reports.reports.sales_per_hour.SalesPerHour(**kwargs)

Bases: OrderReportMixin, ShuupReportBase

identifier = 'sales-per-hour'

title = 'Sales Per Hour'

filename_template = 'sales-per-hour-%(time)s'

form_class

alias of OrderReportForm

schema = [{'key': 'hour', 'title': 'Hour'}, {'key': 'order_amount', 'title': 'Order Amount'}, {'key': 'total_sales', 'title': 'Total Sales'}]

date_hour(timestamp)

get_data(**kwargs)

shuup.default_reports.reports.shipping module

class shuup.default_reports.reports.shipping.ShippingReport(**kwargs)

Bases: OrderReportMixin, ShuupReportBase

identifier = 'shipping_report'

title = 'Shipping'

form_class

alias of ShippingReportForm

filename_template = 'shipping-report-%(time)s'

schema = [{'key': 'carrier', 'title': 'Carrier'}, {'key': 'shipping_method', 'title': 'Shipping method'}, {'key': 'order_count', 'title': 'Orders'}, {'key': 'total_charged', 'title': 'Total Charged'}]

get_objects()

get_data()

shuup.default_reports.reports.taxes module

class shuup.default_reports.reports.taxes.TaxesReport(**kwargs)

Bases: OrderReportMixin, ShuupReportBase

identifier = 'taxes_report'

title = 'Taxes'

form_class

alias of TaxesReportForm

filename_template = 'taxes-report-%(time)s'

schema = [{'key': 'tax', 'title': 'Tax'}, {'key': 'tax_rate', 'title': 'Rate (%)'}, {'key': 'order_count', 'title': 'Orders'}, {'key': 'total_pretax_amount', 'title': 'Pre-tax Total'}, {'key': 'total_tax_amount', 'title': 'Total Tax Amount'}, {'key': 'total', 'title': 'Total'}]

get_objects()

get_data()

shuup.default_reports.reports.total_sales module

class shuup.default_reports.reports.total_sales.TotalSales(**kwargs)

Bases: OrderReportMixin, ShuupReportBase

identifier = 'total_sales_report'

title = 'Total Sales'

form_class

alias of 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'}]

get_data()

Module contents

class shuup.default_reports.reports.CustomerSalesReport(**kwargs)

Bases: OrderReportMixin, ShuupReportBase

filename_template = 'customer-sales-report-%(time)s'

form_class

alias of CustomerSalesReportForm

get_data()

get_objects()

identifier = 'customer_sales_report'

schema = [{'key': 'customer', 'title': 'Customer'}, {'key': 'order_count', 'title': 'Orders'}, {'key': 'average_sales', 'title': 'Average Sales'}, {'key': 'taxless_total', 'title': 'Taxless Total'}, {'key': 'taxful_total', 'title': 'Taxful Total'}]

title = 'Customer Sales'

class shuup.default_reports.reports.NewCustomersReport(**kwargs)

Bases: ShuupReportBase

filename_template = 'new-customers-report-%(time)s'

form_class

alias of NewCustomersReportForm

get_data()

identifier = 'new_customers_report'

schema = [{'key': 'date', 'title': 'Date'}, {'key': 'personcontact', 'title': 'Persons'}, {'key': 'companycontact', 'title': 'Companies'}, {'key': 'users', 'title': 'Users'}]

title = 'New Customers'

class shuup.default_reports.reports.ProductSalesReport(**kwargs)

Bases: OrderReportMixin, ShuupReportBase

filename_template = 'product-total-sales-report-%(time)s'

form_class

alias of ProductTotalSalesReportForm

get_data()

get_objects()

identifier = 'product_total_sales_report'

schema = [{'key': 'product', 'title': 'Product'}, {'key': 'sku', 'title': 'SKU'}, {'key': 'quantity', 'title': 'Quantity'}, {'key': 'taxless_total', 'title': 'Taxless Total'}, {'key': 'taxful_total', 'title': 'Taxful Total'}]

title = 'Product Total Sales'

class shuup.default_reports.reports.RefundedSalesReport(**kwargs)

Bases: OrderReportMixin, ShuupReportBase

filename_template = 'refunded-sales-%(time)s'

form_class

alias of OrderReportForm

get_data(**kwargs)

identifier = 'refunded-sales'

schema = [{'key': 'refunded_orders', 'title': 'Refunded Orders'}, {'key': 'total_refunded', 'title': 'Total Refunded'}]

title = 'Refunded Sales'

class shuup.default_reports.reports.SalesPerHour(**kwargs)

Bases: OrderReportMixin, ShuupReportBase

date_hour(timestamp)

filename_template = 'sales-per-hour-%(time)s'

form_class

alias of OrderReportForm

get_data(**kwargs)

identifier = 'sales-per-hour'

schema = [{'key': 'hour', 'title': 'Hour'}, {'key': 'order_amount', 'title': 'Order Amount'}, {'key': 'total_sales', 'title': 'Total Sales'}]

title = 'Sales Per Hour'

class shuup.default_reports.reports.SalesReport(**kwargs)

Bases: OrderReportMixin, ShuupReportBase

extract_date(entity)

filename_template = 'sales-report-%(time)s'

form_class

alias of OrderReportForm

get_data()

identifier = 'sales_report'

schema = [{'key': 'date', 'title': 'Date'}, {'key': 'order_count', 'title': 'Orders'}, {'key': 'product_count', 'title': 'Products'}, {'key': 'taxless_total', 'title': 'Taxless Total'}, {'key': 'taxful_total', 'title': 'Taxful Total'}]

title = 'Sales Report'

class shuup.default_reports.reports.ShippingReport(**kwargs)

Bases: OrderReportMixin, ShuupReportBase

filename_template = 'shipping-report-%(time)s'

form_class

alias of ShippingReportForm

get_data()

get_objects()

identifier = 'shipping_report'

schema = [{'key': 'carrier', 'title': 'Carrier'}, {'key': 'shipping_method', 'title': 'Shipping method'}, {'key': 'order_count', 'title': 'Orders'}, {'key': 'total_charged', 'title': 'Total Charged'}]

title = 'Shipping'

class shuup.default_reports.reports.TaxesReport(**kwargs)

Bases: OrderReportMixin, ShuupReportBase

filename_template = 'taxes-report-%(time)s'

form_class

alias of TaxesReportForm

get_data()

get_objects()

identifier = 'taxes_report'

schema = [{'key': 'tax', 'title': 'Tax'}, {'key': 'tax_rate', 'title': 'Rate (%)'}, {'key': 'order_count', 'title': 'Orders'}, {'key': 'total_pretax_amount', 'title': 'Pre-tax Total'}, {'key': 'total_tax_amount', 'title': 'Total Tax Amount'}, {'key': 'total', 'title': 'Total'}]

title = 'Taxes'

class shuup.default_reports.reports.TotalSales(**kwargs)

Bases: OrderReportMixin, ShuupReportBase

filename_template = 'total-sales-%(time)s'

form_class

alias of OrderReportForm

get_data()

identifier = 'total_sales_report'

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'}]

title = 'Total Sales'

class shuup.default_reports.reports.OrdersReport(**kwargs)

Bases: OrderReportMixin, ShuupReportBase

filename_template = 'orders-report-%(time)s'

form_class

alias of OrderReportForm

get_data()

identifier = 'orders_report'

schema = [{'key': 'order_num', 'title': 'Order ref.'}, {'key': 'order_date', 'title': 'Order date'}, {'key': 'customer', 'title': 'Customer'}, {'key': 'status', 'title': 'Status'}, {'key': 'order_line_quantity', 'title': 'Order line quantity'}, {'key': 'payment_status', 'title': 'Payment status'}, {'key': 'shipment_status', 'title': 'Shipment status'}, {'key': 'order_total_amount', 'title': 'Total'}]

title = 'Orders Report'

class shuup.default_reports.reports.OrderLineReport(**kwargs)

Bases: OrderLineReportMixin, ShuupReportBase

filename_template = 'orders-report-%(time)s'

form_class

alias of OrderLineReportForm

get_data()

identifier = 'order_line_report'

schema = [{'key': 'order_line_sku', 'title': 'Order Line SKU'}, {'key': 'order_line_text', 'title': 'Order Line Text'}, {'key': 'order_line_quantity', 'title': 'Quantity'}, {'key': 'taxless_unit_price', 'title': 'Taxless Unit Price'}, {'key': 'taxful_unit_price', 'title': 'Taxful Unit Price'}, {'key': 'taxful_price', 'title': 'Taxful Price'}, {'key': 'created_on', 'title': 'Created on'}, {'key': 'type', 'title': 'Type'}]

title = 'Order Line Report'