Shopify SDK for Unity
Public Member Functions | List of all members
Shopify.Unity.GraphQL.ProductVariantQuery Class Reference

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

Public Member Functions

 ProductVariantQuery (StringBuilder query)
 ProductVariantQuery is used to build queries. Typically ProductVariantQuery will not be used directly but instead will be used when building queries from either QueryRootQuery or MutationQuery. More...
 
ProductVariantQuery available ()
 Indicates if the product variant is in stock. More...
 
ProductVariantQuery availableForSale ()
 Indicates if the product variant is available for sale. More...
 
ProductVariantQuery compareAtPrice ()
 The compare at price of the variant. This can be used to mark a variant as on sale, when compareAtPrice is higher than price. More...
 
ProductVariantQuery compareAtPriceV2 (MoneyV2Delegate buildQuery)
 The compare at price of the variant. This can be used to mark a variant as on sale, when compareAtPriceV2 is higher than priceV2. More...
 
ProductVariantQuery id ()
 Globally unique identifier. More...
 
ProductVariantQuery image (ImageDelegate buildQuery, long? maxWidth=null, long? maxHeight=null, CropRegion? crop=null, long? scale=null, string alias=null)
 Image associated with the product variant. This field falls back to the product image if no image is available. More...
 
ProductVariantQuery metafield (MetafieldDelegate buildQuery, string namespaceValue, string key, string alias=null)
 The metafield associated with the resource. More...
 
ProductVariantQuery metafields (MetafieldConnectionDelegate buildQuery, string namespaceValue=null, long? first=null, string after=null, long? last=null, string before=null, bool? reverse=null, string alias=null)
 A paginated list of metafields associated with the resource. More...
 
ProductVariantQuery presentmentPrices (ProductVariantPricePairConnectionDelegate buildQuery, List< CurrencyCode > presentmentCurrencies=null, long? first=null, string after=null, long? last=null, string before=null, bool? reverse=null, string alias=null)
 List of prices and compare-at prices in the presentment currencies for this shop. More...
 
ProductVariantQuery presentmentUnitPrices (MoneyV2connectionDelegate buildQuery, List< CurrencyCode > presentmentCurrencies=null, long? first=null, string after=null, long? last=null, string before=null, bool? reverse=null, string alias=null)
 List of unit prices in the presentment currencies for this shop. More...
 
ProductVariantQuery price ()
 The product variant’s price. More...
 
ProductVariantQuery priceV2 (MoneyV2Delegate buildQuery)
 The product variant’s price. More...
 
ProductVariantQuery product (ProductDelegate buildQuery)
 The product object that the product variant belongs to. More...
 
ProductVariantQuery requiresShipping ()
 Whether a customer needs to provide a shipping address when placing an order for the product variant. More...
 
ProductVariantQuery selectedOptions (SelectedOptionDelegate buildQuery)
 List of product options applied to the variant. More...
 
ProductVariantQuery sku ()
 The SKU (stock keeping unit) associated with the variant. More...
 
ProductVariantQuery title ()
 The product variant’s title. More...
 
ProductVariantQuery unitPrice (MoneyV2Delegate buildQuery)
 The unit price value for the variant based on the variant's measurement. More...
 
ProductVariantQuery unitPriceMeasurement (UnitPriceMeasurementDelegate buildQuery)
 The unit price measurement for the variant. More...
 
ProductVariantQuery weight ()
 The weight of the product variant in the unit system specified with weight_unit. More...
 
ProductVariantQuery weightUnit ()
 Unit of measurement for weight. More...
 

Detailed Description

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

Constructor & Destructor Documentation

◆ ProductVariantQuery()

Shopify.Unity.GraphQL.ProductVariantQuery.ProductVariantQuery ( StringBuilder  query)
inline

ProductVariantQuery is used to build queries. Typically ProductVariantQuery will not be used directly but instead will be used when building queries from either QueryRootQuery or MutationQuery.

Member Function Documentation

◆ available()

ProductVariantQuery Shopify.Unity.GraphQL.ProductVariantQuery.available ( )
inline

Indicates if the product variant is in stock.

Deprecated:
Use availableForSale instead

◆ availableForSale()

ProductVariantQuery Shopify.Unity.GraphQL.ProductVariantQuery.availableForSale ( )
inline

Indicates if the product variant is available for sale.

◆ compareAtPrice()

ProductVariantQuery Shopify.Unity.GraphQL.ProductVariantQuery.compareAtPrice ( )
inline

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

Deprecated:
Use compareAtPriceV2 instead

◆ compareAtPriceV2()

ProductVariantQuery Shopify.Unity.GraphQL.ProductVariantQuery.compareAtPriceV2 ( MoneyV2Delegate  buildQuery)
inline

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

◆ id()

ProductVariantQuery Shopify.Unity.GraphQL.ProductVariantQuery.id ( )
inline

Globally unique identifier.

◆ image()

ProductVariantQuery Shopify.Unity.GraphQL.ProductVariantQuery.image ( ImageDelegate  buildQuery,
long?  maxWidth = null,
long?  maxHeight = null,
CropRegion crop = null,
long?  scale = null,
string  alias = null 
)
inline

