Choose a version:

productVariant

query

Retrieves a product variant by its ID.

A product variant is a specific version of a product that comes in more than one option, such as size or color. For example, if a merchant sells t-shirts with options for size and color, then a small, blue t-shirt would be one product variant and a large, blue t-shirt would be another.

Use the productVariant query when you need to:

Access essential product variant data (for example, title, price, image, and metafields).
Build product detail pages and manage inventory.
Handle international sales with localized pricing and content.
Manage product variants that are part of a bundle or selling plan.

Learn more about working with Shopify's product model.

Anchor to Arguments

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

The ProductVariant object represents a version of a product that comes in more than one option, such as size or color. For example, if a merchant sells t-shirts with options for size and color, then a small, blue t-shirt would be one product variant and a large, blue t-shirt would be another.

Use the ProductVariant object to manage the full lifecycle and configuration of a product's variants. Common use cases for using the ProductVariant object include:

Tracking inventory for each variant
Setting unique prices for each variant
Assigning barcodes and SKUs to connect variants to fulfillment services
Attaching variant-specific images and media
Setting delivery and tax requirements
Supporting product bundles, subscriptions, and selling plans

A ProductVariant is associated with a parent Product object. ProductVariant serves as the central link between a product's merchandising configuration, inventory, pricing, fulfillment, and sales channels within the GraphQL Admin API schema. Each variant can reference other GraphQL types such as:

InventoryItem: Used for inventory tracking
Image: Used for variant-specific images
SellingPlanGroup: Used for subscriptions and selling plans

Learn more about Shopify's product model.

Anchor to availableForSaleavailableForSale

•Boolean!

non-null

Whether the product variant is available for sale.

Anchor to barcodebarcode

•String

The value of the barcode associated with the product.

Anchor to compareAtPricecompareAtPrice

•Money

The compare-at price of the variant in the default shop currency.

Anchor to contextualPricingcontextualPricing

•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.

Arguments

Anchor to contextcontext

•ContextualPricingContext!

required

The context used to generate contextual pricing for the variant.

Anchor to createdAtcreatedAt

•DateTime!

non-null

The date and time when the variant was created.

Anchor to defaultCursordefaultCursor

•String!

non-null

A default cursor that returns the single next record, sorted ascending by ID.

Anchor to deliveryProfiledeliveryProfile

•DeliveryProfile

The delivery profile for the variant.

Anchor to displayNamedisplayName

•String!

non-null

Display name of the variant, based on product's title + variant's title.

Anchor to eventsevents

•EventConnection!

non-null

The paginated list of events associated with the host subject.

Arguments

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 queryquery

•String

Anchor to action •string: The action that occured.

Anchor to reversereverse

•Boolean

Default:false

Reverse the order of the underlying list.

Anchor to sortKeysortKey

•EventSortKeys

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

Anchor to idid

•ID!

non-null

A globally-unique ID.

Anchor to inventoryIteminventoryItem

•InventoryItem!

non-null

The inventory item, which is used to query for inventory information.

Anchor to inventoryPolicyinventoryPolicy

•ProductVariantInventoryPolicy!

non-null

Whether customers are allowed to place an order for the product variant when it's out of stock.

Anchor to inventoryQuantityinventoryQuantity

•Int

The total sellable quantity of the variant.

Anchor to legacyResourceIdlegacyResourceId

•UnsignedInt64!

non-null

The ID of the corresponding resource in the REST Admin API.

Anchor to mediamedia

•MediaConnection!

non-null

The media associated with the product variant.

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 reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to metafieldmetafield

•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.

Anchor to keykey •String! required: The key for the metafield.
Anchor to namespacenamespace •String: The container the metafield belongs to. If omitted, the app-reserved namespace will be used.

Anchor to metafieldsmetafields

•MetafieldConnection!

non-null

A list of custom fields that a merchant associates with a Shopify resource.

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 keyskeys •[String!]: List of keys of metafields in the format namespace.key, will be returned in the same format.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to namespacenamespace •String: The metafield namespace to filter by. If omitted, all metafields are returned.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to positionposition

•Int!

non-null

