sideshow.web.views.orders

Views for Orders

class sideshow.web.views.orders.ContactView(request, context=None)

Master view for the “contact” phase of OrderItem; route prefix is contact. This is a subclass of OrderItemView.

This class auto-filters so only order items with the following status codes are shown:

• ORDER_ITEM_STATUS_RECEIVED

• ORDER_ITEM_STATUS_CONTACT_FAILED

Notable URLs provided by this class:

• /contact/

• /contact/XXX

process_contact_failure()

View to process the “contact failure” step for some order item(s).

This requires a POST request with data:

Parameters:

• item_uuids – Comma-delimited list of OrderItem UUID keys.

• note – Optional note text from the user.

This invokes process_contact_failure() on the order_handler, then redirects user back to the index page.

process_contact_success()

View to process the “contact success” step for some order item(s).

This requires a POST request with data:

Parameters:

• item_uuids – Comma-delimited list of OrderItem UUID keys.

• note – Optional note text from the user.

This invokes process_contact_success() on the order_handler, then redirects user back to the index page.

class sideshow.web.views.orders.DeliveryView(request, context=None)

Master view for the “delivery” phase of OrderItem; route prefix is delivery. This is a subclass of OrderItemView.

This class auto-filters so only order items with the following status codes are shown:

• ORDER_ITEM_STATUS_RECEIVED

• ORDER_ITEM_STATUS_CONTACTED

Notable URLs provided by this class:

• /delivery/

• /delivery/XXX

process_delivery()

View to process the “delivery” step for some order item(s).

This requires a POST request with data:

Parameters:

• item_uuids – Comma-delimited list of OrderItem UUID keys.

• note – Optional note text from the user.

This invokes process_delivery() on the order_handler, then redirects user back to the index page.

process_restock()

View to process the “restock” step for some order item(s).

This requires a POST request with data:

Parameters:

• item_uuids – Comma-delimited list of OrderItem UUID keys.

• note – Optional note text from the user.

This invokes process_restock() on the order_handler, then redirects user back to the index page.

class sideshow.web.views.orders.OrderItemView(request, context=None)

Master view for OrderItem; route prefix is order_items.

Notable URLs provided by this class:

• /order-items/

• /order-items/XXX

This class serves both as a proper master view (for “all” order items) as well as a base class for other “workflow” master views, each of which auto-filters by order item status:

• PlacementView

• ReceivingView

• ContactView

• DeliveryView

Note that this does not expose create, edit or delete. The user must perform various other workflow actions to modify the item.

order_handler

Reference to the order handler as returned by get_order_handler().

add_note()

View which adds a note to an order item. This is POST-only; will redirect back to the item view.

change_status()

View which changes status for an order item. This is POST-only; will redirect back to the item view.

get_order_items(uuids)

This method provides common logic to fetch a list of order items based on a list of UUID keys. It is used by various workflow action methods.

Note that if no order items are found, this will set a flash warning message and raise a redirect back to the index page.

Parameters:

uuids – List (or comma-delimited string) of UUID keys.

Returns:

List of OrderItem records.

model_class

alias of OrderItem

class sideshow.web.views.orders.OrderView(request, context=None)

Master view for Order; route prefix is orders.

Notable URLs provided by this class:

• /orders/

• /orders/new

• /orders/XXX

• /orders/XXX/delete

Note that the “edit” view is not exposed here; user must perform various other workflow actions to modify the order.

order_handler

Reference to the order handler as returned by get_order_handler(). This gets set in the constructor.

batch_handler

Reference to the new order batch handler. This gets set in the constructor.

add_item(batch, data)

This adds a row to the user’s current new order batch.

This is a “batch action” method which may be called from create(). See also:

• update_item()

• delete_item()

assign_customer(batch, data)

Assign the true customer account for a batch.

This calls set_customer() for the heavy lifting.

This is a “batch action” method which may be called from create(). See also:

• unassign_customer()

• set_pending_customer()

cancel_order(batch)

This will delete the user’s current batch, then redirect user back to “List Orders” page.

This is a “batch action” method which may be called from create(). See also:

• start_over()

• submit_order()

create()

Instead of the typical “create” view, this displays a “wizard” of sorts.

Under the hood a NewOrderBatch is automatically created for the user when they first visit this page. They can select a customer, add items etc.

When user is finished assembling the order (i.e. populating the batch), they submit it. This of course executes the batch, which in turn creates a true Order, and user is redirected to the “view order” page.

See also these methods which may be called from this one, based on user actions:

• start_over()

• cancel_order()

• set_store()

• assign_customer()

• unassign_customer()

• set_pending_customer()

• get_product_info()

• add_item()

• update_item()

• delete_item()

• submit_order()

customer_autocomplete()

AJAX view for customer autocomplete, when entering new order.

