Module walkthrough

Created by Vidar Langberget

The e-commerce module has a lot of functionality, so to get an overview of what it contains, we'll briefly go through each of the tabs in the module, before going deeper into the more hardcore parts of the system.

Shop dashboard

The dashboard is the starting tab for most users. It contains various information to give users a quick update on recent activity in the shop. The dashboard might not look exactly like the one pictured above, as it can be customized to suit each shops needs. Which boxes appear on the dashboard is controlled in the shop settings.

Orders

The Orders tab is one of the most used tabs, as all orders are normally handled here. The most common action here is to change the order status of orders to "Shipped" as the products in the orders are packed and sent to the shipping company.

Orders can also be exported to Excel, or manually edited if there are any changes.

Product categories

The product categories tab contains a tree structure of the product categories of the selected shop. A product category has a relation to the products in the category.

Products

The products tab lists all the products in the shop. A product in the shop has to be of a type of ProductBase, or a content class that inherits from ProductBase. If you double-click a product, a dialogue window will open, where you can edit the product in question.

The listing also shows if the product has any variants, the base price ex vat and how many there are in stock. 

The button rows at the bottom contains functionality to add, edit, delete and copy products, as well as import and export products from Excel.

Brands

The brands tab contains a list of all the brands that are used in the shop.

If you double click a brand, a dialogue window where you can edit the brand is displayed. A brand has a relation to it's products, their website url and a logo. If you require any additional properties, you can create a new contant class that inherits from it, and add the properties you require.

Discounts

The system has an extensible discount system. The system ships with a number of built-in discount types, but you can also create your own discount types. The discounts in the system is diplayed in the list in this tab. There is a column called "Running" that shows if a discount is currently active. 

The discounts inherit from DiscountBase. For more information on how to add custom discount types, see the "Extending the module functionality" page.

Payment methods

This tab is where you define the different payment methods you want to offer to your customers. There are two main types of payment methods, regular and credit card payment methods. CreditCardPayment methods are more complex, and involve a third party service, normally with a redirect to their payment solution, but the system supports any type of 3rd party service.

The system ships with a limited number of payment methods, but you can add your own, by implementing our payment provider interface for your payment method of choice.

Shipping methods

This is where you define the shipping methods you want to offer to your customers. The system ships with a few different shipping methods out of the box, but you can easily create your own shipping methods as wel. 

Customers

This contains a list of users that have ordered from the shop.

Settings

The settings tab contains a range of settings for the shop. Ranging from the currency you want to use, to the content of the email notifications that get sent when an order is shipped.