+813-444-3589+44 118 328 3220+49-231-976765-0 | Contact us

Variant

Variants are versions of the same product. They might differ in size, color or in license of usage. So each product has at least one variant. This object has the following fields:

Variable name Object Description Note
available bool Returns a flag that tells whether this variant is available or not. For now, only variants and products are shown that are available, thus this flag is always true.  
barcode string Returns the barcode number for the given variant. If this is empty, the value for the products barcode is to be used.  
compare_at_price int Contains the product price of this variant of other merchants. Not yet supported and will always be 0.  
hd bool If this flag is true, the content for this variant (if applicable) is High Definition (otherwise Standard Definition). EF
id int An internal numerical identifier of this variant.  
inventory_management string Tells whether the shop owner or Flickrocket will track the inventory of the variant. As item inventory is currently not supported, this will always be an empty string.  
inventory_policy string If the item is out of stock (unavailable), this flag tells whether this variant is still available for purchase. The two possible values are “continue” and “deny”. Currently only “deny” is returned.  
inventory_quantity int This is not supported so far and will currently always be 1.  
license License Returns the License object with information about the licensing information about this variant (if applicable). EF
license_id int An internal numerical identifier for the used license. EF
option1 string Names the first option for the given variant (e.g. for color: “Blue”). Might be empty, than this option does not exist. Currently options for variants are unsupported.  
option2 string Names the second option for the given variant (e.g. for size: “XL”). Might be empty, than this option does not exist. Currently options for variants are unsupported.  
option3 string Names the third option for the given variant (e.g. for gender: “Women”). Might be empty, than this option does not exist. Currently options for variants are unsupported.  
options List<string> Returns a list of all the options for this variant (a list containing the non-empty entries of option1, option2 and option3). If there are no options for this variant, then this list will be empty. Currently options for variants are unsupported, thus this list will always be empty.  
price int This is the display price of the given variant. Use the money filter for formatting.  
pricing UserPrice This price is a more detailed version for the variants price as price. For more information, please have a look at the UserPrice object. EF
product Product Returns the Product object for this variant. EF
product_id int This is the product id ofthe product for this variant. EF
requires_shipping bool If it is a physical product, this field is true. Otherwise false will be returned. EF
sku string Returns the Stock Keeping Unit for the given variant. This is currently unsupported, thus this attribute will always return an empty string.  
title string The name of the given variant (for digital content it will often be the name of the license of the variant). If there is only a default (physical) variant available, the title will be “Default” (which might be a good idea not to display).  
weight int If the item is a physical product, this field will tell how much the item will weight in gramm (otherwise it will be 0). Use the weight_with_unit filter to format the weight according to the logged in user (lb in the USA, kg in all other countries).  

Note: Some parts (marked with EF) of this object are exclusive to FlickRocket. If you are using a theme orginating from Shopify and want to use this functionality, you need to add this.