Add a base product
A base product is a template that you can use to create an assortment of perpetual or recurring products with similar characteristics.
For instructions on how to create a new base product in Commerce Assistant (CA), see Products.
To create a new base product in our web admin tool:
- Go to Configure > Manage Products, and select Add Base Product from the three-dot menu.
Complete the information in the following sections:
General
The General section is used to enter product details that will be visible to your customer on the checkout pages, as well as categorical and other internal information about your base products.
Visible information
Product Status
The Product Status option determines how the product is used in the Cleverbridge platform. The options include:
| Option | Description |
|---|---|
| Fully available | It is a default status. The product is available for sale and listed online. |
| Deactivated | The product is neither available for sale nor listed online. |
| Allow sale and initiate only through client website | The product can be sold with no limitations through a direct link provided on a web page or in an email. However, a customer who contacts Cleverbridge Customer Support to purchase the product will be asked to order it through the client's website. Out of PCI compliance reasons, Cleverbridge Customer Support will not send the customer other purchase links, such as protected URLs created by Link Generator. |
| Hide, only sell if product ID is known | The product is hidden from the general public. The customer must have the product ID to access the product. After entering the product ID, the customer can purchase the product at a discounted or special price. |
| Only available from restricted IP range | Use this option if you don't want customers to purchase the product, but you want individuals within your company to be able to use the product in the cart. To set up an IP range for restricting access to this product, contact Client Experience. |
| Only available in protected URLs | The product is available only through a protected URL (created using Link Generator) that is shared with specific customers. You can also use this option if you don't want customers to purchase the product, but you want individuals within your company to be able to use it in the cart. |
Product Name
Product Name is displayed to customers during the checkout process. This field doesn't support HTML.
You must include an English product name, even if your company uses another default language and only sells the product in this language. Failure to do so will result in an Input Validation message when you try to save the product.
Product Subtitle
You can use the Product Subtitle option to provide a short product description that provides more detailed information about the essential features of the product. This description displays as an additional line below the product in the shopping cart, review page, confirmation page, email messages, and so on. This field doesn’t support HTML.
Images
You can use the Images section to add images of your product that will display in the cart.
Internal information
Internal Product Name
The Internal Product Name value cross-references purchases for this product with your own internal product name, which you can also use to easily organize your product information within the Cleverbridge platform.
If Internal Product Name is defined, this name will be used throughout the Cleverbridge platform instead of the name defined in Product Name. In the checkout process, however, customers will see the main product name and not the internal name.
Internal Category
Internal Category is an internal product category for the purpose of sorting products by a specific type or class.
Internal ID
The Internal ID value cross-references purchases for this product with your own internal number. This ID can include alphanumeric characters.
If you would like to use your internal product ID in the checkout process, you can submit the internal ID as a parameter with the number prefixed by the capital letter I.
A Cleverbridge product ID in an order URL is formatted as &cart=42149, but an internal ID is formatted as &cart=I543.
If you are offering a product selection in the checkout process, you can submit Internal ID to trigger the preselection of a particular option. For example, imagine that you are offering the following subscription options for a product: 6 months, 1 year, and 2 years. You can submit Internal ID for the 1-year subscription product so that it is pre-selected for the customer. To trigger a pre-selection using the internal ID for a specific option in a selection, use the following parameter:
&cart=S<selection ID>:I<internal product ID> (for example, &cart=S42149:I543)
Attributes
The Attributes section is used to enter information that will be used to market your product in the Cleverbridge platform, as well as restrict the quantity of products that your customers can order.
Version
If applicable, enter the version of the product. This can be displayed in the checkout process, depending on your configuration template.
Min. Order Quantity
The Min. Order Quantity field specifies the minimum quantity that can be purchased for this product in an order.
Max. Order Quantity
The Max. Order Quantity field specifies the maximum quantity that can be purchased for this product in an order.
Descriptions for Marketing Purposes
Short Description
A short description that appears when this product is used in a recommendation or Cleverbridge-hosted catalog. The exact placement of this text depends on your selected template.
Long Description
A description that appears when this product is used in a recommendation or Cleverbridge-hosted catalog. The exact placement of this text depends on your selected template.
System Requirements
A description of system requirements that appears when this product is used in a recommendation or Cleverbridge-hosted catalog. The exact placement of this text depends on your selected template.
Volume Pricing Note
The volume pricing note displays in the Volume discount pop-up window in the cart. Use this option to provide contact information or any additional information that further explains your volume pricing.
Shopping Cart
Product Information in Cart (as Pop-Up)
To add plain text or HTML that appears within a pop-up in the cart, do the following:
-
Create your product information in the Product Information in Cart (as Pop-Up) text editor field.
-
To add a reference to an image, use the following HTML, and include your client account ID and the image name:
<img src=mycontent/client account ID/image name>.
To reference an image, you must first upload it to Web Files in CA. For more information, see Web files.
The following is an example of how the pop-up information in the cart could be formatted:
<table>
<tr>
<td><img src=/mycontent/123/GenericBoxshotSmall.png> </td> <td>
<h1>Internet Security Basic Extended</h1>
<p>Anti-virus software for personal use. This product offers virus protection, anti-phishing tools, email protection, and identity theft protection. It removes worms and eliminates malware. Protect your Internet browsing, online banking, social networking, and more.</p><br />
</td>
</tr>
</table>
Delivery Text (HTML)
The Delivery Text (HTML) displays information about the product delivery method, such as download, email, and so on, in the delivery section of the cart.
Delivery Text (PDF)
The Delivery Text (PDF) displays information about the product delivery method, such as download, email, and so on, in the delivery section of a PDF order confirmation document. Because PDFs are not compatible with HTML, enter non-HTML information here.
Selection Text
Use selection texts so that customers can choose between different options for a product in the cart.
Delivery
The Delivery section is used to designate how your product will be delivered. In this section, the following options appear:
Delivery Type
In the Delivery Type dropdown list, select how to deliver the product. For certain delivery types, more setup options display.
Cleverbridge delivers the license key for the software to the customer. The following options are available:
| Option | Description |
|---|---|
| Key List | Select a key list. |
| Web Key Generator | Select a web key generator. If you want to set up a new web key generator, use the feature available in CA. For details, see Key generators. |
| Key result type | Used for key generation, controls how the key and template are shown to the customer. Select from the following options:
|
| Execute once per purchased quantity | Select to generate only one key per cart item, regardless of the quantity of the item purchased. |
| Use key template | Select to use the key template text that was set up in the Key Template field. |
There's also a possibility for Cleverbridge to deliver the key by using an executable key generator or a dynamic link library. These options are hosted by Cleverbridge. For more information, contact Client Experience.
If a key generation or key list error occurs, the following happens:
- If you have set up this notification type, you receive an ErrorNotification.
- An error log entry is created.
- The Cleverbridge platform makes up to five attempts to generate or obtain the key (after 1-2-4-8-16 hours). After each unsuccessful attempt, an ErrorNotification is sent and an error log entry created.
- If the fifth attempt to generate or obtain the key fails, our Customer Support will investigate the error (unless Client handles errors is activated).
For subscription products, you can apply additional delivery options in CA:
| Option | Description |
|---|---|
| Execute only on initial purchase | Delivery details are triggered on the initial product purchase. For example, you can use this to create a license key for the customer based on the license generation API. |
| Execute only on subscription billing events | Delivery details are triggered only when the customer successfully pays for each billing interval of the product. |
| Execute on initial purchase and subscription billing events | Delivery details are triggered both upon the initial product purchase and for each subsequent billing event. |
| Execute on initial purchase and copy on subscription billing events | Delivery details are triggered on the initial product purchase, and a copy of the key is included in the confirmation page or email for future billing events. |
Cleverbridge delivers the full version of the software to the customer by download.
The following options are available:
| Option | Description |
|---|---|
| Download File | Select a file that customer downloads though a link. If you want to upload a new file, you need to do it through CA. For details, see Product files. |
| Link Validity in Days | Select the number of days for which the download link is valid. |
| Description | Enter descriptive information that displays with the download link on the confirmation page and confirmation email. |
| Only show download when customer orders in this language | Select the checkbox to restrict the download to a specific language in which the customer orders. |
You deliver the full version of the product to the customer by download.
You deliver the license key to the customer.
Key Template
The Key Template option inserts custom license key information, such as customer name, product name, license key number, and so on, for the customer on the confirmation page. If you don't enter any custom text in this field, default key template text displays on the confirmation page as follows:
Your product key: ...
If you don't want the default key template text to display on the confirmation page, and you don't want to enter custom text, you can enter only the Key placeholder in this field. In this case, if you use a key list, only the license key itself displays, and if you use a key generator, neither the default text nor a license key displays.
The following dynamic placeholders are available to insert customer information:
| Placeholder | Description |
|---|---|
<Key> | License key |
<RegName> | Customer name |
<ProductId> | Product ID |
<InternalProductId> | Internal product ID |
<[NAME_OF_X_PARAM]> | Corresponding x-parameter |
<ProductName> | Name of the ordered product |
<Quantity> | Quantity of the ordered product |
<ProductTrialUrl> | URL to download a trial version of the product |
The following is an example of key template text:
<RegName>, here is your product key for your purchase of <ProductName>.
<Key>
Email Key Template
The Email Key Template option is used to define a key template for the email confirmation. Use this option only if the key template for the email confirmation needs to differ from the one used for the confirmation page.
If the same key template should be used for the confirmation page and the email configuration, leave this field blank.
Additional Delivery Note
The Additional Delivery Note option inserts additional delivery information for the customer on the confirmation page. The following dynamic placeholders are available to insert customer information:
| Placeholder | Description |
|---|---|
<ProductId> | Product ID |
<InternalProductId> | Internal product ID |
<[NAME_OF_X_PARAM]> | Corresponding x-parameter |
<ProductName> | Name of the ordered product |
<Quantity> | Quantity of the ordered product |
<ProductTrialUrl> | URL to download a trial version of the product |
The following is an example of additional delivery note text:
<p>Thank you for your order. To download and install your product, please follow these instructions:</p>
<ol>
<li>Download the installation file by clicking the button below.</li>
<li>Double-click on the downloaded file to begin installation.</li>
<li>Follow the onscreen installation instructions.</li>
<li>When prompted, enter your license key.<br/></li>
</ol>
<p>Please note: The license key is also included in your confirmation email.</p>
Information on Extra Page
The Information on Extra Page option is used when the installation instructions or other product information are too long to fit on the confirmation page. This creates a button on the confirmation page that the customer clicks to open the instructions in a separate window.