Choose a version:

privateMetafields

query

Deprecated.

Metafields created using a reserved namespace are private by default. See our guide for migrating private metafields. This will be removed in 2025-01.

Returns a list of private metafields associated to a resource.

PrivateMetafieldConnection arguments

•PrivateMetafieldConnection!

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 the private metafields by namespace.
Anchor to ownerowner •ID! required: Retrieve the private metafields of a certain resource, specified by the resource ID.
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 •[PrivateMetafieldEdge!]! 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 •[PrivateMetafield!]! non-null: A list of nodes that are contained in PrivateMetafieldEdge. 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 a list of private metafields

Description

To retrieve a list of private metafields associdated to a resource, use the `privateMetafields` query. The following example shows how to retrieve the private metafields associated to an `Order`.

Query

query {
  privateMetafields(owner: "gid://shopify/Order/148977776", first: 2) {
    edges {
      node {
        id
        key
        namespace
        value
      }
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query { privateMetafields(owner: \"gid://shopify/Order/148977776\", first: 2) { edges { node { id key namespace value } } } }"
}'

Remix

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

const response = await admin.graphql(
  `#graphql
  query {
    privateMetafields(owner: "gid://shopify/Order/148977776", first: 2) {
      edges {
        node {
          id
          key
          namespace
          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 {
    privateMetafields(owner: "gid://shopify/Order/148977776", first: 2) {
      edges {
        node {
          id
          key
          namespace
          value
        }
      }
    }
  }
QUERY

response = client.query(query: query)

Node.js

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

Response

{
  "privateMetafields": {
    "edges": [
      {
        "node": {
          "id": "gid://shopify/PrivateMetafield/1060470842",
          "key": "buyer",
          "namespace": "notes",
          "value": "Notes about this buyer"
        }
      },
      {
        "node": {
          "id": "gid://shopify/PrivateMetafield/1060470843",
          "key": "reviews",
          "namespace": "feedback",
          "value": "Feedback about the order"
        }
      }
    ]
  }
}

Retrieve a list of private metafields from the Shop resource

Description

To retrieve a list of private metafields associdated to a resource, use the `privateMetafields` query. The following example shows how to retrieve the private metafields associated to the `Shop`.

Query

query {
  shop {
    name
    privateMetafields(first: 2) {
      edges {
        node {
          id
          key
          namespace
          value
        }
      }
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query { shop { name privateMetafields(first: 2) { edges { node { id key namespace value } } } } }"
}'

Remix

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

const response = await admin.graphql(
  `#graphql
  query {
    shop {
      name
      privateMetafields(first: 2) {
        edges {
          node {
            id
            key
            namespace
            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 {
    shop {
      name
      privateMetafields(first: 2) {
        edges {
          node {
            id
            key
            namespace
            value
          }
        }
      }
    }
  }
QUERY

response = client.query(query: query)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query {
    shop {
      name
      privateMetafields(first: 2) {
        edges {
          node {
            id
            key
            namespace
            value
          }
        }
      }
    }
  }`,
});

Response

{
  "shop": {
    "name": "John Smith Test Store",
    "privateMetafields": {
      "edges": [
        {
          "node": {
            "id": "gid://shopify/PrivateMetafield/769645494",
            "key": "test_key",
            "namespace": "nested_namespace",
            "value": "this is a test value"
          }
        },
        {
          "node": {
            "id": "gid://shopify/PrivateMetafield/1060470841",
            "key": "fantastic_app",
            "namespace": "private_keys",
            "value": "TA432RZ"
          }
        }
      ]
    }
  }
}

Examples

Open in GraphiQL

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

const response = await admin.graphql(

`#graphql

query {

privateMetafields(owner: "gid://shopify/Order/148977776", first: 2) {

edges {

node {

key

namespace

value

}

}`,

);

const data = await response.json();

query {
  privateMetafields(owner: "gid://shopify/Order/148977776", first: 2) {
    edges {
      node {
        id
        key
        namespace
        value
      }
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query { privateMetafields(owner: \"gid://shopify/Order/148977776\", first: 2) { edges { node { id key namespace value } } } }"
}'

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

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

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query {
    privateMetafields(owner: "gid://shopify/Order/148977776", first: 2) {
      edges {
        node {
          id
          key
          namespace
          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 {
    privateMetafields(owner: "gid://shopify/Order/148977776", first: 2) {
      edges {
        node {
          id
          key
          namespace
          value
        }
      }
    }
  }
QUERY

response = client.query(query: query)

Response

JSON

{

"privateMetafields": {

"edges": [

{

"node": {

"id": "gid://shopify/PrivateMetafield/1060470842",

"key": "buyer",

"namespace": "notes",

"value": "Notes about this buyer"

}

{

"node": {

"id": "gid://shopify/PrivateMetafield/1060470843",

"key": "reviews",

"namespace": "feedback",

"value": "Feedback about the order"

}

]

}