A product represents an individual item for sale in a Shopify store. Products are often physical, but they don't have to be. For example, a digital download (such as a movie, music or ebook file) also qualifies as a product, as do services (such as equipment rental, work for hire, customization of another product or an extended warranty). More...

Public Member Functions
	ProductQuery (StringBuilder query)
	ProductQuery is used to build queries. Typically ProductQuery will not be used directly but instead will be used when building queries from either QueryRootQuery or MutationQuery. More...

ProductQuery	availableForSale ()
	Indicates if at least one product variant is available for sale. More...

ProductQuery	collections (CollectionConnectionDelegate buildQuery, long? first=null, string after=null, long? last=null, string before=null, bool? reverse=null, string alias=null)
	List of collections a product belongs to. More...

ProductQuery	createdAt ()
	The date and time when the product was created. More...

ProductQuery	description (long? truncateAt=null, string alias=null)
	Stripped description of the product, single line with HTML tags removed. More...

ProductQuery	descriptionHtml ()
	The description of the product, complete with HTML formatting. More...

ProductQuery	handle ()
	A human-friendly unique string for the Product automatically generated from its title. They are used by the Liquid templating language to refer to objects. More...

ProductQuery	id ()
	Globally unique identifier. More...

ProductQuery	images (ImageConnectionDelegate buildQuery, long? first=null, string after=null, long? last=null, string before=null, bool? reverse=null, ProductImageSortKeys? sortKey=null, long? maxWidth=null, long? maxHeight=null, CropRegion? crop=null, long? scale=null, string alias=null)
	List of images associated with the product. More...

ProductQuery	media (MediaConnectionDelegate buildQuery, long? first=null, string after=null, long? last=null, string before=null, bool? reverse=null, string alias=null)
	The media associated with the product. More...

ProductQuery	metafield (MetafieldDelegate buildQuery, string namespaceValue, string key, string alias=null)
	The metafield associated with the resource. More...

ProductQuery	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...

ProductQuery	onlineStoreUrl ()
	The online store URL for the product. A value of `null` indicates that the product is not published to the Online Store sales channel. More...

ProductQuery	options (ProductOptionDelegate buildQuery, long? first=null, string alias=null)
	List of product options. More...

