ProductVariant - storefront - OBJECT

Version: 2024-10

Description:

A product variant represents a different version of a product, such as differing sizes or differing colors.

Access Scopes

`unauthenticated_read_product_listings` access scope.

Fields

  • availableForSale: Boolean! - Indicates if the product variant is available for sale.
  • barcode: String - The barcode (for example, ISBN, UPC, or GTIN) associated with the variant.
  • compareAtPrice: MoneyV2 - The compare at price of the variant. This can be used to mark a variant as on sale, when `compareAtPrice` is higher than `price`.
  • compareAtPriceV2: MoneyV2 - The compare at price of the variant. This can be used to mark a variant as on sale, when `compareAtPriceV2` is higher than `priceV2`.
  • currentlyNotInStock: Boolean! - Whether a product is out of stock but still available for purchase (used for backorders).
  • id: ID! - A globally-unique ID.
  • image: Image - Image associated with the product variant. This field falls back to the product image if no image is available.
  • 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.
  • metafields: Metafield! - A list of [custom fields](/docs/apps/build/custom-data) that a merchant associates with a Shopify resource.
  • price: MoneyV2! - The product variant’s price.
  • priceV2: MoneyV2! - The product variant’s price.
  • product: Product! - The product object that the product variant belongs to.
  • quantityAvailable: Int - The total sellable quantity of the variant for online sales channels.
  • quantityRule: QuantityRule! - The quantity rule for the product variant in a given context.
  • 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.
  • requiresShipping: Boolean! - Whether a customer needs to provide a shipping address when placing an order for the product variant.
  • selectedOptions: SelectedOption! - List of product options applied to the variant.
  • shopPayInstallmentsPricing: ShopPayInstallmentsProductVariantPricing - The Shop Pay Installments pricing information for the product variant.
  • sku: String - The SKU (stock keeping unit) associated with the variant.
  • taxable: Boolean! - Whether tax is charged when the product variant is sold.
  • title: String! - The product variant’s title.
  • unitPrice: MoneyV2 - The unit price value for the variant based on the variant's measurement.
  • unitPriceMeasurement: UnitPriceMeasurement - The unit price measurement for the variant.
  • weight: Float - The weight of the product variant in the unit system specified with `weight_unit`.
  • weightUnit: WeightUnit! - Unit of measurement for weight.

Connections

  • components: ProductVariantComponentConnection!
  • groupedBy: ProductVariantConnection!
  • quantityPriceBreaks: QuantityPriceBreakConnection!
  • sellingPlanAllocations: SellingPlanAllocationConnection!
  • storeAvailability: StoreAvailabilityConnection!

Related queries

Related mutations

Related Unions

  • Merchandise The merchandise to be purchased at checkout.
  • MetafieldParentResource A resource that the metafield belongs to.
  • MetafieldReference Returns the resource which is being referred to by a metafield.

Examples