Knowledgebase
Calculator HTML Values Reference Guide
21 Sep 06 01:39 PM

AuctionInc's shipping calculator provides a very flexible and easy way to determine shipping charges for your items. The information necessary for calculating the shipping is embedded in the HTML that is generated by the Calculator HTML Wizard. You will, in turn, embed the Calculator HTML with the rest of your HTML for each of your items. 

The HTML generated from the Calculator HTML Wizard contains various shipping settings which are hidden when viewed by a browser. These settings determine the specifics of identifying you, your item, and how the calculator should determine shipping charges for your item.

The HTML for the each of your items will contain some or all of the fields shown in the example below. (The figures in the Value settings will be replaced by the specific values for your item.)  Form fields which are specifically for either our ShopCart product or our ShipCalc product are identified, as are form fields that are specially for either carrier-rated or fixed fee shipping.  For some of these fields, you should feel free to directly edit previously-generated HTML as you list various items; however, some form fields, such as Carrier Special Services and especially Item Attributes (Paid ShipCart product) are best generated directly from our HTML Wizard for each of your item.

HTML Example:

[PAID SHOPCART ONLY:]
<FORM ACTION="http://cart.auctioninc.com/" ENCTYPE="application/x-www-form-urlencoded" METHOD="post">
<INPUT TYPE="hidden" NAME="cmd" VALUE="_cart">

[PAID SHIPCALC ONLY:]
<FORM ACTION="http://calc.auctioninc.com/" ENCTYPE="application/x-www-form-urlencoded" METHOD="post">
<INPUT TYPE="hidden" NAME="cmd" VALUE="_calc">

[BOTH PRODUCTS:]
<INPUT TYPE="hidden" NAME="business" VALUE="342">
<!-- Item Information -->
<INPUT TYPE="hidden" NAME="item_name" VALUE="Willy Mays Photo">
<INPUT TYPE="hidden" NAME="item_number" VALUE="A-2365">
<INPUT TYPE="hidden" NAME="amount" VALUE="135">
<INPUT TYPE="hidden" NAME="quantity" VALUE="1">
<INPUT TYPE="hidden" NAME="taxable" VALUE="1">
<INPUT TYPE="hidden" NAME="undefined_quantity" VALUE="0">

[FIELDS FOR CARRIER RATED ITEMS ONLY:]
<!-- Shipping Information -->
<INPUT TYPE="hidden" NAME="calc_method" VALUE="C" >
<INPUT TYPE="hidden" NAME="lot_size" VALUE="1">
<INPUT TYPE="hidden" NAME="weight_lbs" VALUE="1">
<INPUT TYPE="hidden" NAME="weight_oz" VALUE="0">
<INPUT TYPE="hidden" NAME="length" VALUE="3">
<INPUT TYPE="hidden" NAME="width" VALUE="2">
<INPUT TYPE="hidden" NAME="height" VALUE="5">
<INPUT TYPE="hidden" NAME="package" VALUE="T">
<INPUT TYPE="hidden" NAME="insure" VALUE="1">
<INPUT TYPE="hidden" NAME="supp_handling_code" VALUE="PHOTOS">
<INPUT TYPE="hidden" NAME="supp_handling_fee" VALUE="3.50">
<INPUT TYPE="hidden" NAME="on_demand_services" VALUE="USPBPM,USPMM">

<!-- Carrier Special Services -->
<INPUT TYPE="hidden" NAME="addl_handling_ups" VALUE="1">
<INPUT TYPE="hidden" NAME="addl_handling_fdx" VALUE="1">
<INPUT TYPE="hidden" NAME="addl_handling_dhl" VALUE="1">
<INPUT TYPE="hidden" NAME="hazardous_ups" VALUE="1">
<INPUT TYPE="hidden" NAME="hazardous_fdx" VALUE="1">
<INPUT TYPE="hidden" NAME="hazardous_dhl" VALUE="1">
<INPUT TYPE="hidden" NAME="pod_ups" VALUE="1">
<INPUT TYPE="hidden" NAME="pod_usp" VALUE="1">
<INPUT TYPE="hidden" NAME="pod_fdx" VALUE="1">
<INPUT TYPE="hidden" NAME="pod_dhl" VALUE="1">
<INPUT TYPE="hidden" NAME="hazardous_usp" VALUE="1">
<INPUT TYPE="hidden" NAME="usp_delivery" VALUE="1">
<INPUT TYPE="hidden" NAME="usp_certified" VALUE="1">
<INPUT TYPE="hidden" NAME="usp_registered" VALUE="1">
<INPUT TYPE="hidden" NAME="usp_return" VALUE="1">
<INPUT TYPE="hidden" NAME="usp_return_merch" VALUE="1">
<INPUT TYPE="hidden" NAME="usp_restrict" VALUE="1">
<INPUT TYPE="hidden" NAME="sig_ups" VALUE="1">
<INPUT TYPE="hidden" NAME="sig_fdx" VALUE="1">
<INPUT TYPE="hidden" NAME="sig_dhl" VALUE="1">
<INPUT TYPE="hidden" NAME="sig_usp" VALUE="1">

