---
title: "Field Types"
description: "J2Commerce provides 44 custom Joomla form field types that extend Joomla's form system. These fields handle everything from entity lookups and product pricing to image uploading and SEF router…"
url: "https://docs.j2commerce.com/developer/fields"
markdown_url: "https://docs.j2commerce.com/developer/fields.md"
last_updated: "2026-10-23T03:10:50+00:00"
version: "Developer"
breadcrumbs:
  - title: "Home"
    url: "https://docs.j2commerce.com/"
  - title: "Developer"
    url: "https://docs.j2commerce.com/developer"
  - title: "Field Types"
    url: "https://docs.j2commerce.com/developer/fields"
---

# Field Types

J2Commerce provides 44 custom Joomla form field types that extend Joomla's form system. These fields handle everything from entity lookups and product pricing to image uploading and SEF router configuration. Third-party plugins, modules, and extensions can use any of these fields in their XML forms.

## Using J2Commerce Fields

All fields live in the `J2Commerce\Component\J2commerce\Administrator\Field` namespace. Declare `addfieldprefix` on your form XML:

```html
<form addfieldprefix="J2Commerce\Component\J2commerce\Administrator\Field">
    <fieldset name="basic">
        <field name="country_id" type="Country" label="Country" />
        <field name="zone_id" type="Zone" label="Zone" country_field="country_id" />
    </fieldset>
</form>
```

For plugin manifests:

```html
<config>
    <fields name="params" addfieldprefix="J2Commerce\Component\J2commerce\Administrator\Field">
        <field name="tax_profile" type="Taxprofile" label="Tax Profile" />
    </fields>
</config>
```

Modal fields use a sub-namespace and require a separate prefix:

```html
<field name="product_id" type="Modal_Product"
    addfieldprefix="J2Commerce\Component\J2commerce\Administrator\Field\Modal" />
```

---

## Entity Lookup Fields

Dropdown fields populated from J2Commerce database tables. All extend `ListField`.

