• Navigation
  • Main Page
  • Design Considerations
  • i.STAR Start-up Docs
  • Release Notes
  • Optional Features
  • Modifying i.STAR pages
  • Customizing
  • Action ID Listing
  • Feature HowTo's
  • SEO Tips
  • Recent Changes
  • Help
• Links
  • i.STAR Help Tickets
  • Project Management Login
  • Discussion Forum
• Toolbox
  • What links here
  • Related changes
  • Upload file
  • Special pages
  • Printable version
• Personal tools
  • Admin Login

ProductDetail Data Source

From i.STAR Help

Contents 1 Input Variables 2 Output Variables 3 Variable Availability Notes

Input Variables

Name	Type	Required	Source	Description
id	String	Yes	URL/Param	The unique identifier of the product to display.

Output Variables

General Product Information

Name	Type	Description	Availability
$productId	String	The unique identifier for this product (style/vendor code combo).
$style	String	The Style number for this product.	11
$validProduct	Boolean	Whether or not this is a valid product.
$productDescription	String	The description of the product.	1
$productExtendedDescription	String	The extended description of the product.	1
$productExtendedDescriptionMargin	Numeric	The size of the left margin for the extended description.	1
$productHasColorImages	Boolean	Does the product have color images?	1
$productHasColor	Boolean	Does the product have colors?	1
$productHasSize	Boolean	Does the product have sizes?	1
$productHasSubsize	Boolean	Does the product have subsizes?	1
$productLowPrice	Numeric	The lowest price found for this product.	1
$productHighPrice	Numeric	The highest price found for this product.	1
$colorAlias	String	The term used to describe the color field.	1
$sizeAlias	String	The term used to describe the size field.	1
$subsizeAlias	String	The term used to describe the subsize field.	1
$modelidAlias	String	The term used to describe the model id field.	1
$priceAlias	String	The term used to describe the price field.	1
$compareSalePriceAlias	String	The term used to describe the compare at or sale price field.	1
$stockAlias	String	The term used to describe the stock status field.	1
$displayStockStatus	Boolean	Whether or not stock status should be displayed.	1
$displayCompareAtPrice	Boolean	True if compare at prices are configured to show and the compare at price is higher then the selling price. False otherwise.	1
$compareAtPriceAlias	String	The term used to describe the compare at price field.	1, 2
$compareAtLowPrice	Numeric	The lowest compare at price for this product.	1, 2
$compareAtHighPrice	Numeric	The highest compare at price for this product.	1, 2
$productOriginalImage	String	The original image for this product. This will be the image created by the import process or the default "no image" image.	1
$productImage	String	The full size image for this product.	1
$productImageDetail	String	The detail page sized image for this product.	1
$productImageThumbnail	String	The thumbnail sized image for this product.	1
$productImageWidth	Numeric	The width of a detail page sized image.	1
$productComparePrice	Numeric	The compare price of the product.	1, 3, *
$productSellingPrice	Numeric	The selling price of the product.	1, 3, *
$productStockStatus	String	The stock status message of the current product.	1, 3
$productInStockQuantity	Numeric	The number of items on hand for this product.	1, 3
$productAllowAdd	Boolean	Can this item be added to the shopping cart?	1, 3
$productAllowAddDeniedMessage	String	The message to display about why this item cannot be added to the shopping cart.	1, 3
$departmentName	String	The name of the department of this product.	1
$departmentCode	String	The code of the department of this product.	1
$departmentLink	String	The URL of the department of the product.	1
$className	String	The name of the class of this product.	1, 4
$classCode	String	The code of the class of this product.	1, 4
$classLink	String	The URL of the class of the product.	1, 4
$subclassName	String	The name of the subclass of this product.	1, 5
$subclassCode	String	The code of the subclass of this product.	1, 5
$subclassLink	String	The URL of the subclass of the product.	1, 5
$manufacturerName	String	The name of the manufacturer of this product.	1, 10
$manufacturerCode	String	The code of the manufacturer of this product.	1, 10
$productInStoreOnly	Boolean	Is this product only available in store?	1
$inStoreOnlyVerbage	String	The message to display regarding this item being available in store only.	1
$productAttributes	Collection	Addtional product attributes such as fabric or brand.	1
$productColors	Collection	A collection of colors for the current product.	1

Additional Product Attributes

Name	Type	Description	Notes
$attributeName	String	The name of this attribute.
$attributeVale	String	The value of this attribute.

Product Colors

Name	Type	Description	Notes
$colorName	String	The name of this color.
$colorCode	String	The code of this color.
$colorImage	String	The full size image for this color.	6
$colorImageDetail	String	The detail page size image for this color.	6
$colorImageThumbnail	String	The thumbnail size image for this color.	6
$colorComparePrice	Numeric	The compare price of this item.	7
$colorSellingPrice	Numeric	The selling price of this item.	7
$colorStockStatus	String	The stock status message of this item.	7
$colorInStockQuantity	Numeric	The number of items on hand.	7
$colorInStockQuantityText	String	The message to display the on hand quantity.	7
$colorAllowAdd	Boolean	Can this item be added to the shopping cart?	7
$colorSizes	Collection	The collection of sizes for the current color.

Color Sizes

Name	Type	Description	Notes
$sizeName	String	The name of this size.
$sizeCode	String	The code of this size.
$sizeComparePrice	Numeric	The compare price of this item.	8
$sizeSellingPrice	Numeric	The selling price of this item.	8
$sizeStockStatus	String	The stock status message of this item.	8
$sizeInStockQuantity	Numeric	The number of items on hand.	8
$sizeInStockQuantityText	String	The message to display the on hand quantity.	8
$sizeAllowAdd	Boolean	Can this item be added to the shopping cart?	8
$sizeSubsizes	Collection	The collection of subsizes for the current size.

Size Subsizes

Name	Type	Description	Notes
$subsizeName	String	The name of this subsize.
$subsizeCode	String	The code of this subsize.
$subsizeComparePrice	Numeric	The compare price of this item.	9
$subsizeSellingPrice	Numeric	The selling price of this item.	9
$subsizeStockStatus	String	The stock status message of this item.	9
$subsizeInStockQuantity	Numeric	The number of items on hand.	9
$subsizeInStockQuantityText	String	The message to display the on hand quantity.	9
$subsizeAllowAdd	Boolean	Can this item be added to the shopping cart?	9

Variable Availability Notes

1. These variables are only available when $validProduct is true.
2. These variables are only available when $displayCompareAtPrice is true.
3. These variables are only available when the product is also the item. (There is only 1 SKU.)
4. These variables are only available when the product has a valid class.
5. These variables are only available when the product has a valid subclass.
6. These variables are only available when there is an image for this color.
7. These variables are only available when this color is a SKU (No sizes or subsizes.)
8. These variables are only available when this size is a SKU (No subsizes.)
9. These variables are only available when this subsize is a SKU.
10. These variables are only available when the product has a valid manufacturer.
11. Available in i.STAR v5.0.