Skip to main content

Metafield definitions in Shopify

Use metafield definitions to display and edit custom data directly from the Shopify admin

Customer Fields creates a Shopify metafield definition for each custom data column. Definitions let you view and edit your customers' custom data on their customer page in the Shopify admin. To show a definition there, pin it.

When definitions are created

Definitions need Shopify admin-compatible metafield storage. New installs use it automatically, so most stores don't need to change anything.

If your store still uses the older bundled storage, you'll see Metafields under Settings in Customer Fields. Switch to Shopify admin-compatible there. Once you switch, the page no longer appears.

Until you switch, don't create a metafield definition for customer_fields.data in Shopify. If one exists, Customer Fields shows a red Customers cannot submit forms on your store banner. Delete the definition in your Shopify admin under Settings > Metafields and metaobjects > Customers.

The app creates a definition for each custom data column when it migrates your data to the new storage, and whenever you create a new custom data column.

Definition types

The app picks the right type for each definition. If you ever create one yourself, it must use the type below.

Data column type (Customer Fields)

Metafield definition type (Shopify)

single_line_text

Single line text

single_line_text_field

text

Multi-line text

multi_line_text_field

email

Single line text

single_line_text_field

phone

Single line text

single_line_text_field

list

Single line text (List)

list.single_line_text_field

date

Date

date

datetime

Date and time

date_time

integer

Number

number_integer

float

Decimal

number_decimal

file

JSON

json

file_reference

File

file_reference

boolean

True or false

boolean

group

JSON

json

group_list

JSON

json

Metafield definition errors

If a definition's type doesn't match its data column, Customer Fields can't save that data, and customers may get an error when they submit a form. The app shows a red banner, We detected an issue with your Shopify metafield definitions.

To fix it:

  1. Click See errors in the banner to see which definitions don't match.

  2. In your Shopify admin, go to Settings > Metafields and metaobjects > Customers and delete those definitions.
    ​


    ​

  3. In Customer Fields, click Check again.

Related articles

Did this answer your question?