Validation options
Metafield definitions can have validation options. Validation options enable you to apply additional constraints to the data that a metafield can store, such as a minimum or maximum value, or a regular expression. The type of the metafield definition determines which validation options are available.
A validation option has two parts:
- Name: The name of validation option. Refer to the list of available validation options.
- Value: The value of the validation option. The value depends on the type of validation option.
Supported validation options
The following table lists the supported validation options by type.
| Validation option | Description | Supported types | Example |
|---|---|---|---|
| Minimum length | An option for setting the minimum length of a text value. |
|
"validations": [{
"name": "min",
"value": "8"
}]
|
| Maximum length | An option for setting the maximum length of a text value. |
|
"validations": [{
"name": "max",
"value": "25"
}]
|
| Regular expression | An option for setting a regular expression. Shopify supports RE2. |
|
"validations": [{
"name": "regex",
"value": "(@)(.+)$"
}]
|
| Allowed domains | A list of allowed domains. |
|
"validations": [{
"name": "allowed_domains",
"value": "[\"shopify.com\"]"
}]
|
| File type options | A list of file type options. Valid values: Image, GenericFile |
|
"validations": [{
"name": "file_type_options",
"value": "[\"Image\",\"GenericFile\"]"
}]
|
| Maximum precision | Sets the maximum number of decimal places to store for a decimal number. |
|
"validations": [{
"name": "max_precision",
"value": "2"
}]
|
| Minimum date | An option for setting the minimum date in ISO 8601 format. |
|
"validations": [{
"name": "min",
"value": "2021-01-01"
}]
|
| Maximum date | An option for setting the maximum date in ISO 8601 format. |
|
"validations": [{
"name": "max",
"value": "2021-03-03"
}]
|
| Minimum datetime | An option for setting the minimum date and time in ISO 8601 format. |
|
"validations": [{
"name": "min",
"value": "2021-01-01T12:30:00"
}]
|
| Maximum datetime | An option for setting the maximum date and time in ISO 8601 format. |
|
"validations": [{
"name": "max",
"value": "2021-03-03T16:30:00"
}]
|
| Minimum weight | An option for setting the minimum weight. |
|
"validations": [{
"name": "min",
"value": "{\"unit\":\"g\",\"value\":10}"
}]
|
| Maximum weight | An option for setting the maximum weight. |
|
"validations": [{
"name": "max",
"value": "{\"unit\":\"g\",\"value\":50}"
}]
|
| Minimum volume | An option for setting the minimum volume. |
|
"validations": [{
"name": "min",
"value": "{\"unit\":\"ml\",\"value\":5}"
}]
|
| Maximum volume | An option for setting the maximum volume. |
|
"validations": [{
"name": "max",
"value": "{\"unit\":\"ml\",\"value\":50}"
}]
|
| Minimum dimension | An option for setting the minimum dimension. |
|
"validations": [{
"name": "min",
"value": "{\"unit\":\"cm\",\"value\":5}"
}]
|
| Maximum dimension | An option for setting the maximum dimension. |
|
"validations": [{
"name": "max",
"value": "{\"unit\":\"cm\",\"value\":50}"
}]
|
| Minimum integer | An option for setting the minimum integer number. |
|
"validations": [{
"name": "min",
"value": "9"
}]
|
| Maximum integer | An option for setting the maximum integer number. |
|
"validations": [{
"name": "max",
"value": "15"
}]
|
| Minimum decimal | An option for setting the minimum decimal number. |
|
"validations": [{
"name": "min",
"value": "0.5"
}]
|
| Maximum decimal | An option for setting the maximum decimal number. |
|
"validations": [{
"name": "max",
"value": "1.99"
}]
|
Fetching supported validations from our API
You can also fetch the full list of supported validations for each type from the GraphQL Admin API, as shown in the following example.
POST /admin/api/unstable/graphql.json
Regular expressions
For certain definition types, you can add a regular expression as a validation option. Shopify supports RE2 syntax for regular expressions.
The following example creates a metafield definition called Email with the type single_line_text_field and adds a validation option to confirm that the value of the metafield contains the @ symbol with at least one character after it.
POST /admin/api/unstable/graphql.json
To learn more about regular expressions, you can visit a learning website such as RegexOne.
Adding multiple validation options to a definition
You can add multiple validation options to the same metafield definition. The following example creates a metafield definition called Employee code with a minimum character length of 4 and a maximum character length of 10.
POST /admin/api/unstable/graphql.json