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

ProductVariant

•

ProductVariant

Represents a product variant.

availableForSale• Boolean! non-null: Whether the product variant is available for sale.
barcode• String: The value of the barcode associated with the product.
compareAtPrice• Money: The compare-at price of the variant in the default shop currency.
contextualPricing• ProductVariantContextualPricing! non-null: The pricing that applies for a customer in a given context. As of API version 2025-04, only active markets are considered in the price resolution.
createdAt• DateTime! non-null: The date and time when the variant was created.
defaultCursor• String! non-null: A default cursor that returns the single next record, sorted ascending by ID.
deliveryProfile• DeliveryProfile: The delivery profile for the variant.
displayName• String! non-null: Display name of the variant, based on product's title + variant's title.
events • EventConnection! non-null: The paginated list of events associated with the host subject.
id• ID! non-null: A globally-unique ID.
image• Image: The featured image for the variant.
inventoryItem• InventoryItem! non-null: The inventory item, which is used to query for inventory information.
inventoryPolicy• ProductVariantInventoryPolicy! non-null: Whether customers are allowed to place an order for the product variant when it's out of stock.
inventoryQuantity• Int: The total sellable quantity of the variant.
legacyResourceId• UnsignedInt64! non-null: The ID of the corresponding resource in the REST Admin API.
media • MediaConnection! non-null: The media associated with the product variant.
metafield• Metafield: A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.
metafields • MetafieldConnection! non-null: A list of custom fields that a merchant associates with a Shopify resource.
position• Int! non-null: The order of the product variant in the list of product variants. The first position in the list is 1.
price• Money! non-null: The price of the product variant in the default shop currency.
product• Product! non-null: The product that this variant belongs to.
productVariantComponents • ProductVariantComponentConnection! non-null: A list of the product variant components.
requiresComponents• Boolean! non-null: Whether a product variant requires components. The default value is false. If true, then the product variant can only be purchased as a parent bundle with components and it will be omitted from channels that don't support bundles.
selectedOptions• [SelectedOption!]! non-null: List of product options applied to the variant.
sellableOnlineQuantity• Int! non-null: The total sellable quantity of the variant for online channels. This doesn't represent the total available inventory or capture limitations based on customer location.
sellingPlanGroups • SellingPlanGroupConnection! non-null: A list of all selling plan groups defined in the current shop associated with the product variant.
sellingPlanGroupsCount• Count: Count of selling plan groups associated with the product variant.
sku• String: A case-sensitive identifier for the product variant in the shop. Required in order to connect to a fulfillment service.
taxable• Boolean! non-null: Whether a tax is charged when the product variant is sold.
taxCode• String: The tax code for the product variant.
title• String! non-null: The title of the product variant.
translations• [Translation!]! non-null: The published translations associated with the resource.
unitPriceMeasurement• UnitPriceMeasurement: The unit price measurement for the variant.
updatedAt• DateTime! non-null: The date and time (ISO 8601 format) when the product variant was last modified.
metafieldDefinitions • MetafieldDefinitionConnection! non-nullDeprecated: List of metafield definitions. This field will be removed in a future version. Use the root metafieldDefinitions field instead.
presentmentPrices • ProductVariantPricePairConnection! non-nullDeprecated: List of prices and compare-at prices in the presentment currencies for this shop. Use contextualPricing instead.
privateMetafield• PrivateMetafield Deprecated: Returns a private metafield by namespace and key that belongs to the resource. Metafields created using a reserved namespace are private by default. See our guide for migrating private metafields.
privateMetafields • PrivateMetafieldConnection! non-nullDeprecated: List of private metafields that belong to the resource. Metafields created using a reserved namespace are private by default. See our guide for migrating private metafields.
sellingPlanGroupCount• Int! non-nullDeprecated: Count of selling plan groups associated with the product variant. Use sellingPlanGroupsCount instead.
storefrontId• StorefrontID! non-nullDeprecated: The Storefront GraphQL API ID of the ProductVariant.

As of the 2022-04 version release, the Storefront GraphQL API will no longer return Base64 encoded IDs to match the behavior of the Admin GraphQL API. Therefore, you can safely use the id field's value instead. Use id instead.

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-10/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"

}