Shopping Cart Querystring Parameters

Overview:

External web sites can link into several ordering pages in the cart ordering process, either to view product catalog information, view the cart, or to add items to the cart. 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 Server ordering process.

Once you have Generated an Ordering Link from the Store / Generate Ordering Links or Store / Create a New Order/Cart pages, you can append the querystring parameters to the URL.

Author Catalog Page (Author.aspx)

The author catalog page lists out all products available to new customers for a given author with links to the product details page for each. In addition, the page can optionally filter the product list by category. The page supports the following querystring parameters:

Only one of these is required, but it is best practice to always pass the AuthorID regardless so no errors occur should a category be deleted.

Product Details Page (Product.aspx)

The product details page displays details on a specific product, with links to the product option details page for each. If only a single option is available on the product, the page will automatically redirect to the product option details page for that option. The page requires the following querystring parameter:

Product Option Details Page (ProdOption.aspx)

The product option details page displays details on a specific product option, as well as offering a form allowing the user to specify a quantity and add the item to the cart. If a EULA is defined on the product, the user will first be taken to the license agreement page before the item can be added to the cart, otherwise, the item will be added directly to the cart. The page requires the following querystring parameter:

License Agreement Page (LicenseAgreement.aspx)

For products with a EULA specified, this page displays the license agreement and prompts the customer to accept the agreement before adding the item to the cart. If no EULA is specified, the page will automatically redirect to the cart page and add the item to the cart. The page requires the following querystring parameter:

Shopping Cart Page (Cart.aspx)

The shopping page can be linked in numerous ways to perform different actions such as:

The next few sections will outline linking to the cart page in each of these instances. Though this is not required in all instances, it is highly recommended that regardless of how the cart page is being call, you should include the following querystring parameter AT ALL TIMES:

Displaying the Shopping Cart

To simply display the cart and perform no other actions, simply call the page with the following required querystring parameter:

Initiating Checkout

To initiate checkout, call the cart as if displaying it, but add the following additional querystring parameter:

Adding an Item to the Cart (Simple)

To add an item to the cart, use the following querystring parameters:

So, to add ProdOptionID 1234 to the cart, use the following querystring:

Adding an Item to the Cart (Advanced)

The actiondata0 parameter described above can also accept a comma separated list of additional data regarding the item to be added. The additional fields are as follows:

The fields must be passed in this order, but you can omit fields from the end that are not needed. For example, to specify a quantity of 4 when adding an ProdOptionID 1234 to the cart, use the following querystring:

To also specify a CustomData field of "ExampleCustomData", the querystring would be:

Applying a Priority Code to the Cart

Applying a priority code to the cart is similar to adding an item to the cart. To apply a priority code, use the following querystring parameters:

So, to apply priority code EXAMPLE to the cart, use the following querystring:

Clearing the Cart

To clear all items from the cart, pass the following querystring parameters:

Performing Multiple Actions

Multiple actions can be performed in a single call to the cart page - for example, two items can be added and a priority code can be applied with one link to the cart. This is accomplished by specifying multiple actions in order in the querystring. The "0" in the actiondata0 parameter described above is actually a zero-based index which can be changed to support multiple sets of "actiondata" for multiple actions. To string several actions together, simply specify each action followed by its actiondata, incrementing the index on "actiondata" for each action. For example, the add both ProdOptionID 1234 and 5678 as well as apply priority code EXAMPLE in a single call, the querystring would be as follows:

Returning to an Existing Cart

To return to an existing cart, pass the following querystring parameters:

Initialization Querystring Parameters

In addition to the querystring parameters specific to each page outlined above, numerous additional optional querystring parameters can be passed to any of the cart pages when initializing a new cart. Note that these parameters will only be considered when creating a new cart - they are ignored if a cart already exists, so if you opt to use these they should included in ALL links into the cart. These optional parameters are as follows:

Auto Login Querystring Parameters

Similar to the initialization querystring parameters, the cart also supports auto login querystring parameters which can be used to automatically log in a customer or distributor to the cart. Like the initialization parameters, these parameters will only be considered when creating a new cart - they are ignored if a cart already exists. These parameters are as follows:

Forcing Creation of a new Cart

To force creation of a new cart, simply pass cart=new in the querystring.