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 • BooleanDefault: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

1const { admin } = await authenticate.admin(request);
2
3const response = await admin.graphql(
4  `#graphql
5  query {
6    metafields(first: 2, owner: "gid://shopify/Product/20995642") {
7      edges {
8        node {
9          namespace
10          key
11          value
12        }
13      }
14    }
15  }`,
16);
17
18const data = await response.json();
19

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

1{
2  "metafields": {
3    "edges": [
4      {
5        "node": {
6          "namespace": "my_fields",
7          "key": "materials",
8          "value": "95% Cotton/n 5% Spandex"
9        }
10      }
11    ]
12  }
13}