Functions:pageProductsGet
From Whirlwind eCommerce Wiki
Revision as of 00:20, 7 October 2008 by 71.163.185.8 (Talk)
Description
retrieves product data for use in displaying products in page template management.
Syntax
$array = eV::pageProductsGet($pageId[,$fieldList]);
Paramaters
- $pageId INT
- specifies the parent page whos products will be retrieved (as selected in relationships for the page). Use the core variable $pageId to call products for the current page.
Return Values
Returns a multidimensional array containing product data. The first dimension is the product index, the second dimension is an associative array of product information for the product index. Return array is as follows:
Array
(
[0] => Array
(
[productId] => INT
[title] => STR
[childDescription] => STR
[imagePath] => STR
[productNumber] => STR
[catalogNumber] => STR
[listPrice] => DECIMAL
[salePrice] => DECIMAL
[price] => DECIMAL
[saleFromDate] => DATETIIME
[saleToDate] => DATETIME
[isTaxable] => BIT
[shippingSurcharge] => DECIMAL
[weight] => DECIMAL
[imageAlt] => STR
[saleOn] => BIT
[customContent] => STR
[priceLevelsData] => STR
[optionGroupsData] => STR
[priceLevelArray] => Array
(
[0] => Array
(
[quantity] => INT
[price] => DECIMAL
[price2] => DECIMAL
[price3] => DECIMAL
[price4] => DECIMAL
)
[1] ...
)
[optionGroupArray] => Array
(
[0] => Array
(
[groupId] => INT
[groupName] => STR
[groupField] => STR
[optionList] => STR
[optionArray] => Array
(
[0] => Array
(
[text] => STR
[price] => DECIMAL
[sku] => STR
[priceOption] => INT
[weight] => DECIMAL
)
)
)
[1] ...
)
)
[1] ...
)
Elements from the product associative array are as follows:
| Element | Description | Example |
| productId | INTEGER - the unique id assigned to the product when created in administration | 123 |
| title | STRING - as set in administration console for this product, typically used as a short title for the product when displaying it in a page and / or when displaying it in the shopping cart | Shirt |
| childDescription | STRING - as set in administration for this product, typically used to further describe the product when it is listed in a page. | This is an oversized long sleeve shirt |
| imagePath | STRING - path to the image representing the product as set in administration for this product. Typically used in the shopping cart. | /folder/folder/image.jpg |
| productNumber | STRING - stock code as assigned in administration for this product. Synonymous with SKU, this number is usually displayed in the page containing the product, the shopping cart, throughout the checkout process and even in order management after the sale. | SLSO1 |
| catalogNumber | STRING - an alternative number associated with the product. Typically used in print catalogs, this number is usually used for catalog quick order forms and/or a way for the customer to verify they are ordering the same item online as it appears in the catalog. Usually this is the same as the SKU. | SHRTLSO |
| DECIMAL - the list price as set in administration for the product. Typically used to show the visitor the discount they are receiving. When the visitor purchases they will receive the best price of the following :listPrice, salePrice (if qualifies), price, qualifying price level(s) | 12.34 | |
| salePrice | DECIMAL - The sale price as set in administration for the product. Typically used for special promotions or sales for the product, it can be controlled via the saleFromDate and saleToDate fields (use saleOn is a quick test to see if the sale price qualifies) | 10.45 |
| price | DECIMAL - the price as set in administration for the product. This is typically the 'regular price' of the product, what it is typically sold for on the web site. Note, as you are building the page template that contains products you can display this information anyway you wish - as clients typically want their regular price to look like a special price even though it is not. | 11.22 |
| saleFromDate | DATETIME - The starting date that the sale price will be available, as set in administration for this product. If this value is empty, than the sale price has no starting date and is considered available until the saleToDate is reached. | 2008-08-25 00:00:00 |
| saleToDate | DATETIME - the ending date that the sale price will be available until, as set in administration for this product. If this value is empty, than the sale price never ends and is considered available so long as the saleFromDate is passed. | 2008-08-30 00:00:00 |
| isTaxable | BIT - Flag set in administration to mark if the product qualifies for taxation rules or not. | 1 |
| shippingSurcharge | DECIMAL - additional surcharge added to shipping for this product. This shipping surcharge is multiplied by the product quantity | 11.22 |
| weight | DECIMAL - the weight for the product as set in administration. Used to calculate shipping via weighted shipping tables. Stated in Lbs. | 5.45 |
| imageAlt | STRING - image alt value as set in administration. To be applied to the imagePath image with it is displayed. | Picture of a shirt |
| saleOn | BIT - an easy flag that set to 1 if a sale price is set and the saleFromDate, saleToDate are met. Set to 0 if not. | 1 |
| customContent | STRING - depriciated | |
| priceLevelArray | Array - multidimensional array containing price levels and prices/quantities associated with each level. Prices will be calculated automatically when item(s) are added to the shopping cart, so this information is for display purposes only. See below table for breakdown | [Array] |
| optionGroupArray | Array - multidimensional array containing option group information. See below table for breakdown | [Array] |
Elements from the priceLevelArray associative array are as follows:
| Element | Description | Example |
| quantity | INTEGER - quantity floor threshold to qualify for this price. | 3 |
| price | DECIMAL - price (per item) that the product will qualify for if quantity threshold is met | 9.00 |
| price2 | DECIMAL - alternate price (per item) that the product will qualify for if quantity threshold is met AND an option is selected that contains the {priceOption:2} flag, as set in administration. | 8.00 |
| price3 | DECIMAL - alternate price (per item) that the product will qualify for if quantity threshold is met AND an option is selected that contains the {priceOption:3} flag, as set in administration. | 7.00 |
| price4 | DECIMAL - alternate price (per item) that the product will qualify for if quantity threshold is met AND an option is selected that contains the {priceOption:4} flag, as set in administration. | 6.00 |
Elements from the optionGroupArray associative array are as follows:
| Element | Description | Example |
| groupId | INTEGER - the unique ID assigned to the group when it is created in administration | 25 |
