Skip to main content
All CollectionsIntegrating our serviceSet up
Shopper Approved Seller & Product Review Integration Overview
Shopper Approved Seller & Product Review Integration Overview

Here is a detailed overview for the integration of Seller and Product reviews.

Ryley Freideman avatar
Written by Ryley Freideman
Updated over 5 months ago

Step 1 - Provide us with your product feed

To get started, we will need to collect your current product feed and map that to our system. This step is required to collect product reviews. Our system needs to know what products you sell along with their strong identifiers so we can pass that information off to Google.

If you have a Google shopping feed, it’s best to send that over as well for review since we want to make sure your product feed matches exactly with what Google has.

Here are the strong identifiers for a product feed:

  • Product ID

  • Product name

  • Product URL

  • Product Image URL

  • Brand

  • Manufacturing Parts Number (MPN)

  • Global Trade Identification Number (GTIN)

  • Parent ID (item_group_id) This is used to aggregate the variations of a product so each review will aggregate on the parent level.

Note: If you don’t have a GTIN, then we MUST have a Brand AND MPN to show stars in your product listing ads. If you have all of these strong identifiers, it’s best to include them.

If your products are custom-made and you don’t have an MPN or GTIN, you can use the product ID as the MPN.

Why do we need all this information?

  1. For us to ask your customers for a product review, we need to know what products they purchased. We will ask your customers to review the exact product they purchased which includes the product name and image of the product making it easier for them to remember what they bought. Furthermore, when the customer leaves a review, we associate that review to the specific product.

  2. Secondly, we store the product reviews we collect on your behalf in our system and pass them to Google for syndication. For your review to count in Google and your product listing ads, Google needs to know exactly what product it is and what domain it comes from. By giving us these strong identifiers, it helps Google to identify which products the reviews go to and match them to your Google shopping feed and product listing ads.

If you want to collect product reviews on all the products you sell, we will need a feed with all products. If you want to collect product reviews on only the products you have product listing ads on, the feed can be more limited.

Once you are ready to give us your product feed, you can log in to Shopper Approved and provide your product feed in one of two ways:

  1. One-time feed upload: If you upload a CSV file, the file will be mapped one time. Any future products will not be included unless you upload a new file including those products.

  2. Dynamic feed (recommended): If you have a hosted URL you can provide, you can set up a scheduled export of your products. Our system will read your feed weekly and any changes you make to your feed will be automatically updated. Acceptable file types are CSV and XML.

Here is an example file for you to reference. To submit your product feed to our system, navigate to the main menu in the upper left-hand corner > Setup > Product Integration.

Note: It’s always best to have one of our support members review your product feed the first time to ensure it includes everything we need.

Once you have either uploaded the one-time feed or provided a dynamic URL, we will map your product feed to our system. This step must happen before you can start collecting product reviews.

Step 2 - Add the seller survey code to your order confirmation page

To begin collecting seller reviews, you will place a code snippet on your order confirmation page. This code snippet is what populates the checkout (initial) survey after a customer checks so they can leave a seller review.

You can find the code snippet in your Shopper Approved account within the top left navigation under Setup > Seller Ratings > within the “Copy and paste Initial Survey code on your ‘Thank You’ page” section (3rd section down).

Here is an example code for your reference.

Note: Please do not use this code snippet as is. You will need to replace the variables such as siteID and token.

<script type="text/javascript"> var sa_values = { "site":siteID, "token":"token" }; function saLoadScript(src) { var js = window.document.createElement("script"); js.src = src; js.type = "text/javascript"; document.getElementsByTagName("head")[0].appendChild(js); } saLoadScript("https://www.shopperapproved.com/thankyou/rate/xxxx.js") </script>

The site and token variables are unique to your account. You will notice that they are prefilled for you. If you want to verify, you can check under your Account Settings by clicking on your name in the upper right-hand corner under Settings > Domain Information.

Note: make sure you use the initial survey token and not the API token or it will result in incorrect review submission.

We have other values you can add to this code snippet if desired. To add these variables to your code snippet, select the checkbox next to the value you would like added. You can find this under Auto Populate Values on the Seller Ratings Setup page (see image below). Selecting these checkboxes will only add the value with dummy variable data into the code snippet. Please make sure to configure the correct variables from your site.

Below you see that the order ID, name, and email have been added to the code snippet and filled with dummy data.

 var sa_values = { "site":siteID, "token":"token", 'orderid':'ORDER123', 'name':'John Doe', 'email':'[email protected]' }

