Widget Token Reference

Widget Variables & Entity Tokens

Standard Widget Tokens

variable	entity
l.settings:widget:id	&mvt:widget:id;
l.settings:widget:code	&mvt:widget:code;
l.settings:widget:name	&mvt:widget:name;
l.settings:widget:name2	&mvt:widget:name2;
l.settings:widget:itype	&mvt:widget:itype;
l.settings:widget:prod_id	&mvt:widget:prod_id;
l.settings:widget:cat_id	&mvt:widget:cat_id;
l.settings:widget:disp_order	&mvt:widget:disp_order;
l.settings:widget:max_items	&mvt:widget:max_items;
l.settings:widget:templ_id	&mvt:widget:templ_id;
l.settings:widget:group_id	&mvt:widget:group_id;
l.settings:widget:active	&mvt:widget:active;
l.settings:widget:text	&mvt:widget:text;

Standard Widget Example

<mvt:item name="fonts" param="body_font">

<p>
<b>&mvt:widget:name;</b> (&mvt:widget:code;)
</p>

<p>
Lorem ipsum dolor sit amet, torquent convallis, condimentum ultrices purus 
aliquam urna quam eu, convallis molestie torquent viverra.
</p>

<p>
<a href="&mvt:global:sessionurl;Screen=SFNT&Store_Code=&mvta:global:Store_Code;">storefront</a>  |  
<mvt:if expr="g.Basket:cust_id EQ 0">
<a href="&mvt:global:secure_sessionurl;Screen=LOGN&Order=0&Store_Code=&mvt:global:Store_Code;">account</a>  |  
<mvt:else>
<a href="&mvt:global:secure_sessionurl;Screen=ACNT&Order=0&Store_Code=&mvt:global:Store_Code;">account</a>  |  
</mvt:if>
<a href="&mvt:global:sessionurl;Screen=PLST&Store_Code=&mvt:global:Store_Code;">products</a>  |  
<a href="&mvt:global:sessionurl;Screen=BASK&Store_Code=&mvt:global:Store_Code;">basket</a>  |  
<a href="&mvt:global:secure_sessionurl;Screen=OINF&Store_Code=&mvt:global:Store_Code;">checkout</a>
</p>


</mvt:item>

Other Tokens

Any available token available can be used in a Widget. The Store Helper Module can be used to display a listing of local and global variables for any MIVA Merchant 5 page.

Product Widget Tokens

variable	entity
l.settings:widget:prod_id	&mvt:widget:prod_id;
l.settings:widget:prod_code	&mvt:widget:prod_code;
l.settings:widget:product:active	&mvt:widget:product:active;
l.settings:widget:product:agrpcount	&mvt:widget:product:agrpcount;
l.settings:widget:product:catcount	&mvt:widget:product:catcount;
l.settings:widget:product:code	&mvt:widget:product:code;
l.settings:widget:product:cost	&mvt:widget:product:cost;
l.settings:widget:product:descrip	&mvt:widget:product:descrip;
l.settings:widget:product:disp_order	&mvt:widget:product:disp_order;
l.settings:widget:product:formatted_price	&mvt:widget:product:formatted_price;
l.settings:widget:product:id	&mvt:widget:product:id;
l.settings:widget:product:keywords	&mvt:widget:product:keywords;
l.settings:widget:product:name	&mvt:widget:product:name;
l.settings:widget:product:pgrpcount	&mvt:widget:product:pgrpcount;
l.settings:widget:product:price	&mvt:widget:product:price;
l.settings:widget:product:price2	&mvt:widget:product:price2;
l.settings:widget:product:summary	&mvt:widget:product:summary;
l.settings:widget:product:taxable	&mvt:widget:product:taxable;
l.settings:widget:product:weight	&mvt:widget:product:weight;

Product Widget Example

<table border="0" cellpadding="4" cellspacing="0" class="widgettable">
<tr><td align="left" valign="middle">
<mvt:item name="fonts" param="hdr_font">
<mvt:if expr="NOT ISNULL l.settings:widget:product:image">
<img src="&mvt:widget:product:image;" alt="&mvt:widget:product:name;">
<mvt:else>
 
