shop.skeletons
==============

.. py:module:: shop.skeletons


Submodules
----------

.. toctree::
   :maxdepth: 1

   /viur/shop/skeletons/address/index
   /viur/shop/skeletons/article/index
   /viur/shop/skeletons/cart/index
   /viur/shop/skeletons/discount/index
   /viur/shop/skeletons/discount_condition/index
   /viur/shop/skeletons/order/index
   /viur/shop/skeletons/shipping/index
   /viur/shop/skeletons/shipping_config/index
   /viur/shop/skeletons/shipping_precondition/index
   /viur/shop/skeletons/vat/index
   /viur/shop/skeletons/vat_rate/index


Classes
-------

.. autoapisummary::

   shop.skeletons.AddressSkel
   shop.skeletons.ArticleAbstractSkel
   shop.skeletons.CartNodeSkel
   shop.skeletons.CartItemSkel
   shop.skeletons.DiscountSkel
   shop.skeletons.DiscountConditionSkel
   shop.skeletons.OrderSkel
   shop.skeletons.ShippingSkel
   shop.skeletons.ShippingConfigSkel
   shop.skeletons.ShippingPreconditionRelSkel
   shop.skeletons.VatSkel
   shop.skeletons.VatRateSkel


Package Contents
----------------

.. py:class:: AddressSkel

   Bases: :py:obj:`viur.core.skeleton.Skeleton`


   .. py:attribute:: kindName
      :value: '{{viur_shop_modulename}}_address'



   .. py:attribute:: name


   .. py:attribute:: customer_type


   .. py:attribute:: salutation


   .. py:attribute:: company_name


   .. py:attribute:: firstname


   .. py:attribute:: lastname


   .. py:attribute:: street_name


   .. py:attribute:: street_number


   .. py:attribute:: address_addition


   .. py:attribute:: zip_code


   .. py:attribute:: city


   .. py:attribute:: country


   .. py:attribute:: customer


   .. py:attribute:: email

      Kopieren von User oder Eingabe von Nutzer bei Gast



   .. py:attribute:: phone


   .. py:attribute:: birthdate


   .. py:attribute:: is_default


   .. py:attribute:: address_type


   .. py:attribute:: cloned_from


