privateMetafields

queryDeprecated

Returns a list of private metafields associated to a resource. Metafields created using a reserved namespace are private by default. See our guide for migrating private metafields.

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

Retrieve a list of private metafields
Retrieve a list of private metafields from the Shop resource

Examples

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

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

1{
2  "privateMetafields": {
3    "edges": [
4      {
5        "node": {
6          "id": "gid://shopify/PrivateMetafield/1060470842",
7          "key": "buyer",
8          "namespace": "notes",
9          "value": "Notes about this buyer"
10        }
11      },
12      {
13        "node": {
14          "id": "gid://shopify/PrivateMetafield/1060470843",
15          "key": "reviews",
16          "namespace": "feedback",
17          "value": "Feedback about the order"
18        }
19      }
20    ]
21  }
22}