Products Module Overview¶

Products module is a place for the creation and management of products you want to sell in your online store. In case your e-shop is multilingual, you can create your products directly in all languages you want (no special translations settings needed).

In this module you set up products, categories, manufacturers, brands, stocks and other settings.

Products¶

Products is the main application for creating and management of products you want to sell in your online store.

Category Tree¶

Category Tree unites similar products into hierarchical categories. This structure can be used in combination with the Navigation function to create a clickable menu for your online store.

Products from your product catalog should be assigned to every created category. Particular categories (and their content - concrete products) are displayed in the Product Catalog Component Page.

Product Groups¶

Product Groups allows you to create groups of products you sell. These groups are important for use with the Custom Properties, because you define them for the whole group. Custom properties are specifications of products. Typically it can be a type of certification, color or an expiration date. The only way how to add a product to the group is in the settings of the product.

Product Variants¶

Product Variants defines particular values (such as colors, certification or sizes) that you can assign to a product in the Custom Properties tab. Product variants are used in connection with product groups. You add product variant to the group in which there are products for which you want to use the values from the product variant. Product variants also serves for defining the variant of a Master Products that will be used as the main axis.

Manufacturers¶

Manufacturers application is used for management and storage for all manufacturers which produce the products you sell on your online store. Manufacturers can be used in the product catalog component for filtering in your product catalog.

To add a new manufacturer, click the New button

General Tab¶

Name - this name can be displayed to visitors on your website.
Name in URL - this name will be used in the URL address of the manufacturer detail. The URL may contain “.”.
Internal Name - this name serves only for internal purposes and is never visible to customers. It has to be unique within this application.
Logo (optional) is used to add the logo of this manufacturer. You need to upload this image file to your File Manager first. After that you are able to select it here. A logo can be also displayed to customers on your webpage.
Availability - (optional) is used to define a default availability state for all products connected to this manufacturer.
Small Image - (optional) is a small image from your File Manager that can be displayed on your website.
Big Image - (optional) is another image from your File Manager that can be displayed on your website.
Active - defines the current activity of the manufacturer. Inactive manufacturer acts (from the customer’s perspective) like it don’t exist. A disabled manufacturer is never displayed to customers and is not included in any generated navigation or used for other settings. In case a customer accesses it via URL address, a 404 error page will be displayed instead.
Include in Navigation - disabling navigation will remove this manufacturer from navigations, but it remains accessible via its URL address.
Products Sort (optional) - this setting allows you to define the default product sorting for this manufacturer. It will be used in preference to the Product Catalog Component settings. You can select as many sorting methods as you need together with the default direction (ascending or descending).

Note

To display the value of the Name field in your Product Catalog Component, insert this piece of code “{{ component.product.manufacturer.name }}” directly in your products (probably the Product Detail View).

Description Tab¶

On this tab can be inserted the short and long descriptions. You can display it in particular manufacturer detail.

SEO Tab¶

On the SEO tab can be defined all SEO information - title, description and keywords.

Products¶

On the Products tab are displayed all products which belongs to this manufacturer (a manufacturer is defined in a product detail on the General tab).

To add new products to this manufacurer go to the Products tab. A new window will appear and you can add product to the right side and click the Add button. Remember that only products without defined manufacturer are displayed in this dialog.

Custom Properties¶

On the Custom Properties tab can be defined custom properties that you can set for every manufacturer from your account (properties defined in a single manufacturer detail are shared among all manufacturers from your account).

For more info please visit the Custom Properties documentation for products. Notice that there is no Filterable settings and Master Property for manufacturers.

Import Manufacturers¶

In the toolbar is the Import button which allows you to upload a XLS or XLSX file with manufacturers.

Following columns are available:

