> For the complete documentation index, see [llms.txt](https://help.mimeeq.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.mimeeq.com/platform/custom-fields/custom-fields.md).

# 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.

{% hint style="info" %}
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.
{% endhint %}

***

## 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.

<table><thead><tr><th width="60">#</th><th>Field type</th><th>Scope</th><th>Typical use</th></tr></thead><tbody><tr><td>1</td><td><a href="/platform/custom-fields/checkbox-field.md">Checkbox</a></td><td>Basket</td><td>Simple Yes/No answers, e.g. agreeing to terms and conditions or requesting gift packaging.</td></tr><tr><td>2</td><td><a href="/platform/custom-fields/single-select-field.md">Single-select</a></td><td>Basket</td><td>Choosing from a list you provide, e.g. Standard, Express or Next Day delivery.</td></tr><tr><td>3</td><td><a href="/platform/custom-fields/single-line-text-field.md">Single-line text</a></td><td>Basket, Option Set</td><td>A short note in the Basket, or a value used in SKU codes or Price Codes.</td></tr><tr><td>4</td><td><a href="/platform/custom-fields/multi-line-text-field.md">Multi-line text</a></td><td>Basket</td><td>Longer text, such as an order note, special instructions or delivery preferences.</td></tr><tr><td>5</td><td><a href="/platform/custom-fields/number-field.md">Number</a></td><td>Basket, Option Set</td><td>A phone number, quantity or order reference, or a numeric value for Option Sets.</td></tr><tr><td>6</td><td><a href="/platform/custom-fields/translatable-text-field.md">Translatable text</a></td><td>Option Set</td><td>Single-line text with translations for each language.</td></tr></tbody></table>

***

## 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.

{% stepper %}
{% step %}

### Open Custom Fields

Go to **Settings**, find **Custom Fields** under the **Data** section, and click **New Custom Field**.
{% endstep %}

{% step %}

### Set the scope and type

Choose the **Field Scope** (**Basket** or **Option Set**) and select the **Type**.
{% endstep %}

{% step %}

### Fill in the field details

Provide the remaining required information and save the field.
{% endstep %}
{% endstepper %}

***

## 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](https://621103948-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsqWfi8ifBhTdkvf1vOlY%2Fuploads%2FyFgNFsWZqUCYyTONmmXS%2Fcustom-fields-basket-settings-_1mxeoo.png?alt=media)

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](https://621103948-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsqWfi8ifBhTdkvf1vOlY%2Fuploads%2FLgYIklt29eLlcBf9INDp%2Fcustom-fields-basket-settings-_561og8.png?alt=media)

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](https://621103948-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsqWfi8ifBhTdkvf1vOlY%2Fuploads%2FQSeMx8Rg3OIGwqE7dJa3%2Fcustom-fields-basket-settings-_1gfk32x.png?alt=media)

***

## 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.

{% hint style="warning" %}
If a custom field was created as required, you won't be able to save options without completing all required fields. If you've set a Regex for validation, make sure the format is correct, as incorrect formatting can prevent saving.
{% endhint %}

![Custom field columns in the Option Set data grid](https://621103948-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsqWfi8ifBhTdkvf1vOlY%2Fuploads%2F1O8SxSTmhUIOkL7DeCOK%2Fcustom-fields-option-set1_1j21r5s.png?alt=media)

***

## 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](https://621103948-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsqWfi8ifBhTdkvf1vOlY%2Fuploads%2FzCBxfPG2EqNfpqyYqVSV%2Fcustom-fields-price-code_1n3z243.png?alt=media)

***

## 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.

{% hint style="warning" %}
Deleting a custom field is permanent, and you will no longer have access to the associated data. If you want to keep the data, set the field to inactive instead.
{% endhint %}

![Editing or deleting a custom field in Settings](https://621103948-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsqWfi8ifBhTdkvf1vOlY%2Fuploads%2FFjkHZfBrLGz9GAemoLdu%2Fcustom-fields-edit-and-delete_17zf0pw.png?alt=media)

***

## Related articles

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Basket Settings</strong></td><td>Configure the Basket form, including which fields customers see.</td><td><a href="/commerce-and-integrations/mimeeq-basket/basket-settings.md">Basket Settings</a></td></tr><tr><td><strong>Rules Overview</strong></td><td>Automate configurator behaviour with triggers and actions.</td><td><a href="/configurator/rules/overview.md">Rules Overview</a></td></tr><tr><td><strong>Dynamic Downloads</strong></td><td>Generate downloadable content that changes with the configuration.</td><td><a href="/configurator/dimensions-and-exports/dynamic-downloads.md">Dynamic Downloads</a></td></tr></tbody></table>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://help.mimeeq.com/platform/custom-fields/custom-fields.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `build a script that syncs our docs to a CMS` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.