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.

You can include a validation option for a metafield definition using the validation name and a corresponding value. The appropriate value depends on the metafield type that the validation applies to. For more information about the supported formats and units of measurement available for each type, refer to Metafield types.

Learn more about creating a metafield definition with validation options and refer the to table below for more examples.

Supported validation options

Anchor link to section titled "Supported validation options"

The following table describes the validation options available for metafield definitions:

Validation option	Description	Supported types	Example
Minimum length	A validation for setting the minimum length of a text value. Example use cases: A blog summary needs to be at least 100 characters long so that it provides enough detail. A value, such as a zip code, needs to have an exact character length, so you set minimum length and maximum length to the same value.	`single_line_text_field` `multi_line_text_field`	validations: name: min, value: "8"
Maximum length	A validation for setting the maximum length of a text value. Example use cases: A blog summary or a product description needs to have a maximum length of 150 characters so that it fits in a designated area of your page. A value, such as a phone number, needs to have an exact character length of 10, so you set minimum length and maximum length to 10.	`single_line_text_field` `multi_line_text_field`	validations: name: max, value: "25"
Regular expression	A validation for setting a regular expression. Shopify supports RE2. Example use cases: An email field requires an `@` symbol followed by a `.` and some text (as shown in the example). A serial number needs to start with a specific set of characters.	`single_line_text_field` `multi_line_text_field`	validations: name: regex, value: "(@)(.+)$"
Allowed domains	A list of allowed domains. Example use cases: Allow links to specific social media sites at the bottom of an article. Allow links to other pages within your site for a list of "similar products".	`url`	validations: name: allowed_domains, value: "[\"shopify.com\"]"
Choices	A list of up to 128 predefined options that limits the values allowed for the metafield. Example use cases: The flavor profile field for coffee products allows the following choices: Floral, Sweet, Nutty, and Other. The field for sizing fits for a product allows the following choices: True to size, Runs Large, Runs small.	`single_line_text_field`	validations: name: choices, value: "[\"red\", \"green\", \"blue\"]"
File type options	A list of file type options. Leaving this empty allows all files, regardless of type. Valid values: `Image`, `Video`. Example use cases: A file reference from a blog to an author photo needs to be to an image file type. A file reference to a demonstration video in MP4 format. A file reference from an order to specific product instructions in PDF format.	`file_reference`	validations: name: file_type_options, value:"[\"Image\",\"Video\"]"
Maximum precision	Sets the maximum number of decimal places to store for a decimal number. Example use cases: A version number field needs to accept a number with one decimal place. A specification field for a product needs to have a maximum of 3 decimal places.	`number_decimal`	validations: name: max_precision, value: "2"
Minimum date	A validation for setting the minimum date in ISO 8601 format. Example use case: The date field for an expiry date or a product release needs to be after a specific date.	`date`	validations: name: min, value: "2022-01-01"
Maximum date	A validation for setting the maximum date in ISO 8601 format. Example use case: The date for future product availability can't be later than a certain date.	`date`	validations: name: max, value: "2022-03-03"
Minimum datetime	A validation for setting the minimum date and time in ISO 8601 format. Example use case: A product release occurs on a specific date at midnight, and the product won't display before that date and time.	`date_time`	validations: name: min, value: "2022-03-03T16:30:00"
Maximum datetime	A validation for setting the maximum date and time in ISO 8601 format. Example use case: A customer loyalty reward expires on a specific date and time. The reward can't be used after that date and time.	`date_time`	validations: name: max, value: "2022-03-03T16:30:00"
Minimum weight	A validation for setting the minimum weight. Example use case: A bundled product weight field needs to have a maximum allowed weight.	`weight`	validations: name: min, value: "{\"unit\":\"g\",\"value\":10}"
Maximum weight	A validation for setting the maximum weight. Example use case: An order requires a minimum weight for shipping.	`weight`	validations: name: max, value: "{\"unit\":\"g\",\"value\":50}"
Minimum volume	A validation for setting the minimum volume. Example use cases: A product volume field needs to have certain minimum volume. A product needs to have an exact volume, so you set minimum volume and maximum volume to the same value.	`volume`	validations: name: min, value: "{\"unit\":\"ml\",\"value\":5}"
Maximum volume	A validation for setting the maximum volume. Example use cases: A product volume field needs to have certain maximum volume. A product needs to have an exact volume, so you set minimum volume and maximum volume to the same value.	`volume`	validations: name: max, value: "{\"unit\":\"ml\",\"value\":50}"
Minimum dimension	A validation for setting the minimum dimension. Example use case: A product needs to have a minimum length, width, or height.	`dimension`	validations: name: min, value: "{\"unit\":\"cm\",\"value\":5}"
Maximum dimension	A validation for setting the maximum dimension. Example use case: A product needs to have a minimum length, width, or height.	`dimension`	validations: name: max, value: "{\"unit\":\"cm\",\"value\":50}"
Minimum integer	A validation for setting the minimum integer number. Example use case: A product number needs to be within a specific range of numbers, so you can use both the minimum and maximum integer validation to set the range.	`number_integer`	validations: name: min, value: "9"
Maximum integer	A validation for setting the maximum integer number. Example use case: A product number needs to be within a specific range of numbers, so you use both the minimum and maximum integer validation to set the range.	`number_integer`	validations: name: max, value: "15"
Minimum decimal	A validation for setting the minimum decimal number. Example use case: A product version field needs to accept a version greater than a specific decimal number, such as `0.5`.	`number_decimal`	validations: name: min, value: "0.5"
Maximum decimal	A validation for setting the maximum decimal number. Example use case: A product version field needs to accept a version number less than a specific decimal numbner, such as `1.99`.	`number_decimal`	validations: name: max, value: "1.99"

Query the GraphQL Admin API for a list of supported validation options

Anchor link to section titled "Query the GraphQL Admin API for a list of supported validation options"

The following example query returns the full list of supported validations for each type from the GraphQL Admin API:

POST /admin/api/2022-07/graphql.json

For an example query response that shows the complete list of types and supported validations, refer to the GraphQL reference documentation.

Use regular expressions for validation options

Anchor link to section titled "Use regular expressions for validation options"

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/2022-07/graphql.json

Variables

JSON response

Add multiple validation options to a definition

Anchor link to section titled "Add 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/2022-07/graphql.json

Variables

JSON response

Validation options

Supported validation options

Query the GraphQL Admin API for a list of supported validation options

Use regular expressions for validation options

Add multiple validation options to a definition

On this page