List of Checkout Process Parameters

cleverbridge offers many parameters to control the checkout process, including the following:

Warning

cleverbridge URLs must not exceed 2,000 characters. Certain browsers may not be able to process URLs that exceed this length.

Products

Checkout process URLs contain parameters that determine the products that appear in the shopping cart.

Dynamic Products

Using the parameter dp, you can create customized checkout process URLs that include a unique product price, discount price, and product name, see Configure Dynamic Products.

Example

Here is an example of a dynamic product in a checkout process URL. The product price is set to 24.95 USD and 29.95 EUR, and the discount is shown:

&dp_123456=__DISCOUNT:10:EUR,10:USD;G__PRICE:34.95:EUR,39.95:USD;G __CHECKSUM:C544A8CE27B71C66F985C53DA256979D

Quantity Settings

Checkout process URLs can contain parameters that control product quantities.

Coupon Settings

Coupons can be added to the checkout process. Use the following parameters to add coupon codes, and to enable or disable coupons.

Cart Settings

This section describes miscellaneous parameters used in acart.

Cookie Settings

By default, cleverbridge uses a checkout process that avoids setting cookies in the customer’s browser. However, in order to offer a persistent shopping cart hosted by cleverbridge, cookie support must be activated. Otherwise, previous selections will be removed from the cart when the customer goes back to your website to select additional items.

Currency Settings

This section describes the currency parameters used in checkout process URLs.

Language Settings

This section describes the language parameters used in checkout process URLs.

Volume Discount Settings

You can add volume discount information to the checkout process. The discount information can be masked or turned off with the following parameters.

Configurations

The configuration parameter allows you to select one of the configurations set up in your account. You can use different configurations in order to provide different checkout flow designs and different feature sets.

&cfg=<configuration>

ParameterData TypeDescription
<configuration>string

Use this parameter to override the default cleverbridge configuration. You are limited to the configurations set up for your account. For more information about the available options, see Flow Design of the Checkout Process or contact Client Experience.

Example

&cfg=design2017_nr

License Keys

You can add license keys to the checkout process with the following parameter.

&previouslicense_<productId>=<string>

&previouslicenserno_<runningNo>=<string>

ParameterData TypeDescription
<string>string

License code of a previously purchased license required for key generation. The code is available in the notification XML.

Example

&previouslicense_123123=MyKey0011Code

Price Rules

You can add or change price rules in the checkout process with the following parameters.

Recommendations

Cross-sells, sub-sells, and up-sells are campaigns known as recommendations. When defining a campaign, you can select a recommendation parameter value that triggers the campaign.

Release of Order

You can ensure that an order has to be approved by you with the following parameter.

&requirerelease=<bool>

ParameterData TypeDescription
<bool>boolean

Use this parameter to enable customers to place orders that are initially given an Awaiting Release by Client status and must be approved by you before being processed.

To approve or reject these orders, do the following:

  1. Go to Transactions > Purchases in the main menu of the Commerce Assistant.
  2. Search for the purchase you would like to approve or reject.
  3. Open the purchase.
  4. Click the Acceptance drop-down menu at the top of the purchase viewer.
  5. Select one of the following:
    • Approve an order (to approve the order)
    • Reject an order (to reject the order)

You can use this feature for instance in the upgrade process, where the entitlement of the customer needs to be manually verified. You can also use this feature to validate that specific checkout processes are available to special entities only, such as schools, universities, or government organizations.

Example

&requirerelease=true

Tracking

You can add or disable tracking information in the checkout process using the following parameters.

Dynamic Protected URLs

Use the following parameters to create dynamic protected URLs.

Customer Data

You can add specific customer information to the checkout process using the following parameters.

X-Parameters (Additional Information)

You can use self-defined additional parameters, called x-parameters, to mark the origin of orders or to submit your own transaction IDs to cleverbridge, see About X-Parameters. The additional parameter is saved in our checkout process. You will be able to view any order that has additional information in the Commerce Assistant reports and XML data feeds. The special x-parameterClosedThe x-parameter is a variable appended to a URL that allows grouping and tracking orders for later reporting purposes. It also enables you to pass through data that you want to capture in the order process. X-parameters can also be used to control design elements based on the value of the x-parameter. x-at submits a tracking parameter that will also be visible for your affiliates in the cleverbridge Affiliate Center.

Fallback URL

A fallback URL is a URL your customers are redirected to if they try to use an expired SURL, open an inactive MVT, or delete all products in their cart. The expired URL is recorded in the following parameters:

&prevUrl=<url>

ParameterData TypeDescription
<url>string

A URL that a customer tried to call and that was either an expired SURL, an inactive MVT, or an empty cart. This URL is always URL-encoded.

Example

&prevUrl=https%3a%2f%2fwww.cleverbridge.com%2f864%2f%3fscope%3dcheckout%26cart%3d214aaa

Tip

  • You can set up the fallback URL under Setup > Account Setup in the Commerce Assistant.
  • If the fallback URL is used, it is recorded in the Entry URL field of the Purchase Viewer.