Choose a version:

Anchor to standardMetafieldDefinitionTemplates

standardMetafieldDefinitionTemplates

query

Retrieves preset metafield definition templates for common use cases. Each template provides a reserved namespace and key combination for specific purposes like product subtitles, care guides, or ISBN numbers. Use these templates to create standardized metafields across your store. Filter templates by constraint status or exclude those you've already activated.

See the list of standard metafield definitions for available templates.

Anchor to Arguments

StandardMetafieldDefinitionTemplateConnection arguments

•StandardMetafieldDefinitionTemplateConnection!

Anchor to afterafter

•String

The elements that come after the specified cursor.

Anchor to beforebefore

•String

The elements that come before the specified cursor.

Anchor to constraintStatusconstraintStatus

•MetafieldDefinitionConstraintStatus

Filter standard metafield definitions based on whether they are constrained.

Anchor to constraintSubtypeconstraintSubtype

•MetafieldDefinitionConstraintSubtypeIdentifier

Filter standard metafield definitions based on whether they apply to a given resource subtype.

Anchor to excludeActivatedexcludeActivated

•Boolean

Default:false

Filter standard metafield definitions that have already been activated.

Anchor to firstfirst

•Int

The first n elements from the paginated list.

Anchor to lastlast

•Int

The last n elements from the paginated list.

Anchor to reversereverse

•Boolean

Default:false

Reverse the order of the underlying list.

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to edgesedges •[StandardMetafieldDefinitionTemplateEdge!]! non-null: The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node.
Anchor to nodesnodes •[StandardMetafieldDefinitionTemplate!]! non-null: A list of nodes that are contained in StandardMetafieldDefinitionTemplateEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve.
Anchor to pageInfopageInfo •PageInfo! non-null: An object that’s used to retrieve cursor information about the current page.

Was this section helpful?

Examples

Get a list of standard metafield definition templates

Description

The following query retrieves the first 5 standard metafield definition templates.

Query

query StandardMetafieldDefinitionTemplates {
  standardMetafieldDefinitionTemplates(first: 5) {
    edges {
      node {
        id
        name
        namespace
        key
        description
        ownerTypes
        type {
          name
        }
      }
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query StandardMetafieldDefinitionTemplates { standardMetafieldDefinitionTemplates(first: 5) { edges { node { id name namespace key description ownerTypes type { name } } } } }"
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  query StandardMetafieldDefinitionTemplates {
    standardMetafieldDefinitionTemplates(first: 5) {
      edges {
        node {
          id
          name
          namespace
          key
          description
          ownerTypes
          type {
            name
          }
        }
      }
    }
  }`,
  );
  const json = await response.json();
  return json.data;
}

Ruby

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  query StandardMetafieldDefinitionTemplates {
    standardMetafieldDefinitionTemplates(first: 5) {
      edges {
        node {
          id
          name
          namespace
          key
          description
          ownerTypes
          type {
            name
          }
        }
      }
    }
  }
QUERY

response = client.query(query: query)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query StandardMetafieldDefinitionTemplates {
    standardMetafieldDefinitionTemplates(first: 5) {
      edges {
        node {
          id
          name
          namespace
          key
          description
          ownerTypes
          type {
            name
          }
        }
      }
    }
  }`,
});

Response

{
  "standardMetafieldDefinitionTemplates": {
    "edges": [
      {
        "node": {
          "id": "gid://shopify/StandardMetafieldDefinitionTemplate/1",
          "name": "Product subtitle",
          "namespace": "descriptors",
          "key": "subtitle",
          "description": "Used as a shorthand for a product name",
          "ownerTypes": [
            "PRODUCT",
            "PRODUCTVARIANT"
          ],
          "type": {
            "name": "single_line_text_field"
          }
        }
      },
      {
        "node": {
          "id": "gid://shopify/StandardMetafieldDefinitionTemplate/2",
          "name": "Care guide",
          "namespace": "descriptors",
          "key": "care_guide",
          "description": "Instructions for taking care of a product or apparel",
          "ownerTypes": [
            "PRODUCT",
            "PRODUCTVARIANT"
          ],
          "type": {
            "name": "multi_line_text_field"
          }
        }
      },
      {
        "node": {
          "id": "gid://shopify/StandardMetafieldDefinitionTemplate/3",
          "name": "ISBN",
          "namespace": "facts",
          "key": "isbn",
          "description": "International Standard Book Number",
          "ownerTypes": [
            "PRODUCT",
            "PRODUCTVARIANT"
          ],
          "type": {
            "name": "single_line_text_field"
          }
        }
      },
      {
        "node": {
          "id": "gid://shopify/StandardMetafieldDefinitionTemplate/4",
          "name": "UPC",
          "namespace": "facts",
          "key": "upc",
          "description": "Universal Product Code",
          "ownerTypes": [
            "PRODUCT",
            "PRODUCTVARIANT"
          ],
          "type": {
            "name": "single_line_text_field"
          }
        }
      },
      {
        "node": {
          "id": "gid://shopify/StandardMetafieldDefinitionTemplate/5",
          "name": "EAN",
          "namespace": "facts",
          "key": "ean",
          "description": "European Article Number",
          "ownerTypes": [
            "PRODUCT",
            "PRODUCTVARIANT"
          ],
          "type": {
            "name": "single_line_text_field"
          }
        }
      }
    ]
  }
}

Get a list of standard metafield definition templates

Open in GraphiQL

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(

`#graphql

query StandardMetafieldDefinitionTemplates {

standardMetafieldDefinitionTemplates(first: 5) {

edges {

node {

name

namespace

key

description

ownerTypes

type {

name

}

}`,

);

const json = await response.json();

return json.data;

}

