ProductVariant object
Represents a product variant.
Required access
read_products
access scope.
On this page
Connections
-
media (
MediaConnection!
)The media associated with the product variant.
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.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
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
)Finds all metafields with a specific namespace under the resource.
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
-
privateMetafields (
PrivateMetafieldConnection!
)List of private metafields.
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
)Filter the private metafields by namespace.
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
Fields
-
availableForSale (
Boolean!
)Whether the product variant is available for sale.
-
barcode (
String
)The value of the barcode associated with the product.
-
compareAtPrice (
Money
)The compare-at price of the variant in the default shop currency.
-
createdAt (
DateTime!
)The date and time when the variant was created.
-
defaultCursor (
String!
)A default cursor that returns the single next record, sorted ascending by ID.
-
deliveryProfile (
DeliveryProfile
)The delivery profile for the variant.
-
displayName (
String!
)Display name of the variant, based on product's title + variant's title.
-
fulfillmentService (
FulfillmentService
)The fulfillment service associated with the product.
-
fulfillmentServiceEditable (
EditableProperty!
)Whether changes to the fulfillment service for the product variant are allowed.
-
id (
ID!
)Globally unique identifier.
-
image (
Image
)The featured image for the variant.
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
-
inventoryItem (
InventoryItem!
)The inventory item, which is used to query for inventory information.
-
inventoryPolicy (
ProductVariantInventoryPolicy!
)Whether customers are allowed to place an order for the product variant when it's out of stock.
-
inventoryQuantity (
Int
)The total sellable quantity of the variant.
-
legacyResourceId (
UnsignedInt64!
)The ID of the corresponding resource in the REST Admin API.
-
metafield (
Metafield
)The metafield associated with the resource.
-
position (
Int!
)The order of the product variant in the list of product variants. The first position in the list is 1.
-
price (
Money!
)The price of the product variant in the default shop currency.
-
privateMetafield (
PrivateMetafield
)Returns a private metafield found by namespace and key.
-
product (
Product!
)The product that this variant belongs to.
-
selectedOptions (
[SelectedOption!]!
)List of product options applied to the variant.
-
sellingPlanGroupCount (
Int!
)Count of selling plan groups associated with the product variant.
-
sku (
String
)An identifier for the product variant in the shop. Required in order to connect to a fulfillment service.
-
storefrontId (
StorefrontID!
)The storefront ID of the product variant.
-
taxCode (
String
)The tax code for the product variant.
-
taxable (
Boolean!
)Whether a tax is charged when the product variant is sold.
-
title (
String!
)The title of the product variant.
-
translations (
[PublishedTranslation!]!
)The translations associated with the resource.
Argument Description locale
(String!
) requiredFilters translations locale.
-
updatedAt (
DateTime!
)The date and time (ISO 8601 format) when the product variant was last modified.
-
weight (
Float
)The weight of the product variant in the unit system specified with weight_unit.
-
weightUnit (
WeightUnit!
)The unit of measurement that applies to the product variant's weight. If you don't specify a value for weight_unit, then the shop's default unit of measurement is applied. Valid values:
g
,kg
,oz
,lb
.
Types that return ProductVariant
-
CalculatedDraftOrderLineItem.variant
-
CalculatedLineItem.variant
-
DeliveryProfileItem.variants
-
DiscountProducts.productVariants
-
DraftOrderLineItem.variant
-
InventoryItem.variant
-
LineItem.variant
-
LineItemMutable.variant
-
OrderStagedChangeAddVariant.variant
-
PriceListPrice.variant
-
PriceRuleItemEntitlements.productVariants
-
PriceRuleLineItemPrerequisites.productVariants
-
Product.variants
-
ProductVariant.node
-
QueryRoot.productVariant
-
QueryRoot.productVariants
-
SellingPlanGroup.productVariants
Mutations for ProductVariant
-
Appends media from a product to variants of the product.
-
Creates a product variant.
-
Deletes a product variant.
-
Deletes media from product variants.
-
Adds multiple selling plan groups to a product variant.
-
Remove multiple groups from a product variant.
-
Updates a product variant.
-
Creates product variants in bulk.
-
Deletes product variants in bulk.
-
Bulk reorder product variants.
-
Updates product variants in bulk.
Implements
Deprecated fields
-
harmonizedSystemCode (
String
) deprecatedThe Harmonized System Code (or HS Tariff Code) for the variant.
Deprecation warning
Use
InventoryItem.harmonizedSystemCode
instead. -
inventoryManagement (
ProductVariantInventoryManagement!
) deprecatedThe fulfillment service that tracks the number of items in stock for the product variant.
Deprecation warning
Use tracked attribute on
inventoryItem
instead. -
requiresShipping (
Boolean!
) deprecatedWhether a customer needs to provide a shipping address when placing an order for the product variant.
Deprecation warning
Use
InventoryItem.requiresShipping
instead.
An auto-generated type for paginating through multiple ProductVariants.
Fields
-
edges (
[ProductVariantEdge!]!
)A list of edges.
-
pageInfo (
PageInfo!
)Information to aid in pagination.
Types that return ProductVariant
-
CalculatedDraftOrderLineItem.variant
-
CalculatedLineItem.variant
-
DeliveryProfileItem.variants
-
DiscountProducts.productVariants
-
DraftOrderLineItem.variant
-
InventoryItem.variant
-
LineItem.variant
-
LineItemMutable.variant
-
OrderStagedChangeAddVariant.variant
-
PriceListPrice.variant
-
PriceRuleItemEntitlements.productVariants
-
PriceRuleLineItemPrerequisites.productVariants
-
Product.variants
-
ProductVariant.node
-
QueryRoot.productVariant
-
QueryRoot.productVariants
-
SellingPlanGroup.productVariants
Mutations for ProductVariant
-
Appends media from a product to variants of the product.
-
Creates a product variant.
-
Deletes a product variant.
-
Deletes media from product variants.
-
Adds multiple selling plan groups to a product variant.
-
Remove multiple groups from a product variant.
-
Updates a product variant.
-
Creates product variants in bulk.
-
Deletes product variants in bulk.
-
Bulk reorder product variants.
-
Updates product variants in bulk.
An auto-generated type which holds one ProductVariant and a cursor during pagination.
Fields
-
cursor (
String!
)A cursor for use in pagination.
-
node (
ProductVariant!
)The item at the end of ProductVariantEdge.
Types that return ProductVariant
-
CalculatedDraftOrderLineItem.variant
-
CalculatedLineItem.variant
-
DeliveryProfileItem.variants
-
DiscountProducts.productVariants
-
DraftOrderLineItem.variant
-
InventoryItem.variant
-
LineItem.variant
-
LineItemMutable.variant
-
OrderStagedChangeAddVariant.variant
-
PriceListPrice.variant
-
PriceRuleItemEntitlements.productVariants
-
PriceRuleLineItemPrerequisites.productVariants
-
Product.variants
-
ProductVariant.node
-
QueryRoot.productVariant
-
QueryRoot.productVariants
-
SellingPlanGroup.productVariants
Mutations for ProductVariant
-
Appends media from a product to variants of the product.
-
Creates a product variant.
-
Deletes a product variant.
-
Deletes media from product variants.
-
Adds multiple selling plan groups to a product variant.
-
Remove multiple groups from a product variant.
-
Updates a product variant.
-
Creates product variants in bulk.
-
Deletes product variants in bulk.
-
Bulk reorder product variants.
-
Updates product variants in bulk.
Represents a product variant.
Required access
read_products
access scope.
On this page
Connections
-
media (
MediaConnection!
)The media associated with the product variant.
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.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
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
)Finds all metafields with a specific namespace under the resource.
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
-
privateMetafields (
PrivateMetafieldConnection!
)List of private metafields.
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
)Filter the private metafields by namespace.
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
Fields
-
availableForSale (
Boolean!
)Whether the product variant is available for sale.
-
barcode (
String
)The value of the barcode associated with the product.
-
compareAtPrice (
Money
)The compare-at price of the variant in the default shop currency.
-
createdAt (
DateTime!
)The date and time when the variant was created.
-
defaultCursor (
String!
)A default cursor that returns the single next record, sorted ascending by ID.
-
deliveryProfile (
DeliveryProfile
)The delivery profile for the variant.
-
displayName (
String!
)Display name of the variant, based on product's title + variant's title.
-
fulfillmentService (
FulfillmentService
)The fulfillment service associated with the product.
-
fulfillmentServiceEditable (
EditableProperty!
)Whether changes to the fulfillment service for the product variant are allowed.
-
id (
ID!
)Globally unique identifier.
-
image (
Image
)The featured image for the variant.
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
-
inventoryItem (
InventoryItem!
)The inventory item, which is used to query for inventory information.
-
inventoryPolicy (
ProductVariantInventoryPolicy!
)Whether customers are allowed to place an order for the product variant when it's out of stock.
-
inventoryQuantity (
Int
)The total sellable quantity of the variant.
-
legacyResourceId (
UnsignedInt64!
)The ID of the corresponding resource in the REST Admin API.
-
metafield (
Metafield
)The metafield associated with the resource.
-
position (
Int!
)The order of the product variant in the list of product variants. The first position in the list is 1.
-
price (
Money!
)The price of the product variant in the default shop currency.
-
privateMetafield (
PrivateMetafield
)Returns a private metafield found by namespace and key.
-
product (
Product!
)The product that this variant belongs to.
-
selectedOptions (
[SelectedOption!]!
)List of product options applied to the variant.
-
sellingPlanGroupCount (
Int!
)Count of selling plan groups associated with the product variant.
-
sku (
String
)An identifier for the product variant in the shop. Required in order to connect to a fulfillment service.
-
storefrontId (
StorefrontID!
)The storefront ID of the product variant.
-
taxCode (
String
)The tax code for the product variant.
-
taxable (
Boolean!
)Whether a tax is charged when the product variant is sold.
-
title (
String!
)The title of the product variant.
-
translations (
[PublishedTranslation!]!
)The translations associated with the resource.
Argument Description locale
(String!
) requiredFilters translations locale.
-
updatedAt (
DateTime!
)The date and time (ISO 8601 format) when the product variant was last modified.
-
weight (
Float
)The weight of the product variant in the unit system specified with weight_unit.
-
weightUnit (
WeightUnit!
)The unit of measurement that applies to the product variant's weight. If you don't specify a value for weight_unit, then the shop's default unit of measurement is applied. Valid values:
g
,kg
,oz
,lb
.
Types that return ProductVariant
-
CalculatedDraftOrderLineItem.variant
-
CalculatedLineItem.variant
-
DeliveryProfileItem.variants
-
DiscountProducts.productVariants
-
DraftOrderLineItem.variant
-
InventoryItem.variant
-
LineItem.variant
-
LineItemMutable.variant
-
OrderStagedChangeAddVariant.variant
-
PriceListPrice.variant
-
PriceRuleItemEntitlements.productVariants
-
PriceRuleLineItemPrerequisites.productVariants
-
Product.variants
-
QueryRoot.productVariant
-
QueryRoot.productVariants
-
SellingPlanGroup.productVariants
Mutations for ProductVariant
-
Appends media from a product to variants of the product.
-
Creates a product variant.
-
Deletes a product variant.
-
Deletes media from product variants.
-
Adds multiple selling plan groups to a product variant.
-
Remove multiple groups from a product variant.
-
Updates a product variant.
-
Creates product variants in bulk.
-
Deletes product variants in bulk.
-
Bulk reorder product variants.
-
Updates product variants in bulk.
Implements
Deprecated fields
-
harmonizedSystemCode (
String
) deprecatedThe Harmonized System Code (or HS Tariff Code) for the variant.
Deprecation warning
Use
InventoryItem.harmonizedSystemCode
instead. -
inventoryManagement (
ProductVariantInventoryManagement!
) deprecatedThe fulfillment service that tracks the number of items in stock for the product variant.
Deprecation warning
Use tracked attribute on
inventoryItem
instead. -
requiresShipping (
Boolean!
) deprecatedWhether a customer needs to provide a shipping address when placing an order for the product variant.
Deprecation warning
Use
InventoryItem.requiresShipping
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
Represents a product variant.
Required access
read_products
access scope.
On this page
Connections
-
media (
MediaConnection!
)The media associated with the product variant.
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.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
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
)Finds all metafields with a specific namespace under the resource.
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
-
privateMetafields (
PrivateMetafieldConnection!
)List of private metafields.
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
)Filter the private metafields by namespace.
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
Fields
-
availableForSale (
Boolean!
)Whether the product variant is available for sale.
-
barcode (
String
)The value of the barcode associated with the product.
-
compareAtPrice (
Money
)The compare-at price of the variant in the default shop currency.
-
createdAt (
DateTime!
)The date and time when the variant was created.
-
defaultCursor (
String!
)A default cursor that returns the single next record, sorted ascending by ID.
-
deliveryProfile (
DeliveryProfile
)The delivery profile for the variant.
-
displayName (
String!
)Display name of the variant, based on product's title + variant's title.
-
fulfillmentService (
FulfillmentService
)The fulfillment service associated with the product.
-
fulfillmentServiceEditable (
EditableProperty!
)Whether changes to the fulfillment service for the product variant are allowed.
-
id (
ID!
)Globally unique identifier.
-
image (
Image
)The featured image for the variant.
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
-
inventoryItem (
InventoryItem!
)The inventory item, which is used to query for inventory information.
-
inventoryPolicy (
ProductVariantInventoryPolicy!
)Whether customers are allowed to place an order for the product variant when it's out of stock.
-
inventoryQuantity (
Int
)The total sellable quantity of the variant.
-
legacyResourceId (
UnsignedInt64!
)The ID of the corresponding resource in the REST Admin API.
-
metafield (
Metafield
)The metafield associated with the resource.
-
position (
Int!
)The order of the product variant in the list of product variants. The first position in the list is 1.
-
price (
Money!
)The price of the product variant in the default shop currency.
-
privateMetafield (
PrivateMetafield
)Returns a private metafield found by namespace and key.
-
product (
Product!
)The product that this variant belongs to.
-
selectedOptions (
[SelectedOption!]!
)List of product options applied to the variant.
-
sellingPlanGroupCount (
Int!
)Count of selling plan groups associated with the product variant.
-
sku (
String
)An identifier for the product variant in the shop. Required in order to connect to a fulfillment service.
-
storefrontId (
StorefrontID!
)The storefront ID of the product variant.
-
taxCode (
String
)The tax code for the product variant.
-
taxable (
Boolean!
)Whether a tax is charged when the product variant is sold.
-
title (
String!
)The title of the product variant.
-
translations (
[PublishedTranslation!]!
)The translations associated with the resource.
Argument Description locale
(String!
) requiredFilters translations locale.
-
updatedAt (
DateTime!
)The date and time (ISO 8601 format) when the product variant was last modified.
-
weight (
Float
)The weight of the product variant in the unit system specified with weight_unit.
-
weightUnit (
WeightUnit!
)The unit of measurement that applies to the product variant's weight. If you don't specify a value for weight_unit, then the shop's default unit of measurement is applied. Valid values:
g
,kg
,oz
,lb
.
Types that return ProductVariant
-
CalculatedDraftOrderLineItem.variant
-
CalculatedLineItem.variant
-
DeliveryProfileItem.variants
-
DiscountProducts.productVariants
-
DraftOrderLineItem.variant
-
InventoryItem.variant
-
LineItem.variant
-
LineItemMutable.variant
-
OrderStagedChangeAddVariant.variant
-
PriceListPrice.variant
-
PriceRuleItemEntitlements.productVariants
-
PriceRuleLineItemPrerequisites.productVariants
-
Product.variants
-
QueryRoot.productVariant
-
QueryRoot.productVariants
-
SellingPlanGroup.productVariants
Mutations for ProductVariant
-
Appends media from a product to variants of the product.
-
Creates a product variant.
-
Deletes a product variant.
-
Deletes media from product variants.
-
Adds multiple selling plan groups to a product variant.
-
Remove multiple groups from a product variant.
-
Updates a product variant.
Implements
Deprecated fields
-
harmonizedSystemCode (
String
) deprecatedThe Harmonized System Code (or HS Tariff Code) for the variant.
Deprecation warning
Use
InventoryItem.harmonizedSystemCode
instead. -
inventoryManagement (
ProductVariantInventoryManagement!
) deprecatedThe fulfillment service that tracks the number of items in stock for the product variant.
Deprecation warning
Use tracked attribute on
inventoryItem
instead. -
requiresShipping (
Boolean!
) deprecatedWhether a customer needs to provide a shipping address when placing an order for the product variant.
Deprecation warning
Use
InventoryItem.requiresShipping
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
Represents a product variant.
Required access
read_products
access scope.
On this page
Connections
-
media (
MediaConnection!
)The media associated with the product variant.
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.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
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
)Finds all metafields with a specific namespace under the resource.
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
-
privateMetafields (
PrivateMetafieldConnection!
)List of private metafields.
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
)Filter the private metafields by namespace.
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
Fields
-
availableForSale (
Boolean!
)Whether the product variant is available for sale.
-
barcode (
String
)The value of the barcode associated with the product.
-
compareAtPrice (
Money
)The compare-at price of the variant in the default shop currency.
-
createdAt (
DateTime!
)The date and time when the variant was created.
-
defaultCursor (
String!
)A default cursor that returns the single next record, sorted ascending by ID.
-
deliveryProfile (
DeliveryProfile
)The delivery profile for the variant.
-
displayName (
String!
)Display name of the variant, based on product's title + variant's title.
-
fulfillmentService (
FulfillmentService
)The fulfillment service associated with the product.
-
fulfillmentServiceEditable (
EditableProperty!
)Whether changes to the fulfillment service for the product variant are allowed.
-
id (
ID!
)Globally unique identifier.
-
image (
Image
)The featured image for the variant.
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
-
inventoryItem (
InventoryItem!
)The inventory item, which is used to query for inventory information.
-
inventoryPolicy (
ProductVariantInventoryPolicy!
)Whether customers are allowed to place an order for the product variant when it's out of stock.
-
inventoryQuantity (
Int
)The total sellable quantity of the variant.
-
legacyResourceId (
UnsignedInt64!
)The ID of the corresponding resource in the REST Admin API.
-
metafield (
Metafield
)The metafield associated with the resource.
-
position (
Int!
)The order of the product variant in the list of product variants. The first position in the list is 1.
-
price (
Money!
)The price of the product variant in the default shop currency.
-
privateMetafield (
PrivateMetafield
)Returns a private metafield found by namespace and key.
-
product (
Product!
)The product that this variant belongs to.
-
selectedOptions (
[SelectedOption!]!
)List of product options applied to the variant.
-
sellingPlanGroupCount (
Int!
)Count of selling plan groups associated with the product variant.
-
sku (
String
)An identifier for the product variant in the shop. Required in order to connect to a fulfillment service.
-
storefrontId (
StorefrontID!
)The storefront ID of the product variant.
-
taxCode (
String
)The tax code for the product variant.
-
taxable (
Boolean!
)Whether a tax is charged when the product variant is sold.
-
title (
String!
)The title of the product variant.
-
translations (
[PublishedTranslation!]!
)The translations associated with the resource.
Argument Description locale
(String!
) requiredFilters translations locale.
-
updatedAt (
DateTime!
)The date and time (ISO 8601 format) when the product variant was last modified.
-
weight (
Float
)The weight of the product variant in the unit system specified with weight_unit.
-
weightUnit (
WeightUnit!
)The unit of measurement that applies to the product variant's weight. If you don't specify a value for weight_unit, then the shop's default unit of measurement is applied. Valid values:
g
,kg
,oz
,lb
.
Types that return ProductVariant
-
CalculatedDraftOrderLineItem.variant
-
CalculatedLineItem.variant
-
DeliveryProfileItem.variants
-
DiscountProducts.productVariants
-
DraftOrderLineItem.variant
-
InventoryItem.variant
-
LineItem.variant
-
LineItemMutable.variant
-
OrderStagedChangeAddVariant.variant
-
PriceRuleItemEntitlements.productVariants
-
PriceRuleLineItemPrerequisites.productVariants
-
Product.variants
-
QueryRoot.productVariant
-
QueryRoot.productVariants
-
SellingPlanGroup.productVariants
Mutations for ProductVariant
-
Appends media from a product to variants of the product.
-
Creates a product variant.
-
Deletes a product variant.
-
Deletes media from product variants.
-
Adds multiple selling plan groups to a product variant.
-
Remove multiple groups from a product variant.
-
Updates a product variant.
Implements
Deprecated fields
-
harmonizedSystemCode (
String
) deprecatedThe Harmonized System Code (or HS Tariff Code) for the variant.
Deprecation warning
Use
InventoryItem.harmonizedSystemCode
instead. -
inventoryManagement (
ProductVariantInventoryManagement!
) deprecatedThe fulfillment service that tracks the number of items in stock for the product variant.
Deprecation warning
Use tracked attribute on
inventoryItem
instead. -
requiresShipping (
Boolean!
) deprecatedWhether a customer needs to provide a shipping address when placing an order for the product variant.
Deprecation warning
Use
InventoryItem.requiresShipping
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
Represents a product variant.
Required access
read_products
access scope.
On this page
Connections
-
media (
MediaConnection!
)The media associated with the product variant.
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.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
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
)Finds all metafields with a specific namespace under the resource.
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
-
privateMetafields (
PrivateMetafieldConnection!
)List of private metafields.
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
)Filter the private metafields by namespace.
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
Fields
-
availableForSale (
Boolean!
)Whether the product variant is available for sale.
-
barcode (
String
)The value of the barcode associated with the product.
-
compareAtPrice (
Money
)The compare-at price of the variant in the default shop currency.
-
createdAt (
DateTime!
)The date and time when the variant was created.
-
defaultCursor (
String!
)A default cursor that returns the single next record, sorted ascending by ID.
-
deliveryProfile (
DeliveryProfile
)The delivery profile for the variant.
-
displayName (
String!
)Display name of the variant, based on product's title + variant's title.
-
fulfillmentService (
FulfillmentService
)The fulfillment service associated with the product.
-
fulfillmentServiceEditable (
EditableProperty!
)Whether changes to the fulfillment service for the product variant are allowed.
-
id (
ID!
)Globally unique identifier.
-
image (
Image
)The featured image for the variant.
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
-
inventoryItem (
InventoryItem!
)The inventory item, which is used to query for inventory information.
-
inventoryPolicy (
ProductVariantInventoryPolicy!
)Whether customers are allowed to place an order for the product variant when it's out of stock.
-
inventoryQuantity (
Int
)The total sellable quantity of the variant.
-
legacyResourceId (
UnsignedInt64!
)The ID of the corresponding resource in the REST Admin API.
-
metafield (
Metafield
)The metafield associated with the resource.
-
position (
Int!
)The order of the product variant in the list of product variants. The first position in the list is 1.
-
price (
Money!
)The price of the product variant in the default shop currency.
-
privateMetafield (
PrivateMetafield
)Returns a private metafield found by namespace and key.
-
product (
Product!
)The product that this variant belongs to.
-
selectedOptions (
[SelectedOption!]!
)List of product options applied to the variant.
-
sku (
String
)An identifier for the product variant in the shop. Required in order to connect to a fulfillment service.
-
storefrontId (
StorefrontID!
)The storefront ID of the product variant.
-
taxCode (
String
)The tax code for the product variant.
-
taxable (
Boolean!
)Whether a tax is charged when the product variant is sold.
-
title (
String!
)The title of the product variant.
-
translations (
[PublishedTranslation!]!
)The translations associated with the resource.
Argument Description locale
(String!
) requiredFilters translations locale.
-
updatedAt (
DateTime!
)The date and time (ISO 8601 format) when the product variant was last modified.
-
weight (
Float
)The weight of the product variant in the unit system specified with weight_unit.
-
weightUnit (
WeightUnit!
)The unit of measurement that applies to the product variant's weight. If you don't specify a value for weight_unit, then the shop's default unit of measurement is applied. Valid values:
g
,kg
,oz
,lb
.
Types that return ProductVariant
-
CalculatedDraftOrderLineItem.variant
-
CalculatedLineItem.variant
-
DeliveryProfileItem.variants
-
DiscountProducts.productVariants
-
DraftOrderLineItem.variant
-
InventoryItem.variant
-
LineItem.variant
-
LineItemMutable.variant
-
OrderStagedChangeAddVariant.variant
-
PriceRuleItemEntitlements.productVariants
-
PriceRuleLineItemPrerequisites.productVariants
-
Product.variants
-
QueryRoot.productVariant
-
QueryRoot.productVariants
Mutations for ProductVariant
-
Appends media from a product to variants of the product.
-
Creates a product variant.
-
Deletes a product variant.
-
Deletes media from product variants.
-
Updates a product variant.
Implements
Deprecated fields
-
harmonizedSystemCode (
String
) deprecatedThe Harmonized System Code (or HS Tariff Code) for the variant.
Deprecation warning
Use
InventoryItem.harmonizedSystemCode
instead. -
inventoryManagement (
ProductVariantInventoryManagement!
) deprecatedThe fulfillment service that tracks the number of items in stock for the product variant.
Deprecation warning
Use tracked attribute on
inventoryItem
instead. -
requiresShipping (
Boolean!
) deprecatedWhether a customer needs to provide a shipping address when placing an order for the product variant.
Deprecation warning
Use
InventoryItem.requiresShipping
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
Represents a product variant.
Required access
read_products
access scope.
On this page
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
)Finds all metafields with a specific namespace under the resource.
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
-
privateMetafields (
PrivateMetafieldConnection!
)List of private metafields.
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
)Filter the private metafields by namespace.
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
Fields
-
availableForSale (
Boolean!
)Whether the product variant is available for sale.
-
barcode (
String
)The value of the barcode associated with the product.
-
compareAtPrice (
Money
)The compare-at price of the variant in the default shop currency.
-
createdAt (
DateTime!
)The date and time when the variant was created.
-
defaultCursor (
String!
)A default cursor that returns the single next record, sorted ascending by ID.
-
deliveryProfile (
DeliveryProfile
)The delivery profile for the variant.
-
displayName (
String!
)Display name of the variant, based on product's title + variant's title.
-
fulfillmentService (
FulfillmentService
)The fulfillment service associated with the product.
-
fulfillmentServiceEditable (
EditableProperty!
)Whether changes to the fulfillment service for the product variant are allowed.
-
id (
ID!
)Globally unique identifier.
-
image (
Image
)The featured image for the variant.
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
-
inventoryItem (
InventoryItem!
)The inventory item, which is used to query for inventory information.
-
inventoryPolicy (
ProductVariantInventoryPolicy!
)Whether customers are allowed to place an order for the product variant when it's out of stock.
-
inventoryQuantity (
Int
)The total sellable quantity of the variant.
-
legacyResourceId (
UnsignedInt64!
)The ID of the corresponding resource in the REST Admin API.
-
metafield (
Metafield
)The metafield associated with the resource.
-
position (
Int!
)The order of the product variant in the list of product variants. The first position in the list is 1.
-
price (
Money!
)The price of the product variant in the default shop currency.
-
privateMetafield (
PrivateMetafield
)Returns a private metafield found by namespace and key.
-
product (
Product!
)The product that this variant belongs to.
-
selectedOptions (
[SelectedOption!]!
)List of product options applied to the variant.
-
sku (
String
)An identifier for the product variant in the shop. Required in order to connect to a fulfillment service.
-
storefrontId (
StorefrontID!
)The storefront ID of the product variant.
-
taxCode (
String
)The tax code for the product variant.
-
taxable (
Boolean!
)Whether a tax is charged when the product variant is sold.
-
title (
String!
)The title of the product variant.
-
translations (
[PublishedTranslation!]!
)The translations associated with the resource.
Argument Description locale
(String!
) requiredFilters translations locale.
-
updatedAt (
DateTime!
)The date and time (ISO 8601 format) when the product variant was last modified.
-
weight (
Float
)The weight of the product variant in the unit system specified with weight_unit.
-
weightUnit (
WeightUnit!
)The unit of measurement that applies to the product variant's weight. If you don't specify a value for weight_unit, then the shop's default unit of measurement is applied. Valid values:
g
,kg
,oz
,lb
.
Types that return ProductVariant
-
CalculatedDraftOrderLineItem.variant
-
CalculatedLineItem.variant
-
DeliveryProfileItem.variants
-
DiscountProducts.productVariants
-
DraftOrderLineItem.variant
-
InventoryItem.variant
-
LineItem.variant
-
LineItemMutable.variant
-
OrderStagedChangeAddVariant.variant
-
PriceRuleItemEntitlements.productVariants
-
PriceRuleLineItemPrerequisites.productVariants
-
Product.variants
-
QueryRoot.productVariant
-
QueryRoot.productVariants
Mutations for ProductVariant
-
Creates a product variant.
-
Deletes a product variant.
-
Updates a product variant.
Implements
Deprecated fields
-
harmonizedSystemCode (
String
) deprecatedThe Harmonized System Code (or HS Tariff Code) for the variant.
Deprecation warning
Use
InventoryItem.harmonizedSystemCode
instead. -
inventoryManagement (
ProductVariantInventoryManagement!
) deprecatedThe fulfillment service that tracks the number of items in stock for the product variant.
Deprecation warning
Use tracked attribute on
inventoryItem
instead. -
requiresShipping (
Boolean!
) deprecatedWhether a customer needs to provide a shipping address when placing an order for the product variant.
Deprecation warning
Use
InventoryItem.requiresShipping
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
Represents a product variant.
Required access
read_products
access scope.
On this page
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
)Finds all metafields with a specific namespace under the resource.
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
-
privateMetafields (
PrivateMetafieldConnection!
)List of private metafields.
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
)Filter the private metafields by namespace.
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
Fields
-
availableForSale (
Boolean!
)Whether the product variant is available for sale.
-
barcode (
String
)The value of the barcode associated with the product.
-
compareAtPrice (
Money
)The compare-at price of the variant in the default shop currency.
-
createdAt (
DateTime!
)The date and time when the variant was created.
-
defaultCursor (
String!
)A default cursor that returns the single next record, sorted ascending by ID.
-
deliveryProfile (
DeliveryProfile
)The delivery profile for the variant.
-
displayName (
String!
)Display name of the variant, based on product's title + variant's title.
-
fulfillmentService (
FulfillmentService
)The fulfillment service associated with the product.
-
fulfillmentServiceEditable (
EditableProperty!
)Whether changes to the fulfillment service for the product variant are allowed.
-
id (
ID!
)Globally unique identifier.
-
image (
Image
)The featured image for the variant.
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
-
inventoryItem (
InventoryItem!
)The inventory item, which is used to query for inventory information.
-
inventoryPolicy (
ProductVariantInventoryPolicy!
)Whether customers are allowed to place an order for the product variant when it's out of stock.
-
inventoryQuantity (
Int
)The total sellable quantity of the variant.
-
legacyResourceId (
UnsignedInt64!
)The ID of the corresponding resource in the REST Admin API.
-
metafield (
Metafield
)The metafield associated with the resource.
-
position (
Int!
)The order of the product variant in the list of product variants. The first position in the list is 1.
-
price (
Money!
)The price of the product variant in the default shop currency.
-
privateMetafield (
PrivateMetafield
)Returns a private metafield found by namespace and key.
-
product (
Product!
)The product that this variant belongs to.
-
selectedOptions (
[SelectedOption!]!
)List of product options applied to the variant.
-
sku (
String
)An identifier for the product variant in the shop. Required in order to connect to a fulfillment service.
-
storefrontId (
StorefrontID!
)The storefront ID of the product variant.
-
taxCode (
String
)The tax code for the product variant.
-
taxable (
Boolean!
)Whether a tax is charged when the product variant is sold.
-
title (
String!
)The title of the product variant.
-
translations (
[PublishedTranslation!]!
)The translations associated with the resource.
Argument Description locale
(String!
) requiredFilters translations locale.
-
updatedAt (
DateTime!
)The date and time (ISO 8601 format) when the product variant was last modified.
-
weight (
Float
)The weight of the product variant in the unit system specified with weight_unit.
-
weightUnit (
WeightUnit!
)The unit of measurement that applies to the product variant's weight. If you don't specify a value for weight_unit, then the shop's default unit of measurement is applied. Valid values:
g
,kg
,oz
,lb
.
Types that return ProductVariant
-
CalculatedDraftOrderLineItem.variant
-
CalculatedLineItem.variant
-
DeliveryProfileItem.variants
-
DiscountProducts.productVariants
-
DraftOrderLineItem.variant
-
InventoryItem.variant
-
LineItem.variant
-
LineItemMutable.variant
-
OrderStagedChangeAddVariant.variant
-
PriceRuleItemEntitlements.productVariants
-
PriceRuleLineItemPrerequisites.productVariants
-
Product.variants
-
QueryRoot.productVariant
-
QueryRoot.productVariants
Mutations for ProductVariant
-
Creates a product variant.
-
Deletes a product variant.
-
Updates a product variant.
Implements
Deprecated fields
-
harmonizedSystemCode (
String
) deprecatedThe Harmonized System Code (or HS Tariff Code) for the variant.
Deprecation warning
Use
InventoryItem.harmonizedSystemCode
instead. -
images (
[Image!]!
) deprecatedThe featured image for the variant.
Deprecation warning
Use the singular
image
field instead. There may never be more than one variant image.Argument Description crop
(CropRegion
)Crops the image according to the specified region. This argument is deprecated: Use
crop
onImage.transformedSrc
instead.first
(Int
)Truncate the array result to this size.
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
-
inventoryManagement (
ProductVariantInventoryManagement!
) deprecatedThe fulfillment service that tracks the number of items in stock for the product variant.
Deprecation warning
Use tracked attribute on
inventoryItem
instead. -
requiresShipping (
Boolean!
) deprecatedWhether a customer needs to provide a shipping address when placing an order for the product variant.
Deprecation warning
Use
InventoryItem.requiresShipping
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
Represents a product variant.
Required access
read_products
access scope.
On this page
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
)Finds all metafields with a specific namespace under the resource.
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
-
privateMetafields (
PrivateMetafieldConnection!
)List of private metafields.
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
)Filter the private metafields by namespace.
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
Fields
-
availableForSale (
Boolean!
)Whether the product variant is available for sale.
-
barcode (
String
)The value of the barcode associated with the product.
-
compareAtPrice (
Money
)The compare-at price of the variant in the default shop currency.
-
createdAt (
DateTime!
)The date and time when the variant was created.
-
defaultCursor (
String!
)A default cursor that returns the single next record, sorted ascending by ID.
-
deliveryProfile (
DeliveryProfile
)The delivery profile for the variant.
-
displayName (
String!
)Display name of the variant, based on product's title + variant's title.
-
fulfillmentService (
FulfillmentService
)The fulfillment service associated with the product.
-
fulfillmentServiceEditable (
EditableProperty!
)Whether changes to the fulfillment service for the product variant are allowed.
-
id (
ID!
)Globally unique identifier.
-
image (
Image
)The featured image for the variant.
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
-
inventoryItem (
InventoryItem!
)The inventory item, which is used to query for inventory information.
-
inventoryPolicy (
ProductVariantInventoryPolicy!
)Whether customers are allowed to place an order for the product variant when it's out of stock.
-
inventoryQuantity (
Int
)The total sellable quantity of the variant.
-
legacyResourceId (
UnsignedInt64!
)The ID of the corresponding resource in the REST Admin API.
-
metafield (
Metafield
)The metafield associated with the resource.
-
position (
Int!
)The order of the product variant in the list of product variants. The first position in the list is 1.
-
price (
Money!
)The price of the product variant in the default shop currency.
-
privateMetafield (
PrivateMetafield
)Returns a private metafield found by namespace and key.
-
product (
Product!
)The product that this variant belongs to.
-
selectedOptions (
[SelectedOption!]!
)List of product options applied to the variant.
-
sku (
String
)An identifier for the product variant in the shop. Required in order to connect to a fulfillment service.
-
storefrontId (
StorefrontID!
)The storefront ID of the product variant.
-
taxCode (
String
)The tax code for the product variant.
-
taxable (
Boolean!
)Whether a tax is charged when the product variant is sold.
-
title (
String!
)The title of the product variant.
-
translations (
[PublishedTranslation!]!
)The translations associated with the resource.
Argument Description locale
(String!
) requiredFilters translations locale.
-
updatedAt (
DateTime!
)The date and time (ISO 8601 format) when the product variant was last modified.
-
weight (
Float
)The weight of the product variant in the unit system specified with weight_unit.
-
weightUnit (
WeightUnit!
)The unit of measurement that applies to the product variant's weight. If you don't specify a value for weight_unit, then the shop's default unit of measurement is applied. Valid values:
g
,kg
,oz
,lb
.
Types that return ProductVariant
-
CalculatedDraftOrderLineItem.variant
-
CalculatedLineItem.variant
-
DeliveryProfileItem.variants
-
DiscountProducts.productVariants
-
DraftOrderLineItem.variant
-
InventoryItem.variant
-
LineItem.variant
-
LineItemMutable.variant
-
OrderStagedChangeAddVariant.variant
-
PriceRuleItemEntitlements.productVariants
-
PriceRuleLineItemPrerequisites.productVariants
-
Product.variants
-
QueryRoot.productVariant
-
QueryRoot.productVariants
Mutations for ProductVariant
-
Creates a product variant.
-
Deletes a product variant.
-
Updates a product variant.
Implements
Deprecated fields
-
harmonizedSystemCode (
String
) deprecatedThe Harmonized System Code (or HS Tariff Code) for the variant.
Deprecation warning
Use
InventoryItem.harmonizedSystemCode
instead. -
images (
[Image!]!
) deprecatedThe featured image for the variant.
Deprecation warning
Use the singular
image
field instead. There may never be more than one variant image.Argument Description crop
(CropRegion
)Crops the image according to the specified region. This argument is deprecated: Use
crop
onImage.transformedSrc
instead.first
(Int
)Truncate the array result to this size.
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
-
inventoryManagement (
ProductVariantInventoryManagement!
) deprecatedThe fulfillment service that tracks the number of items in stock for the product variant.
Deprecation warning
Use tracked attribute on
inventoryItem
instead. -
requiresShipping (
Boolean!
) deprecatedWhether a customer needs to provide a shipping address when placing an order for the product variant.
Deprecation warning
Use
InventoryItem.requiresShipping
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
Represents a product variant.
Required access
read_products
access scope.
On this page
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
)Finds all metafields with a specific namespace under the resource.
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
-
privateMetafields (
PrivateMetafieldConnection!
)List of private metafields.
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
)Filter the private metafields by namespace.
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
Fields
-
availableForSale (
Boolean!
)Whether the product variant is available for sale.
-
barcode (
String
)The value of the barcode associated with the product.
-
compareAtPrice (
Money
)The compare-at price of the variant in the default shop currency.
-
createdAt (
DateTime!
)The date and time when the variant was created.
-
defaultCursor (
String!
)A default cursor that returns the single next record, sorted ascending by ID.
-
deliveryProfile (
DeliveryProfile
)The delivery profile for the variant.
-
displayName (
String!
)Display name of the variant, based on product's title + variant's title.
-
fulfillmentService (
FulfillmentService
)The fulfillment service associated with the product.
-
fulfillmentServiceEditable (
EditableProperty!
)Whether changes to the fulfillment service for the product variant are allowed.
-
id (
ID!
)Globally unique identifier.
-
image (
Image
)The featured image for the variant.
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
-
inventoryItem (
InventoryItem!
)The inventory item, which is used to query for inventory information.
-
inventoryPolicy (
ProductVariantInventoryPolicy!
)Whether customers are allowed to place an order for the product variant when it's out of stock.
-
inventoryQuantity (
Int
)The total sellable quantity of the variant.
-
legacyResourceId (
UnsignedInt64!
)The ID of the corresponding resource in the REST Admin API.
-
metafield (
Metafield
)The metafield associated with the resource.
-
position (
Int!
)The order of the product variant in the list of product variants. The first position in the list is 1.
-
price (
Money!
)The price of the product variant in the default shop currency.
-
privateMetafield (
PrivateMetafield
)Returns a private metafield found by namespace and key.
Argument Description key
(String!
) requiredThe key for the private metafield.