We recommend selecting the following:

  • Order ID: Attaching an order ID to a review makes it easier for you to cross-reference the order with a customer review. It is especially useful when you are searching for a particular review.

  • Name: The customer's name will be auto-filled in the name field, making it easier for your customer to fill out the survey. The name will be attached to the review. Note: If the customer doesn’t add a name, or removes the name, the review will show “Anonymous Customer”.

  • Email: The customer's email address will also be auto-filled in the email field on the survey. For us to send a follow-up email to your customers, we must have their email address. This is also a required value if you want us to send emails to all customers who place an order on your site whether they fill out the checkout (initial) survey or not. If you are interested in this, make sure you have “email all” turned on and that your privacy policy states you will share information with a third party.

Optional Values

  • Country

  • State/Province

  • Days to delivery: This dynamically allocates the days to delivery based on a dynamic value.

After selecting the values you want, copy the code snippet to your site. Remember to replace the dummy data with data from your checkout page using your cart’s variables.

Note: If you are not able to auto-populate any of the variables such as order id, name, and email address from your cart/platform, the survey code will still populate a survey. Make sure that the values that you are not able to fill are not selected so they are not included in the code snippet. Remember to include the site ID and token. If the email variable is not passed, this will prohibit you from using the email-all feature and may lead to a lower review conversion rate.

Step 3 - Add the product bolt-on code to your order confirmation page

To transfer information about a customer's purchases to our system, you will need to add the product bolt-on code. This code is designed to populate product details into the "sa_products" object on your order confirmation page. You can find the code example on the "Setup > Product Integration" page.

 <script> var sa_products = { 'productid1':'Product Name 1', 'productid2':'Product Name 2', 'productid3':'Product Name 3' }; </script>

The best way to accomplish this would be to use a loop to go through the products that were purchased and then populate the key-value pairs of product ID and product name into sa_products. Please see below for an example:

<script>
var sa_products = {};
for (i = 0; i < products.length; i++) {
sa_products[products[i].id]=products[i].name;
}
</script>

Best Practices

  • Pass the CHILD variant ID. Passing the parent ID can cause syndication issues in most circumstances and could break Shopper Approved's ability to syndicate or display your product reviews.

  • Escape Product Names. Failure to do so will break the script resulting in no feedback collection.

  • Make sure the variable will be ready and populated with data when the survey script loads. If the data is not present, a product review cannot be requested in the follow-up review request.

Step 4 - Place a Test Order (and set the follow-up days)

Once you have added the code snippet to your order confirmation page with the correct values, you will want to place a test order to ensure the survey submission passes the correct values onto the review.

After checking out, you should see this survey on your order confirmation page.

Note: If you have uploaded your logo in your settings, your logo will appear at the top.

If you are passing the order ID, name, and email, the name and email should be auto-filled in the fields.

Fill out the survey as if you were a customer and submit the review.

To verify the review came through with the correct values, log in to your Shopper Approved account to see your review under the main navigation drop-down menu > Seller Ratings > Manage Seller Ratings.

You should see a review similar to this with the values. You want to make sure the products purchased are attached to the review.

Note: The product the customer purchased is attached to the review.

Please note that if your review is not marked as a “test,” you should reach out to [email protected] to prevent any issues with your account.

To test the follow-up email, you can set the follow-up days to 0 days before submitting the checkout (initial) review. This will send a follow-up email within a few hours to the email address from the survey. From that email, you can fill out the post-fulfillment (full) survey as well.

Note: After placing a successful test order, you will want to change the follow-up days to the average days to delivery. Keep in mind these are calendar days.

Step 5 - Add a seller reviews page

Now that your customers can leave a seller review, you will want to display these reviews on your site. Adding a dedicated seller reviews page to your site gives you an organic search result in Google and drives traffic directly to your site.

Start by creating a new page on your website titled “Reviews” and add a link to your site footer.

Here is what a reviews page will look like:

Customizations for the review page widget are located within the Shopper Approved dashboard under Seals and Widgets > Review Page Widget which includes changing the star, graph, text color, and display options. After customizing your widget to your liking hit Save and then copy and paste the code snippet to your newly created Reviews page.

This will automatically add all your seller reviews to this page. You can change the default sort order and choose to hide the customer location.

Note: It’s recommended to add the reviews page after you have received 5 reviews or more since the reviews page will be an average of all seller reviews.

Step 6 - Add a seal

The seal is very beneficial to add to your site because it shows Google the relationship between your certificate page and your website when they crawl your site, helping you rank higher in Google. It is also used as social proof. The certificate page also gives your organic stars in Google. Your customers can also click on the seal and be directed to the certificate page to see reviews.

To find the seal code, navigate to Seals and Widgets > Manage Seals in your Shopper Approved account to customize. There are a variety of customizations you can make such as color, style, width, and more. The seal can either be dynamic, rotating between your review count and overall rating, or static. A preview of your seal will display on the right-hand side as you customize your settings.