| Field Type | Class | Table | Stored Value |
| --- | --- | --- | --- |
| [`Country`](https://docs.j2commerce.com/index.php?option=com_content&view=article&id=143&catid=43) | `CountryField` | `#__j2commerce_countries` | `j2commerce_country_id` (int) |
| [`Zone`](https://docs.j2commerce.com/index.php?option=com_content&view=article&id=182&catid=43) | `ZoneField` | `#__j2commerce_zones` | `j2commerce_zone_id` (int) |
| [`GeoZone`](https://docs.j2commerce.com/index.php?option=com_content&view=article&id=148&catid=43) | `GeoZoneField` | `#__j2commerce_geozones` | `j2commerce_geozone_id` (int) |
| [`Currencies`](https://docs.j2commerce.com/index.php?option=com_content&view=article&id=145&catid=43) | `CurrenciesField` | `#__j2commerce_currencies` | `currency_code` (string) |
| [`OrderStatus`](https://docs.j2commerce.com/index.php?option=com_content&view=article&id=158&catid=43) | `OrderStatusField` | `#__j2commerce_orderstatuses` | `j2commerce_orderstatus_id` (int) |
| [`Orderstatustype`](https://docs.j2commerce.com/index.php?option=com_content&view=article&id=159&catid=43) | `OrderstatustypeField` | `#__j2commerce_orderstatuses` | `orderstatus_type` (string) |
| [`Taxprofile`](https://docs.j2commerce.com/index.php?option=com_content&view=article&id=173&catid=43) | `TaxprofileField` | `#__j2commerce_taxprofiles` | `j2commerce_taxprofile_id` (int) |
| [`TaxRate`](https://docs.j2commerce.com/index.php?option=com_content&view=article&id=174&catid=43) | `TaxRateField` | `#__j2commerce_taxrates` | `j2commerce_taxrate_id` (int) |
| [`Manufacturers`](https://docs.j2commerce.com/index.php?option=com_content&view=article&id=154&catid=43) | `ManufacturersField` | `#__j2commerce_manufacturers` | `j2commerce_manufacturer_id` (int) |
| [`Vendors`](https://docs.j2commerce.com/index.php?option=com_content&view=article&id=180&catid=43) | `VendorsField` | `#__j2commerce_vendors` | `j2commerce_vendor_id` (int) |
| [`Length`](https://docs.j2commerce.com/index.php?option=com_content&view=article&id=152&catid=43) | `LengthField` | `#__j2commerce_lengths` | `j2commerce_length_id` (int) |
| [`Weight`](https://docs.j2commerce.com/index.php?option=com_content&view=article&id=181&catid=43) | `WeightField` | `#__j2commerce_weights` | `j2commerce_weight_id` (int) |
| [`StoreProfile`](https://docs.j2commerce.com/index.php?option=com_content&view=article&id=171&catid=43) | `StoreProfileField` | `#__j2commerce_storeprofiles` | `j2commerce_storeprofile_id` (int) |
| [`ManufacturerCountry`](https://docs.j2commerce.com/index.php?option=com_content&view=article&id=153&catid=43) | `ManufacturerCountryField` | `#__j2commerce_countries` (filtered) | `j2commerce_country_id` (int) |
| [`VendorCountry`](https://docs.j2commerce.com/index.php?option=com_content&view=article&id=179&catid=43) | `VendorCountryField` | `#__j2commerce_countries` (filtered) | `j2commerce_country_id` (int) |

## Product & Pricing Fields

Fields for product configuration, pricing, and commerce settings.

| Field Type | Class | Purpose |
| --- | --- | --- |
| [`ProductType`](https://docs.j2commerce.com/index.php?option=com_content&view=article&id=164&catid=43) | `ProductTypeField` | Product type selector (simple, configurable, variable, etc.) |
| [`PriceCalculator`](https://docs.j2commerce.com/index.php?option=com_content&view=article&id=162&catid=43) | `PriceCalculatorField` | Pricing calculator strategy selector |
| [`VariantPrice`](https://docs.j2commerce.com/index.php?option=com_content&view=article&id=178&catid=43) | `VariantPriceField` | Currency-prefixed price input for variants |
| [`VariantAdvancedPricing`](https://docs.j2commerce.com/index.php?option=com_content&view=article&id=177&catid=43) | `VariantAdvancedPricingField` | Button to open advanced pricing modal |
| [`Dimensions`](https://docs.j2commerce.com/index.php?option=com_content&view=article&id=146&catid=43) | `DimensionsField` | Three-input group for length/width/height |
| [`PaymentMethods`](https://docs.j2commerce.com/index.php?option=com_content&view=article&id=160&catid=43) | `PaymentMethodsField` | Installed payment plugin selector |
| [`ShippingMethods`](https://docs.j2commerce.com/index.php?option=com_content&view=article&id=170&catid=43) | `ShippingMethodsField` | Installed shipping plugin/method selector |
| [`Invoicetype`](https://docs.j2commerce.com/index.php?option=com_content&view=article&id=150&catid=43) | `InvoicetypeField` | Document type selector (invoice, receipt, packing slip) |

## Modal Picker Fields

Modal-based entity selection fields.

| Field Type | Class | Purpose |
| --- | --- | --- |
| [`Modal_Product`](https://docs.j2commerce.com/index.php?option=com_content&view=article&id=155&catid=43) | `Modal\ProductField` | Single product picker via modal |
| [`Modal_ProductMultiselect`](https://docs.j2commerce.com/index.php?option=com_content&view=article&id=156&catid=43) | `Modal\ProductMultiSelectField` | Multi-product picker via modal |

## Multi-Select & List Fields

Advanced selection fields with dual-panel or checkbox interfaces.

| Field Type | Class | Purpose |
| --- | --- | --- |
| [`Duallistbox`](https://docs.j2commerce.com/index.php?option=com_content&view=article&id=147&catid=43) | `DuallistboxField` | Two-panel multi-select listbox |
| [`CategoryDuallistbox`](https://docs.j2commerce.com/index.php?option=com_content&view=article&id=141&catid=43) | `CategoryDuallistboxField` | Dual listbox pre-loaded with Joomla categories |
| [`PhoneCountries`](https://docs.j2commerce.com/index.php?option=com_content&view=article&id=161&catid=43) | `PhoneCountriesField` | Country checkbox grid with dial codes |

## Template & Layout Fields

Fields for template selection and layout configuration.

| Field Type | Class | Purpose |
| --- | --- | --- |
| [`Subtemplate`](https://docs.j2commerce.com/index.php?option=com_content&view=article&id=172&catid=43) | `SubtemplateField` | Visual card picker for app subtemplates |
| [`Templatelist`](https://docs.j2commerce.com/index.php?option=com_content&view=article&id=176&catid=43) | `TemplatelistField` | Template folder dropdown with plugin event support |
| [`TemplateCustom`](https://docs.j2commerce.com/index.php?option=com_content&view=article&id=175&catid=43) | `TemplateCustomField` | Display-only shortcode reference panel |
| [`Categoryj2commerce`](https://docs.j2commerce.com/index.php?option=com_content&view=article&id=142&catid=43) | `Categoryj2commerceField` | Bootstrap accordion of category settings panels |

## Image & File Fields

Fields for image uploading and directory selection.

| Field Type | Class | Purpose |
| --- | --- | --- |
| [`J2CommerceImage`](https://docs.j2commerce.com/index.php?option=com_content&view=article&id=151&catid=43) | `J2CommerceImageField` | Single image picker with preview |
| [`MultiImageUploader`](https://docs.j2commerce.com/index.php?option=com_content&view=article&id=157&catid=43) | `MultiImageUploaderField` | Uppy-powered drag-and-drop multi-image uploader |
| [`ImageDirectory`](https://docs.j2commerce.com/index.php?option=com_content&view=article&id=149&catid=43) | `ImageDirectoryField` | Folder picker rooted at `images/` |

## Router & Menu Fields

Fields for SEF URL routing configuration.

| Field Type | Class | Purpose |
| --- | --- | --- |
| [`Routertype`](https://docs.j2commerce.com/index.php?option=com_content&view=article&id=169&catid=43) | `RoutertypeField` | Hidden field exposing router type for `showon` conditions |
| [`RouterCategory`](https://docs.j2commerce.com/index.php?option=com_content&view=article&id=167&catid=43) | `RouterCategoryField` | Category field that auto-switches by router mode |
| [`RouterModalCategory`](https://docs.j2commerce.com/index.php?option=com_content&view=article&id=168&catid=43) | `RouterModalCategoryField` | Modal/multi-select category field by router mode |
| [`Productlistmenu`](https://docs.j2commerce.com/index.php?option=com_content&view=article&id=165&catid=43) | `ProductlistmenuField` | Menu item selector for legacy router |

## Display & Utility Fields

Read-only display fields and UI utilities. These fields render information but store no data.

| Field Type | Class | Purpose |
| --- | --- | --- |
| [`Alert`](https://docs.j2commerce.com/index.php?option=com_content&view=article&id=140&catid=43) | `AlertField` | Bootstrap alert box (display only) |
| `Button` | `ButtonField` | Clickable button with onclick handler |
| [`Price`](https://docs.j2commerce.com/index.php?option=com_content&view=article&id=163&catid=43) | `PriceField` | Alert variant for pricing contexts |
| [`Cronlasthit`](https://docs.j2commerce.com/index.php?option=com_content&view=article&id=144&catid=43) | `CronlasthitField` | Cron last execution status display |
| [`Queuekey`](https://docs.j2commerce.com/index.php?option=com_content&view=article&id=166&catid=43) | `QueuekeyField` | Queue key display with AJAX regenerate |

---

## Key Notes

- **CurrenciesField** stores an ISO string (`USD`), not an integer ID — unique among entity fields.
- **ZoneField** supports AJAX country-linking via the `country_field` attribute.
- **ManufacturerCountry/VendorCountry** are filtered variants of `CountryField` — ideal for filter forms.
- **Router fields** work together: `RoutertypeField` drives `showon` conditions for `RouterCategory`, `RouterModalCategory`, and `Productlistmenu`.
- **Display fields** (Alert, Button, Price, Cronlasthit, TemplateCustom) render UI elements but never appear in POST data.

## Pages

- [AlertField](https://docs.j2commerce.com/developer/fields/alert-field.md): Display-only Bootstrap alert box for showing informational headings and descriptions inside J2Commerce admin forms.
- [CategoryDuallistboxField](https://docs.j2commerce.com/developer/fields/category-duallistbox-field.md): Dual listbox field pre-populated with all published Joomla article categories, rendered with hierarchical indentation.
- [Categoryj2commerceField](https://docs.j2commerce.com/developer/fields/categoryj2commerce-field.md): Spacer-derived field that renders a Bootstrap accordion of J2Commerce app settings panels inside the Joomla category edit form.
- [CountryField Field Type](https://docs.j2commerce.com/developer/fields/country-field.md): A Joomla list field that populates a dropdown with all enabled J2Commerce countries from the database.
- [CronlasthitField](https://docs.j2commerce.com/developer/fields/cronlasthit-field.md): Display-only field that reads the cron_last_trigger component parameter and renders the last cron execution date, URL, and IP address.
- [CurrenciesField Field Type](https://docs.j2commerce.com/developer/fields/currencies-field.md): A Joomla list field that populates a dropdown with all enabled J2Commerce currencies, displaying both the currency title and its ISO code.
- [Dimensions Form Field](https://docs.j2commerce.com/developer/fields/dimensions-field.md): Developer reference for the Dimensions custom form field — a composite Bootstrap input-group rendering Length, Width, and Height inputs in a single row.
- [DuallistboxField](https://docs.j2commerce.com/developer/fields/duallistbox-field.md): Multi-select dual listbox field with search, add-all, and remove-all controls backed by the vanilla JavaScript DualListbox library.
- [GeoZoneField Field Type](https://docs.j2commerce.com/developer/fields/geozone-field.md): A Joomla list field that populates a dropdown with all enabled J2Commerce geo-zones, used for tax and shipping rule assignment.
- [ImageDirectoryField](https://docs.j2commerce.com/developer/fields/image-directory-field.md): Folder picker restricted to the Joomla /images directory tree, with the root 'images' folder always present as the first option.
- [Invoicetype Form Field](https://docs.j2commerce.com/developer/fields/invoicetype-field.md): Developer reference for the Invoicetype custom form field — a dropdown of built-in invoice document types (invoice, receipt, packing slip) that plugins can extend via onJ2CommerceGetInvoiceTypes.
- [J2CommerceImage Form Field](https://docs.j2commerce.com/developer/fields/j2commerce-image-field.md): Developer reference for the J2CommerceImage custom form field — a compact inline image picker for J2Commerce admin forms.
- [LengthField Field Type](https://docs.j2commerce.com/developer/fields/length-field.md): A Joomla list field that populates a dropdown with all enabled J2Commerce length classes for product dimension units.
- [ManufacturerCountryField Field Type](https://docs.j2commerce.com/developer/fields/manufacturer-country-field.md): A Joomla list field that populates a dropdown with only the countries that have at least one enabled J2Commerce manufacturer, useful for filtered report or search forms.
- [ManufacturersField Field Type](https://docs.j2commerce.com/developer/fields/manufacturers-field.md): A Joomla list field that populates a dropdown with all enabled J2Commerce manufacturers, joining the manufacturers and addresses tables to retrieve company names.
- [Modal\\ProductField Form Field](https://docs.j2commerce.com/developer/fields/modal-product-field.md): Developer reference for the Modal\\Product custom form field — a modal product picker backed by the J2Commerce products list view.
- [Modal\\ProductMultiSelectField Form Field](https://docs.j2commerce.com/developer/fields/modal-product-multiselect-field.md): Developer reference for the Modal\\ProductMultiselect custom form field — a modal multi-product picker that stores selected IDs and renders a live product table.
- [MultiImageUploaderField](https://docs.j2commerce.com/developer/fields/multi-image-uploader-field.md): Multi-image drag-and-drop uploader field backed by Uppy, with client-side compression, thumbnail generation, and reorderable image gallery.
- [OrderStatusField Field Type](https://docs.j2commerce.com/developer/fields/orderstatus-field.md): A Joomla list field that populates a dropdown with all enabled J2Commerce order statuses, with label translation via Text::\_().
- [OrderstatustypeField Field Type](https://docs.j2commerce.com/developer/fields/orderstatustype-field.md): A Joomla list field that populates a dropdown with every order-status lifecycle type — core plus plugin-registered — via OrderStatusHelper.
- [PaymentMethods Form Field](https://docs.j2commerce.com/developer/fields/payment-methods-field.md): Developer reference for the PaymentMethods custom form field — a dropdown of enabled J2Commerce payment plugins, with per-plugin language file loading.
- [PhoneCountriesField](https://docs.j2commerce.com/developer/fields/phone-countries-field.md): Checkbox grid of all countries from PhoneHelper dial data, displaying country name and dial code, storing selected ISO2 codes as a JSON array.
- [PriceCalculator Form Field](https://docs.j2commerce.com/developer/fields/price-calculator-field.md): Developer reference for the PriceCalculator custom form field — a plugin-extensible dropdown of J2Commerce pricing calculators.
- [PriceField](https://docs.j2commerce.com/developer/fields/price-field.md): Display-only Bootstrap alert box used to present pricing headings and summary text inside J2Commerce admin forms.
- [ProductlistmenuField](https://docs.j2commerce.com/developer/fields/productlistmenu-field.md): Dropdown of J2Commerce product list (products view) menu items, used in legacy router mode to select the canonical product list URL.
- [ProductType Form Field](https://docs.j2commerce.com/developer/fields/product-type-field.md): Developer reference for the ProductType custom form field — a plugin-extensible dropdown of J2Commerce product types.
- [QueuekeyField](https://docs.j2commerce.com/developer/fields/queuekey-field.md): Displays the J2Commerce queue/cron secret key with an inline Regenerate button that calls an AJAX endpoint to rotate the key.
- [RouterCategoryField](https://docs.j2commerce.com/developer/fields/router-category-field.md): Category selection field that automatically switches between single-select and multi-select modes based on the active J2Commerce SEF router type.
- [RouterModalCategoryField](https://docs.j2commerce.com/developer/fields/router-modal-category-field.md): Router-aware category field that delegates to a modal_category picker in modern mode or a multi-select dropdown in legacy mode.
- [RoutertypeField](https://docs.j2commerce.com/developer/fields/routertype-field.md): Hidden field that outputs the active J2Commerce SEF router type (modern or legacy) for use in showon conditions.
- [ShippingMethods Form Field](https://docs.j2commerce.com/developer/fields/shipping-methods-field.md): Developer reference for the ShippingMethods custom form field — a dropdown of enabled J2Commerce shipping plugins and their configured sub-methods.
- [StoreProfileField Field Type](https://docs.j2commerce.com/developer/fields/storeprofile-field.md): A Joomla list field that populates a dropdown with all enabled J2Commerce store profiles for assigning a store identity to products or orders.
- [SubtemplateField](https://docs.j2commerce.com/developer/fields/subtemplate-field.md): Visual card-picker field for selecting an installed and enabled J2Commerce app subtemplate, with optional thumbnail previews and an 'Auto' option.
- [TaxprofileField Field Type](https://docs.j2commerce.com/developer/fields/taxprofile-field.md): A Joomla list field that populates a dropdown with all enabled J2Commerce tax profiles for product tax assignment.
- [TaxRateField Field Type](https://docs.j2commerce.com/developer/fields/taxrate-field.md): A Joomla list field that populates a dropdown with all enabled J2Commerce tax rates for direct rate assignment.
- [TemplateCustomField](https://docs.j2commerce.com/developer/fields/template-custom-field.md): Display-only informational field that renders a reference table of email template shortcodes for billing, shipping, and payment custom fields.
- [TemplatelistField](https://docs.j2commerce.com/developer/fields/templatelist-field.md): Dropdown listing available J2Commerce template folder names from installed app plugins and active site template overrides, with optional view-context filtering.
- [VariantAdvancedPricing Form Field](https://docs.j2commerce.com/developer/fields/variant-advanced-pricing-field.md): Developer reference for the VariantAdvancedPricing custom form field — a button that opens the advanced pricing modal for a saved product variant.
- [VariantPrice Form Field](https://docs.j2commerce.com/developer/fields/variant-price-field.md): Developer reference for the VariantPrice custom form field — a currency-prefixed price input for J2Commerce product variant forms.
- [VendorCountryField Field Type](https://docs.j2commerce.com/developer/fields/vendor-country-field.md): A Joomla list field that populates a dropdown with only the countries that have at least one enabled J2Commerce vendor, useful for filtered report or search forms.
- [VendorsField Field Type](https://docs.j2commerce.com/developer/fields/vendors-field.md): A Joomla list field that populates a dropdown with all enabled J2Commerce vendors, joining the vendors and addresses tables to retrieve company names.
- [WeightField Field Type](https://docs.j2commerce.com/developer/fields/weight-field.md): A Joomla list field that populates a dropdown with all enabled J2Commerce weight classes for product weight units.
- [ZoneField Field Type](https://docs.j2commerce.com/developer/fields/zone-field.md): A Joomla list field that renders a zone dropdown with optional AJAX country-zone linking, filtering zones dynamically when a country is selected.