The order of the product variant in the list of product variants. The first position in the list is 1.

Anchor to priceprice

•Money!

non-null

The price of the product variant in the default shop currency.

Anchor to productproduct

•Product!

non-null

The product that this variant belongs to.

Anchor to productParentsproductParents

•ProductConnection!

non-null

A list of products that have product variants that contain this variant as a product component.

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 queryquery •String: A filter made up of terms, connectives, modifiers, and comparators.

name type description acceptable_values default_value example_use
default string Filter by a case-insensitive search of multiple fields
in a document. - query=Bob Norman
- query=title:green hoodie
barcode string Filter by the product variant barcode
field. - barcode:ABC-abc-1234
bundles boolean Filter by a [product
bundle](https://shopify.dev/docs/apps/build/product-merchandising/bundles).
A product bundle is a set of two or more related products, which are
commonly offered at a discount. - bundles:true
category_id string Filter by the product category ID
(product.category.id). A product category is the category of a product
from Shopify's Standard Product Taxonomy.
- category_id:sg-4-17-2-17
collection_id id Filter by the collection id
field. - collection_id:108179161409
combined_listing_role string Filter by the role of the product in a combined listing.
- parent
- child
- no_role -
combined_listing_role:parent
created_at time Filter by the date and time when the product was
created. - created_at:>'2020-10-21T23:39:20Z'
-
created_at:<now
- created_at:<='2024'
delivery_profile_id id Filter by the delivery profile id
field. - delivery_profile_id:108179161409
error_feedback string Filter by products with publishing errors.
gift_card boolean Filter by the product isGiftCard
field. - gift_card:true
handle string Filter by a comma-separated list of product handles.
- handle:the-minimal-snowboard
has_only_composites boolean Filter by products that have only
composite variants. - has_only_composites:true
has_only_default_variant boolean Filter by products that have only a
default variant. A default variant is the only variant if no other variants
are specified. - has_only_default_variant:true
has_variant_with_components boolean Filter by products that have
variants with associated components. -
has_variant_with_components:true
id id Filter by id range. - id:1234
- id:>=1234
- id:<=1234
inventory_total integer Filter by inventory count. -
inventory_total:0
- inventory_total:>150
-
inventory_total:>=200
is_price_reduced boolean Filter by products that have a reduced price.
For more information, refer to the CollectionRule
object. - is_price_reduced:true
metafields.{namespace}.{key} mixed Filters resources by metafield
value. Format: metafields.{namespace}.{key}:{value}. Learn more about
querying by metafield value.
- metafields.custom.on_sale:true
-
metafields.product.material:"gid://shopify/Metaobject/43458085"
out_of_stock_somewhere boolean Filter by products that are out of
stock in at least one location. - out_of_stock_somewhere:true
price bigdecimal Filter by the product variant price
field. - price:100.57
product_configuration_owner string Filter by the app
id
field. - product_configuration_owner:10001
product_publication_status string Filter by channel approval process
status of the resource on a channel, such as the online store. The value is
a composite of the channel app ID
(Channel.app.id) and one of the valid values. For simple visibility checks, use published_status
instead. - * {channel_app_id}-approved
- `*
{channel_app_id}-rejected<br/> - * {channel_app_id}-needs_action`
-
* {channel_app_id}-awaiting_review
- `*
{channel_app_id}-published<br/> - * {channel_app_id}-demoted<br/> - *
{channel_app_id}-scheduled<br/> - *
{channel_app_id}-provisionally_published` -
product_publication_status:189769876-approved
product_type string Filter by a comma-separated list of [product
types](https://help.shopify.com/manual/products/details/product-type).

product_type:snowboard | | publication_ids | string | Filter by a comma-separated list of publication IDs that are associated with the product. | | | - publication_ids:184111530305,184111694145 | | publishable_status | string | Deprecated: This parameter is deprecated as of 2025-12 and will be removed in a future API version. Use published_status for visibility checks. Filter by the publishable status of the resource on a channel. The value is a composite of the channel app ID (Channel.app.id) and one of the valid status values. | - * {channel_app_id}-unset
- * {channel_app_id}-pending
- * {channel_app_id}-approved
- * {channel_app_id}-not_approved | | - publishable_status:580111-unset
- publishable_status:580111-pending | | published_at | time | Filter by the date and time when the product was published to the online store and other sales channels. | | | - published_at:>2020-10-21T23:39:20Z
- published_at:<now
- published_at:<=2024 | | published_status | string | Filter resources by their visibility and publication state on a channel. Online store channel filtering: - online_store_channel: Returns all resources in the online store channel, regardless of publication status. - published/visible: Returns resources that are published to the online store. - unpublished: Returns resources that are not published to the online store. Channel-specific filtering using a channel ID, channel handle, channel app ID (Channel.app.id), or app handle with suffixes: - {id_or_handle}-published: Returns resources published to the specified channel. - {id_or_handle}-visible: Same as {id_or_handle}-published (kept for backwards compatibility). - {id_or_handle}-intended: Returns resources added to the channel but not yet published. - {id_or_handle}-hidden: Returns resources not added to the channel or not published. Other: - unavailable: Returns resources not published to any channel. | - online_store_channel
- published
- visible

unpublished
- * {channel_id_or_handle}-published
- * {channel_id_or_handle}-visible
- * {channel_id_or_handle}-intended
- * {channel_id_or_handle}-hidden
- * {channel_app_id_or_handle}-published
- * {channel_app_id_or_handle}-visible
- * {channel_app_id_or_handle}-intended
- * {channel_app_id_or_handle}-hidden
- unavailable | | - published_status:online_store_channel
- published_status:published
- published_status:580111-published

published_status:580111-hidden
- published_status:my-channel-handle-published
- published_status:unavailable | | sku | string | Filter by the product variant sku field. Learn more about SKUs. | | | - sku:XYZ-12345 | | status | string | Filter by a comma-separated list of statuses. You can use statuses to manage inventory. Shopify only displays products with an ACTIVE status in online stores, sales channels, and apps. | - active
- archived
- draft | active | - status:active,draft | | tag | string | Filter objects by the tag field. | | | - tag:my_tag | | tag_not | string | Filter by objects that don’t have the specified tag. | | | - tag_not:my_tag | | title | string | Filter by the product title field. | | | - title:The Minimal Snowboard | | tracks_inventory | boolean | Filter by products that have inventory tracking enabled. | | | - tracks_inventory:true | | updated_at | time | Filter by the date and time when the product was last updated. | | | - updated_at:>'2020-10-21T23:39:20Z'
- updated_at:<now
- updated_at:<='2024' | | variant_id | id | Filter by the product variant id field. | | | - variant_id:45779434701121 | | variant_title | string | Filter by the product variant title field. | | | - variant_title:'Special ski wax' | | vendor | string | Filter by the origin or source of the product. Learn more about vendors and managing vendor information. | | | - vendor:Snowdevil
- vendor:Snowdevil OR vendor:Icedevil | You can apply one or more filters to a query. Learn more about Shopify API search syntax.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to productVariantComponentsproductVariantComponents

•ProductVariantComponentConnection!

non-null

A list of the product variant components.

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 reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to requiresComponentsrequiresComponents

•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.

Anchor to selectedOptionsselectedOptions

•[SelectedOption!]!

non-null

List of product options applied to the variant.

Anchor to sellableOnlineQuantitysellableOnlineQuantity

•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.

Anchor to sellingPlanGroupssellingPlanGroups

•SellingPlanGroupConnection!

non-null

A list of all selling plan groups defined in the current shop associated with the product variant.

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 reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to sellingPlanGroupsCountsellingPlanGroupsCount

•Count

Count of selling plan groups associated with the product variant.

Anchor to showUnitPriceshowUnitPrice

•Boolean!

non-null

Whether to show the unit price for this product variant.

Anchor to skusku

•String

A case-sensitive identifier for the product variant in the shop. Required in order to connect to a fulfillment service.

Anchor to taxabletaxable

•Boolean!

non-null

Whether a tax is charged when the product variant is sold.

Anchor to titletitle

•String!

non-null

The title of the product variant.

Anchor to translationstranslations

•[Translation!]!

non-null

The published translations associated with the resource.

Anchor to localelocale •String! required: Filters translations locale.
Anchor to marketIdmarketId •ID: Filters translations by market ID. Use this argument to retrieve content specific to a market.

Anchor to unitPriceunitPrice

•MoneyV2

The unit price value for the variant based on the variant measurement.

Anchor to unitPriceMeasurementunitPriceMeasurement

•UnitPriceMeasurement

The unit price measurement for the variant.

Anchor to updatedAtupdatedAt

•DateTime!

non-null

The date and time (ISO 8601 format) when the product variant was last modified.

Anchor to imageimage

•Image

Deprecated

Arguments

Anchor to cropcrop

•CropRegion

Deprecated

Anchor to maxHeightmaxHeight

•Int

Deprecated

Anchor to maxWidthmaxWidth

•Int

Deprecated

Anchor to scalescale

•Int

DeprecatedDefault:1

Anchor to metafieldDefinitionsmetafieldDefinitions

•MetafieldDefinitionConnection!

non-nullDeprecated

Arguments

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 metafield definitions by namespace.

Anchor to pinnedStatuspinnedStatus

•MetafieldDefinitionPinnedStatus

Default:ANY

Filter by the definition's pinned status.

Anchor to queryquery

•String

A filter made up of terms, connectives, modifiers, and comparators.

name	type	description	acceptable_values	example_use
default	string	Filter by a case-insensitive search of multiple fields
in a document.			- `query=Bob Norman` - `query=title:green hoodie`
created_at	time	Filter by the date and time when the metafield
definition was created.			- `created_at:>2020-10-21T23:39:20Z` -
`created_at:<now` - `created_at:<=2024`
id	id	Filter by `id` range.		- `id:1234` - `id:>=1234` - `id:<=1234`
key	string	Filter by the metafield definition `key`
field.			- `key:some-key`
namespace	string	Filter by the metafield definition `namespace`
field.			- `namespace:some-namespace`
owner_type	string	Filter by the metafield definition `ownerType`
field.			- `owner_type:PRODUCT`
type	string	Filter by the metafield definition `type`
field.			- `type:single_line_text_field`
updated_at	time	Filter by the date and time when the metafield
definition was last updated.			- `updated_at:>2020-10-21T23:39:20Z`

updated_at:<now
- updated_at:<=2024 | You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to reversereverse

•Boolean

Default:false

Reverse the order of the underlying list.

Anchor to sortKeysortKey

•MetafieldDefinitionSortKeys

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

Anchor to presentmentPricespresentmentPrices

•ProductVariantPricePairConnection!

non-nullDeprecated

Arguments

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 presentmentCurrenciespresentmentCurrencies

•[CurrencyCode!]

The presentment currencies prices should return in.

Anchor to reversereverse

•Boolean

Default:false

Reverse the order of the underlying list.

Anchor to sellingPlanGroupCountsellingPlanGroupCount

•Int!

non-nullDeprecated

Anchor to storefrontIdstorefrontId

•StorefrontID!

non-nullDeprecated

Anchor to taxCodetaxCode

•String

Deprecated

Was this section helpful?

Examples

Retrieve a metafield associated with a product variant

Description

Get the [metafield](https://shopify.dev/docs/apps/build/custom-data) value identified by `my_fields.liner_material` on a specific product variant.

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"
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2026-04/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"
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  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 json = await response.json();
  return json.data;
}

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 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)

Node.js

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"
    },
  },
});

