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

  • sellingPlanAllocations (SellingPlanAllocationConnection!)

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

    Required access

    unauthenticated_read_selling_plans access scope.

    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

  • storeAvailability (StoreAvailabilityConnection!)

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

    Required access

    unauthenticated_read_product_pickup_locations access scope.

    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

Fields

  • availableForSale (Boolean!)

    Indicates if the product variant is available for sale.

  • barcode (String)

    The barcode (ISBN, UPC, GTIN, etc.) associated with the variant.

  • compareAtPriceV2 (MoneyV2)

    The compare at price of the variant. This can be used to mark a variant as on sale, when compareAtPriceV2 is higher than priceV2.

  • currentlyNotInStock (Boolean!)

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

  • id (ID!)

    A 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 on Image.transformedSrc instead.

    maxHeight ( Int )

    Image height in pixels between 1 and 2048. This argument is deprecated: Use maxHeight on Image.transformedSrc instead.

    maxWidth ( Int )

    Image width in pixels between 1 and 2048. This argument is deprecated: Use maxWidth on Image.transformedSrc instead.

    scale ( Int )

    Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use scale on Image.transformedSrc instead.
    Default value: 1

  • metafield (Metafield)

    Returns a metafield found by namespace and key.

    Argument Description
    key ( String! ) required

    Identifier for the metafield (maximum of 30 characters).

    namespace ( String! ) required

    Container for a set of metafields (maximum of 20 characters).

  • 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) deprecated

    Indicates if the product variant is in stock.

    Deprecation warning

    Use availableForSale instead

  • compareAtPrice (Money) deprecated

    The compare at price of the variant. This can be used to mark a variant as on sale, when compareAtPrice is higher than price.

    Deprecation warning

    Use compareAtPriceV2 instead

  • presentmentPrices (ProductVariantPricePairConnection!) deprecated

    List of prices and compare-at prices in the presentment currencies for this shop.

    Deprecation warning

    Use @inContext instead.

    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!) deprecated

    List of unit prices in the presentment currencies for this shop.

    Deprecation warning

    Use @inContext instead.

    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

  • price (Money!) deprecated

    The product variant’s price.

    Deprecation warning

    Use priceV2 instead

An auto-generated type for paginating through multiple ProductVariants.

Fields

Types that return ProductVariant

An auto-generated type which holds one ProductVariant and a cursor during pagination.

Fields

  • cursor (String!)

    A cursor for use in pagination.

  • 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

  • sellingPlanAllocations (SellingPlanAllocationConnection!)

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

    Required access

    unauthenticated_read_selling_plans access scope.

    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

  • storeAvailability (StoreAvailabilityConnection!)

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

    Required access

    unauthenticated_read_product_pickup_locations access scope.

    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

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 than priceV2.

  • currentlyNotInStock (Boolean!)

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

  • id (ID!)

    A 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 on Image.transformedSrc instead.

    maxHeight ( Int )

    Image height in pixels between 1 and 2048. This argument is deprecated: Use maxHeight on Image.transformedSrc instead.

    maxWidth ( Int )

    Image width in pixels between 1 and 2048. This argument is deprecated: Use maxWidth on Image.transformedSrc instead.

    scale ( Int )

    Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use scale on Image.transformedSrc instead.
    Default value: 1

  • metafield (Metafield)

    Returns a metafield found by namespace and key.

    Argument Description
    key ( String! ) required

    Identifier for the metafield (maximum of 30 characters).

    namespace ( String! ) required

    Container for a set of metafields (maximum of 20 characters).

  • 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) deprecated

    Indicates if the product variant is in stock.

    Deprecation warning

    Use availableForSale instead

  • compareAtPrice (Money) deprecated

    The compare at price of the variant. This can be used to mark a variant as on sale, when compareAtPrice is higher than price.

    Deprecation warning

    Use compareAtPriceV2 instead

  • presentmentPrices (ProductVariantPricePairConnection!) deprecated

    List of prices and compare-at prices in the presentment currencies for this shop.

    Deprecation warning

    Use @inContext instead.

    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!) deprecated

    List of unit prices in the presentment currencies for this shop.

    Deprecation warning

    Use @inContext instead.

    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

  • price (Money!) deprecated

    The product variant’s price.

    Deprecation warning

    Use priceV2 instead

