ProductVariant - admin-graphql - OBJECT

Version: 2024-07

Description:

Represents a product variant.

Access Scopes

`read_products` access scope.

Fields

• availableForSale: Boolean! - 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! - The pricing that applies for a customer in a given context.
• createdAt: DateTime! - The date and time when the variant was created.
• defaultCursor: String! - A default [cursor](https://shopify.dev/api/usage/pagination-graphql) that returns the single next record, sorted ascending by ID.
• deliveryProfile: DeliveryProfile - The [delivery profile](https://shopify.dev/api/admin-graphql/latest/objects/DeliveryProfile) for the variant.
• displayName: String! - Display name of the variant, based on product's title + variant's title.
• id: ID! - A globally-unique ID.
• image: Image - The featured image for the variant.
• inventoryItem: InventoryItem! - The inventory item, which is used to query for inventory information.
• inventoryPolicy: ProductVariantInventoryPolicy! - 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! - The ID of the corresponding resource in the REST Admin API.
• metafield: Metafield - A [custom field](https://shopify.dev/docs/apps/build/custom-data), including its `namespace` and `key`, that's associated with a Shopify resource for the purposes of adding and storing additional information.
• position: Int! - The order of the product variant in the list of product variants. The first position in the list is 1.
• price: Money! - The price of the product variant in the default shop currency.
• privateMetafield: PrivateMetafield - Returns a private metafield by namespace and key that belongs to the resource.
• product: Product! - The product that this variant belongs to.
• requiresComponents: Boolean! - 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! - List of product options applied to the variant.
• sellableOnlineQuantity: Int! - 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](https://help.shopify.com/manual/markets/inventory_and_fulfillment).
• sellingPlanGroupCount: Int! - Count of selling plan groups 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.
• storefrontId: StorefrontID! - 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.
• taxCode: String - The tax code for the product variant.
• taxable: Boolean! - Whether a tax is charged when the product variant is sold.
• title: String! - The title of the product variant.
• translations: Translation! - The published translations associated with the resource.
• updatedAt: DateTime! - The date and time (ISO 8601 format) when the product variant was last modified.

Connections

• media: MediaConnection!
• metafieldDefinitions: MetafieldDefinitionConnection!
• metafields: MetafieldConnection!
• presentmentPrices: ProductVariantPricePairConnection!
• privateMetafields: PrivateMetafieldConnection!
• productVariantComponents: ProductVariantComponentConnection!
• sellingPlanGroups: SellingPlanGroupConnection!

Related queries

• productVariant Returns a ProductVariant resource by ID.
• productVariants Returns a list of product variants.

Related mutations

• productVariantAppendMedia Appends media from a product to variants of the product.
• productVariantCreate Creates a product variant.
• productVariantDetachMedia Detaches media from product variants.
• productVariantJoinSellingPlanGroups Adds multiple selling plan groups to a product variant.
• productVariantLeaveSellingPlanGroups Remove multiple groups from a product variant.
• productVariantRelationshipBulkUpdate Creates new bundles, updates existing bundles, and removes bundle components for one or multiple bundles.
• productVariantUpdate Updates a product variant.
• productVariantsBulkCreate Creates multiple variants in a single product. This mutation can be called directly or via the bulkOperation.
• productVariantsBulkUpdate Updates multiple variants in a single product. This mutation can be called directly or via the bulkOperation.
• quantityPricingByVariantUpdate Updates quantity pricing on a price list. You can use the `quantityPricingByVariantUpdate` mutation to set fixed prices, quantity rules, and quantity price breaks. This mutation does not allow partial successes. If any of the requested resources fail to update, none of the requested resources will be updated. Delete operations are executed before create operations.

Related Unions

• CommentEventEmbed The main embed of a comment event.
• MetafieldReference The resource referenced by the metafield value.
• MetafieldReferencer Types of resources that may use metafields to reference other resources.

Examples

• Get a metafield attached to a product variant

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query ProductVariantMetafield($namespace: String!, $key: String!, $ownerId: ID!) { productVariant(id: $ownerId) { linerMaterial: metafield(namespace: $namespace, key: $key) { value } } }\",\n \"variables\": {\n    \"namespace\": \"my_fields\",\n    \"key\": \"liner_material\",\n    \"ownerId\": \"gid://shopify/ProductVariant/43729076\"\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `query ProductVariantMetafield($namespace: String!, $key: String!, $ownerId: ID!) {\n      productVariant(id: $ownerId) {\n        linerMaterial: metafield(namespace: $namespace, key: $key) {\n          value\n        }\n      }\n    }`,\n    \"variables\": {\n      \"namespace\": \"my_fields\",\n      \"key\": \"liner_material\",\n      \"ownerId\": \"gid://shopify/ProductVariant/43729076\"\n    },\n  },\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  query ProductVariantMetafield($namespace: String!, $key: String!, $ownerId: ID!) {\n    productVariant(id: $ownerId) {\n      linerMaterial: metafield(namespace: $namespace, key: $key) {\n        value\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"namespace\": \"my_fields\",\n  \"key\": \"liner_material\",\n  \"ownerId\": \"gid://shopify/ProductVariant/43729076\"\n}\n\nresponse = client.query(query: query, variables: variables)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  query ProductVariantMetafield($namespace: String!, $key: String!, $ownerId: ID!) {\n    productVariant(id: $ownerId) {\n      linerMaterial: metafield(namespace: $namespace, key: $key) {\n        value\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"namespace\" => \"my_fields\",\n  \"key\" => \"liner_material\",\n  \"ownerId\" => \"gid://shopify/ProductVariant/43729076\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query ProductVariantMetafield($namespace: String!, $key: String!, $ownerId: ID!) {\n    productVariant(id: $ownerId) {\n      linerMaterial: metafield(namespace: $namespace, key: $key) {\n        value\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"namespace\": \"my_fields\",\n      \"key\": \"liner_material\",\n      \"ownerId\": \"gid://shopify/ProductVariant/43729076\"\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "query ProductVariantMetafield($namespace: String!, $key: String!, $ownerId: ID!) {\n  productVariant(id: $ownerId) {\n    linerMaterial: metafield(namespace: $namespace, key: $key) {\n      value\n    }\n  }\n}"
        

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

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

  Get metafields attached to a product variant

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query ProductVariantMetafields($ownerId: ID!) { productVariant(id: $ownerId) { metafields(first: 3) { edges { node { namespace key value } } } } }\",\n \"variables\": {\n    \"ownerId\": \"gid://shopify/ProductVariant/43729076\"\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `query ProductVariantMetafields($ownerId: ID!) {\n      productVariant(id: $ownerId) {\n        metafields(first: 3) {\n          edges {\n            node {\n              namespace\n              key\n              value\n            }\n          }\n        }\n      }\n    }`,\n    \"variables\": {\n      \"ownerId\": \"gid://shopify/ProductVariant/43729076\"\n    },\n  },\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  query ProductVariantMetafields($ownerId: ID!) {\n    productVariant(id: $ownerId) {\n      metafields(first: 3) {\n        edges {\n          node {\n            namespace\n            key\n            value\n          }\n        }\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"ownerId\": \"gid://shopify/ProductVariant/43729076\"\n}\n\nresponse = client.query(query: query, variables: variables)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  query ProductVariantMetafields($ownerId: ID!) {\n    productVariant(id: $ownerId) {\n      metafields(first: 3) {\n        edges {\n          node {\n            namespace\n            key\n            value\n          }\n        }\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"ownerId\" => \"gid://shopify/ProductVariant/43729076\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query ProductVariantMetafields($ownerId: ID!) {\n    productVariant(id: $ownerId) {\n      metafields(first: 3) {\n        edges {\n          node {\n            namespace\n            key\n            value\n          }\n        }\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"ownerId\": \"gid://shopify/ProductVariant/43729076\"\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "query ProductVariantMetafields($ownerId: ID!) {\n  productVariant(id: $ownerId) {\n    metafields(first: 3) {\n      edges {\n        node {\n          namespace\n          key\n          value\n        }\n      }\n    }\n  }\n}"
        

  input: {
    "ownerId": "gid://shopify/ProductVariant/43729076"
  }

  response: {
    "data": {
      "productVariant": {
        "metafields": {
          "edges": [
            {
              "node": {
                "namespace": "my_fields",
                "key": "liner_material",
                "value": "synthetic leather"
              }
            }
          ]
        }
      }
    }
  }

  Get pinned metafield definitions associated with a product variant

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query ProductVariantMetafieldDefinitions($ownerId: ID!, $first: Int, $pinnedStatus: MetafieldDefinitionPinnedStatus, $sortKey: MetafieldDefinitionSortKeys) { productVariant(id: $ownerId) { metafieldDefinitions(first: $first, pinnedStatus: $pinnedStatus, sortKey: $sortKey) { edges { node { name namespace key type { name } } } } } }\",\n \"variables\": {\n    \"pinnedStatus\": \"PINNED\",\n    \"ownerId\": \"gid://shopify/ProductVariant/43729076\",\n    \"first\": 10,\n    \"sortKey\": \"PINNED_POSITION\"\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `query ProductVariantMetafieldDefinitions($ownerId: ID!, $first: Int, $pinnedStatus: MetafieldDefinitionPinnedStatus, $sortKey: MetafieldDefinitionSortKeys) {\n      productVariant(id: $ownerId) {\n        metafieldDefinitions(first: $first, pinnedStatus: $pinnedStatus, sortKey: $sortKey) {\n          edges {\n            node {\n              name\n              namespace\n              key\n              type {\n                name\n              }\n            }\n          }\n        }\n      }\n    }`,\n    \"variables\": {\n      \"pinnedStatus\": \"PINNED\",\n      \"ownerId\": \"gid://shopify/ProductVariant/43729076\",\n      \"first\": 10,\n      \"sortKey\": \"PINNED_POSITION\"\n    },\n  },\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  query ProductVariantMetafieldDefinitions($ownerId: ID!, $first: Int, $pinnedStatus: MetafieldDefinitionPinnedStatus, $sortKey: MetafieldDefinitionSortKeys) {\n    productVariant(id: $ownerId) {\n      metafieldDefinitions(first: $first, pinnedStatus: $pinnedStatus, sortKey: $sortKey) {\n        edges {\n          node {\n            name\n            namespace\n            key\n            type {\n              name\n            }\n          }\n        }\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"pinnedStatus\": \"PINNED\",\n  \"ownerId\": \"gid://shopify/ProductVariant/43729076\",\n  \"first\": 10,\n  \"sortKey\": \"PINNED_POSITION\"\n}\n\nresponse = client.query(query: query, variables: variables)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  query ProductVariantMetafieldDefinitions($ownerId: ID!, $first: Int, $pinnedStatus: MetafieldDefinitionPinnedStatus, $sortKey: MetafieldDefinitionSortKeys) {\n    productVariant(id: $ownerId) {\n      metafieldDefinitions(first: $first, pinnedStatus: $pinnedStatus, sortKey: $sortKey) {\n        edges {\n          node {\n            name\n            namespace\n            key\n            type {\n              name\n            }\n          }\n        }\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"pinnedStatus\" => \"PINNED\",\n  \"ownerId\" => \"gid://shopify/ProductVariant/43729076\",\n  \"first\" => 10,\n  \"sortKey\" => \"PINNED_POSITION\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query ProductVariantMetafieldDefinitions($ownerId: ID!, $first: Int, $pinnedStatus: MetafieldDefinitionPinnedStatus, $sortKey: MetafieldDefinitionSortKeys) {\n    productVariant(id: $ownerId) {\n      metafieldDefinitions(first: $first, pinnedStatus: $pinnedStatus, sortKey: $sortKey) {\n        edges {\n          node {\n            name\n            namespace\n            key\n            type {\n              name\n            }\n          }\n        }\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"pinnedStatus\": \"PINNED\",\n      \"ownerId\": \"gid://shopify/ProductVariant/43729076\",\n      \"first\": 10,\n      \"sortKey\": \"PINNED_POSITION\"\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "query ProductVariantMetafieldDefinitions($ownerId: ID!, $first: Int, $pinnedStatus: MetafieldDefinitionPinnedStatus, $sortKey: MetafieldDefinitionSortKeys) {\n  productVariant(id: $ownerId) {\n    metafieldDefinitions(first: $first, pinnedStatus: $pinnedStatus, sortKey: $sortKey) {\n      edges {\n        node {\n          name\n          namespace\n          key\n          type {\n            name\n          }\n        }\n      }\n    }\n  }\n}"
        

  input: {
    "pinnedStatus": "PINNED",
    "ownerId": "gid://shopify/ProductVariant/43729076",
    "first": 10,
    "sortKey": "PINNED_POSITION"
  }

  response: {
    "data": {
      "productVariant": {
        "metafieldDefinitions": {
          "edges": [
            {
              "node": {
                "name": "Sole Material",
                "namespace": "my_fields",
                "key": "sole_material",
                "type": {
                  "name": "single_line_text_field"
                }
              }
            },
            {
              "node": {
                "name": "Liner Material",
                "namespace": "my_fields",
                "key": "liner_material",
                "type": {
                  "name": "single_line_text_field"
                }
              }
            }
          ]
        }
      }
    }
  }

  Get the price for a product variant for buyers in Canada

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query { productVariant(id: \\\"gid://shopify/ProductVariant/43729076\\\") { contextualPricing(context: {country: CA}) { price { amount currencyCode } } } }\"\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: `query {\n    productVariant(id: \"gid://shopify/ProductVariant/43729076\") {\n      contextualPricing(context: {country: CA}) {\n        price {\n          amount\n          currencyCode\n        }\n      }\n    }\n  }`,\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  query {\n    productVariant(id: \"gid://shopify/ProductVariant/43729076\") {\n      contextualPricing(context: {country: CA}) {\n        price {\n          amount\n          currencyCode\n        }\n      }\n    }\n  }\nQUERY\n\nresponse = client.query(query: query)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  query {\n    productVariant(id: \"gid://shopify/ProductVariant/43729076\") {\n      contextualPricing(context: {country: CA}) {\n        price {\n          amount\n          currencyCode\n        }\n      }\n    }\n  }\nQUERY;\n\n$response = $client->query([\"query\" => $query]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query {\n    productVariant(id: \"gid://shopify/ProductVariant/43729076\") {\n      contextualPricing(context: {country: CA}) {\n        price {\n          amount\n          currencyCode\n        }\n      }\n    }\n  }`,\n);\n\nconst data = await response.json();\n"
          Graphql query: "query {\n  productVariant(id: \"gid://shopify/ProductVariant/43729076\") {\n    contextualPricing(context: {country: CA}) {\n      price {\n        amount\n        currencyCode\n      }\n    }\n  }\n}"
        

  input: null

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

  Get the price for a product variant for different countries in the same request

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"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 } } } }\"\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: `query {\n    productVariant(id: \"gid://shopify/ProductVariant/43729076\") {\n      CanadaPrice: contextualPricing(context: {country: CA}) {\n        price {\n          amount\n          currencyCode\n        }\n      }\n      USPrice: contextualPricing(context: {country: US}) {\n        price {\n          amount\n          currencyCode\n        }\n      }\n      FrancePrice: contextualPricing(context: {country: FR}) {\n        price {\n          amount\n          currencyCode\n        }\n      }\n    }\n  }`,\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  query {\n    productVariant(id: \"gid://shopify/ProductVariant/43729076\") {\n      CanadaPrice: contextualPricing(context: {country: CA}) {\n        price {\n          amount\n          currencyCode\n        }\n      }\n      USPrice: contextualPricing(context: {country: US}) {\n        price {\n          amount\n          currencyCode\n        }\n      }\n      FrancePrice: contextualPricing(context: {country: FR}) {\n        price {\n          amount\n          currencyCode\n        }\n      }\n    }\n  }\nQUERY\n\nresponse = client.query(query: query)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  query {\n    productVariant(id: \"gid://shopify/ProductVariant/43729076\") {\n      CanadaPrice: contextualPricing(context: {country: CA}) {\n        price {\n          amount\n          currencyCode\n        }\n      }\n      USPrice: contextualPricing(context: {country: US}) {\n        price {\n          amount\n          currencyCode\n        }\n      }\n      FrancePrice: contextualPricing(context: {country: FR}) {\n        price {\n          amount\n          currencyCode\n        }\n      }\n    }\n  }\nQUERY;\n\n$response = $client->query([\"query\" => $query]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query {\n    productVariant(id: \"gid://shopify/ProductVariant/43729076\") {\n      CanadaPrice: contextualPricing(context: {country: CA}) {\n        price {\n          amount\n          currencyCode\n        }\n      }\n      USPrice: contextualPricing(context: {country: US}) {\n        price {\n          amount\n          currencyCode\n        }\n      }\n      FrancePrice: contextualPricing(context: {country: FR}) {\n        price {\n          amount\n          currencyCode\n        }\n      }\n    }\n  }`,\n);\n\nconst data = await response.json();\n"
          Graphql query: "query {\n  productVariant(id: \"gid://shopify/ProductVariant/43729076\") {\n    CanadaPrice: contextualPricing(context: {country: CA}) {\n      price {\n        amount\n        currencyCode\n      }\n    }\n    USPrice: contextualPricing(context: {country: US}) {\n      price {\n        amount\n        currencyCode\n      }\n    }\n    FrancePrice: contextualPricing(context: {country: FR}) {\n      price {\n        amount\n        currencyCode\n      }\n    }\n  }\n}"
        

  input: null

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

  Receive a single Product Variant

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query GetProductVariant($id: ID!) { productVariant(id: $id) { id title availableForSale barcode compareAtPrice createdAt } }\",\n \"variables\": {\n    \"id\": \"gid://shopify/ProductVariant/43729076\"\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `query GetProductVariant($id: ID!) {\n      productVariant(id: $id) {\n        id\n        title\n        availableForSale\n        barcode\n        compareAtPrice\n        createdAt\n      }\n    }`,\n    \"variables\": {\n      \"id\": \"gid://shopify/ProductVariant/43729076\"\n    },\n  },\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  query GetProductVariant($id: ID!) {\n    productVariant(id: $id) {\n      id\n      title\n      availableForSale\n      barcode\n      compareAtPrice\n      createdAt\n    }\n  }\nQUERY\n\nvariables = {\n  \"id\": \"gid://shopify/ProductVariant/43729076\"\n}\n\nresponse = client.query(query: query, variables: variables)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  query GetProductVariant($id: ID!) {\n    productVariant(id: $id) {\n      id\n      title\n      availableForSale\n      barcode\n      compareAtPrice\n      createdAt\n    }\n  }\nQUERY;\n\n$variables = [\n  \"id\" => \"gid://shopify/ProductVariant/43729076\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query GetProductVariant($id: ID!) {\n    productVariant(id: $id) {\n      id\n      title\n      availableForSale\n      barcode\n      compareAtPrice\n      createdAt\n    }\n  }`,\n  {\n    variables: {\n      \"id\": \"gid://shopify/ProductVariant/43729076\"\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "query GetProductVariant($id: ID!) {\n  productVariant(id: $id) {\n    id\n    title\n    availableForSale\n    barcode\n    compareAtPrice\n    createdAt\n  }\n}"
        

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

  response: {
    "data": {
      "productVariant": {
        "id": "gid://shopify/ProductVariant/43729076",
        "title": "151cm",
        "availableForSale": true,
        "barcode": "12345678",
        "compareAtPrice": "20.00",
        "createdAt": "2024-11-12T15:54:57Z"
      }
    }
  }

  Retrieve information for non-existent variant ID

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query { productVariant(id: \\\"gid://shopify/ProductVariant/-1\\\") { contextualPricing(context: {country: CA}) { price { amount currencyCode } } } }\"\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: `query {\n    productVariant(id: \"gid://shopify/ProductVariant/-1\") {\n      contextualPricing(context: {country: CA}) {\n        price {\n          amount\n          currencyCode\n        }\n      }\n    }\n  }`,\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  query {\n    productVariant(id: \"gid://shopify/ProductVariant/-1\") {\n      contextualPricing(context: {country: CA}) {\n        price {\n          amount\n          currencyCode\n        }\n      }\n    }\n  }\nQUERY\n\nresponse = client.query(query: query)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  query {\n    productVariant(id: \"gid://shopify/ProductVariant/-1\") {\n      contextualPricing(context: {country: CA}) {\n        price {\n          amount\n          currencyCode\n        }\n      }\n    }\n  }\nQUERY;\n\n$response = $client->query([\"query\" => $query]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query {\n    productVariant(id: \"gid://shopify/ProductVariant/-1\") {\n      contextualPricing(context: {country: CA}) {\n        price {\n          amount\n          currencyCode\n        }\n      }\n    }\n  }`,\n);\n\nconst data = await response.json();\n"
          Graphql query: "query {\n  productVariant(id: \"gid://shopify/ProductVariant/-1\") {\n    contextualPricing(context: {country: CA}) {\n      price {\n        amount\n        currencyCode\n      }\n    }\n  }\n}"
        

  input: null

  response: {
    "data": {
      "productVariant": null
    }
  }