shop.skeletons¶

Submodules¶

Classes¶

`AddressSkel`
`ArticleAbstractSkel`	Abstract skeleton class which the project has to implement for the article skeletons
`CartNodeSkel`
`CartItemSkel`
`DiscountSkel`
`DiscountConditionSkel`
`OrderSkel`
`ShippingSkel`
`ShippingConfigSkel`
`ShippingPreconditionRelSkel`
`VatSkel`
`VatRateSkel`

Package Contents¶

class shop.skeletons.AddressSkel¶

Bases: viur.core.skeleton.Skeleton

kindName = '{{viur_shop_modulename}}_address'¶

name¶

customer_type¶

salutation¶

company_name¶

firstname¶

lastname¶

street_name¶

street_number¶

address_addition¶

zip_code¶

city¶

country¶

customer¶

email¶: Kopieren von User oder Eingabe von Nutzer bei Gast

phone¶

birthdate¶

is_default¶

address_type¶

cloned_from¶

class shop.skeletons.ArticleAbstractSkel¶

Bases: viur.core.skeleton.BaseSkeleton

Abstract skeleton class which the project has to implement for the article skeletons

All members in this abstract skeleton has to be prefixed with shop_ to avoid name collisions with bones in the project skeleton

property shop_name: StringBone | TextBone¶

Abstractmethod:
Return type:: StringBone | TextBone

Name of the article in the shop

property shop_description: TextBone¶

Abstractmethod:
Return type:: TextBone

property shop_price_retail: NumericBone¶

Abstractmethod:
Return type:: NumericBone

property shop_price_recommended: NumericBone¶

Abstractmethod:
Return type:: NumericBone

property shop_availability: SelectBone¶

Abstractmethod:
Return type:: SelectBone

property shop_listed: BooleanBone¶

Abstractmethod:
Return type:: BooleanBone

property shop_image: FileBone¶

Abstractmethod:
Return type:: FileBone

References a FileSkel

property shop_art_no_or_gtin: StringBone¶

Abstractmethod:
Return type:: StringBone

shop_vat_rate_category¶

property shop_shipping_config: RelationalBone¶

Abstractmethod:
Return type:: RelationalBone

References a ShippingConfigSkel

property shop_is_weee: BooleanBone¶

Abstractmethod:
Return type:: BooleanBone

Waste Electrical and Electronic Equipment Directive (WEEE Directive)

property shop_is_low_price: BooleanBone¶

Abstractmethod:
Return type:: BooleanBone

shop_price_retail != shop_price_recommended

shop_view_url¶: URL to the article page (view)

property shop_price_: viur.shop.types.Price¶

Return type:: viur.shop.types.Price

shop_price¶

shop_shipping¶: Calculated, cheapest shipping for this article

classmethod setSystemInitialized()¶

class shop.skeletons.CartNodeSkel¶

Bases: viur.core.prototypes.tree.TreeSkel

kindName = '{{viur_shop_modulename}}_cart_node'¶

subSkels¶

is_root_node¶

total¶

total_raw¶

total_discount_price¶

vat¶

total_quantity¶

shipping_address¶

customer_comment¶

name¶

cart_type¶

shipping¶

shipping_status¶: Versand bei Warenkorb der einer Bestellung zugehört

discount¶

project_data¶

is_frozen¶

frozen_values¶

classmethod refresh_shipping_address(skel)¶

Shorthand to refresh the shipping_address of an CartNodeSkel Due to race-condition and timing issues, the dest values are not always set correctly. This refresh fixes this.

Parameters:: skel (viur.core.skeleton.SkeletonInstance)
Return type:: viur.core.skeleton.SkeletonInstance

classmethod read(skel, *args, **kwargs)¶

Parameters:: skel (viur.core.skeleton.SkeletonInstance)
Return type:: viur.shop.types.t.Optional[viur.core.skeleton.SkeletonInstance]

class shop.skeletons.CartItemSkel¶

Bases: viur.core.prototypes.tree.TreeSkel

kindName = '{{viur_shop_modulename}}_cart_leaf'¶

article¶

quantity¶

project_data¶

shop_name¶

shop_description¶

shop_price_retail¶

shop_price_recommended¶

shop_availability¶

shop_listed¶

shop_image¶

shop_art_no_or_gtin¶

shop_vat_rate_category¶

shop_shipping_config¶

shop_is_weee¶

shop_is_low_price¶

property article_skel: viur.core.skeleton.SkeletonInstance¶

Return type:: viur.core.skeleton.SkeletonInstance

property article_skel_full: viur.shop.types.SkeletonInstance_T[shop.skeletons.article.ArticleAbstractSkel]¶

Return type:: viur.shop.types.SkeletonInstance_T[shop.skeletons.article.ArticleAbstractSkel]

classmethod get_article_cache()¶