This invokes one of the following on the batch_handler:

• autocomplete_customers_external()

• autocomplete_customers_local()

Returns:

List of search results; each should be a dict with value and label keys.

classmethod defaults(config)

Provide default Pyramid configuration for a master view.

This is generally called from within the module’s includeme() function, e.g.:

from wuttaweb.views import MasterView

class WidgetView(MasterView):
    model_name = 'Widget'

def includeme(config):
    WidgetView.defaults(config)

Parameters:

config – Reference to the app’s pyramid.config.Configurator instance.

delete_item(batch, data)

This deletes a row from the user’s current new order batch.

This is a “batch action” method which may be called from create(). See also:

• add_item()

• update_item()

get_current_batch()

Returns the current batch for the current user.

This looks for a new order batch which was created by the user, but not yet executed. If none is found, a new batch is created.

Returns:

NewOrderBatch instance

get_dept_item_discounts()

Returns the list of per-department default item discount settings.

Each entry in the list will look like:

{
    'department_id': '42',
    'department_name': 'Grocery',
    'default_item_discount': 10,
}

Returns:

List of department settings as shown above.

get_past_products(batch, data)

Fetch past products for convenient re-ordering.

This essentially calls get_past_products() on the batch_handler and returns the result.

This is a “batch action” method which may be called from create().

Returns:

List of product info dicts.

get_product_info(batch, data)

Fetch data for a specific product.

Depending on config, this calls one of the following to get its primary data:

• get_product_info_local()

• get_product_info_external()

It then may supplement the data with additional fields.

This is a “batch action” method which may be called from create().

Returns:

Dict of product info.

model_class

alias of Order

product_autocomplete()

AJAX view for product autocomplete, when entering new order.

This invokes one of the following on the batch_handler:

• autocomplete_products_external()

• autocomplete_products_local()

Returns:

List of search results; each should be a dict with value and label keys.

row_model_class

alias of OrderItem

set_pending_customer(batch, data)

This will set/update the batch pending customer info.

This calls set_customer() for the heavy lifting.

This is a “batch action” method which may be called from create(). See also:

• assign_customer()

• unassign_customer()

set_store(batch, data)

Assign the store_id for a batch.

This is a “batch action” method which may be called from create().

start_over(batch)

This will delete the user’s current batch, then redirect user back to “Create Order” page, which in turn will auto-create a new batch for them.

This is a “batch action” method which may be called from create(). See also:

• cancel_order()

• submit_order()

submit_order(batch, data)

This submits the user’s current new order batch, hence executing the batch and creating the true order.

This is a “batch action” method which may be called from create(). See also:

• start_over()

• cancel_order()

unassign_customer(batch, data)

Clear the customer info for a batch.

This calls set_customer() for the heavy lifting.

This is a “batch action” method which may be called from create(). See also:

• assign_customer()

• set_pending_customer()

update_item(batch, data)

This updates a row in the user’s current new order batch.

This is a “batch action” method which may be called from create(). See also:

• add_item()

• delete_item()

class sideshow.web.views.orders.PlacementView(request, context=None)

Master view for the “placement” phase of OrderItem; route prefix is placement. This is a subclass of OrderItemView.

This class auto-filters so only order items with the following status codes are shown:

• ORDER_ITEM_STATUS_READY

Notable URLs provided by this class:

• /placement/

• /placement/XXX

process_placement()

View to process the “placement” step for some order item(s).

This requires a POST request with data:

Parameters:

• item_uuids – Comma-delimited list of OrderItem UUID keys.

• vendor_name – Optional name of vendor.

• po_number – Optional PO number.

• note – Optional note text from the user.

This invokes process_placement() on the order_handler, then redirects user back to the index page.

class sideshow.web.views.orders.ReceivingView(request, context=None)

Master view for the “receiving” phase of OrderItem; route prefix is receiving. This is a subclass of OrderItemView.

This class auto-filters so only order items with the following status codes are shown:

• ORDER_ITEM_STATUS_PLACED

Notable URLs provided by this class:

• /receiving/

• /receiving/XXX

process_receiving()

View to process the “receiving” step for some order item(s).

This requires a POST request with data:

Parameters:

• item_uuids – Comma-delimited list of OrderItem UUID keys.

• vendor_name – Optional name of vendor.

• invoice_number – Optional invoice number.

• po_number – Optional PO number.

• note – Optional note text from the user.

This invokes process_receiving() on the order_handler, then redirects user back to the index page.

process_reorder()

View to process the “reorder” step for some order item(s).

This requires a POST request with data:

Parameters:

• item_uuids – Comma-delimited list of OrderItem UUID keys.

• note – Optional note text from the user.

This invokes process_reorder() on the order_handler, then redirects user back to the index page.