(PAGE IS INCOMPLETE)
The following table describes the various product tokens which can be used in templates.
| Token ID | Description | Notes/Comments (to be deleted before publishing) |
|---|---|---|
| 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 | ? | |
| AvailableForBot | ? | |
| AvailableForOne | ? | |
| AvailableQty | Returns the quantity available for sale after calculating stock on hand, quantity committed, PO's in transit, etc. | |
| AvailableQtyNotIncCurrentLinesString | ? | |
| AverageRating | Returns numeric star-rating of the average rating for the queried product. | Need to confirm - Returns resource? Or number? |
| AverageRatingDescription | ? | |
| AverageRatingText | ? | |
| BonusStockForProductText | ? | |
| CompanionCount | Returns the total number of companion products for the queried product. | (Companion product? Not sure what this is.) |
| 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 | ? | Why do we have both String & number? |
| 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) | |
| ImagePrefix | ? | |
| ImageSuffix | ? | |
| IncTaxPrice | Returns True or False as to whether the price displayed includes GST. | Need to confirm. Just basing this description on - http://www.radioparts.com.au/productdisplay.aspx?Product=39815910&Template=Tokens |
| ItemCostEx | Returns the Standard Cost (ex GST) for the queried product. | Need to confirm - Standard or Replacement? |
| ItemCostExForQty(Decimal) | Returns the Standard Cost (ex GST) for the queried product, for the specified quantity. | Need to confirm - Standard or Replacement? |
| ItemsOnOrder | Returns numeric value of (PO's + In Transit ?) or (Current Commitments?) for the queried product. | Need to confirm - which field does this draw from? |
| 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 | ? | What's the difference between this and 'NettPriceBreakPrice0' (below)? |
| NettPriceBreak0ExGST | ? | " |
| NettPriceBreak0IncGST | ? | " |
| NettPriceBreak1 | ? | " |
| NettPriceBreak1ExGST | ? | " |
| NettPriceBreak1IncGST | ? | " |
| NettPriceBreak2 | ? | " |
| NettPriceBreak2ExGST | ? | " |
| NettPriceBreak2IncGST | ? | " |
| NettPriceBreak3 | ? | " |
| NettPriceBreak3ExGST | ? | " |
| NettPriceBreak3IncGST | ? | " |
| NettPriceBreak4 | ? | " |
| NettPriceBreak4ExGST | ? | " |
| NettPriceBreak4IncGST | ? | " |
| NettPriceBreakPrice0 | Gets the Nett Price Break price at level 0. Dependant on Customer settings whether price shown is GST-inclusive or -exclusive. | |
| NettPriceBreakPrice0ExGST | Gets the Nett Price Break price (ex GST) at level 0 | |
| NettPriceBreakPrice0IncGST | Gets the Nett Price Break price (inc GST) at level 0 | |
| NettPriceBreakPrice1 | Gets the Nett Price Break price at level 1. Dependant on Customer settings whether price shown is GST-inclusive or -exclusive. | |
| NettPriceBreakPrice1ExGST | Gets the Nett Price Break price (ex GST) at level 1 | |
| NettPriceBreakPrice1IncGST | Gets the Nett Price Break price (inc GST) at level 1 | |
| NettPriceBreakPrice2 | Gets the Nett Price Break price at level 2. Dependant on Customer settings whether price shown is GST-inclusive or -exclusive. | |
| NettPriceBreakPrice2ExGST | Gets the Nett Price Break price (ex GST) at level 2 | |
| NettPriceBreakPrice2IncGST | Gets the Nett Price Break price (inc GST) at level 2 | |
| NettPriceBreakPrice3 | Gets the Nett Price Break price at level 3. Dependant on Customer settings whether price shown is GST-inclusive or -exclusive. | |
| NettPriceBreakPrice3ExGST | Gets the Nett Price Break price (ex GST) at level 3 | |
| NettPriceBreakPrice3IncGST | Gets the Nett Price Break price (inc GST) at level 3 | |
| NettPriceBreakPrice4 | Gets the Nett Price Break price at level 4. Dependant on Customer settings whether price shown is GST-inclusive or -exclusive. | |
| NettPriceBreakPrice4ExGST | Gets the Nett Price Break price (ex GST) at level 4 | |
| NettPriceBreakPrice4IncGST | Gets the Nett Price Break price (inc GST) at level 4 | |
| 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 | Returns price (with discount) ex-tax, for quantity x 1 of the product. | Need to confirm - what is "Or message" ? |
| 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. | Need to confirm - what is "Or message" ? |
| 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 | ? | |
| 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. | |
| OrderLineNote | Returns the text of the order note line associated with the queried product. | Need to confirm. (educated guess) |
| Picture1 | Returns the 'Picture1' file name for the queried product. | |
| Picture1Image | Renders the 'Picture1' image for the queried product. | |
| PriceBreak0 | ? | What's the difference between this and 'PriceBreakPrice0' (below)? |
| PriceBreak0ExGST | ? | " |
| PriceBreak0IncGST | ? | " |
| PriceBreak1 | ? | " |
| PriceBreak1ExGST | ? | " |
| PriceBreak1IncGST | ? | " |
| PriceBreak2 | ? | " |
| PriceBreak2ExGST | ? | " |
| PriceBreak2IncGST | ? | " |
| PriceBreak3 | ? | " |
| PriceBreak3ExGST | ? | " |
| PriceBreak3IncGST | ? | " |
| PriceBreak4 | ? | " |
| PriceBreak4ExGST | ? | " |
| PriceBreak4IncGST | ? | " |
| PriceBreakPrice0 | Returns the Price Break price at level 0. Dependant on Customer settings whether price shown is GST-inclusive or -exclusive. | |
| PriceBreakPrice1 | Returns the Price Break price at level 1. Dependant on Customer settings whether price shown is GST-inclusive or -exclusive. | |
| PriceBreakPrice2 | Returns the Price Break price at level 2. Dependant on Customer settings whether price shown is GST-inclusive or -exclusive. | |
| PriceBreakPrice3 | Returns the Price Break price at level 3. Dependant on Customer settings whether price shown is GST-inclusive or -exclusive. | |
| PriceBreakPrice4 | Returns the Price Break price at level 4. Dependant on Customer settings whether price shown is GST-inclusive or -exclusive. | |
| 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, or message based on attribute config on page, for quantity x 1 of the queried product. | (do we have an example of attribute related msg?) |
| PriceForOneString | ? | |
| PriceFromDefault | ? | |
| PriceFromFirst | ? | |
| PricePromotion | Formats the ProntoPriceRecord["PromPrice"] so this is essentially ex GST. | What does this mean? Especially in relation to the next two on the list ('PricePromotionExGST' and 'IncGST')? |
| PricePromotionExGST | ? | |
| PricePromotionIncGST | ? | |
| ProductParsedListTemplate(String) | Returns a parsed template for the queried product. Designed to replace WebServiceAjax.ProductSearchWithListTemplate with DynamicServices and call Product.GetProductWithFilter. | In english? |
| ProductParsedListTemplateBatched(String, Boolean) | Returns a parsed template for THE WHOLE Product RECORDSET - will only return parsed data for the first record in the set. Assumes that the template has a CSSRepeat in it. | In english? |
| QtyBox | Renders an input box for user to input quantity. | |
| QuantityInCart | Returns the quantity of the queried product currently in the user's cart. | |
| RegistryListIDHiddenHtmlField | Renders a html input hidden field for adding products for the RegistryListID contained in the querystring. The resource has 2 parameters: the product code, and the RegistryListID. | In english? |
| RequestedDeliveryDateBox | Renders an input box for user to input preferred order delivery date. | |
| ReviewSummary | ? | Guessing to do w/ Product Reviews, but not sure which field. |
| RRPEx | Returns the RRP (ex GST) for the queried product. | |
| RRPExOrMessage | Returns the RRP (ex GST), or message based on attribute config on page, for quantity x 1 of the queried product. | (do we have an example of attribute related msg?) |
| RRPInc | Returns the RRP (inc GST) for the queried product. | |
| RRPIncOrMessage | Returns the RRP (inc GST), or message based on attribute config on page, for quantity x 1 of the queried product. | (do we have an example of attribute related msg?) |
| RRPOrMessage | Returns the RRP, or message based on attribute config on page, for quantity x 1 of the queried product. Dependant on Customer settings whether price shown is GST-inclusive or -exclusive. | (do we have an example of attribute related msg?) |
| 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. | |
| UniqueBomLineTypeConfigurableKitComponents | Returns a ProntoBillOfMaterials set of unique BomLineTypes of configurable kit components for the product. | Example would help. |
| UserFavouritesProductDisplayIcon | Checks if the queried product is in the list of user favourites. If so, returns a resource. |
