Skip to main content
RichRelevance

Purchase Complete Page

The purchase complete page is the page displayed to customers immediately after they successfully purchased their items.

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 URL.richrelevance.com/rrserver/'); Set RR Server URL to one of the following values:

For initial development:
integration
For production:
recs
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 RichRelevance to track shopper 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 RichRelevance 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 RichRelevance, 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 RichRelevance).

Note: If the User ID is unknown, leave it blank.
R3_PURCHASED.setOrderNumber('Order ID'); Replace Order ID with the order ID, a unique identifier for the order.
R3_PURCHASED.addItemIdPriceQuantity('Item ID', 'Price', 'Quantity', 'SKU');

Use this function once for every item purchased.
Replace Item ID with the item ID, a unique identifier for the item. Replace Price with the price of a single item in decimal format ("19.99" for example). Replace Quantity with the quantity for this product. Replace SKU with the specific SKU the user has purchased. If there is no SKU ID, do not use the second parameter.​

Example with SKU:
R3_PURCHASED.addItemIdPriceQuantity('21666189', '499.99', '1', '9876A');

Example without SKU:
R3_PURCHASED.addItemIdPriceQuantity('21666189', '499.99', '1');

Note: Personalization capabilities at the SKU level are currently unavailable. However, we are ready to accept and evaluate this data for recommendations.
R3_COMMON.addPlacementType('purchase_complete_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('purchase_complete_page');instead.
R3_COMMON.setClickthruServer(window.location.protocol+'//'+window.location.host)

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 m.retailer.com or UAT.retailer.com, we can automatically redirect to the correct domain.

Sample Integration Code

RichRelevance JavaScript Library

<!-- Primary function library placed before the callback and Primary Code Block. -->
<script src="//media.richrelevance.com/rrserver/js/1.2/p13n.js"></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.
    console.dir(RR.data.JSON.placements);
  };
</script>

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.setApiKey('abcd5432e1');
  R3_COMMON.setBaseUrl(window.location.protocol+'//integration.richrelevance.com/rrserver/');
  R3_COMMON.setClickthruServer(window.location.protocol+"//"+window.location.host);
  R3_COMMON.setSessionId('6B4D397B');
  R3_COMMON.setUserId('1');  // if no user ID is available, please leave this blank
 
  // Use this code if you are not requesting placement(s) for personalization
  R3_COMMON.addPlacementType('purchase_complete_page');

  // Replace placement_name with the placement name you set up in Dashboard.
  // Call multiple times to display more than one placement.
  R3_COMMON.addPlacementType('purchase_complete_page.placement_name');
 
  var R3_PURCHASED = new r3_purchased();
  R3_PURCHASED.setOrderNumber('XYZ123456');
  
  // In this example, the customer purchased this item:
  // Product ID: 21666189
  // Price: $499.99,
  // Quantity: 1
  // SKU: 9876A
  
  // Call multiple times, one time per purchased item.
  R3_PURCHASED.addItemIdPriceQuantity('21666189', '499.99', '1', '9876A');
 
  rr_flush_onload();
 
  r3(); 
</script>

Notes

  • Placements requested via addPlacementType() should always be displayed on the page.
  • This page is often secure (served via HTTPS). If not using window.location.protocol, provide “https” in R3_COMMON.setBaseUrl():
     R3_COMMON.setBaseUrl('https://recs.richrelevance.com/rrserver/');
  • The PRICE passed in R3_PURCHASED.addItemIdPriceQuantity() is the single unit price. RichRelevance multiplies this by the quantity to determine line item order value.