ProductVariantConnection

Anchor to DeliveryProfileItem.variantsDeliveryProfileItem.variants

•OBJECT

A product and the subset of associated variants that are part of this delivery profile.

Anchor to DiscountProducts.productVariantsDiscountProducts.productVariants

•OBJECT

A list of products and product variants that the discount can have as a prerequisite or a list of products and product variants to which the discount can be applied.

Anchor to PriceRuleItemEntitlements.productVariantsPriceRuleItemEntitlements.productVariants

•OBJECT

The items to which this price rule applies. This may be multiple products, product variants, collections or combinations of the aforementioned.

Anchor to PriceRuleLineItemPrerequisites.productVariantsPriceRuleLineItemPrerequisites.productVariants

•OBJECT

Single or multiple line item products, product variants or collections required for the price rule to be applicable, can also be provided in combination.

Anchor to Product.variantsProduct.variants

•OBJECT

The Product object lets you manage products in a merchant’s store.

Products are the goods and services that merchants offer to customers. They can include various details such as title, description, price, images, and options such as size or color. You can use product variants to create or update different versions of the same product. You can also add or update product media. Products can be organized by grouping them into a collection.

Learn more about working with Shopify's product model, including limitations and considerations.

Anchor to ProductBundleComponent.componentVariantsProductBundleComponent.componentVariants

•OBJECT

The product's component information.

Anchor to ProductComponentType.componentVariantsProductComponentType.componentVariants

•OBJECT

The product component information.

Anchor to ProductComponentType.nonComponentVariantsProductComponentType.nonComponentVariants

•OBJECT

The product component information.

Anchor to SellingPlanGroup.productVariantsSellingPlanGroup.productVariants

•OBJECT

A selling method that defines how products can be sold through purchase options like subscriptions, pre-orders, or try-before-you-buy. Groups one or more SellingPlan objects that share the same selling method and options.

The group provides buyer-facing labels and merchant-facing descriptions for the selling method. Associates Product and ProductVariant objects with selling plan groups to offer them through these purchase options.

---

Caution

Selling plan groups and their associated records are automatically deleted 48 hours after a merchant uninstalls the App that created them. Back up these records if you need to restore them later.

---

Anchor to SubscriptionBillingAttemptInsufficientStockProductVariantsError.insufficientStockProductVariantsSubscriptionBillingAttemptInsufficientStockProductVariantsError.insufficientStockProductVariants

•OBJECT

An inventory error caused by an issue with one or more of the contract merchandise lines.

Deprecated fields with this connection

Anchor to Shop.productVariantsShop.productVariants

•OBJECT

Deprecated

Anchor to SubscriptionBillingAttemptOutOfStockProductVariantsError.outOfStockProductVariantsSubscriptionBillingAttemptOutOfStockProductVariantsError.outOfStockProductVariants

•OBJECT

Deprecated

Anchor to productVariantsproductVariants

•query

Retrieves a list of product variants associated with a product.

A product variant is a specific 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 productVariants query when you need to:

• Search for product variants by attributes such as SKU, barcode, or inventory quantity.
• Filter product variants by attributes, such as whether they're gift cards or have custom metafields.
• Fetch product variants for bulk operations, such as updating prices or inventory.
• Preload data for product variants, such as inventory items, selected options, or associated products.

The productVariants query supports pagination to handle large product catalogs and saved searches for frequently used product variant queries.

The productVariants query returns product variants with their associated metadata, including:

• Basic product variant information (for example, title, SKU, barcode, price, and inventory)
• Media attachments (for example, images and videos)
• Associated products, selling plans, bundles, and metafields

Learn more about working with Shopify's product model.

Show fields

Arguments

Anchor to firstfirst

•Int

The first n elements from the paginated list.

Anchor to afterafter

•String

The elements that come after the specified cursor.

Anchor to lastlast

•Int

The last n elements from the paginated list.

Anchor to beforebefore

•String

The elements that come before the specified cursor.

Anchor to reversereverse

•Boolean

Default:false

Reverse the order of the underlying list.

Anchor to sortKeysortKey

•ProductVariantSortKeys

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

Show enum values

Anchor to queryquery

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Show filters

Anchor to default

•string

Filter by a case-insensitive search of multiple fields in a document.

Example:

• query=Bob Norman
• query=title:green hoodie

Anchor to barcode

•string

Filter by the product variant barcode field.

Example:

• barcode:ABC-abc-123

Anchor to collection

•string

Filter by the ID of the collection that the product variant belongs to.

Example:

• collection:465903092033

Anchor to delivery_profile_id

•id

Filter by the product variant delivery profile ID (ProductVariant.deliveryProfile.id).

Example:

• delivery_profile_id:108179161409

Anchor to exclude_composite

•boolean

Filter by product variants that aren't composites.

Example:

• exclude_composite:true

Anchor to exclude_variants_with_components

•boolean

Filter by whether there are components that are associated with the product variants in a bundle.

Example:

• exclude_variants_with_components:true

Anchor to gift_card

•boolean

Filter by the product isGiftCard field.

Example:

• gift_card:true

Anchor to id

•id

