Master Command Reference
Items in italics indicate user-specified data.
"xxx" indicates values that you specify according to the product.
"..." indicates areas where more information is typically supplied.
Referencing the engine directly from a URL:
Clickable text message such as "Add xxxx to basket" or <IMG SRC="...">
Referencing the engine from inside a <FORM ...> HTML structure:
<FORM METHOD="post" ACTION="http://order.icorp.net/mpr/mo">
<INPUT TYPE="hidden" NAME="c_VendorID" VALUE="1">
<INPUT TYPE="hidden" NAME="function" VALUE="function">
<INPUT TYPE="hidden" NAME="fieldname" VALUE="xxx">
... (other FORM fields, including SUBMIT button code)
Every call to the Engine must include the Vendor ID code. This tells the Engine which
configuration file to use, which in turn, determines the behavior of the ordering system.
If you do not specify a Vendor ID, or specify an invalid Vendor ID, the system will
generate an error message and not function properly.
In the above examples, replace xxx with the Vendor ID which ICorp assigns to you. For example, if your company name is "Bob Incorporated", your Vendor ID might be "bobinc", and it would be specified as: c_bobinc
Every call to the Engine must have a function specified. In a URL, the function should be the first parameter (immediately following the "?"):
In a FORM, the function is specified as:
When a function is required, use one of the values below.
Adds the specified item(s) to the user's shopping basket.
Additional tokens are required; see the token/field reference for details.
|review||Go to the "Basket Review" page, allowing the user to remove or change the quantity of items in the shopping basket|
Delete all items from a user's shopping basket.
The following tokens are available when using this function:
|check||Go to the check-out (purchase items in the shopping basket).
This function can also be used with tokens as normally specified when adding an item to the shopping basket. If you use "check" instead of "add" as the function value, the user is immediately taken to the check-out with the following item (and any other items in their basket) ready to be purchased.
Tokens (also known as fields when specified in a FORM) are extra bits of information passed to the Engine. Depending upon the function specified (whether you're adding an item to the shopping basket, going to the check-out, etc.), you may be required to specify additional information which is necessary in order for the Engine to do its job properly. For example, if you call the Engine with a function of "add", it will expect additional tokens identifying which item is to be added to the user's shopping basket.
When this information is specified in a stand-alone URL, it is appended to the command line, separated by plus signs "+" - we call these tokens. The format for their use is below:
The available tokens are listed in the first column of the table below.
When this information is specified inside of a FORM structure, the format is slightly different. We use more verbose field names as identified in the second column.
As tokens, the field identifier is listed as a single lowercase character, followed by an underscore, immediately followed by the value data. As a FORM field, the data is listed in an INPUT statement in the following format:
Where "xxx" corresponds to the data.
NOTE: The Product ID number (i_xxx or field name "item") should always be listed before any other tokens!! Failure to do so will not associate the product information with the proper item. You should specify tokens in the order of the table below.
|token value:||field name:||Description / (xxx) Data Value:|
|i_xxx||item||Product ID number (alphanumeric - no spaces)|
|u_xxx||iunit||Unit cost (a decimal number - do not use any monetary symbol)|
|n_xxx||iname||Line-item product description (50 chars max, spaces allowd in a FORM, use underscore characters for spaces in a URL|
|s_xxx||istyle||Item style (unlimited number, but total length of all styles should not exceed 128 chars)|
|f_xxx||ifreight||Per-unit freight value|
|v_xxx||ivendor||Vendor ID (associated with this item)
Only use this if you have more than one Vendor ID for which you are listing products.