An auto-generated type for paginating through multiple ProductVariants.

On this page

Fields

An auto-generated type which holds one ProductVariant and a cursor during pagination.

Fields

  • cursor (String!)

    A cursor for use in pagination.

  • 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

  • sellingPlanAllocations (SellingPlanAllocationConnection!)

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

    Required access

    unauthenticated_read_selling_plans access scope.

    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

  • storeAvailability (StoreAvailabilityConnection!)

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

    Required access

    unauthenticated_read_product_pickup_locations access scope.

    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

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 than priceV2.

  • currentlyNotInStock (Boolean!)

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

  • id (ID!)

    A 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 on Image.transformedSrc instead.

    maxHeight ( Int )

    Image height in pixels between 1 and 2048. This argument is deprecated: Use maxHeight on Image.transformedSrc instead.

    maxWidth ( Int )

    Image width in pixels between 1 and 2048. This argument is deprecated: Use maxWidth on Image.transformedSrc instead.

    scale ( Int )

    Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use scale on Image.transformedSrc instead.
    Default value: 1

  • metafield (Metafield)

    Returns a metafield found by namespace and key.

    Argument Description
    key ( String! ) required

    Identifier for the metafield (maximum of 30 characters).

    namespace ( String! ) required

    Container for a set of metafields (maximum of 20 characters).

  • 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) deprecated

    Indicates if the product variant is in stock.

    Deprecation warning

    Use availableForSale instead

  • compareAtPrice (Money) deprecated

    The compare at price of the variant. This can be used to mark a variant as on sale, when compareAtPrice is higher than price.

    Deprecation warning

    Use compareAtPriceV2 instead

  • presentmentPrices (ProductVariantPricePairConnection!) deprecated

    List of prices and compare-at prices in the presentment currencies for this shop.

    Deprecation warning

    Use @inContext instead.

    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!) deprecated

    List of unit prices in the presentment currencies for this shop.

    Deprecation warning

    Use @inContext instead.

    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

  • price (Money!) deprecated

    The product variant’s price.

    Deprecation warning

    Use priceV2 instead

An auto-generated type for paginating through multiple ProductVariants.

On this page

Fields

An auto-generated type which holds one ProductVariant and a cursor during pagination.

Fields

  • cursor (String!)

    A cursor for use in pagination.

  • 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

  • sellingPlanAllocations (SellingPlanAllocationConnection!)

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

    Required access

    unauthenticated_read_selling_plans access scope.

    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

  • storeAvailability (StoreAvailabilityConnection!)

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

    Required access

    unauthenticated_read_product_pickup_locations access scope.

    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

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 than priceV2.

  • currentlyNotInStock (Boolean!)

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

  • id (ID!)

    A 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 on Image.transformedSrc instead.

    maxHeight ( Int )

    Image height in pixels between 1 and 2048. This argument is deprecated: Use maxHeight on Image.transformedSrc instead.

    maxWidth ( Int )

    Image width in pixels between 1 and 2048. This argument is deprecated: Use maxWidth on Image.transformedSrc instead.

    scale ( Int )

    Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use scale on Image.transformedSrc instead.
    Default value: 1

  • metafield (Metafield)

    Returns a metafield found by namespace and key.

    Argument Description
    key ( String! ) required

    Identifier for the metafield (maximum of 30 characters).

    namespace ( String! ) required

    Container for a set of metafields (maximum of 20 characters).

  • 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) deprecated

    Indicates if the product variant is in stock.

    Deprecation warning

    Use availableForSale instead

  • compareAtPrice (Money) deprecated

    The compare at price of the variant. This can be used to mark a variant as on sale, when compareAtPrice is higher than price.

    Deprecation warning

    Use compareAtPriceV2 instead

  • presentmentPrices (ProductVariantPricePairConnection!) deprecated

    List of prices and compare-at prices in the presentment currencies for this shop.

    Deprecation warning

    Use @inContext instead.

    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!) deprecated

    List of unit prices in the presentment currencies for this shop.

    Deprecation warning

    Use @inContext instead.

    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

  • price (Money!) deprecated

    The product variant’s price.

    Deprecation warning

    Use priceV2 instead

