Obsolete documentation

Plugins

Django SHOP defines 4 types of different plugins for the time being:

  1. Cart modifiers
  2. Shipping modules
  3. Payment modules
  4. Order workflow modules

Shipping backends

Shipping backends differ from price modifiers in that there must be only one shipping backend selected per order (the shopper must choose which delivery method to use)

Shipping costs should be calculated on an Order object, not on a Cart object (Order instances are fully serialized in the database for archiving purposes).

How they work

Shipping backends need to be registered in the SHOP_SHIPPING_BACKENDS Django setting. They do not need to extend any particular class, but need to expose a specific interface, as defined in :ref:`shipping-backend-interface`.

The core functionality the shop exposes is the ability to retrieve the current Order object (and all it’s related bits and pieces such as extra price fields, line items etc...) via a convenient self.shop.get_order() call. This allows for your module to be reused relatively easily should another shop system implement this interface.

On their part, shipping backends should expose at least a get_urls() method, returning a urlpattern-style list or urls. This allows backend writers to have almost full control of the shipping process (they can create views and make them available to the URL resolver).

Please note that module URLs should be namespaced, and will be added to the ship/ URL namespace. This is a hard limitation to avoid URL name clashes.

Payment backends

Payment backends must also be selected by the end user (the shopper). Theses modules take care of the actual payment processing.

How they work

Similar to shipping backends, payment backends do not need to extend any particular class, but need to expose a specific interface, as defined in Backend interface.

They also obtain a reference to the shop, with some convenient methods defined such as self.shop.get_order().

They must also define a get_urls() method, and all defined URLs will be namespaced to pay/.