How to Create and Use Custom Fields in Mimeeq

Content

1. About Custom Fields
2. How to create Custom Fields
3. Common use cases for Custom Fields
4. Editing and Deleting Custom Fields

About Custom Fields

Custom fields help you capture, validate, and utilize additional or specialized information within your account. You can use them to display specialized details about your product or to gather specific order information, such as the delivery type. Currently, Mimeeq supports six different types of custom fields, allowing you to collect and store various kinds of information:

• Checkbox
• Single-select
• Single-line text
• Multi-line text
• Number
• Translatable text

How to create Custom Fields

As mentioned earlier, Mimeeq currently offers six different types of custom fields. The types available depend on the field scope — whether it will be used in the Basket or Option Set. Below, we provide instructions on how to create each type and examples of how they can be used.

Checkbox

A checkbox custom field is useful for collecting simple Yes/No responses from your customers. For example, you can use it to confirm agreement with terms and conditions, sign up for a newsletter, or request gift packaging.

Follow these steps to create a checkbox custom field:

1. Go to Settings, find Custom Fields under the Data section, and click New Custom Field.
2. Set the Field Scope to Basket (as the checkbox is only available for Baskets) and select Type: Checkbox.
3. Provide the remaining required information.

Once you’ve created a checkbox custom field and added it to the Basket form, it will be visible to customers submitting their Baskets. Below are examples of how the checkbox appears when fixed in the footer, within the form, and in an error state.

Single-select

A single-select custom field is useful for collecting information from customers by having them choose from a list you provide. For example, it can be used to specify delivery options, such as Standard, Express, or Next Day.

Follow these steps to create a single-select custom field:

1. Go to Settings, find Custom Fields under the Data section, and click New Custom Field.
2. Set the Field Scope to Basket (as the single-select is only available for Baskets) and select Type: Single-Select.
3. Provide the remaining required information.

Once you’ve created a single-select custom field and added it to the Basket form, it will appear as a dropdown with your list of options for customers submitting their Baskets. Below are examples of how the single-select field appears in the Basket form.

Single-line text

A single-line text field can be used for both Baskets and Option Set. For Baskets, it appears as an input field where customers can provide additional information, such as a short note. For Option Set, this field is visible in the admin panel within Option Set. You can later use this information as a dynamic value in different areas, such as SKU codes or Price Codes.

Follow these steps to create a single-line text custom field:

1. Go to Settings, find Custom Fields under the Data section, and click New Custom Field.
2. Set the Field Scope to Basket or Option Set and select Type: Single-line text.
3. Provide the remaining required information.

For single-line text custom fields created for Option Set, two additional settings are available:

Once you’ve created a single-line text custom field and added it to the Basket form, it will appear as a simple input field. Below are examples of how the single-line text field appears in the Basket form. The field can be set as required or optional, and it can also include validation based on a Regex Regular Expression.

Multi-line text

A multi-select custom field is useful for collecting longer text from your customer, such as an order note, special instructions, or delivery preferences. It can only be used on the Basket form and appears as a large text area field.

Follow these steps to create a multi-line text custom field:

1. Go to Settings, find Custom Fields under the Data section, and click New Custom Field.
2. Set the Field Scope to Basket and select Type: Multi-line text.
3. Provide the remaining required information.

Once you’ve created a multi-line text custom field and added it to the Basket form, it will appear as a text area for customers submitting their Baskets. Below are examples of how the multi-line text field appears in the Basket form.

Number

A number custom field can be used for both Baskets and Option Set. For Baskets, it appears as an input field where customers can provide additional information, such as a phone number, quantity needed, or order reference number. For Option Set, this field is visible in the admin panel within Option Set. You can later use this information as a dynamic value in different areas, such as SKU codes or Price Codes.

Follow these steps to create a number custom field:

1. Go to Settings, find Custom Fields under the Data section, and click New Custom Field.
2. Set the Field Scope to Basket or Option Set and select Type: Number.
3. Provide the remaining required information.

For number custom fields created for Option Set, two additional settings are available:

Once you’ve created a number custom field and added it to the Basket form, it will appear as a numeric input field for customers submitting their Baskets. Below are examples of how the number field appears in the Basket form.

Translatable text

Translatable text is available only for Option Set and functions similarly to single-line text, but with the added ability to include translations for this field. Once you’ve created a translatable custom field, it appears in the admin panel within Option Set. You can later use this information as a dynamic value in various areas, such as SKU codes or Price Codes.

1. Go to Settings, find Custom Fields under the Data section, and click New Custom Field.
2. Set the Field Scope to Option Set and select Type: Translatable text.
3. Provide the remaining required information.

Once you’ve created a translatable text custom field, go to Option Set, select Options, and you’ll see the field in the data grid, typically placed as the last column. You can add translations by clicking on the flag icon.

Common use cases for Custom Fields

Mimeeq currently supports custom fields in two primary scopes: Basket and Option Set. However, this functionality is expected to expand, with more scopes and field types planned for the future.

How to add Custom Fields in 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.

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

For fields that are not required to be active, you can choose to turn them off if you don’t need them. Use the Active checkbox column to control visibility: if checked, the field will be displayed on Basket forms; if unchecked, the field will 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 will be displayed on the Basket form. Here’s an example of how this might look:

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

How to add Custom Fields to the 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.

Advanced Use Cases of Custom Fields

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

• 2D Layers
• Rules
• Pricing Code and SKU
• Downloadable Content

Editing and Deleting Custom Fields

After creating a custom field, you may need to edit or delete it. 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. Note, that some attributes, such as field scope, type, and ID, cannot be edited after creation. However, you can still modify other details like the name, single-select options, and checkbox label.

Keep in mind that deleting a custom field is a permanent action, and you will no longer have access to the associated data. If you wish to retain access to the data, consider setting the field to inactive instead.

If you have any questions or need further assistance, please don’t hesitate to contact our support team. We’re here to help! 🤝

Updated on: 13/03/2025