Choose a version:

productVariantByIdentifier

query

Requires read_products access scope.

Return a product variant by an identifier.

Arguments

Anchor to identifieridentifier •ProductVariantIdentifierInput! required: The identifier of the product variant.

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.

Was this section helpful?

Find a variant by custom id

Open in GraphiQL

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

const response = await admin.graphql(

`#graphql

query($identifier: ProductVariantIdentifierInput!) {

variant: productVariantByIdentifier(identifier: $identifier) {

title

}

}`,

{

variables: {

"identifier": {

"customId": {

"namespace": "custom",

"key": "id",

"value": "1001"

}

);

const data = await response.json();

query($identifier: ProductVariantIdentifierInput!) {
  variant: productVariantByIdentifier(identifier: $identifier) {
    id
    title
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query($identifier: ProductVariantIdentifierInput!) { variant: productVariantByIdentifier(identifier: $identifier) { id title } }",
 "variables": {
    "identifier": {
      "customId": {
        "namespace": "custom",
        "key": "id",
        "value": "1001"
      }
    }
  }
}'

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

const response = await admin.graphql(
  `#graphql
  query($identifier: ProductVariantIdentifierInput!) {
    variant: productVariantByIdentifier(identifier: $identifier) {
      id
      title
    }
  }`,
  {
    variables: {
      "identifier": {
        "customId": {
          "namespace": "custom",
          "key": "id",
          "value": "1001"
        }
      }
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `query($identifier: ProductVariantIdentifierInput!) {
      variant: productVariantByIdentifier(identifier: $identifier) {
        id
        title
      }
    }`,
    "variables": {
      "identifier": {
        "customId": {
          "namespace": "custom",
          "key": "id",
          "value": "1001"
        }
      }
    },
  },
});

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($identifier: ProductVariantIdentifierInput!) {
    variant: productVariantByIdentifier(identifier: $identifier) {
      id
      title
    }
  }
QUERY

variables = {
  "identifier": {
    "customId": {
      "namespace": "custom",
      "key": "id",
      "value": "1001"
    }
  }
}

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

Input variables

JSON

{

"identifier": {

"customId": {

"namespace": "custom",

"key": "id",

"value": "1001"

}

Response

JSON

{

"variant": {

"id": "gid://shopify/ProductVariant/30322695",

"title": "151cm"

}