Shopping cart software for Dreamweaver, Frontpage, CSS and Golive templates

Home > PHP Version Help > Parameters for the includes.php page

PHP Parameters

In the folder vsadmin there's a file called includes.php - this is where you can specify some important options regarding mail, shipping, tax, and the display options for your product pages. Below is a guide to preparing the set up that best suits your needs. If the include line is not present in your list, it can be added and the position of the line is not important to functionality. Additions since the previous version (5.4) will appear in orange.

Please note that the parameters are all Case Sensitive.

Email Options	Layout Options	Payment Options
· Email a friend	· Product listings	· Setting the path to your SSL
· HTML emails	· Product layout options	· Disabling SSL
· Email orders	· Continue shopping link	· Encryption
· Email headers and footers	· Category layout options	· Dump credit card numbers
· Order status email	· DHTML menu	· Force form submission
· Custom headers	· Product separation	· Authorize.net
· Order tracking	· Product detail static page	· Capture card order status
· Collect email addresses	· Cart product image	· Force CVV credit card code
· Remove mailing list option	· Cart product image link	· Verisign PayFlow Pro
· Mailing list confirmation	· Multi-purchase columns	· 2Checkout
		· PayPal
		· Google Checkout
Shipping / Tax Options	Display Options	Affiliate Options
· Adding tax to shipping	· Product page display numbers	· Affiliates cookie
· Removing the shipping address	· Removing buy and checkout buttons	· Affiliates commission
· Will pick up option	· Remove top navigation
· Show tax inclusive prices	· Terms and Conditions
· UPS options	· Quantity boxes
· Commercial location	· Zero price message
· Shipping insurance	· Show product id
· Invoice / packing slips	· Hide product options
· Canadian tax	· Extra checkout fields
· Per payment provider handling charge	· Forcing minimum purchase amount
· Split heavy packages	· Alternative currency format
· Canada Post	· Product detail link
· Per product tax rate	· Hide product option price
· Shipping estimator	· Remove category ID
· Shipping carriers switch	· Show products in stock
· Combine shipping and handling	· Optional zip (postal) code
· Shipping tracking	· Cross selling
· FedEx	· Force product detail link
	· Limit product description
	· Remove remember me
	· Show the product SKU
	· Show manufacturer in search
	· Show manufacturer on products page
	· Alternate Product ID options
Discount Options	Customer Login	Admin Tweaks
· Remove discount / coupon feature	· Enable customer login	· cURL compilation
· Hide discount / coupon text	· Wholesale pricing	· Currency formats
	· Forwarding page	· Adjust date
	· Force customer login	· Admin product sort
	· Self registry	· Character sets
	· Remove login prompt	· Multiple languages
	· Customer login link	· IP blocking
		· Second store URL
		· Admin login
		· Our ESolutions Quickbooks
		· Product admin HTML editor
		· State abbreviations
		· Static page redirection
Image tweaks	Customer Reviews
· Change buttons to images	· Enable customer reviews
· Giant image properties	· Logged in customer reviews only
· Default image folder	· Display options
	· Limit daily reviews

Email options

· Email a friend (Minimum version 1.3.7)

You can now add the option of emailing a friend from your product detail page - this adds a link to a pop-up window with a form that you can fill out to forward the information regarding a product to a friend. If you wish to use this feature set the parameter like this $useemailfriend=TRUE;
if you would like to disable the feature then you need
$useemailfriend=FALSE;

· HTML email (Minimum version 4.0.0)

Emails can be sent in HTML format if you wish by adding the following switch
$htmlemails=TRUE;

· Email orders (Minimum version 4.0.0)

If you need to set email orders as Authorized in your admin orders page, set
$emailorderstatus=3;
Please note that if you use a value less than 3 then the orders are not authorized your cart will not clear after purchase.

IMPORTANT NOTE
An order status below 3 is not considered "completed". If this isn't what is needed, then it is better to make a new order status like "Received email order" and assign the emailorderstatus to that new status id. That way the order will be "completed".

· Email headers and footers (Minimum version 4.2.2)

This feature allows you to add email headers and footers to emails either for all payment systems, or depending on the payment system chosen.
If you want to add a header or footer to all emails then just add the following to your vsadmin/includes.php file
$emailheader="This is your email header";
$emailfooter="This is your email footer";

If you want to add a header or footer only for a particular payment system then first go to your admin payment providers page. You will see that now the first column is the payment provider id. Take a note of the id of the payment provider you are interested in. Now if for instance you wanted to add a header or footer for the "Email" payment provider, you will see that the id is 4. All you have to do is add the id "4" after emailheader or emailfooter like this...
$emailheader4="This is your email header for the email payment provider";
$emailfooter4="This is your email footer for the email payment provider";

NOTE
If you need to place HTML within the parameter and it includes quotation marks you have to do something to allow you to have quotes within quotes and that is to "escape" them with a slash. For instance.
$emailheader4="This is ok";
$emailheader4="This "would cause an error" message";
$emailheader4="This \"would NOT cause an error\" message";

For example to center your text . . .
$emailheader4="<p align=\"center\">Text goes here</p>";

· Dropshipper headers and footers (Minimum version 4.8.0)

If you want to add a header or footer for the email sent out to dropshippers then the general header / footer for all payment types would be like this:
$dropshipheader="<br>general drop ship header<br>";
$dropshipfooter="general drop ship footer<br>";

There is an additional Header / footer only for payment method 4 (Email Only)
$dropshipheader4="drop ship header for drop shipper 4<br>";
$dropshipfooter4="drop ship footer for drop shipper 4<br>";

· Order status email (Minimum version 4.5.0)

You can now set the system to send an email to customers when you change the order status on the admin orders page. To turn this feature on you need to add the following parameter for example...

$orderstatusemail="Your order id %orderid% from %orderdate% has been updated from %oldstatus% to %newstatus% on %date% and the additional comments are %statusinfo%";

...where %statusinfo% is the information added to the Status Info field in the admin orders page.

The message can be anything you like, and can contain HTML if you have the $htmlemails=true; setting. The following parameters will be replaced with the actual order and order status details...
%orderid%
%orderdate%
%oldstatus%
%newstatus%
%date%
%statusinfo%

From version 4.8.6 %ordername% can be added to the order status emails and will be replaced by the customers name. Also, you can use %nl% for new lines.

You can also set a parameter $orderstatussubject for the order status emails in the vsadmin/includes.php file, for example...
$orderstatussubject = "Place your text here";
If you don't set this then the default email subject "Order status updated" will be used for the order status emails.

Using the setting
$alwaysemailstatus=true;
will mean that the checkbox for "email order status change" is always set by default.

· Custom headers (Minimum version 4.8.4)

You can set the parameter $customheaders in your vsadmin/includes.php file for hosts that require non-standard email headers. Instances of %from% will be replaced by the "From:" address and instances of "%to%" (not normally needed) will be replaced by the "To:" address. For example . . .
$customheaders = "MIME-Version: 1.0\nFrom: %from%\nContent-type: text/plain; charset=iso-8859-1\n";

· Order tracking (Minimum version 5.0.0)

A separate tracking number can be set in the admin orders page, and this can be set in the order status email by specifying %trackingnum%
The default text for the tracking number would be for instance . . .
Your tracking number is: AAAAABBBBBBBCCCCCC
You can optionally set the text that is displayed for the tracking number by setting trackingnumtext. For instance . . .
$trackingnumtext="This is your tracking number: %s %nl%";

The %s will be replaced with the actual tracking number. %nl% will be replaced by a new line as always.

An example of the order status email therefore could be:

$orderstatusemail = "Dear %ordername%%nl%Your order id %orderid% from %orderdate% has been updated from %oldstatus% to %newstatus% on %date%%nl%%trackingnum%%nl%Additional Information: %statusinfo%";

· Collect email addresses (Minimum version 5.3.0)

Customers are asked on checkout if they would be willing to receive promotional emails and if so their email is added to the database for you to use with your mailshots.
If the following is set in the vsadmin/includes.php file then by default the box will be checked.

$allowemaildefaulton=TRUE;

· Remove mailing list checkbox (Minimum version 5.3.1)

Set this in vsadmin/includes.php

$nomailinglist=TRUE;

to remove the mailing list checkbox.

· Stop email confirmation for mailing list (Minimum version 5.4.0)

Setting this in vsadmin/includes.php

$noconfirmationemail=TRUE;

will stop the email a customer receives to verify their mailing list sign-up. By default the customer will receive an email to verify their address and intention.

Layout options

· Product listings (Minimum version 1.3.7)

You can now choose how to sort your product listings - you can do this alphabetically, by id or by price. There are four options:

1. = sorting the products alphabetically
2. = sorting the products by id
3. = sorting the products by price (cheapest first)
4. = sorting the products by price (most expensive first)

So for example if you wanted to list your products alphabetically you would choose this option:
$sortBy = 1;
or by product id like this
$sortBy = 2;

$sortBy=6;
(Minimum version 5.1.0)
This will sort the products in ascending order depending on the value added to the "Product Order" box in the product admin page.
$sortBy=7;
(Minimum version 5.1.0)
This will sort the products in descending order depending on the value added to the "Product Order" box in the product admin page.

$sortBy=8;
(Minimum version 5.4.0)
This will sort the products in ascending order depending on the date added.
$sortBy=9;
(Minimum version 5.4.0)
This will sort the products in descending order depending on the date added.

· Product layout options (Minimum version 1.3.7)

In version 1.3.7 we have added the possibility for different layout formats for your products.

$productcolumns=2;

$useproductbodyformat=1;

$usesearchbodyformat=1;

$usedetailbodyformat=1;

$usecategoryformat=1;

$allproductsimage="";

Those who are upgrading from previous versions will need to add these parameters..

By setting useproductbody format to 2 like this
$useproductbodyformat=2;
the products are displayed with the product options, price and buy button below the product image. When useproductbodyformat is set to 1 the product options, price and buy button are displayed to the right of the product image.

The reason we added this second layout is that it lends itself well to having more than one column of products. So, when using
$useproductbodyformat=2;
the products will be displayed in the number of columns specified by productcolumns, such as

$productcolumns=2;

You can have as many as you like in theory, but just make sure they fit on your page.

Please note that with the useproductbodyformat set to 1 the productcolumns setting will be ignored.

To allow you to specify the search results independently of the general product display, you can set usesearchbodyformat to 1 or 2 in the same way.

There is also a second product detail format available now. Setting
$usedetailbodyformat=2;
will display the product detail page with the image to the left of the product description, price, quantity and buy button.

If you need the category text and description to the right of the image choose $usecategoryformat=2;

$usecategoryformat=3;
will show the image on top of the category name on top of the category description

$allproductsimage="";
allows you to specify an image for "All Products" and the path can be inserted here.

$useproductbodyformat=3; (Version 5.0.0 required)
This will be a "list" like layout, and you will be able to select the columns you wish to display by setting and customizing . . .
$cpdcolumns="id,image,name,description,discounts,listprice,price,priceinctax,instock,options,quantity,buy";
. . . and the column headers like for instance . . .
$cpdheaders="ID,Name,description,discounts,listprice,price,Inc. Tax,In Stock,Options,Quant, ";

For more information on the category, product and product detail display, please visit our layouts page.

· Continue shopping (Minimum version 3.6.6)

$actionaftercart=1;

...or not setting anything will mean that the continue shopping button will take the URL from the xxHomeURL from the vsadmin/inc/languagefile.php which is the current default.

$actionaftercart=2;

...will make the cart "continue shopping" button return to the page you just came from when you are on the cart contents page.

$actionaftercart=3;

...when you add something to your cart, you will refresh immediately back to the products page you came from without going to the cart contents page.

$actionaftercart=4; (Minimum version 4.9.9)

...will skip the page showing "The products have been added to your cart" when adding products to the cart.

$cartrefreshseconds=2; (Minimum version 5.1.2)

... can be used to control the number of seconds that the message "The items has been added to your cart" is shown. If set to zero this will perform an HTTP redirect rather than a refresh.

· Category layout (Minimum version 4.1.0)

$categorycolumns=1; - will give you a vertical list of categories in a single list

$categorycolumns=2; - will show the categories in two columns

$categorycolumns=3; - will show the categories in three columns

$catseparator=""; - is required to use the new category set up - no changes are necessary here

· DHTML menu (Minimum version 4.6.0)

You can now limit the number of "popout levels" that the DHTML pops out to by setting the parameter
$menupoplimit=2;
. . . where 2 in this example would limit to 2 popout levels.

· Product separation (Minimum version 5.1.0)

You can remove the horizontal line (and the space it takes up) between products with the addition of

$noproductseparator=TRUE;

If you want to add a custom separation between products then use this

$prodseparator="<p align=\"center\">........</p>";

· Product detail static page (Minimum version 5.1.0)

You can set the character of your choice that is used between the individual words of the product name which make up the product detail static page. For example if you want to separate the words with a hyphen then set
$urlfillerchar='-';
...to get a page name like this product-name.php

· Show thumbnail image in the shopping cart (Minimum version 5.4.0)

If you want to show a thumbnail image in the cart of the product a customer has purchased, add this to vsadmin/includes.php
$useimageincart=TRUE;

· Link the thumbnail image in the shopping cart (Minimum version 5.4.0)

If you want to link the thumbnail image in the cart to its product detail page, add this to vsadmin/includes.php
$linkcartproducts=TRUE;

· Multi-purchase columns (Minimum version 5.5.0)

If you are using the multi purchase feature, you can specify the number of columns for the quantity boxes with the following setting

$multipurchasecolumns=3;

Payment options

· Setting the path to your SSL (Minimum version 1.3.7)

If you are using a payment provider that requires SSL then what the system is going to look by default is your website URL on an HTTPS connection, ie https://www.yoursite.com/cart.php
If you have shared ssl space which requires a different url, or if you want to override the switch to SSL for testing purposes then you can override it like this:

$pathtossl = "https://www.yourhostssl.com/yourdir/";
. . . or . . .
$pathtossl = "http://www.yoursite.com/";
. . . to keep it on http and not go to https

· Disabling SSL (Minimum version 3.5.4)

Setting $nochecksslserver=TRUE;
will disable the checking with capture card and other payment systems that require an SSL server that check you are on an SSL connection.

IMPORTANT NOTE:
This should not be set unless you are most certainly sure that you are on HTTPS when viewing the credit card details. Our check for SSL can be fooled the way some servers set up their shared SSL certs so all this switch does is remove the warning in this case. It should NOT be used to enable yourself to view CC details on a non-SSL connection.

· Encryption method (Minimum version 4.5.1)

For those using Capture Card, the encryption method "mcrypt". You can set this by adding...

$encryptmethod="mcrypt";

It does require the mcrypt library 2.4 or above to be compiled with PHP so ask your host. You also need to set a "pass phrase" in the vsadmin/includes.php file. For instance...

$ccencryptkey = "adhdhdhe3sk39 add your own random text here and do not copy this";

Do make it unique (don't just copy the example above). Do add random text (not the random text above). Do make it at least 32 characters long (and not using the text above).

Please note that if someone manages to compromise your database AND your site so they gain access to your secret phrase, then it is possible that they can decrypt the credit card numbers. It is not a public / private key type algorithm. However it does add an important extra level of security.

You can also set the encryption cypher used by setting for instance...
$mcryptalg = MCRYPT_RIJNDAEL_128;
...in your includes.php page. A list of cyphers supported in PHP is available here...
http://www.php.net/manual/en/ref.mcrypt.php

· Dump credit card numbers (Minimum version 3.6.6)

$dumpccnumber=TRUE;

...this will dump the credit card numbers to the .csv file.

· Force form submission (Minimum version 4.1.3)

For payment processors where the credit card details are taken on an SSL connection on your site you can set the parameter:

$forcesubmit=TRUE;

...which will submit the form by default in 5 seconds. If you want to change that 5 second interval you can set

$forcesubmittimeout=5000;

where the time is set in milliseconds, so the above example would result in a 5 second delay.

· Authorize.net (Minimum version 4.5.0)

Add the parameter $secretword to encrypt your authorize.net merchant id and transaction key in the database for extra security. For example...
$secretword="this is my secret word";
Please note that if you set this, you will have to reset your merchant id and transaction key in your admin payment providers page for authorize.net

If you are using the authorize.net AIM system you can now set the parameter
$acceptecheck=true;
to allow for eChecks. You will need to have your authorize.net account set up for accepting eChecks.

Authorize.net AIM method can now be used with the WellsFargo SecureSource system using the setting
$wellsfargo=true;

· Authorize.net time adjust (Minimum version 4.8.2)

Setting $authnetadjust will adjust the authorize.net timestamp by the given number of seconds. For instance . . .
$authnetadjust=1320;

· Capture card order status (Minimum version 4.6.0)

You can set the order status of "Capture Card" orders by setting the following
$capturecardorderstatus=5;
. . . which in this case would set the order status of a capture card order to 5. To see the order status id numbers just look on your order status admin page.

· Force CVV credit card code on checkout (Minimum version 4.7.4)

For payment processors that are integrated into your own site, you can set
$requirecvv=TRUE;
. . . to force the customer to enter their CVV credit card code on checkout.

· PayPal PayFlow Pro (Minimum version 4.7.4 to 5.4.4)

By default it is assumed that payflow pro support has been compiled into PHP. If using the command line version of the pfpro module however, you can set the following . . .
$pathtopfpro = "/path/to/pfpro";
Those using the PHP version on a windows server can set . . .
$pathtopfpro=="COM";
. . . to use the PFProCOMControl COM Component.
You can also use . . .
$pathtopfprocert = "/path/to/certificate";
. . . to specify the directory to the payflow pro certificate.

PayPal PayFlow Pro (Minimum version 4.8.2 to 5.4.4)

Setting $pathtopfprolib can be set in the vsadmin/includes.php file to specify the location of the payflow pro libraries for Verisign.

· PayPal PayFlow Pro (Minimum version 5.4.4)

Replacing the SDK method for PayPal PayFlow Pro set...
$usenvpforpayflowpro=TRUE;
...in vsadmin/includes.php

· Force the checkout to use 2Checkout's v2 system (Minimum version 4.8.6)

Setting...
$use2checkoutv2=TRUE;
. . . in your vsadmin/includes.php file will force the checkout to use 2Checkout's v2 system.

Use 2Checkout's one page checkout (Minimum version 5.5.1)

Set...

$use2checkoutfastcheckout=TRUE;

. . . in your vsadmin/includes.php file to use the 2Checkout one page checkout.

· Force the PayPal locale (Minimum version 5.2.2)

To force the PayPal payment page locale to one of your choosing you could set...
$paypallc="FR";
...to force the default language / locale to French.

· Google Checkout order status (Minimum version 5.2.3)

You can change the delivered status that Google will set for a delivered order by setting the switch in vsadmin/includes.php...
$googledeliveredstate=5;
...to whatever you like.

· Google Checkout default shipping (Minimum version 5.3.1)

If for any reason Google can't connect to your site, or there is a lot of network traffic and the callback takes over 3 seconds, then Google will fail the callback. When we pass the cart to Google we are obliged to set a default shipping rate in case this happens and we set that to $999 so that it stands out and integration problems can be resolved. But you can override this default shipping rate if with the setting...
$googledefaultshipping=25.0;
... or to whatever you like.

Shipping and tax options

· Adding tax to shipping (Minimum version 3.5.9)

If you need to add tax to shipping you'll need to choose
$taxShipping=1;
if not leave it as it is:
$taxShipping=0;

Setting $taxShipping=2;
will add the shipping tax to the state and country tax totals.

If you need to add tax to handling you'll need to choose
$taxHandling=1;
if not leave it as it is:
$taxHandling=0;

Setting $taxHandling=2;
will add the handling tax to the state and country tax totals.

· Removing the shipping address (Minimum version 3.6.3)

Use:

$noshipaddress=TRUE;

to cause a shipping address entry section not to be shown on the checkout page if set.

· "Will pick up option" (Minimum version 4.1.0)

Use:

$willpickuptext="Will Pickup";

If you want to allow your customers the option of picking up their purchase from your physical location. The text here can be changed as necessary.

Use

$willpickupcost=1.32;

To set the cost of picking up from your location. Set to zero if there is no charge

· Show tax inclusive prices (Minimum version 3.1.2)

To show tax exclusive price followed by the inclusive price on the products page use
$showtaxinclusive=TRUE;
the wording for the tax can be changed in vsadmin/inc/languagefile.php.

From version 5.4 to only show tax inclusive price, set

$showtaxinclusive=2;

· UPS Options (Minimum version 3.5.0)

The way that you deliver your packages to UPS for delivery can affect the total cost of delivering the package. We have set the default as "Customer Counter", though you can change this by setting the following in your vsadmin/includes.php file . . .

$upspickuptype="03";

The code in quotes there would be taken from the following table...

01 - Daily Pickup
03 - Customer Counter
06 - One Time Pickup
07 - On Call Air
19 - Letter Center
20 - Air Service Center

Remember to enclose the code above in double quotes. Also, please note that these options are not exactly the same as you might find on the UPS web site but we hear that is something that UPS are working on...more information

The signature options available for UPS are...
$signatureoption="direct";
$signatureoption="indirect";
$signatureoption="adult";

To add UPS shipping insurance based on the product value, but not ask the customer...
$addshippinginsurance=1;

To ask the customer if they would like shipping insurance on the checkout form...
$addshippinginsurance=2;

· Commercial location (Minimum version 3.5.0)

Set $commercialloc=TRUE;
if you want to place a question and checkbox on checkout for shipping to a commercial location. This is automatically set for UPS but can be used for other shipping methods.

· Shipping insurance (Minimum version 3.6.6)

Shipping insurance can now be added to more shipping types than just UPS shipping. If using UPS shipping, then adding

$addshippinginsurance=1;

to your includes.asp file will calculate shipping costs with insurance. If using UPS shipping then add

$addshippinginsurance=2;

will ask the user if they would like shipping insurance, and if so add it to the shipping cost.

With shipping types other than UPS, you have to also set an amount, shipinsuranceamt
for instance...
$shipinsuranceamt=5;
If $addshippinginsurance=1; then in this example 5% of the product price total will be added to the shipping cost for insurance.
If $addshippinginsurance=2; then in this example 5% of the product price total will be added to the shipping cost for insurance IF the user checks the "yes I want shipping insurance" box on checkout.
If $addshippinginsurance=-1; then in this example 5.00 (of your monetary units, say Dollars) will be added to the shipping cost for insurance.
If $addshippinginsurance=-2; then in this example 5.00 (of your monetary units, say Dollars) will be added to the shipping cost for insurance IF the user checks the "yes I want shipping insurance" box on checkout.

For Canada Post you have to set insurance in your Canada Post shipping profile.

For USPS add the following (Minimum version 5.4.3)

$useuspsinsurancerates=TRUE;

in conjunction with $addshippinginsurance=1; or $addshippinginsurance=2; from above.

· Invoices / packing slips (Minimum version 3.6.6)

$invoiceheader='<img src="images/logo.gif" border="0"><br><br>';

...this will print your logo at the top of the invoice. Obviously you will need to upload the logo to your images folder and set the path / name correctly.

$invoiceaddress='<br><b>My Company LLC</b><br>10, My Road<br>My Town, MyCity 90210<br>USA<br><br>';

... this will print your address on the invoice. As you can see it is possible to use HTML for formatting.

$invoicefooter='<br><br><font size="1">Thank you for shopping with EcommerceTemplates.com</font>';

..will print the footer information you need to include. Again HTML can be used for formatting.

· Packing slip headers and footers (Minimum version 5.3.0)

These settings are available for packing slips, mirroring the invoice versions to provide separate headers for the packing slip. HTML can be used as in the invoice examples above.

$packingslipaddress="packing slip address";
$packingslipheader="packing slip header";
$packingslipfooter="packing slip footer";

· Canadian Tax (Minimum version 4.3.0)

Support for the Canadian PST / GST / HST tax system, including the Price Edward Island and Quebec systems of adding the provincial tax to the product total + government tax. To use this feature you would need to download the current Canadian plug-in and also set the parameter...
$canadataxsystem=true;

· Per payment provider handling charge (Minimum version 4.3.0)

You can set a "per payment provider" handling charge. On the payment providers admin page, each payment provider shows a unique id. You would use the text $handlingcharge + the unique id to assign the charge. Say for instance if you wanted to add a $2.35 charge to the "2Checkout" payment provider, then if you look on the payment providers admin page you will see the ID for 2Checkout is 2, so you would set the following...
$handlingcharge2=2.35;

If you need to add tax to handling you'll need to choose
$taxHandling=1;
if not leave it as it is:
$taxHandling=0;

Setting $taxHandling=2;
will add the handling tax to the state and country tax totals.

Add a handling charge per payment provider which is a percentage of the cart total + shipping + handling. For instance you could set .
$handlingchargepercent4=5;
. . . to add a 5% handling charge to "Email" payments. Taxes are not counted in this total as the handling charge can also qualify for taxes. (Minimum version 5.0.0)

· Split heavy packages (Minimum version 4.5.0)

Adding the parameter $splitpackat when using UPS or USPS shipping will split heavy packages into multiple packages. For instance...
$splitpackat=70;

· Canada Post (Minimum version 4.6.0)

To place Canada Post in test mode on the testing server, please use the following parameter
$canadaposttest=TRUE;

· Per product tax rate (Minimum version 4.8.0)

To set a tax rate per product add this and a tax rate box will appear in the product admin page...
$perproducttaxrate=TRUE;

· Shipping estimator (Minimum version 4.9.0)

To place a shipping estimator on the cart page before checkout use
$estimateshipping=TRUE;
There is also this parameter you can set if you are using a shipping method like weight based or price based shipping where the ship state is necessary . . .
$defaultshipstate="California";
Please note, this is not necessary for UPS / USPS / Canada Post shipping as it is the zip / postal code that is used.

This switch is available to not set a default zip (postal) code for the shipping estimator (Minimum Version 5.0.0). . .
$nodefaultzip=TRUE;

· Shipping carrier switch (Minimum version 4.9.0)

If you need the ability to allow the customer to switch between different shipping carriers at checkout you can enable this with . . .
$alternateratesups="UPS Rates";
$alternateratesusps="USPS Rates";
$alternateratesweightbased="Weight Based";
$alternateratescanadapost="Canada Post";
$alternateratesfedex="FedEx Rates";
Please note, the above text can be anything you like and will be included in the shipping selector dropdown from which your customers can choose the shipping type.

· Combine shipping and handling (Minimum version 5.0.0)

Shipping and handling can be combined with the switch . . .
$combineshippinghandling=TRUE;

· Default shipping tracking (Minimum version 5.1.2)

This allows selection of the default shipping carrier on the tracking page. The choices are "ups", "usps" and "fedex". For instance...
$defaulttrackingcarrier="usps";

· Removing FedEx discounted rates (Minimum version 5.2.1)

If you receive discount rates from FedEx, this setting will give the customer the full default rate
$uselistshippingrates=TRUE;

· FedEx delivery options

These services are available for FedEx shipping
$saturdaydelivery=true;
Presents customer with Saturday Delivery option
$saturdaypickup=true;
Calculates Rates based on a Saturday Pickup
$packaging="25kgbox";
envelope, pak, box, tube, 10kgbox, 25kgbox
$codpaymentprovider=4;
Declares which payment option is used for Cash On Delivery
$signatureoption="none";
none indirect direct adult
$allowsignaturerelease=TRUE;
Allows customer to select Signature Release as an option
$insidepickup=TRUE;
Calculates rates based on an inside pickup (freight only)

NOTE
The C.O.D. / Saturday Delivery / Signature (direct, adult) / Packaging switches will also work with UPS.

Display options

· Product page display numbers (Minimum version 1.3.7)

To display the product page number links at the top of the page as well as the bottom set
$pagebarattop=1;

· Removing buy and checkout buttons (Minimum version 2.0.0)

You can simply eliminate the buy and checkout buttons as well as the price for all products, this is done by choosing
$nobuyorcheckout=TRUE;
and
$noprice=TRUE;

· Remove top navigation (Minimum version 3.5.0)

If you need to remove the top navigation ie. home >> category >> product then set
$showcategories=FALSE;

· Terms and Conditions (Minimum version 3.6.0)

If you need to make your customers agree to your terms and conditions on checkout, set $termsandconditions=TRUE;
You will also need to create a page with your terms and conditions called termsandconditions.php ... which will be shown in a 420 x 380 popup.

· Quantity boxes (Minimum version 3.6.1)

Setting the following to TRUE will put up a quantity box on the products and the product details page (not available if using usedetailbodyformat=2):

$showquantonproduct=FALSE;
$showquantondetail=FALSE;

· Zero price (Minimum version 3.6.3)

If you set this, for instance...

$pricezeromessage="<b>Price: Please call</b>";

...then in the case where a price is set to zero, this message will be printed instead. If the pricezeromessage is not set then products with a zero price will be displayed as Price: $0.00 as usual.

· Show product id (Minimum version 3.6.3)

$showproductid=TRUE;

...will cause the product id to display on the product pages. The text "Product ID" is from the vsadmin/inc/languagefile.php as xxPrId

· Hide product options (Minimum version 3.6.4)

$noproductoptions=TRUE;

...this will hide all the product options on the products page.

· Extra checkout fields (Minimum version 4.1.0)

It is possible to add two new fields to your cart checkout page. The extraorderfield1 will go at the top of the billing and shipping form and the extraordefield2 at the bottom of the billing and shipping form.

$extraorderfield1="Company Name"; - adds a company name field to the top of your cart checkout page, text can be edited here for other uses.

$extraorderfield1required=TRUE; - will make this field obligatory, setting to false will make it optional

$extraorderfield2="Another Field"; - will add an additional field to the bottom of the cart checkout page, obviously the text will need editing here.

$extraorderfield2required=TRUE; - will make this field obligatory, setting to false will make it optional

· Extra checkout fields (Minimum version 5.3.0)

There are 2 new "checkout" parameters which will appear in the "Miscellaneous" section, following the additional information field. You can use these in the following way...

$extracheckoutfield1="Checkout Field";
$extracheckoutfield2="2nd Checkout Field";

To make these required use...

$extracheckoutfield1required=TRUE;

There is also a parameter to switch the control and the text which can be useful if you are using a checkbox or similar small control. To do that just add...

$extracheckoutfield1reverse=TRUE;

To specify custom HTML for these just use something like this for example...

$extracheckoutfield1html="<input type=\"checkbox\" name=\"ordcheckoutextra1\" value=\"Yes\">";

$extracheckoutfield1html="<select name=\"ordcheckoutextra1\" size=\"1\"><option value=\"No\">No</option><option value=\"Yes\">Yes</option></select>";

· Extra address line on checkout (Minimum version 4.9.0)
To enable the use of an "Address Line 2" entry on the checkout form, use the following switch...
$useaddressline2=TRUE;

· Extra shipping field on checkout (Versions 5.0.0 to 5.2.6 only)
To enable the use of an extra shipping field on checkout use the following switch...
$extraorderfield3 = "Extra Ship Field";

· Forcing minimum purchase amount (Minimum version 4.3.0)

Setting the parameter $minpurchaseamount will force a minimum purchase amount. You can also set the parameter $minpurchasemessage to display a message / html if the minimum purchase amount is not met. For instance...
$minpurchaseamount=4.99;
$minpurchasemessage="I'm sorry, we have a minimum purchase amount of £4.99. Please go back and <b>buy some more</b>";

· Alternative currency format (Minimum version 4.7.0)

You can now have total control over the display of the currency conversions if you require. For instance use the following. . .

$currFormat1="<b>€</b>%s";
$currFormat2="<b>£</b>%s";
$currFormat3="<b>\$</b>%s";

In each of these %s is replaced by the actual currency value. Be careful that the symbols match the currencies you have chosen on your admin main page. Of course you can place any formatting or text here.

NOTE
The dollar sign is a special character in PHP so would need to be escaped as in the example above, \$

· Product detail link (Minimum version 4.7.0)

Instead of having the product “details” link leading to the proddetail.php page, you can specify your own link by adding the following (for example) to your vsadmin/includes.php file.

$detailslink="<a href=\"%largeimage%\" target=\"_blank\">";
$detailsendlink="</a>";

Any instances of %pid% will be replaced by the product id and any instances of %largeimage% will be replaced by the the value of you have set for large image in your admin products page. This will allow you to vary the links per product.

· Hide product option price difference (Minimum version 4.7.0)

By setting the switch . . .
$hideoptpricediffs=true;
. . . you can hide the price difference in the product option drop down menus and the checkout page. Only the total price will be shown.

· Remove category id from Product Detail page (Minimum version 4.9.2)

Set the following switch . . .
$nocatid=TRUE;
if you don't want the category id added to the product detail page links . . .

· Showing stock totals / out of stock products on the products page (Minimum version 5.0.0)

Set the following switch . . .
$showinstock=TRUE;
to show the number of items in stock on your products page

Use
$noshowoutofstock=TRUE;
if you don't want out of stock items to appear on your products page

· Optional zip (postal) code on checkout (Minimum version 5.0.0)

This will make the zip code an optional item on the checkout page.
$zipoptional=TRUE;

· Cross selling (Minimum version 5.1.0)

This addition will show the cross selling features you want to display below the cart:

$crosssellaction='recommended,related,alsobought,bestsellers';

These options are also used depending on what information you would like to display there

$csnobuyorcheckout=TRUE;
...will remove the buy and checkout buttons
$csnoproductoptions=TRUE;
...will remove the product options
$csnoshowdiscounts=TRUE;
...will remove the discounts text

If you want to change the text that introduces the cross selling features then add these to includes.asp

$csrecommendedtitle='Your recommended title';
$csalsoboughttitle='Your also bought title';
$csrelatedtitle='Your related title';
$csbestsellerstitle='Your best seller title';

If you want to limit the number of products that are shown then you can add this to includes.php

$crosssellcolumns=2;
$crosssellrows=1;

This will give you two columns and 1 row of products, effectively a maximum of 2 products showing.

Full set up details can be found on the cross selling help page.

· Force product detail link (Minimum version 5.1.0)

Adding....

$forcedetailslink=TRUE;

...to includes.php will force a link to the corresponding product detail page even if there is no long description added through the product admin page.

· Setting the limit of text in the short product description (Minimum version 5.1.0)

If you want to limit the number of characters used on the products page for the product description then use this setting...

$shortdescriptionlimit=100;

...where 100 is the number of characters that will be shown on the products page. This means that you can use the same description in both the long and short descriptions but the short description will be truncated at that point.

· Remove the "remember me" box from checkout (Minimum version 5.3.0)

If you want to remove the Remember Me feature from the checkout page then add this to vsadmin/includes.php...

$noremember=TRUE;

· Show the SKU on the product and detail pages (Minimum version 5.4.0)

If you want to show the SKU in the products and product detail pages then add this to vsadmin/includes.php...

$showproductsku="ISBN";

...you will need to add the SKU to the product admin page.

· Show the manufacturers on the search page (Minimum version 5.4.0)

To show a drop down and allow customers to refine the search by manufacturer, use this setting...

$searchbymanufacturer="Manufacturer";

...you will need to define the manufacturers in the manufacturer admin page and select them from the product admin page.

· Show the manufacturers on the products page (Minimum version 5.5.0)

To show the manufacturer field on the products page, add

$manufacturerfield="Manufacturer";

· Remove options showing in cart using product alt id (Minimum version 5.5.2)

For options with an alternate product id not to be added to the cart set the following...

$noaddalternateoptions=TRUE;

Affiliate options

· Affiliates cookie (Minimum version 2.0.0)

By default the affiliate cookie stays active for 30 days, this means that if somebody clicks on an affiliate link and then comes back later to purchase as long as it's within 30 days, the sales will be accredited to the affiliate partner. If you need to change this then the value here
$expireaffiliate=30;
will have to be modified.

· Affiliates commission (Minimum version 4.5.0)

You can now set an affiliate percentage in the affiliates admin, and set a
$defaultcommission=12;
to set a default commission for new affiliates

Discount options

· Remove discount / coupon feature (Minimum version 3.0.0)

To remove the discount and coupon function choose
$nogiftcertificate=TRUE;

· Hide discount or coupon text (Minimum version 4.1.0)

To remove the discount and coupon text that appears on category and product pages
$noshowdiscounts=TRUE;

Customer login

· Enable customer login (Minimum version 4.2.0)

To enable the customer login box you will need to add the line (if it's not already present)
$enableclientlogin=true;

· Wholesale pricing (Minimum version 4.6.0)

Wholesale prices can be set for product options. To do this add the parameter
$wholesaleoptionpricediff=TRUE;

You can disable discounts for logged in customers with the wholesale attribute by adding the parameter
$nowholesalediscounts=TRUE;

You can set a separate minimum wholesale purchase amount and message by setting the following
$minwholesaleamount=23.00;
$minwholesalemessage="Your message";

· Client login forwarding page (Minimum version 4.8.0)

You can set per login level forwarding pages for the client login system or send the logged in client back to the referring page. To set the forwarding page for all pages you can set for instance . . .
$clientloginref="yourpage.php";
Or to use the "referring" page set . . .
$clientloginref="referer";
Or optionally you can set . . .
$clientloginref2="otherpage.php";
. . . to set say a forwarding page for only those logged in with login level 2.

· Force customer login (Minimum version 5.3.0)

To force customers to create an account before checking out

$forceclientlogin=true;

· Self register (Minimum version 5.3.0)

To enable customers / clients to self register

$allowclientregistration=true;

· Remove login prompt (Minimum version 5.3.0)

If you need to remove the prompt on cart.php to login then add this to your vsadmin/includes.php file...

$noclientloginprompt=TRUE;

· Customer login link (Minimum version 5.5.0)

To provide a link to the customer account in the login minibox, add the following

$customeraccounturl="clientlogin.php";

Admin tweaks

· Currency formats (Minimum version 3.1.2)

Normally the currency is automatically set by your country settings, but sometimes servers don't seem to have locales installed, and some have special needs. These are the parameters available:

$overridecurrency=TRUE;
- Switches the currency overriding on

$orcsymbol="US\$";
- The currency symbol used on product pages.

$orcemailsymbol="US\$";
- The currency symbol used in emails. Normally the same, but can be handy if you wish to set your product page currency symbol to an HTML code like € or ¥ and then in the email set it to EURO or YEN

$orcdecplaces=2;
- How many decimal places your currency has.

$orcdecimals=".";
- The symbol used for the decimal separator. Normally a "." but can be ","

$orcthousands=",";
- The symbol used for the thousands separator. Normally a "," but can be a "."

$orcpreamount=FALSE;
- If you want to display the currency symbol before or after the amount.

$orcurrencyisosymbol="USD";
- If you need to force the settlement in US Dollars even if you are selling from another country.

Please note, the dollar sign ($) is a special character in PHP and so must be preceeded with a slash, as in "US\$"

· Adjust date (Minimum version 3.6.6)

$dateadjust=3;

...would adjust the date the order status was updated by 3 hours.

$dateadjust=-4;

...would adjust it by minus 4 hours. This is so that if your server time is not the same as your local time then you can adjust for this.

$dateformatstr = "d/m/Y";

...would show the European date format of day / month / year for packing slips

$dateformatstr = "dS F Y";

..would show the date in the format for example 25th May 2004 20:17

· Admin date (Minimum version 4.6.3)
To set dates in your admin section to US style format (for instance mm/dd/yyyy), set the following
$admindateformat=1;

To set dates in your admin section to UK style format (for instance dd/mm/yyyy), set the following
$admindateformat=2;

· cURL (Minimum version 4.3.0)

An alternative is provided for those that don't have cURL compiled into PHP, but where the host provides cURL on the command line and you typically receive an error about curl_init() being undefined. To use this feature you need to set the path to the cURL binary on your server in the parameter $pathtocurl. For instance...
$pathtocurl="/usr/local/curl";

· cURL for Godaddy hosting (Minimum version 4.8.9b)

These two parameters are used mainly with GoDaddy hosting where they have disabled the PHP "fsockopen" functions. These are . . .
$usecurlforfsock=TRUE;
. . . which will use the cURL functions instead and . . .
$curlproxy="http://64.202.165.130:3128";
. . . which will set the cURL proxy server to that specified.

If using Wild West Domains through Godaddy then that would be

$usecurlforfsock=TRUE;
$curlproxy="http://proxy.shr.secureserver.net:3128";

· Admin product sort

If you need to list the products in the admin page by product id rather than product name then add this to includes.php

$adminsortorder="pID";

· Character sets (Minimum version 4.7.0)

Greater support is now given for “Wide” Character sets such as Japanese and Chinese. You can set the following 2 switches . . .

$emailencoding="shift_jis";
$adminencoding="shift_jis";

. . . changing “shift_jis” for the actual character encoding used in your emails and admin section pages.

· Multiple languages (Minimum version 4.8.0)

If you need to have more than one language then set:
$languageid=2;
to indicate which language is being used for that particular admin section.

· IP Blocking (Minimum version 4.8.0)

To limit the number of transactions in a 24 hour period per IP set:
$blockmultipurchase=10;
...where 10 here is the maximum number of purchases by that particular IP address in 24 hours.

· Second store URL (Minimum version 4.8.0)

If you need to set up a second store on the same server but for a different domain then use the setting
$orstoreurl="http://www.mysecondsite.com";
in includes.php. This will override the Home URL in the main admin settings.

· Admin login (Minimum version 4.9.0)

To receive notification of when somebody tries to enter your admin section set:
$notifyloginattempt=TRUE;

To disable the login to your admin section set:
$disallowlogin=TRUE;
This means that you can disable the vsadmin directory and create a copy in a directory with your choice of name that hackers will never know exists.

· Our ESolutions Quickbooks Integration Utility (Minimum version 5.0.0)

You can use the following switch . . .
$ouresolutionsxml=1;
. . . to the vsadmin/includes.php file to add a menu item on the admin orders page to dump order details in a format compatible with the Our ESolutions Quickbooks integration utility. These are the available options
1 is the product id and product description
2 is the product name and product description
3 is just the product id
4 is just the product name
5 is the product id and the product name

· TinyMCE product admin HTML editor (Minimum version 5.1.0)

If you want the built in HTML editor for your product admin page then add this to includes.php . . .
$htmleditor="tinymce";
You will need to download the Tinymce files separately from our free downloads page and upload them as per the instructions there.

If you want the styles to be available from your stylesheet then add
$htmleditorstyle='/style.css';

· FCKeditor product admin HTML editor (Minimum version 5.5.0)

If you want the built in FCKeditor HTML editor for your product admin page then add this to includes.php . . .

$htmleditor="fckeditor";

You will need to download the FCKeditor files separately from our free downloads page and upload them as per the instructions there.

· State abbreviations (Minimum version 5.1.0)

Add...

$usestateabbrev=TRUE;

to use state abbreviations rather than state names.

· Static page redirection (Minimum version 5.3.0)

If you are using static pages, an attempt to locate the page on the old dynamic URL will result in an HTTP "301 Moved Permanently" and a redirect to the static page. To enable this feature use the following setting in your vsadmin/includes.php file...

$redirecttostatic=TRUE;

Please note, to use this you must have output buffering on the products.php and categories.php pages. To do this, simply open these pages in HTML view and right at the top add this line
ob_start();
right after the line
session_start();

Image tweaks

· Changing default buttons to images (Minimum version 5.5.0)

If you would like to use your own images instead of the browser generated buttons for Continue Shopping, Update Totals, Delete, Printable Version, Configure Options and Buy the add the following to vsadmin/includes.php

$imgcontinueshopping="images/imgcontshop.gif";
$imgupdatetotals="images/imgupdtots.gif";
$imgdelete="images/imgdelete.gif";
$imgprintversion="images/imgprintable.gif";
$imgconfigoptions="images/imgconfopts.gif";
$imgbuybutton="images/buy.gif";

For the checkout button you can use an image with this addition

$imgcheckoutbutton="images/othercheckoutimage.gif";

or if you want a button then use

$imgcheckoutbutton="button";

You will need to upload your own images to the main images folder on your store.

· Giant image properties (Minimum version 5.5.0)

If you are using the giant image linked from the product detail page then to have it appear in a pop-up window, use the following

$giantimageinpopup=TRUE;

To set the height and width of the pop-up window, use

$giantimagepopupwidth=450;
$giantimagepopupheight=600;

If you prefer not to have a pop-up window and have the image open on a separate page then set

$giantimageinpopup=FALSE;

· Default product and category image folder (Minimum version 5.5.0)

The default folder for product images is /prodimages/ but this can be changed for the location of the product images with this addition

$defaultprodimages = 'newimagefolder/';

... and this one for category images which has a default of /images/

$defaultcatimages = 'newcatimagefolder/';

Customer reviews

· Enable customer reviews and ratings (Minimum version 5.5.0)

If you would like your customers to rate and review your products, add this line to vsadmin/includes.php

$enablecustomerratings=TRUE;

· Restrict customer reviews to logged in customers only (Minimum version 5.5.0)

If you only want logged in customers to be able to add a rating and / or review then set

$onlyclientratings=TRUE;

· Customer review display options (Minimum version 5.5.0)

You can set the maximum number of reviews and ratings you want to appear on the product detail page with the following addition

$numcustomerratings=6;

To set the number of reviews per page on the all reviews page(s)

$allreviewspagesize=30;

· Limit the number of reviews submitted per day (Minimum version 5.5.0)

If you want to limit the number of reviews submitted in a 24 hour period then set the following

$dailyratinglimit=10;