shuup.admin.modules.orders package

Submodules

shuup.admin.modules.orders.json_order_creator module

class shuup.admin.modules.orders.json_order_creator.AdminOrderSource(shop)[source]

Bases: shuup.core.order_creator.OrderSource

get_validation_errors()[source]
is_cash_order()[source]
class shuup.admin.modules.orders.json_order_creator.AdminOrderCreator(request=None)[source]

Bases: shuup.core.order_creator.OrderCreator

Initialize order creator.

Parameters:request (django.http.HttpRequest|None) – Optional request object for backward compatibility. Passing non-None value is DEPRECATED.
class shuup.admin.modules.orders.json_order_creator.AdminOrderModifier[source]

Bases: shuup.core.order_creator.OrderModifier

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

Bases: object

static safe_get_first(model, **lookup)[source]
static is_empty_address(address_data)[source]

An address will have at least a tax_number field. It will still be considered empty.

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 (shuup.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

get_removed_product_ids(state, order_to_update)[source]

Collect product ids for products which were removed from the order.

Parameters:
Returns:

set

update_stock_for_removed_products(removed_ids, shop)[source]

Update stocks for products which were completely removed from the updated order.

Parameters:
  • removed_ids (set) – Set of removed product ids.
  • shop (shuup.core.models.Shop) – Shop instance where this order is made.

shuup.admin.modules.orders.mass_actions module

class shuup.admin.modules.orders.mass_actions.CancelOrderAction[source]

Bases: shuup.admin.utils.picotable.PicotableMassAction

label = 'Cancel'
identifier = 'mass_action_order_cancel'
process(request, ids)[source]
class shuup.admin.modules.orders.mass_actions.OrderConfirmationPdfAction[source]

Bases: shuup.admin.utils.picotable.PicotableFileMassAction

label = 'Print Confirmation PDF(s)'
identifier = 'mass_action_order_confirmation_pdf'
process(request, ids)[source]
class shuup.admin.modules.orders.mass_actions.OrderDeliveryPdfAction[source]

Bases: shuup.admin.utils.picotable.PicotableFileMassAction

label = 'Print Delivery PDF(s)'
identifier = 'mass_action_order_delivery_pdf'
process(request, ids)[source]

shuup.admin.modules.orders.receivers module

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

shuup.admin.modules.orders.sections module

class shuup.admin.modules.orders.sections.BasicDetailsOrderSection[source]

Bases: shuup.admin.base.Section

identifier = 'order_details'
name = 'Details'
icon = 'fa-info-circle'
template = 'shuup/admin/orders/_detail_section.jinja'
order = 0
classmethod visible_for_object(order, request=None)[source]
classmethod get_context_data(order, request=None)[source]
class shuup.admin.modules.orders.sections.PaymentOrderSection[source]

Bases: shuup.admin.base.Section

identifier = 'payments'
name = 'Payments'
icon = 'fa-dollar'
template = 'shuup/admin/orders/_detail_payments.jinja'
extra_js = 'shuup/admin/orders/_detail_payments_js.jinja'
order = 1
classmethod visible_for_object(order, request=None)[source]
classmethod get_context_data(order, request=None)[source]
class shuup.admin.modules.orders.sections.ShipmentSection[source]

Bases: shuup.admin.base.Section

identifier = 'shipments_data'
name = 'Shipments'
icon = 'fa-truck'
template = 'shuup/admin/orders/_order_shipments.jinja'
order = 2
static visible_for_object(order, request=None)[source]
static get_context_data(order, request=None)[source]
class shuup.admin.modules.orders.sections.LogEntriesOrderSection[source]

Bases: shuup.admin.base.Section

identifier = 'log_entries'
name = 'Log Entries'
icon = 'fa-pencil'
template = 'shuup/admin/orders/_order_log_entries.jinja'
extra_js = 'shuup/admin/orders/_order_log_entries_extra_js.jinja'
order = 3
classmethod visible_for_object(order, request=None)[source]
classmethod get_context_data(order, request=None)[source]
class shuup.admin.modules.orders.sections.AdminCommentSection[source]

Bases: shuup.admin.base.Section

identifier = 'admin_comment'
name = 'Admin comment/notes'
icon = 'fa-comment-o'
template = 'shuup/admin/orders/_admin_comment.jinja'
extra_js = 'shuup/admin/orders/_admin_comment_extra_js.jinja'
order = 4
classmethod visible_for_object(order, request=None)[source]
classmethod get_context_data(order, request=None)[source]

shuup.admin.modules.orders.toolbar module

class shuup.admin.modules.orders.toolbar.OrderDetailToolbar(order)[source]

Bases: shuup.admin.toolbar.Toolbar

build()[source]
class shuup.admin.modules.orders.toolbar.CreatePaymentAction(object, **kwargs)[source]

Bases: shuup.admin.toolbar.DropdownItem

static visible_for_object(object)[source]
class shuup.admin.modules.orders.toolbar.SetPaidAction(object, **kwargs)[source]

Bases: shuup.admin.toolbar.PostActionDropdownItem

static visible_for_object(object)[source]
class shuup.admin.modules.orders.toolbar.CreateRefundAction(object, **kwargs)[source]

Bases: shuup.admin.toolbar.DropdownItem

static visible_for_object(object)[source]
class shuup.admin.modules.orders.toolbar.EditAddresses(object, **kwargs)[source]

Bases: shuup.admin.toolbar.DropdownItem

static visible_for_object(object)[source]

shuup.admin.modules.orders.utils module

class shuup.admin.modules.orders.utils.OrderInformation(order, **kwargs)[source]

Bases: object

title = 'default'
order = 1
provides_info()[source]

Override to add business logic if the order should show this information row.

information

Override this property to return wanted information about the order.

Module contents

class shuup.admin.modules.orders.OrderEntry(text, url, icon=None, category=None, ordering=99999, aliases=(), **kwargs)[source]

Bases: shuup.admin.base.MenuEntry

name = 'Orders'
get_badge(request)[source]
class shuup.admin.modules.orders.OrderModule[source]

Bases: shuup.admin.base.AdminModule

name = 'Orders'
breadcrumbs_menu_entry = <shuup.admin.modules.orders.OrderEntry object>
get_urls()[source]
get_menu_entries(request)[source]
get_search_results(request, query)[source]
get_notifications(request)[source]
get_model_url(object, kind, shop=None)[source]
get_help_blocks(request, kind)[source]
class shuup.admin.modules.orders.OrderStatusModule[source]

Bases: shuup.admin.base.AdminModule

name = 'Order Status'
breadcrumbs_menu_entry = <shuup.admin.modules.orders.OrderEntry object>
get_urls()[source]
get_menu_entries(request)[source]
get_model_url(object, kind, shop=None)[source]