Tags:
- Action Required
- Platform
Metafields now require a definition to be accessed through the Customer Account API
Starting today, metafields stored on the app resource must have a metafield definition and customer accounts permissions to be accessible through the Customer Account API. Going forward, when calling the Customer Accounts API, app metafields without a definition will no longer return a value. If your app has functionality which depends on these fields, update those metafields to use definitions with the Customer Account API permission to avoid disruption.
Action required:
You must ensure that every metafield your app uses for customer account UI extensions, a Hydrogen or a Headless store, has a definition.
- Run the metafieldDefinitionCreate for every store that installs your app to ensure the metafields are correctly defined.
- For app-owned metafields, configure declarative metafields in your app’s TOML file.
- Configure the access settings on your definition to allow customer accounts API access.
Metafields owned by Customer or Order resources will not be affected by this change.
Was this section helpful?