Column Name (Excel)	Filed Name (Application)	Short Description
sysid	Internal Name	Tthe internal name of the manufacturer, required.
name:en	Name	The name of the manufacturer which can be displayed on the website.
nameUrl:en	Name in URL	The last part of the URL detail.
web	Web	The manufacturer’s website.
logo	Logo	Defines a path to an image that will be used as the logo for the manufacturer.
availability:en	Availability	Defines the default manufacturer availability (text string).
active	Active	A boolean value which defines the current manufacturer activity.
includeInNavigation	Include in Navigation	A boolean value which defines if the manufacturer will be displayed in the navigation.
shortDescription:en	Short Description	The short description of the manufacturer.
description:en	Description	The long description of the manufacturer.
seoTitle:en	SEO Title	The SEO title for this manufacturer.
seoDescription:en	SEO Description	The SEO description for this manufacturer.
seoKeywords:en	SEO Keywords	The SEO keywords of this manufacturer.
seoTitleSource	SEO Title Source	Defines from where will be taken the SEO title source (default, specific, none).
seoDescriptionSource	SEO Description Source	Defines from where will be taken the SEO description source (default, specific, none).

Display Manufacturers¶

Manufacturers are displayed through the product component, product list view (/manufacturer/name-in-url).

Use following parameters to work with manufacturers in the product catalog component (product list view):

component.manufacturer - the manufacturer defined in the URL address
component.currentEntity - the current product list object

Brands¶

Brands application is used for management and storage for brands whose products you sell on your online store.

A brand unites all products from one brand. You can work with it in the website code (display it in the product detail or display all product connected to a particular brand).

To add a new brand, click the New button.

General Tab¶

Name - this name can be displayed to visitors on your website.
Internal Name - this name serves only for internal purposes and is never visible to customers. It has to be unique within this application.
Name in URL - this name will be used in the URL address of the brand detail. The URL may contain “.”.
Logo - (optional) is used to add the logo of this brand. You need to upload this image file to your File Manager first. After that you are able to select it here. A logo can be also displayed to customers on the product detail page. To display the value of the Name field in your Product Catalog Component, insert this piece of code “{{ component.product.brand.name }}” directly in your products (probably the Product Detail View).
Availability - (optional) is a translated text field you connect to this brand. It can be displayed on the website (on the particular product detail for example). It is mostly used to define information about the availability for products of this brand but feel free to use it according to your needs. This information is available as a part of the information about a particular product (component.product.brand.availability in the Product Component or ecommerce.products.get(‘product-code’).brands.availability).
Small Image - (optional) is a small image from your File Manager that can be displayed on your website.
Big Image - (optional) is another image from your File Manager that can be displayed on your website.
Active - defines the current activity of the brand. Inactive brand acts (from the customer’s perspective) like it don’t exist. A disabled brand is never displayed to customers and is not included in any generated navigation or used for other settings. In case a customer accesses it via URL address, a 404 error page will be displayed instead.
Include in Navigation - disabling navigation will remove this brand from navigations, but it remains accessible via its URL address.
Products Sort (optional) - this setting allows you to define the default product sorting for this brand. It will be used in preference to the Product Catalog Component settings. You can select as many sorting methods as you need together with the default direction (ascending or descending).

In case you want to display all Brands connected to your online catalog, you can use the ecommerce.brands parameter. Brands can be used in the product catalog component for filtering in your product catalog.

Description Tab¶

On this tab can be inserted the short and long descriptions. You can display it in particular brand detail.

SEO Tab¶

On the SEO tab can be defined all SEO information - title, description and keywords.

Products¶

On the Products tab are displayed all products which belongs to this brand (a brand is defined in a product detail on the General tab).

To add new products to this brand go to the Products tab. A new window will appear and you can add product to the right side and click the Add button. Remember that only products without defined brand are displayed in this dialog.

Custom Properties¶

On the Custom Properties tab can be defined custom properties that you can set for every brand from your account (properties defined in a single brand detail are shared among all brands from your account).

For more info please visit the Custom Properties documentation for products. Notice that there is no Filterable setting and Master Property for brands.

Import Brands¶

In the toolbar is the Import button which allows you to upload a XLS or XLSX file with brands.

Following columns are available:

Column Name (Excel)	Filed Name (Application)	Short Description
sysid	Internal Name	Tthe internal name of the brand, required.
name:en	Name	The name of the brand which can be displayed on the website.
nameUrl:en	Name in URL	The last part of the URL detail.
web	Web	The brand’s website.
logo	Logo	Defines a path to an image that will be used as the logo for the brand.
availability:en	Availability	Defines the default brand availability (text string).
active	Active	A boolean value which defines the current brand activity.
includeInNavigation	Include in Navigation	A boolean value which defines if the brand will be displayed in the navigation.
shortDescription:en	Short Description	The short description of the brand.
description:en	Description	The long description of the brand.
seoTitle:en	SEO Title	The SEO title for this brand.
seoDescription:en	SEO Description	The SEO description for this brand.
seoKeywords:en	SEO Keywords	The SEO keywords of this brand.
seoTitleSource	SEO Title Source	Defines from where will be taken the SEO title source (default, specific, none).
seoDescriptionSource	SEO Description Source	Defines from where will be taken the SEO description source (default, specific, none).

Display Brands¶

Brands are displayed through the product component, product list view (/brand/name-in-url).

Use following parameters to work with brands in the product catalog component (product list view):

component.brands - the brand defined in the URL address
component.currentEntity - the current product list object

Link example:

<a href="{{ getViewLink( 'katalog:brand', {'manufacturer': brand.sysid } ) }}">{{ brand.name }}</a>

Extra Entities¶

Extra Entities application in the Products module is available only for accounts with the Extra Entities addon available.

Extra entities are special entities with multiple linkage to a product. Unlike brands, manufacturers or product variants, a product can have assigned ad many extra entities as you need. A typical example is an author (one book can have many authors).

To add a new extra entity, click the New button.

General Tab¶

Name - this name can be displayed to visitors on your website.
Internal Name - this name serves only for internal purposes and is never visible to customers. It has to be unique within this application.
Name in URL - this name will be used in the URL address of the extra entity detail. The URL may contain “.”.
Small Image - (optional) is a small image from your File Manager that can be displayed on your website.
Big Image - (optional) is another image from your File Manager that can be displayed on your website.
Active - defines the current activity of the extra entity. Inactive entity acts (from the customer’s perspective) like it don’t exist. A disabled entity is never displayed to customers and is not included in any generated navigation or used for other settings. In case a customer accesses it via URL address, a 404 error page will be displayed instead.
Include in Navigation - disabling navigation will remove this extra entity from navigations, but it remains accessible via its URL address.

Description Tab¶

On this tab can be inserted the short and long descriptions. You can display it in particular extra entity detail (on the website).

SEO Tab¶

On the SEO tab can be defined all SEO information - title, description and keywords.

Custom Properties¶

On the Custom Properties tab can be defined custom properties that you can set for every extra entity from your account (properties defined in a single entity detail are shared among all extra entities from your account).

For more info please visit the Custom Properties documentation for products. Notice that there is no Master Property for extra entities.

Import and Export of Extra Entities¶

Extra entities can be exported from the application. Click the Export button in the toolbar and select the file type, languages and export range.

You can also import extra entities using information from the table below.

Column Name (Excel)	Filed Name (Application)	Short Description
internalName	Internal Name	Tthe internal name of the external entity, required.
name:en	Name	The name of the external entity which can be displayed on the website.
nameUrl:en	Name in URL	The last part of the URL detail.
active	Active	A boolean value which defines the current entity activity.
includeInNavigation	Include in Navigation	A boolean value which defines if the entity will be displayed in the navigation.
smallImage	Small Image	The path to the small image in the file manager.
bigImage	Big Image	The path to the big image in the file manager.
smallImageSourceSysid	Small Image Source	The internal name of the image source in which is the small image stored.
smallImageSourcePath	Small Image Path in Source	The path to the small image in the external source.
bigImageSourceSysid	Big Image Source	The internal name of the image source in which is the big image stored.
bigImageSourcePath	Big Image Path in Source	The path to the big image in the external source.
shortDescription:cs	Short Description	The short description of the extra entity.
longDescription:en	Description	The (long) description of the extra entity.
seoTitle:en	SEO Title	The SEO title for this extra entity.
seoDescription:en	SEO Description	The SEO description for this extra entity.
seoKeywords:en	SEO Keywords	The SEO keywords of this extra entity.
seoTitleSource	SEO Title Source	Defines from where will be taken the SEO title source (default, specific, none).
seoDescriptionSource	SEO Description Source	Defines from where will be taken the SEO description source (default, specific, none).
custom:internal-name	Particular Custom Property	The value of a particular custom property (custom property is defined by its internal name).

