Object: product

Variables

.id

Unique ID of the product. Product IDs are generated automatically at the time of creating the products and cannot be changed. Typical use of the ID is as a product SKU, for easy referencing by customers and internally.

TYPE
numeric
CONSTRAINTS
>= 1
PRESENCE
always

Examples

CODE{{ product.id }}
OUTPUT10245

CODE{{ product.id | product_url }}
OUTPUT/product/hp-laserjet-cp1525n-laser-printer
NB: the exact URL depends on the Product URL configuration

CODE{{ product.id | product_link: 'buy now' }}
OUTPUT<a href="/product/hp-laserjet-cp1525n-laser-printer">buy now</a>
NB: the exact URL depends on the Product URL configuration

.ref

Unique reference name of the product, based on configuration under Product » Update » Reference name.

TYPE
reference
CONSTRAINTS
alphanumeric, dashes and underscores
PRESENCE
always

Examples

CODE{{ product.ref }}
OUTPUThp-laserjet-cp1525n-laser-printer

URLs

Do not use .ref to construct a product URL manually. Use the product_url filter instead, on either the .id, .ref or the product object itself.

.brand

Brand object for the product, based on the configuration under Product » Update » Brand.

TYPE
object
CONSTRAINTS
n/a
PRESENCE
if brand is set

.barcode

Barcode object for the product, based on the configuration under Product » Update » Barcode.

TYPE
object
CONSTRAINTS
n/a
PRESENCE
if barcode is set

.manufacturer_code

Manufacturer code of the product as configured under Product » Update » Manufacturer code.

TYPE
string
CONSTRAINTS
up to 64 characters
PRESENCE
always, but could be blank

Examples

CODE{{ product.manufacturer_code }}
OUTPUTCX-110223

.manufacturer_url

Manufacturer URL of the product as configured under Product » Update » Manufacturer URL.

TYPE
absolute URL
CONSTRAINTS
valid URL
PRESENCE
always, but can be blank

Examples

CODE{{ product.manufacturer_url }}
OUTPUThttp://www.intel.com/processors/core-i7-processor.html

.name

Display name of the product as configured under Product » Update » Name.

TYPE
multi-line string
CONSTRAINTS
none
PRESENCE
always

Examples

CODE{{ product.name }}
OUTPUTHP LaserJet CP1525n Colour Laser Printer

.highlights

Higlights of the product as configured under Product » Update » Highlights.

TYPE
multi-line string
CONSTRAINTS
none
PRESENCE
always, but can be blank

Examples

CODE{{ product.highlights }}
OUTPUTFast reliable laser printing. Up to 22ppm in black. USB and Ethernet interfaces.

CODE{{ product.highlights | newline_to_br }}
OUTPUTFast reliable laser printing.
Up to 22ppm in black.
USB and Ethernet interfaces.

CODE{{ product.highlights | newline_to_ul }}
OUTPUT• Fast reliable laser printing.
• Up to 22ppm in black.
• USB and Ethernet interfaces.

.overview

Overview of the product as configured under Product » Update » Overview.

TYPE
multi-line string
CONSTRAINTS
none
PRESENCE
always, but can be blank

Examples

CODE{{ product.overview }}
OUTPUTGreat printer with lots of features ...

.package_content

Package content of the product as configured under Product » Update » Package Content.

TYPE
multi-line string
CONSTRAINTS
none
PRESENCE
always, but can be blank

Examples

CODE{{ product.package_content }}
OUTPUTPrinter
Cables
4 x Toners

.tier_pricing

tier_pricing

TYPE
CONSTRAINTS
PRESENCE

.discount_pricing

discount_pricing

TYPE
CONSTRAINTS
PRESENCE

.price

Display price of the product. It is either configured under Product » Update » Price (display) or calculated automatically, based on supplier product pricing, depending on the product's pricing profile configuration. When using tiers, and the price is rendered in customer account context, the display price will reflect the tiered pricing applicable to the customer's account.

TYPE
decimal number
CONSTRAINTS
>= 0.00
PRESENCE
always

Examples

CODE{{ product.price }}
OUTPUT999.95

CODE{{ product.price | money }}
OUTPUTEUR 999.95

.price_exclusive

Product price exclluding tax. It is either configured under Product » Update » Price (excl) or calculated automatically, based on supplier product pricing, depending on the product's pricing profile configuration.

TYPE
decimal number
CONSTRAINTS
>= 0.00
PRESENCE
always

Examples

CODE{{ product.price_exclusive }}
OUTPUT799.96

CODE{{ product.price_exclusive | money }}
OUTPUTEUR 799.96

.price_inclusive

Product price including tax. It is either configured under Product » Update » Price (incl) or calculated automatically, based on supplier product pricing, depending on the product's pricing profile configuration.

TYPE
decimal number
CONSTRAINTS
>= 0.00
PRESENCE
always

Examples

