> 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/number-field.md).

# Number Field

Collect or store numeric values such as quantities or reference numbers. Learn how to create a number field with limits and validation.

A number custom field can be used for both Baskets and Option Sets. 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 Sets, this field is visible in the admin panel within the Option Set. You can later use this information as a dynamic value in different areas, such as SKU codes or Price Codes.

{% hint style="info" %}
Your account type and plan may limit the number of custom fields you can create.
{% endhint %}

***

## Create a number field

{% 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

Set **Field Scope** to **Basket** or **Option Set** and select **Type**: **Number**.
{% endstep %}

{% step %}

### Fill in the field details

Provide the remaining required information. For example, the regular expression `^\+?\d{1,3}[-.\s]?\d{3,14}$` validates European phone numbers with an optional country code and supports basic separators like dashes, dots or spaces.

<table><thead><tr><th width="60">#</th><th>Setting</th><th>Description</th></tr></thead><tbody><tr><td>1</td><td><strong>Name</strong></td><td>The name for the number custom field. Required.</td></tr><tr><td>2</td><td><strong>ID</strong></td><td>Automatically generated ID from the name in a URL-friendly format. Required.</td></tr><tr><td>3</td><td><strong>Field Scope</strong></td><td>Basket or Option Set. Required.</td></tr><tr><td>4</td><td><strong>Type</strong></td><td>Number. Required.</td></tr><tr><td>5</td><td><strong>Regex Regular Expression</strong></td><td>A pattern used to validate the format of text entered by the user (see the example above). Optional.</td></tr><tr><td>6</td><td><strong>Description</strong></td><td>A description of the custom field, which can be used to provide additional details for your customer. Optional.</td></tr><tr><td>7</td><td><strong>Min Value</strong></td><td>Specifies the minimum numeric value allowed for the field. Optional.</td></tr><tr><td>8</td><td><strong>Max Value</strong></td><td>Specifies the maximum numeric value allowed for the field. Optional.</td></tr><tr><td>9</td><td><strong>Decimal Value</strong></td><td>Specifies the maximum number of decimal places allowed in the input field for more precise values. Optional.</td></tr><tr><td>10</td><td><strong>Required Setting</strong></td><td>Defines whether the input is required or not.</td></tr></tbody></table>

![New Custom Field form with number settings for the Basket scope](https://621103948-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsqWfi8ifBhTdkvf1vOlY%2Fuploads%2Fx5Z1UOXhBFwwfTLpGS2R%2Fcustom-fields-number-11_1p2tjys.png?alt=media)
{% endstep %}
{% endstepper %}

***

## Option Set settings

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

<table><thead><tr><th width="60">#</th><th>Setting</th><th>Description</th></tr></thead><tbody><tr><td>11</td><td><strong>Custom field must be unique</strong></td><td>Controls whether the data entered must be unique for each entry, preventing duplicate values.</td></tr><tr><td>12</td><td><strong>Exposed to Embed</strong></td><td>Enabled by default to allow the custom field to be used in embeds.</td></tr></tbody></table>

![New Custom Field form with number settings for the Option Set scope](https://621103948-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsqWfi8ifBhTdkvf1vOlY%2Fuploads%2FEdiHoCTaKbo1nxS6CdiK%2Fcustom-fields-number-22_sc9ewy.png?alt=media)

***

## How it appears in the Basket

Once you've created a number custom field and added it to the Basket form, it appears as a numeric input field for customers submitting their Baskets.

![Number input on the Basket form](https://621103948-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsqWfi8ifBhTdkvf1vOlY%2Fuploads%2Fxk7V6fXXF4hgWwjGa7P1%2Fcustom-fields-number-33_15vebba.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>Custom Fields Overview</strong></td><td>Learn field types, scopes, and how to manage custom fields.</td><td><a href="/platform/custom-fields/custom-fields.md">Custom Fields Overview</a></td></tr><tr><td><strong>Single-Line Text Field</strong></td><td>Collect short text in Baskets or store it in Option Sets.</td><td><a href="/platform/custom-fields/single-line-text-field.md">Single-Line Text Field</a></td></tr><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></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/number-field.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.