GQL

query StandardMetafieldDefinitionTemplates {
  standardMetafieldDefinitionTemplates(first: 5) {
    edges {
      node {
        id
        name
        namespace
        key
        description
        ownerTypes
        type {
          name
        }
      }
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query StandardMetafieldDefinitionTemplates { standardMetafieldDefinitionTemplates(first: 5) { edges { node { id name namespace key description ownerTypes type { name } } } } }"
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  query StandardMetafieldDefinitionTemplates {
    standardMetafieldDefinitionTemplates(first: 5) {
      edges {
        node {
          id
          name
          namespace
          key
          description
          ownerTypes
          type {
            name
          }
        }
      }
    }
  }`,
  );
  const json = await response.json();
  return json.data;
}

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query StandardMetafieldDefinitionTemplates {
    standardMetafieldDefinitionTemplates(first: 5) {
      edges {
        node {
          id
          name
          namespace
          key
          description
          ownerTypes
          type {
            name
          }
        }
      }
    }
  }`,
});

Ruby

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  query StandardMetafieldDefinitionTemplates {
    standardMetafieldDefinitionTemplates(first: 5) {
      edges {
        node {
          id
          name
          namespace
          key
          description
          ownerTypes
          type {
            name
          }
        }
      }
    }
  }
QUERY

response = client.query(query: query)

Response

JSON

{

"standardMetafieldDefinitionTemplates": {

"edges": [

{

"node": {

"id": "gid://shopify/StandardMetafieldDefinitionTemplate/1",

"name": "Product subtitle",

"namespace": "descriptors",

"key": "subtitle",

"description": "Used as a shorthand for a product name",

"ownerTypes": [

"PRODUCT",

"PRODUCTVARIANT"

"type": {

"name": "single_line_text_field"

}

{

"node": {

"id": "gid://shopify/StandardMetafieldDefinitionTemplate/2",

"name": "Care guide",

"namespace": "descriptors",

"key": "care_guide",

"description": "Instructions for taking care of a product or apparel",

"ownerTypes": [

"PRODUCT",

"PRODUCTVARIANT"

"type": {

"name": "multi_line_text_field"

}

{

"node": {

"id": "gid://shopify/StandardMetafieldDefinitionTemplate/3",

"name": "ISBN",

"namespace": "facts",

"key": "isbn",

"description": "International Standard Book Number",

"ownerTypes": [

"PRODUCT",

"PRODUCTVARIANT"

"type": {

"name": "single_line_text_field"

}

{

"node": {

"id": "gid://shopify/StandardMetafieldDefinitionTemplate/4",

"name": "UPC",

"namespace": "facts",

"key": "upc",

"description": "Universal Product Code",

"ownerTypes": [

"PRODUCT",

"PRODUCTVARIANT"

"type": {

"name": "single_line_text_field"

}

{

"node": {

"id": "gid://shopify/StandardMetafieldDefinitionTemplate/5",

"name": "EAN",

"namespace": "facts",

"key": "ean",

"description": "European Article Number",

"ownerTypes": [

"PRODUCT",

"PRODUCTVARIANT"

"type": {

"name": "single_line_text_field"

}

]

}