ProductListing Data Source
From i.STAR Help
Contents |
[edit]
Input Variables
| Name | Type | Required | Source | Description |
|---|---|---|---|---|
| numperpage | String | No | URL/Param | Number of products to be displayed per page |
| numperrow | String | No | URL/Param | Number of products to be displayed per row |
| pos | String | No | URL/Param | Position - the number of last product displayed on a page |
| sortby | String | No | URL/Param | Sort criteria for products displayed |
[edit]
Output Variables
| Name | Type | Description | Availability |
|---|---|---|---|
| $addtocarturl | String | Url string for add to cart button/link(s) | |
| $browselistingtype | Numeric | Browse listing type | |
| $category | String | Product category | |
| $compareat_label | String | Compare at price label | |
| $compareprice_high | Numeric | Compare at highest price in range | |
| $compareprice_low | Numeric | Compare at lowest price in range | |
| $classId | String | Class Id/Code of product | |
| $club_price_high | String | Highest club price in range | |
| $club_price_low | String | Lowest club price in range | |
| $clubprice_label | String | Club price label | |
| $departmentId | String | Department Id/Code of product | |
| $detailurl | String | Product detail page url of product | |
| $displayColorsAvailable | Boolean | Indicates whether to show product color availability | |
| $firstpageurl | String | Url for the first page for pagination | |
| $group | String | Product group | |
| $hasColors | Boolean | Indicates if product has more than one color | |
| $haspagination | Boolean | Indicates if product has more than one page | |
| $hasSKUs | Boolean | Indicates if product has more than one sku | |
| $iconNumber | Boolean | Icon Number | If icons apply |
| $iconText | String | Icon Text | If icons apply |
| $iconUrl | String | Icon Url | If icons apply |
| $id | String | Product Id/Code | |
| $instock_label | String | In stock label | |
| $instoreonly | Boolean | Indicates if product is only available for in store pruchase | |
| $lastpageurl | String | Url for the last page of the current product listing | |
| $longdescription | String | Extended description for product | |
| $manufcode | String | Manufacturer Code/Id | |
| $manufname | String | Manufacturer name | |
| $modelid | String | Model Id/Code | |
| $navurl | String | Url for page number links | |
| $nextpageurl | String | Url for the next page link | |
| $nextprev_bottom | Boolean | Indicates if previous page link is available for the pagination at the bottom of the page | |
| $nextprev_top | Boolean | Indicates if previous page link is available for the pagination at the top of the page | |
| $numperpage | String | Number of products to be displayed per page | |
| $numperrow | String | Number of products to be displayed per row | |
| $numreturned | Numeric | Number of products returned | |
| $onsale | Boolean | Indicates if products is on sale | |
| $outstock_label | String | Out of stock label | |
| $pagelabel_bottom | String | Pagination label for bottom set | |
| $pagelabel_top | String | Pagination label for bottom set | |
| $pagenum | Numeric | Page number | |
| $pagination_bottom | Boolean | Indicates whether pagination is shown on the bottom of the page | |
| $pagination_top | Boolean | Indicates whether pagination is shown on the top of the page | |
| $prevpageurl | String | Url for the previous page link | |
| $price_label | String | Price label | |
| $price_high | Numeric | Highest price in price range | |
| $price_low | Numeric | Lowest price in price range | |
| $pricefilterurl | String | Url with sortby value appended | |
| $sale_compareprice_high | Numeric | Highest price in sale compare price range | |
| $sale_compareprice_low | Numeric | Lowest price in sale compare price range | |
| $sale_regprice_label | String | Sale regular Price label | |
| $saleprice_label | String | Sale price label | |
| $season | String | Season code for product | |
| $selected | Boolean | Selected number per page | |
| $selectedsorttype | String | Season code for product | |
| $shortdescription | String | Product short description/title | |
| $show_club | Boolean | Indicates whether to show club pricing | |
| $show_compareat | Boolean | Indicates whether to show compare at pricing | |
| $show_stockstatus | Boolean | Indicates whether to show stock status | Only if stock status is present/supported for a product |
| $showdefaulttn | Boolean | Indicates whether to show default thumbnail | |
| $showmanufacturer | Numeric | Indicates whether to show manufacturer | |
| $sortalphaurl | String | Url with sortby value appended as "&sortby=ALPHA" | |
| $sortalphadescurl | String | Url with sortby value appended as "&sortby=ALPHADESC" | |
| $sortinstockurl | String | Url with sortby value appended as "&sortby=INSTOCK" | If stock status applies |
| $sortpricedescurl | String | Url with sortby value appended as "&sortby=PRICEDESC" | |
| $sortReceivedDateUrl | String | Url with sortby value appended as "&sortby=RECVDATE" | |
| $sorttopsellerurl | String | Url with sortby value appended as "&sortby=TOPSELLER" | |
| $sortstyle | Numeric | Indicates how the sort options are displayed | |
| $stockstatus_label | String | Stock status label | |
| $style | String | Style Code | |
| $subclassId | String | Subclass Id/Code | |
| $supports_stockstatus | Boolean | Indicates whether stock status is supported | |
| $suppress_price | Boolean | Indicates whether to show pricing | |
| $suppress_addtocart | Boolean | Indicates whether to add to cart button/link | |
| $tnurl | String | Thumbnail image path | |
| $totalnum | Numeric | Number of total products returned | |
| $totalpages | Numeric | Number of total products pages | |
| $usingdefaulttn | Boolean | Indicates whether default thumbnail is being used |
[edit]
Variable Availability Notes
i.STAR version 5.3
