Parameters that can be passed to UCEditor

The URL http://secure.ultracart.com/cgi-bin/UCEditor is the main entry point to the UltraCart system from your website. It serves as both a way to view the cart and to also add items to the cart. Your website can do either a GET or a POST to this URL.

In a typical scenario, a merchant will have a web page displaying a product, and the "Add to Cart" button will be a portion of a form pointing to UCEditor.

MerchantID = 1-5 character merchant ID (required), example http://secure.ultracart.com/cgi-bin/UCEditor?MerchantID=DEMO
ADD = Item ID of a single item to add (optional), example http://secure.ultracart.com/cgi-bin/UCEditor?MerchantID=DEMO&ADD=MyItemID

PROPER URL FOR USE WITH STOREFRONTS

When using the UltraCart Storefront, you'll need to change the hostname portion of the URL to use the storefront hostname. So, for our DEMO store the URL would be:

 http://demo.ultracartstore.com/cgi-bin/UCEditor 

Pre-populating Cart Data From an External Form

The following parameters can be passed to pre-populate portions of the checkout:

Additional Parameters

Passing multiple items at once

In certain cases you may wish to create a buy link or buy form that add multiple items, which can be accomplished with adding multiple "add" parameters:

 
http://secure.ultracart.com/cgi-bin/UCEditor?MerchantID=DEMO&ADD=BONE&ADD=DOG-COLLAR
 

What if you need to be able to include the qty of each item, in the situation above there are only two options, leave the qty out and let the customer adjust the quantity after adding the items to the shopping cart, or including a quantity parameter which would have to be the same for both. 

 
http://secure.ultracart.com/cgi-bin/UCEditor?MerchantID=DEMO&ADD=BONE&ADD=DOG-COLLAR&QUANTITY=3
 

In many situation you may wish to add multiple items to the cart at once but also have the ability to define a separate quantity for each item, To do so, you will use a modify version of the buy link parameters, that uses a underscore to tie together the ADD statement with it's own quantity (this applies to other parameter, such as the OptionName1 and OptionValue1, etc.

The following variation of the previous code example uses this variation, passing three of the item "Bone" (box of bones) and 1 of the color, passing the size and color options:

 
http://secure.ultracart.com/cgi-bin/UCEditor?MerchantID=DEMO&ADD_BONE=3&ADD_DOG-COLLAR=1&ADD_DOG-COLLAR_OptionName1=SIZE&ADD_DOG-COLLAR_OptionValue1=X-Large&ADD_DOG-COLLAR_OptionName2=COLOR&ADD_DOG-COLLAR_OptionValue2=BLACK
 

Using Parameters

There are two main styles of links that merchant's use:
1) View Cart
2) Buy Link (Item)

View Cart - specify MerchantID only
Buy Link - specify MerchantID and ADD parameters.

All the other parameters can be used creatively to produce the checkout experience desired. If you have any questions, please contact UltraCart Support.
In order to make the single page checkout automatically display the calculated shipping options, add this script to the footer edit field:

<script>
shippingDestinationChanged();
</script>

-------

Sample uceditor form code skeleton

<form method="POST" action="http://secure.ultracart.com/cgi-bin/UCEditor">
  <input type="hidden" name="merchantId" value="DEMO"></input>
  <input type="hidden" name="add" value="Bone"></input>
  <table>
    <tr>
      <td>Qty</td>
      <td>
        <input type="text" name="quantity" value="1"></input>
      </td>
    </tr>
    <tr>
      <td></td>
      <td>
        <input type="submit" name="submit" value="add to cart"></input>
      </td>
    </tr>
  </table>
</form>

-------

Sample uceditor form for adding multiple items at one time. The merchant id is SRVCO and the items are T200SAVINGSKIT and T300SAVINGSKIT :

<!--
notice! the *name* of the input is ADD_ + item id. the *value* is the quantity for that item.
-->
<form action='http://secure.ultracart.com/cgi-bin/UCEditor' method='POST'>
    <input type='hidden' name='merchantId' value='SRVCO'/>

    Please enter your desired quantities below:<br />
    $200 Saving Kit <input type='text' name='ADD_T200SAVINGSKIT' size='10' maxlength='10'/><br />
    $300 Saving Kit <input type='text' name='ADD_T300SAVINGSKIT' size='10' maxlength='10'/><br />

    <input type='submit' value='Add to Cart'/>
</form>

By-passing upsell path

Sometimes you may need to by-pass your configured upsell offers.

This can be accomplished by creating an additional upsell after path, configured with none of the steps enabled within the path and saving the path with zero percent traffic. Then, on the buy link of the item, append the new "empty" upsell after path to the buy link URL.

Related Documentation

Advanced Links - JavaScript