[FIELDS FOR FIXED FEE ITEMS ONLY:]
(use either code field or fee fields, not both)
<!-- Shipping Information -->
<INPUT TYPE="hidden" NAME="calc_method" VALUE="F">
<INPUT TYPE="hidden" NAME="fixed_fee_code" VALUE="BOOK">
<INPUT TYPE="hidden" NAME="fixed_fee_1" VALUE="3.00">
<INPUT TYPE="hidden" NAME="fixed_fee_2" VALUE="1.00">

[PAID SHOPCART ONLY:]
<!-- Item Attributes -->
<INPUT TYPE="hidden" NAME="on0" VALUE="Size">
<INPUT TYPE="radio" NAME="os0" VALUE="large||P:5,WO:3,L:12,W:12,H:10" CHECKED> large
<INPUT TYPE="radio" NAME="os0" VALUE="Small"> Small

[PAID SHOPCART ONLY:]
<!--Add to Cart Button -->
<INPUT TYPE="submit" NAME="_cart_btn" VALUE="Add to Cart">

[PAID SHIPCALC ONLY:]
<!-- Add To Calculator Button -->
<INPUT TYPE="submit" NAME="calc_btn" VALUE="Add To Calculator">

[OPTIONAL FIELDS]
(BOTH PRODUCTS)
<INPUT TYPE="hidden" NAME="allow_decimal_qty" VALUE="1">
<INPUT TYPE="hidden" NAME="quantity_uom" VALUE="yards">

[BOTH PRODUCTS:]
</FORM>