.. py:class:: ArticleAbstractSkel

   Bases: :py:obj:`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


   .. py:property:: shop_name
      :type: StringBone | TextBone

      :abstractmethod:


      Name of the article in the shop



   .. py:property:: shop_description
      :type: TextBone

      :abstractmethod:



   .. py:property:: shop_price_retail
      :type: NumericBone

      :abstractmethod:



   .. py:property:: shop_price_recommended
      :type: NumericBone

      :abstractmethod:



   .. py:property:: shop_availability
      :type: SelectBone

      :abstractmethod:



   .. py:property:: shop_listed
      :type: BooleanBone

      :abstractmethod:



   .. py:property:: shop_image
      :type: FileBone

      :abstractmethod:


      References a FileSkel



   .. py:property:: shop_art_no_or_gtin
      :type: StringBone

      :abstractmethod:



   .. py:attribute:: shop_vat_rate_category


   .. py:property:: shop_shipping_config
      :type: RelationalBone

      :abstractmethod:


      References a ShippingConfigSkel



   .. py:property:: shop_is_weee
      :type: BooleanBone

      :abstractmethod:


      Waste Electrical and Electronic Equipment Directive (WEEE Directive)



   .. py:property:: shop_is_low_price
      :type: BooleanBone

      :abstractmethod:


      shop_price_retail != shop_price_recommended



   .. py:attribute:: shop_view_url

      URL to the article page (view)



   .. py:property:: shop_price_
      :type: viur.shop.types.Price



   .. py:attribute:: shop_price


   .. py:attribute:: shop_shipping

      Calculated, cheapest shipping for this article



   .. py:method:: setSystemInitialized()
      :classmethod:



.. py:class:: CartNodeSkel

   Bases: :py:obj:`viur.core.prototypes.tree.TreeSkel`


   .. py:attribute:: kindName
      :value: '{{viur_shop_modulename}}_cart_node'



   .. py:attribute:: subSkels


   .. py:attribute:: is_root_node


   .. py:attribute:: total


   .. py:attribute:: total_raw


   .. py:attribute:: total_discount_price


   .. py:attribute:: vat


   .. py:attribute:: total_quantity


   .. py:attribute:: shipping_address


   .. py:attribute:: customer_comment


   .. py:attribute:: name


   .. py:attribute:: cart_type


   .. py:attribute:: shipping


   .. py:attribute:: shipping_status

      Versand bei Warenkorb der einer Bestellung zugehört



   .. py:attribute:: discount


   .. py:attribute:: project_data


   .. py:attribute:: is_frozen


   .. py:attribute:: frozen_values


   .. py:method:: refresh_shipping_address(skel)
      :classmethod:


      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.



   .. py:method:: read(skel, *args, **kwargs)
      :classmethod:



.. py:class:: CartItemSkel

   Bases: :py:obj:`viur.core.prototypes.tree.TreeSkel`


   .. py:attribute:: kindName
      :value: '{{viur_shop_modulename}}_cart_leaf'



   .. py:attribute:: article


   .. py:attribute:: quantity


   .. py:attribute:: project_data


   .. py:attribute:: shop_name


   .. py:attribute:: shop_description


   .. py:attribute:: shop_price_retail


   .. py:attribute:: shop_price_recommended


   .. py:attribute:: shop_availability


   .. py:attribute:: shop_listed


   .. py:attribute:: shop_image


   .. py:attribute:: shop_art_no_or_gtin


   .. py:attribute:: shop_vat_rate_category


   .. py:attribute:: shop_shipping_config


   .. py:attribute:: shop_is_weee


   .. py:attribute:: shop_is_low_price


   .. py:property:: article_skel
      :type: viur.core.skeleton.SkeletonInstance



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



   .. py:method:: get_article_cache()
      :classmethod:



   .. py:property:: parent_skel
      :type: viur.core.skeleton.SkeletonInstance



   .. py:property:: price_
      :type: viur.shop.types.Price



   .. py:attribute:: price


   .. py:attribute:: shipping


   .. py:attribute:: is_frozen


   .. py:attribute:: frozen_values


.. py:class:: DiscountSkel

   Bases: :py:obj:`viur.core.skeleton.Skeleton`


   .. py:attribute:: kindName
      :value: '{{viur_shop_modulename}}_discount'



   .. py:attribute:: interBoneValidations


   .. py:attribute:: name


   .. py:attribute:: description


   .. py:attribute:: discount_type


   .. py:attribute:: absolute


   .. py:attribute:: percentage


   .. py:attribute:: free_article


   .. py:attribute:: condition


   .. py:attribute:: condition_operator


   .. py:attribute:: activate_automatically


.. py:class:: DiscountConditionSkel

   Bases: :py:obj:`viur.core.skeleton.Skeleton`


   .. py:attribute:: kindName
      :value: '{{viur_shop_modulename}}_discount_condition'



   .. py:attribute:: interBoneValidations


   .. py:attribute:: name


   .. py:attribute:: description


   .. py:attribute:: code_type


   .. py:attribute:: application_domain

      Anwendungsbereich



   .. py:attribute:: quantity_volume


   .. py:attribute:: quantity_used

      Wie oft wurde der code Bereits verwendet?



   .. py:attribute:: individual_codes_amount


   .. py:attribute:: scope_code


   .. py:attribute:: individual_codes_prefix


   .. py:attribute:: scope_minimum_order_value


   .. py:attribute:: scope_date_start


   .. py:attribute:: scope_date_end


   .. py:attribute:: scope_language


   .. py:attribute:: scope_country


   .. py:attribute:: scope_minimum_quantity

      Minimale Anzahl

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



   .. py:attribute:: scope_customer_group


   .. py:attribute:: scope_combinable_other_discount

      Kombinierbar mit anderen Rabatten



   .. py:attribute:: scope_combinable_low_price

      Kombinierbar

      prüfen mit shop_is_low_price



   .. py:attribute:: scope_article


   .. py:attribute:: is_subcode


   .. py:attribute:: parent_code


.. py:class:: OrderSkel

   Bases: :py:obj:`viur.core.skeleton.Skeleton`


   .. py:attribute:: kindName
      :value: '{{viur_shop_modulename}}_order'



   .. py:attribute:: billing_address


   .. py:attribute:: customer


   .. py:attribute:: cart


   .. py:attribute:: total

      Kopie der total vom gesamten Warenkorb



   .. py:attribute:: order_uid

      Bestellnummer



   .. py:attribute:: payment_provider


   .. py:attribute:: is_ordered


   .. py:attribute:: is_paid


   .. py:attribute:: is_rts


   .. py:attribute:: is_checkout_in_progress


   .. py:attribute:: state


   .. py:attribute:: email

      .. deprecated:: 0.1.0.dev36
          Use :py:attr:`shop.skeleton.AddressSkel.email` instead.



   .. py:attribute:: phone

      .. deprecated:: 0.1.0.dev36
          Use :py:attr:`shop.skeleton.AddressSkel.phone` instead.



   .. py:attribute:: project_data

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



   .. py:attribute:: payment


   .. py:method:: refresh_cart(skel)
      :classmethod:


      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.



   .. py:method:: refresh_billing_address(skel)
      :classmethod:


      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.



   .. py:method:: read(skel, *args, **kwargs)
      :classmethod:



.. py:class:: ShippingSkel

   Bases: :py:obj:`viur.core.skeleton.Skeleton`


   .. py:attribute:: kindName
      :value: '{{viur_shop_modulename}}_shipping'



   .. py:attribute:: name

      DHL Standard, DHL Express, DPD-Shop, ...



   .. py:attribute:: description

      "Sie brauchen ein DHL-Kundenkonto"
      "Du bist auf einer Insel"
      ...



   .. py:attribute:: shipping_cost


   .. py:attribute:: art_no


   .. py:attribute:: supplier


   .. py:attribute:: delivery_time_min

      Tag(e)



   .. py:attribute:: delivery_time_max

      Tag(e)



   .. py:attribute:: delivery_time_range


.. py:class:: ShippingConfigSkel

   Bases: :py:obj:`viur.core.skeleton.Skeleton`


   .. py:attribute:: kindName
      :value: '{{viur_shop_modulename}}_shipping_config'



   .. py:attribute:: name


   .. py:attribute:: shipping


   .. py:method:: read(skel, *args, **kwargs)
      :classmethod:



.. py:class:: ShippingPreconditionRelSkel

   Bases: :py:obj:`viur.core.skeleton.RelSkel`


   .. py:attribute:: minimum_order_value


   .. py:attribute:: country


   .. py:attribute:: zip_code


.. py:class:: VatSkel

   Bases: :py:obj:`viur.core.skeleton.RelSkel`


   .. py:attribute:: category


   .. py:attribute:: percentage

      Vat rate (percentage)



.. py:class:: VatRateSkel

   Bases: :py:obj:`viur.core.skeleton.Skeleton`


   .. py:attribute:: kindName
      :value: '{{viur_shop_modulename}}_vat_rate'



   .. py:attribute:: name


   .. py:attribute:: country


   .. py:attribute:: configuration