This package is part of the bda.plone.shop stack. Please refer to https://github.com/bluedynamics/bda.plone.shop for installation instructions.

• The order actions are done with background images in CSS, so if you have your own theme that is not based on Sunburst, you will have to add the "icons.on" part of Sunburst's base.css.

If you've added custom fields to the checkout (see bda.plone.checkout), chances are high you want to add them to the order emails, order summaries or the order export.

Please follow the instructions in Customizing the shop in the bda.plone.shop Readme first to setup the patch infrastructure.

After that you can start customizing the order process:

def patchShop():
    patchMailTemplates()
    patchOrderExport()

Copy the messages you need to customize from bda.plone.orders.mailtemplates and change the text to your needs. There are two dictionaries containing all the strings, ORDER_TEMPLATES and RESERVATION_TEMPLATES. Its a nested dict. On the first level is the langugae code, the second level is subject, body and delivery_address. Change them i.e. like this:

from bda.plone.orders.mailtemplates import ORDER_TEMPLATES
from bda.plone.orders.mailtemplates import RESERVATION_TEMPLATES

ORDER_TEMPLATES['en']['body'] = """
This is my heavily customized confirmation mail."""

RESERVATION_TEMPLATES['de']['body'] = "Ihre Reservierung ist da!"

When updating bda.plone.order to a new version, make sure to keep them in sync with the original templates and check if all stock variables (such as global_text or the @@showorder link which have been added in version 0.4 are present.)

Alternativly you add/replace the notification methods and implement your own very custom. To do provide your own two functions similar to bda.plone.orders.mailnotify.notify_checkout_success and bda.plone.orders.mailnotify.notify_payment_success. Then

from bda.plone.orders.mailnotify import NOTIFICATIONS

# register as additional action
NOTIFICATIONS['checkout_success'].append(my_notify_checkout_success)
NOTIFICATIONS['payment_success'].append(my_notify_payment_success)

# OR
# register as replacement:
NOTIFICATIONS['checkout_success'] = [my_notify_checkout_success]
NOTIFICATIONS['payment_success'] = [my_notify_payment_success]

To make a new field show up in the export, just add it to the list ORDER_EXPORT_ATTRS.

In this example we include the company uid we added in the example for customizing bda.plone.checkout right after the company name:

from bda.plone.orders.browser.views import ORDER_EXPORT_ATTRS

def patchOrderExport():
    idx = ORDER_EXPORT_ATTRS.index('personal_data.company')
    ORDER_EXPORT_ATTRS.insert(idx+1, 'personal_data.uid')

To show the data of the new field in the detail view of the order customize bda/plone/orders/browser/order.pt using z3c.jbot or by registering the page for your policy package's browserlayer or themelayer:

<browser:page
  for="zope.component.interfaces.ISite"
  name="order"
  template="my-order.pt"
  class="bda.plone.orders.browser.views.OrderView"
  permission="bda.plone.orders.ViewOrders"
  layer="my.package.interfaces.IMyBrowserLayer"/>

• Make sure you do not move orders or bookings soup away from portal root. This will end up in unexpected behavior and errors.

In general, custom shop deployments are likely to configure the permission and role settings according to their use cases.

The Permissions bda.plone.orders.ViewOrderDirectly and bda.plone.orders.ViewOrders are granted to default Plone roles rather than Customer role, because the Customer role can be granted as a local role contextually, where the @@orders and @@showorder views should be callable on ISite root. So a possible customer might be no customer on the site root.

TODO: document

TODO: document

TODO: document

TODO: document

TODO: document

TODO: document

TODO: document

TODO: document

In your Generic Setup's profile, add to rolemap.xml:

<!-- Allow Anonymous to buy items -->
<permission name="bda.plone.orders: View Order Directly" acquire="True">
  <role name="Manager" />
  <role name="Site Administrator" />
  <role name="Authenticated" />
  <role name="Anonymous"/>
</permission>
<permission name="bda.plone.shop: View Buyable Info" acquire="True">
  <role name="Manager" />
  <role name="Site Administrator" />
  <role name="Reviewer" />
  <role name="Editor" />
  <role name="Customer" />
  <role name="Anonymous"/>
</permission>
<permission name="bda.plone.shop: Buy Items" acquire="True">
  <role name="Manager" />
  <role name="Site Administrator" />
  <role name="Customer" />
  <role name="Anonymous"/>
</permission>

$ cd src/bda/plone/orders/
$ ./i18n.sh

• @@orders in lineage subsites should only list orders in that path.
• Consider vendor UID's and booking based state in mail notification
• add is_customer utility
• improve customers vocabulary utility to be more cpu friendly
• search text in orders view needs to consider vendor and customer filter
• Display Export orders link only for vendors and administrators
• Work internally with unicode only.

• Move IUUID adapter for IPloneSiteRoot to bda.plone.cart, which is the central package for the shop.
• cart_discount_net and cart_discount_vat values calculation for vendor specific orders in order view and order export.
• skip payment for individual bookings instead of whole order, if they are in state reserved.
• warning-popup, if state is changed globally for all bookings in @@orders view
• buyable_uid, buyable_count, buyable_comment -> should be named cartitem*?
• customer role -> move to bda.plone.cart
• eventually create common.BookingTransitions and common.BookingData
• fix dependency in bda.plone.payment.cash.__init__, which depends on b.p.orders
• eventually create: or bda.shop, which defines the interfaces. every other package can depend on, which eases the dependency chain

• Robert Niederreiter (Author)
• Johannes Raggam
• Peter Holzer
• Harald Frießnegger
• Ezra Holder
• Benjamin Stefaner (benniboy)

Icons used are Silk-Icons by FamFamFam under CC-BY 2.5 license.