Documentation
Products
MANAGING PRODUCTSDocument Revision: v1.0
OVERVIEW
Products are the items customers browse and purchase on the storefront. Each
product has a name and optional description (one set per store language), a
model, price, tax settings, inventory details, physical dimensions, and a
range of optional relationships such as manufacturer, categories, filters,
downloads, related products, colors, custom fields, attributes, options,
discounts, specials, reward points, images, and layout overrides. The Product
form is organised into tabs so that related fields can be managed together.
REQUIRED PERMISSION
The signed-in admin user must have modify permission on catalog/product.
ADD/CREATE NEW: STEP-BY-STEP
1. Go to Catalog > Products.
2. Click the Insert button (top right).
3. On the General tab, for each enabled store language:
a. Enter the Product Name (required, 1 to 255 characters).
b. Optionally enter Meta Tag Description, Meta Tag Keywords, and Tag.
c. Optionally enter a Description (rich-text editor).
4. Open the Data tab and complete the main fields:
a. Model: enter a unique product model/code (required, 1 to 64
characters).
b. Image / Label: click Browse to open the File Manager and select an
image (allowed formats: JPG, JPEG, PNG, GIF). Label is typically a
secondary badge/overlay image.
c. Video Code: optionally enter a video embed reference.
d. Keyword: enter an SEO-friendly URL keyword (no spaces; use hyphens).
e. Price: enter the base price. A Local Tax Rate can be selected, which
is used to calculate and display the inclusive price alongside the
exclusive price.
f. Cost: optionally enter the internal cost price (not shown to
customers).
g. Tax Class: select the tax class used for storefront tax calculation.
h. Quote / Age Minimum: optional flags used by specific storefront
features.
i. Date Available: the date from which the product becomes purchasable
(defaults to yesterday for new products).
j. Sort Order: a number controlling list ordering (default: 1).
k. Status: choose Enabled (default) or Disabled.
5. Still on the Data tab, complete the Inventory section:
a. Quantity / Minimum: stock on hand and the minimum order quantity.
b. Subtract: whether stock is deducted from Quantity as orders are
placed.
c. Stock Status: the status shown once Quantity reaches zero (uses the
store default unless overridden).
d. Shipping: whether the product requires shipping.
e. Store Location: optionally select one or more locations.
f. SKU, UPC, EAN, JAN, ISBN, MPN, Location: optional identifier fields.
6. Complete the Dimension section: Length, Width, Height and Length Class,
plus Weight and Weight Class.
7. Open the Links tab and assign, as needed: Manufacturer, Stores (Default is
pre-selected), Categories, Filters, Downloads, and Related Products
(autocomplete is available for each).
8. Open the Colors tab to assign a Palette and specific product Colors, the
Fields tab to assign custom Fields, and the Attribute / Option tabs to
configure product attributes and purchasable options, if applicable.
9. Open the Discount / Special / Reward tabs to configure quantity-based
discounts, timed special pricing, and reward points, if applicable.
10. Open the Image tab to add additional product gallery images, each with
an optional palette color association and sort order.
11. Optionally open the Design tab and choose a Layout Override per store.
Leave as None to use the default storefront layout.
12. Save the product using one of these buttons:
- Save Saves the product and returns to the product list.
- Apply Saves the product and re-opens the updated form to continue.
- Cancel Discards changes and returns to the list.
EXAMPLE: CREATE A NEW PRODUCT — "Wireless Mouse"
Goal: add a simple, enabled product with basic pricing and stock.
General tab (English):
Product Name: Wireless Mouse
Meta Tag Description: Compact wireless mouse with USB receiver.
Description: (optional rich-text overview of the product)
Data tab:
Model: WM-1001
Image: (select via File Manager)
Keyword: wireless-mouse
Price: 19.99
Tax Class: Taxable Goods
Date Available: (today's date)
Sort Order: 1
Status: Enabled
Quantity: 50
Minimum: 1
Subtract: Yes
Stock Status: (store default)
Shipping: Yes
Links tab:
Manufacturer: (optional)
Stores: Default (checked)
Categories: Electronics > Accessories
Steps:
1. Catalog > Products > Insert
2. General tab > English: enter "Wireless Mouse" and optional SEO/
description fields
3. Data tab: enter Model "WM-1001", select an Image, set Keyword
"wireless-mouse", Price 19.99, Tax Class, Date Available, Sort
Order = 1, Status = Enabled, and Quantity = 50
4. Links tab: assign Category "Electronics > Accessories"
5. Click Save
Result: the list shows "Wireless Mouse" with its model, price, and quantity.
The product is now available for storefront display, subject to Status and
Date Available.
EDIT: STEP-BY-STEP
1. Go to Catalog > Products.
2. Locate the product (use the Name, Model, Price, Quantity, or Status
filters as needed).
3. Click Edit in the Action column for that product.
4. Update fields on any tab as needed — General, Data, Links, Colors,
Fields, Attribute, Option, Discount, Special, Reward, Image, or Design.
5. Click Save, Apply, or Cancel as when creating.
EXAMPLE: EDIT THE PRODUCT "Wireless Mouse"
Goal: adjust the price, update stock quantity, and disable the product
temporarily while restocking.
1. Catalog > Products
2. Filter by Name "Wireless Mouse" > Edit
3. Data tab:
Price: 17.99
Quantity: 0
Status: Disabled
4. Click Save
Result: the list reflects the updated price, quantity, and status. While
Disabled, the product will not normally appear on the storefront regardless
of stock, depending on theme settings.
COPY: STEP-BY-STEP
1. Go to Catalog > Products.
2. Check the box(es) next to the product or products to copy.
3. Click the Copy button.
4. Confirm the dialog when prompted.
5. If the copy succeeds, a success message is shown and the list refreshes
with the duplicated product(s) appended.
EXAMPLE: COPY THE PRODUCT "Wireless Mouse"
Goal: create a duplicate of an existing product as a starting point for a
similar variant.
1. Catalog > Products
2. Check the box for "Wireless Mouse"
3. Click Copy > Confirm
Result: a new product is created with the same data as "Wireless Mouse"
(model, price, options, images, etc.), which can then be edited — for
example, to rename it and update its Model and SEO Keyword before enabling it.
DELETE: STEP-BY-STEP
1. Go to Catalog > Products.
2. Check the box(es) next to the product or products to delete.
(Use the header checkbox to select all products on the current page.)
3. Click the Delete button.
4. Confirm the dialog when prompted ("Delete/Uninstall cannot be undone!
Are you sure you want to do this?").
5. If deletion succeeds, a success message is shown and the list refreshes.
EXAMPLE: DELETE A PRODUCT
Goal: remove a discontinued test product, "Wireless Mouse (Copy)".
1. Catalog > Products
2. Filter by Name "Wireless Mouse (Copy)"
3. Check the box for the product
4. Click Delete > Confirm
Result: the product and its related descriptions, options, images, links to
categories/filters/downloads/related products, discounts, specials, and
rewards are removed from the database.
QUICK ENABLE / DISABLE
From the product list, one or more products can be enabled or disabled
without opening the form:
1. Check the box(es) next to the desired product(s).
2. Click Enable or Disable (top of the list).
This updates the Status field directly and is a faster alternative to
editing each product individually when only the Status needs to change.