sideshow.enum

Enum Values

sideshow.enum.ORDER_ITEM_EVENT = {10: 'initiated', 20: 'price confirmed', 50: 'payment received', 100: 'ready to proceed', 120: 'customer resolved', 140: 'product resolved', 200: 'placed with vendor', 210: 'marked for re-order', 300: 'received from vendor', 350: 'customer contacted', 375: 'contact failed', 500: 'delivered', 700: 'changed status', 750: 'added note', 900: 'canceled', 910: 'refund pending', 920: 'refunded', 930: 'restocked', 940: 'expired', 950: 'inactive', 999: 'other'}

Dict of possible code -> label options for order item event types.

These codes are referenced by:

sideshow.enum.ORDER_ITEM_EVENT_CANCELED = 900

Indicates the order item was canceled.

sideshow.enum.ORDER_ITEM_EVENT_CONTACTED = 350

Indicates the customer has been contacted, to notify them of the item being on hand and ready for pickup.

sideshow.enum.ORDER_ITEM_EVENT_CONTACT_FAILED = 375

Indicates an attempt was made to contact the customer, to notify them of item being on hand, but the attempt failed, e.g. due to bad phone or email on file.

sideshow.enum.ORDER_ITEM_EVENT_CUSTOMER_RESOLVED = 120

Indicates the customer for the order has been assigned to a “proper” (existing) account. This may happen (after the fact) if the order was first created with a new/unknown customer.

sideshow.enum.ORDER_ITEM_EVENT_DELIVERED = 500

Indicates the customer has picked up the item.

sideshow.enum.ORDER_ITEM_EVENT_EXPIRED = 940

Indicates the order item (or its product) has expired.

sideshow.enum.ORDER_ITEM_EVENT_INACTIVE = 950

Indicates the order item has become inactive.

sideshow.enum.ORDER_ITEM_EVENT_INITIATED = 10

Indicates the item was “initiated” - this occurs when the order is first created.

sideshow.enum.ORDER_ITEM_EVENT_NOTE_ADDED = 750

Indicates an arbitrary note was added.

sideshow.enum.ORDER_ITEM_EVENT_OTHER = 999

Arbitrary event type which does not signify anything in particular. If used, the event should be given an explanatory note.

sideshow.enum.ORDER_ITEM_EVENT_PAYMENT_RECEIVED = 50

Indicates payment was received for the item. This may occur toward the beginning, or toward the end, of the item’s life cycle depending on app configuration etc.

sideshow.enum.ORDER_ITEM_EVENT_PLACED = 200

Indicates the buyer has placed a vendor purchase order which includes this item. So the item is “on order” until the truck arrives.

sideshow.enum.ORDER_ITEM_EVENT_PRICE_CONFIRMED = 20

Indicates the item’s price was confirmed by a user who is authorized to do that.

sideshow.enum.ORDER_ITEM_EVENT_PRODUCT_RESOLVED = 140

Indicates the product for the order item has been assigned to a “proper” (existing) product record. This may happen (after the fact) if the order was first created with a new/unknown product.

sideshow.enum.ORDER_ITEM_EVENT_READY = 100

Indicates the item has become “ready” for buyer placement on a new vendor purchase order. Often this will occur when the order is first created, if the data is suitable. However this may be delayed if e.g. the price needs confirmation.

sideshow.enum.ORDER_ITEM_EVENT_RECEIVED = 300

Indicates the receiver has found the item while receiving a vendor delivery. The item is set aside and is “on hand” until customer comes in to pick it up.

sideshow.enum.ORDER_ITEM_EVENT_REFUNDED = 920

Indicates the customer has been refunded for the item.

sideshow.enum.ORDER_ITEM_EVENT_REFUND_PENDING = 910

Indicates the customer is due a (pending) refund for the item.

sideshow.enum.ORDER_ITEM_EVENT_REORDER = 210

Indicates the item was not received with the delivery on which it was expected, and must be re-ordered from vendor.

sideshow.enum.ORDER_ITEM_EVENT_RESTOCKED = 930

Indicates the product has been restocked, e.g. due to the order item being canceled.

sideshow.enum.ORDER_ITEM_EVENT_STATUS_CHANGE = 700

Indicates a manual status change was made. Such an event should ideally contain a note with further explanation.

sideshow.enum.ORDER_ITEM_STATUS = {1: 'uninitiated', 10: 'initiated', 50: 'paid', 100: 'ready', 200: 'placed', 300: 'received', 350: 'contacted', 375: 'contact failed', 500: 'delivered', 550: 'paid', 900: 'canceled', 910: 'refund pending', 920: 'refunded', 930: 'restocked', 940: 'expired', 950: 'inactive'}

