Choose a version:

privateMetafield

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 private metafield by ID. Private metafields are accessible only by the application that created them.

Arguments

Anchor to idid •ID! required: The ID of the PrivateMetafield to return.

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to PrivateMetafieldPrivateMetafield •PrivateMetafield: Private metafields represent custom metadata that is attached to a resource. Private metafields are accessible only by the application that created them and only from the GraphQL Admin API.

An application can create a maximum of 10 private metafields per shop resource.

Private metafields are deprecated. Metafields created using a reserved namespace are private by default. See our guide for migrating private metafields.

Was this section helpful?

Examples

Retrieve a private metafield by its ID

Description

To retrieve a single private metafield, use the `privateMetafield` query. The following example shows how to retrieve the private metafield owned by an `Order` resource.

Query

query {
  privateMetafield(id: "gid://shopify/PrivateMetafield/1060470840") {
    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 { privateMetafield(id: \"gid://shopify/PrivateMetafield/1060470840\") { id key namespace value } }"
}'

Remix

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

const response = await admin.graphql(
  `#graphql
  query {
    privateMetafield(id: "gid://shopify/PrivateMetafield/1060470840") {
      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 {
    privateMetafield(id: "gid://shopify/PrivateMetafield/1060470840") {
      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 {
    privateMetafield(id: "gid://shopify/PrivateMetafield/1060470840") {
      id
      key
      namespace
      value
    }
  }`,
});

Response

{
  "privateMetafield": {
    "id": "gid://shopify/PrivateMetafield/1060470840",
    "key": "buyer",
    "namespace": "notes",
    "value": "Notes about this buyer"
  }
}

Retrieve a private metafield by its ID

Open in GraphiQL

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

const response = await admin.graphql(

`#graphql

query {

privateMetafield(id: "gid://shopify/PrivateMetafield/1060470840") {

key

namespace

value

}

}`,

);

const data = await response.json();

query {
  privateMetafield(id: "gid://shopify/PrivateMetafield/1060470840") {
    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 { privateMetafield(id: \"gid://shopify/PrivateMetafield/1060470840\") { id key namespace value } }"
}'

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

const response = await admin.graphql(
  `#graphql
  query {
    privateMetafield(id: "gid://shopify/PrivateMetafield/1060470840") {
      id
      key
      namespace
      value
    }
  }`,
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query {
    privateMetafield(id: "gid://shopify/PrivateMetafield/1060470840") {
      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 {
    privateMetafield(id: "gid://shopify/PrivateMetafield/1060470840") {
      id
      key
      namespace
      value
    }
  }
QUERY

response = client.query(query: query)

Response

JSON

{

"privateMetafield": {

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

"key": "buyer",

"namespace": "notes",

"value": "Notes about this buyer"

}