Skip to content

Product Models

Classes for representing products, product groups, shopping list items, and related data.

Product

The main product class, initialized from various API response types.

Product(data)

Bases: DataModel

name property

id property

product_group_id property

available_amount property

amount_aggregated property

amount_opened property

amount_opened_aggregated property

is_aggregated_amount property

best_before_date property

barcodes property

product_barcodes property

amount_missing property

is_partly_in_stock property

default_quantity_unit_purchase property

get_details(api_client)

ProductBarcode

ProductBarcode(data)

Bases: DataModel

barcode property

amount property

QuantityUnit

QuantityUnit(data)

Bases: DataModel

id property

name property

name_plural property

description property

Group

Represents a product group.

Group(raw_product_group)

Bases: DataModel

id property

name property

description property

ShoppingListProduct

A product entry on a shopping list.

ShoppingListProduct(raw_shopping_list)

Bases: DataModel

id property

product_id property

amount property

note property

product property

done property

get_details(api_client)