Custom Fields let you add your own information to products, categories, customers, orders, and pages. Whether you need to track additional product details, power storefront filters, or store internal notes, Custom Fields give you the flexibility to shape your store’s data around your business needs.
On This Page
- Creating a New Custom Field
- Deleting Custom Fields
Add a Product Custom Field to Your Product Page (Flex Components)
Understanding Custom Field Types
When you create a custom field, the first decision is what kind of record it belongs to.
The type you choose determines where the field appears in the Admin and how it can be used.
Category Custom Field - Use a Category Custom Field to store additional data associated with a category. How that data is used depends on your storefront configuration and layout.
Customer Custom Field - Customer Custom Fields store additional data tied to individual customer records. These fields can be referenced internally or through integrations as needed.
Order Custom Field - Order Custom Fields allow you to attach additional information to order records for internal tracking or workflow purposes.
Page Custom Field - Page Custom Fields store additional data associated with content pages and can be referenced in your page layout as needed.
Product Custom Field
Product Custom Fields attach directly to product records and are the most commonly used type of custom field. They allow you to store additional product-specific information and are often used to power storefront features such as filtering, search, and sorting.
Because Product Custom Fields are often used in search and filtering, they can generate significant amounts of data, especially in stores with large inventories. As a result, they include additional configuration options related to storefront behavior and data storage.
Product Custom Field Configuration Options
Product Custom Fields include several configuration options that control how they behave in the storefront and how their data is handled.
Facet – Allows the field to function as a storefront filter, enabling customers to narrow results based on its values (for example, filtering by brand).
Public – Makes the field accessible via the API. If this option is not enabled, the field will not be returned in API responses.
Separate – Stores the field’s values in a dedicated database table instead of the default shared product field table. This is typically recommended for stores with large catalogs or high volumes of product data, especially when the field is heavily used in search, filtering, faceted navigation, or relevance sorting.
When separate storage is enabled or disabled, the system automatically migrates the field’s data between storage locations. Depending on the volume of data, this process may take time.
Creating a New Custom Field
In the Miva Admin, click the Settings gear in the lower-left corner, go to Utilities → Custom Fields, then click New Custom Field in the upper-right corner. The Add Custom Field window will open.
Step 1: Choose the Field Type
Use the Type dropdown to select what the custom field will be attached to:
Step 2: Define the Field
Code – The internal identifier used in templates and integrations.
(Best practice: Use lowercase letters with no spaces.)Name – The label shown in the Admin.
Step 3: Configure Field Options
The following options control how the custom field behaves:
Note: The Separate option applies only to Product Fields.
Step 4: Select the Field Type
Choose the format in which the field’s data will be stored and entered.
Text Field – A single-line text input.
Text Area – A multi-line text input.
Radio Button – Allows selection of one option from a predefined list.
Drop-Down List – Allows selection of one option from a list.
Checkbox – A single on/off option.
Image Upload – Allows an image file to be uploaded and associated with the field.
PDF Upload – Allows a PDF file to be uploaded and associated with the field.
Multi-Text – Allows multiple text values to be assigned to the field.
If the Rich Text Editor is enabled, it will be available for Text Area fields.
Important: Image Upload and PDF Upload fields allow files to be uploaded through the Admin only. They cannot be used to accept file uploads from customers on the storefront.
Step 5: Assign a Group
Use the Group dropdown to organize the field within the Admin.
Groups help organize related custom fields, making them easier to manage, especially in stores with many fields. You can search, sort, and filter custom fields by group name to quickly locate what you need.
For example, you might create groups for product tabs, additional order information, or other related field sets.
Important: When a custom field is assigned to a group, that group appears as its own tab within the corresponding record in the Admin (for example, within a Product record). Custom fields that are not assigned to a group appear under the default Custom Fields tab.
For more information about creating Custom Field Groups, see [Custom Field Groups].
Step 6: Add Additional Information (Optional)
Use the Additional Information field to document how the custom field should be used.
This can be helpful for internal teams and future administrators, particularly when the field serves a specific business or technical purpose.
Step 7: Save
Click Add to create the field.
Click Add+ to save and immediately create another field.
Deleting Custom Fields
1. In the Miva Admin, click the Settings gear in the lower-left corner.
2. Select Utilities, then click the Custom Fields tab.
3. Select the custom field you want to delete by checking the box to the left of its name.
4. Click the Ellipsis ( ... ), then select Delete Records.
Add a Product Custom Field to Your Product Page (Flex Components)
After creating a Product Custom Field, you can display it on the storefront using Flex Components.
In the Admin, go to User Interface → Page Builder, then select Product Display (PROD).
Click the Product Details component.
Choose Where the Field Should Appear
In the left panel, expand the section where you want the field to display.
For example, if you want the custom field to appear under the product name:
1. Click Main Content (Level 1).
2. Click Details (Level 2).
3. Click Add Detail: Level 3.
You can reposition the new detail by dragging it beneath the Name detail to control its placement.
Configure the Custom Field
In the Detail settings:
1. Enter a Detail Name (for internal reference).
2. Under Type, select Detail: Custom Field.
3. Click Look Up, choose the Product Custom Field you want to display, and confirm.
4. Click Save.
Your Product Custom Field will now appear on the Product page in the location you selected.