Choose a version:

metafields

query

A paginated list of metafields.

MetafieldConnection arguments

•MetafieldConnection!

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 firstfirst •Int: The first n elements from the paginated list.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to namespacenamespace •String: Filter metafields by namespace.
Anchor to ownerowner •ID! required: Filter metafields to a specific owner. Recommend using the metafields connection from HasMetafields directly from the owner instead.
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 •[MetafieldEdge!]! 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 •[Metafield!]! non-null: A list of nodes that are contained in MetafieldEdge. 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

Retrieve metafields belonging to a resource

Description

Retrieve all metafields belonging to a product. It's recommended to use the `metafields` connection from [HasMetafields](https://shopify.dev/api/admin/graphql/reference/common-objects/HasMetafields) directly from the owner instead. Refer to [this example instead](https://shopify.dev/api/admin/graphql/reference/common-objects/product#examples-Get_metafields_attached_to_a_product).

Query

query {
  metafields(first: 2, owner: "gid://shopify/Product/20995642") {
    edges {
      node {
        namespace
        key
        value
      }
    }
  }
}

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 { metafields(first: 2, owner: \"gid://shopify/Product/20995642\") { edges { node { namespace key value } } } }"
}'

Remix

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

const response = await admin.graphql(
  `#graphql
  query {
    metafields(first: 2, owner: "gid://shopify/Product/20995642") {
      edges {
        node {
          namespace
          key
          value
        }
      }
    }
  }`,
);

const data = await response.json();

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 {
    metafields(first: 2, owner: "gid://shopify/Product/20995642") {
      edges {
        node {
          namespace
          key
          value
        }
      }
    }
  }
QUERY

response = client.query(query: query)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query {
    metafields(first: 2, owner: "gid://shopify/Product/20995642") {
      edges {
        node {
          namespace
          key
          value
        }
      }
    }
  }`,
});

Response

{
  "metafields": {
    "edges": [
      {
        "node": {
          "namespace": "my_fields",
          "key": "materials",
          "value": "95% Cotton/n 5% Spandex"
        }
      }
    ]
  }
}

Retrieve metafields within a namespace

Description

Retrieve all metafields that are under the same namespace. It's recommended to use the `metafields` connection from [HasMetafields](https://shopify.dev/api/admin/graphql/reference/common-objects/HasMetafields) directly from the owner instead. Refer to [this example instead](https://shopify.dev/api/admin/graphql/reference/common-objects/product#examples-Get_metafields_attached_to_a_product).

Query

query {
  metafields(first: 2, owner: "gid://shopify/Product/20995642", namespace: "my_fields") {
    edges {
      node {
        namespace
        key
        value
      }
    }
  }
}

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 { metafields(first: 2, owner: \"gid://shopify/Product/20995642\", namespace: \"my_fields\") { edges { node { namespace key value } } } }"
}'

Remix

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

const response = await admin.graphql(
  `#graphql
  query {
    metafields(first: 2, owner: "gid://shopify/Product/20995642", namespace: "my_fields") {
      edges {
        node {
          namespace
          key
          value
        }
      }
    }
  }`,
);

const data = await response.json();

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 {
    metafields(first: 2, owner: "gid://shopify/Product/20995642", namespace: "my_fields") {
      edges {
        node {
          namespace
          key
          value
        }
      }
    }
  }
QUERY

response = client.query(query: query)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query {
    metafields(first: 2, owner: "gid://shopify/Product/20995642", namespace: "my_fields") {
      edges {
        node {
          namespace
          key
          value
        }
      }
    }
  }`,
});

Response

{
  "metafields": {
    "edges": [
      {
        "node": {
          "namespace": "my_fields",
          "key": "materials",
          "value": "95% Cotton\n5% Spandex"
        }
      },
      {
        "node": {
          "namespace": "my_fields",
          "key": "manufactured",
          "value": "Made in Canada"
        }
      }
    ]
  }
}

Examples

Open in GraphiQL

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

const response = await admin.graphql(

`#graphql

query {

metafields(first: 2, owner: "gid://shopify/Product/20995642") {

edges {

node {

namespace

key

value

}

}`,

);

const data = await response.json();

query {
  metafields(first: 2, owner: "gid://shopify/Product/20995642") {
    edges {
      node {
        namespace
        key
        value
      }
    }
  }
}

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 { metafields(first: 2, owner: \"gid://shopify/Product/20995642\") { edges { node { namespace key value } } } }"
}'

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

const response = await admin.graphql(
  `#graphql
  query {
    metafields(first: 2, owner: "gid://shopify/Product/20995642") {
      edges {
        node {
          namespace
          key
          value
        }
      }
    }
  }`,
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query {
    metafields(first: 2, owner: "gid://shopify/Product/20995642") {
      edges {
        node {
          namespace
          key
          value
        }
      }
    }
  }`,
});

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 {
    metafields(first: 2, owner: "gid://shopify/Product/20995642") {
      edges {
        node {
          namespace
          key
          value
        }
      }
    }
  }
QUERY

response = client.query(query: query)

Response

JSON

{

"metafields": {

"edges": [

{

"node": {

"namespace": "my_fields",

"key": "materials",

"value": "95% Cotton/n 5% Spandex"

}

]

}