shop.modules.shipping
=====================

.. py:module:: shop.modules.shipping


Attributes
----------

.. autoapisummary::

   shop.modules.shipping.logger


Classes
-------

.. autoapisummary::

   shop.modules.shipping.Shipping


Module Contents
---------------

.. py:data:: logger

.. py:class:: Shipping

   Bases: :py:obj:`shop.modules.abstract.ShopModuleAbstract`, :py:obj:`viur.core.prototypes.List`


   .. py:attribute:: moduleName
      :value: 'shipping'



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



   .. py:method:: adminInfo()


   .. py:method:: choose_shipping_skel_for_article(article_skel, *, country = None)

      Chooses always the cheapest, applicable shipping for an article

      Ignores the supplier

      :param country: Ignore the context and get shipping for this country.

      # TODO(discuss): List all options?



   .. py:method:: get_shipping_skels_for_cart(*, cart_key = SENTINEL, cart_skel = SENTINEL, country = None, use_cache = False)

      Get all configured and applicable shippings of all items in the cart

      # TODO: how do we handle free shipping discounts?

      :param cart_key: Key of the parent cart node, can be a sub-cart too
      :param country: Ignore the context and get shipping for this country.
      :return: A list of :class:`SkeletonInstance`s for the :class:`ShippingSkel`.