Dict of possible code -> label options for order item status.

These codes are referenced by:

sideshow.enum.ORDER_ITEM_STATUS_CANCELED = 900

Indicates the order item has been canceled.

sideshow.enum.ORDER_ITEM_STATUS_CONTACTED = 350

Indicates the customer has been notified that the item is “on hand” and awaiting their pickup.

sideshow.enum.ORDER_ITEM_STATUS_CONTACT_FAILED = 375

Indicates the attempt(s) to notify customer have failed. The item is on hand but the customer does not know to pickup.

sideshow.enum.ORDER_ITEM_STATUS_DELIVERED = 500

Indicates the customer has picked up the item.

sideshow.enum.ORDER_ITEM_STATUS_EXPIRED = 940

Indicates the order item and/or product has expired.

sideshow.enum.ORDER_ITEM_STATUS_INACTIVE = 950

Indicates the order item has become inactive.

sideshow.enum.ORDER_ITEM_STATUS_INITIATED = 10

Indicates the item is “initiated” (aka. created) but not yet “ready” for buyer/PO. This may imply the price needs confirmation etc.

sideshow.enum.ORDER_ITEM_STATUS_PAID_AFTER = 550

Indicates the customer has fully paid for the item, as part of their pickup. This completes the cycle for orders which require payment on the tail end.

sideshow.enum.ORDER_ITEM_STATUS_PAID_BEFORE = 50

Indicates the customer has fully paid for the item, up-front before the buyer places PO etc. It implies the item is not yet “ready” for some reason.

sideshow.enum.ORDER_ITEM_STATUS_PLACED = 200

Indicates the buyer has placed a vendor purchase order which includes this item. The item is thereby “on order” until the truck arrives.

sideshow.enum.ORDER_ITEM_STATUS_READY = 100

Indicates the item is “ready” for buyer to include it on a vendor purchase order.

sideshow.enum.ORDER_ITEM_STATUS_RECEIVED = 300

Indicates the item has been received as part of a vendor delivery. The item is thereby “on hand” until customer comes in for pickup.

sideshow.enum.ORDER_ITEM_STATUS_REFUNDED = 920

Indicates the order item has been canceled, and the customer has been given a refund.

sideshow.enum.ORDER_ITEM_STATUS_REFUND_PENDING = 910

Indicates the order item has been canceled, and the customer is due a (pending) refund.

sideshow.enum.ORDER_ITEM_STATUS_RESTOCKED = 930

Indicates the product has been restocked, e.g. after the order item was canceled.

sideshow.enum.ORDER_ITEM_STATUS_UNINITIATED = 1

Indicates the item is “not yet initiated” - this probably is not useful but exists as a possibility just in case.

sideshow.enum.ORDER_UOM = {'CS': 'Cases', 'EA': 'Units', 'KG': 'Kilograms', 'LB': 'Pounds'}

Dict of possible code -> label options for ordering unit of measure.

These codes are referenced by:

sideshow.enum.ORDER_UOM_CASE = 'CS'

UOM code for ordering a “case” of product.

Sideshow will treat “case” orders somewhat differently as compared to “unit” orders.

sideshow.enum.ORDER_UOM_KILOGRAM = 'KG'

UOM code for ordering a “kilogram” of product.

This is treated same as “unit” by Sideshow. However it should (probably?) only be used for items where e.g. product_weighed is true.

sideshow.enum.ORDER_UOM_POUND = 'LB'

UOM code for ordering a “pound” of product.

This is treated same as “unit” by Sideshow. However it should (probably?) only be used for items where e.g. product_weighed is true.

sideshow.enum.ORDER_UOM_UNIT = 'EA'

UOM code for ordering a “unit” of product.

This is the default “unit” UOM but in practice all others are treated the same by Sideshow, whereas “case” orders are treated somewhat differently.

enum sideshow.enum.PendingCustomerStatus(value)[source]

Enum values for sideshow.db.model.customers.PendingCustomer.status.

Valid values are as follows:

PENDING = <PendingCustomerStatus.PENDING: 'pending'>
READY = <PendingCustomerStatus.READY: 'ready'>
RESOLVED = <PendingCustomerStatus.RESOLVED: 'resolved'>
IGNORED = <PendingCustomerStatus.IGNORED: 'ignored'>
enum sideshow.enum.PendingProductStatus(value)[source]

Enum values for sideshow.db.model.products.PendingProduct.status.

Valid values are as follows:

PENDING = <PendingProductStatus.PENDING: 'pending'>
READY = <PendingProductStatus.READY: 'ready'>
RESOLVED = <PendingProductStatus.RESOLVED: 'resolved'>
IGNORED = <PendingProductStatus.IGNORED: 'ignored'>