Choose a version:

productVariant

query

Returns a ProductVariant resource by ID.

Arguments

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

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to ProductVariantProductVariant • ProductVariant: Represents a product variant.

Was this section helpful?

Get a metafield attached to a product variant
Get metafields attached to a product variant
Get pinned metafield definitions associated with a product variant
Get the price for a product variant for buyers in Canada
Get the price for a product variant for different countries in the same request
Receive a single Product Variant
Retrieve information for non-existent variant ID

Examples

Open in GraphiQL

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

const response = await admin.graphql(

`#graphql

query ProductVariantMetafield($namespace: String!, $key: String!, $ownerId: ID!) {

productVariant(id: $ownerId) {

linerMaterial: metafield(namespace: $namespace, key: $key) {

value

}

}`,

{

variables: {

"namespace": "my_fields",

"key": "liner_material",

"ownerId": "gid://shopify/ProductVariant/43729076"

);

const data = await response.json();

query ProductVariantMetafield($namespace: String!, $key: String!, $ownerId: ID!) {
  productVariant(id: $ownerId) {
    linerMaterial: metafield(namespace: $namespace, key: $key) {
      value
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query ProductVariantMetafield($namespace: String!, $key: String!, $ownerId: ID!) { productVariant(id: $ownerId) { linerMaterial: metafield(namespace: $namespace, key: $key) { value } } }",
 "variables": {
    "namespace": "my_fields",
    "key": "liner_material",
    "ownerId": "gid://shopify/ProductVariant/43729076"
  }
}'

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

const response = await admin.graphql(
  `#graphql
  query ProductVariantMetafield($namespace: String!, $key: String!, $ownerId: ID!) {
    productVariant(id: $ownerId) {
      linerMaterial: metafield(namespace: $namespace, key: $key) {
        value
      }
    }
  }`,
  {
    variables: {
      "namespace": "my_fields",
      "key": "liner_material",
      "ownerId": "gid://shopify/ProductVariant/43729076"
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `query ProductVariantMetafield($namespace: String!, $key: String!, $ownerId: ID!) {
      productVariant(id: $ownerId) {
        linerMaterial: metafield(namespace: $namespace, key: $key) {
          value
        }
      }
    }`,
    "variables": {
      "namespace": "my_fields",
      "key": "liner_material",
      "ownerId": "gid://shopify/ProductVariant/43729076"
    },
  },
});

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 ProductVariantMetafield($namespace: String!, $key: String!, $ownerId: ID!) {
    productVariant(id: $ownerId) {
      linerMaterial: metafield(namespace: $namespace, key: $key) {
        value
      }
    }
  }
QUERY

variables = {
  "namespace": "my_fields",
  "key": "liner_material",
  "ownerId": "gid://shopify/ProductVariant/43729076"
}

response = client.query(query: query, variables: variables)

Input variables

JSON

{

"namespace": "my_fields",

"key": "liner_material",

"ownerId": "gid://shopify/ProductVariant/43729076"

}

Response

JSON

{

"productVariant": {

"linerMaterial": {

"value": "synthetic leather"

}