ProductQuery	presentmentPriceRanges (ProductPriceRangeConnectionDelegate 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 price ranges in the presentment currencies for this shop. More...

ProductQuery	priceRange (ProductPriceRangeDelegate buildQuery)
	The price range. More...

ProductQuery	productType ()
	A categorization that a product can be tagged with, commonly used for filtering and searching. More...

ProductQuery	publishedAt ()
	The date and time when the product was published to the channel. More...

ProductQuery	tags ()
	A comma separated list of tags that have been added to the product. Additional access scope required for private apps: unauthenticated_read_product_tags. More...

ProductQuery	title ()
	The product’s title. More...

ProductQuery	updatedAt ()
	The date and time when the product was last modified. A product's `updatedAt` value can change for different reasons. For example, if an order is placed for a product that has inventory tracking set up, then the inventory adjustment is counted as an update. More...

ProductQuery	variantBySelectedOptions (ProductVariantDelegate buildQuery, List< SelectedOptionInput > selectedOptions, string alias=null)
	Find a product’s variant based on its selected options. This is useful for converting a user’s selection of product options into a single matching variant. If there is not a variant for the selected options, `null` will be returned. More...

ProductQuery	variants (ProductVariantConnectionDelegate buildQuery, long? first=null, string after=null, long? last=null, string before=null, bool? reverse=null, ProductVariantSortKeys? sortKey=null, string alias=null)
	List of the product’s variants. More...

ProductQuery	vendor ()
	The product’s vendor name. More...

Detailed Description

A product represents an individual item for sale in a Shopify store. Products are often physical, but they don't have to be. For example, a digital download (such as a movie, music or ebook file) also qualifies as a product, as do services (such as equipment rental, work for hire, customization of another product or an extended warranty).

Constructor & Destructor Documentation

◆ ProductQuery()

Shopify.Unity.GraphQL.ProductQuery.ProductQuery ( StringBuilder query )

inline

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

Member Function Documentation

◆ availableForSale()

ProductQuery Shopify.Unity.GraphQL.ProductQuery.availableForSale ( )

inline

Indicates if at least one product variant is available for sale.

◆ collections()

ProductQuery Shopify.Unity.GraphQL.ProductQuery.collections	(	CollectionConnectionDelegate	buildQuery,
		long?	first = `null`,
		string	after = `null`,
		long?	last = `null`,
		string	before = `null`,
		bool?	reverse = `null`,
		string	alias = `null`
	)

inline

List of collections a product belongs to.

Parameters

first	Returns up to the first `n` elements from the list.
after	Returns the elements that come after the specified cursor.
last	Returns up to the last `n` elements from the list.
before	Returns the elements that come before the specified cursor.
reverse	Reverse the order of the underlying list.

◆ createdAt()

ProductQuery Shopify.Unity.GraphQL.ProductQuery.createdAt ( )

inline

The date and time when the product was created.

◆ description()

ProductQuery Shopify.Unity.GraphQL.ProductQuery.description	(	long?	truncateAt = `null`,
		string	alias = `null`
	)

inline

Stripped description of the product, single line with HTML tags removed.

Parameters

truncateAt Truncates string after the given length.

◆ descriptionHtml()

ProductQuery Shopify.Unity.GraphQL.ProductQuery.descriptionHtml ( )

inline

The description of the product, complete with HTML formatting.

◆ handle()

ProductQuery Shopify.Unity.GraphQL.ProductQuery.handle ( )

inline

A human-friendly unique string for the Product automatically generated from its title. They are used by the Liquid templating language to refer to objects.

◆ id()

ProductQuery Shopify.Unity.GraphQL.ProductQuery.id ( )

inline

Globally unique identifier.

◆ images()

ProductQuery Shopify.Unity.GraphQL.ProductQuery.images	(	ImageConnectionDelegate	buildQuery,
		long?	first = `null`,
		string	after = `null`,
		long?	last = `null`,
		string	before = `null`,
		bool?	reverse = `null`,
		ProductImageSortKeys?	sortKey = `null`,
		long?	maxWidth = `null`,
		long?	maxHeight = `null`,
		CropRegion?	crop = `null`,
		long?	scale = `null`,
		string	alias = `null`
	)

inline

List of images associated with the product.

Parameters

first	Returns up to the first `n` elements from the list.
after	Returns the elements that come after the specified cursor.
last	Returns up to the last `n` elements from the list.
before	Returns the elements that come before the specified cursor.
reverse	Reverse the order of the underlying list.
sortKey	Sort the underlying list by the given key.
maxWidth	Image width in pixels between 1 and 2048. This argument is deprecated: Use `maxWidth` on `Image.transformedSrc` instead.
maxHeight	Image height in pixels between 1 and 2048. This argument is deprecated: Use `maxHeight` on `Image.transformedSrc` instead.
crop	Crops the image according to the specified region. This argument is deprecated: Use `crop` on `Image.transformedSrc` instead.
scale	Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use `scale` on `Image.transformedSrc` instead.

◆ media()

ProductQuery Shopify.Unity.GraphQL.ProductQuery.media	(	MediaConnectionDelegate	buildQuery,
		long?	first = `null`,
		string	after = `null`,
		long?	last = `null`,
		string	before = `null`,
		bool?	reverse = `null`,
		string	alias = `null`
	)

inline

The media associated with the product.

Parameters

first	Returns up to the first `n` elements from the list.
after	Returns the elements that come after the specified cursor.
last	Returns up to the last `n` elements from the list.
before	Returns the elements that come before the specified cursor.
reverse	Reverse the order of the underlying list.

◆ metafield()

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

inline

The metafield associated with the resource.

Parameters

namespace	Container for a set of metafields (maximum of 20 characters).
key	Identifier for the metafield (maximum of 30 characters).

◆ metafields()

ProductQuery Shopify.Unity.GraphQL.ProductQuery.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

namespace	Container for a set of metafields (maximum of 20 characters).
first	Returns up to the first `n` elements from the list.
after	Returns the elements that come after the specified cursor.
last	Returns up to the last `n` elements from the list.
before	Returns the elements that come before the specified cursor.
reverse	Reverse the order of the underlying list.

◆ onlineStoreUrl()

ProductQuery Shopify.Unity.GraphQL.ProductQuery.onlineStoreUrl ( )

inline

The online store URL for the product. A value of null indicates that the product is not published to the Online Store sales channel.

◆ options()

ProductQuery Shopify.Unity.GraphQL.ProductQuery.options	(	ProductOptionDelegate	buildQuery,
		long?	first = `null`,
		string	alias = `null`
	)

inline

List of product options.

Parameters

first Truncate the array result to this size.

◆ presentmentPriceRanges()

ProductQuery Shopify.Unity.GraphQL.ProductQuery.presentmentPriceRanges	(	ProductPriceRangeConnectionDelegate	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 price ranges in the presentment currencies for this shop.

Parameters

presentmentCurrencies	Specifies the presentment currencies to return a price range in.
first	Returns up to the first `n` elements from the list.
after	Returns the elements that come after the specified cursor.
last	Returns up to the last `n` elements from the list.
before	Returns the elements that come before the specified cursor.
reverse	Reverse the order of the underlying list.

◆ priceRange()

ProductQuery Shopify.Unity.GraphQL.ProductQuery.priceRange ( ProductPriceRangeDelegate buildQuery )

inline

The price range.

◆ productType()

ProductQuery Shopify.Unity.GraphQL.ProductQuery.productType ( )

inline

A categorization that a product can be tagged with, commonly used for filtering and searching.

◆ publishedAt()

ProductQuery Shopify.Unity.GraphQL.ProductQuery.publishedAt ( )

inline

The date and time when the product was published to the channel.

◆ tags()

ProductQuery Shopify.Unity.GraphQL.ProductQuery.tags ( )

inline

A comma separated list of tags that have been added to the product. Additional access scope required for private apps: unauthenticated_read_product_tags.

◆ title()

ProductQuery Shopify.Unity.GraphQL.ProductQuery.title ( )

inline

The product’s title.

◆ updatedAt()

ProductQuery Shopify.Unity.GraphQL.ProductQuery.updatedAt ( )

inline

The date and time when the product was last modified. A product's updatedAt value can change for different reasons. For example, if an order is placed for a product that has inventory tracking set up, then the inventory adjustment is counted as an update.

◆ variantBySelectedOptions()

ProductQuery Shopify.Unity.GraphQL.ProductQuery.variantBySelectedOptions	(	ProductVariantDelegate	buildQuery,
		List< SelectedOptionInput >	selectedOptions,
		string	alias = `null`
	)

inline

Find a product’s variant based on its selected options. This is useful for converting a user’s selection of product options into a single matching variant. If there is not a variant for the selected options, null will be returned.

Parameters

selectedOptions The input fields used for a selected option.

◆ variants()

ProductQuery Shopify.Unity.GraphQL.ProductQuery.variants	(	ProductVariantConnectionDelegate	buildQuery,
		long?	first = `null`,
		string	after = `null`,
		long?	last = `null`,
		string	before = `null`,
		bool?	reverse = `null`,
		ProductVariantSortKeys?	sortKey = `null`,
		string	alias = `null`
	)

inline

List of the product’s variants.

Parameters

first	Returns up to the first `n` elements from the list.
after	Returns the elements that come after the specified cursor.
last	Returns up to the last `n` elements from the list.
before	Returns the elements that come before the specified cursor.
reverse	Reverse the order of the underlying list.
sortKey	Sort the underlying list by the given key.

◆ vendor()

ProductQuery Shopify.Unity.GraphQL.ProductQuery.vendor ( )

inline

The product’s vendor name.

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

Assets/Shopify/Unity/Generated/GraphQL/ProductQuery.cs

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ProductQuery()

Member Function Documentation

◆ availableForSale()

◆ collections()

◆ createdAt()

◆ description()

◆ descriptionHtml()

◆ handle()

◆ id()

◆ images()

◆ media()

◆ metafield()

◆ metafields()

◆ onlineStoreUrl()

◆ options()

◆ presentmentPriceRanges()

◆ priceRange()

◆ productType()

◆ publishedAt()

◆ tags()

◆ title()

◆ updatedAt()

◆ variantBySelectedOptions()

◆ variants()

◆ vendor()