HTML Integration: Cart Page (Legacy)
NOTE This section refers to a legacy feature which is only available to existing customers. New and existing customers looking to add personalization should refer to Cart Page (JSON).
The cart page typically displays the items in a shopper's cart. It is a distinct page separate from the add-to-cart page, which may be a modal window or an interstitial page before cart, such as an options page.
How To Make This Code Work For You
Follow the sample integration code below, making these changes:
Function | Requirement |
---|---|
R3_COMMON.setApiKey('MY_API_KEY'); |
Replace MY_API_KEY with your site's API key, a unique identifier for your account. |
R3_COMMON.setBaseUrl(RRSERVER_URL); |
Set
|
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 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
|
R3_CART.addItemId('ITEM_ID','SKU'); |
Use this function once for every item in the cart. Replace ITEM_ID with the item ID, a unique identifier for the item. Replace SKU with the specific SKU the user has purchased. If there is no SKU ID, this can be left empty.Note: Personalization capabilities at the SKU level are currently unavailable. However, we are ready to accept and evaluate this data for recommendations. |
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
Primary Code Block
<!-- Place this code inside the <body> element as close to the top as possible --> <script src="//media.richrelevance.com/rrserver/js/1.1/p13n.js"></script> <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 // here's an example requesting recommendations for 3 page areas R3_COMMON.addPlacementType('cart_page.rr1'); R3_COMMON.addPlacementType('cart_page.rr2'); R3_COMMON.addPlacementType('cart_page.rr3'); var R3_CART = new r3_cart(); R3_CART.addItemId('21666189', '9876A'); // iterate over this line for each item in the cart r3(); </script>
Placement-marker Code Blocks
<script charset="utf-8" type="text/javascript"> r3_placement('cart_page.rr1'); </script> <!-- Page contents --> <script charset="utf-8" type="text/javascript"> r3_placement('cart_page.rr2'); </script> <!-- Page contents --> <script charset="utf-8" type="text/javascript"> r3_placement('cart_page.rr3'); </script>
Flush Code Block
<script charset="utf-8" type="text/javascript"> rr_flush_onload(); </script>
Notes
- The values in
addPlacementType()
should match the values in eachr3_placement()
call.