Documentation
Product Options
MANAGING PRODUCT OPTIONSDocument Revision: v1.0
OVERVIEW
Product Options define the choices or input fields a customer must complete
before adding a product to the cart — for example, selecting a size or color,
uploading a file, or entering a custom message. Each option has a name (one per
store language), a type, a sort order, and — for choice-based types — one or
more option values that the customer can select from.
Options are created here as reusable definitions. Once created, an option can be
assigned to individual products under the Option tab in the Product form, where
pricing adjustments, quantities, and other product-level settings are applied per
option value.
OPTION TYPES
There are nine option types, grouped by how the customer interacts with them:
Choice-based (require option values to be defined here):
Select Drop-down list of predefined values.
Radio Radio buttons — one selection from a list.
Checkbox Tick boxes — multiple selections allowed.
Image Selectable image swatches with labels.
Input-based (no option values required):
Text Single-line text entry.
Textarea Multi-line text entry.
File File upload field.
Date Date picker.
Time Time picker.
REQUIRED PERMISSION
The signed-in admin user must have modify permission on catalog/option.
ADD/CREATE NEW: STEP-BY-STEP
1. Go to Catalog > Options.
2. Click the Insert button (top right).
3. For each enabled store language, enter the Option Name (required, 1 to 128
characters).
4. Select the option Type from the dropdown.
5. Enter a Sort Order to control the display order when multiple options are
assigned to a product (default: 0).
6. If the type is Select, Radio, Checkbox, or Image, add at least one option
value:
a. Click Add Option Value.
b. For each store language, enter the Option Value Name (required, 1 to 128
characters).
c. Optionally select an Image for the value (used mainly with the Image type)
by clicking Browse to open the File Manager.
d. Enter a Sort Order for this value.
e. Repeat for each additional value.
f. To remove a value row before saving, click Remove on that row.
Input-based types (Text, Textarea, File, Date, Time) do not require option
values and the values table will not appear.
7. Save the option using one of these buttons:
- Save Saves the option and returns to the option list.
- Apply Saves the option and re-opens the updated form to continue.
- Cancel Discards changes and returns to the list.
EXAMPLE 1: CREATE A CHOICE-BASED OPTION — "Size" (Select)
Goal: create a drop-down size selector with three values.
Option Name (English): Size
Type: Select
Sort Order: 1
Option Values:
Value 1: Small | Sort Order: 1
Value 2: Medium | Sort Order: 2
Value 3: Large | Sort Order: 3
Steps:
1. Catalog > Options > Insert
2. Enter Option Name: Size
3. Type: Select
4. Sort Order: 1
5. Click Add Option Value — enter "Small", Sort Order 1
6. Click Add Option Value — enter "Medium", Sort Order 2
7. Click Add Option Value — enter "Large", Sort Order 3
8. Click Save
Result: the list shows "Size" with Sort Order 1. The option is now available to
assign to products under Catalog > Products > [product] > Option tab.
EXAMPLE 2: CREATE AN INPUT-BASED OPTION — "Custom Message" (Textarea)
Goal: allow the customer to enter a personalised message at checkout.
Option Name (English): Custom Message
Type: Textarea
Sort Order: 5
Steps:
1. Catalog > Options > Insert
2. Enter Option Name: Custom Message
3. Type: Textarea
4. Sort Order: 5
5. Click Save (no option values are needed for input-based types)
Result: the list shows "Custom Message". When assigned to a product, a
multi-line text field is displayed to the customer on the product page.
EDIT: STEP-BY-STEP
1. Go to Catalog > Options.
2. Locate the option and click Edit in the Action column.
3. Update the Option Name, Type, Sort Order, and/or option values as needed:
- To rename a value, update its name inline.
- To add a new value, click Add Option Value.
- To remove a value, click Remove on that row.
Note: changing the Type of an existing option (for example from Select to
Text) will remove any option values on save, as input-based types do not
use them.
4. Click Save, Apply, or Cancel.
EXAMPLE: EDIT THE "Size" OPTION
Goal: add an extra size "Extra Large" and update the option sort order.
1. Catalog > Options > Edit on "Size"
2. Sort Order: change to 2
3. Click Add Option Value
4. Enter "Extra Large", Sort Order 4
5. Click Save
Result: the Size option now has four values. Any products already using the
Size option will have the new value available to assign in the product form.
DELETE: STEP-BY-STEP
1. Go to Catalog > Options.
2. Check the box(es) next to the option(s) to delete.
3. Click the Delete button.
4. Confirm the dialog when prompted.
5. If deletion succeeds, a success message is shown and the list refreshes.
Important: an option cannot be deleted if it is currently assigned to one or
more products. Remove the option from all products first, then delete it here.
EXAMPLE: DELETE AN OPTION
Goal: remove the unused "Custom Message" option.
1. Catalog > Options
2. Check the box for "Custom Message"
3. Click Delete > Confirm
Result: the option and all of its values and descriptions are removed from the
database. If the option is still assigned to any products, deletion will be
blocked and an error message shown indicating how many products are affected.
USING OPTIONS ON PRODUCTS
After an option exists:
1. Open Catalog > Products and edit or create a product.
2. Open the Option tab.
3. Begin typing the option name in the search field and select it from the
suggestions.
4. Set whether the option is Required, then configure per-value settings such
as price adjustment, quantity, and stock subtraction.
5. Save the product.
Options are shared definitions; renaming an option or its values here affects
every product that uses it on the next page load.