Image associated with the product variant. This field falls back to the product image if no image is available.

Parameters
maxWidthImage width in pixels between 1 and 2048. This argument is deprecated: Use maxWidth on Image.transformedSrc instead.
maxHeightImage height in pixels between 1 and 2048. This argument is deprecated: Use maxHeight on Image.transformedSrc instead.
cropCrops the image according to the specified region. This argument is deprecated: Use crop on Image.transformedSrc instead.
scaleImage size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use scale on Image.transformedSrc instead.

◆ metafield()

ProductVariantQuery Shopify.Unity.GraphQL.ProductVariantQuery.metafield ( MetafieldDelegate  buildQuery,
string  namespaceValue,
string  key,
string  alias = null 
)
inline

The metafield associated with the resource.

Parameters
namespaceContainer for a set of metafields (maximum of 20 characters).
keyIdentifier for the metafield (maximum of 30 characters).

◆ metafields()

ProductVariantQuery Shopify.Unity.GraphQL.ProductVariantQuery.metafields ( MetafieldConnectionDelegate  buildQuery,
string  namespaceValue = null,
long?  first = null,
string  after = null,
long?  last = null,
string  before = null,
bool?  reverse = null,
string  alias = null 
)
inline

A paginated list of metafields associated with the resource.

Parameters
namespaceContainer for a set of metafields (maximum of 20 characters).
firstReturns up to the first n elements from the list.
afterReturns the elements that come after the specified cursor.
lastReturns up to the last n elements from the list.
beforeReturns the elements that come before the specified cursor.
reverseReverse the order of the underlying list.

◆ presentmentPrices()

ProductVariantQuery Shopify.Unity.GraphQL.ProductVariantQuery.presentmentPrices ( ProductVariantPricePairConnectionDelegate  buildQuery,
List< CurrencyCode presentmentCurrencies = null,
long?  first = null,
string  after = null,
long?  last = null,
string  before = null,
bool?  reverse = null,
string  alias = null 
)
inline

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

Parameters
presentmentCurrenciesThe presentment currencies prices should return in.
firstReturns up to the first n elements from the list.
afterReturns the elements that come after the specified cursor.
lastReturns up to the last n elements from the list.
beforeReturns the elements that come before the specified cursor.
reverseReverse the order of the underlying list.

◆ presentmentUnitPrices()

ProductVariantQuery Shopify.Unity.GraphQL.ProductVariantQuery.presentmentUnitPrices ( MoneyV2connectionDelegate  buildQuery,
List< CurrencyCode presentmentCurrencies = null,
long?  first = null,
string  after = null,
long?  last = null,
string  before = null,
bool?  reverse = null,
string  alias = null 
)
inline

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

Parameters
presentmentCurrenciesSpecify the currencies in which to return presentment unit prices.
firstReturns up to the first n elements from the list.
afterReturns the elements that come after the specified cursor.
lastReturns up to the last n elements from the list.
beforeReturns the elements that come before the specified cursor.
reverseReverse the order of the underlying list.

◆ price()

ProductVariantQuery Shopify.Unity.GraphQL.ProductVariantQuery.price ( )
inline

The product variant’s price.

Deprecated:
Use priceV2 instead

◆ priceV2()

ProductVariantQuery Shopify.Unity.GraphQL.ProductVariantQuery.priceV2 ( MoneyV2Delegate  buildQuery)
inline

The product variant’s price.

◆ product()

ProductVariantQuery Shopify.Unity.GraphQL.ProductVariantQuery.product ( ProductDelegate  buildQuery)
inline

The product object that the product variant belongs to.

◆ requiresShipping()

ProductVariantQuery Shopify.Unity.GraphQL.ProductVariantQuery.requiresShipping ( )
inline

Whether a customer needs to provide a shipping address when placing an order for the product variant.

◆ selectedOptions()

ProductVariantQuery Shopify.Unity.GraphQL.ProductVariantQuery.selectedOptions ( SelectedOptionDelegate  buildQuery)
inline

List of product options applied to the variant.

◆ sku()

ProductVariantQuery Shopify.Unity.GraphQL.ProductVariantQuery.sku ( )
inline

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

◆ title()

ProductVariantQuery Shopify.Unity.GraphQL.ProductVariantQuery.title ( )
inline

The product variant’s title.

◆ unitPrice()

ProductVariantQuery Shopify.Unity.GraphQL.ProductVariantQuery.unitPrice ( MoneyV2Delegate  buildQuery)
inline

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

◆ unitPriceMeasurement()

ProductVariantQuery Shopify.Unity.GraphQL.ProductVariantQuery.unitPriceMeasurement ( UnitPriceMeasurementDelegate  buildQuery)
inline

The unit price measurement for the variant.

◆ weight()

ProductVariantQuery Shopify.Unity.GraphQL.ProductVariantQuery.weight ( )
inline

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

◆ weightUnit()

ProductVariantQuery Shopify.Unity.GraphQL.ProductVariantQuery.weightUnit ( )
inline

Unit of measurement for weight.


The documentation for this class was generated from the following file: