http://wiki.whirlwind-ecommerce.com/mediawiki/index.php?action=history&feed=atom&title=Functions%3AcatalogProductsGetFunctions:catalogProductsGet - Revision history2026-05-17T10:47:16ZRevision history for this page on the wikiMediaWiki 1.24.2http://wiki.whirlwind-ecommerce.com/mediawiki/index.php?title=Functions:catalogProductsGet&diff=521&oldid=prev71.163.185.8: added lowFlatPrice2009-01-27T13:42:41Z<p>added lowFlatPrice</p>
<table class='diff diff-contentalign-left'>
<col class='diff-marker' />
<col class='diff-content' />
<col class='diff-marker' />
<col class='diff-content' />
<tr style='vertical-align: top;'>
<td colspan='2' style="background-color: white; color:black; text-align: center;">← Older revision</td>
<td colspan='2' style="background-color: white; color:black; text-align: center;">Revision as of 13:42, 27 January 2009</td>
</tr><tr><td colspan="2" class="diff-lineno">Line 29:</td>
<td colspan="2" class="diff-lineno">Line 29:</td></tr>
<tr><td class='diff-marker'> </td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"><div>             [price] => DECIMAL</div></td><td class='diff-marker'> </td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"><div>             [price] => DECIMAL</div></td></tr>
<tr><td class='diff-marker'> </td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"><div>             [lowPrice] => DECIMAL</div></td><td class='diff-marker'> </td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"><div>             [lowPrice] => DECIMAL</div></td></tr>
<tr><td colspan="2"> </td><td class='diff-marker'>+</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div><ins style="font-weight: bold; text-decoration: none;">            [lowFlatPrice] => DECIMAL</ins></div></td></tr>
<tr><td class='diff-marker'> </td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"><div>             [saleFromDate] => DATETIIME</div></td><td class='diff-marker'> </td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"><div>             [saleFromDate] => DATETIIME</div></td></tr>
<tr><td class='diff-marker'> </td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"><div>             [saleToDate] => DATETIME</div></td><td class='diff-marker'> </td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"><div>             [saleToDate] => DATETIME</div></td></tr>
<tr><td colspan="2" class="diff-lineno">Line 127:</td>
<td colspan="2" class="diff-lineno">Line 128:</td></tr>
<tr><td class='diff-marker'> </td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"><div>|lowPrice</div></td><td class='diff-marker'> </td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"><div>|lowPrice</div></td></tr>
<tr><td class='diff-marker'> </td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"><div>|DECIMAL - the lowest possible price for this product. Takes into consideration list, regular, sale (if qualifies) and price levels.</div></td><td class='diff-marker'> </td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"><div>|DECIMAL - the lowest possible price for this product. Takes into consideration list, regular, sale (if qualifies) and price levels.</div></td></tr>
<tr><td colspan="2"> </td><td class='diff-marker'>+</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div><ins style="font-weight: bold; text-decoration: none;">|9.88</ins></div></td></tr>
<tr><td colspan="2"> </td><td class='diff-marker'>+</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div><ins style="font-weight: bold; text-decoration: none;">|-</ins></div></td></tr>
<tr><td colspan="2"> </td><td class='diff-marker'>+</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div><ins style="font-weight: bold; text-decoration: none;">|lowFlatPrice</ins></div></td></tr>
<tr><td colspan="2"> </td><td class='diff-marker'>+</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div><ins style="font-weight: bold; text-decoration: none;">|DECIMAL - the lowest flat price for this product. Takes into consideration list, regular, sale (if qualifies). DOES NOT take into consideration price levels.</ins></div></td></tr>
<tr><td class='diff-marker'> </td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"><div>|9.88</div></td><td class='diff-marker'> </td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"><div>|9.88</div></td></tr>
<tr><td class='diff-marker'> </td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"><div>|-</div></td><td class='diff-marker'> </td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"><div>|-</div></td></tr>
</table>71.163.185.8http://wiki.whirlwind-ecommerce.com/mediawiki/index.php?title=Functions:catalogProductsGet&diff=519&oldid=prev71.163.185.8: New page: {{Page Template Functions Shortcuts}} == Description == retrieves product data by catalog number. For use in displaying products in a catalog quick order page template management. == Syn...2009-01-26T13:04:33Z<p>New page: {{Page Template Functions Shortcuts}} == Description == retrieves product data by catalog number. For use in displaying products in a catalog quick order page template management. == Syn...</p>
<p><b>New page</b></p><div>{{Page Template Functions Shortcuts}}<br />
== Description ==<br />
retrieves product data by catalog number. For use in displaying products in a catalog quick order page template management. <br />
<br />
== Syntax ==<br />
$array = eV::catalogProductsGet($catalogNumber[,$fieldList]);<br />
<br />
== Paramaters ==<br />
*$catalogNumber STRING<br />
:: specifies the catalog number that the product must match in it's catalogNumber field to be returned.<br />
<br />
== Return Values ==<br />
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.<br />
Return array is as follows:<br />
<br />
<pre><br />
Array<br />
(<br />
[0] => Array<br />
(<br />
[productId] => INT<br />
[title] => STR<br />
[childDescription] => STR<br />
[imagePath] => STR<br />
[productNumber] => STR<br />
[catalogNumber] => STR<br />
[listPrice] => DECIMAL<br />
[salePrice] => DECIMAL<br />
[price] => DECIMAL<br />
[lowPrice] => DECIMAL<br />
[saleFromDate] => DATETIIME<br />
[saleToDate] => DATETIME<br />
[isTaxable] => BIT<br />
[shippingSurcharge] => DECIMAL<br />
[weight] => DECIMAL<br />
[imageAlt] => STR<br />
[saleOn] => BIT<br />
[customContent] => STR<br />
[priceLevelsData] => STR<br />
[optionGroupsData] => STR<br />
[priceLevelArray] => Array<br />
(<br />
[0] => Array<br />
(<br />
[quantity] => INT<br />
[price] => DECIMAL<br />
[price2] => DECIMAL<br />
[price3] => DECIMAL<br />
[price4] => DECIMAL<br />
<br />
)<br />
[1] ...<br />
)<br />
[optionGroupArray] => Array<br />
(<br />
[0] => Array<br />
(<br />
[groupId] => INT<br />
[groupName] => STR<br />
[groupField] => STR<br />
[optionList] => STR<br />
[optionArray] => Array<br />
(<br />
[0] => Array<br />
(<br />
[text] => STR<br />
[price] => DECIMAL<br />
[sku] => STR<br />
[priceOption] => INT<br />
[weight] => DECIMAL<br />
[value] => STR<br />
)<br />
)<br />
<br />
)<br />
[1] ...<br />
)<br />
<br />
)<br />
[1] ... <br />
)<br />
</pre><br />
<br />
Elements from the product associative array are as follows: <br />
{|border=2<br />
|-<br />
|Element<br />
|Description<br />
|Example<br />
|-<br />
|productId<br />
|INTEGER - the unique id assigned to the product when created in administration<br />
|123<br />
|-<br />
|title<br />
|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<br />
|Shirt<br />
|-<br />
|childDescription<br />
|STRING - as set in administration for this product, typically used to further describe the product when it is listed in a page.<br />
|This is an oversized long sleeve shirt<br />
|-<br />
|imagePath<br />
|STRING - path to the image representing the product as set in administration for this product. Typically used in the shopping cart.<br />
|/folder/folder/image.jpg<br />
|-<br />
|productNumber<br />
|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.<br />
|SLSO1<br />
|-<br />
|catalogNumber<br />
|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.<br />
|SHRTLSO<br />
|-<br />
|listPrice<br />
|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)<br />
|12.34<br />
|-<br />
|salePrice<br />
|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)<br />
|10.45<br />
|-<br />
|price<br />
|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.<br />
|11.22<br />
|-<br />
|lowPrice<br />
|DECIMAL - the lowest possible price for this product. Takes into consideration list, regular, sale (if qualifies) and price levels.<br />
|9.88<br />
|-<br />
|saleFromDate<br />
|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.<br />
|2008-08-25 00:00:00<br />
|-<br />
|saleToDate<br />
|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.<br />
|2008-08-30 00:00:00<br />
|-<br />
|isTaxable<br />
|BIT - Flag set in administration to mark if the product qualifies for taxation rules or not.<br />
|1<br />
|-<br />
|shippingSurcharge<br />
|DECIMAL - additional surcharge added to shipping for this product. This shipping surcharge is multiplied by the product quantity<br />
|11.22<br />
|-<br />
|weight<br />
|DECIMAL - the weight for the product as set in administration. Used to calculate shipping via weighted shipping tables. Stated in Lbs.<br />
|5.45<br />
|-<br />
|imageAlt<br />
|STRING - image alt value as set in administration. To be applied to the imagePath image with it is displayed.<br />
|Picture of a shirt<br />
|-<br />
|saleOn<br />
|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.<br />
|1<br />
|-<br />
|customContent<br />
|STRING - depriciated<br />
|<br />
|-<br />
|priceLevelArray<br />
|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<br />
|[Array]<br />
|-<br />
|optionGroupArray<br />
|Array - multidimensional array containing option group information. See below table for breakdown<br />
|[Array]<br />
|}<br />
<br />
Elements from the priceLevelArray associative array are as follows:<br />
{|border=2<br />
|-<br />
|Element<br />
|Description<br />
|Example<br />
|-<br />
|quantity<br />
|INTEGER - quantity floor threshold to qualify for this price.<br />
|3<br />
|-<br />
|price<br />
|DECIMAL - price (per item) that the product will qualify for if quantity threshold is met<br />
|9.00<br />
|-<br />
|price2<br />
|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.<br />
|8.00<br />
|-<br />
|price3<br />
|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.<br />
|7.00<br />
|-<br />
|price4<br />
|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.<br />
|6.00<br />
|-<br />
|}<br />
<br />
Elements from the optionGroupArray associative array are as follows:<br />
{|border=2<br />
|-<br />
|Element<br />
|Description<br />
|Example<br />
|-<br />
|groupId<br />
|INTEGER - the unique ID assigned to the group when it is created in administration<br />
|25<br />
|-<br />
|groupName<br />
|STRING - Group name as set in administration for the group. Typically used as a title for the group when presenting within the page.<br />
|Size<br />
|-<br />
|groupField<br />
|STRING - complete code for select field containing this groups' options. Simply plop into your page template where you want the drop down to appear.<br />
|&lt;SELECT name="group52"&gt;<br />
&lt;OPTION value="Small{sku:SM}"&gt;Small&lt;/OPTION&gt;<br />
&lt;OPTION value="Medium{sku:ME}"&gt;Medium&lt;/OPTION&gt;<br />
&lt;OPTION value="Large{sku:LG}{price:3.00}"&gt;Large + $3.00&lt;/OPTION&gt;<br />
&lt;/SELECT&gt;<br />
|-<br />
|optionArray<br />
|ARRAY - multidimensional array of option values for this group. See the following table for details<br />
|[ARRAY]<br />
|}<br />
<br />
Elements from the optionArray associative array are as follows:<br />
{|border=2<br />
|-<br />
|Element<br />
|Description<br />
|Example<br />
|-<br />
|text<br />
|STRING - The text output of the option<br />
|large<br />
|-<br />
|price<br />
|DECIMAL - the price offset of the option. This offset will be automatically added to the product cost, if this option is selected, when it is placed in the shopping cart.<br />
|3.00<br />
|-<br />
|sku<br />
|STRING - if this field has value, it will automatically be appended to the products' SKU (productNumber) when it is added to the shopping cart, if this option is selected.<br />
|_LG<br />
|-<br />
|priceOption<br />
|INTEGER - 1 through 4. If an option with this set is selected, the appropriate price level alt price (see priceLevelArray above) will be applied to the product price.<br />
|2<br />
|-<br />
|weight<br />
|DECIMAL - weight offset of the option. This offset is automatically added to the product weight if this option is selected, when the item is added to the shopping cart.<br />
|1.15<br />
|-<br />
|value<br />
|STRING - the full data value of the option including the text, price, weight, priceOption, sku. This is what is used to populate the value attribute of the form field (weather option, radio) when building custom product page forms.<br />
|Large{sku:_LG}{price:3.00}{weight:1.15}{priceOption:2}<br />
|}<br />
== Examples ==<br />
;Simple example displaying products and add to cart buttons (no options, not price levels)<br />
<source lang="php"><br />
// set catalog number if not set - should come from previous page submission<br />
if(!isset($attributes['catalogNumber'])) $attributes['catalogNumber'] = '';<br />
<br />
// get the product<br />
$prodArr = eV::catalogProductsGet($attributes['catalogNumber'],"title,childDescription,productNumber,lowPrice,productId");<br />
<br />
// loop thru products<br />
// usually there will only be on product returned (or zero for no match), but if more than one product match the catalog number, they will be returned.<br />
foreach($prodArr as $prod) {<br />
// output product data<br />
echo "<hr><b>" . $prod['title'] . "</b> - " . $prod['productNumber'] . " - " . eV::dollarFormat($prod['lowPrice']) . "<br>" . $prod['childDescription'];<br />
<br />
// product order form<br />
echo "<form action=\"index.php\" method=\"post\">";<br />
echo "<input type=\"text\" size=5 maxlength=4 name=\"quantity\"> <input type=\"submit\" value=\"Add To Cart\">";<br />
// hidden fields fa,productId required<br />
echo "<input type=\"hidden\" name=\"fa\" value=\"order.cartAdd\">";<br />
echo "<input type=\"hidden\" name=\"productId\" value=\"" . $prod['productId'] . "\">";<br />
echo "</form>";<br />
// end product loop<br />
};<br />
<br />
</source><br />
<br />
;Complex example displaying products, price levels and options (with simple option field output)<br />
<source lang="php"><br />
// set catalog number if not set - should come from previous page submission<br />
if(!isset($attributes['catalogNumber'])) $attributes['catalogNumber'] = '';<br />
<br />
// get the product<br />
$prodArr = eV::catalogProductsGet($attributes['catalogNumber']);<br />
<br />
// loop thru products<br />
foreach($prodArr as $prod) {<br />
<br />
// output base product data <br />
echo "<hr><b>" . $prod['title'] . "</b> - " . $prod['productNumber'] . " - as low as: " . eV::dollarFormat($prod['lowPrice']) . " each<br>" . $prod['childDescription'];<br />
<br />
// start price level table<br />
echo "<table><tr><td>Quantity</td><td>Price Each</td></tr>";<br />
// loop thru price levels and output<br />
foreach($prod['priceLevelArray'] as $priceLevel) echo "<tr><td>" . $priceLevel['quantity'] . "</td><td>" . eV::dollarFormat($priceLevel['price']) . " each</td></tr>";<br />
// end price level table<br />
echo "</table>";<br />
<br />
// start order form<br />
echo "<form action=\"index.php\" method=\"post\">";<br />
// loop thru option groups (must be inside of form, as they need to be submitted with form<br />
foreach($prod['optionGroupArray'] as $optionGroup) echo '<br>' . $optionGroup['groupName'] . " : " . $optionGroup['groupField'];<br />
<br />
// quantity and submit button<br />
echo "<br><input type=\"text\" size=5 maxlength=4 name=\"quantity\"> <input type=\"submit\" value=\"Add To Cart\">";<br />
<br />
// hidden fields fa, productId (required)<br />
echo "<input type=\"hidden\" name=\"fa\" value=\"ORDER.cartAdd\">";<br />
echo "<input type=\"hidden\" name=\"productId\" value=\"" . $prod['productId'] . "\">";<br />
<br />
// end order form<br />
echo "</form>";<br />
// end product loop<br />
};<br />
</source><br />
<br />
;Complex example displaying products with options (with complex option field output)<br />
<source lang="php"><br />
// loop thru products<br />
foreach($prodArr as $prod) {<br />
<br />
// output base product data <br />
echo "<hr><b>" . $prod['title'] . "</b> - " . $prod['productNumber'] . " - as low as: " . eV::dollarFormat($prod['lowPrice']) . " each<br>" . $prod['childDescription'];<br />
<br />
// start order form<br />
echo "<form action=\"index.php\" method=\"post\">";<br />
<br />
// loop thru option groups (must be inside of form, as they need to be submitted with form<br />
foreach($prod['optionGroupArray'] as $optionGroup) {<br />
echo '<br>' . $optionGroup['groupName'] . " : ";<br />
// start option group select field, be sure to get the name of this field correct<br />
echo "<select name=\"group" . $optionGroup['groupId'] . "\"><br />
// loop thru options and output<br />
<br />
foreach($optionGroup['optionArray'] as $option] {<br />
// start option field<br />
echo "<option value=\"" . $option['value'] . "\">" . $option['text'];<br />
// show price increase in field<br />
if(!empty($option['price'])) echo " +" . eV::dollarFormat($option['price']);<br />
// end option field<br />
echo "</option>";<br />
// end options loop<br />
};<br />
<br />
// end option group select field<br />
echo "</select>";<br />
<br />
// end option group loop<br />
};<br />
<br />
// quantity and submit button<br />
echo "<br><input type=\"text\" size=5 maxlength=4 name=\"quantity\"> <input type=\"submit\" value=\"Add To Cart\">";<br />
<br />
// hidden fields fa, productId (required)<br />
echo "<input type=\"hidden\" name=\"fa\" value=\"ORDER.cartAdd\">";<br />
echo "<input type=\"hidden\" name=\"productId\" value=\"" . $prod['productId'] . "\">";<br />
<br />
// end order form<br />
echo "</form>";<br />
// end product loop<br />
};<br />
</source></div>71.163.185.8