shuup.core.suppliers package

Submodules

shuup.core.suppliers.base module

class shuup.core.suppliers.base.BaseSupplierModule(supplier, options)[source]

Bases: object

Base supplier module implementation.

identifier = None
name = None
get_stock_statuses(product_ids)[source]
Parameters:product_ids – Iterable of product IDs
Returns:Dict of {product_id: ProductStockStatus}
Return type:dict[int, shuup.core.stocks.ProductStockStatus]
get_stock_status(product_id)[source]
Parameters:product_id (int) – Product ID
Return type:shuup.core.stocks.ProductStockStatus
get_orderability_errors(shop_product, quantity, customer)[source]
Parameters:
Return type:

iterable[ValidationError]
adjust_stock(product_id, delta, created_by=None, type=<StockAdjustmentType.INVENTORY: 1>)[source]
update_stock(product_id)[source]
update_stocks(product_ids)[source]
ship_products(shipment, product_quantities)[source]

shuup.core.suppliers.enums module

class shuup.core.suppliers.enums.StockAdjustmentType[source]

Bases: enumfields.enums.Enum

An enumeration.

INVENTORY = <StockAdjustmentType.INVENTORY: 1>
RESTOCK = <StockAdjustmentType.RESTOCK: 2>
RESTOCK_LOGICAL = <StockAdjustmentType.RESTOCK_LOGICAL: 3>

Module contents

class shuup.core.suppliers.BaseSupplierModule(supplier, options)[source]

Bases: object

Base supplier module implementation.

adjust_stock(product_id, delta, created_by=None, type=<StockAdjustmentType.INVENTORY: 1>)[source]
get_orderability_errors(shop_product, quantity, customer)[source]
Parameters:
Return type:

iterable[ValidationError]
get_stock_status(product_id)[source]
Parameters:product_id (int) – Product ID
Return type:shuup.core.stocks.ProductStockStatus
get_stock_statuses(product_ids)[source]
Parameters:product_ids – Iterable of product IDs
Returns:Dict of {product_id: ProductStockStatus}
Return type:dict[int, shuup.core.stocks.ProductStockStatus]
identifier = None
name = None
ship_products(shipment, product_quantities)[source]
update_stock(product_id)[source]
update_stocks(product_ids)[source]