Shopify CLI

shopify app execute \
--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"
}'

Direct API Access

const response = await fetch('shopify:admin/api/2026-04/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    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 { data } = await response.json();
console.log(data);

Response

{
  "productVariant": {
    "linerMaterial": {
      "value": "synthetic leather"
    }
  }
}

Retrieve a product variant's price for buyers in Canada

Description

Use the `contextualPricing` field to retrieve a product variant's price for buyers in Canada. Prices are returned in the currency configured for the country in [Markets settings](https://help.shopify.com/manual/international/managing). They might be calculated from the base variant prices, or provided by the merchant as fixed local prices.

Query

query {
  productVariant(id: "gid://shopify/ProductVariant/43729076") {
    contextualPricing(context: {country: CA}) {
      price {
        amount
        currencyCode
      }
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2026-04/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query { productVariant(id: \"gid://shopify/ProductVariant/43729076\") { contextualPricing(context: {country: CA}) { price { amount currencyCode } } } }"
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  query {
    productVariant(id: "gid://shopify/ProductVariant/43729076") {
      contextualPricing(context: {country: CA}) {
        price {
          amount
          currencyCode
        }
      }
    }
  }`,
  );
  const json = await response.json();
  return json.data;
}

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 {
    productVariant(id: "gid://shopify/ProductVariant/43729076") {
      contextualPricing(context: {country: CA}) {
        price {
          amount
          currencyCode
        }
      }
    }
  }
QUERY

response = client.query(query: query)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query {
    productVariant(id: "gid://shopify/ProductVariant/43729076") {
      contextualPricing(context: {country: CA}) {
        price {
          amount
          currencyCode
        }
      }
    }
  }`,
});

Shopify CLI

shopify app execute \
--query \
'query {
  productVariant(id: "gid://shopify/ProductVariant/43729076") {
    contextualPricing(context: {country: CA}) {
      price {
        amount
        currencyCode
      }
    }
  }
}'

Direct API Access

const response = await fetch('shopify:admin/api/2026-04/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `
      query {
        productVariant(id: "gid://shopify/ProductVariant/43729076") {
          contextualPricing(context: {country: CA}) {
            price {
              amount
              currencyCode
            }
          }
        }
      }
    `,
  }),
});

const { data } = await response.json();
console.log(data);

Response

{
  "productVariant": {
    "contextualPricing": {
      "price": {
        "amount": "12.99",
        "currencyCode": "CAD"
      }
    }
  }
}

Retrieve a product variant's price in different countries

Description

Use the `contextualPricing` field to retrieve a product variant's price in Canada, France, and the United States. This example returns the price of the product variant in each country.

Query

query {
  productVariant(id: "gid://shopify/ProductVariant/43729076") {
    CanadaPrice: contextualPricing(context: {country: CA}) {
      price {
        amount
        currencyCode
      }
    }
    USPrice: contextualPricing(context: {country: US}) {
      price {
        amount
        currencyCode
      }
    }
    FrancePrice: contextualPricing(context: {country: FR}) {
      price {
        amount
        currencyCode
      }
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2026-04/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query { productVariant(id: \"gid://shopify/ProductVariant/43729076\") { CanadaPrice: contextualPricing(context: {country: CA}) { price { amount currencyCode } } USPrice: contextualPricing(context: {country: US}) { price { amount currencyCode } } FrancePrice: contextualPricing(context: {country: FR}) { price { amount currencyCode } } } }"
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  query {
    productVariant(id: "gid://shopify/ProductVariant/43729076") {
      CanadaPrice: contextualPricing(context: {country: CA}) {
        price {
          amount
          currencyCode
        }
      }
      USPrice: contextualPricing(context: {country: US}) {
        price {
          amount
          currencyCode
        }
      }
      FrancePrice: contextualPricing(context: {country: FR}) {
        price {
          amount
          currencyCode
        }
      }
    }
  }`,
  );
  const json = await response.json();
  return json.data;
}

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 {
    productVariant(id: "gid://shopify/ProductVariant/43729076") {
      CanadaPrice: contextualPricing(context: {country: CA}) {
        price {
          amount
          currencyCode
        }
      }
      USPrice: contextualPricing(context: {country: US}) {
        price {
          amount
          currencyCode
        }
      }
      FrancePrice: contextualPricing(context: {country: FR}) {
        price {
          amount
          currencyCode
        }
      }
    }
  }
QUERY

response = client.query(query: query)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query {
    productVariant(id: "gid://shopify/ProductVariant/43729076") {
      CanadaPrice: contextualPricing(context: {country: CA}) {
        price {
          amount
          currencyCode
        }
      }
      USPrice: contextualPricing(context: {country: US}) {
        price {
          amount
          currencyCode
        }
      }
      FrancePrice: contextualPricing(context: {country: FR}) {
        price {
          amount
          currencyCode
        }
      }
    }
  }`,
});

Shopify CLI

shopify app execute \
--query \
'query {
  productVariant(id: "gid://shopify/ProductVariant/43729076") {
    CanadaPrice: contextualPricing(context: {country: CA}) {
      price {
        amount
        currencyCode
      }
    }
    USPrice: contextualPricing(context: {country: US}) {
      price {
        amount
        currencyCode
      }
    }
    FrancePrice: contextualPricing(context: {country: FR}) {
      price {
        amount
        currencyCode
      }
    }
  }
}'

Direct API Access

const response = await fetch('shopify:admin/api/2026-04/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `
      query {
        productVariant(id: "gid://shopify/ProductVariant/43729076") {
          CanadaPrice: contextualPricing(context: {country: CA}) {
            price {
              amount
              currencyCode
            }
          }
          USPrice: contextualPricing(context: {country: US}) {
            price {
              amount
              currencyCode
            }
          }
          FrancePrice: contextualPricing(context: {country: FR}) {
            price {
              amount
              currencyCode
            }
          }
        }
      }
    `,
  }),
});

const { data } = await response.json();
console.log(data);

Response

{
  "productVariant": {
    "CanadaPrice": {
      "price": {
        "amount": "12.99",
        "currencyCode": "CAD"
      }
    },
    "USPrice": {
      "price": {
        "amount": "10.0",
        "currencyCode": "USD"
      }
    },
    "FrancePrice": {
      "price": {
        "amount": "4.95",
        "currencyCode": "EUR"
      }
    }
  }
}

Retrieve information about a product variant by its ID

Description

Retrieve information about a product variant by its ID. This example returns details including the title, price, and barcode of the product variant.

Query

query GetProductVariant($id: ID!) {
  productVariant(id: $id) {
    id
    title
    availableForSale
    barcode
    compareAtPrice
    createdAt
  }
}

Variables

{
  "id": "gid://shopify/ProductVariant/43729076"
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2026-04/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query GetProductVariant($id: ID!) { productVariant(id: $id) { id title availableForSale barcode compareAtPrice createdAt } }",
 "variables": {
    "id": "gid://shopify/ProductVariant/43729076"
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  query GetProductVariant($id: ID!) {
    productVariant(id: $id) {
      id
      title
      availableForSale
      barcode
      compareAtPrice
      createdAt
    }
  }`,
  {
    variables: {
        "id": "gid://shopify/ProductVariant/43729076"
    },
  },
  );
  const json = await response.json();
  return json.data;
}

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 GetProductVariant($id: ID!) {
    productVariant(id: $id) {
      id
      title
      availableForSale
      barcode
      compareAtPrice
      createdAt
    }
  }