The settings are stored in a format known as HTML HIDDEN FORM variables. In order to change the settings you must locate the appropriate property, which is indicated by the NAME="property name" (e.g. INPUT TYPE=hidden NAME="length" VALUE="12"). You can edit the setting by changing the text located within the quotes (") after the VALUE=. Please make certain not to remove the quotes since improperly quoted text can prevent the calculator from working.

The calc_method property identifies which calculation method the shipping calculator should use. The calculator uses the properties found in the Carrier Rate or Fixed Fee sections to determine the shipping rate.  When this setting is set to "C", the shipping calculation will be based on weight (and possibly additional item properties) and customer address and rated for each shipping service you are using. When this setting is set to "F", the calculator will instead base the shipping cost on the fixed fee you indicate.

HTML PROPERTY REFERENCE CHART:

 

Property NameDescriptionValuesModifiable


General Information

FORM tag
The values in the form tag determine the submission characteristics when the form is submitted and should not be modified.  Be sure both the open (<Form....) and the closing (</form> tag are included. If the "target" value is present, it controls the cart/calc opening in a new window.product specificno
cmdInternal tag used by AuctionInc.product specificno
businessThis value identifies your AuctionInc account.numberno
calc_methodThis critical value determines whether the shipping calculator uses carrier rates or fixed fee rates for this item. Depending on how it is set, the appropriate form values for the selected method must be included.  The options are' C' (calculated shipping), 'F' (Fixed Fee shipping), or 'N' (No Charge).  The 'N' value can be used if your product is a service (and doesnt ship) or simply to offer free shipping on your item.
C
F
N
yes
SUBMIT tagName of the button which submits to the calculator or the cart.  (If you have selected for the cart/calc to open in a popup window, there will also be some javascript which controls this in this tag.)product specific
yes


Item Information

item_nameName of your itemitem specificyes
item_numberUnique value that identifies your itemitem specificyes
amountPrice of your itemitem specificyes
quantityQuantity of the item that is for sale.  You can indicate whether or not your customer can modify this value numberyes
taxableIndicates if the item should be taxed when shipped into a state that you have added to your tax settings.yes
no
yes
undefined_quantityIndicates if the item quantity you selected is editable by the user in the cart.  If the value = 1,  the quantity is editable.0
(disabled)
1
(enabled)
yes


Shipping Information: Carrier Rated Items

The following properties are used when the calc_method property is set to C)arrier Rate
lot sizeNumber of units in your item (default 1). Your weight and dimensions should be for one lot.numberyes
weight_lbsIndicates the weight of the item in pounds. You may enter the pounds and ounces values separately or enter the pound including decimals (e.g. 1.25 lbs).numberyes
weight_ozIndicates the weight of the item in ounces. Ounces may be used in conjuction with pounds or entered alone. numberyes
lengthMeasurement of the length of the item in inches rounded up to the nearest inch. As a rule of thumb, dimensions should be entered for items when any of the measurements exceed 16" since package size may increase the shipping cost. The shipping calculator will account for oversized packages as long as you specify the dimensions. Please consult the carrier specification for additional information on package dimensions. (optional)numberyes
widthMeasurement of the width of the item in inches rounded up to the nearest inch (optional)numberyes
heightHeight of the item in inches (optional)numberyes
packageWhen there are multiple items in a shipment, this setting determines if shipping calculations will be based on shipping the items packaged T)ogether or S)eparately. When items are indicated as S)eparate then the calculator will rate the item as an individual package based solely on its weight and dimensions. When the items are identified to be shipped T)ogether, they are grouped together, combining their weights, packaging weight is added (calculated according to your packaging factors) and then the shipping rate is calculated.T
S
yes
insureIndicates if the item should be insured, in accordance with your configuration settings and insurance threshold.yes
no
yes
supp_handling_codeAdditonal handling fee for this item (based on a predefined code) (optional)code
supp_handling_feeAdditional handling fee for this item (no code necessary) (optional)numberyes
on_demand_servicesEach service listed (in a string of service codes seperated by commas) enables that service for this item only. You must have configured the service as "on-demand" to use it here. (optional)comma-delimited textyes
carrier special servicesThere may be one or more form variables for this category of values. Each form variable defines one type of special service for one carrier. You should use the HTML Wizard to generate the correct form variables for these. If you always use the same special services, you can just generate the html once; however, if you need to add a special service for a particular item, use the Wizard to generate the HTML for it.(optional)1
(enabled)

0
(disabled)
yes


Shipping Information: Fixed Fee Items

The following properties are used when the calc_method property is set to F)ixed Fee.
(Use either a fixed fee code or fixed fee amounts, but not both.)
fixed_fee_codePredefined code that maps to various fixed fees per carrier service or geographic location. codeyes
fixed_fee_1When using Fixed Fee shipping, this is the shipping cost that will be charged for this item. If a fixed fee item is combined in a shipment with other fixed fee shipping items, the highest fixed_fee_1 value is used for the first item and the remaining items will use the cost indicated in fixed_fee_2 numberyes
fixed_fee_2Used to indicate the fixed fee shipping cost to include when this item is combined with other items. numberyes


Item Attributes (Paid ShopCart only)

variousItem attributes are used to add specific optional characteristics to your item. The resulting form properties and values are complex and should not be directly edited.  Use the HTML Wizard to generate these values.
variousno


Optional Values (Both Products)

allow_decimal_qtyThis form field, which is not generated from the HTML Wizard, allows a decimal quantity to be calculated and (for ShopCart) sent to Paypal. Since Paypal normally does not accept decimal quantities, the presence of this form field notifies us to pass over the correct price and shipping to Paypal but reset the quantity to 1 so Paypal will accept it.  In short, it allows your customers to use decimal quantites in your Cart and bypasses Paypal's restriction on this.
1
 (enabled) 
0
(disabled)
yes
quantity_uomThis form field, which is not generated from the HTML Wizard, will add text to the cart item (based on the value of the field) which describes.the unit of measurement (ie, yards, gallons) in which you are selling this item. It is normally used in conjunction whith allow_decimal_qty described above.
unit of measureyes

(332 vote(s))
Helpful
Not helpful

Comments (0)