NOTE: This topic applies only to the legacy ASP cart. If you are using the next generation .NET shopping cart, please see .NET Cart Querystring Parameters.
Overview:
External web sites can link into several ordering pages in the cart ordering process, either to view product catalog information or to view the cart or add items to it directly. Much of the behavior of the cart will be determined by the querystring parameters passed in on the first visit to the ordering process, so it is important that all necessary parameters are passed in on every external link into the SOLO ordering process.
Linkable Pages:
The following pages can be linked to externally into the SOLO ordering process:
b1_cart.asp The cart page. This page can be linked in view mode or in add mode.
b1_newordereula.asp The EULA page. Link here to force the user to accept a EULA before adding an item to their cart (note that a EULA must be defined in SOLO for the given product or the user will be automatically redirected to the cart page).
b1_trigdetail.asp The option details page.
b1_product.asp The product details page.
b1_author.asp The author details page.
Querystring Parameters:
Each querystring parameter is described here:
action=add Used only when adding items directly to the cart.
A The Author ID. Optional when adding to cart.
T The Product Option ID. If adding to the cart and the cart is not running in single order mode, a list of Product Option IDs separated by commas (no spaces) can also be passed in to add multiple items to the cart.
P The Product ID.
U The License ID being upgraded from.
Quantity The quantity to be ordered.
D The Distributor ID to be associated with the order.
S The order source. This can be any string up to 50 characters in length. If passed in, this will be stored on the cart and saved on the invoice upon checkout. In addition, the How did you hear about us? drop down and text box will not be displayed on the registration page. Be sure to URLEncode this value before adding to a querystring.
PROMO The promo code. This can be any string up to 50 characters in length, and is used to supplement the source for additional tracking functionality. If passed in, this will be stored on the cart and tied to the invoice upon check out. Be sure to URLEncode this value before adding to a querystring.
Q The original querystring. If this is not supplied, the querystring passed in to the page that created the cart will be used. This is used to perform any search and replacement for the OriginalQS parameter in the order complete htmls. Do not URLEncode this value (everything within it should already be URLEncoded)
PrCode A priority code to be auto applied to the cart. If present, the code will automatically apply itself to the cart.
NoPrCode (assumed false if omitted) A true/false value used to determine whether to display the priority code entry field on the cart page.
Aredir (assumed false if omitted) A true/false value which determines whether the login screen is bypassed for customers with no customer cookie.
PreRegister (assumed false if omitted) A true/false value determining whether to operate the cart in preregister mode, which will force the user to either log in or register before viewing their cart.
Single (assumed false if omitted) A true/false value determining whether to run the cart in single order mode.
CID/C - The CustomerID (either C or CID can be used). If this is passed in and is valid, the customer will automatically be associated with the cart and the login page will be skipped during the checkout process.
OriginalE/Pw - The customer email/password. Must be used together. If passed in, the system will attempt to find the customer by email/password and if found the customer will automatically be associated with the cart and the login page will be skipped during checkout.
noopo (assumed false if omitted) A true/false value which when included will cause no other options aside from credit card to be displayed on the payment page.
nopaypal (assumed false if omitted) A true/false value which when included will cause the paypal payment option to be hidden.
nomailinst (assumed false if omitted) A true/false value which when included will cause the by mail payment option to be hidden.
nophoneinst (assumed false if omitted) A true/false value which when included will cause the by phone payment option to be hidden.
ReturnPage (optional) A page to return to from the continue shopping link/button, allowing an override of the continue shopping URL defined on the cart options. This can take the following values:
conturl: Sets the continue shopping button to go to the predefined continue shopping URL defined in the cart options.
refer: Sets the continue shopping URL to return to the page that referred the user to the cart. If the referrer is blank (the user used a bookmark or typed in the URL), the continue shopping URL defined on the cart options will be used instead if it is present.
<URL>: Sets the continue shopping button to return to the given URL. If this is used, make sure to URLEncode the value before adding it to the querystring.
RegisterRedirect (optional) A custom page to redirect to during the checkout process after the customer has registered. This is an advanced option. The path to the page is relative to the root of the author custom directory, and does not support querystring parameters.
CompletionRedirect (optional) A custom page to redirect to after the order has successfully processed instead of the standard thank you page. This is an advanced option. The path to the page is relative to the root of the author custom directory, and does not support querystring parameters.
clear (optional) If passed in with a value of "true", all existing items will be cleared from the cart before adding the new item.
CustomData (optional)- if passed in, the string value in the parameter is saved on the cart item, and the cart item from that point on is considered unique by both ProdOptionID/CustomData. This is an advanced feature. When provided, this value will be passed along to the license upon order completion.
PONumber (optional) - A PO Number to pass on to the invoice during order processing.
Parameter/Page Requirements:
The previous parameters are supported on the ordering pages as follows:
|
|
Ordering Page |
|||||
|
Parameter |
Cart View |
Cart Add |
EULA |
Author |
Products |
Options |
|
A |
R |
O |
O |
R |
X |
X |
|
T |
X |
R |
R |
X |
X |
R |
|
Quantity |
X |
O |
O |
X |
X |
R |
|
P |
X |
X |
X |
X |
R |
X |
|
U |
X |
O |
O |
X |
X |
O |
|
D (F) |
O |
O |
O |
X |
O |
O |
|
Single (F) |
O |
O |
O |
O |
O |
O |
|
S (F) |
O |
O |
O |
X |
O |
O |
|
PROMO (F) |
O |
O |
O |
O |
O |
O |
|
Q (F) |
O |
O |
O |
X |
O |
O |
|
PrCode |
O |
O |
O |
O |
O |
O |
|
aredir (F) |
O |
O |
O |
X |
X |
X |
|
PreRegister (F) |
O |
O |
O |
X |
X |
X |
|
ReturnPage (F) |
O |
O |
O |
X |
X |
X |
|
C\CID (F) |
O |
O |
O |
X |
X |
X |
|
OriginalE\PW (F) |
O |
O |
O |
X |
X |
X |
|
noopo\nopaypal\ nomailinst\nophoneinst (F) |
O |
O |
O |
X |
X |
X |
|
RegisterRedirect (F) |
O |
O |
X |
X |
X |
X |
|
CompletionRedirect(F) |
O |
O |
X |
X |
X |
X |
|
clear |
O |
O |
X |
X |
X |
X |
|
PONumber (F) |
O |
O |
X |
X |
X |
X |
where the codes are defined as:
R - Required
O - Optional
X - Not Supported
In addition, any parameter marked with an F is a first run parameter, meaning that once the cart is created (once the b1_cart.asp page has been reached for the first time), this parameter is stored on the cart and cannot be changed or modified.
For information of how to use these links, visit the Change Links section of the manual