</mvt:if>
</mvt:item>
</td></tr>
<tr><td align="left" valign="middle">
<mvt:item name="fonts" param="hdr_font">
<b>&mvt:widget:product:name;</b>
</mvt:item>
</td></tr>
<tr><td align="left" valign="middle" colspan="2"> </td></tr>
<tr>
<td align="left" valign="top">
<mvt:item name="fonts" param="body_font">
Quantity in Basket:
<mvt:if expr="l.settings:widget:product:quantity EQ 0">
<i>None</i>
<mvt:else>
<b>&mvt:widget:product:quantity;</b>
</mvt:if>
<br>
Code: <b>&mvt:widget:product:code;</b><br>
Price: <b>&mvt:widget:product:formatted_price;</b><br>
<mvt:if expr="l.settings:widget:product:weight NE 0">
Shipping Weight: <b>&mvt:widget:product:weight;</b> &mvt:store:wtunits;<br>
</mvt:if>
<mvt:if expr="NOT ISNULL l.settings:widget:product:customfield_values:customfields:custom1">
&mvt:customfield_names:customfields:custom1;:
<b>&mvt:widget:product:customfield_values:customfields:custom1;</b><br>
</mvt:if>
Price: <b>&mvt:widget:product:keywords;</b><br>
<mvt:if expr="l.settings:widget:product:inv_active">
&mvt:widget:product:inv_long;
</mvt:if>
 <br>
Keywords: &mvt:widget:product:keywords;<br>
</mvt:item>
</td></tr>
<form method="post" action="&mvt:global:sessionurl;">
<input type="hidden" name="Action" value="ADPR">
<input type="hidden" name="Screen" value="BASK">
<input type="hidden" name="Store_Code" value="&mvte:store:code;">
<input type="hidden" name="Product_Code" value="&mvte:widget:product:code;">
<tr><td> </td></tr>
<tr><td align="left" valign="top">
<mvt:item name="product_attributes" param="widget:product:id" />
</td></tr>
<tr><td> </td></tr>
<tr><td align="left" valign="middle">
<mvt:item name="fonts" param="body_font">
Quantity:
<input type="text" name="Quantity" value=1 size=4>
<mvt:item name="buttons" param="AddToBasket" />
</mvt:item>
</td></tr>
</form>
<tr><td align="left" valign="middle" colspan="2"> </td></tr>
<tr><td align="left" valign="middle" colspan="2">
<mvt:item name="fonts" param="body_font">
&mvt:widget:product:descrip;
</mvt:item>
</td></tr>
</table>

Category Widget Tokens

variable	entity
l.settings:widget:cat_id	&mvt:widget:cat_id;
l.settings:widget:cat_code	&mvt:widget:cat_code;
l.settings:widget:max_items	&mvt:widget:max_items;
l.settings:widget:category:active	&mvt:widget:category:active;
l.settings:widget:category:agrpcount	&mvt:widget:category:agrpcount;
l.settings:widget:category:code	&mvt:widget:category:code;
l.settings:widget:category:disp_order	&mvt:widget:category:disp_order;
l.settings:widget:category:id	&mvt:widget:category:id;
l.settings:widget:category:name	&mvt:widget:category:name;
l.settings:widget:category:parent_id	&mvt:widget:category:parent_id;
l.settings:widget:product_count	&mvt:widget:product_count;
l.settings:widget:product_count_all	&mvt:widget:product_count_all;
l.settings:widget:product_list	&mvt:widget:product_list;

l.settings:product:active	&mvt:product:active;
l.settings:product:agrpcount	&mvt:product:agrpcount;
l.settings:product:catcount	&mvt:product:catcount;
l.settings:product:code	&mvt:product:code;
l.settings:product:cost	&mvt:product:cost;
l.settings:product:descrip	&mvt:product:descrip;
l.settings:product:disp_order	&mvt:product:disp_order;
l.settings:product:formatted_price	&mvt:product:formatted_price;
l.settings:product:full_price	&mvt:product:full_price;
l.settings:product:i	&mvt:product:i;
l.settings:product:id	&mvt:product:id;
l.settings:product:inv_active	&mvt:product:inv_active;
l.settings:product:name	&mvt:product:name;
l.settings:product:pgrpcount	&mvt:product:pgrpcount;
l.settings:product:price	&mvt:product:price;
l.settings:product:taxable	&mvt:product:taxable;
l.settings:product:weight	&mvt:product:weight;

Category Widget Example

