Skip to main content
Anchor to ProductVariant

ProductVariant

object

Requires unauthenticated_read_product_listings access scope.

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

Anchor to Fields and connectionsFields and connections

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.

Field results may vary based on the @inContext directive values for:

Anchor to componentscomponents
•ProductVariantComponentConnection!non-null

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

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 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 metafieldsmetafields
•[Metafield]!non-null

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

Anchor to priceprice
•MoneyV2!non-null

The product variant’s price.

Field results may vary based on the @inContext directive values for:

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.

Field results may vary based on the @inContext directive values for:

Anchor to quantityRulequantityRule
•QuantityRule!non-null

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

Field results may vary based on the @inContext directive values for:

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 shopPayInstallmentsPricingshopPayInstallmentsPricing
•ShopPayInstallmentsProductVariantPricing

The Shop Pay Installments pricing information for the product variant.

Anchor to skusku
•String

The SKU (stock keeping unit) associated with the variant.

Anchor to storeAvailabilitystoreAvailability
•StoreAvailabilityConnection!non-null

The in-store pickup availability of this variant by location.

Anchor to taxabletaxable
•Boolean!non-null

Whether tax is charged when the product variant is sold.

Anchor to titletitle
•String!non-null

The product variant’s title.

Anchor to unitPriceunitPrice
•MoneyV2

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

Field results may vary based on the @inContext directive values for:

Anchor to unitPriceMeasurementunitPriceMeasurement
•UnitPriceMeasurement

The unit price measurement for the variant.

Anchor to weightweight
•Float

The weight of the product variant in the unit system specified with weight_unit.

Anchor to weightUnitweightUnit
•WeightUnit!non-null

Unit of measurement for weight.

Deprecated fields and connections

Anchor to compareAtPriceV2compareAtPriceV2
•MoneyV2Deprecated
Anchor to priceV2priceV2
•MoneyV2!non-nullDeprecated
Was this section helpful?

Anchor to InterfacesInterfaces

Was this section helpful?
OSZAR »