Choose a version:

ProductVariant

object

Requires unauthenticated_read_product_listings access scope.

A specific version of a product available for sale, differentiated by options like size or color. For example, a small blue t-shirt and a large blue t-shirt are separate variants of the same product. For more information, see the docs on Shopify's product model.

For products with quantity rules, variants enforce minimum, maximum, and increment constraints on purchases.

Variants also support subscriptions and pre-orders through selling plan allocations objects, bundle configurations through product variant components objects, and shop pay installments pricing for flexible payment options.

Anchor to FieldsFields

Anchor to availableForSaleavailableForSale

•Boolean!

non-null

Indicates if the product variant is available for sale.

Anchor to barcodebarcode

•String

The barcode (for example, ISBN, UPC, or GTIN) associated with the variant.

Anchor to compareAtPricecompareAtPrice

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

Anchor to componentscomponents

•ProductVariantComponentConnection!

non-null

List of bundles components included in the variant considering only fixed bundles.

Anchor to firstfirst •Int: Returns up to the first n elements from the list.
Anchor to afterafter •String: Returns the elements that come after the specified cursor.
Anchor to lastlast •Int: Returns up to the last n elements from the list.
Anchor to beforebefore •String: Returns the elements that come before the specified cursor.

Anchor to currentlyNotInStockcurrentlyNotInStock

•Boolean!

non-null

Whether a product is out of stock but still available for purchase (used for backorders).

Anchor to groupedBygroupedBy

•ProductVariantConnection!

non-null

List of bundles that include this variant considering only fixed bundles.

Anchor to firstfirst •Int: Returns up to the first n elements from the list.
Anchor to afterafter •String: Returns the elements that come after the specified cursor.
Anchor to lastlast •Int: Returns up to the last n elements from the list.
Anchor to beforebefore •String: Returns the elements that come before the specified cursor.

Anchor to idid

•ID!

non-null

A globally-unique ID.

Anchor to imageimage

•Image

Image associated with the product variant. This field falls back to the product image if no image is available.

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 namespacenamespace •String: The container the metafield belongs to. If omitted, the app-reserved namespace will be used.
Anchor to keykey •String! required: The identifier for the metafield.

Anchor to metafieldsmetafields

•[Metafield]!

non-null

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

Arguments

Anchor to identifiersidentifiers

•[HasMetafieldsIdentifier!]!

required

The list of metafields to retrieve by namespace and key.

The input must not contain more than 250 values.

Anchor to priceprice

•MoneyV2!

non-null

The product variant’s price.

Anchor to productproduct

•Product!

non-null

The product object that the product variant belongs to.

Anchor to quantityAvailablequantityAvailable

•Int

The total sellable quantity of the variant for online sales channels.

Anchor to quantityPriceBreaksquantityPriceBreaks

•QuantityPriceBreakConnection!

non-null

A list of quantity breaks for the product variant.

Anchor to firstfirst •Int: Returns up to the first n elements from the list.
Anchor to afterafter •String: Returns the elements that come after the specified cursor.
Anchor to lastlast •Int: Returns up to the last n elements from the list.
Anchor to beforebefore •String: Returns the elements that come before the specified cursor.

Anchor to quantityRulequantityRule

•QuantityRule!

non-null

The quantity rule for the product variant in a given context.

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.

Anchor to requiresShippingrequiresShipping

•Boolean!

non-null

Whether a customer needs to provide a shipping address when placing an order for the product variant.

Anchor to selectedOptionsselectedOptions

•[SelectedOption!]!

non-null

List of product options applied to the variant.

Anchor to sellingPlanAllocationssellingPlanAllocations

•SellingPlanAllocationConnection!

non-null

Represents an association between a variant and a selling plan. Selling plan allocations describe which selling plans are available for each variant, and what their impact is on pricing.

Anchor to firstfirst •Int: Returns up to the first n elements from the list.
Anchor to afterafter •String: Returns the elements that come after the specified cursor.
Anchor to lastlast •Int: Returns up to the last n elements from the list.
Anchor to beforebefore •String: Returns the elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.