Filter by id range.

Example:

• id:1234
• id:>=1234
• id:<=1234

Anchor to inventory_quantity

•integer

Filter by an aggregate of inventory across all locations where the product variant is stocked.

Example:

• inventory_quantity:10

Anchor to location_id

•id

Filter by the location ID for the product variant.

Example:

• location_id:88511152449

Anchor to managed

•boolean

Filter by whether there is fulfillment service tracking associated with the product variants.

Example:

• managed:true

Anchor to managed_by

•string

Filter by the fulfillment service that tracks the number of items in stock for the product variant.

Example:

• managed_by:shopify

Anchor to option1

•string

Filter by a custom property that a shop owner uses to define product variants.

Example:

• option1:small

Anchor to option2

•string

Filter by a custom property that a shop owner uses to define product variants.

Example:

• option2:medium

Anchor to option3

•string

Filter by a custom property that a shop owner uses to define product variants.

Example:

• option3:large

Anchor to product_id

•id

Filter by the product id field.

Example:

• product_id:8474977763649

Anchor to product_ids

•string

Filter by a comma-separated list of product IDs.

Example:

• product_ids:8474977763649,8474977796417

Anchor to product_publication_status

•string

Filter by channel approval process status of the resource on a channel, such as the online store. The value is a composite of the channel app ID (Channel.app.id) and one of the valid values. For simple visibility checks, use published_status instead.

Valid values:

• * {channel_app_id}-approved
• * {channel_app_id}-rejected
• * {channel_app_id}-needs_action
• * {channel_app_id}-awaiting_review
• * {channel_app_id}-published
• * {channel_app_id}-demoted
• * {channel_app_id}-scheduled
• * {channel_app_id}-provisionally_published

Example:

• product_publication_status:189769876-approved

Anchor to product_status

•string

Filter by a comma-separated list of product statuses.

Example:

• product_status:ACTIVE,DRAFT

Anchor to product_type

•string

Filter by the product type that's associated with the product variants.

Example:

• product_type:snowboard

Anchor to publishable_status

•string

Deprecated: This parameter is deprecated as of 2025-12 and will be removed in a future API version. Use published_status for visibility checks. Filter by the publishable status of the resource on a channel. The value is a composite of the channel app ID (Channel.app.id) and one of the valid status values.

Valid values:

• * {channel_app_id}-unset
• * {channel_app_id}-pending
• * {channel_app_id}-approved
• * {channel_app_id}-not_approved

Example:

• publishable_status:580111-unset
• publishable_status:580111-pending

Anchor to published_status

•string

Filter resources by their visibility and publication state on a channel. Online store channel filtering: - online_store_channel: Returns all resources in the online store channel, regardless of publication status. - published/visible: Returns resources that are published to the online store. - unpublished: Returns resources that are not published to the online store. Channel-specific filtering using the channel app ID (Channel.app.id) with suffixes: - {channel_app_id}-published: Returns resources published to the specified channel. - {channel_app_id}-visible: Same as {channel_app_id}-published (kept for backwards compatibility). - {channel_app_id}-intended: Returns resources added to the channel but not yet published. - {channel_app_id}-hidden: Returns resources not added to the channel or not published. Other: - unavailable: Returns resources not published to any channel.

Valid values:

• online_store_channel
• published
• visible
• unpublished
• * {channel_app_id}-published
• * {channel_app_id}-visible
• * {channel_app_id}-intended
• * {channel_app_id}-hidden
• unavailable

Example:

• published_status:online_store_channel
• published_status:published
• published_status:580111-published
• published_status:580111-hidden
• published_status:unavailable

Anchor to requires_components

•boolean

Filter by whether the product variant can only be purchased with components. Learn more.

Example:

• requires_components:true

Anchor to sku

•string

Filter by the product variant sku field. Learn more about SKUs.

Example:

• sku:XYZ-12345

Anchor to tag

•string

Filter objects by the tag field.

Example:

• tag:my_tag

Anchor to tag_not

•string

Filter by objects that don’t have the specified tag.

Example:

• tag_not:my_tag

Anchor to taxable

•boolean

Filter by the product variant taxable field.

Example:

• taxable:false

Anchor to title

•string

Filter by the product variant title field.

Example:

• title:ice

Anchor to updated_at

•time

Filter by date and time when the product variant was updated.

Example:

• updated_at:>2020-10-21T23:39:20Z
• updated_at:<now
• updated_at:<=2024

Anchor to vendor

•string

Filter by the origin or source of the product variant. Learn more about vendors and managing vendor information.

Example:

• vendor:Snowdevil
• vendor:Snowdevil OR vendor:Icedevil

Anchor to savedSearchIdsavedSearchId

•ID

The ID of a saved search. The search’s query string is used as the query argument.

---

Anchor to edgesedges

•[ProductVariantEdge!]!

non-null

The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node.

Show fields

Anchor to nodesnodes

•[ProductVariant!]!

non-null

A list of nodes that are contained in ProductVariantEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve.

Show fields

Anchor to pageInfopageInfo

•PageInfo!

non-null

An object that’s used to retrieve cursor information about the current page.

Show fields