Display Extra Entities¶

Extra entities are displayed through the product component, product list view (/extra/name-in-url).

Use following parameters to work with extra entities in the product catalog component (product list view):

component.extraEntity - the extra entity defined in the URL address (see the Extra Entity object data structure).
component.currentEntity - the current product list object.
component.extraEntities - list of all extra entities which are available in the template.

An Extra Entity is also used as the SEO source.

Stocks¶

Stocks application in the Products module is used to manage particular stock you use in your online stores. You can have as many stocks as you need. Every stock (record) in this application represents one real warehouse. Within this stock you can define various locations within this warehouse. It helps you manage the stock supply because you can specify where it is stored.

You can add new stock in this application only if Stock Service exists in your account. Stock Services are created in the Administration module in the Stock Services application. Here, a stock service must be created according to its type. For more information visit the manual for stock services.

Receipts¶

Receipts application is used for creation and management of receipts - this is the only way how you can manually add product to your Stock.

This application is not available for all account automatically, you need to have the Inhouse Stock Management addon allowed on your account.

For more information please visit the Receipts help-site.

Issues¶

Issues application is located in the Products module. It is used to create Issues - documents that allows you to write off products from your Stock. It is the inverse of the receipt.

This application is not available for all account automatically, you need to have the Inhouse Stock Management addon allowed on your account.

For more information plese visit the Issues help-site

Transfers¶

Transfers is application located in the Products module. It is used to ship items from one Stock to another. The products will be issued at first and then will be received to another Stock. Transfer is an issue and a receipt in one.

This application is not available for all account automatically, you need to have the Inhouse Stock Management addon allowed on your account.

For more information please visit the Transfers help-site

Scheduled Deliveries¶

Scheduled Deliveries application is located in the Products module and is used to plan and manage future deliveries of goods into your stock. It can be used for both your sources management and for your customers, because you will be able to display the date of future delivery on your website in the particular product’s detail. Customer can then see when the product they want to buy will be in stock again.

This application works only with the Inhouse BizBox Stock Services.

For more information about Scheduled Deliveries please visit the stocks help-site.

Suppliers¶

The Suppliers application is used to manage your suppliers (manufacturer, contractor or distributor) - legal entities and natural persons which are connected to your Stocks (they supply the products) and products.

This application is not available for all account automatically, you need to have the Inhouse Stock Management addon allowed on your account.

For more information please visit the Suppliers help-site.

Customer Alerts¶

This application allows you to add and manage particular customer alerts.

Customer alert is a request from a customer who wants to receive an information about particular product stock availability. If a product is out of stock, customers can insert their e-mail address. The e-mail will be send automatically to the provided e-mail address when the products your customers are interested in become available (buyable) on the website.

You can also define the minimum number of products that must be available on the website in order to send the notification. This setting is available in the E-shop Settings on the Advanced tab (Minimum Stock Quantity setting).

To make this feature work, you need:

the Customer Alerts addon enabled for your account;
the Customer Alerts form in the product detail;
the Customer Stock Alert e-mail;
to set up the e-mail sending in the E-shop Settings.

Most of the customer alerts is created on the website (a customer fills in the Customer Alerts form). All alerts are available in the Customer Alerts application (located in the Products module). In this application, the customer’s e-mail address, particular product, e-shop, language and send date are available. The send date will be filled in after the alert is sent.

Note

If a customer requests more product alerts and these products will be received at once, only one e-mail will be sent.

Customer alerts can be created manually directly in the Customer Alerts application. Click the New button in the toolbar and fill in all fields:

E-mail - e-mail to which the alert will be send.

Product - select particular product from your product catalog. When it become available on the e-shop selected below, the alert will be send to the address defined above.

E-shop - select e-shop settings for which has to be the product selected above available.

Culture - select the culture (language) of the customer alert e-mail.

Note

Customer alert e-mails are send once per hour.

Product Reviews¶

In this application are all product reviews available. Product reviews are created on the website by your customers (registered users) or in administration. If you create a rating in the administration, you must select the existing contact that rated the product or you can add a new review as the BizBox administrator.