CODE{{ product.price_exclusive }}
OUTPUT999.95

CODE{{ product.price_exclusive | money }}
OUTPUTEUR 999.95

.tax

tax

TYPE
CONSTRAINTS
PRESENCE

.price_rrp

RRP (Recommended Retail Price) as configured under Product » Update » Recommended price.

TYPE
decimal number
CONSTRAINTS
>= 0.00
PRESENCE
optional

Examples

CODE{{ product.price_rrp }}
OUTPUT999.95

CODE{{ product.price_rrp | money }}
OUTPUTEUR 999.95

.price_compare

Compare price as configured under Product » Update » Compare price.

TYPE
decimal number
CONSTRAINTS
>= 0.00
PRESENCE
optional

Examples

CODE{{ product.price_compare }}
OUTPUT999.95

CODE{{ product.price_compare | money }}
OUTPUTEUR 999.95

.collections

List of collections the product belongs to.

TYPE
array of objects
CONSTRAINTS
n/a
PRESENCE
always, but could be zero-length

.variants

List of available variants of the product.

TYPE
array of objects
CONSTRAINTS
n/a
PRESENCE
optional

.specifications

specifications

TYPE
CONSTRAINTS
PRESENCE

.customizations

customizations

TYPE
CONSTRAINTS
PRESENCE

.tags

tags

TYPE
CONSTRAINTS
PRESENCE

.metadata

metadata

TYPE
CONSTRAINTS
PRESENCE

.featured_image

The primary product image, as selected in the Product Gallery. If none is selected, the first image is returned. If the product has no associated images, the field is set to null.

TYPE
image object or null
CONSTRAINTS
n/a
PRESENCE
always

Examples

CODE{{ product.featured_image.src }}
OUTPUT/files/gallery/00/00/00/00000001_00000007.jpg

.images

List of all non-hidden images in the Product Gallery.

TYPE
image objects array
CONSTRAINTS
n/a
PRESENCE
always, but could be empty

Examples

CODE{% for image in product.images %}
{{ image.src }}
{% endfor %}
OUTPUT/files/gallery/00/00/00/00000001_00000007.jpg
/files/gallery/00/00/00/00000001_00000005.jpg
/files/gallery/00/00/00/00000001_00000006.jpg

Variable Dump

Copy and paste the below HTML into a product type template page, to see all product data dumped to your product page. You can then simply remove the unnecessary fields and other elements, and format the remaining fields however necessary to achieve the desired look and feel. 

<style>
.thedump .name{
	background-color:#3A5FCD;
    color:white;
    padding:0.5em;
    font-weight:bold;
}
.thedump .code{
    background-color:#888888;
    color:white;
    padding:0.5em;
}
.thedump .out{
    background-color:white;
    color:#555555;
    padding:0.5em;
    border-bottom:1px solid #CCCCCC;
    margin-bottom:1em;
}
.thedump .code pre{
    padding:0;
    margin:0;
    font-size:1.1em;
}
</style>

<div class="thedump">
    <div class="name">Product ID (SKU)</div>
    <div class="code"><pre>&#123;&#123; product.id &#125;&#125;</pre></div>
    <div class="out">{{ product.id }}</div>
    
    <div class="name">Product Brand</div>
    <div class="code"><pre>id: &#123;&#123; product.brand.id &#125;&#125;&lt;br/&gt;
reference: &#123;&#123; product.brand.ref &#125;&#125;&lt;br/&gt;
name: &#123;&#123; product.brand.name &#125;&#125;</pre></div>
    <div class="out">
        id: {{ product.brand.id }}<br/>
        reference: {{ product.brand.ref }}<br/>
        name: {{ product.brand.name }}<br/>
    </div>
    
    <div class="name">Product Collections</div>
    <div class="code"><pre>&#123;&#37; for collection in product.collections &#37;&#125;
    &lt;p&gt;
    id: &#123;&#123; collection.id &#125;&#125;&lt;br/&gt;
    reference: &#123;&#123; collection.ref &#125;&#125;&lt;br/&gt;
    name: &#123;&#123; collection.name &#125;&#125;
    url: &#123;&#123; collection | collection_url &#125;&#125;
    link: &#123;&#123; collection | collection_link: collection.name &#125;&#125;
    &lt;/p&gt;
