ProductVariant object
A product variant represents a different version of a product, such as differing sizes or differing colors.
Required access
unauthenticated_read_product_listings
access scope.
Connections
-
metafields (
MetafieldConnection!
)A paginated list of metafields associated with the resource.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.namespace
(String
)Container for a set of metafields (maximum of 20 characters).
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
presentmentPrices (
ProductVariantPricePairConnection!
)List of prices and compare-at prices in the presentment currencies for this shop.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.presentmentCurrencies
([CurrencyCode!]
)The presentment currencies prices should return in.
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
presentmentUnitPrices (
MoneyV2Connection!
)List of unit prices in the presentment currencies for this shop.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.presentmentCurrencies
([CurrencyCode!]
)Specify the currencies in which to return presentment unit prices.
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
Fields
-
availableForSale (
Boolean!
)Indicates if the product variant is available for sale.
-
compareAtPriceV2 (
MoneyV2
)The compare at price of the variant. This can be used to mark a variant as on sale, when
compareAtPriceV2
is higher thanpriceV2
. -
currentlyNotInStock (
Boolean!
)Whether a product is out of stock but still available for purchase (used for backorders).
-
id (
ID!
)Globally unique identifier.
-
image (
Image
)Image associated with the product variant. This field falls back to the product image if no image is available.
Argument Description crop
(CropRegion
)Crops the image according to the specified region. This argument is deprecated: Use
crop
onImage.transformedSrc
instead.maxHeight
(Int
)Image height in pixels between 1 and 2048. This argument is deprecated: Use
maxHeight
onImage.transformedSrc
instead.maxWidth
(Int
)Image width in pixels between 1 and 2048. This argument is deprecated: Use
maxWidth
onImage.transformedSrc
instead.scale
(Int
)Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use
scale
onImage.transformedSrc
instead.
Default value:1
-
metafield (
Metafield
)The metafield associated with the resource.
-
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.
Required access
unauthenticated_read_product_inventory
access scope. -
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.
-
sku (
String
)The SKU (stock keeping unit) associated with the variant.
-
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.
Types that return ProductVariant
-
CheckoutLineItem.variant
-
OrderLineItem.variant
-
Product.variantBySelectedOptions
-
Product.variants
-
ProductVariant.node
Implements
Deprecated fields
-
available (
Boolean
) deprecatedIndicates if the product variant is in stock.
Deprecation warning
Use
availableForSale
instead -
compareAtPrice (
Money
) deprecatedThe compare at price of the variant. This can be used to mark a variant as on sale, when
compareAtPrice
is higher thanprice
.Deprecation warning
Use
compareAtPriceV2
instead -
price (
Money!
) deprecatedThe product variant’s price.
Deprecation warning
Use
priceV2
instead
An auto-generated type for paginating through multiple ProductVariants.
On this page
Fields
-
edges (
[ProductVariantEdge!]!
)A list of edges.
-
pageInfo (
PageInfo!
)Information to aid in pagination.
Types that return ProductVariant
An auto-generated type which holds one ProductVariant and a cursor during pagination.
On this page
Fields
-
cursor (
String!
)A cursor for use in pagination.
-
node (
ProductVariant!
)The item at the end of ProductVariantEdge.
Types that return ProductVariant
A product variant represents a different version of a product, such as differing sizes or differing colors.
Required access
unauthenticated_read_product_listings
access scope.
Connections
-
metafields (
MetafieldConnection!
)A paginated list of metafields associated with the resource.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.namespace
(String
)Container for a set of metafields (maximum of 20 characters).
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
presentmentPrices (
ProductVariantPricePairConnection!
)List of prices and compare-at prices in the presentment currencies for this shop.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.presentmentCurrencies
([CurrencyCode!]
)The presentment currencies prices should return in.
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
presentmentUnitPrices (
MoneyV2Connection!
)List of unit prices in the presentment currencies for this shop.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.presentmentCurrencies
([CurrencyCode!]
)Specify the currencies in which to return presentment unit prices.
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
Fields
-
availableForSale (
Boolean!
)Indicates if the product variant is available for sale.
-
compareAtPriceV2 (
MoneyV2
)The compare at price of the variant. This can be used to mark a variant as on sale, when
compareAtPriceV2
is higher thanpriceV2
. -
currentlyNotInStock (
Boolean!
)Whether a product is out of stock but still available for purchase (used for backorders).
-
id (
ID!
)Globally unique identifier.
-
image (
Image
)Image associated with the product variant. This field falls back to the product image if no image is available.
Argument Description crop
(CropRegion
)Crops the image according to the specified region. This argument is deprecated: Use
crop
onImage.transformedSrc
instead.maxHeight
(Int
)Image height in pixels between 1 and 2048. This argument is deprecated: Use
maxHeight
onImage.transformedSrc
instead.maxWidth
(Int
)Image width in pixels between 1 and 2048. This argument is deprecated: Use
maxWidth
onImage.transformedSrc
instead.scale
(Int
)Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use
scale
onImage.transformedSrc
instead.
Default value:1
-
metafield (
Metafield
)The metafield associated with the resource.
-
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.
Required access
unauthenticated_read_product_inventory
access scope. -
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.
-
sku (
String
)The SKU (stock keeping unit) associated with the variant.
-
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.
Types that return ProductVariant
Implements
Deprecated fields
-
available (
Boolean
) deprecatedIndicates if the product variant is in stock.
Deprecation warning
Use
availableForSale
instead -
compareAtPrice (
Money
) deprecatedThe compare at price of the variant. This can be used to mark a variant as on sale, when
compareAtPrice
is higher thanprice
.Deprecation warning
Use
compareAtPriceV2
instead -
price (
Money!
) deprecatedThe product variant’s price.
Deprecation warning
Use
priceV2
instead
An auto-generated type for paginating through multiple ProductVariants.
On this page
Fields
-
edges (
[ProductVariantEdge!]!
)A list of edges.
-
pageInfo (
PageInfo!
)Information to aid in pagination.
An auto-generated type which holds one ProductVariant and a cursor during pagination.
On this page
Fields
-
cursor (
String!
)A cursor for use in pagination.
-
node (
ProductVariant!
)The item at the end of ProductVariantEdge.
Types that return ProductVariantEdge
A product variant represents a different version of a product, such as differing sizes or differing colors.
Required access
unauthenticated_read_product_listings
access scope.
Connections
-
metafields (
MetafieldConnection!
)A paginated list of metafields associated with the resource.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.namespace
(String
)Container for a set of metafields (maximum of 20 characters).
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
presentmentPrices (
ProductVariantPricePairConnection!
)List of prices and compare-at prices in the presentment currencies for this shop.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.presentmentCurrencies
([CurrencyCode!]
)The presentment currencies prices should return in.
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
presentmentUnitPrices (
MoneyV2Connection!
)List of unit prices in the presentment currencies for this shop.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.presentmentCurrencies
([CurrencyCode!]
)Specify the currencies in which to return presentment unit prices.
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
Fields
-
availableForSale (
Boolean!
)Indicates if the product variant is available for sale.
-
compareAtPriceV2 (
MoneyV2
)The compare at price of the variant. This can be used to mark a variant as on sale, when
compareAtPriceV2
is higher thanpriceV2
. -
currentlyNotInStock (
Boolean!
)Whether a product is out of stock but still available for purchase (used for backorders).
-
id (
ID!
)Globally unique identifier.
-
image (
Image
)Image associated with the product variant. This field falls back to the product image if no image is available.
Argument Description crop
(CropRegion
)Crops the image according to the specified region. This argument is deprecated: Use
crop
onImage.transformedSrc
instead.maxHeight
(Int
)Image height in pixels between 1 and 2048. This argument is deprecated: Use
maxHeight
onImage.transformedSrc
instead.maxWidth
(Int
)Image width in pixels between 1 and 2048. This argument is deprecated: Use
maxWidth
onImage.transformedSrc
instead.scale
(Int
)Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use
scale
onImage.transformedSrc
instead.
Default value:1
-
metafield (
Metafield
)The metafield associated with the resource.
-
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.
Required access
unauthenticated_read_product_inventory
access scope. -
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.
-
sku (
String
)The SKU (stock keeping unit) associated with the variant.
-
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.
Types that return ProductVariant
Implements
Deprecated fields
-
available (
Boolean
) deprecatedIndicates if the product variant is in stock.
Deprecation warning
Use
availableForSale
instead -
compareAtPrice (
Money
) deprecatedThe compare at price of the variant. This can be used to mark a variant as on sale, when
compareAtPrice
is higher thanprice
.Deprecation warning
Use
compareAtPriceV2
instead -
price (
Money!
) deprecatedThe product variant’s price.
Deprecation warning
Use
priceV2
instead
An auto-generated type for paginating through multiple ProductVariants.
On this page
Fields
-
edges (
[ProductVariantEdge!]!
)A list of edges.
-
pageInfo (
PageInfo!
)Information to aid in pagination.
An auto-generated type which holds one ProductVariant and a cursor during pagination.
On this page
Fields
-
cursor (
String!
)A cursor for use in pagination.
-
node (
ProductVariant!
)The item at the end of ProductVariantEdge.
Types that return ProductVariantEdge
A product variant represents a different version of a product, such as differing sizes or differing colors.
Required access
unauthenticated_read_product_listings
access scope.
Connections
-
metafields (
MetafieldConnection!
)A paginated list of metafields associated with the resource.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.namespace
(String
)Container for a set of metafields (maximum of 20 characters).
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
presentmentPrices (
ProductVariantPricePairConnection!
)List of prices and compare-at prices in the presentment currencies for this shop.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.presentmentCurrencies
([CurrencyCode!]
)The presentment currencies prices should return in.
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
presentmentUnitPrices (
MoneyV2Connection!
)List of unit prices in the presentment currencies for this shop.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.presentmentCurrencies
([CurrencyCode!]
)Specify the currencies in which to return presentment unit prices.
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
Fields
-
availableForSale (
Boolean!
)Indicates if the product variant is available for sale.
-
compareAtPriceV2 (
MoneyV2
)The compare at price of the variant. This can be used to mark a variant as on sale, when
compareAtPriceV2
is higher thanpriceV2
. -
currentlyNotInStock (
Boolean!
)Whether a product is out of stock but still available for purchase (used for backorders).
-
id (
ID!
)Globally unique identifier.
-
image (
Image
)Image associated with the product variant. This field falls back to the product image if no image is available.
Argument Description crop
(CropRegion
)Crops the image according to the specified region. This argument is deprecated: Use
crop
onImage.transformedSrc
instead.maxHeight
(Int
)Image height in pixels between 1 and 2048. This argument is deprecated: Use
maxHeight
onImage.transformedSrc
instead.maxWidth
(Int
)Image width in pixels between 1 and 2048. This argument is deprecated: Use
maxWidth
onImage.transformedSrc
instead.scale
(Int
)Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use
scale
onImage.transformedSrc
instead.
Default value:1
-
metafield (
Metafield
)The metafield associated with the resource.
-
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.
Required access
unauthenticated_read_product_inventory
access scope. -
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.
-
sku (
String
)The SKU (stock keeping unit) associated with the variant.
-
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.
Types that return ProductVariant
Implements
Deprecated fields
-
available (
Boolean
) deprecatedIndicates if the product variant is in stock.
Deprecation warning
Use
availableForSale
instead -
compareAtPrice (
Money
) deprecatedThe compare at price of the variant. This can be used to mark a variant as on sale, when
compareAtPrice
is higher thanprice
.Deprecation warning
Use
compareAtPriceV2
instead -
price (
Money!
) deprecatedThe product variant’s price.
Deprecation warning
Use
priceV2
instead
An auto-generated type for paginating through multiple ProductVariants.
On this page
Fields
-
edges (
[ProductVariantEdge!]!
)A list of edges.
-
pageInfo (
PageInfo!
)Information to aid in pagination.
An auto-generated type which holds one ProductVariant and a cursor during pagination.
On this page
Fields
-
cursor (
String!
)A cursor for use in pagination.
-
node (
ProductVariant!
)The item at the end of ProductVariantEdge.
Types that return ProductVariantEdge
A product variant represents a different version of a product, such as differing sizes or differing colors.
Required access
unauthenticated_read_product_listings
access scope.
Connections
-
metafields (
MetafieldConnection!
)A paginated list of metafields associated with the resource.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.namespace
(String
)Container for a set of metafields (maximum of 20 characters).
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
presentmentPrices (
ProductVariantPricePairConnection!
)List of prices and compare-at prices in the presentment currencies for this shop.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.presentmentCurrencies
([CurrencyCode!]
)The presentment currencies prices should return in.
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
presentmentUnitPrices (
MoneyV2Connection!
)List of unit prices in the presentment currencies for this shop.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.presentmentCurrencies
([CurrencyCode!]
)Specify the currencies in which to return presentment unit prices.
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
Fields
-
availableForSale (
Boolean!
)Indicates if the product variant is available for sale.
-
compareAtPriceV2 (
MoneyV2
)The compare at price of the variant. This can be used to mark a variant as on sale, when
compareAtPriceV2
is higher thanpriceV2
. -
currentlyNotInStock (
Boolean!
)Whether a product is out of stock but still available for purchase (used for backorders).
-
id (
ID!
)Globally unique identifier.
-
image (
Image
)Image associated with the product variant. This field falls back to the product image if no image is available.
Argument Description crop
(CropRegion
)Crops the image according to the specified region. This argument is deprecated: Use
crop
onImage.transformedSrc
instead.maxHeight
(Int
)Image height in pixels between 1 and 2048. This argument is deprecated: Use
maxHeight
onImage.transformedSrc
instead.maxWidth
(Int
)Image width in pixels between 1 and 2048. This argument is deprecated: Use
maxWidth
onImage.transformedSrc
instead.scale
(Int
)Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use
scale
onImage.transformedSrc
instead.
Default value:1
-
metafield (
Metafield
)The metafield associated with the resource.
-
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.
Required access
unauthenticated_read_product_inventory
access scope. -
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.
-
sku (
String
)The SKU (stock keeping unit) associated with the variant.
-
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.
Types that return ProductVariant
Implements
Deprecated fields
-
available (
Boolean
) deprecatedIndicates if the product variant is in stock.
Deprecation warning
Use
availableForSale
instead -
compareAtPrice (
Money
) deprecatedThe compare at price of the variant. This can be used to mark a variant as on sale, when
compareAtPrice
is higher thanprice
.Deprecation warning
Use
compareAtPriceV2
instead -
price (
Money!
) deprecatedThe product variant’s price.
Deprecation warning
Use
priceV2
instead
An auto-generated type for paginating through multiple ProductVariants.
On this page
Fields
-
edges (
[ProductVariantEdge!]!
)A list of edges.
-
pageInfo (
PageInfo!
)Information to aid in pagination.
An auto-generated type which holds one ProductVariant and a cursor during pagination.
On this page
Fields
-
cursor (
String!
)A cursor for use in pagination.
-
node (
ProductVariant!
)The item at the end of ProductVariantEdge.
Types that return ProductVariantEdge
A product variant represents a different version of a product, such as differing sizes or differing colors.
Required access
unauthenticated_read_product_listings
access scope.
Connections
-
metafields (
MetafieldConnection!
)A paginated list of metafields associated with the resource.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.namespace
(String
)Container for a set of metafields (maximum of 20 characters).
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
presentmentPrices (
ProductVariantPricePairConnection!
)List of prices and compare-at prices in the presentment currencies for this shop.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.presentmentCurrencies
([CurrencyCode!]
)The presentment currencies prices should return in.
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
presentmentUnitPrices (
MoneyV2Connection!
)List of unit prices in the presentment currencies for this shop.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.presentmentCurrencies
([CurrencyCode!]
)Specify the currencies in which to return presentment unit prices.
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
Fields
-
availableForSale (
Boolean!
)Indicates if the product variant is available for sale.
-
compareAtPriceV2 (
MoneyV2
)The compare at price of the variant. This can be used to mark a variant as on sale, when
compareAtPriceV2
is higher thanpriceV2
. -
currentlyNotInStock (
Boolean!
)Whether a product is out of stock but still available for purchase (used for backorders).
-
id (
ID!
)Globally unique identifier.
-
image (
Image
)Image associated with the product variant. This field falls back to the product image if no image is available.
Argument Description crop
(CropRegion
)Crops the image according to the specified region. This argument is deprecated: Use
crop
onImage.transformedSrc
instead.maxHeight
(Int
)Image height in pixels between 1 and 2048. This argument is deprecated: Use
maxHeight
onImage.transformedSrc
instead.maxWidth
(Int
)Image width in pixels between 1 and 2048. This argument is deprecated: Use
maxWidth
onImage.transformedSrc
instead.scale
(Int
)Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use
scale
onImage.transformedSrc
instead.
Default value:1
-
metafield (
Metafield
)The metafield associated with the resource.
-
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.
Required access
unauthenticated_read_product_inventory
access scope. -
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.
-
sku (
String
)The SKU (stock keeping unit) associated with the variant.
-
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.
Types that return ProductVariant
Implements
Deprecated fields
-
available (
Boolean
) deprecatedIndicates if the product variant is in stock.
Deprecation warning
Use
availableForSale
instead -
compareAtPrice (
Money
) deprecatedThe compare at price of the variant. This can be used to mark a variant as on sale, when
compareAtPrice
is higher thanprice
.Deprecation warning
Use
compareAtPriceV2
instead -
price (
Money!
) deprecatedThe product variant’s price.
Deprecation warning
Use
priceV2
instead
An auto-generated type for paginating through multiple ProductVariants.
On this page
Fields
-
edges (
[ProductVariantEdge!]!
)A list of edges.
-
pageInfo (
PageInfo!
)Information to aid in pagination.
An auto-generated type which holds one ProductVariant and a cursor during pagination.
On this page
Fields
-
cursor (
String!
)A cursor for use in pagination.
-
node (
ProductVariant!
)The item at the end of ProductVariantEdge.
Types that return ProductVariantEdge
A product variant represents a different version of a product, such as differing sizes or differing colors.
Required access
unauthenticated_read_product_listings
access scope.
Connections
-
metafields (
MetafieldConnection!
)A paginated list of metafields associated with the resource.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.namespace
(String
)Container for a set of metafields (maximum of 20 characters).
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
presentmentPrices (
ProductVariantPricePairConnection!
)List of prices and compare-at prices in the presentment currencies for this shop.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.presentmentCurrencies
([CurrencyCode!]
)The presentment currencies prices should return in.
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
presentmentUnitPrices (
MoneyV2Connection!
)List of unit prices in the presentment currencies for this shop.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.presentmentCurrencies
([CurrencyCode!]
)Specify the currencies in which to return presentment unit prices.
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
Fields
-
availableForSale (
Boolean!
)Indicates if the product variant is available for sale.
-
compareAtPriceV2 (
MoneyV2
)The compare at price of the variant. This can be used to mark a variant as on sale, when
compareAtPriceV2
is higher thanpriceV2
. -
currentlyNotInStock (
Boolean!
)Whether a product is out of stock but still available for purchase (used for backorders).
-
id (
ID!
)Globally unique identifier.
-
image (
Image
)Image associated with the product variant. This field falls back to the product image if no image is available.
Argument Description crop
(CropRegion
)Crops the image according to the specified region. This argument is deprecated: Use
crop
onImage.transformedSrc
instead.maxHeight
(Int
)Image height in pixels between 1 and 2048. This argument is deprecated: Use
maxHeight
onImage.transformedSrc
instead.maxWidth
(Int
)Image width in pixels between 1 and 2048. This argument is deprecated: Use
maxWidth
onImage.transformedSrc
instead.scale
(Int
)Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use
scale
onImage.transformedSrc
instead.
Default value:1
-
metafield (
Metafield
)The metafield associated with the resource.
-
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.
Required access
unauthenticated_read_product_inventory
access scope. -
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.
-
sku (
String
)The SKU (stock keeping unit) associated with the variant.
-
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.
Types that return ProductVariant
Implements
Deprecated fields
-
available (
Boolean
) deprecatedIndicates if the product variant is in stock.
Deprecation warning
Use
availableForSale
instead -
compareAtPrice (
Money
) deprecatedThe compare at price of the variant. This can be used to mark a variant as on sale, when
compareAtPrice
is higher thanprice
.Deprecation warning
Use
compareAtPriceV2
instead -
price (
Money!
) deprecatedThe product variant’s price.
Deprecation warning
Use
priceV2
instead
An auto-generated type for paginating through multiple ProductVariants.
On this page
Fields
-
edges (
[ProductVariantEdge!]!
)A list of edges.
-
pageInfo (
PageInfo!
)Information to aid in pagination.
An auto-generated type which holds one ProductVariant and a cursor during pagination.
On this page
Fields
-
cursor (
String!
)A cursor for use in pagination.
-
node (
ProductVariant!
)The item at the end of ProductVariantEdge.
Types that return ProductVariantEdge
A product variant represents a different version of a product, such as differing sizes or differing colors.
Required access
unauthenticated_read_product_listings
access scope.
Connections
-
metafields (
MetafieldConnection!
)A paginated list of metafields associated with the resource.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.namespace
(String
)Container for a set of metafields (maximum of 20 characters).
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
presentmentPrices (
ProductVariantPricePairConnection!
)List of prices and compare-at prices in the presentment currencies for this shop.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.presentmentCurrencies
([CurrencyCode!]
)The presentment currencies prices should return in.
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
presentmentUnitPrices (
MoneyV2Connection!
)List of unit prices in the presentment currencies for this shop.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.presentmentCurrencies
([CurrencyCode!]
)Specify the currencies in which to return presentment unit prices.
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
Fields
-
availableForSale (
Boolean!
)Indicates if the product variant is available for sale.
-
compareAtPriceV2 (
MoneyV2
)The compare at price of the variant. This can be used to mark a variant as on sale, when
compareAtPriceV2
is higher thanpriceV2
. -
currentlyNotInStock (
Boolean!
)Whether a product is out of stock but still available for purchase (used for backorders).
-
id (
ID!
)Globally unique identifier.
-
image (
Image
)Image associated with the product variant. This field falls back to the product image if no image is available.
Argument Description crop
(CropRegion
)Crops the image according to the specified region. This argument is deprecated: Use
crop
onImage.transformedSrc
instead.maxHeight
(Int
)Image height in pixels between 1 and 2048. This argument is deprecated: Use
maxHeight
onImage.transformedSrc
instead.maxWidth
(Int
)Image width in pixels between 1 and 2048. This argument is deprecated: Use
maxWidth
onImage.transformedSrc
instead.scale
(Int
)Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use
scale
onImage.transformedSrc
instead.
Default value:1
-
metafield (
Metafield
)The metafield associated with the resource.
-
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.
Required access
unauthenticated_read_product_inventory
access scope. -
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.
-
sku (
String
)The SKU (stock keeping unit) associated with the variant.
-
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.
Types that return ProductVariant
Implements
Deprecated fields
-
available (
Boolean
) deprecatedIndicates if the product variant is in stock.
Deprecation warning
Use
availableForSale
instead -
compareAtPrice (
Money
) deprecatedThe compare at price of the variant. This can be used to mark a variant as on sale, when
compareAtPrice
is higher thanprice
.Deprecation warning
Use
compareAtPriceV2
instead -
price (
Money!
) deprecatedThe product variant’s price.
Deprecation warning
Use
priceV2
instead
An auto-generated type for paginating through multiple ProductVariants.
On this page
Fields
-
edges (
[ProductVariantEdge!]!
)A list of edges.
-
pageInfo (
PageInfo!
)Information to aid in pagination.
An auto-generated type which holds one ProductVariant and a cursor during pagination.
On this page
Fields
-
cursor (
String!
)A cursor for use in pagination.
-
node (
ProductVariant!
)The item at the end of ProductVariantEdge.
Types that return ProductVariantEdge
A product variant represents a different version of a product, such as differing sizes or differing colors.
Required access
unauthenticated_read_product_listings
access scope.
Connections
-
metafields (
MetafieldConnection!
)A paginated list of metafields associated with the resource.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.namespace
(String
)Container for a set of metafields (maximum of 20 characters).
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
presentmentPrices (
ProductVariantPricePairConnection!
)List of prices and compare-at prices in the presentment currencies for this shop.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.presentmentCurrencies
([CurrencyCode!]
)The presentment currencies prices should return in.
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
presentmentUnitPrices (
MoneyV2Connection!
)List of unit prices in the presentment currencies for this shop.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.presentmentCurrencies
([CurrencyCode!]
)Specify the currencies in which to return presentment unit prices.
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
Fields
-
availableForSale (
Boolean!
)Indicates if the product variant is available for sale.
-
compareAtPriceV2 (
MoneyV2
)The compare at price of the variant. This can be used to mark a variant as on sale, when
compareAtPriceV2
is higher thanpriceV2
. -
currentlyNotInStock (
Boolean!
)Whether a product is out of stock but still available for purchase (used for backorders).
-
id (
ID!
)Globally unique identifier.
-
image (
Image
)Image associated with the product variant. This field falls back to the product image if no image is available.
Argument Description crop
(CropRegion
)Crops the image according to the specified region. This argument is deprecated: Use
crop
onImage.transformedSrc
instead.maxHeight
(Int
)Image height in pixels between 1 and 2048. This argument is deprecated: Use
maxHeight
onImage.transformedSrc
instead.maxWidth
(Int
)Image width in pixels between 1 and 2048. This argument is deprecated: Use
maxWidth
onImage.transformedSrc
instead.scale
(Int
)Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use
scale
onImage.transformedSrc
instead.
Default value:1
-
metafield (
Metafield
)The metafield associated with the resource.
-
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.
Required access
unauthenticated_read_product_inventory
access scope. -
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.
-
sku (
String
)The SKU (stock keeping unit) associated with the variant.
-
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.
Types that return ProductVariant
Implements
Deprecated fields
-
available (
Boolean
) deprecatedIndicates if the product variant is in stock.
Deprecation warning
Use
availableForSale
instead -
compareAtPrice (
Money
) deprecatedThe compare at price of the variant. This can be used to mark a variant as on sale, when
compareAtPrice
is higher thanprice
.Deprecation warning
Use
compareAtPriceV2
instead -
price (
Money!
) deprecatedThe product variant’s price.
Deprecation warning
Use
priceV2
instead
An auto-generated type for paginating through multiple ProductVariants.
On this page
Fields
-
edges (
[ProductVariantEdge!]!
)A list of edges.
-
pageInfo (
PageInfo!
)Information to aid in pagination.
An auto-generated type which holds one ProductVariant and a cursor during pagination.
On this page
Fields
-
cursor (
String!
)A cursor for use in pagination.
-
node (
ProductVariant!
)The item at the end of ProductVariantEdge.