Customers are able to add a review only in case they are signed in and have already bought the product (the order which contains it has been paid). You can add ratings from the administration regardless of an existing order.

Tip

You can set up a notification that alerts you to each new rating by e-mail.

All reviews harvested from the website are available in this application. You can perform following actions here:

Edit an existing review by double-click or the Edit button in the toolbar. Reviews can be checked (approved/reviewed) by administrators. You are also able to assign loyalty points to the customer.
Delete an review by clicking the Delete button in the toolbar.
Add a commentary on the second tab.

Review Creation and Edition¶

When creating a new review, you have to insert:

Product - find the product for which you want to add the rating.
User - search for an existing contact from the Contacts application. Each product rating must be associated with a contact.
Create ad Administrator - if you don’t want to place a review as a user, you can place it as the BizBox administrator.

General tab In a review detail on the General tab, the base info about the review is displayed:

Reviewed Product name
Customer, who reviewed it (a registered user who has bought this product)
Verified Purchase – If the user has purchased the product, it is automatically set to YES. Otherwise (if the customer rates on the website without having to buy the product) it is set to NO.
Public setting which defines if the review can be displayed on the product detail
Reviewed info means, that the review has been checked by an administrator (a BizBox user)
Reviewed By defines a BizBox user who checked this review
Reviewed Date is the date when has been this review checked by BizBox administrator
Loyalty Points allows you to assign loyalty points to the user who created this review (this is usable only if you have an active loyalty points program in your account)

In the Review section, the review itself is displayed - its title, rating, recommending, text, pros and cons. All these info has been entered by a customer through the form on a product detail.

Other website visitors can make votes for product reviews. These votes are available under the review info.

Comments tab¶

On the Comments tab is the review and all comments assigned to it displayed (together with authors and comments’ vote count). Other website visitors can post a comment for existing review (according to your website template).

You (as a BizBox user) can post a comment (reply) directly from the Comment tab. Mark an existing comment and click the Reply button in the toolbar.

For every author, an icon used to indicate the author’s role is displayed - admin, registered user and anonymous user.

Send an e-mail response to a comment¶

If you add a comment (response) in the administration, you can send a notification e-mail to the original commenter (author). This will allow the original author to learn about your response to their post.

To make this feature work you need to create an e-mail template and set its settings.

Go to the Templates application (in the Website Editor).
Add a new template. Select the Product Rating Comment E-mail type.
Code and save the template.
Go to the Product Reviews application (Products module) and edit an existing rating.
On the Comments tab, click the E-mail Settings button in the toolbar.
A new window will appear. Click the Add button and set up a new e-mail setting.
Approve the project.

It will now be possible to send notifications to the author. When you add a comment to a review, the Send Email button will be active and you can use it to send the email. It is also possible to send an e-mail immediately after writing the reply (the e-mail will be sent when your response is saved).

Product Discussions¶

In this application are all products’ discussions available. Discussions are created on the website by visitors (registration is not necessary) or directly in the application (you can create a new discussion).

You can perform following actions here:

Create a new discussion.
Edit an existing discussion by double-click or the Edit button in the toolbar.
Delete an discussion by clicking the Delete button in the toolbar.

Discussion Detail¶

When starting a new discussion, you have to select the product for which you want to start the discussion.

General Tab On the general tab, all base info about the fist comment in the discussion is available:

Product to which this discussion belongs
Author and his/her e-mail address (provided in the form on your website)
Title of the discussion
Message (text)
Vote Count (other website visitors can vote for the comment)

You cannot modify these information.

Comments tab On the Comments tab, the main and other comments are displayed. Other comments can be added on the website by website visitors.

Send an e-mail response to a comment¶

To make this feature work you need to create an e-mail template and set its settings.

Go to the Templates application (in the Website Editor).
Add a new template. Select the Product Discussion Comment E-mail type.
Code and save the template.
Go to the Product Discussions application (Products module) and edit an existing rating.
On the Comments tab, click the E-mail Settings button in the toolbar.
A new window will appear. Click the Add button and set up a new e-mail setting.
Approve the project.