latest
Getting Started
Installation
Adding products
Checkout & payment
Advanced Usage
Basket modifiers
Payment methods
Order customization
Sending notifications
Custom validators
Custom formatters
Swappable models
API Documentation
Basket
Checkout
Orders
Extras
Reference
Release notes
Credits
Salesman
Index
Edit on GitHub
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
L
|
M
|
N
|
O
|
P
|
Q
|
R
|
S
|
T
|
U
|
V
|
W
A
add() (salesman.basket.models.BaseBasket method)
add_extra_row() (salesman.basket.modifiers.BasketModifier method)
all() (salesman.orders.views.OrderViewSet method)
amount_outstanding (salesman.orders.models.BaseOrder property)
amount_paid (salesman.orders.models.BaseOrder attribute)
app_settings (salesman.conf attribute)
AppSettings (class in salesman.conf)
B
BaseAdminMixin (class in salesman.admin.mixins)
BaseBasket (class in salesman.basket.models)
BaseBasketItem (class in salesman.basket.models)
BaseOrder (class in salesman.orders.models)
BaseOrderAdmin (class in salesman.admin.admin)
(class in salesman.admin.wagtail_hooks)
BaseOrderItem (class in salesman.orders.models)
BaseOrderNote (class in salesman.orders.models)
BaseOrderPayment (class in salesman.orders.models)
BaseOrderStatus (class in salesman.orders.status)
Basket (class in salesman.basket.models)
Basket.DoesNotExist
Basket.MultipleObjectsReturned
basket_payment() (salesman.checkout.payment.PaymentMethod method)
BasketExtraSerializer (class in salesman.basket.serializers)
BasketItem (class in salesman.basket.models)
BasketItem.DoesNotExist
BasketItem.MultipleObjectsReturned
BasketItemCreateSerializer (class in salesman.basket.serializers)
BasketItemSerializer (class in salesman.basket.serializers)
BasketModifier (class in salesman.basket.modifiers)
BasketModifiersPool (class in salesman.basket.modifiers)
BasketSerializer (class in salesman.basket.serializers)
BasketViewSet (class in salesman.basket.views)
C
check_permissions() (salesman.checkout.views.CheckoutViewSet method)
CheckoutSerializer (class in salesman.checkout.serializers)
CheckoutViewSet (class in salesman.checkout.views)
classes() (salesman.admin.wagtail.panels.OrderItemsPanel method)
clear() (salesman.basket.models.BaseBasket method)
(salesman.basket.views.BasketViewSet method)
clone_kwargs() (salesman.admin.wagtail.panels.ReadOnlyPanel method)
code (salesman.basket.models.BaseBasketItem property)
(salesman.orders.models.BaseOrderItem property)
count (salesman.basket.models.BaseBasket property)
count() (salesman.basket.views.BasketViewSet method)
create() (salesman.basket.serializers.BasketItemCreateSerializer method)
(salesman.checkout.views.CheckoutViewSet method)
D
delete() (salesman.basket.views.BasketViewSet method)
dispatch() (salesman.basket.views.BasketViewSet method)
(salesman.checkout.views.CheckoutViewSet method)
(salesman.orders.views.OrderViewSet method)
E
edit_view_class (salesman.admin.wagtail_hooks.BaseOrderAdmin attribute)
extra() (salesman.basket.views.BasketViewSet method)
extra_update() (salesman.basket.views.BasketViewSet method)
ExtraRowSerializer (class in salesman.basket.serializers)
ExtraRowsField (class in salesman.basket.serializers)
F
finalize_basket() (salesman.basket.modifiers.BasketModifier method)
finalize_item() (salesman.basket.modifiers.BasketModifier method)
finalize_response() (salesman.basket.views.BasketViewSet method)
find() (salesman.basket.models.BaseBasket method)
form (salesman.admin.admin.BaseOrderAdmin attribute)
(salesman.admin.admin.OrderNoteInline attribute)
(salesman.admin.admin.OrderPaymentInline attribute)
format_json() (in module salesman.admin.utils)
format_price() (in module salesman.admin.utils)
(in module salesman.core.utils)
,
[1]
G
generate_ref() (in module salesman.orders.utils)
get_base_form_class() (salesman.admin.wagtail_hooks.BaseOrderAdmin method)
get_choices() (salesman.checkout.payment.PaymentMethodsPool method)
get_edit_handler() (salesman.admin.wagtail_hooks.BaseOrderAdmin method)
get_items() (salesman.basket.models.BaseBasket method)
(salesman.orders.models.BaseOrder method)
get_modifiers() (salesman.basket.modifiers.BasketModifiersPool method)
get_object() (salesman.orders.views.OrderViewSet method)
get_payable() (salesman.orders.status.BaseOrderStatus class method)
get_payment() (salesman.checkout.payment.PaymentMethodsPool method)
get_payment_method() (salesman.orders.models.BaseOrderPayment method)
get_payments() (salesman.checkout.payment.PaymentMethodsPool method)
get_price() (salesman.core.typing.Product method)
get_product_ref() (salesman.basket.models.BaseBasketItem class method)
get_queryset() (salesman.admin.admin.BaseOrderAdmin method)
(salesman.admin.admin.OrderItemInline method)
(salesman.admin.admin.OrderPaymentInline method)
(salesman.basket.views.BasketViewSet method)
(salesman.checkout.views.CheckoutViewSet method)
(salesman.orders.views.OrderViewSet method)
get_salesman_model() (in module salesman.core.utils)
,
[1]
get_serializer_class() (salesman.basket.views.BasketViewSet method)
(salesman.orders.views.OrderViewSet method)
get_serializer_context() (salesman.basket.views.BasketViewSet method)
(salesman.checkout.views.CheckoutViewSet method)
(salesman.orders.views.OrderViewSet method)
get_success_url() (salesman.admin.wagtail.views.OrderEditView method)
get_template_names() (salesman.admin.wagtail.views.OrderRefundView method)
get_transitions() (salesman.orders.status.BaseOrderStatus class method)
get_urls() (salesman.checkout.payment.PaymentMethod method)
(salesman.checkout.payment.PaymentMethodsPool method)
get_view_name() (salesman.basket.views.BasketViewSet method)
(salesman.checkout.views.CheckoutViewSet method)
get_wagtail_admin_attribute() (salesman.orders.models.BaseOrder class method)
H
has_add_permission() (salesman.admin.admin.BaseOrderAdmin method)
(salesman.admin.admin.OrderItemInline method)
has_delete_permission() (salesman.admin.admin.BaseOrderAdmin method)
(salesman.admin.admin.OrderItemInline method)
I
index_view_class (salesman.admin.wagtail_hooks.BaseOrderAdmin attribute)
is_enabled() (salesman.checkout.payment.PaymentMethod method)
is_paid (salesman.orders.models.BaseOrder property)
L
last() (salesman.orders.views.OrderViewSet method)
list() (salesman.basket.views.BasketViewSet method)
(salesman.checkout.views.CheckoutViewSet method)
M
media (salesman.admin.forms.OrderModelForm property)
(salesman.admin.forms.OrderNoteModelForm property)
(salesman.admin.forms.OrderPaymentModelForm property)
(salesman.admin.wagtail.forms.WagtailOrderModelForm property)
merge() (salesman.basket.models.BaseBasket method)
model (salesman.admin.admin.OrderItemInline attribute)
(salesman.admin.admin.OrderNoteInline attribute)
(salesman.admin.admin.OrderPaymentInline attribute)
(salesman.admin.wagtail_hooks.BaseOrderAdmin attribute)
module
salesman.admin.admin
salesman.admin.filters
salesman.admin.forms
salesman.admin.mixins
salesman.admin.utils
salesman.admin.wagtail.forms
salesman.admin.wagtail.helpers
salesman.admin.wagtail.mixins
salesman.admin.wagtail.panels
salesman.admin.wagtail.views
salesman.admin.wagtail_hooks
salesman.admin.widgets
salesman.basket.models
salesman.basket.modifiers
salesman.basket.serializers
salesman.basket.utils
salesman.basket.views
salesman.checkout.payment
salesman.checkout.serializers
salesman.checkout.utils
salesman.checkout.views
salesman.core.serializers
salesman.core.typing
salesman.core.utils
,
[1]
salesman.orders.models
salesman.orders.serializers
salesman.orders.signals
salesman.orders.status
salesman.orders.utils
salesman.orders.views
N
name (salesman.basket.models.BaseBasketItem property)
(salesman.orders.models.BaseOrderItem property)
O
on_model_bound() (salesman.admin.wagtail.panels.OrderAdminPanel method)
(salesman.admin.wagtail.panels.ReadOnlyPanel method)
optimize_queryset() (salesman.orders.views.OrderViewSet method)
Order (class in salesman.orders.models)
Order.DoesNotExist
Order.MultipleObjectsReturned
order_payment() (salesman.checkout.payment.PaymentMethod method)
OrderAdmin (class in salesman.admin.admin)
(class in salesman.admin.wagtail_hooks)
OrderAdminMixin (class in salesman.admin.mixins)
OrderAdminPanel (class in salesman.admin.wagtail.panels)
OrderAdminPanel.BoundPanel (class in salesman.admin.wagtail.panels)
OrderAdminRefundMixin (class in salesman.admin.mixins)
OrderCheckboxPanel (class in salesman.admin.wagtail.panels)
OrderCheckboxPanel.BoundPanel (class in salesman.admin.wagtail.panels)
OrderDatePanel (class in salesman.admin.wagtail.panels)
OrderDatePanel.BoundPanel (class in salesman.admin.wagtail.panels)
OrderEditView (class in salesman.admin.wagtail.views)
OrderIndexView (class in salesman.admin.wagtail.views)
OrderItem (class in salesman.orders.models)
OrderItem.DoesNotExist
OrderItem.MultipleObjectsReturned
OrderItemAdminMixin (class in salesman.admin.mixins)
OrderItemInline (class in salesman.admin.admin)
OrderItemSerializer (class in salesman.orders.serializers)
OrderItemsPanel (class in salesman.admin.wagtail.panels)
OrderItemsPanel.BoundPanel (class in salesman.admin.wagtail.panels)
OrderModelForm (class in salesman.admin.forms)
OrderNote (class in salesman.orders.models)
OrderNote.DoesNotExist
OrderNote.MultipleObjectsReturned
OrderNoteInline (class in salesman.admin.admin)
OrderNoteModelForm (class in salesman.admin.forms)
OrderNoteSerializer (class in salesman.orders.serializers)
OrderPayment (class in salesman.orders.models)
OrderPayment.DoesNotExist
OrderPayment.MultipleObjectsReturned
OrderPaymentInline (class in salesman.admin.admin)
OrderPaymentModelForm (class in salesman.admin.forms)
OrderPaymentSerializer (class in salesman.orders.serializers)
OrderPaySerializer (class in salesman.orders.serializers)
OrderPermissionHelper (class in salesman.admin.wagtail.helpers)
OrderRefundSerializer (class in salesman.orders.serializers)
OrderRefundView (class in salesman.admin.wagtail.views)
OrderSerializer (class in salesman.orders.serializers)
OrderStatus (class in salesman.orders.status)
OrderStatusSelect (class in salesman.admin.widgets)
OrderStatusSerializer (class in salesman.orders.serializers)
OrderViewSet (class in salesman.orders.views)
P
ParentalForeignKey (class in salesman.orders.models)
pay() (salesman.orders.models.BaseOrder method)
(salesman.orders.views.OrderViewSet method)
pay_create() (salesman.orders.views.OrderViewSet method)
payment_method_display (salesman.orders.models.BaseOrderPayment property)
PaymentError
PaymentMethod (class in salesman.checkout.payment)
PaymentMethodSerializer (class in salesman.checkout.serializers)
PaymentMethodsPool (class in salesman.checkout.payment)
PaymentSelect (class in salesman.admin.widgets)
permission_helper_class (salesman.admin.wagtail_hooks.BaseOrderAdmin attribute)
populate_from_basket() (salesman.orders.models.BaseOrder method)
populate_from_basket_item() (salesman.orders.models.BaseOrderItem method)
PriceField (class in salesman.core.serializers)
process_basket() (salesman.basket.modifiers.BasketModifier method)
process_item() (salesman.basket.modifiers.BasketModifier method)
Product (class in salesman.core.typing)
ProductField (class in salesman.basket.serializers)
Q
quantity (salesman.basket.models.BaseBasket property)
quantity() (salesman.basket.views.BasketViewSet method)
R
ReadOnlyPanel (class in salesman.admin.wagtail.panels)
ReadOnlyPanel.BoundPanel (class in salesman.admin.wagtail.panels)
refund() (salesman.orders.views.OrderViewSet method)
refund_payment() (salesman.checkout.payment.PaymentMethod method)
refund_view_class (salesman.admin.wagtail.mixins.WagtailOrderAdminRefundMixin attribute)
remove() (salesman.basket.models.BaseBasket method)
render_html() (salesman.admin.wagtail.panels.ReadOnlyPanel.BoundPanel method)
S
salesman.admin.admin
module
salesman.admin.filters
module
salesman.admin.forms
module
salesman.admin.mixins
module
salesman.admin.utils
module
salesman.admin.wagtail.forms
module
salesman.admin.wagtail.helpers
module
salesman.admin.wagtail.mixins
module
salesman.admin.wagtail.panels
module
salesman.admin.wagtail.views
module
salesman.admin.wagtail_hooks
module
salesman.admin.widgets
module
salesman.basket.models
module
salesman.basket.modifiers
module
salesman.basket.serializers
module
salesman.basket.utils
module
salesman.basket.views
module
salesman.checkout.payment
module
salesman.checkout.serializers
module
salesman.checkout.utils
module
salesman.checkout.views
module
salesman.core.serializers
module
salesman.core.typing
module
salesman.core.utils
module
,
[1]
salesman.orders.models
module
salesman.orders.serializers
module
salesman.orders.signals
module
salesman.orders.status
module
salesman.orders.utils
module
salesman.orders.views
module
SALESMAN_ADDRESS_VALIDATOR (salesman.conf.AppSettings attribute)
SALESMAN_ADMIN_JSON_FORMATTER (salesman.conf.AppSettings attribute)
SALESMAN_ADMIN_REGISTER (salesman.conf.AppSettings property)
SALESMAN_ALLOW_ANONYMOUS_USER_CHECKOUT (salesman.conf.AppSettings property)
SALESMAN_BASKET_ITEM_MODEL (salesman.conf.AppSettings property)
SALESMAN_BASKET_ITEM_VALIDATOR (salesman.conf.AppSettings attribute)
SALESMAN_BASKET_MODEL (salesman.conf.AppSettings property)
SALESMAN_BASKET_MODIFIERS (salesman.conf.AppSettings attribute)
SALESMAN_EXTRA_VALIDATOR (salesman.conf.AppSettings attribute)
SALESMAN_ORDER_ITEM_MODEL (salesman.conf.AppSettings property)
SALESMAN_ORDER_MODEL (salesman.conf.AppSettings property)
SALESMAN_ORDER_NOTE_MODEL (salesman.conf.AppSettings property)
SALESMAN_ORDER_PAYMENT_MODEL (salesman.conf.AppSettings property)
SALESMAN_ORDER_REFERENCE_GENERATOR (salesman.conf.AppSettings attribute)
SALESMAN_ORDER_SERIALIZER (salesman.conf.AppSettings attribute)
SALESMAN_ORDER_STATUS (salesman.conf.AppSettings attribute)
SALESMAN_ORDER_SUMMARY_SERIALIZER (salesman.conf.AppSettings attribute)
SALESMAN_PAYMENT_METHODS (salesman.conf.AppSettings attribute)
SALESMAN_PRICE_FORMATTER (salesman.conf.AppSettings attribute)
SALESMAN_PRODUCT_TYPES (salesman.conf.AppSettings attribute)
save() (salesman.basket.models.BaseBasketItem method)
(salesman.orders.models.BaseOrder method)
(salesman.orders.models.BaseOrderItem method)
serializer_class (salesman.basket.views.BasketViewSet attribute)
(salesman.checkout.views.CheckoutViewSet attribute)
(salesman.orders.views.OrderViewSet attribute)
setup_basket() (salesman.basket.modifiers.BasketModifier method)
setup_item() (salesman.basket.modifiers.BasketModifier method)
Status (salesman.orders.models.BaseOrder attribute)
status() (salesman.orders.views.OrderViewSet method)
status_display (salesman.orders.models.BaseOrder property)
status_update() (salesman.orders.views.OrderViewSet method)
StatusTransitionSerializer (class in salesman.orders.serializers)
T
to_representation() (salesman.basket.serializers.BasketItemCreateSerializer method)
(salesman.basket.serializers.BasketItemSerializer method)
(salesman.basket.serializers.BasketSerializer method)
(salesman.basket.serializers.ExtraRowsField method)
(salesman.basket.serializers.ProductField method)
(salesman.checkout.serializers.PaymentMethodSerializer method)
(salesman.core.serializers.PriceField method)
(salesman.orders.serializers.OrderStatusSerializer method)
(salesman.orders.serializers.StatusTransitionSerializer method)
U
update() (salesman.basket.models.BaseBasket method)
(salesman.basket.models.BaseBasketItem method)
user_can_create() (salesman.admin.wagtail.helpers.OrderPermissionHelper method)
user_can_delete_obj() (salesman.admin.wagtail.helpers.OrderPermissionHelper method)
V
validate_address() (in module salesman.checkout.utils)
validate_basket() (salesman.checkout.payment.PaymentMethod method)
validate_basket_item() (in module salesman.basket.utils)
validate_extra() (in module salesman.basket.utils)
validate_order() (salesman.checkout.payment.PaymentMethod method)
validate_transition() (salesman.orders.status.BaseOrderStatus class method)
W
WagtailOrderAdminMixin (class in salesman.admin.wagtail.mixins)
WagtailOrderAdminRefundMixin (class in salesman.admin.wagtail.mixins)
WagtailOrderModelForm (class in salesman.admin.wagtail.forms)
Read the Docs
v: latest
Versions
latest
stable
1.2.0
1.1.6
1.1.5
1.1.4
1.1.3
1.1.2
1.1.1
1.1.0
1.0.6
1.0.5
1.0.4
1.0.3
1.0.2
1.0.1
1.0.0
0.1.7
0.1.6
0.1.5
0.1.4
0.1.3
0.1.2
0.1.1
0.1.0
Downloads
On Read the Docs
Project Home
Builds