QUERY

variables = {
  "id": "gid://shopify/ProductVariant/43729076"
}

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

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `query GetProductVariant($id: ID!) {
      productVariant(id: $id) {
        id
        title
        availableForSale
        barcode
        compareAtPrice
        createdAt
      }
    }`,
    "variables": {
        "id": "gid://shopify/ProductVariant/43729076"
    },
  },
});

Shopify CLI

shopify app execute \
--query \
'query GetProductVariant($id: ID!) {
  productVariant(id: $id) {
    id
    title
    availableForSale
    barcode
    compareAtPrice
    createdAt
  }
}' \
--variables \
'{
  "id": "gid://shopify/ProductVariant/43729076"
}'

Direct API Access

const response = await fetch('shopify:admin/api/2026-04/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `
      query GetProductVariant($id: ID!) {
        productVariant(id: $id) {
          id
          title
          availableForSale
          barcode
          compareAtPrice
          createdAt
        }
      }
    `,
    variables: {
        "id": "gid://shopify/ProductVariant/43729076"
    },
  }),
});

const { data } = await response.json();
console.log(data);

Response

{
  "productVariant": {
    "id": "gid://shopify/ProductVariant/43729076",
    "title": "151cm",
    "availableForSale": true,
    "barcode": "12345678",
    "compareAtPrice": "20.00",
    "createdAt": "2025-06-11T00:27:43Z"
  }
}

Retrieve multiple product variants using their IDs and GraphQL aliases

Description

Retrieve multiple product variants by their IDs using [aliases](https://shopify.dev/docs/apps/build/graphql/basics/advanced#make-multiple-queries-in-one-request) to name the results. This example returns the ID and title for each product variant.

Query

query {
  productVariant1: productVariant(id: "gid://shopify/ProductVariant/30322695") {
    id
    title
  }
  productVariant2: productVariant(id: "gid://shopify/ProductVariant/43729076") {
    id
    title
  }
  productVariant3: productVariant(id: "gid://shopify/ProductVariant/113711323") {
    id
    title
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2026-04/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query { productVariant1: productVariant(id: \"gid://shopify/ProductVariant/30322695\") { id title } productVariant2: productVariant(id: \"gid://shopify/ProductVariant/43729076\") { id title } productVariant3: productVariant(id: \"gid://shopify/ProductVariant/113711323\") { id title } }"
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  query {
    productVariant1: productVariant(id: "gid://shopify/ProductVariant/30322695") {
      id
      title
    }
    productVariant2: productVariant(id: "gid://shopify/ProductVariant/43729076") {
      id
      title
    }
    productVariant3: productVariant(id: "gid://shopify/ProductVariant/113711323") {
      id
      title
    }
  }`,
  );
  const json = await response.json();
  return json.data;
}

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 {
    productVariant1: productVariant(id: "gid://shopify/ProductVariant/30322695") {
      id
      title
    }
    productVariant2: productVariant(id: "gid://shopify/ProductVariant/43729076") {
      id
      title
    }
    productVariant3: productVariant(id: "gid://shopify/ProductVariant/113711323") {
      id
      title
    }
  }
