For the complete documentation index, see llms.txt. This page is also available as Markdown.

Custom Fields Overview

Capture extra order details and store specialised product data. Learn the field types, where to use them, and how to edit or delete fields.

Custom fields help you capture, validate, and use additional or specialised information within your account. You can use them to display specialised details about your product or to gather specific order information, such as the delivery type.

Your account type and plan may limit the number of custom fields you can create. The default limit typically starts at three, with higher limits available on upgraded plans.


Field types

Mimeeq currently supports six types of custom fields. The types available depend on the field scope: whether the field will be used in the Basket or in an Option Set. More scopes and field types are planned for the future.

#
Field type
Scope
Typical use

1

Basket

Simple Yes/No answers, e.g. agreeing to terms and conditions or requesting gift packaging.

2

Basket

Choosing from a list you provide, e.g. Standard, Express or Next Day delivery.

3

Basket, Option Set

A short note in the Basket, or a value used in SKU codes or Price Codes.

4

Basket

Longer text, such as an order note, special instructions or delivery preferences.

5

Basket, Option Set

A phone number, quantity or order reference, or a numeric value for Option Sets.

6

Option Set

Single-line text with translations for each language.


Create a custom field

Every field type is created the same way. The settings in the last step depend on the type; see the article for each type above.

1

Open Custom Fields

Go to Settings, find Custom Fields under the Data section, and click New Custom Field.

2

Set the scope and type

Choose the Field Scope (Basket or Option Set) and select the Type.

3

Fill in the field details

Provide the remaining required information and save the field.


Add custom fields to the Basket form

Basket custom fields are primarily used during the submission process, allowing you to gather additional information from customers. To add or remove custom fields in Basket forms, go to Settings → Baskets and open the General tab. Here, you'll find a list of available custom fields, including system-generated fields created by default and any custom fields you have previously created.

The Basket form already includes several system-generated fields:

  • Full Name (always required and active)

  • Email (always required and active)

  • Phone Number

  • Company Name

  • Address

  • Order Notes

Basket settings with the list of system-generated and custom fields

Fields that are not required to be active can be turned off if you don't need them. Use the Active checkbox column to control visibility: if checked, the field is displayed on Basket forms; if unchecked, it does not appear. To change the order in which fields appear on the form, use drag and drop. To edit a field, click its name, and you'll be redirected to the custom field page.

After you've added custom fields to your form, they are displayed on the Basket form. Here's an example of how this might look:

Basket form showing custom fields

Once a customer submits their Basket, both you and the customer receive an email and PDF containing the submitted field information. In the app, you can also review the submitted Basket: all customer-submitted information appears on the left side of the Basket drawer.

Submitted Basket preview in the app with custom field values

Add custom fields to an Option Set

Once you create a custom field for an Option Set in Settings, it is automatically added to the Option Set. To access it, go to Option Set → Options, where you'll see all custom fields displayed at the end of the data grid. From here, you can fill in the necessary content.

Custom field columns in the Option Set data grid

Advanced use cases

You can use custom fields as a dynamic value in different areas, for example in:

  • 2D Layers

  • Rules

  • Pricing Code and SKU

  • Downloadable Content

Custom field used in a price code pattern

Edit and delete custom fields

To edit or delete a custom field, go to Settings → Custom Fields, then select the custom field you want to modify or remove from the data grid. Some attributes, such as Field Scope, Type and ID, cannot be edited after creation. You can still modify other details, like the name, single-select options and checkbox labels.

Editing or deleting a custom field in Settings

Was this helpful?