The following table describes the various product tokens which can be used in templates.
| Token ID | Description |
|---|---|
| AccessoriesAvailable | Returns True or False as to whether accessories exist for the queried product. Returns data from LivePriceCache table, not ProductAlternatives table. |
| AccessoriesCount | Returns total number of accessories for the queried product, taking into consideration any contract item rules. |
| AddProductToComparisonListToken | Renders a tick box which adds the queried product to the user's Comparison List. |
| AddReviewButton | Renders an 'Add Review' button which brings up a review form for the queried product. |
| AddToFavouritesButton | Renders an 'Add to Favourites' button which, when ticked, will add the queried product to the user's Favourites list. |
| AddToOrCreateOwnRegistryListButton | Renders html button for adding the queried product to one of the user's own registry lists, or creating and adding to a new list. |
| AddToOrderButton | Renders an 'Add to Order' button to add the product to the user's shopping cart. |
| AllowOrderEntryForProduct | Returns True for False as to whether the user should be permitted to order the product, based on various business rules. |
| AlternatesAccessoriesText | Retrieves html about accessories or products relating to the queried product. |
| AlternatesAvailable | Returns True or False as to whether alternates exist for the queried product. |
| AlternatesCount | Returns total number of alternates for the queried product. |
| AttributedProductDropDownList | Renders a drop-down list for attribute options against the queried (attributed) product. |
| AttributeList | Returns a list of all attribute combinations in the database for a queried (attributed) product. |
| AttributePriceBreakContainer | For Attributed Products (style/colour/size variations), renders the template for displaying quantity break information (IF quantity breaks exist for the attribute). |
| AvailableForBot | No longer in use. Use 'AvailableForOne' instead. |
| AvailableForOne | Renders the available quantity of the queried product. The value returned is determined by the system setting 'Available Qty calculation', and the system/role-based setting 'Stock Availability'. (Sites can be configured to take into account Qty On Hand, Qty Committed, Qty Backordered, Qty Forward Ordered, Qty on PO, and so forth. |
| AvailableQty | Returns the quantity available for sale (expressed as a decimal value), after calculating stock on hand, quantity committed, PO's in transit, etc. Useful for conditional templates in which logic is employed. |
| AvailableQtyNotIncCurrentLinesString | Returns the quantity available of the queried product, not taking into account quantities currently in shopping carts as unsubmitted orders. (If the site is configured to count stock in Unsubmitted Orders in availability calculations, this token will override that and just display the warehouse availability. |
| AverageRating | Returns average rating for the queried product, expressed as a decimal point (eg 1.00), IF the product has been rated at least once. Otherwise, returns the resource 'rcProductReviewNoteRated' (which could be set to say "Be the first to review this product" or similar). |
| AverageRatingDescription | Returns the text equivalent of the queried product's average rating value (defined in System Table of type='Rating'). For example, 3 stars = 'Average'. |
| AverageRatingText | If the queried product has reviews, returns the value of 'rcProductReviewRatingText', including the numeric average review. If no reviews, returns empty string. (Example '4 out of 5 possible Stars') |
| BonusStockForProductText | If there are 1 or more bonus products attached to the queried product, renders the content defined in "ProductBonusItemsTemplate" (set in Assign Default Templates - zAllocate.aspx). |
| ConfigureKitButton | Renders a resource-based input button that allows user to configure kit components. |
| CostCentreCode | Returns the cost centre code control HTML if the product is allowed to be ordered, otherwise returns ? |
| CustomerFavouritesProductDisplayIcon | Checks if the queried product is in the list of customer favourites. If so, returns a resource. |
| CustomerProductCode | Returns the Customer-specific product code for the queried product. |
| DeleteFromUserStocktakeButton | Renders a button to remove a product from the user's current stocktake calculation. |
| DiscountForOne | Returns the discount (if any apply) for quantity x 1 of the queried product. |
| DiscountForOneString | Returns the discount for qty x 1 of the queried product, including the '%' symbol. If no discount, returns empty string. |
| GPAmountEx | Returns the GP dollar amount (ex GST) for a quantity x 1 of the product. |
| GPAmountExForQty(Decimal) | Returns the GP dollar amount (ex GST) for a specified quantity of the product. |
| GPPercentageEx | Returns the GP percentage (ex GST) for a quantity x 1 of the product. |
| GPPercentageExForQty(Decimal) | Returns the GP percentage (ex GST) for a specified quantity of the product. |
| HasLiveQuantityBreaks | Returns True or False as to whether the product has quantity breaks, allowing for use in Xslt templates. (Only for Live connections) |
| KitCode | Returns the Kit Code if configurable kits are enabled and the queried product is a kit. |
| LiveQuantityBreakMessage | Returns a resource value (description) to indicate to the user that quantity break pricing applies to the queried product. |
| MetaDataSummary | Returns a summary of all product metadata as defined in MetaDataSummaryFieldGroup and rendered using MetaDataSummaryTemplate as nominated in ProductCategory, Role, or System settings. |
| MetaDataSummaryCustom(String, String) | Returns a summary of all product metadata as defined in the supplied template and fieldgroup. |
| NettPriceBreak0 | Returns the Nett Price Break (with discount) at level 0. Dependant on Customer settings whether price shown is GST-inclusive or -exclusive. Returns translated value based on resource 'PriceLevel0Template'. |
| NettPriceBreak0ExGST | Returns the Nett Price Break (with discount), ex-GST at level 0. Returns translated value based on resource 'PriceLevel0Template'. |
| NettPriceBreak0IncGST | Returns the Nett Price Break (with discount), incl-GST at level 0. Returns translated value based on resource 'PriceLevel0Template'. |
| NettPriceBreak1 | Returns the Nett Price Break (with discount) at level 1. Dependant on Customer settings whether price shown is GST-inclusive or -exclusive. Returns translated value based on resource 'PriceLevel1Template'. |
| NettPriceBreak1ExGST | Returns the Nett Price Break (with discount), ex-GST at level 1. Returns translated value based on resource 'PriceLevel1Template'. |
| NettPriceBreak1IncGST | Returns the Nett Price Break (with discount), incl-GST at level 1. Returns translated value based on resource 'PriceLevel1Template'. |
| NettPriceBreak2 | Returns the Nett Price Break (with discount) at level 2. Dependant on Customer settings whether price shown is GST-inclusive or -exclusive. Returns translated value based on resource 'PriceLevel2Template'. |
| NettPriceBreak2ExGST | Returns the Nett Price Break (with discount), ex-GST at level 2. Returns translated value based on resource 'PriceLevel2Template'. |
| NettPriceBreak2IncGST | Returns the Nett Price Break (with discount), incl-GST at level 2. Returns translated value based on resource 'PriceLevel2Template'. |
| NettPriceBreak3 | Returns the Nett Price Break (with discount) at level 3. Dependant on Customer settings whether price shown is GST-inclusive or -exclusive. Returns translated value based on resource 'PriceLevel3Template'. |
| NettPriceBreak3ExGST | Returns the Nett Price Break (with discount), ex-GST at level 3. Returns translated value based on resource 'PriceLevel3Template'. |
| NettPriceBreak3IncGST | Returns the Nett Price Break (with discount), incl-GST at level 3. Returns translated value based on resource 'PriceLevel3Template'. |
| NettPriceBreak4 | Returns the Nett Price Break (with discount) at level 4. Dependant on Customer settings whether price shown is GST-inclusive or -exclusive. Returns translated value based on resource 'PriceLevel4Template'. |
| NettPriceBreak4ExGST | Returns the Nett Price Break (with discount), ex-GST at level 4. Returns translated value based on resource 'PriceLevel4Template'. |
| NettPriceBreak4IncGST | Returns the Nett Price Break (with discount), incl-GST at level 4. Returns translated value based on resource 'PriceLevel4Template'. |
| NettPriceBreakPrice0 | Returns the Nett Price Break (with discount) at level 0. Dependant on Customer settings whether price shown is GST-inclusive or -exclusive. Returns the numeric value only, suitable for conditional templates (which employ logic). |
| NettPriceBreakPrice0ExGST | Returns the Nett Price Break (with discount), ex-GST at level 0. Returns the numeric value only, suitable for conditional templates (which employ logic). |
| NettPriceBreakPrice0IncGST | Returns the Nett Price Break (with discount), incl-GST at level 0. Returns the numeric value only, suitable for conditional templates (which employ logic). |
| NettPriceBreakPrice1 | Returns the Nett Price Break (with discount) at level 1. Dependant on Customer settings whether price shown is GST-inclusive or -exclusive. Returns the numeric value only, suitable for conditional templates (which employ logic). |
| NettPriceBreakPrice1ExGST | Returns the Nett Price Break (with discount), ex-GST at level 1. Returns the numeric value only, suitable for conditional templates (which employ logic). |
| NettPriceBreakPrice1IncGST | Returns the Nett Price Break (with discount), incl-GST at level 1. Returns the numeric value only, suitable for conditional templates (which employ logic). |
| NettPriceBreakPrice2 | Returns the Nett Price Break (with discount) at level 2. Dependant on Customer settings whether price shown is GST-inclusive or -exclusive. Returns the numeric value only, suitable for conditional templates (which employ logic). |
| NettPriceBreakPrice2ExGST | Returns the Nett Price Break (with discount), ex-GST at level 2. Returns the numeric value only, suitable for conditional templates (which employ logic). |
| NettPriceBreakPrice2IncGST | Returns the Nett Price Break (with discount), incl-GST at level 2. Returns the numeric value only, suitable for conditional templates (which employ logic). |
| NettPriceBreakPrice3 | Returns the Nett Price Break (with discount) at level 3. Dependant on Customer settings whether price shown is GST-inclusive or -exclusive. Returns the numeric value only, suitable for conditional templates (which employ logic). |
| NettPriceBreakPrice3ExGST | Returns the Nett Price Break (with discount), ex-GST at level 3. Returns the numeric value only, suitable for conditional templates (which employ logic). |
| NettPriceBreakPrice3IncGST | Returns the Nett Price Break (with discount), incl-GST at level 3. Returns the numeric value only, suitable for conditional templates (which employ logic). |
| NettPriceBreakPrice4 | Returns the Nett Price Break (with discount) at level 4. Dependant on Customer settings whether price shown is GST-inclusive or -exclusive. Returns the numeric value only, suitable for conditional templates (which employ logic). |
| NettPriceBreakPrice4ExGST | Returns the Nett Price Break (with discount), ex-GST at level 4. Returns the numeric value only, suitable for conditional templates (which employ logic). |
| NettPriceBreakPrice4IncGST | Returns the Nett Price Break (with discount), incl-GST at level 4. Returns the numeric value only, suitable for conditional templates (which employ logic). |
| NettPriceForOne | Returns price (no discount) for quantity x 1 of the product. Dependant on Customer settings whether price shown is GST-inclusive or -exclusive. |
| NettPriceForOneEx | Returns price (no discount) ex-tax, for quantity x 1 of the product. |
| NettPriceForOneExOrMessage | Same as NettPriceForOne, unless attribute(s) have not been configured. In this case, displays message to user to select product options (resource 'rcProductAttributePriceEmptyMessage'). |
| NettPriceForOneInc | Returns price (no discount) inc-tax, for quantity x 1 of the product. |
| NettPriceForOneIncOrMessage | Returns price (with discount) inc-tax, for quantity x 1 of the product, unless attribute(s) have not been configured. In this case, displays message to user to select product options (resource 'rcProductAttributePriceEmptyMessage'). |
| NettPriceForOneOrMessage | Returns price (with discount) for quantity x 1 of the product. Dependant on Customer settings whether price shown is GST-inclusive or -exclusive. |
| NettPriceForOneString | Returns Nett Price (with discount), for qty x 1 of the queried product. Returned value includes '$' symbol. Useful for display templates rather than conditional templates (which employ logic). |
| NettTaxForOne | Returns the GST amount for quantity x 1 of the product. |
| NumberOfReviews | Returns numeric value of the number of approved/published reviews for the queried product. |
| OnContract | Returns True or False as to whether the queried product is a contract item. |
| Picture1 | Returns the 'Picture1' file name for the queried product. |
| PriceBreak0 | Returns the Price Break (without discount). Dependant on Customer settings whether price shown is GST-inclusive or -exclusive. Returns translated value based on resource 'PriceLevel0Template'. |
| PriceBreak0ExGST | Returns the Price Break (without discount), ex-GST. Returns translated value based on resource 'PriceLevel0Template'. |
| PriceBreak0IncGST | Returns the Price Break (without discount), incl-GST. Returns translated value based on resource 'PriceLevel0Template'. |
| PriceBreak1 | Returns the Price Break (without discount). Dependant on Customer settings whether price shown is GST-inclusive or -exclusive. Returns translated value based on resource 'PriceLevelXTemplate'. |
| PriceBreak1ExGST | Returns the Price Break (without discount), ex-GST. Returns translated value based on resource 'PriceLevel1Template'. |
| PriceBreak1IncGST | Returns the Price Break (without discount), incl-GST. Returns translated value based on resource 'PriceLevel1Template'. |
| PriceBreak2 | Returns the Price Break (without discount). Dependant on Customer settings whether price shown is GST-inclusive or -exclusive. Returns translated value based on resource 'PriceLevelXTemplate'. |
| PriceBreak2ExGST | Returns the Price Break (without discount), ex-GST. Returns translated value based on resource 'PriceLevel2Template'. |
| PriceBreak2IncGST | Returns the Price Break (without discount), incl-GST. Returns translated value based on resource 'PriceLevel2Template'. |
| PriceBreak3 | Returns the Price Break (without discount). Dependant on Customer settings whether price shown is GST-inclusive or -exclusive. Returns translated value based on resource 'PriceLevelXTemplate'. |
| PriceBreak3ExGST | Returns the Price Break (without discount), ex-GST. Returns translated value based on resource 'PriceLevel3Template'. |
| PriceBreak3IncGST | Returns the Price Break (without discount), incl-GST. Returns translated value based on resource 'PriceLevel3Template'. |
| PriceBreak4 | Returns the Price Break (without discount). Dependant on Customer settings whether price shown is GST-inclusive or -exclusive. Returns translated value based on resource 'PriceLevelXTemplate'. |
| PriceBreak4ExGST | Returns the Price Break (without discount), ex-GST. Returns translated value based on resource 'PriceLevel4Template'. |
| PriceBreak4IncGST | Returns the Price Break (without discount), incl-GST. Returns translated value based on resource 'PriceLevel4Template'. |
| PriceBreakPrice0 | Returns the Price Break price (numeric only) at level 0. Dependant on Customer settings whether price shown is GST-inclusive or -exclusive. Does not translate the resource PriceLevelXTemplate. |
| PriceBreakPrice1 | Returns the Price Break price (numeric only) at level 1. Dependant on Customer settings whether price shown is GST-inclusive or -exclusive. Does not translate the resource PriceLevel1Template. |
| PriceBreakPrice2 | Returns the Price Break price (numeric only) at level 2. Dependant on Customer settings whether price shown is GST-inclusive or -exclusive. Does not translate the resource PriceLevel2Template. |
| PriceBreakPrice3 | Returns the Price Break price (numeric only) at level 3. Dependant on Customer settings whether price shown is GST-inclusive or -exclusive. Does not translate the resource PriceLevel3Template. |
| PriceBreakPrice4 | Returns the Price Break price (numeric only) at level 4. Dependant on Customer settings whether price shown is GST-inclusive or -exclusive. Does not translate the resource PriceLevel4Template. |
| PriceBreakQty0 | Returns the required quantity for a level 0 Price Break. |
| PriceBreakQty1 | Returns the required quantity for a level 1 Price Break. |
| PriceBreakQty2 | Returns the required quantity for a level 2 Price Break. |
| PriceBreakQty3 | Returns the required quantity for a level 3 Price Break. |
| PriceBreakQty4 | Returns the required quantity for a level 4 Price Break. |
| PriceContract | Returns the Contract price for quantity x 1 of the queried product. Dependant on Customer settings whether price shown is GST-inclusive or -exclusive. |
| PriceContractExGST | Returns the Contract price (ex GST) for quantity x 1 of the queried product. |
| PriceContractIncGST | Returns the Contract price (inc GST) for quantity x 1 of the queried product. |
| PriceCurrencySuffix | Displays the generic currency suffix or '(inc GST)' / '(ex GST)', depending on flags. |
| PriceForOne | Returns the price for quantity x 1 of the queried product. Dependant on Customer settings whether price shown is GST-inclusive or -exclusive. |
| PriceForOneEx | Returns the price (ex GST) for quantity x 1 of the queried product. |
| PriceForOneExOrMessage | Returns the price (ex GST), or message based on attribute config on page, for quantity x 1 of the queried product. |
| PriceForOneInc | Returns the price (inc GST) for quantity x 1 of the queried product. |
| PriceForOneIncOrMessage | Returns the price (inc GST) or message based on attribute config on page, for quantity x 1 of the queried product. |
| PriceForOneOrMessage | Returns the price for quantity x 1 of the queried product, unless attribute(s) have not been configured. In this case, displays message to user to select product options (resource 'rcProductAttributePriceEmptyMessage'). |
| PriceForOneString | Returns RRP with dollar sign symbol. Useful for display templates rather than conditional templates (which employ logic). |
| PriceFromDefault | For Attributed Products (style/colour/size variations), returns the RRP of the nominated default product - useful when variations have different prices. The lowest priced product would be nominated the default, then price could be displayed as 'From $XX.XX'. |
| PriceFromFirst | For Attributed Products (style/colour/size variations), returns the RRP of the first product found - useful when all variations are the same price. |
| PricePromotion | Returns a formatted value for Promotional Price based on the resource 'PricePromotionTemplate'. Dependant on both Customer settings AND 'System2.PromoPriceIncludesTax' whether price shown is GST-inclusive or -exclusive. |
| PricePromotionExGST | Returns a formatted value for Promotional Price (ex GST), based on the resource 'PricePromotionTemplate'. |
| PricePromotionIncGST | Returns a formatted value for Promotional Price (inc GST), based on the resource 'PricePromotionTemplate'. |
| QtyBox | Renders an input box for user to input quantity. |
| QuantityInCart | Returns the quantity of the queried product currently in the user's cart. |
| RequestedDeliveryDateBox | Renders an input box for user to input preferred order delivery date. |
| RRPEx | Returns the RRP (ex GST) for the queried product. |
| RRPExOrMessage | Returns the RRP (ex GST) for quantity x 1 of the queried product, unless attribute(s) have not been configured. In this case, displays message to user to select product options (resource 'rcProductAttributePriceEmptyMessage'). |
| RRPInc | Returns the RRP (inc GST) for the queried product. |
| RRPIncOrMessage | Returns the RRP (inc GST) for quantity x 1 of the queried product, unless attribute(s) have not been configured. In this case, displays message to user to select product options (resource 'rcProductAttributePriceEmptyMessage'). |
| RRPOrMessage | Returns the RRP for quantity x 1 of the queried product, unless attribute(s) have not been configured. In this case, displays message to user to select product options (resource 'rcProductAttributePriceEmptyMessage'). Dependant on Customer settings whether price shown is GST-inclusive or -exclusive. |
| StocktakeQty | Renders the quantity of the queried product counted in the user's current User Stocktake for that Customer. Returns an empty string if the feature is disabled. |
| UserFavouritesProductDisplayIcon | Checks if the queried product is in the list of user favourites. If so, returns a resource. |
For further information on how to use a particular product token, please contact Commerce Vision Support.
Related articles