<table border="0" cellspacing="0" cellpadding="2" class="widgettable">
<tr align="left" valign="top">
<td nowrap><mvt:item name="fonts" param="body_font">
<b>&mvt:widget:category:name;</b><br>
</mvt:item></td>
</tr>
<tr align="left" valign="top">
<td nowrap><mvt:item name="fonts" param="body_font">

	<table border="0" cellspacing="0" cellpadding="2">
	
	<mvt:foreach iterator="product" array="widget:product_list">
	
		<tr align="left" valign="top">
		<td nowrap><mvt:item name="fonts" param="body_font">
		<a href="&mvt:global:sessionurl;Screen=PROD&Store_Code=&mvta:global:Store_Code;&Product_Code=&mvta:product:code;&Category_Code=&mvt:widget:category:code;">&mvt:product:name;</a>
		</mvt:item></td>
		<td align="right"><mvt:item name="fonts" param="body_font">
		&mvt:product:formatted_price;
		</mvt:item></td>
		</tr>
		
	</mvt:foreach>
	
	</table>
	
</mvt:item></td>
</tr>
<tr align="left" valign="top">
<td nowrap><mvt:item name="fonts" param="body_font">
<b><a href="&mvt:global:sessionurl;Screen=CTGY&Store_Code=&mvta:global:Store_Code;&Category_Code=&mvt:widget:category:code;"> &mvt:widget:product_count_all; products...</a></b><br>
</mvt:item></td>
</tr>
</table>

Basket Widget Tokens

variable	entity
l.settings:widget:basket:subtotal	&mvt:widget:basket:subtotal;
l.settings:widget:basket:formatted_subtotal	&mvt:widget:basket:formatted_subtotal;
l.settings:widget:basket:total	&mvt:widget:basket:total;
l.settings:widget:basket:formatted_total	&mvt:widget:basket:formatted_total;
l.settings:widget:basket:items	&mvt:widget:basket:items;
l.settings:widget:basket:item_count	&mvt:widget:basket:item_count;

l.settings:item:code	&mvt:item:code;
l.settings:item:formatted_price	&mvt:item:formatted_price;
l.settings:item:formatted_subtotal	&mvt:item:formatted_subtotal;
l.settings:item:line_id	&mvt:item:line_id;
l.settings:item:name	&mvt:item:name;
l.settings:item:price	&mvt:item:price;
l.settings:item:product_id	&mvt:item:product_id;
l.settings:item:quantity	&mvt:item:quantity;
l.settings:item:subtotal	&mvt:item:subtotal;
l.settings:item:taxable	&mvt:item:taxable;
l.settings:item:upsold	&mvt:item:upsold;
l.settings:item:weight	&mvt:item:weight;

l.settings:option:attmpat_id	&mvt:option:attmpat_id;
l.settings:option:attr_code	&mvt:option:attr_code;
l.settings:option:attr_id	&mvt:option:attr_id;
l.settings:option:basket_id	&mvt:option:basket_id;
l.settings:option:formatted_price	&mvt:option:formatted_price;
l.settings:option:formatted_subtotal	&mvt:option:formatted_subtotal;
l.settings:option:line_id	&mvt:option:line_id;
l.settings:option:option_id	&mvt:option:option_id;
l.settings:option:opt_code	&mvt:option:opt_code;
l.settings:option:price	&mvt:option:price;
l.settings:option:subtotal	&mvt:option:subtotal;
l.settings:option:weight	&mvt:option:weight;

WidgetGroup Variables & Entity Tokens

WidgetGroup Tokens

variable	entity
l.settings:widgetgroup:id	&mvt:widgetgroup:id;
l.settings:widgetgroup:code	&mvt:widgetgroup:code;
l.settings:widgetgroup:name	&mvt:widgetgroup:name;
l.settings:widgetgroup:disp_order	&mvt:widgetgroup:disp_order;
l.settings:widgetgroup:templ_id	&mvt:widgetgroup:templ_id;
l.settings:widgetgroup:active	&mvt:widgetgroup:active;
l.settings:widgetgroup:text	&mvt:widgetgroup:text;
l.settings:widgetgroup:widgets_count	&mvt:widgetgroup:widgets_count;
l.settings:widgetgroup:widgets_list	&mvt:widgetgroup:widgets_list;

WidgetGroup Example

<table border="0" cellspacing="0" cellpadding="8" class="widgettable">
<tr align="left" valign="top">
<td><mvt:item name="fonts" param="body_font">
&mvt:widgetgroup:name; (&mvt:widgetgroup:code;)<br>
<b>GROUP:</b><br>
</mvt:item></td>
</tr>

<mvt:foreach iterator="widget" array="widgetgroup:widgets_list">

	<tr align="left" valign="top">
	<td><mvt:item name="fonts" param="body_font">
	&mvt:widget:text;
	</mvt:item></td>
	</tr>
	
</mvt:foreach>

</table>

close window