Once you are done customizing to your liking, copy and paste the code snippet onto the desired location on your site. The most common locations are in the header and/or footer of your website.

We have found that clients get the best conversion when they place the seal somewhere in the top right of their website in the header. You can also create a floating seal so the seal is always visible on your site when a customer scrolls.

Note: For security, the seal should never be placed on pages where credit card information is entered.

Step 7 - Add product ratings to collection pages

Once you start collecting product reviews, you will want to display the star ratings and review count on your site. One location where you can display the product ratings is underneath the product on a collections page on a per-product level.

You will add code to the collection page once and then add divs to each category listing so the star rating and review count appear below each product. You can find this code under Setup > Category Code. The code below will be loaded on the page one time.

Please note the default behavior is that if no reviews are found no star containers will be shown. If you would like empty stars to show you will need to create code to do so.

 <script type="text/javascript"> function saLoadScript(src) { var js = window.document.createElement('script'); js.src = src; js.type = 'text/javascript'; document.getElementsByTagName("head")[0].appendChild(js); } saLoadScript("https://www.shopperapproved.com/widgets/group2.0/xxxxx.js"); </script>

You will then place the code below on each category listing replacing product_id_here with the product ID for the respective product.

 <div class="star_container product_id_here"></div>

Once you place the code, the category pages should display the star rating and review count.

Step 8 - Add Product Star Rating and Review Count Code to Product pages

You can find this code snippet under Setup > Product Page Code under Step 1 - Copy Your Star Code. This code is only for one product on a product page.

You can select either small or big stars. Here is an example code snippet:

 <div id="product_just_stars" class="big"></div> 

Notice the placeholder value for the product ID sa_product = '[PRODUCT ID]'. This will need to be replaced with the product ID for that particular product.

Step 9 - Customize your product page widget

Under Setup > Product Page Code > Product page widget, you can customize your display, sort, and schema settings. You will want to select how many product reviews you’d like to collect before displaying the product reviews. We will display Seller Reviews until we reach the threshold of Product Reviews you select in these settings.

Step 10 - Schema Setting

Note the setting, "Inject JSON-LD schema”.

If the schema on your site is currently in JSON-LD format and you have an @id attribute that contains the product URL, enable this setting to have the product review widget automatically inject the Aggregate Rating schema onto your product pages.

Note: Turning this feature on will enable your product reviews to be crawled by Google so your ratings will show up in organic searches. Before turning this feature on, all non-json_ld schema on your product pages should be removed.

If you are not sure about your existing schema or have any other questions related to schema, please reach out to [email protected] and our dedicated support team can advise you on what needs to be done to benefit from this schema.

Step 11 - Add Product Review Code

Now that you have your settings configured and your product review widget is customized, copy and paste the code snippet and paste it to the desired location of your website. You can find this code snippet under Setup > Product Page Code

Here is an example code snippet. Please make sure to copy the code snippet within your dashboard.

 <div id="SA_review_wrapper" ></div><script type="text/javascript">var sa_product = '[PRODUCT ID]'; var sa_interval = 5000;function saLoadScript(src) { var js = window.document.createElement('script'); js.src = src; js.type = 'text/javascript'; document.getElementsByTagName("head")[0].appendChild(js); } if (typeof(shopper_first) == 'undefined') saLoadScript('//www.shopperapproved.com/widgets/xxxxx/product/'+sa_product+'/product-widget/yyyyyyyyyyyyy.js'); </script>

Note: You will have to replace the [PRODUCT ID] placeholder anywhere you place this code. Also, some carts will strip div tags with empty content. If this is the case put a &nbsp; in the empty divs to keep it from doing so.

Once your code is placed, you will see the product reviews widget on the product page.

Step 12 - Add a rotating widget

This is optional but gives you the option to highlight some of your best-seller reviews on your site. You can select 5-star reviews, 4- and 5-star reviews, or your favorite reviews. To learn how to favorite a review, reach out to our support team to get a walk-through of that feature.

Note: Only reviews with comments can be displayed.

To find the code for the rotating widget, navigate to Seals & Widgets > Rotating Widget. From here, go through the settings to customize it to your liking and just like the reviews page and seal, copy and paste the code to the location on your home page.

Step 12 - Add a milestone award

Once you collect 100 5-star reviews, you will see a Milestone Award under Seals & Widgets.

If you want to add the milestone to your site, select your desired style and copy and paste the code in the desired location of your site.

You’re all set! If you have any questions about your integration, please reach out to [email protected].

Happy Collecting!

Did this answer your question?