QUERY

response = client.query(query: query)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query {
    productVariant1: productVariant(id: "gid://shopify/ProductVariant/30322695") {
      id
      title
    }
    productVariant2: productVariant(id: "gid://shopify/ProductVariant/43729076") {
      id
      title
    }
    productVariant3: productVariant(id: "gid://shopify/ProductVariant/113711323") {
      id
      title
    }
  }`,
});

Shopify CLI

shopify app execute \
--query \
'query {
  productVariant1: productVariant(id: "gid://shopify/ProductVariant/30322695") {
    id
    title
  }
  productVariant2: productVariant(id: "gid://shopify/ProductVariant/43729076") {
    id
    title
  }
  productVariant3: productVariant(id: "gid://shopify/ProductVariant/113711323") {
    id
    title
  }
}'

Direct API Access

const response = await fetch('shopify:admin/api/2026-04/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `
      query {
        productVariant1: productVariant(id: "gid://shopify/ProductVariant/30322695") {
          id
          title
        }
        productVariant2: productVariant(id: "gid://shopify/ProductVariant/43729076") {
          id
          title
        }
        productVariant3: productVariant(id: "gid://shopify/ProductVariant/113711323") {
          id
          title
        }
      }
    `,
  }),
});

const { data } = await response.json();
console.log(data);

Response

{
  "productVariant1": {
    "id": "gid://shopify/ProductVariant/30322695",
    "title": "151cm"
  },
  "productVariant2": {
    "id": "gid://shopify/ProductVariant/43729076",
    "title": "151cm"
  },
  "productVariant3": {
    "id": "gid://shopify/ProductVariant/113711323",
    "title": "155cm"
  }
}

Examples

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {

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 json = await response.json();

return json.data;

}

GQL

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

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2026-04/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"
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  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 json = await response.json();
  return json.data;
}

Node.js

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"
    },
  },
});

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 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)

Shopify CLI

shopify app execute \
--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"
}'

Direct API Access

const response = await fetch('shopify:admin/api/2026-04/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    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 { data } = await response.json();
console.log(data);

Input variables

JSON

{

"namespace": "my_fields",

"key": "liner_material",

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

}

Response

JSON

{

"productVariant": {

"linerMaterial": {

"value": "synthetic leather"

}