shuup.admin.modules.orders package

Subpackages

• shuup.admin.modules.orders.views package
  • Submodules
  • shuup.admin.modules.orders.views.addresses module
  • shuup.admin.modules.orders.views.detail module
  • shuup.admin.modules.orders.views.edit module
  • shuup.admin.modules.orders.views.list module
  • shuup.admin.modules.orders.views.log module
  • shuup.admin.modules.orders.views.payment module
  • shuup.admin.modules.orders.views.refund module
  • shuup.admin.modules.orders.views.shipment module
  • shuup.admin.modules.orders.views.status module
  • Module contents

Submodules

shuup.admin.modules.orders.json_order_creator module

class shuup.admin.modules.orders.json_order_creator.AdminOrderSource(shop)

Bases: shuup.core.order_creator.OrderSource

get_validation_errors()

is_cash_order()

class shuup.admin.modules.orders.json_order_creator.AdminOrderCreator(request=None)

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

Bases: shuup.core.order_creator.OrderModifier

class shuup.admin.modules.orders.json_order_creator.JsonOrderCreator

Bases: object

static safe_get_first(model, **lookup)

static is_empty_address(address_data)

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

add_error(error)

is_valid

errors

create_source_from_state(state, creator=None, ip_address=None, save=False, order_to_update=None)

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)

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)

Update an order from a state dict unserialized from JSON.

Parameters:

• state (dict) – State dictionary.
• order_to_update (shuup.core.models.Order) – Order object to edit.

Returns:

The created order, or None if something failed along the way.

Return type:

Order|None

get_removed_product_ids(state, order_to_update)

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

Parameters:

• state (dict) – State dictionary.
• order_to_update (shuup.core.models.Order) – Order object to edit.

Returns:

set

update_stock_for_removed_products(removed_ids, shop)

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

Bases: shuup.admin.utils.picotable.PicotableMassAction

label = 'Cancel'

identifier = 'mass_action_order_cancel'

process(request, ids)

class shuup.admin.modules.orders.mass_actions.OrderConfirmationPdfAction

Bases: shuup.admin.utils.picotable.PicotableFileMassAction

label = 'Print Confirmation PDF(s)'

identifier = 'mass_action_order_confirmation_pdf'

process(request, ids)

class shuup.admin.modules.orders.mass_actions.OrderDeliveryPdfAction

Bases: shuup.admin.utils.picotable.PicotableFileMassAction

label = 'Print Delivery PDF(s)'

identifier = 'mass_action_order_delivery_pdf'

process(request, ids)

shuup.admin.modules.orders.receivers module

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

shuup.admin.modules.orders.sections module

class shuup.admin.modules.orders.sections.BasicDetailsOrderSection

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)

classmethod get_context_data(order, request=None)

class shuup.admin.modules.orders.sections.PaymentOrderSection

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)

classmethod get_context_data(order, request=None)

class shuup.admin.modules.orders.sections.ShipmentSection

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)

static get_context_data(order, request=None)

class shuup.admin.modules.orders.sections.LogEntriesOrderSection

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)

classmethod get_context_data(order, request=None)

class shuup.admin.modules.orders.sections.AdminCommentSection

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)

classmethod get_context_data(order, request=None)

shuup.admin.modules.orders.toolbar module

class shuup.admin.modules.orders.toolbar.OrderDetailToolbar(order)

Bases: shuup.admin.toolbar.Toolbar

build()

class shuup.admin.modules.orders.toolbar.CreatePaymentAction(object, **kwargs)

Bases: shuup.admin.toolbar.DropdownItem

static visible_for_object(object)

class shuup.admin.modules.orders.toolbar.SetPaidAction(object, **kwargs)

Bases: shuup.admin.toolbar.PostActionDropdownItem

static visible_for_object(object)

class shuup.admin.modules.orders.toolbar.CreateRefundAction(object, **kwargs)

Bases: shuup.admin.toolbar.DropdownItem

static visible_for_object(object)

class shuup.admin.modules.orders.toolbar.EditAddresses(object, **kwargs)

Bases: shuup.admin.toolbar.DropdownItem

static visible_for_object(object)

shuup.admin.modules.orders.utils module

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

Bases: object

title = 'default'

order = 1

provides_info()

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)

Bases: shuup.admin.base.MenuEntry

name = 'Orders'

get_badge(request)

class shuup.admin.modules.orders.OrderModule

Bases: shuup.admin.base.AdminModule

name = 'Orders'

breadcrumbs_menu_entry = <shuup.admin.modules.orders.OrderEntry object>

get_urls()

get_menu_entries(request)

get_search_results(request, query)

get_notifications(request)

get_model_url(object, kind, shop=None)

get_help_blocks(request, kind)

class shuup.admin.modules.orders.OrderStatusModule

Bases: shuup.admin.base.AdminModule

name = 'Order Status'

breadcrumbs_menu_entry = <shuup.admin.modules.orders.OrderEntry object>

get_urls()

get_menu_entries(request)

get_model_url(object, kind, shop=None)