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

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

Inheritance diagram for Shopify.Unity.Product:
Shopify.Unity.SDK.AbstractResponse Shopify.Unity.HasMetafields Shopify.Unity.Node

Public Member Functions

 Product (Dictionary< string, object > dataJSON)
 Accepts deserialized json data. Will further parse passed in data. More...
 
bool availableForSale ()
 Indicates if at least one product variant is available for sale. More...
 
CollectionConnection collections (string alias=null)
 List of collections a product belongs to. More...
 
DateTime? createdAt ()
 The date and time when the product was created. More...
 
string description (string alias=null)
 Stripped description of the product, single line with HTML tags removed. More...
 
string descriptionHtml ()
 The description of the product, complete with HTML formatting. More...
 
string 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...
 
string id ()
 Globally unique identifier. More...
 
ImageConnection images (string alias=null)
 List of images associated with the product. More...
 
MediaConnection media (string alias=null)
 The media associated with the product. More...
 
Metafield metafield (string alias=null)
 The metafield associated with the resource. More...
 
MetafieldConnection metafields (string alias=null)
 A paginated list of metafields associated with the resource. More...
 
string 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...
 
List< ProductOptionoptions (string alias=null)
 List of product options. More...
 
ProductPriceRangeConnection presentmentPriceRanges (string alias=null)
 List of price ranges in the presentment currencies for this shop. More...
 
ProductPriceRange priceRange ()
 The price range. More...
 
string productType ()
 A categorization that a product can be tagged with, commonly used for filtering and searching. More...
 
DateTime? publishedAt ()
 The date and time when the product was published to the channel. More...
 
List< string > 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...
 
string title ()
 The product’s title. More...
 
DateTime? 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...
 
ProductVariant variantBySelectedOptions (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...
 
ProductVariantConnection variants (string alias=null)
 List of the product’s variants. More...
 
string vendor ()
 The product’s vendor name. More...
 
object Clone ()
 

Additional Inherited Members

- Protected Member Functions inherited from Shopify.Unity.SDK.AbstractResponse
Get< T > (string field, string alias=null)
 
- Protected Attributes inherited from Shopify.Unity.SDK.AbstractResponse
Dictionary< string, object > Data
 
- Properties inherited from Shopify.Unity.SDK.AbstractResponse
Dictionary< string, object > DataJSON [get, protected set]
 

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

◆ Product()

Shopify.Unity.Product.Product ( Dictionary< string, object >  dataJSON)
inline

Accepts deserialized json data. Will further parse passed in data.

Parameters
dataJSONDeserialized JSON data for Product

Member Function Documentation

◆ availableForSale()

bool Shopify.Unity.Product.availableForSale ( )
inline

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

◆ collections()

CollectionConnection Shopify.Unity.Product.collections ( string  alias = null)
inline

List of collections a product belongs to.

Parameters
aliasIf the original field queried was queried using an alias, then pass the matching string.

◆ createdAt()

DateTime? Shopify.Unity.Product.createdAt ( )
inline

The date and time when the product was created.

◆ description()

string Shopify.Unity.Product.description ( string  alias = null)
inline

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

Parameters
aliasIf the original field queried was queried using an alias, then pass the matching string.

◆ descriptionHtml()

string Shopify.Unity.Product.descriptionHtml ( )
inline

The description of the product, complete with HTML formatting.

◆ handle()

string Shopify.Unity.Product.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()

string Shopify.Unity.Product.id ( )
inline

Globally unique identifier.

Implements Shopify.Unity.Node.

◆ images()

ImageConnection Shopify.Unity.Product.images ( string  alias = null)
inline

List of images associated with the product.

Parameters
aliasIf the original field queried was queried using an alias, then pass the matching string.

◆ media()

MediaConnection Shopify.Unity.Product.media ( string  alias = null)
inline

The media associated with the product.

Parameters
aliasIf the original field queried was queried using an alias, then pass the matching string.

◆ metafield()

Metafield Shopify.Unity.Product.metafield ( string  alias = null)
inline

The metafield associated with the resource.

Parameters
aliasIf the original field queried was queried using an alias, then pass the matching string.

Implements Shopify.Unity.HasMetafields.

◆ metafields()

MetafieldConnection Shopify.Unity.Product.metafields ( string  alias = null)
inline

A paginated list of metafields associated with the resource.

Parameters
aliasIf the original field queried was queried using an alias, then pass the matching string.

Implements Shopify.Unity.HasMetafields.

◆ onlineStoreUrl()

string Shopify.Unity.Product.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()

List<ProductOption> Shopify.Unity.Product.options ( string  alias = null)
inline

List of product options.

Parameters
aliasIf the original field queried was queried using an alias, then pass the matching string.

◆ presentmentPriceRanges()

ProductPriceRangeConnection Shopify.Unity.Product.presentmentPriceRanges ( string  alias = null)
inline

List of price ranges in the presentment currencies for this shop.

Parameters
aliasIf the original field queried was queried using an alias, then pass the matching string.

◆ priceRange()

ProductPriceRange Shopify.Unity.Product.priceRange ( )
inline

The price range.

◆ productType()

string Shopify.Unity.Product.productType ( )
inline

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

◆ publishedAt()

DateTime? Shopify.Unity.Product.publishedAt ( )
inline

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

◆ tags()

List<string> Shopify.Unity.Product.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()

string Shopify.Unity.Product.title ( )
inline

The product’s title.

◆ updatedAt()

DateTime? Shopify.Unity.Product.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()

ProductVariant Shopify.Unity.Product.variantBySelectedOptions ( 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
aliasIf the original field queried was queried using an alias, then pass the matching string.

◆ variants()

ProductVariantConnection Shopify.Unity.Product.variants ( string  alias = null)
inline

List of the product’s variants.

Parameters
aliasIf the original field queried was queried using an alias, then pass the matching string.

◆ vendor()

string Shopify.Unity.Product.vendor ( )
inline

The product’s vendor name.


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