shoop.admin.modules.orders package

Submodules

shoop.admin.modules.orders.dashboard module

shoop.admin.modules.orders.dashboard.get_orders_by_currency(currency)[source]
class shoop.admin.modules.orders.dashboard.OrderValueChartDashboardBlock(id, currency, **kwargs)[source]

Bases: shoop.admin.dashboard.blocks.DashboardChartBlock

get_chart()[source]
shoop.admin.modules.orders.dashboard.get_subtitle(count)[source]
shoop.admin.modules.orders.dashboard.get_sales_of_the_day_block(request, currency)[source]
shoop.admin.modules.orders.dashboard.get_lifetime_sales_block(request, currency)[source]
shoop.admin.modules.orders.dashboard.get_avg_purchase_size_block(request, currency)[source]
shoop.admin.modules.orders.dashboard.get_open_orders_block(request, currency)[source]
shoop.admin.modules.orders.dashboard.get_order_value_chart_dashboard_block(request, currency)[source]

shoop.admin.modules.orders.json_order_creator module

class shoop.admin.modules.orders.json_order_creator.JsonOrderCreator[source]

Bases: object

static safe_get_first(model, **lookup)[source]
add_error(error)[source]
is_valid
errors
create_source_from_state(state, creator=None, ip_address=None, save=False, order_to_update=None)[source]

Create an order source from a state dict unserialized from JSON.

Parameters:
  • state (dict) – State dictionary
  • creator (django.contrib.auth.models.User|None) – Creator user
  • save (boolean) – Flag whether order customer and addresses is saved to database
  • order_to_update (shoop.core.models.Order|None) – Order object to edit
Returns:

The created order source, or None if something failed along the way
Return type:

OrderSource|None
create_order_from_state(state, creator=None, ip_address=None)[source]

Create an order from a state dict unserialized from JSON.

Parameters:
  • state (dict) – State dictionary
  • creator (django.contrib.auth.models.User|None) – Creator user
  • ip_address (str) – Remote IP address (IPv4 or IPv6)
Returns:

The created order, or None if something failed along the way
Return type:

Order|None
update_order_from_state(state, order_to_update, modified_by=None)[source]

Update an order from a state dict unserialized from JSON.

Parameters:
Returns:

The created order, or None if something failed along the way
Return type:

Order|None

shoop.admin.modules.orders.receivers module

shoop.admin.modules.orders.receivers.handle_custom_payment_return_requests(sender, order, *args, **kwargs)[source]

shoop.admin.modules.orders.sections module

class shoop.admin.modules.orders.sections.PaymentOrderSection[source]

Bases: shoop.admin.base.OrderSection

identifier = 'payments'
name = 'Payments'
icon = 'fa-dollar'
template = 'shoop/admin/orders/_detail_payments.jinja'
order = 1
static visible_for_order(order)[source]
static get_context_data(order)[source]
class shoop.admin.modules.orders.sections.ContentsOrderSection[source]

Bases: shoop.admin.base.OrderSection

identifier = 'contents'
name = 'Order Contents'
icon = 'fa-file-text'
template = 'shoop/admin/orders/_order_contents.jinja'
order = 2
static visible_for_order(order)[source]
static get_context_data(order)[source]
class shoop.admin.modules.orders.sections.LogEntriesOrderSection[source]

Bases: shoop.admin.base.OrderSection

identifier = 'log_entries'
name = 'Log Entries'
icon = 'fa-pencil'
template = 'shoop/admin/orders/_order_log_entries.jinja'
extra_js = 'shoop/admin/orders/_order_log_entries_extra_js.jinja'
order = 3
static visible_for_order(order)[source]
static get_context_data(order)[source]

Module contents

class shoop.admin.modules.orders.OrderModule(currency=None, *args, **kwargs)[source]

Bases: shoop.admin.currencybound.CurrencyBound, shoop.admin.base.AdminModule

name = <django.utils.functional.lazy.<locals>.__proxy__ object>
breadcrumbs_menu_entry = <shoop.admin.base.MenuEntry object>
get_urls()[source]
get_menu_category_icons()[source]
get_menu_entries(request)[source]
get_required_permissions()[source]
get_search_results(request, query)[source]
get_dashboard_blocks(request)[source]
get_notifications(request)[source]
get_model_url(object, kind)[source]