Spree Commerce customisation
OFN is built on Spree Commerce Engine (currently being upgraded to v2.0.0), with significant modifications as outlined below. Advantages of building on top of this include:
- Strong basic functionality taken care of: orders; product displays; payments; checkout etc
- Active community maintaining and improving the underlying code base and documentation
- Reasonable and growing library of extensions to add functionality (including interfaces to other platforms)
This section explains the main structural changes we have made to the Spree core, which reflect our design for flexibility in use and how the system could evolve.
The latest summary of objects and their relationships is shown below. [ERD diagram]
'Enterprises' are business or community entities that play an active role in supplying and/or distributing food.
The simplest Enterprise has the role Producer - these supply products to the system and set the base price.
The other current Enterprise type is a Hub (diverse Distributors) - an Enterprise that aggregates and disaggregates products between suppliers and buyers and/or is a collection or delivery point for customers.
An Enterprise can:
- Provide an offer to buyers i.e. make products available under certain conditions
- Take on one or more different roles e.g. a Producer can also be a Distributor (e.g. aggregating produce from other farmers for transport)
- Operate at any scale - for example Hubs / Distributors can range from regional Food Hub (providing as many concurrent order cycles as they like) to retail fronts, farmers' markets or ephemeral hubs such as childcare centre, school or front verandah
- Hubs can easily coordinate distribution to other Hubs (i.e. if a Hub coordinates distribution to a range of collection or delivery points e.g. workplaces, schools etc)
- [Not yet built] Purchase food from other Enterprises and move it into inventory for reselling, with the product history carried through and visible to later Buyers
Order Cycles are a key organising principle. Any Enterprise can coordinate an Order Cycle, which means:
- Set date and time that orders will open and close
- Select producers and products to make available in that order cycle
- Select one or more outgoing Distributors / Hubs (that determine the options customers have for collecting or getting their orders delivered)
- Add fees or mark-ups for different parts of the supply chain e.g. admin, sales, packing and transport. Fees can be added for any Enterprise in the order cycle.
- NB. Even within the same order cycle, different Hubs may have different products available (for example if they are aggregating orders from a central food hub as well as some very local farmers)
Usage notes:
- A Hub / Distributor can have separate and concurrent order cycles e.g. for different collection and delivery dates or dealing with different classes of products (e.g. bulk dry goods, fresh produce etc)
- An order cycle can be available through one or more Hubs (e.g. buyers can choose their Hub for collection or delivery)
- MULTI-TENANCY - each Hub (and Producer) is running its own show. They have their own fees, payment methods and shipping methods so that they can customise what they are offering their customers.
The product and variant system is mostly unchanged from the Spree standard. The only significant difference is that every product must be associated with a Producer. We have also made some changes to the administration interface for more efficient management of products and variants e.g. Products / Bulk Product Edit.
Variants enable the same product to be easily organised by size of package, quantity, quality, colour etc. This means that the same product (e.g. olive oil from Olivia Green) can be easily sold in different size bottles at different prices.
General reports have been created that enable management of food enterprises within this model. They can be viewed on screen or exported as a csv file. These include:
- Orders and Distributors - general read out of order information, including customer details, products and distributors. Can be filtered in excel to do almost anything you want
- Orders & Fulfillment Reports - Totals for a given date range of
- Suppliers, Products
- Suppliers - Totals for each Product to each Distributor
- Distributors - Totals of Each Product from each Supplier
- Customers - Items in Order, sorted by Distributor