Return type:: dict[viur.core.db.Key, viur.shop.types.SkeletonInstance_T[shop.skeletons.article.ArticleAbstractSkel]]

property parent_skel: viur.core.skeleton.SkeletonInstance¶

Return type:: viur.core.skeleton.SkeletonInstance

property price_: viur.shop.types.Price¶

Return type:: viur.shop.types.Price

price¶

shipping¶

is_frozen¶

frozen_values¶

class shop.skeletons.DiscountSkel¶

Bases: viur.core.skeleton.Skeleton

kindName = '{{viur_shop_modulename}}_discount'¶

interBoneValidations¶

name¶

description¶

discount_type¶

absolute¶

percentage¶

free_article¶

condition¶

condition_operator¶

activate_automatically¶

class shop.skeletons.DiscountConditionSkel¶

Bases: viur.core.skeleton.Skeleton

kindName = '{{viur_shop_modulename}}_discount_condition'¶

interBoneValidations¶

name¶

description¶

code_type¶

application_domain¶: Anwendungsbereich

quantity_volume¶

quantity_used¶: Wie oft wurde der code Bereits verwendet?

individual_codes_amount¶

scope_code¶

individual_codes_prefix¶

scope_minimum_order_value¶

scope_date_start¶

scope_date_end¶

scope_language¶

scope_country¶

scope_minimum_quantity¶

Minimale Anzahl

für Staffelrabatte (in Kombination mit application_domain) für Artikel oder kompletten Warenkorb

scope_customer_group¶

scope_combinable_other_discount¶: Kombinierbar mit anderen Rabatten

scope_combinable_low_price¶

Kombinierbar

prüfen mit shop_is_low_price

scope_article¶

is_subcode¶

parent_code¶

class shop.skeletons.OrderSkel¶

Bases: viur.core.skeleton.Skeleton

kindName = '{{viur_shop_modulename}}_order'¶

billing_address¶

customer¶

cart¶

total¶: Kopie der total vom gesamten Warenkorb

order_uid¶: Bestellnummer

payment_provider¶

is_ordered¶

is_paid¶

is_rts¶

is_checkout_in_progress¶

state¶

email¶: Deprecated since version 0.1.0.dev36: Use shop.skeleton.AddressSkel.email instead.

phone¶: Deprecated since version 0.1.0.dev36: Use shop.skeleton.AddressSkel.phone instead.

project_data¶: Zusätzliche Daten vom Projekt für eine Bestellung. Ggf. überlegen ob einzelne Bones durch Skeleton Modifizierung besser sind.

payment¶

classmethod refresh_cart(skel)¶

Shorthand to refresh the cart of an OrderSkel Due to race-condition and timing issues, the dest values are not always set correctly. This refresh fixes this.

Parameters:: skel (viur.core.skeleton.SkeletonInstance)
Return type:: viur.core.skeleton.SkeletonInstance

classmethod refresh_billing_address(skel)¶

Shorthand to refresh the billing_address of an OrderSkel Due to race-condition and timing issues, the dest values are not always set correctly. This refresh fixes this.

Parameters:: skel (viur.core.skeleton.SkeletonInstance)
Return type:: viur.core.skeleton.SkeletonInstance

classmethod read(skel, *args, **kwargs)¶

Parameters:: skel (viur.core.skeleton.SkeletonInstance)
Return type:: viur.shop.types.t.Optional[viur.core.skeleton.SkeletonInstance]

class shop.skeletons.ShippingSkel¶

Bases: viur.core.skeleton.Skeleton

kindName = '{{viur_shop_modulename}}_shipping'¶

name¶: DHL Standard, DHL Express, DPD-Shop, …

description¶: “Sie brauchen ein DHL-Kundenkonto” “Du bist auf einer Insel” …

shipping_cost¶

art_no¶

supplier¶

delivery_time_min¶: Tag(e)

delivery_time_max¶: Tag(e)

delivery_time_range¶

class shop.skeletons.ShippingConfigSkel¶

Bases: viur.core.skeleton.Skeleton

kindName = '{{viur_shop_modulename}}_shipping_config'¶

name¶

shipping¶

classmethod read(skel, *args, **kwargs)¶

Parameters:: skel (viur.core.skeleton.SkeletonInstance)
Return type:: bool

class shop.skeletons.ShippingPreconditionRelSkel¶

Bases: viur.core.skeleton.RelSkel

minimum_order_value¶

country¶

zip_code¶

class shop.skeletons.VatSkel¶

Bases: viur.core.skeleton.RelSkel

category¶

percentage¶: Vat rate (percentage)

class shop.skeletons.VatRateSkel¶

Bases: viur.core.skeleton.Skeleton

kindName = '{{viur_shop_modulename}}_vat_rate'¶

name¶

country¶

configuration¶