Create the metafield definition using your app's shopify.app.toml file. The following creates the definition with app-owned namespace app and key internal_sku: ... After you create the metafield definition, add the metafield (value) using the GraphQL Admin API.

Metafields enable you to attach additional information to a Shopify resource, such as a [Product](https://shopify.dev/api/admin-graphql/latest/objects/product) or a [Collection](https://shopify.dev/api/admin-graphql/latest/objects/collection).

curl -d '{"metafield":{"namespace":"my_fields","key":"discount","type":"single_line_text_field","value":"25%"}}' \ -X POST "https://your-development-store.myshopify.com/admin/api/2025-10/collections/482865238/metafields.json" \ -H "X-Shopify-Access-Token: {access_token}" \ -H "Content-Type: application/json"

Metafields represent custom metadata attached to a resource. Metafields can be sorted into namespaces and are comprised of keys, values, and value types.

The API for interacting with metafields.

August 14, 2023 - I am trying to create Metafield from API and able to do it for a specific product or collection. But the issue I am facing is how to create a metafield that can get pin and have definition in it from API? Because all the metafield that I am creating from POSTMAN doesn’t get pin and it always ...

You can retrieve metafields with the Storefront API to access additional information from different types of resources.

If you want to allow custom storefronts to display your metafields, then you can give access to the Storefront API when you create or edit a metafield definition. If you sell your Shopify products through a non-Shopify website, video game, or other custom shopping experience, then you might ...

Writing to metafields directly from the Customer Account API enables you to store additional information about customers within Shopify, without making a separate call to the GraphQL Admin API, a third-party server, or other external resource.

January 5, 2024 - From there, your Shopify store will be expanded with more unique features to make the management and operation more convenient. Data organization: You may effectively arrange your data by setting custom metafield namespaces and keys. This is especially beneficial if your store has many metafields connected with various items. It contributes to data consistency and integrity. Flexibility: The Metafields API is versatile and can be used with various store objects, including products, collections, customers, and orders.

Manage metafields, metafield definitions, and app-data metafields using the GraphQL Admin API.

The problem with using the REST API to retrieve metafield data stored against your client’s products is that there is no way to retrieve them in bulk. There are a few promising leads to be found in the Shopify documentation, such as /metafields.json?metafield[owner_resource]=product.

Metafields are key-value pairs that let you store custom data on Shopify resources like products, customers, and orders. This guide shows you how to create, read, update, and delete metafield values using the GraphQL Admin API.

We cannot provide a description for this page right now

Find an example Product ID that contains the needed metafield · Copy the API URL into the browser and append it with /admin/products/ + the product ID + /metafields.json

May 4, 2021 - Hi, I need to get product meta-fields from the Admin /products.json API but it doesn’t return the meta-fields but I’m able to get products meta-fields from /products/123/metafields.json for a single product it would be …

If you’re subscribing to Shopify webhooks, you can include the metafield_namespaces: "customer_fields" parameter to receive our custom data within each request. You’ll be sent a webhook even when only the metafield changed. We also offer direct webhook subscriptions in addition to Shopify via our REST API.

August 1, 2024 - With GraphQL, you can perform bulk operations, which help retrieve more contextual data in fewer requests. For example, fetching metafields for multiple products in a single query significantly reduces the number of API calls. Before diving into complex queries, ensure you have the necessary access and setup to use Shopify’s GraphQL API.

For example, if you create a definition called "Ingredients" with type multi_line_text_field for products, then every product will enforce that type for its "Ingredients" metafield. ... When using the Admin API to read and write metafields, the value is always entered and stored as a string, regardless of type.

A metafield attached to a parent object.