&#123;&#37; endfor &#37;&#125;</pre></div>
    <div class="out">
		{% for collection in product.collections %}
		<p>
        	id: {{ collection.id }}<br/>
	        reference: {{ collection.ref }}<br/>
    	    name: {{ collection.name }}<br/>
    	    url: {{ collection | collection_url }}<br/>
    	    link: {{ collection | collection_link: collection.name }}
		</p>
        {% endfor %}
    </div>
    
    <div class="name">Product URL</div>
    <div class="code"><pre>&#123;&#123; product | product_url &#125;&#125;</pre></div>
    <div class="out">{{ product | product_url }}</div>
    
    <div class="name">Product Reference</div>
    <div class="code"><pre>&#123;&#123; product.ref &#125;&#125;</pre></div>
    <div class="out">{{ product.ref }}</div>
    
    <div class="name">Product Manufacturer Code</div>
    <div class="code"><pre>&#123;&#123; product.manufacturer_code &#125;&#125;</pre></div>
    <div class="out">{{ product.manufacturer_code }}</div>
    
    <div class="name">Product Manufacturer URL</div>
    <div class="code"><pre>&#123;&#123; product.manufacturer_url &#125;&#125;</pre></div>
    <div class="out">{{ product.manufacturer_url }}</div>
    
    <div class="name">Product Name</div>
    <div class="code"><pre>&#123;&#123; product.name &#125;&#125;</pre></div>
    <div class="out">{{ product.name }}</div>
    
    <div class="name">Product Highlights</div>
    <div class="code"><pre>&#123;&#123; product.highlights | newline_to_ul &#125;&#125;</pre></div>
    <div class="out">{{ product.highlights | newline_to_ul }}</div>
    
    <div class="name">Product Overview</div>
    <div class="code"><pre>&#123;&#123; product.overview &#125;&#125;</pre></div>
    <div class="out">{{ product.overview }}</div>
    
    <div class="name">Product Package Content</div>
    <div class="code"><pre>&#123;&#123; product.package_content &#125;&#125;</pre></div>
    <div class="out">{{ product.package_content }}</div>
   
    <div class="name">Product Featured Image</div>
    <div class="code"><pre>id: &#123;&#123; product.featured_image.id &#125;&#125;&lt;br/&gt;
alt: &#123;&#123; product.featured_image.alt &#125;&#125;&lt;br/&gt;
notes: &#123;&#123; product.featured_image.notes &#125;&#125;&lt;br/&gt;
&#123;&#123; product.featured_image.src &#125;&#125;&lt;br/&gt;
&#123;&#123; product.featured_image.src | img_tag &#125;&#125;&lt;br/&gt;
&#123;&#37; for variant in product.featured_image.variants &#37;&#125;
    &#123;&#123; variant.ref &#125;&#125;&lt;br/&gt;
    &#123;&#123; variant.src &#125;&#125;&lt;br/&gt;
    &#123;&#123; variant.src | img_tag &#125;&#125;&lt;br/&gt;
&#123;&#37; endfor &#37;&#125;
&#123;&#123; product.featured_image.variants.small.src &#125;&#125;&lt;br/&gt;
&#123;&#123; product.featured_image.variants.small.src | img_tag &#125;&#125;&lt;br/&gt;</pre></div>
    <div class="out">
        id: {{ product.featured_image.id }}<br/>
        alt: {{ product.featured_image.alt }}<br/>
        notes: {{ product.featured_image.notes }}<br/>
        {{ product.featured_image.src }}<br/>
        {{ product.featured_image.src | img_tag }}<br/>
        {% for variant in product.featured_image.variants %}
            {{ variant.ref }}<br/>
            {{ variant.src }}<br/>
            {{ variant.src | img_tag }}<br/>
        {% endfor %}
        {{ product.featured_image.variants.small.src }}<br/>
        {{ product.featured_image.variants.small.src | img_tag }}<br/>
    </div>
    
    <div class="name">Product Images</div>
    <div class="code"><pre>&#123;&#37; for image in product.images &#37;&#125;
    id: &#123;&#123; image.id &#125;&#125;&lt;br/&gt;
    alt: &#123;&#123; image.alt &#125;&#125;&lt;br/&gt;
    notes: &#123;&#123; image.notes &#125;&#125;&lt;br/&gt;
    &#123;&#123; image.src &#125;&#125;&lt;br/&gt;
    &#123;&#123; image.src | img_tag: image.alt &#125;&#125;&lt;br/&gt;
    &#123;&#37; for variant in image.variants &#37;&#125;
        &#123;&#123; variant.ref &#125;&#125;&lt;br/&gt;
        &#123;&#123; variant.src &#125;&#125;&lt;br/&gt;
        &#123;&#123; variant.src | img_tag: image.alt &#125;&#125;&lt;br/&gt;
    &#123;&#37; endfor &#37;&#125;
&#123;&#37; endfor &#37;&#125;</pre></div>
    <div class="out">
        {% for image in product.images %}
        id: {{ image.id }}<br/>
        alt: {{ image.alt }}<br/>
        notes: {{ image.notes }}<br/>
        {{ image.src }}<br/>
        {{ image.src | img_tag: image.alt }}<br/>
        {% for variant in image.variants %}
            {{ variant.ref }}<br/>
            {{ variant.src }}<br/>
            {{ variant.src | img_tag: image.alt }}<br/>
        {% endfor %}
        {% endfor %}
    </div>
</div>