Skip to main content

JSON Integration: Item Page

An item page is typically any page that shows detailed product information for a single product.

This is a required page type. Even if no placements appear on this page, the integration logic must be present.

How To Make This Code Work For You

Follow the sample integration code below, making these changes:

Function Requirement
R3_COMMON.setApiKey('API Key'); Replace API Key with your site’s API key, a unique identifier for your account.
R3_COMMON.setBaseUrl(window.location.protocol+'//RR Server'); Set RR Server URL to one of the following values:

For initial development:
For production:
R3_COMMON.setSessionId('User Session ID'); Replace User Session ID with the session ID for the current user and session. The session ID is a crucial variable that allows Algonomy to track customer behavior when they visit your site so recommendations can be generated. This parameter should remain the same from start to finish for a user’s shopping session.
R3_COMMON.setUserId('User ID'); Replace User ID with the user ID, a unique string to identify each user. All user behavior will be stored using this key. It is case-sensitive and should be the same user ID sent to Algonomy in other applications. User IDs are often connected to email addresses, and can be directly linked to the login credentials a consumer uses to log into and buy products from the e-commerce site. To avoid sending personally identifiable information to Algonomy, you can use a hash of your site’s user ID (if, for example, your site uses email addresses as user IDs, then you should not send that information directly to Algonomy).

Note: If the User ID is unknown, leave it blank.
R3_ITEM.setId('Item ID'); Replace Item ID with the item ID, a unique identifier for the item.
R3_ITEM.setName('Item Name'); Replace Item Name with the item name, a user-friendly name of the item.
R3_COMMON.addCategoryHintId('Category ID');

Replace Category ID with the category ID. This is the current category ID related to your product based on the context of how your customer navigated to it. For example, if a customer navigated to "Electronics - Computers - Laptops", the category ID would be Laptops. If the user landed on the item page without a breadcrumb trail or navigation process, you can fall back on a Primary Category or Default Category. Algonomy uses the addCategoryHintId to derive category context when responding with data.

Note: this field can be alphanumeric. The example below is numeric.
R3_COMMON.addPlacementType('item_page.Placement Name'); Replace Placement Name with the Placement ID. You can find your Placement IDs in the Dashboard under the Placements section. If you do not display personalization on this page, call R3_COMMON.addPlacementType('item_page');instead.

No changes are required.

This code enables the client to send the domain for click-through URL through the p13n_generated.js call if relative URLs are supplied in the feed. For example, if the domain calling our code is or, we can automatically redirect to the correct domain.

Sample Integration Code

Algonomy JavaScript Library

<!-- Primary function library placed before the callback and Primary Code Block. -->
<script src="//"></script>

Callback Function

This function will consume the JSON response object. Place anywhere in between your <script> tag that loads p13n.js and the r3() function call.

<script charset="utf-8" type="text/javascript">
  RR.jsonCallback = function(){
    // Place your rendering logic here. Actual code varies depending on your website implementation.

Primary Code Block

<!-- Place this code inside the <body> element as close to the top as possible -->
<script charset="utf-8" type="text/javascript">
  var R3_COMMON = new r3_common();
  R3_COMMON.setUserId('10987');  // if no user ID is available, please leave this blank
  // Use this code if you are not requesting placement(s) for personalization
  // Replace placement_name with the placement name you set up in Dashboard.
  // Call multiple times to display more than one placement.
  // We highly recommend you provide the Category Hint ID. See above for more information.
  var R3_ITEM = new r3_item();
  R3_ITEM.setName('HP 2000-2b59WM Laptop');


  • Placements requested via addPlacementType() should always be displayed on the page.
  • Was this article helpful?