An auto-generated type for paginating through multiple ProductVariants.

On this page

Fields

An auto-generated type which holds one ProductVariant and a cursor during pagination.

Fields

  • cursor (String!)

    A cursor for use in pagination.

  • 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

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 than priceV2.

  • currentlyNotInStock (Boolean!)

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

  • id (ID!)

    A 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 on Image.transformedSrc instead.

    maxHeight ( Int )

    Image height in pixels between 1 and 2048. This argument is deprecated: Use maxHeight on Image.transformedSrc instead.

    maxWidth ( Int )

    Image width in pixels between 1 and 2048. This argument is deprecated: Use maxWidth on Image.transformedSrc instead.

    scale ( Int )

    Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use scale on Image.transformedSrc instead.
    Default value: 1

  • metafield (Metafield)

    Returns a metafield found by namespace and key.

    Argument Description
    key ( String! ) required

    Identifier for the metafield (maximum of 30 characters).

    namespace ( String! ) required

    Container for a set of metafields (maximum of 20 characters).

  • 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) deprecated

    Indicates if the product variant is in stock.

    Deprecation warning

    Use availableForSale instead

  • compareAtPrice (Money) deprecated

    The compare at price of the variant. This can be used to mark a variant as on sale, when compareAtPrice is higher than price.

    Deprecation warning

    Use compareAtPriceV2 instead

  • presentmentPrices (ProductVariantPricePairConnection!) deprecated

    List of prices and compare-at prices in the presentment currencies for this shop.

    Deprecation warning

    Use @inContext instead.

    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!) deprecated

    List of unit prices in the presentment currencies for this shop.

    Deprecation warning

    Use @inContext instead.

    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

  • price (Money!) deprecated

    The product variant’s price.

    Deprecation warning

    Use priceV2 instead

An auto-generated type for paginating through multiple ProductVariants.

On this page

Fields

An auto-generated type which holds one ProductVariant and a cursor during pagination.

Fields

  • cursor (String!)

    A cursor for use in pagination.

  • 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

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 than priceV2.

  • currentlyNotInStock (Boolean!)

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

  • id (ID!)

    A 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 on Image.transformedSrc instead.

    maxHeight ( Int )

    Image height in pixels between 1 and 2048. This argument is deprecated: Use maxHeight on Image.transformedSrc instead.

    maxWidth ( Int )

    Image width in pixels between 1 and 2048. This argument is deprecated: Use maxWidth on Image.transformedSrc instead.

    scale ( Int )

    Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use scale on Image.transformedSrc instead.
    Default value: 1

  • metafield (Metafield)

    Returns a metafield found by namespace and key.

    Argument Description
    key ( String! ) required

    Identifier for the metafield (maximum of 30 characters).

    namespace ( String! ) required

    Container for a set of metafields (maximum of 20 characters).

  • 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) deprecated

    Indicates if the product variant is in stock.

    Deprecation warning

    Use availableForSale instead

  • compareAtPrice (Money) deprecated

    The compare at price of the variant. This can be used to mark a variant as on sale, when compareAtPrice is higher than price.

    Deprecation warning

    Use compareAtPriceV2 instead

  • presentmentPrices (ProductVariantPricePairConnection!) deprecated

    List of prices and compare-at prices in the presentment currencies for this shop.

    Deprecation warning

    Use @inContext instead.

    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!) deprecated

    List of unit prices in the presentment currencies for this shop.

    Deprecation warning

    Use @inContext instead.

    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

  • price (Money!) deprecated

    The product variant’s price.

    Deprecation warning

    Use priceV2 instead

An auto-generated type for paginating through multiple ProductVariants.

On this page

Fields

An auto-generated type which holds one ProductVariant and a cursor during pagination.

Fields

  • cursor (String!)

    A cursor for use in pagination.

  • The item at the end of ProductVariantEdge.

Types that return ProductVariantEdge